diff options
Diffstat (limited to 'data/en_us/pairecservice/2022-12-13/api-docs.php')
| -rw-r--r-- | data/en_us/pairecservice/2022-12-13/api-docs.php | 28728 |
1 files changed, 15564 insertions, 13164 deletions
diff --git a/data/en_us/pairecservice/2022-12-13/api-docs.php b/data/en_us/pairecservice/2022-12-13/api-docs.php index d90db6c..96aa01c 100644 --- a/data/en_us/pairecservice/2022-12-13/api-docs.php +++ b/data/en_us/pairecservice/2022-12-13/api-docs.php @@ -1,1328 +1,871 @@ <?php return [ 'version' => '1.0', - 'info' => [ - 'style' => 'ROA', - 'product' => 'PaiRecService', - 'version' => '2022-12-13', - ], + 'info' => ['style' => 'ROA', 'product' => 'PaiRecService', 'version' => '2022-12-13'], 'directories' => [ [ - 'id' => 183827, - 'title' => null, + 'children' => ['ListInstances', 'GetInstance'], 'type' => 'directory', - 'children' => [ - 'ListInstances', - 'GetInstance', - ], + 'title' => 'Instance management', ], [ - 'id' => 365002, - 'title' => null, - 'type' => 'directory', 'children' => [ - 'GetRecallManagementConfig', - 'GetRecallManagementServiceVersion', - 'GetRecallManagementServiceVersionConfig', - 'GetRecallManagementTable', - 'ListRecallManagementJobs', - 'ListRecallManagementServiceVersions', - 'ListRecallManagementServices', - 'ListRecallManagementTables', - 'UpdateRecallManagementConfig', - 'PublishRecallManagementTable', - 'OfflineRecallManagementService', - 'CreateRecallManagementTable', - 'CreateRecallManagementServiceVersionConfig', - 'CreateRecallManagementServiceVersion', - 'CreateRecallManagementService', - 'CreateRecallManagementConfig', + [ + 'children' => ['CreateRecallManagementConfig', 'UpdateRecallManagementConfig', 'GetRecallManagementConfig'], + 'type' => 'directory', + 'title' => 'Recall management configuration', + ], + [ + 'children' => ['CreateRecallManagementTable', 'ListRecallManagementTables', 'UpdateRecallManagementTable', 'GetRecallManagementTable', 'DeleteRecallManagementTable', 'PublishRecallManagementTable', 'ListRecallManagementTableVersions', 'QueryRecallManagementTableRecords', 'ExportRecallManagementTable'], + 'type' => 'directory', + 'title' => 'Recall management table', + ], + [ + 'children' => ['GetRecallManagementJob', 'ListRecallManagementJobs'], + 'type' => 'directory', + 'title' => 'Recall management task', + ], + [ + 'children' => [ + [ + 'children' => ['CreateRecallManagementService', 'ListRecallManagementServices', 'UpdateRecallManagementService', 'GetRecallManagementService', 'DeleteRecallManagementService', 'OnlineRecallManagementService', 'OfflineRecallManagementService', 'ChangeRecallManagementServiceVersion'], + 'type' => 'directory', + 'title' => 'Recall service', + ], + [ + 'children' => ['CreateRecallManagementServiceVersion', 'ListRecallManagementServiceVersions', 'GetRecallManagementServiceVersion', 'DeleteRecallManagementServiceVersion'], + 'type' => 'directory', + 'title' => 'Recall service version', + ], + [ + 'children' => ['CreateRecallManagementServiceVersionConfig', 'UpdateRecallManagementServiceVersionConfig', 'GetRecallManagementServiceVersionConfig', 'DeleteRecallManagementServiceVersionConfig'], + 'type' => 'directory', + 'title' => 'Recall service version configuration', + ], + ], + 'type' => 'directory', + 'title' => 'Recall management service', + ], ], + 'type' => 'directory', + 'title' => 'Recall management', ], [ - 'id' => 188034, - 'title' => null, + 'children' => ['ListInstanceResourceSchemas', 'ListInstanceResourceTables', 'CheckInstanceResources', 'UpdateInstanceResource', 'GetInstanceResourceTable', 'ListInstanceResources', 'GetInstanceResource', 'DeleteInstanceResource', 'CreateInstanceResource'], 'type' => 'directory', - 'children' => [ - 'ListInstanceResourceSchemas', - 'ListInstanceResourceTables', - 'CheckInstanceResources', - 'UpdateInstanceResource', - 'GetInstanceResourceTable', - 'ListInstanceResources', - 'GetInstanceResource', - 'DeleteInstanceResource', - 'CreateInstanceResource', - ], + 'title' => 'Data resource management', ], [ - 'id' => 183688, - 'title' => null, + 'children' => ['CreateScene', 'DeleteScene', 'UpdateScene', 'ListScenes', 'GetScene'], 'type' => 'directory', - 'children' => [ - 'CreateScene', - 'DeleteScene', - 'UpdateScene', - 'ListScenes', - 'GetScene', - ], + 'title' => 'Scene management', ], [ - 'id' => 221290, - 'title' => null, - 'type' => 'directory', 'children' => [ [ - 'id' => 221291, - 'title' => null, + 'children' => ['CreateDataDiagnosis', 'ListDataDiagnoses', 'UpdateDataDiagnosis', 'GetDataDiagnosis', 'DeleteDataDiagnosis', 'CreateDataDiagnosisJobs', 'ListDataDiagnosisJobs', 'ListDataDiagnosisReports', 'QueryDataDiagnosisStatistics'], 'type' => 'directory', - 'children' => [ - 'GenerateAlgorithmCustomizationScript', - ], + 'title' => 'Data diagnostics', + ], + [ + 'children' => ['GenerateAlgorithmCustomizationScript'], + 'type' => 'directory', + 'title' => 'Algorithm customization', ], ], + 'type' => 'directory', + 'title' => 'Algorithm customization', ], [ - 'id' => 183857, - 'title' => null, + 'children' => ['CreateLaboratory', 'DeleteLaboratory', 'UpdateLaboratory', 'ListLaboratories', 'GetLaboratory', 'OnlineLaboratory', 'OfflineLaboratory', 'CloneLaboratory'], 'type' => 'directory', - 'children' => [ - 'CreateLaboratory', - 'DeleteLaboratory', - 'UpdateLaboratory', - 'ListLaboratories', - 'GetLaboratory', - 'OnlineLaboratory', - 'OfflineLaboratory', - 'CloneLaboratory', - ], + 'title' => 'Lab management', ], [ - 'id' => 183850, - 'title' => null, + 'children' => ['CreateLayer', 'DeleteLayer', 'UpdateLayer', 'ListLayers', 'GetLayer'], 'type' => 'directory', - 'children' => [ - 'CreateLayer', - 'DeleteLayer', - 'UpdateLayer', - 'ListLayers', - 'GetLayer', - ], + 'title' => 'Layer management', ], [ - 'id' => 183866, - 'title' => null, + 'children' => ['CreateExperimentGroup', 'DeleteExperimentGroup', 'UpdateExperimentGroup', 'ListExperimentGroups', 'GetExperimentGroup', 'CloneExperimentGroup', 'OnlineExperimentGroup', 'OfflineExperimentGroup'], 'type' => 'directory', - 'children' => [ - 'CreateExperimentGroup', - 'DeleteExperimentGroup', - 'UpdateExperimentGroup', - 'ListExperimentGroups', - 'GetExperimentGroup', - 'CloneExperimentGroup', - 'OnlineExperimentGroup', - 'OfflineExperimentGroup', - ], + 'title' => 'Experiment group management', ], [ - 'id' => 183812, - 'title' => null, + 'children' => ['CreateExperiment', 'DeleteExperiment', 'UpdateExperiment', 'GetExperiment', 'ListExperiments', 'CloneExperiment', 'OfflineExperiment', 'PushAllExperiment', 'OnlineExperiment'], 'type' => 'directory', - 'children' => [ - 'CreateExperiment', - 'DeleteExperiment', - 'UpdateExperiment', - 'GetExperiment', - 'ListExperiments', - 'CloneExperiment', - 'OfflineExperiment', - 'PushAllExperiment', - 'OnlineExperiment', - ], + 'title' => 'Experiment management', ], [ - 'id' => 183822, - 'title' => null, + 'children' => ['CreateParam', 'DeleteParam', 'UpdateParam', 'ListParams'], 'type' => 'directory', - 'children' => [ - 'CreateParam', - 'DeleteParam', - 'UpdateParam', - 'ListParams', - ], + 'title' => 'Parameter management', ], [ - 'id' => 183834, - 'title' => null, + 'children' => ['CreateCrowd', 'CreateSubCrowd', 'DeleteCrowd', 'DeleteSubCrowd', 'UpdateCrowd', 'ListCrowds', 'ListCrowdUsers', 'ListSubCrowds', 'GetSubCrowd'], 'type' => 'directory', - 'children' => [ - 'CreateCrowd', - 'CreateSubCrowd', - 'DeleteCrowd', - 'DeleteSubCrowd', - 'UpdateCrowd', - 'ListCrowds', - 'ListCrowdUsers', - 'ListSubCrowds', - 'GetSubCrowd', - ], + 'title' => 'Crowd management', ], [ - 'id' => 187974, - 'title' => null, + 'children' => ['UpdateTableMeta', 'ListTableMetas', 'GetTableMeta', 'DeleteTableMeta', 'CreateTableMeta'], 'type' => 'directory', - 'children' => [ - 'UpdateTableMeta', - 'ListTableMetas', - 'GetTableMeta', - 'DeleteTableMeta', - 'CreateTableMeta', - ], + 'title' => 'Data table management', ], [ - 'id' => 188051, - 'title' => null, + 'children' => ['UpdateABMetric', 'CreateABMetric', 'ListABMetrics', 'GetABMetric', 'DeleteABMetric'], 'type' => 'directory', - 'children' => [ - 'UpdateABMetric', - 'CreateABMetric', - 'ListABMetrics', - 'GetABMetric', - 'DeleteABMetric', - ], + 'title' => 'AB metric management', ], [ - 'id' => 188045, - 'title' => null, + 'children' => ['ReportABMetricGroup', 'UpdateABMetricGroup', 'CreateABMetricGroup', 'ListABMetricGroups', 'GetABMetricGroup', 'DeleteABMetricGroup'], 'type' => 'directory', - 'children' => [ - 'ReportABMetricGroup', - 'UpdateABMetricGroup', - 'CreateABMetricGroup', - 'ListABMetricGroups', - 'GetABMetricGroup', - 'DeleteABMetricGroup', - ], + 'title' => 'AB metric group management', ], [ - 'id' => 188041, - 'title' => null, + 'children' => ['ListCalculationJobs', 'GetCalculationJob', 'CreateCalculationJobs'], 'type' => 'directory', - 'children' => [ - 'ListCalculationJobs', - 'GetCalculationJob', - 'CreateCalculationJobs', - ], + 'title' => 'Compute task management', ], [ - 'id' => 185916, - 'title' => null, + 'children' => ['CreateFeatureConsistencyCheckJobConfig', 'CreateFeatureConsistencyCheckJob', 'UpdateFeatureConsistencyCheckJobConfig', 'ListFeatureConsistencyCheckJobConfigs', 'GetFeatureConsistencyCheckJobConfig', 'ListFeatureConsistencyCheckJobs', 'GetFeatureConsistencyCheckJob', 'ListFeatureConsistencyCheckJobFeatureReports', 'ListFeatureConsistencyCheckJobScoreReports', 'CloneFeatureConsistencyCheckJobConfig', 'TerminateFeatureConsistencyCheckJob', 'BackflowFeatureConsistencyCheckJobData', 'SyncFeatureConsistencyCheckJobReplayLog'], 'type' => 'directory', - 'children' => [ - 'CreateFeatureConsistencyCheckJobConfig', - 'CreateFeatureConsistencyCheckJob', - 'UpdateFeatureConsistencyCheckJobConfig', - 'ListFeatureConsistencyCheckJobConfigs', - 'GetFeatureConsistencyCheckJobConfig', - 'ListFeatureConsistencyCheckJobs', - 'GetFeatureConsistencyCheckJob', - 'ListFeatureConsistencyCheckJobFeatureReports', - 'ListFeatureConsistencyCheckJobScoreReports', - 'CloneFeatureConsistencyCheckJobConfig', - 'TerminateFeatureConsistencyCheckJob', - 'BackflowFeatureConsistencyCheckJobData', - 'SyncFeatureConsistencyCheckJobReplayLog', - ], + 'title' => 'Feature consistency check task management', ], [ - 'id' => 194358, - 'title' => null, + 'children' => ['DeleteEngineConfig', 'UpdateEngineConfig', 'ListEngineConfigs', 'GetEngineConfig', 'CreateEngineConfig', 'CloneEngineConfig', 'ApplyEngineConfig'], 'type' => 'directory', - 'children' => [ - 'DeleteEngineConfig', - 'UpdateEngineConfig', - 'ListEngineConfigs', - 'GetEngineConfig', - 'CreateEngineConfig', - 'CloneEngineConfig', - 'ApplyEngineConfig', - ], + 'title' => 'Engine configuration management', ], [ - 'id' => 286382, - 'title' => null, + 'children' => ['GetService'], 'type' => 'directory', - 'children' => [ - 'GetService', - ], + 'title' => 'Service management', ], [ - 'id' => 268827, - 'title' => null, - 'type' => 'directory', 'children' => [ [ - 'id' => 268828, - 'title' => null, + 'children' => ['CreateTrafficControlTask', 'ListTrafficControlTasks', 'UpdateTrafficControlTask', 'GetTrafficControlTask', 'DeleteTrafficControlTask', 'CloneTrafficControlTask', 'CheckTrafficControlTaskExpression', 'ReleaseTrafficControlTask', 'StartTrafficControlTask', 'StopTrafficControlTask', 'GenerateTrafficControlTaskCode', 'GetTrafficControlTaskTraffic', 'UpdateTrafficControlTaskTraffic', 'DeployTrafficControlTaskCode', 'QueryTrafficControlTaskDeployResult', 'QueryTrafficControlTaskItemReport'], 'type' => 'directory', - 'children' => [ - 'GetTrafficControlTaskTraffic', - 'SplitTrafficControlTarget', - ], + 'title' => 'Traffic control task', + ], + [ + 'children' => ['CreateTrafficControlTarget', 'UpdateTrafficControlTarget', 'GetTrafficControlTarget', 'DeleteTrafficControlTarget', 'StartTrafficControlTarget', 'StopTrafficControlTarget', 'SplitTrafficControlTarget', 'ListTrafficControlTargetTrafficHistory', 'QueryTrafficControlTargetItemReportDetail'], + 'type' => 'directory', + 'title' => 'Traffic control target', ], ], + 'type' => 'directory', + 'title' => 'Traffic control', + ], + [ + 'children' => ['ChatConversation', 'StopTrafficControlFlinkTask'], + 'type' => 'directory', + 'title' => 'Others', ], ], 'components' => [ 'schemas' => [], ], 'apis' => [ - 'ListInstances' => [ - 'summary' => '获取推荐全链路深度定制开发平台实例信息列表。', - 'path' => '/api/v1/instances', - 'methods' => [ - 'get', - ], - 'schemes' => [ - 'http', - 'https', - ], + 'ApplyEngineConfig' => [ + 'summary' => 'Applies an engine configuration.', + 'path' => '/api/v1/engineconfigs/{EngineConfigId}/action/apply', + 'methods' => ['post'], + 'schemes' => ['http', 'https'], 'security' => [ [ 'AK' => [], ], ], - 'consumes' => [ - 'application/json', - ], - 'produces' => [ - 'application/json', - ], - 'operationType' => 'read', + 'consumes' => ['application/json'], + 'produces' => ['application/json'], + 'operationType' => 'readAndWrite', 'deprecated' => false, 'systemTags' => [ 'operationType' => 'none', 'riskType' => 'none', 'chargeType' => 'free', - 'abilityTreeCode' => '163069', - 'abilityTreeNodes' => [ - 'FEATURElearnN0NAWV', - ], + 'abilityTreeCode' => '180295', + 'abilityTreeNodes' => ['FEATURElearnN0NAWV'], ], 'parameters' => [ [ + 'name' => 'EngineConfigId', + 'in' => 'path', + 'schema' => ['description' => 'The engine configuration ID.', 'type' => 'string', 'required' => false, 'example' => '2', 'title' => ''], + ], + [ 'name' => 'InstanceId', 'in' => 'query', + 'schema' => ['description' => 'The instance ID. You can obtain this by calling the [ListInstances](~~2411819~~) API.', 'type' => 'string', 'required' => false, 'example' => 'pairec-cn-***test', 'title' => ''], + ], + ], + 'responses' => [ + 200 => [ 'schema' => [ - 'title' => '实例Id模糊匹配过滤。', - 'description' => '', - 'type' => 'string', - 'required' => false, - 'example' => 'pairec-test1', + 'title' => 'Schema of Response', + 'description' => 'The response body.', + 'type' => 'object', + 'properties' => [ + 'RequestId' => ['title' => 'Id of the request', 'description' => 'The request ID.', 'type' => 'string', 'example' => 'F8F613A9-DF1C-551A-88E1-397A3981A785'], + ], + 'example' => '', ], ], - [ - 'name' => 'SortBy', - 'in' => 'query', - 'schema' => [ - 'title' => '排序依据。', - 'description' => '', - 'type' => 'string', - 'required' => false, - 'example' => 'Type', + ], + 'staticInfo' => ['returnType' => 'synchronous'], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"F8F613A9-DF1C-551A-88E1-397A3981A785\\"\\n}","type":"json"}]', + 'title' => 'Publish DPI engine configuration', + 'changeSet' => [], + 'ramActions' => [ + [ + 'operationType' => 'none', + 'ramAction' => [ + 'action' => 'pairec:ApplyEngineConfig', + 'authLevel' => 'operate', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'PAIRecService', 'resourceType' => 'All Resource', 'arn' => '*'], + ], ], ], + ], + 'flowControl' => [ + 'flowControlList' => [], + ], + ], + 'BackflowFeatureConsistencyCheckJobData' => [ + 'summary' => 'Performs data backflow for the latest job of a specified feature consistency check job configuration.', + 'path' => '/api/v1/featureconsistencycheck/jobs/action/backflowdata', + 'methods' => ['post'], + 'schemes' => ['http', 'https'], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'consumes' => ['application/json'], + 'produces' => ['application/json'], + 'operationType' => 'readAndWrite', + 'deprecated' => false, + 'systemTags' => [ + 'operationType' => 'none', + 'riskType' => 'none', + 'chargeType' => 'free', + 'abilityTreeNodes' => ['FEATURElearnN0NAWV'], + ], + 'parameters' => [ [ - 'name' => 'Order', - 'in' => 'query', + 'name' => 'body', + 'in' => 'body', + 'style' => 'json', 'schema' => [ - 'title' => '排序方式。', - 'description' => '', - 'type' => 'string', + 'description' => 'The request body.', + 'type' => 'object', + 'properties' => [ + 'FeatureConsistencyCheckJobConfigId' => ['description' => 'The feature consistency check job configuration ID. To obtain the configuration ID, call the [ListFeatureConsistencyCheckJobConfigs](~~2557567~~) operation.', 'type' => 'string', 'required' => true, 'example' => '4', 'title' => ''], + 'InstanceId' => ['description' => 'The instance ID. To obtain the instance ID, call the [ListInstances](~~2411819~~) operation.', 'type' => 'string', 'required' => true, 'example' => 'pairec-cn-********', 'title' => ''], + 'LogUserId' => ['description' => 'The user ID in the log.', 'type' => 'string', 'required' => true, 'example' => '1010', 'title' => ''], + 'LogItemId' => ['description' => 'The item ID in the log.', 'type' => 'string', 'required' => true, 'example' => '9010', 'title' => ''], + 'LogRequestId' => ['description' => 'The log request ID.', 'type' => 'string', 'required' => true, 'example' => '728C5E01-ABF6-5AA8-B9FC-B3BA05DECC77', 'title' => ''], + 'SceneName' => ['description' => 'The scene name.', 'type' => 'string', 'required' => true, 'example' => 'video-feed', 'title' => ''], + 'Scores' => ['description' => 'The scores.', 'type' => 'string', 'required' => true, 'example' => '[\\"{\\\\\\"dbmtl_probs_is_valid_play\\\\\\":0.00032182207107543945,\\\\\\"dbmtl_y_play_time\\\\\\":0.0043269748210906982}\\"]', 'title' => ''], + 'UserFeatures' => ['description' => 'The user features.', 'type' => 'string', 'required' => true, 'example' => '{\\"userid\\":{\\"value\\":1010,\\"type\\":\\"string\\"},\\"click_5_seq\\":{\\"value\\":\\"9001;9002;9003;9004;9005\\",\\"type\\":\\"string\\"}}', 'title' => ''], + 'ItemFeatures' => ['description' => 'The item features.', 'type' => 'string', 'required' => true, 'example' => '[\\"{\\\\\\"itemid\\\\\\":{\\\\\\"value\\\\\\":1010,\\\\\\"type\\\\\\":\\\\\\"string\\\\\\"}}\\"]', 'title' => ''], + 'LogRequestTime' => ['description' => 'The log request time (UNIX epoch timestamp).', 'type' => 'integer', 'format' => 'int64', 'required' => true, 'example' => '1693900981465', 'title' => ''], + 'ServiceName' => ['type' => 'string', 'description' => '', 'required' => false, 'title' => '', 'example' => ''], + ], 'required' => false, - 'example' => 'Desc', + 'title' => '', + 'example' => '', ], ], - [ - 'name' => 'PageNumber', - 'in' => 'query', + ], + 'responses' => [ + 200 => [ 'schema' => [ - 'title' => '页大小。', - 'description' => '', - 'type' => 'integer', - 'format' => 'int32', - 'required' => false, - 'example' => '1', + 'title' => 'Schema of Response', + 'description' => 'The response object.', + 'type' => 'object', + 'properties' => [ + 'RequestId' => ['title' => 'Id of the request', 'description' => 'The request ID.', 'type' => 'string', 'example' => 'BDB621CB-A81E-5D39-8793-39A365CBCC74'], + ], + 'example' => '', ], ], + ], + 'staticInfo' => ['returnType' => 'synchronous'], + 'title' => 'Feature Consistency Check Data Backflow', + 'changeSet' => [ + ['createdAt' => '2025-03-03T01:31:15.000Z', 'description' => 'Request parameters changed'], + ], + 'flowControl' => [ + 'flowControlList' => [ + ['threshold' => '100', 'countWindow' => 1, 'regionId' => '*', 'api' => 'BackflowFeatureConsistencyCheckJobData'], + ], + ], + 'ramActions' => [ [ - 'name' => 'PageSize', - 'in' => 'query', - 'schema' => [ - 'title' => '页码。', - 'description' => '', - 'type' => 'integer', - 'format' => 'int32', - 'required' => false, - 'example' => '50', + 'operationType' => 'none', + 'ramAction' => [ + 'action' => 'pairec:BackflowFeatureConsistencyCheckJobData', + 'authLevel' => 'operate', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'PAIRecService', 'resourceType' => 'All Resource', 'arn' => '*'], + ], ], ], + ], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"BDB621CB-A81E-5D39-8793-39A365CBCC74\\"\\n}","type":"json"}]', + ], + 'ChangeRecallManagementServiceVersion' => [ + 'summary' => 'This API changes the version of a recall management service.', + 'path' => '/api/v1/recallmanagementservices/{RecallManagementServiceId}/action/changeversion', + 'methods' => ['post'], + 'schemes' => ['https'], + 'security' => [ [ - 'name' => 'Type', - 'in' => 'query', + 'AK' => [], + ], + ], + 'consumes' => ['application/json'], + 'produces' => ['application/json'], + 'operationType' => 'write', + 'deprecated' => false, + 'systemTags' => [ + 'operationType' => 'none', + 'riskType' => 'none', + 'chargeType' => 'free', + 'abilityTreeNodes' => ['FEATURElearnN0NAWV'], + ], + 'parameters' => [ + [ + 'name' => 'RecallManagementServiceId', + 'in' => 'path', + 'schema' => ['description' => 'The recall management service ID.', 'type' => 'string', 'required' => false, 'example' => '2', 'title' => ''], + ], + [ + 'name' => 'body', + 'in' => 'body', + 'style' => 'json', 'schema' => [ - 'title' => '实例类型。'."\n" - .'● basic-基础版'."\n" - .'● highleve-升级版'."\n" - .'● advance-进阶版'."\n" - .'● standard-标准版', - 'description' => '', - 'type' => 'string', + 'type' => 'object', + 'properties' => [ + 'InstanceId' => ['description' => 'The instance ID.', 'type' => 'string', 'required' => false, 'example' => 'pairec-cn-test123', 'title' => ''], + 'RecallManagementServiceVersionId' => ['description' => 'The recall management service version ID.', 'type' => 'string', 'required' => false, 'example' => '1', 'title' => ''], + ], + 'description' => 'The request body.', 'required' => false, - 'example' => 'basic', + 'title' => '', + 'example' => '', ], ], ], 'responses' => [ 200 => [ 'schema' => [ - 'title' => 'Schema of Response', - 'description' => 'Schema of Response', 'type' => 'object', 'properties' => [ - 'RequestId' => [ - 'description' => '', - 'type' => 'string', - 'example' => 'BDB621CB-A81E-5D39-8793-39A365CBCC74', - ], - 'Instances' => [ - 'description' => '', - 'type' => 'array', - 'items' => [ - 'type' => 'object', - 'properties' => [ - 'InstanceId' => [ - 'title' => '实例id。', - 'description' => '', - 'type' => 'string', - 'example' => 'pairec-test1', - ], - 'Type' => [ - 'title' => '实例类型。'."\n" - .'● basic-基础版'."\n" - .'● highleve-升级版'."\n" - .'● advance-进阶版'."\n" - .'● standard-标准版', - 'description' => '', - 'type' => 'string', - 'example' => 'basic', - ], - 'Status' => [ - 'title' => '实例状态。'."\n" - .'● Initializing-初始化中'."\n" - .'● Stopped-停止服务'."\n" - .'● Running-运行中', - 'description' => '', - 'type' => 'string', - 'example' => 'Initializing', - ], - 'RegionId' => [ - 'title' => '区域ID。'."\n" - .'● cn-shenzhen - 深圳'."\n" - .'● cn-hangzhou - 杭州'."\n" - .'● cn-beijing - 北京'."\n" - .'● cn-shanghai - 上海', - 'description' => '', - 'type' => 'string', - 'example' => 'cn-shenzhen', - ], - 'GmtCreateTime' => [ - 'title' => '实例创建时间。', - 'description' => '', - 'type' => 'string', - 'example' => '2022-10-13 17:34:52.0', - ], - 'GmtModifiedTime' => [ - 'title' => '实例更新时间。', - 'description' => '', - 'type' => 'string', - 'example' => '2022-11-05 09:02:30.0', - ], - 'ExpiredTime' => [ - 'title' => '实例过期时间。', - 'description' => '', - 'type' => 'string', - 'example' => '2022-12-14 00:00:00.0', - ], - 'CommodityCode' => [ - 'title' => '实例所属的商品code。', - 'description' => '', - 'type' => 'string', - 'example' => 'airec_developers_public_cn', - ], - 'ChargeType' => [ - 'title' => '实例的付费类型，目前仅支持Subscription（预付费）。', - 'description' => '', - 'type' => 'string', - 'example' => 'Subscription', - ], - 'Config' => [ - 'title' => '实例配置。', - 'description' => '', - 'type' => 'object', - 'properties' => [ - 'Engines' => [ - 'title' => '服务引擎列表。', - 'description' => '', - 'type' => 'array', - 'items' => [ - 'type' => 'object', - 'properties' => [ - 'ComponentCode' => [ - 'title' => '组件代码。', - 'description' => '', - 'type' => 'string', - 'example' => 'feature', - ], - 'Type' => [ - 'title' => '组件类型。', - 'description' => '', - 'type' => 'string', - 'example' => 'Hologres', - ], - 'Meta' => [ - 'title' => '元数据。', - 'description' => '', - 'type' => 'object', - ], - ], - ], - ], - 'Monitors' => [ - 'title' => '配套功能列表。', - 'description' => '', - 'type' => 'array', - 'items' => [ - 'type' => 'object', - 'properties' => [ - 'ComponentCode' => [ - 'title' => '组件代码。', - 'description' => '', - 'type' => 'string', - 'example' => 'featuresets', - ], - 'Type' => [ - 'title' => '组件类型。', - 'description' => '', - 'type' => 'string', - 'example' => 'Platform', - ], - 'Meta' => [ - 'title' => '元数据。', - 'description' => '', - 'type' => 'object', - ], - ], - ], - ], - 'DataManagements' => [ - 'title' => '建模环境列表。', - 'description' => '', - 'type' => 'array', - 'items' => [ - 'type' => 'object', - 'properties' => [ - 'ComponentCode' => [ - 'title' => '组件代码。', - 'description' => '', - 'type' => 'string', - 'example' => 'storage', - ], - 'Type' => [ - 'title' => '组件类型。', - 'description' => '', - 'type' => 'string', - 'example' => 'OSS', - ], - 'Meta' => [ - 'title' => '元数据。', - 'description' => '', - 'type' => 'object', - ], - ], - ], - ], - ], - ], - 'OperatingTool' => [ - 'type' => 'object', - 'properties' => [ - 'IsEnable' => [ - 'type' => 'boolean', - ], - ], - ], - ], - ], - ], - 'TotalCount' => [ - 'title' => '列表内元素总数。', - 'description' => '', - 'type' => 'integer', - 'format' => 'int32', - 'example' => '7', - ], + 'RequestId' => ['description' => 'The request ID.', 'type' => 'string', 'title' => '', 'example' => '728C5E01-ABF6-5AA8-B9FC-B3BA05DECC77'], ], + 'title' => '', + 'description' => 'The response object.', + 'example' => '', ], ], ], - 'staticInfo' => [ - 'returnType' => 'synchronous', + 'staticInfo' => ['returnType' => 'synchronous'], + 'title' => 'ChangeRecallManagementServiceVersion', + 'description' => '## Request'."\n" + ."\n" + .'Use this API to change the version of a recall management service. Ensure that the provided `RecallManagementServiceId`, `InstanceId`, and target `RecallManagementServiceVersionId` are valid, and that you have the required permissions for these resources.'."\n" + ."\n" + .'- **RecallManagementServiceId**: The unique identifier of the recall management service.'."\n" + ."\n" + .'- **InstanceId**: The instance ID associated with the recall management service.'."\n" + ."\n" + .'- **RecallManagementServiceVersionId**: The target version ID to switch to.'."\n" + ."\n" + .'Note: Before changing the version, confirm that the new version is fully tested and ready for production.', + 'changeSet' => [], + 'flowControl' => [ + 'flowControlList' => [], + ], + 'ramActions' => [ + [ + 'operationType' => 'none', + 'ramAction' => [ + 'action' => 'pairec:ChangeRecallManagementServiceVersion', + 'authLevel' => 'operate', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'PAIRecService', 'resourceType' => 'All Resource', 'arn' => '*'], + ], + ], + ], ], - 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"BDB621CB-A81E-5D39-8793-39A365CBCC74\\",\\n \\"Instances\\": [\\n {\\n \\"InstanceId\\": \\"pairec-test1\\",\\n \\"Type\\": \\"basic\\",\\n \\"Status\\": \\"Initializing\\",\\n \\"RegionId\\": \\"cn-shenzhen\\",\\n \\"GmtCreateTime\\": \\"2022-10-13 17:34:52.0\\",\\n \\"GmtModifiedTime\\": \\"2022-11-05 09:02:30.0\\",\\n \\"ExpiredTime\\": \\"2022-12-14 00:00:00.0\\",\\n \\"CommodityCode\\": \\"airec_developers_public_cn\\",\\n \\"ChargeType\\": \\"Subscription\\",\\n \\"Config\\": {\\n \\"Engines\\": [\\n {\\n \\"ComponentCode\\": \\"feature\\",\\n \\"Type\\": \\"Hologres\\",\\n \\"Meta\\": {\\n \\"test\\": \\"test\\",\\n \\"test2\\": 1\\n }\\n }\\n ],\\n \\"Monitors\\": [\\n {\\n \\"ComponentCode\\": \\"featuresets\\",\\n \\"Type\\": \\"Platform\\",\\n \\"Meta\\": {\\n \\"test\\": \\"test\\",\\n \\"test2\\": 1\\n }\\n }\\n ],\\n \\"DataManagements\\": [\\n {\\n \\"ComponentCode\\": \\"storage\\",\\n \\"Type\\": \\"OSS\\",\\n \\"Meta\\": {\\n \\"test\\": \\"test\\",\\n \\"test2\\": 1\\n }\\n }\\n ]\\n },\\n \\"OperatingTool\\": {\\n \\"IsEnable\\": true\\n }\\n }\\n ],\\n \\"TotalCount\\": 7\\n}","type":"json"}]', + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"728C5E01-ABF6-5AA8-B9FC-B3BA05DECC77\\"\\n}","type":"json"}]', ], - 'GetInstance' => [ - 'summary' => '获取指定推荐全链路深度定制开发平台实例信息。', - 'path' => '/api/v1/instances/{InstanceId}', - 'methods' => [ - 'get', - ], - 'schemes' => [ - 'http', - 'https', - ], + 'ChatConversation' => [ + 'summary' => 'Sends a conversation message to an agent. Supports Server-Sent Events (SSE). Creates a new session or continues a conversation in an existing session.', + 'path' => '/api/v1/conversations/chat', + 'methods' => ['post'], + 'schemes' => ['https', 'sse'], 'security' => [ [ 'AK' => [], ], ], - 'consumes' => [ - 'application/json', - ], - 'produces' => [ - 'application/json', - ], - 'operationType' => 'read', + 'consumes' => ['application/json'], + 'produces' => ['text/event-stream'], + 'operationType' => 'readAndWrite', 'deprecated' => false, 'systemTags' => [ - 'operationType' => 'get', + 'operationType' => 'none', 'riskType' => 'none', 'chargeType' => 'free', - 'abilityTreeCode' => '163068', - 'abilityTreeNodes' => [ - 'FEATURElearnN0NAWV', - ], + 'abilityTreeNodes' => ['FEATURElearnN0NAWV'], ], 'parameters' => [ [ - 'name' => 'InstanceId', - 'in' => 'path', + 'name' => 'body', + 'in' => 'body', + 'style' => 'json', 'schema' => [ - 'title' => '实例ID。', - 'description' => '', - 'type' => 'string', + 'description' => 'The request body.', + 'type' => 'object', + 'properties' => [ + 'InstanceId' => ['title' => '', 'description' => 'The instance ID.', 'type' => 'string', 'required' => true, 'example' => 'learn-pairec-xxx'], + 'ConversationId' => ['title' => '', 'description' => 'The session ID. If this parameter is not specified, a new session is created. If this parameter is specified, the conversation continues in the context of the existing session.', 'type' => 'string', 'required' => false, 'example' => 'e47cfae9-c0cc-42e1-91e2-e67cdb0e7b96'], + 'Content' => ['title' => '', 'description' => 'The message content.', 'type' => 'string', 'required' => true, 'example' => '校验引擎配置'], + 'Config' => ['title' => '', 'description' => 'The additional information input in JSON format.', 'type' => 'string', 'required' => false, 'example' => '{}'], + ], 'required' => false, - 'example' => 'pairec-cn-abcdefg1234', + 'example' => '{}', + 'title' => '', ], ], ], 'responses' => [ 200 => [ 'schema' => [ - 'title' => 'Schema of Response', + 'title' => '', 'description' => 'Schema of Response', 'type' => 'object', 'properties' => [ - 'RequestId' => [ - 'title' => '请求id。', - 'description' => '', - 'type' => 'string', - 'example' => '728C5E01-ABF6-5AA8-B9FC-B3BA05DECC77', - ], - 'InstanceId' => [ - 'title' => '实例id。', - 'description' => '', - 'type' => 'string', - 'example' => 'pairec-test1', - ], - 'Type' => [ - 'title' => '实例类型。'."\n" - .'● basic-基础版'."\n" - .'● highleve-升级版'."\n" - .'● advance-进阶版'."\n" - .'● standard-标准版', - 'description' => '', - 'type' => 'string', - 'example' => 'basic', - ], - 'Status' => [ - 'title' => '实例状态。'."\n" - .'● Initializing-初始化中'."\n" - .'● Stopped-停止服务'."\n" - .'● Running-运行中', - 'description' => '', - 'type' => 'string', - 'example' => 'Initializing', - ], - 'RegionId' => [ - 'title' => '区域ID。'."\n" - .'● cn-shenzhen - 深圳'."\n" - .'● cn-hangzhou - 杭州'."\n" - .'● cn-beijing - 北京'."\n" - .'● cn-shanghai - 上海', - 'description' => '', - 'type' => 'string', - 'example' => 'cn-shenzhen', - ], - 'GmtCreateTime' => [ - 'title' => '实例创建时间。', - 'description' => '', - 'type' => 'string', - 'example' => '2022-10-13 17:34:52.0', - ], - 'GmtModifiedTime' => [ - 'title' => '实例更新时间。', - 'description' => '', - 'type' => 'string', - 'example' => '2022-11-05 09:02:30.0', - ], - 'ExpiredTime' => [ - 'title' => '实例过期时间。', - 'description' => '', - 'type' => 'string', - 'example' => '2022-12-14 00:00:00.0', - ], - 'CommodityCode' => [ - 'title' => '实例所属的商品code。', - 'description' => '', - 'type' => 'string', - 'example' => 'airec_developers_public_cn', - ], - 'ChargeType' => [ - 'title' => '实例的付费类型，目前仅支持Subscription（预付费）。', - 'description' => '', - 'type' => 'string', - 'example' => 'Subscription', - ], - 'Config' => [ - 'title' => '实例配置。', - 'description' => '', - 'type' => 'object', - 'properties' => [ - 'Engines' => [ - 'title' => '服务引擎列表。', - 'description' => '', - 'type' => 'array', - 'items' => [ - 'type' => 'object', - 'properties' => [ - 'ComponentCode' => [ - 'title' => '组件代码。', - 'description' => '', - 'type' => 'string', - 'example' => 'feature', - ], - 'Type' => [ - 'title' => '组件类型。', - 'description' => '', - 'type' => 'string', - 'example' => 'Hologres', - ], - 'Meta' => [ - 'title' => '元数据。', - 'description' => '', - 'type' => 'object', - ], - ], - ], - ], - 'Monitors' => [ - 'title' => '配套功能列表。', - 'description' => '', - 'type' => 'array', - 'items' => [ - 'type' => 'object', - 'properties' => [ - 'ComponentCode' => [ - 'title' => '组件代码。', - 'description' => '', - 'type' => 'string', - 'example' => 'featuresets', - ], - 'Type' => [ - 'title' => '组件类型。', - 'description' => '', - 'type' => 'string', - 'example' => 'Platform', - ], - 'Meta' => [ - 'title' => '元数据。', - 'description' => '', - 'type' => 'object', - ], - ], - ], - ], - 'DataManagements' => [ - 'title' => '建模环境列表。', - 'description' => '', - 'type' => 'array', - 'items' => [ - 'type' => 'object', - 'properties' => [ - 'ComponentCode' => [ - 'title' => '组件代码。', - 'description' => '', - 'type' => 'string', - 'example' => 'storage', - ], - 'Type' => [ - 'title' => '组件类型。', - 'description' => '', - 'type' => 'string', - 'example' => 'OSS', - ], - 'Meta' => [ - 'title' => '元数据。', - 'description' => '', - 'type' => 'object', - ], - ], - ], - ], - ], - ], - 'OperatingTool' => [ - 'type' => 'object', - 'properties' => [ - 'IsEnable' => [ - 'type' => 'boolean', - ], - ], - ], + 'RequestId' => ['title' => '', 'description' => 'The request ID.', 'type' => 'string', 'example' => '728C5E01-ABF6-5AA8-B9FC-B3BA05DECC77'], + 'ConversationId' => ['title' => '', 'description' => 'The session ID.', 'type' => 'string', 'example' => 'e47cfae9-c0cc-42e1-91e2-e67cdb0e7b96'], + 'MessageId' => ['title' => '', 'description' => 'The message ID.', 'type' => 'string', 'example' => 'chat-abcdefg'], + 'Event' => ['title' => '', 'description' => 'The event.', 'type' => 'string', 'example' => 'message'], + 'Answer' => ['title' => '', 'description' => 'The reply content.', 'type' => 'string', 'example' => 'FeatureDB近7天读写量为xxx'], + 'GmtCreateTime' => ['title' => '', 'description' => 'The creation time.', 'type' => 'string', 'example' => '2021-12-15T23:24:33.132+08:00'], + 'ErrorCode' => ['title' => '', 'description' => 'The error code.', 'type' => 'string', 'example' => 'SERVER_ERROR'], + 'ErrorMessage' => ['title' => '', 'description' => 'The error message.', 'type' => 'string', 'example' => 'connection failed'], + 'SkillName' => ['title' => '', 'description' => 'The skill name.', 'type' => 'string', 'example' => '""'], + 'Func' => ['title' => '', 'description' => 'The function name.', 'type' => 'string', 'example' => '""'], + 'CallId' => ['title' => '', 'description' => 'The call ID.', 'type' => 'string', 'example' => '""'], ], + 'example' => '', ], ], ], - 'staticInfo' => [ - 'returnType' => 'synchronous', + 'staticInfo' => ['returnType' => 'synchronous'], + 'title' => 'Send conversation message', + 'description' => '## Operation description'."\n" + .'- Call this API operation to send a conversation message to an agent. Server-Sent Events (SSE) is supported.'."\n" + .'- If the `ConversationId` parameter is specified, the conversation continues in the context of the specified existing session. If this parameter is not specified, automatic creation of a new session is performed.'."\n" + .'- The `Config` field allows you to pass additional information input. The value must be in JSON format.'."\n" + .'- If the request succeeds, the response includes the message ID, reply content, and other information for this conversation. If a fault occurs, the corresponding error code and error message are returned.', + 'changeSet' => [], + 'flowControl' => [ + 'flowControlList' => [], ], - 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"728C5E01-ABF6-5AA8-B9FC-B3BA05DECC77\\",\\n \\"InstanceId\\": \\"pairec-test1\\",\\n \\"Type\\": \\"basic\\",\\n \\"Status\\": \\"Initializing\\",\\n \\"RegionId\\": \\"cn-shenzhen\\",\\n \\"GmtCreateTime\\": \\"2022-10-13 17:34:52.0\\",\\n \\"GmtModifiedTime\\": \\"2022-11-05 09:02:30.0\\",\\n \\"ExpiredTime\\": \\"2022-12-14 00:00:00.0\\",\\n \\"CommodityCode\\": \\"airec_developers_public_cn\\",\\n \\"ChargeType\\": \\"Subscription\\",\\n \\"Config\\": {\\n \\"Engines\\": [\\n {\\n \\"ComponentCode\\": \\"feature\\",\\n \\"Type\\": \\"Hologres\\",\\n \\"Meta\\": {\\n \\"test\\": \\"test\\",\\n \\"test2\\": 1\\n }\\n }\\n ],\\n \\"Monitors\\": [\\n {\\n \\"ComponentCode\\": \\"featuresets\\",\\n \\"Type\\": \\"Platform\\",\\n \\"Meta\\": {\\n \\"test\\": \\"test\\",\\n \\"test2\\": 1\\n }\\n }\\n ],\\n \\"DataManagements\\": [\\n {\\n \\"ComponentCode\\": \\"storage\\",\\n \\"Type\\": \\"OSS\\",\\n \\"Meta\\": {\\n \\"test\\": \\"test\\",\\n \\"test2\\": 1\\n }\\n }\\n ]\\n },\\n \\"OperatingTool\\": {\\n \\"IsEnable\\": true\\n }\\n}","type":"json"}]', - ], - 'GetRecallManagementConfig' => [ - 'summary' => '获取召回管理初始化配置。', - 'path' => '/api/v1/recallmanagementconfigs', - 'methods' => [ - 'get', - ], - 'schemes' => [ - 'https', + 'ramActions' => [ + [ + 'operationType' => 'none', + 'ramAction' => [ + 'action' => 'pairec:ChatConversation', + 'authLevel' => 'operate', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'PAIRecService', 'resourceType' => 'All Resource', 'arn' => '*'], + ], + ], + ], ], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"728C5E01-ABF6-5AA8-B9FC-B3BA05DECC77\\",\\n \\"ConversationId\\": \\"e47cfae9-c0cc-42e1-91e2-e67cdb0e7b96\\",\\n \\"MessageId\\": \\"chat-abcdefg\\",\\n \\"Event\\": \\"message\\",\\n \\"Answer\\": \\"FeatureDB近7天读写量为xxx\\",\\n \\"GmtCreateTime\\": \\"2021-12-15T23:24:33.132+08:00\\",\\n \\"ErrorCode\\": \\"SERVER_ERROR\\",\\n \\"ErrorMessage\\": \\"connection failed\\",\\n \\"SkillName\\": \\"\\\\\\"\\\\\\"\\",\\n \\"Func\\": \\"\\\\\\"\\\\\\"\\",\\n \\"CallId\\": \\"\\\\\\"\\\\\\"\\"\\n}","type":"json"}]', + ], + 'CheckInstanceResources' => [ + 'summary' => 'Verifies access to resources configured for an instance.', + 'path' => '/api/v1/instances/{InstanceId}/action/checkresources', + 'methods' => ['post'], + 'schemes' => ['http', 'https'], 'security' => [ [ 'AK' => [], ], ], - 'consumes' => [ - 'application/json', - ], - 'produces' => [ - 'application/json', - ], + 'consumes' => ['application/json'], + 'produces' => ['application/json'], 'operationType' => 'read', 'deprecated' => false, 'systemTags' => [ - 'operationType' => 'get', + 'operationType' => 'none', 'riskType' => 'none', 'chargeType' => 'free', - 'abilityTreeNodes' => [ - 'FEATURElearnN0NAWV', - ], + 'abilityTreeNodes' => ['FEATURElearnN0NAWV'], ], 'parameters' => [ [ - 'name' => 'InstanceId', - 'in' => 'query', + 'name' => 'body', + 'in' => 'body', + 'style' => 'json', 'schema' => [ - 'description' => '', - 'type' => 'string', + 'description' => 'The request body.', + 'type' => 'object', + 'properties' => [ + 'Type' => ['description' => 'The resource type. Valid values:'."\n" + ."\n" + .'- Hologres'."\n" + ."\n" + .'- EAS'."\n" + ."\n" + .'- BE'."\n" + ."\n" + .'- Rec'."\n" + ."\n" + .'- Platform'."\n" + ."\n" + .'- SLS'."\n" + ."\n" + .'- DataHub'."\n" + ."\n" + .'- Kafka'."\n" + ."\n" + .'- Flinkvvp'."\n" + ."\n" + .'- ACR'."\n" + ."\n" + .'- OSS'."\n" + ."\n" + .'- DataWorks'."\n" + ."\n" + .'- PAI'."\n" + ."\n" + .'- MaxCompute'."\n" + ."\n" + .'- GraphCompute'."\n" + ."\n" + .'- Redis', 'type' => 'string', 'required' => true, 'example' => 'OSS', 'title' => ''], + 'Uri' => ['description' => 'The resource URI.', 'type' => 'string', 'required' => false, 'example' => 'bucket-test-123', 'title' => ''], + 'ResourceId' => ['type' => 'string', 'description' => '', 'required' => false, 'title' => '', 'example' => ''], + ], 'required' => false, - 'example' => 'learn-pairec-xxx', + 'title' => '', + 'example' => '', ], ], + [ + 'name' => 'InstanceId', + 'in' => 'path', + 'schema' => ['description' => 'The instance ID. You can obtain this ID by calling the [ListInstances](~~2411819~~) operation.', 'type' => 'string', 'required' => true, 'example' => 'pairec-cn-test1', 'title' => ''], + ], ], 'responses' => [ 200 => [ 'schema' => [ 'title' => 'Schema of Response', - 'description' => 'Schema of Response', + 'description' => 'The response data.', 'type' => 'object', 'properties' => [ - 'RequestId' => [ - 'title' => 'Id of the request', - 'description' => 'Id of the request', - 'type' => 'string', - 'example' => '728C5E01-ABF6-5AA8-B9FC-B3BA05DECC77', - ], - 'UserName' => [ - 'description' => '', - 'type' => 'string', - 'example' => 'scene_test', - ], - 'NetworkConfigs' => [ - 'description' => '', + 'RequestId' => ['title' => 'Id of the request', 'description' => 'The request ID.', 'type' => 'string', 'example' => '9763624B-5FBB-5E3A-9193-B1ADB554CEAE'], + 'Resources' => [ + 'description' => 'A list of resources.', 'type' => 'array', 'items' => [ - 'description' => '', + 'description' => 'The details of a resource.', 'type' => 'object', 'properties' => [ - 'VpcId' => [ - 'description' => '', - 'type' => 'string', - 'example' => 'vpc-xxx', - ], - 'Status' => [ - 'description' => '', - 'type' => 'string', - 'example' => 'Connecting', - ], - 'VswitchIds' => [ - 'description' => '', - 'type' => 'object', - 'additionalProperties' => [ - 'type' => 'string', - 'example' => 'vsw-xxx', - 'description' => '', - ], - ], - 'PrivateLinkAddress' => [ - 'description' => '', - 'type' => 'string', - 'example' => 'http://xxx', - ], + 'Type' => ['description' => 'The resource type. Valid values:'."\n" + ."\n" + .'- Hologres'."\n" + ."\n" + .'- EAS'."\n" + ."\n" + .'- BE'."\n" + ."\n" + .'- Rec'."\n" + ."\n" + .'- Platform'."\n" + ."\n" + .'- SLS'."\n" + ."\n" + .'- DataHub'."\n" + ."\n" + .'- Kafka'."\n" + ."\n" + .'- Flinkvvp'."\n" + ."\n" + .'- ACR'."\n" + ."\n" + .'- OSS'."\n" + ."\n" + .'- DataWorks'."\n" + ."\n" + .'- PAI'."\n" + ."\n" + .'- MaxCompute'."\n" + ."\n" + .'- GraphCompute'."\n" + ."\n" + .'- Redis', 'type' => 'string', 'example' => 'OSS', 'title' => ''], + 'Uri' => ['description' => 'The resource URI.', 'type' => 'string', 'example' => 'bucket-test-123', 'title' => ''], + 'Status' => ['description' => 'The access status. Valid values:'."\n" + ."\n" + .'- Success'."\n" + ."\n" + .'- Failure', 'type' => 'string', 'example' => 'Success', 'title' => ''], ], + 'title' => '', + 'example' => '', ], + 'title' => '', + 'example' => '', ], ], + 'example' => '', ], ], ], - 'staticInfo' => [ - 'returnType' => 'synchronous', + 'staticInfo' => ['returnType' => 'synchronous'], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"9763624B-5FBB-5E3A-9193-B1ADB554CEAE\\",\\n \\"Resources\\": [\\n {\\n \\"Type\\": \\"OSS\\",\\n \\"Uri\\": \\"bucket-test-123\\",\\n \\"Status\\": \\"Success\\"\\n }\\n ]\\n}","type":"json"}]', + 'title' => 'Check Resource Status', + 'changeSet' => [ + ['createdAt' => '2025-05-19T06:21:38.000Z', 'description' => 'Request parameters changed'], + ['createdAt' => '2024-02-22T03:35:43.000Z', 'description' => 'Request parameters changed'], + ], + 'flowControl' => [ + 'flowControlList' => [], + ], + 'ramActions' => [ + [ + 'operationType' => 'none', + 'ramAction' => [ + 'action' => 'pairec:CheckInstanceResources', + 'authLevel' => 'operate', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'PAIRecService', 'resourceType' => 'All Resource', 'arn' => '*'], + ], + ], + ], ], - 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"728C5E01-ABF6-5AA8-B9FC-B3BA05DECC77\\",\\n \\"UserName\\": \\"scene_test\\",\\n \\"NetworkConfigs\\": [\\n {\\n \\"VpcId\\": \\"vpc-xxx\\",\\n \\"Status\\": \\"Connecting\\",\\n \\"VswitchIds\\": {\\n \\"key\\": \\"vsw-xxx\\"\\n },\\n \\"PrivateLinkAddress\\": \\"http://xxx\\"\\n }\\n ]\\n}","type":"json"}]', ], - 'GetRecallManagementServiceVersion' => [ - 'summary' => '获取指定召回管理版本详细信息', - 'path' => '/api/v1/recallmanagementservices/{RecallManagementServiceId}/versions/{RecallManagementServiceVersionId}', - 'methods' => [ - 'get', - ], - 'schemes' => [ - 'https', - ], + 'CheckTrafficControlTaskExpression' => [ + 'summary' => 'Validates a traffic control task expression.', + 'path' => '/api/v1/trafficcontroltasks/action/checkexpression', + 'methods' => ['get'], + 'schemes' => ['http', 'https'], 'security' => [ [ 'AK' => [], ], ], - 'consumes' => [ - 'application/json', - ], - 'produces' => [ - 'application/json', - ], + 'consumes' => ['application/json'], + 'produces' => ['application/json'], 'operationType' => 'read', 'deprecated' => false, 'systemTags' => [ 'operationType' => 'none', 'riskType' => 'none', 'chargeType' => 'free', - 'abilityTreeNodes' => [ - 'FEATURElearnN0NAWV', - ], + 'abilityTreeCode' => '226483', + 'abilityTreeNodes' => ['FEATURElearnN0NAWV'], ], 'parameters' => [ [ - 'name' => 'RecallManagementServiceId', - 'in' => 'path', - 'schema' => [ - 'description' => '', - 'type' => 'string', - 'required' => false, - 'example' => '3', - ], + 'name' => 'InstanceId', + 'in' => 'query', + 'schema' => ['description' => 'The ID of the instance.', 'type' => 'string', 'required' => true, 'example' => 'pairec_123****', 'title' => ''], ], [ - 'name' => 'RecallManagementServiceVersionId', - 'in' => 'path', - 'schema' => [ - 'description' => '', - 'type' => 'string', - 'required' => false, - 'example' => '2', - ], + 'name' => 'Expression', + 'in' => 'query', + 'schema' => ['description' => 'The expression to validate.', 'type' => 'string', 'required' => true, 'example' => 'event=exposure', 'title' => ''], ], [ - 'name' => 'InstanceId', + 'name' => 'TableMetaId', 'in' => 'query', - 'schema' => [ - 'description' => '', - 'type' => 'string', - 'required' => false, - 'example' => 'learn-pairec-xxx', - ], + 'schema' => ['description' => 'The ID of the table.', 'type' => 'string', 'required' => true, 'example' => '1', 'title' => ''], ], ], 'responses' => [ 200 => [ 'schema' => [ + 'description' => 'The response object.', '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' => 'E15A1443-7917-5BE0-AE70-25538ECF398D', - ], - 'RecallManagementServiceVersionId' => [ - 'description' => '', - 'type' => 'string', - 'example' => '2', - ], - 'Name' => [ - 'description' => '', - 'type' => 'string', - 'example' => 'V1', - ], - 'IsDefault' => [ - 'description' => '', - 'type' => 'string', - 'example' => 'false', - ], - 'Configs' => [ - 'description' => '', - 'type' => 'object', - 'properties' => [ - 'RecallConfigs' => [ - 'description' => '', - 'type' => 'array', - 'items' => [ - 'description' => '', - 'type' => 'object', - 'properties' => [ - 'Name' => [ - 'description' => '', - 'type' => 'string', - 'example' => 'etrec', - ], - 'Description' => [ - 'description' => '', - 'type' => 'string', - 'example' => 'this is etrec recall', - ], - 'Priority' => [ - 'description' => '', - 'type' => 'integer', - 'format' => 'int64', - 'example' => '10', - ], - 'RecallType' => [ - 'description' => '', - 'type' => 'string', - 'example' => 'X2I', - ], - 'RecallManagementTableId' => [ - 'description' => '', - 'type' => 'string', - 'example' => '2', - ], - 'UserVectorRecallManagementTableId' => [ - 'description' => '', - 'type' => 'string', - 'example' => '3', - ], - 'UserVectorField' => [ - 'description' => '', - 'type' => 'string', - 'example' => 'user_embedding', - ], - 'ItemVectorRecallManagementTableId' => [ - 'description' => '', - 'type' => 'string', - 'example' => '4', - ], - 'ItemVectorField' => [ - 'description' => '', - 'type' => 'string', - 'example' => 'item_embedding', - ], - 'Operators' => [ - 'description' => '', - 'type' => 'array', - 'items' => [ - 'description' => '', - 'type' => 'object', - 'properties' => [ - 'OperatorType' => [ - 'description' => '', - 'type' => 'string', - 'example' => 'Filter', - ], - 'TriggerConfig' => [ - 'description' => '', - 'type' => 'object', - 'properties' => [ - 'Field' => [ - 'description' => '', - 'type' => 'string', - 'example' => 'user_id', - ], - 'IsRandSort' => [ - 'description' => '', - 'type' => 'string', - 'example' => 'false', - ], - 'SortField' => [ - 'description' => '', - 'type' => 'string', - 'example' => 'create_time', - ], - 'FieldQuantityLimit' => [ - 'description' => '', - 'type' => 'string', - 'example' => '20', - ], - ], - ], - 'FilterConfig' => [ - 'description' => '', - 'type' => 'object', - 'properties' => [ - 'Experession' => [ - 'description' => '', - 'type' => 'string', - 'example' => 'age > 10', - ], - ], - ], - 'FeatureConfig' => [ - 'description' => '', - 'type' => 'object', - 'properties' => [ - 'Name' => [ - 'description' => '', - 'type' => 'string', - 'example' => 'city', - ], - 'Type' => [ - 'description' => '', - 'type' => 'string', - 'example' => 'STRING', - ], - 'Expression' => [ - 'description' => '', - 'type' => 'string', - 'example' => 'city = \'hangzhou\'', - ], - ], - ], - 'JoinConfig' => [ - 'description' => '', - 'type' => 'object', - 'properties' => [ - 'Field' => [ - 'description' => '', - 'type' => 'string', - 'example' => 'item_id', - ], - 'RecallManagementTableId' => [ - 'description' => '', - 'type' => 'string', - 'example' => '3', - ], - 'OutputFields' => [ - 'description' => '', - 'type' => 'array', - 'items' => [ - 'description' => '', - 'type' => 'string', - 'example' => 'category', - ], - ], - ], - ], - ], - ], - ], - 'ExtendedConfig' => [ - 'description' => '', - 'type' => 'string', - 'example' => '""', - ], - 'RecallManagementServiceVersionConfigId' => [ - 'description' => '', - 'type' => 'string', - 'example' => '5', - ], - 'ItemConditionArray' => [ - 'description' => '', - 'type' => 'string', - 'example' => '[{"option":"<","field":"category","type":"STRING","value":"10"}]', - ], - 'ItemConditionExpression' => [ - 'title' => '物品条件表达式。', - 'type' => 'string', - 'example' => 'age>20', - ], - ], - ], - ], - 'MergeConfig' => [ - 'description' => '', - 'type' => 'object', - 'properties' => [ - 'RecallManagementServiceVersionConfigId' => [ - 'description' => '', - 'type' => 'string', - 'example' => '1', - ], - 'MergeType' => [ - 'description' => '', - 'type' => 'string', - 'example' => 'Weight', - ], - 'FilterRecallManagementTableIds' => [ - 'description' => '', - 'type' => 'array', - 'items' => [ - 'description' => '', - 'type' => 'string', - 'example' => '3', - ], - ], - 'ItemRecallManagementTableId' => [ - 'description' => '', - 'type' => 'string', - 'example' => '2', - ], - 'ItemTableFields' => [ - 'description' => '', - 'type' => 'array', - 'items' => [ - 'description' => '', - 'type' => 'string', - 'example' => 'item_id', - ], - ], - 'ExtendedConfig' => [ - 'description' => '', - 'type' => 'string', - 'example' => '""', - ], - 'FilterExpression' => [ - 'description' => '', - 'type' => 'string', - 'example' => 'age>20', - ], - ], - ], - ], - ], - 'GmtCreateTime' => [ - 'description' => '', - 'type' => 'string', - 'example' => '2021-12-15T23:24:33.132+08:00', - ], - 'GmtModifiedTime' => [ - 'description' => '', - 'type' => 'string', - 'example' => '2021-12-15T23:24:33.132+08:00', - ], - 'IsEffective' => [ - 'title' => '当前版本是否有效。', - 'type' => 'boolean', - 'default' => 'false', - ], + 'RequestId' => ['title' => 'Id of the request', 'description' => 'The request ID.', 'type' => 'string', 'example' => '728C5E01-ABF6-5AA8-B9FC-B3BA05DECC77'], + 'IsValie' => ['description' => 'Indicates whether the expression is valid.', 'type' => 'boolean', 'example' => 'true', 'title' => ''], + 'Reason' => ['description' => 'If `IsValid` is `false`, this field provides the reason for the failure.', 'type' => 'string', 'example' => '""', 'title' => ''], ], + 'example' => '', ], ], ], - 'staticInfo' => [ - 'returnType' => 'synchronous', + 'staticInfo' => ['returnType' => 'synchronous'], + 'title' => 'Validate Traffic Regulation Job Expression', + 'description' => '## Description'."\n" + ."\n" + .'This operation validates a traffic control task expression for a specific instance and table. Provide the correct `InstanceId`, `TableMetaId`, and `Expression` parameters.', + 'changeSet' => [], + 'flowControl' => [ + 'flowControlList' => [], ], - 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"E15A1443-7917-5BE0-AE70-25538ECF398D\\",\\n \\"RecallManagementServiceVersionId\\": \\"2\\",\\n \\"Name\\": \\"V1\\",\\n \\"IsDefault\\": \\"false\\",\\n \\"Configs\\": {\\n \\"RecallConfigs\\": [\\n {\\n \\"Name\\": \\"etrec\\",\\n \\"Description\\": \\"this is etrec recall\\",\\n \\"Priority\\": 10,\\n \\"RecallType\\": \\"X2I\\",\\n \\"RecallManagementTableId\\": \\"2\\",\\n \\"UserVectorRecallManagementTableId\\": \\"3\\",\\n \\"UserVectorField\\": \\"user_embedding\\",\\n \\"ItemVectorRecallManagementTableId\\": \\"4\\",\\n \\"ItemVectorField\\": \\"item_embedding\\",\\n \\"Operators\\": [\\n {\\n \\"OperatorType\\": \\"Filter\\",\\n \\"TriggerConfig\\": {\\n \\"Field\\": \\"user_id\\",\\n \\"IsRandSort\\": \\"false\\",\\n \\"SortField\\": \\"create_time\\",\\n \\"FieldQuantityLimit\\": \\"20\\"\\n },\\n \\"FilterConfig\\": {\\n \\"Experession\\": \\"age > 10\\"\\n },\\n \\"FeatureConfig\\": {\\n \\"Name\\": \\"city\\",\\n \\"Type\\": \\"STRING\\",\\n \\"Expression\\": \\"city = \'hangzhou\'\\"\\n },\\n \\"JoinConfig\\": {\\n \\"Field\\": \\"item_id\\",\\n \\"RecallManagementTableId\\": \\"3\\",\\n \\"OutputFields\\": [\\n \\"category\\"\\n ]\\n }\\n }\\n ],\\n \\"ExtendedConfig\\": \\"\\\\\\"\\\\\\"\\",\\n \\"RecallManagementServiceVersionConfigId\\": \\"5\\",\\n \\"ItemConditionArray\\": \\"[{\\\\\\"option\\\\\\":\\\\\\"<\\\\\\",\\\\\\"field\\\\\\":\\\\\\"category\\\\\\",\\\\\\"type\\\\\\":\\\\\\"STRING\\\\\\",\\\\\\"value\\\\\\":\\\\\\"10\\\\\\"}]\\",\\n \\"ItemConditionExpression\\": \\"age>20\\"\\n }\\n ],\\n \\"MergeConfig\\": {\\n \\"RecallManagementServiceVersionConfigId\\": \\"1\\",\\n \\"MergeType\\": \\"Weight\\",\\n \\"FilterRecallManagementTableIds\\": [\\n \\"3\\"\\n ],\\n \\"ItemRecallManagementTableId\\": \\"2\\",\\n \\"ItemTableFields\\": [\\n \\"item_id\\"\\n ],\\n \\"ExtendedConfig\\": \\"\\\\\\"\\\\\\"\\",\\n \\"FilterExpression\\": \\"age>20\\"\\n }\\n },\\n \\"GmtCreateTime\\": \\"2021-12-15T23:24:33.132+08:00\\",\\n \\"GmtModifiedTime\\": \\"2021-12-15T23:24:33.132+08:00\\",\\n \\"IsEffective\\": true\\n}","type":"json"}]', - ], - 'GetRecallManagementServiceVersionConfig' => [ - 'summary' => '获取召回管理服务版本配置详细信息', - 'path' => '/api/v1/recallmanagementservices/{RecallManagementServiceId}/versions/{RecallManagementServiceVersionId}/configs/{RecallManagementServiceVersionConfigId}', - 'methods' => [ - 'get', - ], - 'schemes' => [ - 'https', + 'ramActions' => [ + [ + 'operationType' => 'none', + 'ramAction' => [ + 'action' => 'pairec:CheckTrafficControlTaskExpression', + 'authLevel' => 'operate', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'PAIRecService', 'resourceType' => 'All Resource', 'arn' => '*'], + ], + ], + ], ], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"728C5E01-ABF6-5AA8-B9FC-B3BA05DECC77\\",\\n \\"IsValie\\": true,\\n \\"Reason\\": \\"\\\\\\"\\\\\\"\\"\\n}","type":"json"}]', + ], + 'CloneEngineConfig' => [ + 'summary' => 'Clones an engine configuration.', + 'path' => '/api/v1/engineconfigs/{EngineConfigId}/action/clone', + 'methods' => ['post'], + 'schemes' => ['http', 'https'], 'security' => [ [ 'AK' => [], ], ], - 'consumes' => [ - 'application/json', - ], - 'produces' => [ - 'application/json', - ], - 'operationType' => 'read', + 'consumes' => ['application/json'], + 'produces' => ['application/json'], + 'operationType' => 'readAndWrite', 'deprecated' => false, 'systemTags' => [ 'operationType' => 'none', 'riskType' => 'none', 'chargeType' => 'free', - 'abilityTreeNodes' => [ - 'FEATURElearnN0NAWV', - ], + 'abilityTreeCode' => '180296', + 'abilityTreeNodes' => ['FEATURElearnN0NAWV'], ], 'parameters' => [ [ - 'name' => 'RecallManagementServiceId', + 'name' => 'EngineConfigId', 'in' => 'path', + 'schema' => ['description' => 'The engine configuration ID.', 'type' => 'string', 'required' => false, 'example' => '1', 'title' => ''], + ], + [ + 'name' => 'body', + 'in' => 'body', + 'style' => 'json', 'schema' => [ - 'description' => '', - 'type' => 'string', + 'description' => 'The request body.', + 'type' => 'object', + 'properties' => [ + 'ConfigValue' => ['description' => 'The content of the engine configuration.', 'type' => 'string', 'required' => false, 'example' => '{}', 'title' => ''], + 'InstanceId' => ['description' => 'The instance ID. To obtain an instance ID, see [ListInstances](~~2411819~~).', 'type' => 'string', 'required' => false, 'example' => 'pairec-cn-********', 'title' => ''], + 'Environment' => ['description' => 'The environment. Valid values:'."\n" + ."\n" + .'- Daily: The daily environment.'."\n" + ."\n" + .'- Pre: The pre-release environment.'."\n" + ."\n" + .'- Prod: The production environment.', 'type' => 'string', 'required' => false, 'example' => 'Pre', 'title' => ''], + 'Description' => ['type' => 'string', 'description' => '', 'required' => false, 'title' => '', 'example' => ''], + ], 'required' => false, - 'example' => '3', + 'title' => '', + 'example' => '', ], ], - [ - 'name' => 'RecallManagementServiceVersionId', - 'in' => 'path', + ], + 'responses' => [ + 200 => [ 'schema' => [ - 'description' => '', - 'type' => 'string', - 'required' => false, - 'example' => '2', + 'title' => 'Schema of Response', + 'description' => 'The response body.', + 'type' => 'object', + 'properties' => [ + 'RequestId' => ['title' => 'Id of the request', 'description' => 'The request ID.', 'type' => 'string', 'example' => 'A04CB8C0-E74A-5E83-BC61-64D153574EC7'], + 'EngineConfigId' => ['description' => 'The engine configuration ID.', 'type' => 'string', 'example' => '2', 'title' => ''], + ], + 'example' => '', ], ], + ], + 'staticInfo' => ['returnType' => 'synchronous'], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"A04CB8C0-E74A-5E83-BC61-64D153574EC7\\",\\n \\"EngineConfigId\\": \\"2\\"\\n}","type":"json"}]', + 'title' => 'Clone DPI Engine Configuration', + 'changeSet' => [ + ['createdAt' => '2024-12-27T08:56:39.000Z', 'description' => 'Request parameters changed'], + ], + 'flowControl' => [ + 'flowControlList' => [], + ], + 'ramActions' => [ + [ + 'operationType' => 'none', + 'ramAction' => [ + 'action' => 'pairec:CloneEngineConfig', + 'authLevel' => 'operate', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'PAIRecService', 'resourceType' => 'All Resource', 'arn' => '*'], + ], + ], + ], + ], + ], + 'CloneExperiment' => [ + 'summary' => 'Clones a specified experiment.', + 'path' => '/api/v1/experiments/{ExperimentId}/action/clone', + 'methods' => ['post'], + 'schemes' => ['http', 'https'], + 'security' => [ [ - 'name' => 'RecallManagementServiceVersionConfigId', + 'AK' => [], + ], + ], + 'consumes' => ['application/json'], + 'produces' => ['application/json'], + 'operationType' => 'readAndWrite', + 'deprecated' => false, + 'systemTags' => [ + 'operationType' => 'none', + 'riskType' => 'none', + 'chargeType' => 'free', + 'abilityTreeNodes' => ['FEATURElearnN0NAWV'], + ], + 'parameters' => [ + [ + 'name' => 'ExperimentId', 'in' => 'path', - 'schema' => [ - 'description' => '', - 'type' => 'string', - 'required' => false, - 'example' => '3', - ], + 'schema' => ['description' => 'The experiment ID.', 'type' => 'string', 'required' => true, 'example' => 'experiment_test', 'title' => ''], ], [ - 'name' => 'InstanceId', - 'in' => 'query', + 'name' => 'body', + 'in' => 'body', + 'style' => 'json', 'schema' => [ - 'description' => '', - 'type' => 'string', + 'description' => 'The request body.', + 'type' => 'object', + 'properties' => [ + 'InstanceId' => ['description' => 'The instance ID. Call the ListInstances operation to get the instance ID.', 'type' => 'string', 'required' => true, 'example' => 'pairec-cn-abcdefg1234'."\n", 'title' => ''], + ], 'required' => false, - 'example' => 'learn-pairec-xxx', + 'title' => '', + 'example' => '', ], ], ], @@ -1330,396 +873,80 @@ 200 => [ 'schema' => [ 'title' => 'Schema of Response', - 'description' => 'Schema of Response', + 'description' => 'The response object.', 'type' => 'object', 'properties' => [ - 'RequestId' => [ - 'title' => 'Id of the request', - 'description' => 'Id of the request', - 'type' => 'string', - 'example' => '728C5E01-ABF6-5AA8-B9FC-B3BA05DECC77', - ], - 'RecallManagementServiceId' => [ - 'description' => '', - 'type' => 'string', - 'example' => '3', - ], - 'RecallManagementServiceVersionId' => [ - 'description' => '', - 'type' => 'string', - 'example' => '2', - ], - 'RecallManagementServiceVersionConfigId' => [ - 'description' => '', - 'type' => 'string', - 'example' => '2', - ], - 'ConfigType' => [ - 'description' => '', - 'type' => 'string', - 'example' => 'Recall', - ], - 'RecallConfig' => [ - 'description' => '', - 'type' => 'object', - 'properties' => [ - 'Name' => [ - 'description' => '', - 'type' => 'string', - 'example' => 'etrec', - ], - 'Description' => [ - 'description' => '', - 'type' => 'string', - 'example' => 'this is etrec recall', - ], - 'Priority' => [ - 'description' => '', - 'type' => 'integer', - 'format' => 'int64', - 'example' => '10', - ], - 'RecallType' => [ - 'description' => '', - 'type' => 'string', - 'example' => 'X2I', - ], - 'RecallManagementTableId' => [ - 'description' => '', - 'type' => 'string', - 'example' => '3', - ], - 'UserVectorRecallManagementTableId' => [ - 'description' => '', - 'type' => 'string', - 'example' => '2', - ], - 'UserVectorField' => [ - 'description' => '', - 'type' => 'string', - 'example' => 'user_embedding', - ], - 'ItemVectorRecallManagementTableId' => [ - 'description' => '', - 'type' => 'string', - 'example' => '2', - ], - 'ItemVectorField' => [ - 'description' => '', - 'type' => 'string', - 'example' => 'item_embedding', - ], - 'Operators' => [ - 'description' => '', - 'type' => 'array', - 'properties' => [ - 'OperatorType' => [ - 'name' => 'OperatorType', - 'description' => '', - 'type' => 'string', - 'example' => 'Filter', - ], - 'TriggerConfig' => [ - 'name' => 'TriggerConfig', - 'description' => '', - 'type' => 'object', - 'properties' => [ - 'Field' => [ - 'name' => 'Field', - 'description' => '', - 'type' => 'string', - 'example' => 'user_id', - ], - 'IsRandSort' => [ - 'name' => 'IsRandSort', - 'description' => '', - 'type' => 'string', - 'example' => 'False', - ], - 'SortField' => [ - 'name' => 'SortField', - 'description' => '', - 'type' => 'string', - 'example' => 'create_time', - ], - 'FieldQuantityLimit' => [ - 'name' => 'FieldQuantityLimit', - 'description' => '', - 'type' => 'string', - 'example' => '20', - ], - ], - ], - 'FilterConfig' => [ - 'name' => 'FilterConfig', - 'description' => '', - 'type' => 'object', - 'properties' => [ - 'Experession' => [ - 'name' => 'Experession', - 'description' => '', - 'type' => 'string', - 'example' => 'age>20', - ], - ], - ], - 'FeatureConfig' => [ - 'name' => 'FeatureConfig', - 'description' => '', - 'type' => 'object', - 'properties' => [ - 'Name' => [ - 'name' => 'Name', - 'description' => '', - 'type' => 'string', - 'example' => 'city', - ], - 'Type' => [ - 'name' => 'Type', - 'description' => '', - 'type' => 'string', - 'example' => 'string', - ], - 'Expression' => [ - 'name' => 'Expression', - 'description' => '', - 'type' => 'string', - 'example' => 'category=3', - ], - ], - ], - 'JoinConfig' => [ - 'name' => 'JoinConfig', - 'description' => '', - 'type' => 'object', - 'properties' => [ - 'Field' => [ - 'name' => 'Field', - 'description' => '', - 'type' => 'string', - 'example' => 'item_id', - ], - 'RecallManagementTableId' => [ - 'name' => 'RecallManagementTableId', - 'description' => '', - 'type' => 'string', - 'example' => '3', - ], - 'OutputFields' => [ - 'name' => 'OutputFields', - 'description' => '', - 'type' => 'array', - 'items' => [ - 'description' => '', - 'type' => 'string', - 'example' => 'item_id', - 'extendType' => 'true', - ], - 'itemName' => 'OutputFields', - ], - ], - ], - ], - 'items' => [ - 'type' => 'object', - 'properties' => [ - 'OperatorType' => [ - 'type' => 'string', - ], - 'TriggerConfig' => [ - 'type' => 'object', - 'properties' => [ - 'Field' => [ - 'type' => 'string', - ], - 'IsRandSort' => [ - 'type' => 'boolean', - ], - 'SortField' => [ - 'type' => 'string', - ], - 'FieldQuantityLimit' => [ - 'type' => 'integer', - 'format' => 'int32', - ], - ], - ], - 'FilterConfig' => [ - 'type' => 'object', - 'properties' => [ - 'Expression' => [ - 'type' => 'string', - ], - ], - ], - 'FeatureConfig' => [ - 'type' => 'object', - 'properties' => [ - 'Name' => [ - 'type' => 'string', - ], - 'Type' => [ - 'type' => 'string', - ], - 'Expression' => [ - 'type' => 'string', - ], - ], - ], - 'JoinConfig' => [ - 'type' => 'object', - 'properties' => [ - 'Field' => [ - 'type' => 'string', - ], - 'RecallManagementTableId' => [ - 'type' => 'string', - ], - 'OutputFields' => [ - 'type' => 'array', - 'items' => [ - 'type' => 'string', - ], - ], - ], - ], - ], - ], - ], - 'ExtendedConfig' => [ - 'description' => '', - 'type' => 'string', - 'example' => '{"":""}', - ], - 'ItemConditionArray' => [ - 'description' => '', - 'type' => 'string', - 'example' => '[{"option":"<","field":"category","type":"STRING","value":"10"}]', - ], - 'ItemConditionExpression' => [ - 'title' => '物品条件表达式。', - 'type' => 'string', - 'example' => 'age>20', - ], - ], - ], - 'MergeConfig' => [ - 'description' => '', - 'type' => 'object', - 'properties' => [ - 'RecallManagementServiceVersionConfigId' => [ - 'description' => '', - 'type' => 'string', - 'example' => '1', - ], - 'MergeType' => [ - 'description' => '', - 'type' => 'string', - 'example' => 'Weight', - ], - 'FilterRecallManagementTableIds' => [ - 'description' => '', - 'type' => 'array', - 'items' => [ - 'description' => '', - 'type' => 'string', - 'example' => '3', - ], - ], - 'ItemRecallManagementTableId' => [ - 'description' => '', - 'type' => 'string', - 'example' => '2', - ], - 'ItemTableFields' => [ - 'description' => '', - 'type' => 'array', - 'items' => [ - 'description' => '', - 'type' => 'string', - 'example' => 'item_id', - ], - ], - 'FilterExpression' => [ - 'description' => '', - 'type' => 'string', - 'example' => 'age>20', - ], - 'ExtendedConfig' => [ - 'description' => '', - 'type' => 'string', - 'example' => '{"":""}', - ], - ], - ], - 'GmtCreateTime' => [ - 'description' => '', - 'type' => 'string', - 'example' => '2021-12-15T23:24:33.132+08:00', - ], - 'GmtModifiedTime' => [ - 'description' => '', - 'type' => 'string', - 'example' => '2021-12-15T23:24:33.132+08:00', - ], + 'RequestId' => ['title' => 'Id of the request', 'description' => 'The request ID.', 'type' => 'string', 'example' => 'F8F613A9-DF1C-551A-88E1-397A3981A785'], + 'ExperimentId' => ['description' => 'The ID of the cloned experiment.', 'type' => 'string', 'example' => '3', 'title' => ''], ], + 'example' => '', ], ], ], - 'staticInfo' => [ - 'returnType' => 'synchronous', + 'staticInfo' => ['returnType' => 'synchronous'], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"F8F613A9-DF1C-551A-88E1-397A3981A785\\",\\n \\"ExperimentId\\": \\"3\\"\\n}","type":"json"}]', + 'title' => 'Clone Experiment', + 'changeSet' => [ + ['createdAt' => '2023-09-14T01:50:51.000Z', 'description' => 'Request parameters changed'], + ], + 'flowControl' => [ + 'flowControlList' => [], + ], + 'ramActions' => [ + [ + 'operationType' => 'none', + 'ramAction' => [ + 'action' => 'pairec:CloneExperiment', + 'authLevel' => 'operate', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'PAIRecService', 'resourceType' => 'All Resource', 'arn' => '*'], + ], + ], + ], ], - 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"728C5E01-ABF6-5AA8-B9FC-B3BA05DECC77\\",\\n \\"RecallManagementServiceId\\": \\"3\\",\\n \\"RecallManagementServiceVersionId\\": \\"2\\",\\n \\"RecallManagementServiceVersionConfigId\\": \\"2\\",\\n \\"ConfigType\\": \\"Recall\\",\\n \\"RecallConfig\\": {\\n \\"Name\\": \\"etrec\\",\\n \\"Description\\": \\"this is etrec recall\\",\\n \\"Priority\\": 10,\\n \\"RecallType\\": \\"X2I\\",\\n \\"RecallManagementTableId\\": \\"3\\",\\n \\"UserVectorRecallManagementTableId\\": \\"2\\",\\n \\"UserVectorField\\": \\"user_embedding\\",\\n \\"ItemVectorRecallManagementTableId\\": \\"2\\",\\n \\"ItemVectorField\\": \\"item_embedding\\",\\n \\"Operators\\": [\\n {\\n \\"OperatorType\\": \\"Filter\\",\\n \\"TriggerConfig\\": {\\n \\"Field\\": \\"user_id\\",\\n \\"IsRandSort\\": false,\\n \\"SortField\\": \\"create_time\\",\\n \\"FieldQuantityLimit\\": 20\\n },\\n \\"FilterConfig\\": {\\n \\"Expression\\": \\"age>20\\"\\n },\\n \\"FeatureConfig\\": {\\n \\"Name\\": \\"age\\",\\n \\"Type\\": \\"STRING\\",\\n \\"Expression\\": \\"category=3\\"\\n },\\n \\"JoinConfig\\": {\\n \\"Field\\": \\"item_id\\",\\n \\"RecallManagementTableId\\": \\"3\\",\\n \\"OutputFields\\": [\\n \\"item_id\\"\\n ]\\n }\\n }\\n ],\\n \\"ExtendedConfig\\": \\"{\\\\\\"\\\\\\":\\\\\\"\\\\\\"}\\",\\n \\"ItemConditionArray\\": \\"[{\\\\\\"option\\\\\\":\\\\\\"<\\\\\\",\\\\\\"field\\\\\\":\\\\\\"category\\\\\\",\\\\\\"type\\\\\\":\\\\\\"STRING\\\\\\",\\\\\\"value\\\\\\":\\\\\\"10\\\\\\"}]\\",\\n \\"ItemConditionExpression\\": \\"age>20\\"\\n },\\n \\"MergeConfig\\": {\\n \\"RecallManagementServiceVersionConfigId\\": \\"1\\",\\n \\"MergeType\\": \\"Weight\\",\\n \\"FilterRecallManagementTableIds\\": [\\n \\"3\\"\\n ],\\n \\"ItemRecallManagementTableId\\": \\"2\\",\\n \\"ItemTableFields\\": [\\n \\"item_id\\"\\n ],\\n \\"FilterExpression\\": \\"age>20\\",\\n \\"ExtendedConfig\\": \\"{\\\\\\"\\\\\\":\\\\\\"\\\\\\"}\\"\\n },\\n \\"GmtCreateTime\\": \\"2021-12-15T23:24:33.132+08:00\\",\\n \\"GmtModifiedTime\\": \\"2021-12-15T23:24:33.132+08:00\\"\\n}","type":"json"}]', ], - 'GetRecallManagementTable' => [ - 'summary' => '获取指定召回管理表详细信息。', - 'path' => '/api/v1/recallmanagementtables/{RecallManagementTableId}', - 'methods' => [ - 'get', - ], - 'schemes' => [ - 'https', - ], + 'CloneExperimentGroup' => [ + 'summary' => 'Clones an experiment group to a specified environment.', + 'path' => '/api/v1/experimentgroups/{ExperimentGroupId}/action/clone', + 'methods' => ['post'], + 'schemes' => ['http', 'https'], 'security' => [ [ 'AK' => [], ], ], - 'consumes' => [ - 'application/json', - ], - 'produces' => [ - 'application/json', - ], - 'operationType' => 'read', + 'consumes' => ['application/json'], + 'produces' => ['application/json'], + 'operationType' => 'readAndWrite', 'deprecated' => false, 'systemTags' => [ - 'operationType' => 'get', + 'operationType' => 'none', 'riskType' => 'none', 'chargeType' => 'free', - 'abilityTreeNodes' => [ - 'FEATURElearnN0NAWV', - ], + 'abilityTreeNodes' => ['FEATURElearnN0NAWV'], ], 'parameters' => [ [ - 'name' => 'RecallManagementTableId', + 'name' => 'ExperimentGroupId', 'in' => 'path', - 'schema' => [ - 'description' => '', - 'type' => 'string', - 'required' => true, - 'example' => '3', - ], + 'schema' => ['description' => 'The experiment group ID. You can get this ID by calling the ListExperimentGroups operation.', 'type' => 'string', 'required' => true, 'example' => '3', 'title' => ''], ], [ - 'name' => 'InstanceId', - 'in' => 'query', + 'name' => 'body', + 'in' => 'body', + 'style' => 'json', 'schema' => [ - 'description' => '', - 'type' => 'string', - 'required' => true, - 'example' => 'pairec-cn-test123', + 'title' => '', + 'description' => 'The request body.', + 'type' => 'object', + 'properties' => [ + 'InstanceId' => ['description' => 'The instance ID. You can get this ID by calling the ListInstances operation.', 'type' => 'string', 'required' => true, 'example' => 'pairec-cn-abcdefg1234'."\n", 'title' => ''], + 'LayerId' => ['description' => 'The layer ID. You can get this ID by calling the ListLayers operation.', 'type' => 'string', 'required' => true, 'example' => '3', 'title' => ''], + 'Environment' => ['description' => 'The target environment for the experiment group. ● Daily: Daily environment ● Pre: pre-release environment ● Prod: production environment', 'type' => 'string', 'required' => true, 'example' => 'Daily', 'title' => ''], + ], + 'required' => false, + 'example' => '', ], ], ], @@ -1727,545 +954,499 @@ 200 => [ 'schema' => [ 'title' => 'Schema of Response', - 'description' => 'Schema of Response', + 'description' => 'The data returned.', 'type' => 'object', 'properties' => [ - 'RequestId' => [ - 'title' => 'Id of the request', - 'description' => '', - 'type' => 'string', - 'example' => '728C5E01-ABF6-5AA8-B9FC-B3BA05DECC77', - ], - 'RecallManagementTableId' => [ - 'description' => '', - 'type' => 'string', - 'example' => '3', - ], - 'Name' => [ - 'description' => '', - 'type' => 'string', - 'example' => 'table-123', - ], - 'Description' => [ - 'description' => '', - 'type' => 'string', - 'example' => 'this is a test', - ], - 'Type' => [ - 'description' => '', - 'type' => 'string', - 'example' => 'Recall', - ], - 'RecallType' => [ - 'description' => '', - 'type' => 'string', - 'example' => 'X2I', - ], - 'DataSource' => [ - 'description' => '', - 'type' => 'string', - 'example' => 'Api', - ], - 'MaxcomputeProjectName' => [ - 'description' => '', - 'type' => 'string', - 'example' => 'test', - ], - 'MaxcomputeTableName' => [ - 'description' => '', - 'type' => 'string', - 'example' => 'table-1', - ], - 'CanDelete' => [ - 'description' => '', - 'type' => 'boolean', - 'example' => 'true', - ], - 'IndexVersionId' => [ - 'description' => '', - 'type' => 'string', - 'example' => '20250701', - ], - 'IndexEffectiveTime' => [ - 'description' => '', - 'type' => 'string', - 'example' => '2021-12-15T23:24:33.132+08:00', - ], - 'Config' => [ - 'description' => '', - 'type' => 'string', - 'example' => '{"item_id":""}', - ], - 'EnableRowCountFluctuationThreshold' => [ - 'description' => '', - 'type' => 'boolean', - 'example' => 'true', - ], - 'MinRowCountFluctuationThreshold' => [ - 'description' => '', - 'type' => 'integer', - 'format' => 'int32', - 'example' => '10', - ], - 'MaxRowCountFluctuationThreshold' => [ - 'description' => '', - 'type' => 'integer', - 'format' => 'int32', - 'example' => '100', - ], - 'EnableDataSizeFluctuationThreshold' => [ - 'description' => '', - 'type' => 'boolean', - 'example' => 'false', - ], - 'MinDataSizeFluctuationThreshold' => [ - 'description' => '', - 'type' => 'integer', - 'format' => 'int32', - 'example' => '10', - ], - 'MaxDataSizeFluctuationThreshold' => [ - 'description' => '', - 'type' => 'integer', - 'format' => 'int32', - 'example' => '100', - ], - 'GmtCreateTime' => [ - 'description' => '', - 'type' => 'string', - 'example' => '2021-12-15T23:24:33.132+08:00', - ], - 'GmtModifiedTime' => [ - 'description' => '', - 'type' => 'string', - 'example' => '2021-12-15T23:24:33.132+08:00', - ], - 'MaxcomputeSchema' => [ - 'description' => 'maxcompute schema。'."\n", - 'type' => 'string', - 'example' => 'default', - ], - 'PartitionFields' => [ - 'description' => '', - 'type' => 'string', - 'example' => 'dt', - ], - 'Fields' => [ - 'description' => '', - 'type' => 'array', - 'properties' => [ - 'Name' => [ - 'name' => 'Name', - 'description' => '', - 'type' => 'string', - 'example' => 'age', - ], - 'Type' => [ - 'name' => 'Type', - 'description' => '', - 'type' => 'string', - 'example' => 'STRING', - ], - 'Attributes' => [ - 'name' => 'Attributes', - 'description' => '', - 'type' => 'array', - 'items' => [ - 'description' => '', - 'type' => 'string', - 'example' => 'Primary', - 'extendType' => 'true', - ], - 'itemName' => 'Attributes', - ], - 'VectorDimension' => [ - 'name' => 'VectorDimension', - 'description' => '', - 'type' => 'integer', - 'format' => 'int32', - 'example' => '32', - ], - 'VectorMetricType' => [ - 'name' => 'VectorMetricType', - 'description' => '', - 'type' => 'string', - 'example' => 'L2', - ], - ], - 'items' => [ - 'title' => '字段详情。', - 'type' => 'object', - 'properties' => [ - 'Name' => [ - 'title' => '字段名称。', - 'type' => 'string', - 'example' => 'age', - ], - 'Type' => [ - 'title' => '字段类型。', - 'type' => 'string', - 'example' => 'STRING', - ], - 'Attributes' => [ - 'title' => '字段的属性列表。', - 'type' => 'array', - 'items' => [ - 'title' => '字段属性。', - 'type' => 'string', - 'example' => 'Primary', - ], - ], - 'VectorDimension' => [ - 'title' => '向量维度。', - 'type' => 'integer', - 'format' => 'int32', - 'example' => '32', - ], - 'VectorMetricType' => [ - 'title' => '向量指标类型。', - 'type' => 'string', - 'example' => 'L2', - ], - ], - ], - ], + 'RequestId' => ['title' => 'Id of the request', 'description' => 'The request ID, used for tracking and troubleshooting.', 'type' => 'string', 'example' => '12A65C6C-AFA1-59B2-9A66-A9E0BB73F0E5'], + 'ExperimentGroupId' => ['description' => 'The ID of the cloned experiment group.', 'type' => 'string', 'example' => '3', 'title' => ''], ], + 'example' => '', ], ], ], - 'staticInfo' => [ - 'returnType' => 'synchronous', - ], - 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"728C5E01-ABF6-5AA8-B9FC-B3BA05DECC77\\",\\n \\"RecallManagementTableId\\": \\"3\\",\\n \\"Name\\": \\"table-123\\",\\n \\"Description\\": \\"this is a test\\",\\n \\"Type\\": \\"Recall\\",\\n \\"RecallType\\": \\"X2I\\",\\n \\"DataSource\\": \\"Api\\",\\n \\"MaxcomputeProjectName\\": \\"test\\",\\n \\"MaxcomputeTableName\\": \\"table-1\\",\\n \\"CanDelete\\": true,\\n \\"IndexVersionId\\": \\"20250701\\",\\n \\"IndexEffectiveTime\\": \\"2021-12-15T23:24:33.132+08:00\\",\\n \\"Config\\": \\"{\\\\\\"item_id\\\\\\":\\\\\\"\\\\\\"}\\",\\n \\"EnableRowCountFluctuationThreshold\\": true,\\n \\"MinRowCountFluctuationThreshold\\": 10,\\n \\"MaxRowCountFluctuationThreshold\\": 100,\\n \\"EnableDataSizeFluctuationThreshold\\": false,\\n \\"MinDataSizeFluctuationThreshold\\": 10,\\n \\"MaxDataSizeFluctuationThreshold\\": 100,\\n \\"GmtCreateTime\\": \\"2021-12-15T23:24:33.132+08:00\\",\\n \\"GmtModifiedTime\\": \\"2021-12-15T23:24:33.132+08:00\\",\\n \\"MaxcomputeSchema\\": \\"default\\",\\n \\"PartitionFields\\": \\"dt\\",\\n \\"Fields\\": [\\n {\\n \\"Name\\": \\"age\\",\\n \\"Type\\": \\"STRING\\",\\n \\"Attributes\\": [\\n \\"Primary\\"\\n ],\\n \\"VectorDimension\\": 32,\\n \\"VectorMetricType\\": \\"L2\\"\\n }\\n ]\\n}","type":"json"}]', - ], - 'ListRecallManagementJobs' => [ - 'summary' => '获取召回管理任务列表。', - 'path' => '/api/v1/recallmanagementjobs', - 'methods' => [ - 'get', + 'staticInfo' => ['returnType' => 'synchronous'], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"12A65C6C-AFA1-59B2-9A66-A9E0BB73F0E5\\",\\n \\"ExperimentGroupId\\": \\"3\\"\\n}","type":"json"}]', + 'title' => 'Clone Experiment Group', + 'changeSet' => [], + 'ramActions' => [ + [ + 'operationType' => 'none', + 'ramAction' => [ + 'action' => 'pairec:CloneExperimentGroup', + 'authLevel' => 'operate', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'PAIRecService', 'resourceType' => 'All Resource', 'arn' => '*'], + ], + ], + ], ], - 'schemes' => [ - 'https', + 'flowControl' => [ + 'flowControlList' => [], ], + ], + 'CloneFeatureConsistencyCheckJobConfig' => [ + 'summary' => 'Clones a feature consistency check job configuration.', + 'path' => '/api/v1/featureconsistencycheck/jobconfigs/{SourceFeatureConsistencyCheckJobConfigId}/action/clone', + 'methods' => ['post'], + 'schemes' => ['http', 'https'], 'security' => [ [ 'AK' => [], ], ], - 'consumes' => [ - 'application/json', - ], - 'produces' => [ - 'application/json', - ], - 'operationType' => 'read', + 'consumes' => ['application/json'], + 'produces' => ['application/json'], + 'operationType' => 'readAndWrite', 'deprecated' => false, 'systemTags' => [ - 'operationType' => 'list', + 'operationType' => 'none', 'riskType' => 'none', 'chargeType' => 'free', - 'abilityTreeNodes' => [ - 'FEATURElearnN0NAWV', - ], + 'abilityTreeNodes' => ['FEATURElearnN0NAWV'], ], 'parameters' => [ [ - 'name' => 'InstanceId', - 'in' => 'query', - 'schema' => [ - 'description' => '', - 'type' => 'string', - 'required' => false, - 'example' => 'pairec-test1', - ], + 'name' => 'SourceFeatureConsistencyCheckJobConfigId', + 'in' => 'path', + 'schema' => ['description' => 'The ID of the source feature consistency check job configuration. To get the ID, call [ListFeatureConsistencyCheckJobConfigs](~~2557567~~).', 'type' => 'string', 'required' => true, 'example' => '3', 'title' => ''], ], [ - 'name' => 'Type', - 'in' => 'query', + 'name' => 'body', + 'in' => 'body', + 'style' => 'json', 'schema' => [ - 'description' => '', - 'type' => 'string', + 'description' => 'The request body.', + 'type' => 'object', + 'properties' => [ + 'InstanceId' => ['description' => 'The instance ID. To get the ID, call [ListInstances](~~2411819~~).', 'type' => 'string', 'required' => true, 'example' => 'pairec-cn-********', 'title' => ''], + ], 'required' => false, - 'example' => 'Table', + 'title' => '', + 'example' => '', ], ], - [ - 'name' => 'Condition', - 'in' => 'query', - 'style' => 'flat', + ], + 'responses' => [ + 200 => [ 'schema' => [ - 'description' => '', + 'title' => 'Schema of Response', + 'description' => 'Response schema', 'type' => 'object', - 'required' => false, - 'example' => '{"RecallManagementTableId":"1"}', + 'properties' => [ + 'RequestId' => ['title' => 'Id of the request', 'description' => 'The request ID.', 'type' => 'string', 'example' => '74D958EF-3598-56FA-8296-FF1575CE43DF'], + 'FeatureConsistencyCheckId' => ['description' => 'The ID of the new feature consistency check job configuration.', 'type' => 'string', 'example' => '4', 'title' => ''], + ], + 'example' => '', ], ], - [ - 'name' => 'SortBy', - 'in' => 'query', - 'schema' => [ - 'description' => '', - 'type' => 'string', - 'required' => false, - 'example' => 'GmtCreateTime', + ], + 'staticInfo' => ['returnType' => 'synchronous'], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"74D958EF-3598-56FA-8296-FF1575CE43DF\\",\\n \\"FeatureConsistencyCheckId\\": \\"4\\"\\n}","type":"json"}]', + 'title' => 'Clone the feature consistency check job configuration', + 'changeSet' => [], + 'ramActions' => [ + [ + 'operationType' => 'none', + 'ramAction' => [ + 'action' => 'pairec:CloneFeatureConsistencyCheckJobConfig', + 'authLevel' => 'operate', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'PAIRecService', 'resourceType' => 'All Resource', 'arn' => '*'], + ], ], ], + ], + 'flowControl' => [ + 'flowControlList' => [], + ], + ], + 'CloneLaboratory' => [ + 'summary' => 'Clones a specified laboratory to a designated environment. You can specify whether to clone the experiment groups within the laboratory.', + 'path' => '/api/v1/laboratories/{LaboratoryId}/action/clone', + 'methods' => ['post'], + 'schemes' => ['http', 'https'], + 'security' => [ [ - 'name' => 'Order', - 'in' => 'query', - 'schema' => [ - 'description' => '', - 'type' => 'string', - 'required' => false, - 'example' => 'ASC', - ], + 'AK' => [], ], + ], + 'consumes' => ['application/json'], + 'produces' => ['application/json'], + 'operationType' => 'readAndWrite', + 'deprecated' => false, + 'systemTags' => [ + 'operationType' => 'none', + 'riskType' => 'none', + 'chargeType' => 'free', + 'abilityTreeNodes' => ['FEATURElearnN0NAWV'], + ], + 'parameters' => [ [ - 'name' => 'PageNumber', - 'in' => 'query', - 'schema' => [ - 'description' => '', - 'type' => 'integer', - 'format' => 'int32', - 'required' => false, - 'example' => '1', - ], + 'name' => 'LaboratoryId', + 'in' => 'path', + 'schema' => ['description' => 'The laboratory ID. To obtain this ID, call the `ListLaboratories` operation.', 'type' => 'string', 'required' => true, 'example' => '3', 'title' => ''], ], [ - 'name' => 'PageSize', - 'in' => 'query', + 'name' => 'body', + 'in' => 'body', + 'style' => 'json', 'schema' => [ - 'description' => '', - 'type' => 'integer', - 'format' => 'int32', + 'title' => '', + 'description' => 'The request body.', + 'type' => 'object', + 'properties' => [ + 'InstanceId' => ['description' => 'The instance ID. To obtain this ID, call the `ListInstances` operation.', 'type' => 'string', 'required' => true, 'example' => 'pairec-cn-abcdefg1234', 'title' => ''], + 'Environment' => ['description' => 'The destination environment. Valid values: Daily, Pre (pre-release), and Prod (production).', 'type' => 'string', 'required' => true, 'example' => 'Daily', 'title' => ''], + 'CloneExperimentGroup' => ['description' => 'Specifies whether to clone the experiment groups.', 'type' => 'boolean', 'required' => true, 'title' => '', 'example' => 'true'], + ], 'required' => false, - 'example' => '10', + 'example' => '', ], ], - [ - 'name' => 'MaxResults', - 'in' => 'query', + ], + 'responses' => [ + 200 => [ 'schema' => [ - 'description' => '', - 'type' => 'integer', - 'format' => 'int32', - 'required' => false, - 'example' => '0', + 'title' => 'Schema of Response', + 'description' => 'The response schema.', + 'type' => 'object', + 'properties' => [ + 'RequestId' => ['title' => 'Id of the request', 'description' => 'The request ID.', 'type' => 'string', 'example' => '01D22D08-BA20-5F35-8302-99115F288220'], + 'LaboratoryId' => ['description' => 'The ID of the cloned laboratory.', 'type' => 'string', 'example' => '3', 'title' => ''], + ], + 'example' => '', ], ], + ], + 'staticInfo' => ['returnType' => 'synchronous'], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"01D22D08-BA20-5F35-8302-99115F288220\\",\\n \\"LaboratoryId\\": \\"3\\"\\n}","type":"json"}]', + 'title' => 'Clone Lab', + 'changeSet' => [], + 'flowControl' => [ + 'flowControlList' => [], + ], + 'ramActions' => [ + [ + 'operationType' => 'none', + 'ramAction' => [ + 'action' => 'pairec:CloneLaboratory', + 'authLevel' => 'operate', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'PAIRecService', 'resourceType' => 'All Resource', 'arn' => '*'], + ], + ], + ], + ], + ], + 'CloneTrafficControlTask' => [ + 'path' => '/api/v1/trafficcontroltasks/{TrafficControlTaskId}/action/clone', + 'methods' => ['post'], + 'schemes' => ['http', 'https'], + 'security' => [ [ - 'name' => 'NextToken', - 'in' => 'query', + 'AK' => [], + ], + ], + 'consumes' => ['application/json'], + 'produces' => ['application/json'], + 'operationType' => 'readAndWrite', + 'deprecated' => false, + 'systemTags' => [ + 'operationType' => 'none', + 'riskType' => 'none', + 'chargeType' => 'free', + 'abilityTreeCode' => '220414', + 'abilityTreeNodes' => ['FEATURElearnN0NAWV'], + ], + 'parameters' => [ + [ + 'name' => 'TrafficControlTaskId', + 'in' => 'path', + 'schema' => ['description' => 'Traffic control task ID', 'type' => 'string', 'required' => false, 'example' => '1', 'title' => ''], + ], + [ + 'name' => 'body', + 'in' => 'body', + 'style' => 'json', 'schema' => [ - 'description' => '', - 'type' => 'string', + 'description' => 'Request body', + 'type' => 'object', + 'properties' => [ + 'InstanceId' => ['description' => 'Instance ID.', 'type' => 'string', 'required' => false, 'example' => 'pairec_123****', 'title' => ''], + ], 'required' => false, - 'example' => '""', + 'title' => '', + 'example' => '', ], ], ], 'responses' => [ 200 => [ 'schema' => [ - 'title' => 'Schema of Response', 'description' => 'Schema of Response', + 'title' => 'Schema of Response', 'type' => 'object', 'properties' => [ - 'RequestId' => [ - 'title' => 'Id of the request', - 'description' => '', - 'type' => 'string', - 'example' => '728C5E01-ABF6-5AA8-B9FC-B3BA05DECC77', - ], - 'TotalCount' => [ - 'description' => '', - 'type' => 'string', - 'example' => '30', - ], - 'RecallManagementJobs' => [ - 'description' => '', - 'type' => 'array', - 'items' => [ - 'description' => '', - 'type' => 'object', - 'properties' => [ - 'RecallManagementJobId' => [ - 'description' => '', - 'type' => 'string', - 'example' => '1', - ], - 'RecallManagerTableInfo' => [ - 'description' => '', - 'type' => 'object', - 'properties' => [ - 'RecallManagementTableVersionId' => [ - 'description' => '', - 'type' => 'string', - 'example' => '2', - ], - 'DataVersion' => [ - 'description' => '', - 'type' => 'string', - 'example' => 'ds=20250701', - ], - 'SourceTableRowCount' => [ - 'description' => '', - 'type' => 'string', - 'example' => '100', - ], - 'SourceTableDataSize' => [ - 'description' => '', - 'type' => 'string', - 'example' => '1000', - ], - ], - ], - 'Status' => [ - 'description' => '', - 'type' => 'string', - 'example' => 'Running', - ], - 'StartTime' => [ - 'description' => '', - 'type' => 'string', - 'example' => '2025-01-28T10:00:00Z', - ], - 'EndTime' => [ - 'description' => '', - 'type' => 'string', - 'example' => '2025-03-28T10:24Z', - ], - 'RecallManagementTableInfo' => [ - 'type' => 'object', - 'properties' => [ - 'RecallManagementTableVersionId' => [ - 'type' => 'string', - ], - 'DataVersion' => [ - 'type' => 'string', - ], - 'SourceTableRowCount' => [ - 'type' => 'string', - ], - 'SourceTableDataSize' => [ - 'type' => 'string', - ], - ], - ], - ], - ], - ], - 'NextToken' => [ - 'description' => '', - 'type' => 'string', - 'example' => '""', - ], - 'MaxResults' => [ - 'description' => '', - 'type' => 'integer', - 'format' => 'int32', - 'example' => '0', - ], + 'RequestId' => ['title' => 'Id of the request', 'description' => 'Request ID.', 'type' => 'string', 'example' => '728C5E01-ABF6-5AA8-B9FC-B3BA05DECC77'], + 'TrafficControlTaskId' => ['description' => 'Traffic control task ID.', 'type' => 'string', 'example' => '3', 'title' => ''], ], + 'example' => '', ], ], ], - 'staticInfo' => [ - 'returnType' => 'synchronous', + 'staticInfo' => ['returnType' => 'synchronous'], + 'title' => 'Clone Traffic Control Job', + 'summary' => 'Clones a specified traffic control task to a new instance.', + 'description' => '## Request description'."\n" + ."\n" + .'This API clones an existing traffic control task to another specified instance. Ensure that the `InstanceId` you provide is valid and that you have the required permissions for the target instance.'."\n" + ."\n" + .'Note: The cloning process does not affect the status or configuration of the original task.', + 'changeSet' => [], + 'flowControl' => [ + 'flowControlList' => [], + ], + 'ramActions' => [ + [ + 'operationType' => 'none', + 'ramAction' => [ + 'action' => 'pairec:CloneTrafficControlTask', + 'authLevel' => 'operate', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'PAIRecService', 'resourceType' => 'All Resource', 'arn' => '*'], + ], + ], + ], ], - 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"728C5E01-ABF6-5AA8-B9FC-B3BA05DECC77\\",\\n \\"TotalCount\\": \\"30\\",\\n \\"RecallManagementJobs\\": [\\n {\\n \\"RecallManagementJobId\\": \\"1\\",\\n \\"RecallManagerTableInfo\\": {\\n \\"RecallManagementTableVersionId\\": \\"2\\",\\n \\"DataVersion\\": \\"ds=20250701\\",\\n \\"SourceTableRowCount\\": \\"100\\",\\n \\"SourceTableDataSize\\": \\"1000\\"\\n },\\n \\"Status\\": \\"Running\\",\\n \\"StartTime\\": \\"2025-01-28T10:00:00Z\\",\\n \\"EndTime\\": \\"2025-03-28T10:24Z\\",\\n \\"RecallManagementTableInfo\\": {\\n \\"RecallManagementTableVersionId\\": \\"2\\",\\n \\"DataVersion\\": \\"ds=20250701\\",\\n \\"SourceTableRowCount\\": \\"100\\",\\n \\"SourceTableDataSize\\": \\"100\\"\\n }\\n }\\n ],\\n \\"NextToken\\": \\"\\\\\\"\\\\\\"\\",\\n \\"MaxResults\\": 0\\n}","type":"json"}]', + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"728C5E01-ABF6-5AA8-B9FC-B3BA05DECC77\\",\\n \\"TrafficControlTaskId\\": \\"3\\"\\n}","type":"json"}]', ], - 'ListRecallManagementServiceVersions' => [ - 'summary' => '获取召回管理服务下的版本列表', - 'path' => '/api/v1/recallmanagementservices/{RecallManagementServiceId}/versions', - 'methods' => [ - 'get', - ], - 'schemes' => [ - 'https', - ], + 'CreateABMetric' => [ + 'summary' => 'Creates an AB metric.', + 'path' => '/api/v1/abmetrics', + 'methods' => ['post'], + 'schemes' => ['http', 'https'], 'security' => [ [ 'AK' => [], ], ], - 'consumes' => [ - 'application/json', - ], - 'produces' => [ - 'application/json', - ], - 'operationType' => 'read', + 'consumes' => ['application/json'], + 'produces' => ['application/json'], + 'operationType' => 'readAndWrite', 'deprecated' => false, 'systemTags' => [ - 'operationType' => 'none', + 'operationType' => 'create', 'riskType' => 'none', 'chargeType' => 'free', - 'abilityTreeNodes' => [ - 'FEATURElearnN0NAWV', - ], + 'abilityTreeNodes' => ['FEATURElearnN0NAWV'], ], 'parameters' => [ [ - 'name' => 'RecallManagementServiceId', - 'in' => 'path', + 'name' => 'body', + 'in' => 'body', + 'style' => 'json', 'schema' => [ - 'description' => '', - 'type' => 'string', + 'description' => 'The request body.', + 'type' => 'object', + 'properties' => [ + 'Name' => ['description' => 'The metric name.', 'type' => 'string', 'required' => true, 'example' => 'pv', 'title' => ''], + 'Description' => ['description' => 'The metric description.', 'type' => 'string', 'required' => true, 'example' => 'pv指标', 'title' => ''], + 'SceneId' => ['description' => 'The scene ID. Call the [ListScenes](~~2402581~~) operation to obtain this ID.', 'type' => 'string', 'required' => true, 'example' => '1', 'title' => ''], + 'Type' => ['description' => 'The metric type. Valid values:'."\n" + ."\n" + .'- `Single`: A single metric.'."\n" + ."\n" + .'- `Derived`: A derived metric.', 'type' => 'string', 'required' => true, 'example' => 'Single', 'title' => ''], + 'Realtime' => ['description' => 'Specifies whether the metric is a real-time metric. Valid values:'."\n" + ."\n" + .'- `true`: The metric is real-time.'."\n" + ."\n" + .'- `false`: The metric is not real-time.', 'type' => 'boolean', 'required' => true, 'example' => 'false', 'title' => ''], + 'TableMetaId' => ['description' => 'The data table ID. Call the ListTableMetas operation to obtain this ID.', 'type' => 'string', 'required' => true, 'example' => '2', 'title' => ''], + 'ResultResourceId' => ['description' => 'The data source ID to which the results are written back. Call the ListInstanceResources operation to obtain this ID.', 'type' => 'string', 'required' => false, 'example' => '3', 'title' => ''], + 'Definition' => ['description' => 'The metric definition.', 'type' => 'string', 'required' => true, 'example' => 'sum(click_cnt)', 'title' => ''], + 'StatisticsCycle' => ['description' => 'The statistics cycle.', 'type' => 'integer', 'format' => 'int32', 'required' => false, 'example' => '1', 'title' => ''], + 'LeftMetricId' => ['description' => 'The ID of the left metric used to calculate the derived metric.', 'type' => 'string', 'required' => false, 'example' => '2', 'title' => ''], + 'RightMetricId' => ['description' => 'The ID of the right metric used to calculate the derived metric.', 'type' => 'string', 'required' => false, 'example' => '3', 'title' => ''], + 'Operator' => ['description' => 'The operator used to calculate the derived metric. Valid values:'."\n" + ."\n" + .'- `Plus`: Addition'."\n" + ."\n" + .'- `Minus`: Subtraction'."\n" + ."\n" + .'- `Multiplication`: Multiplication'."\n" + ."\n" + .'- `Division`: Division', 'type' => 'string', 'required' => false, 'example' => 'Division', 'title' => ''], + 'InstanceId' => ['description' => 'The instance ID. Call the [ListInstances](~~2411819~~) operation to obtain this ID.', 'type' => 'string', 'required' => true, 'example' => 'pairec-cn-test1', 'title' => ''], + 'NeedSignificance' => ['type' => 'boolean', 'description' => '', 'title' => '', 'example' => ''], + 'AggregationByUser' => ['type' => 'boolean', 'description' => '', 'title' => '', 'example' => ''], + 'Numerator' => ['type' => 'string', 'example' => 'click', 'description' => '', 'title' => ''], + 'Denominator' => ['type' => 'string', 'example' => 'pv', 'description' => '', 'title' => ''], + 'IsBinomialDistribution' => ['type' => 'boolean', 'description' => '', 'title' => '', 'example' => ''], + ], 'required' => false, - 'example' => '3', + 'title' => '', + 'example' => '', ], ], - [ - 'name' => 'InstanceId', - 'in' => 'query', + ], + 'responses' => [ + 200 => [ 'schema' => [ - 'description' => '', - 'type' => 'string', - 'required' => false, - 'example' => 'pairec-cn-test123', + 'title' => 'Schema of Response', + 'description' => 'Response schema', + 'type' => 'object', + 'properties' => [ + 'RequestId' => ['title' => 'Id of the request', 'description' => 'The request ID.', 'type' => 'string', 'example' => 'F7AC05FF-EDE7-5C2B-B9AE-33D6DF4178BA'], + 'ABMetricId' => ['description' => 'The AB metric ID.', 'type' => 'string', 'example' => '1', 'title' => ''], + ], + 'example' => '', ], ], + ], + 'staticInfo' => ['returnType' => 'synchronous'], + 'title' => 'Create AB Metric', + 'changeSet' => [ + ['createdAt' => '2024-02-22T03:35:42.000Z', 'description' => 'Request parameters changed'], + ], + 'flowControl' => [ + 'flowControlList' => [], + ], + 'ramActions' => [ [ - 'name' => 'PageNumber', - 'in' => 'query', - 'schema' => [ - 'description' => '', - 'type' => 'integer', - 'format' => 'int64', - 'required' => false, - 'example' => '1', + 'operationType' => 'create', + 'ramAction' => [ + 'action' => 'pairec:CreateABMetric', + 'authLevel' => 'operate', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'PAIRecService', 'resourceType' => 'All Resource', 'arn' => '*'], + ], ], ], + ], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"F7AC05FF-EDE7-5C2B-B9AE-33D6DF4178BA\\",\\n \\"ABMetricId\\": \\"1\\"\\n}","type":"json"}]', + ], + 'CreateABMetricGroup' => [ + 'summary' => 'Creates an A/B metric group.', + 'path' => '/api/v1/abmetricgroups', + 'methods' => ['post'], + 'schemes' => ['http', 'https'], + 'security' => [ [ - 'name' => 'PageSize', - 'in' => 'query', + 'AK' => [], + ], + ], + 'consumes' => ['application/json'], + 'produces' => ['application/json'], + 'operationType' => 'readAndWrite', + 'deprecated' => false, + 'systemTags' => [ + 'operationType' => 'create', + 'riskType' => 'none', + 'chargeType' => 'free', + 'abilityTreeNodes' => ['FEATURElearnN0NAWV'], + ], + 'parameters' => [ + [ + 'name' => 'body', + 'in' => 'body', + 'style' => 'json', 'schema' => [ - 'description' => '', - 'type' => 'integer', - 'format' => 'int64', + 'description' => 'The request body.', + 'type' => 'object', + 'properties' => [ + 'Name' => ['description' => 'The name of the metric group.', 'type' => 'string', 'required' => true, 'example' => 'visits', 'title' => ''], + 'SceneId' => ['description' => 'The ID of the scene. You can call the [ListScenes](~~2402581~~) operation to obtain this ID.', 'type' => 'string', 'required' => true, 'example' => '1', 'title' => ''], + 'Description' => ['description' => 'The description of the metric group.', 'type' => 'string', 'required' => true, 'example' => '访问量相关指标', 'title' => ''], + 'ABMetricIds' => ['description' => 'The A/B metric IDs. Separate multiple IDs with commas (,).', 'type' => 'string', 'required' => true, 'example' => '1,2', 'title' => ''], + 'InstanceId' => ['description' => 'The ID of the instance. You can call the [ListInstances](~~2411819~~) operation to obtain this ID.', 'type' => 'string', 'required' => true, 'example' => 'pairec-cn-test1', 'title' => ''], + 'Realtime' => ['description' => 'Specifies whether the metric group is a real-time metric group.', 'type' => 'boolean', 'required' => true, 'example' => 'false', 'title' => ''], + ], 'required' => false, - 'example' => '50', + 'title' => '', + 'example' => '', ], ], - [ - 'name' => 'SortBy', - 'in' => 'query', + ], + 'responses' => [ + 200 => [ 'schema' => [ - 'description' => '', - 'type' => 'string', - 'required' => false, - 'example' => 'GmtCreateTime', + 'title' => 'Schema of Response', + 'description' => 'The response data.', + 'type' => 'object', + 'properties' => [ + 'RequestId' => ['title' => 'Id of the request', 'description' => 'The request ID.', 'type' => 'string', 'example' => 'E15A1443-7917-5BE0-AE70-25538ECF398D'], + 'ABMetricGroupId' => ['description' => 'The ID of the A/B metric group.', 'type' => 'string', 'example' => '1', 'title' => ''], + ], + 'example' => '', ], ], + ], + 'staticInfo' => ['returnType' => 'synchronous'], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"E15A1443-7917-5BE0-AE70-25538ECF398D\\",\\n \\"ABMetricGroupId\\": \\"1\\"\\n}","type":"json"}]', + 'title' => 'Create Metric Group', + 'changeSet' => [ + ['createdAt' => '2024-02-22T03:35:41.000Z', 'description' => 'Request parameters changed'], + ], + 'flowControl' => [ + 'flowControlList' => [], + ], + 'ramActions' => [ + [ + 'operationType' => 'create', + 'ramAction' => [ + 'action' => 'pairec:CreateABMetricGroup', + 'authLevel' => 'operate', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'PAIRecService', 'resourceType' => 'All Resource', 'arn' => '*'], + ], + ], + ], + ], + ], + 'CreateCalculationJobs' => [ + 'summary' => 'Creates multiple calculation jobs.', + 'path' => '/api/v1/batch/calculationjobs/create', + 'methods' => ['post'], + 'schemes' => ['http', 'https'], + 'security' => [ [ - 'name' => 'Order', - 'in' => 'query', + 'AK' => [], + ], + ], + 'consumes' => ['application/json'], + 'produces' => ['application/json'], + 'operationType' => 'write', + 'deprecated' => false, + 'systemTags' => [ + 'operationType' => 'create', + 'riskType' => 'none', + 'chargeType' => 'free', + 'abilityTreeNodes' => ['FEATURElearnN0NAWV'], + ], + 'parameters' => [ + [ + 'name' => 'body', + 'in' => 'body', + 'style' => 'json', 'schema' => [ - 'description' => '', - 'type' => 'string', + 'description' => 'The request body.', + 'type' => 'object', + 'properties' => [ + 'ABMetricIds' => ['description' => 'A comma-separated list of A/B metric IDs.', 'type' => 'string', 'required' => true, 'example' => '2,3,4', 'title' => ''], + 'StartDate' => ['description' => 'The start date.', 'type' => 'string', 'required' => true, 'example' => '2023-01-01', 'title' => ''], + 'EndDate' => ['description' => 'The end date.', 'type' => 'string', 'required' => true, 'example' => '2023-01-03', 'title' => ''], + 'InstanceId' => ['description' => 'The instance ID. Call the [ListInstances](~~2411819~~) operation to get this ID.', 'type' => 'string', 'required' => true, 'example' => 'pairec-cn-test1', 'title' => ''], + ], 'required' => false, - 'example' => 'ASC', + 'title' => '', + 'example' => '', ], ], ], @@ -2273,534 +1454,689 @@ 200 => [ 'schema' => [ 'title' => 'Schema of Response', - 'description' => 'Schema of Response', + 'description' => 'The response schema.', 'type' => 'object', 'properties' => [ - 'RequestId' => [ - 'title' => 'Id of the request', - 'description' => '', - 'type' => 'string', - 'example' => '728C5E01-ABF6-5AA8-B9FC-B3BA05DECC77', - ], - 'TotalCount' => [ - 'description' => '', - 'type' => 'string', - 'example' => '30', - ], - 'RecallManagementServiceVersions' => [ - 'description' => '', + 'RequestId' => ['title' => 'Id of the request', 'description' => 'The request ID.', 'type' => 'string', 'example' => '8C27790E-CCA5-56BB-BA17-646295DEC0A2'], + 'CalculationJobIds' => [ + 'description' => 'A list of calculation job IDs.', 'type' => 'array', - 'items' => [ - 'description' => '', - 'type' => 'object', - 'properties' => [ - 'RecallManagementServiceVersionId' => [ - 'description' => '', - 'type' => 'string', - 'example' => '1', - ], - 'Name' => [ - 'description' => '', - 'type' => 'string', - 'example' => 'version-1', - ], - 'IsDefault' => [ - 'description' => '', - 'type' => 'string', - 'example' => 'false', - ], - 'GmtCreateTime' => [ - 'description' => '', - 'type' => 'string', - 'example' => '2021-12-15T23:24:33.132+08:00', - ], - 'GmtModifiedTime' => [ - 'description' => '', - 'type' => 'string', - 'example' => '2021-12-15T23:24:33.132+08:00', - ], - ], - ], + 'items' => ['description' => 'A calculation job ID.', 'type' => 'string', 'example' => '["12","13","14"]', 'title' => ''], + 'title' => '', + 'example' => '', ], ], + 'example' => '', ], ], ], - 'staticInfo' => [ - 'returnType' => 'synchronous', + 'staticInfo' => ['returnType' => 'synchronous'], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"8C27790E-CCA5-56BB-BA17-646295DEC0A2\\",\\n \\"CalculationJobIds\\": [\\n \\"[\\\\\\"12\\\\\\",\\\\\\"13\\\\\\",\\\\\\"14\\\\\\"]\\"\\n ]\\n}","type":"json"}]', + 'title' => 'Create Script Task', + 'changeSet' => [ + ['createdAt' => '2024-02-22T03:35:41.000Z', 'description' => 'Request parameters changed'], + ], + 'flowControl' => [ + 'flowControlList' => [], + ], + 'ramActions' => [ + [ + 'operationType' => 'create', + 'ramAction' => [ + 'action' => 'pairec:CreateCalculationJobs', + 'authLevel' => 'operate', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'PAIRecService', 'resourceType' => 'All Resource', 'arn' => '*'], + ], + ], + ], ], - 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"728C5E01-ABF6-5AA8-B9FC-B3BA05DECC77\\",\\n \\"TotalCount\\": \\"30\\",\\n \\"RecallManagementServiceVersions\\": [\\n {\\n \\"RecallManagementServiceVersionId\\": \\"1\\",\\n \\"Name\\": \\"version-1\\",\\n \\"IsDefault\\": \\"false\\",\\n \\"GmtCreateTime\\": \\"2021-12-15T23:24:33.132+08:00\\",\\n \\"GmtModifiedTime\\": \\"2021-12-15T23:24:33.132+08:00\\"\\n }\\n ]\\n}","type":"json"}]', ], - 'ListRecallManagementServices' => [ - 'summary' => '获取召回管理服务列表', - 'path' => '/api/v1/recallmanagementservices', - 'methods' => [ - 'get', - ], - 'schemes' => [ - 'https', - ], + 'CreateCrowd' => [ + 'summary' => 'Creates a crowd that represents a group of users.', + 'path' => '/api/v1/crowds', + 'methods' => ['post'], + 'schemes' => ['http', 'https'], 'security' => [ [ 'AK' => [], ], ], - 'consumes' => [ - 'application/json', - ], - 'produces' => [ - 'application/json', - ], - 'operationType' => 'read', + 'consumes' => ['application/json'], + 'produces' => ['application/json'], + 'operationType' => 'write', 'deprecated' => false, 'systemTags' => [ - 'operationType' => 'list', + 'operationType' => 'create', 'riskType' => 'none', 'chargeType' => 'free', - 'abilityTreeNodes' => [ - 'FEATURElearnN0NAWV', - ], + 'abilityTreeNodes' => ['FEATURElearnN0NAWV'], ], 'parameters' => [ [ - 'name' => 'InstanceId', - 'in' => 'query', + 'name' => 'body', + 'in' => 'body', + 'style' => 'json', 'schema' => [ - 'description' => '', - 'type' => 'string', + 'title' => '', + 'description' => 'The request body.', + 'type' => 'object', + 'properties' => [ + 'InstanceId' => ['description' => 'The instance ID. To get this ID, call the ListInstances operation.', 'type' => 'string', 'required' => true, 'example' => 'pairec-cn-abcdefg1234', 'title' => ''], + 'Name' => ['description' => 'The crowd name.', 'type' => 'string', 'required' => true, 'example' => 'xx人群', 'title' => ''], + 'Description' => ['description' => 'The description of the crowd.', 'type' => 'string', 'required' => true, 'example' => 'This is a test.', 'title' => ''], + 'Label' => ['description' => 'The crowd label.', 'type' => 'string', 'example' => 'os=android', 'title' => '', 'required' => false], + 'Source' => ['description' => 'The source of the user data. Valid values: ● ManualInput: Users are provided in the Users parameter. ● UploadFile: Users are provided from an uploaded file.', 'type' => 'string', 'example' => 'ManualInput', 'title' => '', 'required' => false], + 'Users' => ['description' => 'The users to include in the crowd. Separate multiple users with commas (,).', 'type' => 'string', 'example' => 'user1,user2,user3', 'title' => '', 'required' => false], + ], 'required' => false, - 'example' => 'pairec-cn-test123', + 'example' => '', ], ], - [ - 'name' => 'PageNumber', - 'in' => 'query', + ], + 'responses' => [ + 200 => [ 'schema' => [ - 'description' => '', - 'type' => 'integer', - 'format' => 'int64', - 'required' => false, - 'example' => '1', + 'title' => 'Schema of Response', + 'description' => 'The data returned by the request.', + 'type' => 'object', + 'properties' => [ + 'RequestId' => ['title' => 'Id of the request', 'description' => 'The request ID.', 'type' => 'string', 'example' => '59CE7EC6-F268-5D71-9215-32922CC50D72'], + 'CrowdId' => ['description' => 'The crowd ID.', 'type' => 'string', 'example' => '3', 'title' => ''], + ], + 'example' => '', ], ], - [ - 'name' => 'PageSize', - 'in' => 'query', - 'schema' => [ - 'description' => '', - 'type' => 'integer', - 'format' => 'int64', - 'required' => false, - 'example' => '50', + ], + 'staticInfo' => ['returnType' => 'synchronous'], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"59CE7EC6-F268-5D71-9215-32922CC50D72\\",\\n \\"CrowdId\\": \\"3\\"\\n}","type":"json"}]', + 'title' => 'Create Audience', + 'changeSet' => [], + 'flowControl' => [ + 'flowControlList' => [], + ], + 'ramActions' => [ + [ + 'operationType' => 'create', + 'ramAction' => [ + 'action' => 'pairec:CreateCrowd', + 'authLevel' => 'operate', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'PAIRecService', 'resourceType' => 'All Resource', 'arn' => '*'], + ], ], ], + ], + ], + 'CreateDataDiagnosis' => [ + 'path' => '/api/v1/datadiagnoses', + 'methods' => ['post'], + 'schemes' => ['http', 'https'], + 'security' => [ [ - 'name' => 'SortBy', - 'in' => 'query', - 'schema' => [ - 'description' => '', - 'type' => 'string', - 'required' => false, - 'example' => 'GmtCreateTime', - ], + 'AK' => [], ], + ], + 'consumes' => ['application/json'], + 'produces' => ['application/json'], + 'operationType' => 'readAndWrite', + 'deprecated' => false, + 'systemTags' => [ + 'operationType' => 'create', + 'riskType' => 'none', + 'chargeType' => 'free', + 'abilityTreeNodes' => ['FEATURElearnN0NAWV'], + ], + 'parameters' => [ [ - 'name' => 'Order', - 'in' => 'query', + 'name' => 'body', + 'in' => 'body', + 'style' => 'json', 'schema' => [ - 'description' => '', - 'type' => 'string', + 'description' => 'The request body.', + 'type' => 'object', + 'properties' => [ + 'InstanceId' => ['description' => 'The instance ID.', 'type' => 'string', 'required' => true, 'example' => 'learn-pairec-xxx', 'title' => ''], + 'Name' => ['description' => 'The name of the data diagnosis task.', 'type' => 'string', 'required' => true, 'example' => 'data_diagnosis_job1', 'title' => ''], + 'Type' => [ + 'description' => 'The type of the data diagnosis task. Valid values:'."\n" + ."\n" + .'- ChangeRate: Item or user change rate analysis.'."\n" + ."\n" + .'- PreferenceStatisticsCycle: User preference statistics cycle analysis.'."\n" + ."\n" + .'- JoinTables: Two-table join analysis.'."\n" + ."\n" + .'- BaseStatistics: Basic statistical analysis.'."\n" + ."\n" + .'- AbnormalBehavior: Abnormal behavior analysis.', + 'enumValueTitles' => ['AbnormalBehavior' => 'AbnormalBehavior', 'JoinTables' => 'JoinTables', 'PreferenceStatisticsCycle' => 'PreferenceStatisticsCycle', 'BaseStatistics' => 'BaseStatistics', 'ChangeRate' => 'ChangeRate'], + 'type' => 'string', + 'required' => true, + 'example' => 'ChangeRate', + 'title' => '', + ], + 'TableMetaId' => ['description' => 'The ID of the data table.', 'type' => 'string', 'required' => false, 'example' => '3', 'title' => ''], + 'LeftTableMetaId' => ['description' => 'The ID of the left data table.', 'type' => 'string', 'required' => false, 'example' => '4', 'title' => ''], + 'RightTableMetaId' => ['description' => 'The ID of the right data table.', 'type' => 'string', 'required' => false, 'example' => '5', 'title' => ''], + 'PartitionField' => ['description' => 'The partition field.', 'type' => 'string', 'required' => false, 'example' => 'dt', 'title' => ''], + 'LeftTablePartitionField' => ['description' => 'The partition field for the left data table.', 'type' => 'string', 'required' => false, 'example' => 'dt', 'title' => ''], + 'RightTablePartitionField' => ['description' => 'The partition field for the right data table.', 'type' => 'string', 'required' => false, 'example' => 'dt', 'title' => ''], + 'Config' => ['description' => 'The configuration for the data diagnosis task, specified as a JSON string. The required fields in this object depend on the value of the `Type` parameter.'."\n" + ."\n" + .'- If `Type` is set to `ChangeRate`, specify the following fields: `AnalysisField` and `PartitionFieldFormat`.'."\n" + ."\n" + .'- If `Type` is set to `PreferenceStatisticsCycle`, specify the following fields: `UserIdField`, `RemainDays`, `EverAppearedDays`, `RemainRatePeriods`, and `PartitionFieldFormat`.'."\n" + ."\n" + .'- If `Type` is set to `JoinTables`, specify the following fields: `LeftTableAnalysisField`, `RightTableAnalysisField`, `LeftJoinField`, `RightJoinField`, `SampleQuantity`, `LeftTablePartitionFieldFormat`, and `RightTablePartitionFieldFormat`.'."\n" + ."\n" + .'- If `Type` is set to `BaseStatistics`, specify the following fields: `TagField`, `TagFieldSeparator`, `KVField`, `KVFieldSeparator`, `KVPairSeparator`, `TextField`, `Quantiles`, `DefaultValueOfString`, `NullStringField`, and `PartitionFieldFormat`.'."\n" + ."\n" + .'- If `Type` is set to `AbnormalBehavior`, specify the following fields: `UserId`, `ItemId`, `EventField`, `UpStreamBehavior`, `DownstreamBehavior`, `NumericHistogramBins`, and `PartitionFieldFormat`.', 'type' => 'string', 'required' => true, 'example' => '{ "AnalysisField": "userid", "PartitionFieldFormat": "yyyymmdd" }', 'title' => ''], + 'CycleTime' => ['description' => 'The scheduled time to run the task. If this parameter is omitted, the task runs only once.', 'type' => 'string', 'required' => false, 'example' => '08:00', 'title' => ''], + 'TopNQuantity' => ['description' => 'The number of top results to return.', 'type' => 'integer', 'format' => 'int64', 'required' => false, 'example' => '10', 'title' => ''], + ], 'required' => false, - 'example' => 'ASC', + 'title' => '', + 'example' => '', ], ], - [ - 'name' => 'MaxResults', - 'in' => 'query', + ], + 'responses' => [ + 200 => [ 'schema' => [ - 'description' => '', - 'type' => 'integer', - 'format' => 'int32', - 'required' => false, - 'example' => '""', + 'description' => 'The response body.', + 'title' => 'Schema of Response ', + 'type' => 'object', + 'properties' => [ + 'RequestId' => ['title' => 'Id of the request ', 'description' => 'The request ID.', 'type' => 'string', 'example' => '728C5E01-ABF6-5AA8-B9FC-B3BA05DECC77'], + 'DataDiagnosisId' => ['description' => 'The ID of the data diagnosis task.', 'type' => 'string', 'example' => '1', 'title' => ''], + ], + 'example' => '', ], ], + ], + 'staticInfo' => ['returnType' => 'synchronous'], + 'title' => 'Create Data Diagnosis Job ', + 'summary' => 'Creates a data diagnosis task. This API supports various analysis types.', + 'description' => '## Description'."\n" + ."\n" + .'- This API creates a data diagnosis task. It supports various analysis types, including item or user change rate analysis, user preference statistics cycle analysis, two-table join analysis, basic statistical analysis, and abnormal behavior analysis.'."\n" + ."\n" + .'- The content of the `Config` parameter depends on the value of the `Type` parameter. For more information, see the example configurations in this topic.'."\n" + ."\n" + .'- To run the task on a schedule, specify the `CycleTime` parameter. If this parameter is omitted, the task runs only once.'."\n" + ."\n" + .'- The optional `TopNQuantity` parameter specifies the number of top results to return.', + 'changeSet' => [], + 'flowControl' => [ + 'flowControlList' => [], + ], + 'ramActions' => [ + [ + 'operationType' => 'create', + 'ramAction' => [ + 'action' => 'pairec:CreateDataDiagnosis', + 'authLevel' => 'operate', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'PAIRecService', 'resourceType' => 'All Resource', 'arn' => '*'], + ], + ], + ], + ], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"728C5E01-ABF6-5AA8-B9FC-B3BA05DECC77\\",\\n \\"DataDiagnosisId\\": \\"1\\"\\n}","type":"json"}]', + ], + 'CreateDataDiagnosisJobs' => [ + 'path' => '/api/v1/batch/datadiagnosisjobs/create', + 'methods' => ['post'], + 'schemes' => ['http', 'https'], + 'security' => [ [ - 'name' => 'NextToken', - 'in' => 'query', + 'AK' => [], + ], + ], + 'consumes' => ['application/json'], + 'produces' => ['application/json'], + 'operationType' => 'readAndWrite', + 'deprecated' => false, + 'systemTags' => [ + 'operationType' => 'create', + 'riskType' => 'none', + 'chargeType' => 'free', + 'abilityTreeNodes' => ['FEATURElearnN0NAWV'], + ], + 'parameters' => [ + [ + 'name' => 'body', + 'in' => 'body', + 'style' => 'json', 'schema' => [ - 'description' => '', - 'type' => 'string', + 'description' => 'The request body.', + 'type' => 'object', + 'properties' => [ + 'DataDiagnosisId' => ['description' => 'The data diagnosis ID.', 'type' => 'string', 'required' => true, 'example' => '3', 'title' => ''], + 'InstanceId' => ['description' => 'The instance ID.', 'type' => 'string', 'required' => true, 'example' => 'learn-pairec-xxx', 'title' => ''], + 'StartDate' => ['description' => 'The start date for the job.', 'type' => 'string', 'required' => true, 'example' => '2022-01-01', 'title' => ''], + 'EndDate' => ['description' => 'The end date for the job.', 'type' => 'string', 'required' => true, 'example' => '2022-02-01', 'title' => ''], + ], 'required' => false, - 'example' => '0', + 'title' => '', + 'example' => '', ], ], ], 'responses' => [ 200 => [ 'schema' => [ + 'description' => 'The response schema.', 'title' => 'Schema of Response', - 'description' => 'Schema of Response', 'type' => 'object', 'properties' => [ - 'RequestId' => [ - 'title' => 'Id of the request', - 'description' => '', - 'type' => 'string', - 'example' => '728C5E01-ABF6-5AA8-B9FC-B3BA05DECC77', - ], - 'TotalCount' => [ - 'description' => '', - 'type' => 'string', - 'example' => '10', - ], - 'RecallManagementServices' => [ - 'description' => '', + 'RequestId' => ['title' => 'Id of the request', 'description' => 'The request ID.', 'type' => 'string', 'example' => '728C5E01-ABF6-5AA8-B9FC-B3BA05DECC77'], + 'DataDiagnosisJobIds' => [ + 'description' => 'A list of data diagnosis job IDs.', 'type' => 'array', - 'items' => [ - 'description' => '', - 'type' => 'object', - 'properties' => [ - 'RecallManagementServiceId' => [ - 'description' => '', - 'type' => 'string', - 'example' => '3', - ], - 'Name' => [ - 'description' => '', - 'type' => 'string', - 'example' => 'hot_group_recall', - ], - 'Description' => [ - 'description' => '', - 'type' => 'string', - 'example' => 'this is a test recall', - ], - 'CurrentRecallManagementServiceVersionId' => [ - 'description' => '', - 'type' => 'string', - 'example' => '1', - ], - 'CurrentRecallManagementServiceVersionName' => [ - 'description' => '', - 'type' => 'string', - 'example' => 'version-1', - ], - 'Status' => [ - 'description' => '', - 'type' => 'string', - 'example' => 'Online', - ], - 'GmtCreateTime' => [ - 'description' => '', - 'type' => 'string', - 'example' => '2021-12-15T23:24:33.132+08:00', - ], - 'GmtModifiedTime' => [ - 'description' => '', - 'type' => 'string', - 'example' => '2021-12-15T23:24:33.132+08:00', - ], - ], - ], - ], - 'NextToken' => [ - 'description' => '', - 'type' => 'string', - 'example' => '""', - ], - 'MaxResults' => [ - 'description' => '', - 'type' => 'integer', - 'format' => 'int32', - 'example' => '0', + 'items' => ['description' => 'The data diagnosis job ID.', 'type' => 'string', 'example' => '1', 'title' => ''], + 'title' => '', + 'example' => '', ], ], + 'example' => '', ], ], ], - 'staticInfo' => [ - 'returnType' => 'synchronous', + 'staticInfo' => ['returnType' => 'synchronous'], + 'title' => 'Create a Data Diagnosis Job', + 'summary' => 'Creates a data diagnosis (rerun) job for a specified time period.', + 'description' => '## Description'."\n" + ."\n" + .'This operation creates a data diagnosis (rerun) job for a specific instance within a specified time frame. To ensure the job runs correctly, provide accurate values for the `DataDiagnosisId`, `InstanceId`, `StartDate`, and `EndDate` parameters.', + 'changeSet' => [], + 'flowControl' => [ + 'flowControlList' => [], ], - 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"728C5E01-ABF6-5AA8-B9FC-B3BA05DECC77\\",\\n \\"TotalCount\\": \\"10\\",\\n \\"RecallManagementServices\\": [\\n {\\n \\"RecallManagementServiceId\\": \\"3\\",\\n \\"Name\\": \\"hot_group_recall\\",\\n \\"Description\\": \\"this is a test recall\\",\\n \\"CurrentRecallManagementServiceVersionId\\": \\"1\\",\\n \\"CurrentRecallManagementServiceVersionName\\": \\"version-1\\",\\n \\"Status\\": \\"Online\\",\\n \\"GmtCreateTime\\": \\"2021-12-15T23:24:33.132+08:00\\",\\n \\"GmtModifiedTime\\": \\"2021-12-15T23:24:33.132+08:00\\"\\n }\\n ],\\n \\"NextToken\\": \\"\\\\\\"\\\\\\"\\",\\n \\"MaxResults\\": 0\\n}","type":"json"}]', - ], - 'ListRecallManagementTables' => [ - 'summary' => '获取召回管理表列表。', - 'path' => '/api/v1/recallmanagementtables', - 'methods' => [ - 'get', - ], - 'schemes' => [ - 'https', + 'ramActions' => [ + [ + 'operationType' => 'create', + 'ramAction' => [ + 'action' => 'pairec:CreateDataDiagnosisJobs', + 'authLevel' => 'operate', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'PAIRecService', 'resourceType' => 'All Resource', 'arn' => '*'], + ], + ], + ], ], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"728C5E01-ABF6-5AA8-B9FC-B3BA05DECC77\\",\\n \\"DataDiagnosisJobIds\\": [\\n \\"1\\"\\n ]\\n}","type":"json"}]', + ], + 'CreateEngineConfig' => [ + 'summary' => 'Creates an engine config.', + 'path' => '/api/v1/engineconfigs', + 'methods' => ['post'], + 'schemes' => ['http', 'https'], 'security' => [ [ 'AK' => [], ], ], - 'consumes' => [ - 'application/json', - ], - 'produces' => [ - 'application/json', - ], - 'operationType' => 'read', + 'consumes' => ['application/json'], + 'produces' => ['application/json'], + 'operationType' => 'readAndWrite', 'deprecated' => false, 'systemTags' => [ - 'operationType' => 'list', + 'operationType' => 'create', 'riskType' => 'none', 'chargeType' => 'free', - 'abilityTreeNodes' => [ - 'FEATURElearnN0NAWV', - ], + 'abilityTreeCode' => '180238', + 'abilityTreeNodes' => ['FEATURElearnN0NAWV'], ], 'parameters' => [ [ - 'name' => 'InstanceId', - 'in' => 'query', + 'name' => 'body', + 'in' => 'body', + 'style' => 'json', 'schema' => [ - 'description' => '', - 'type' => 'string', - 'required' => true, - 'example' => 'pairec-cn-test123', + 'description' => 'The request body.', + 'type' => 'object', + 'properties' => [ + 'Name' => ['description' => 'The name of the engine config.', 'type' => 'string', 'required' => false, 'example' => 'engine_config_v1', 'title' => ''], + 'ConfigValue' => ['description' => 'The content of the engine config.', 'type' => 'string', 'required' => false, 'example' => '{}', 'title' => ''], + 'Environment' => ['description' => 'The environment. Valid values:'."\n" + ."\n" + .'- `Daily`: The daily environment.'."\n" + ."\n" + .'- `Pre`: The pre-production environment.'."\n" + ."\n" + .'- `Prod`: The production environment.', 'type' => 'string', 'required' => false, 'example' => 'Pre', 'title' => ''], + 'InstanceId' => ['description' => 'The ID of the instance. You can obtain this ID by calling the [ListInstances](~~2411819~~) operation.', 'type' => 'string', 'required' => false, 'example' => 'pairec-cn-***test', 'title' => ''], + 'Description' => ['type' => 'string', 'description' => '', 'required' => false, 'title' => '', 'example' => ''], + ], + 'required' => false, + 'title' => '', + 'example' => '', ], ], - [ - 'name' => 'Name', - 'in' => 'query', + ], + 'responses' => [ + 200 => [ 'schema' => [ - 'description' => '', - 'type' => 'string', - 'required' => false, - 'example' => 'table-1', + 'title' => 'Schema of Response', + 'description' => 'The response data.', + 'type' => 'object', + 'properties' => [ + 'RequestId' => ['title' => 'Id of the request', 'description' => 'The ID of the request.', 'type' => 'string', 'example' => 'E15A1443-7917-5BE0-AE70-25538ECF398D'], + 'EngineConfigId' => ['description' => 'The ID of the engine config.', 'type' => 'string', 'example' => '1', 'title' => ''], + ], + 'example' => '', ], ], - [ - 'name' => 'Type', - 'in' => 'query', - 'schema' => [ - 'description' => '', - 'type' => 'string', - 'required' => false, - 'example' => 'X2I', + ], + 'staticInfo' => ['returnType' => 'synchronous'], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"E15A1443-7917-5BE0-AE70-25538ECF398D\\",\\n \\"EngineConfigId\\": \\"1\\"\\n}","type":"json"}]', + 'title' => 'Create Engine Configuration', + 'changeSet' => [ + ['createdAt' => '2024-12-27T08:56:39.000Z', 'description' => 'Request parameters changed'], + ], + 'flowControl' => [ + 'flowControlList' => [], + ], + 'ramActions' => [ + [ + 'operationType' => 'create', + 'ramAction' => [ + 'action' => 'pairec:CreateEngineConfig', + 'authLevel' => 'operate', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'PAIRecService', 'resourceType' => 'All Resource', 'arn' => '*'], + ], ], ], + ], + ], + 'CreateExperiment' => [ + 'summary' => 'Creates an experiment in a specified experiment group.', + 'path' => '/api/v1/experiments', + 'methods' => ['post'], + 'schemes' => ['http', 'https'], + 'security' => [ [ - 'name' => 'PageNumber', - 'in' => 'query', + 'AK' => [], + ], + ], + 'consumes' => ['application/json'], + 'produces' => ['application/json'], + 'operationType' => 'readAndWrite', + 'deprecated' => false, + 'systemTags' => [ + 'operationType' => 'create', + 'riskType' => 'none', + 'chargeType' => 'free', + 'abilityTreeNodes' => ['FEATURElearnN0NAWV'], + ], + 'parameters' => [ + [ + 'name' => 'body', + 'in' => 'body', + 'style' => 'json', 'schema' => [ - 'description' => '', - 'type' => 'integer', - 'format' => 'int32', + 'description' => 'The request body.', + 'type' => 'object', + 'properties' => [ + 'InstanceId' => ['description' => 'The instance ID. Call the ListInstances operation to obtain this ID.', 'type' => 'string', 'required' => true, 'example' => 'pairec-test1', 'title' => ''], + 'ExperimentGroupId' => ['description' => 'The ID of the experiment group. Call the ListExperimentGroups operation to obtain this ID.', 'type' => 'string', 'required' => true, 'example' => '3', 'title' => ''], + 'Name' => ['description' => 'The experiment name.', 'type' => 'string', 'required' => true, 'example' => 'experiment_test', 'title' => ''], + 'Description' => ['description' => 'The experiment description.', 'type' => 'string', 'required' => true, 'example' => 'This is a test.', 'title' => ''], + 'Type' => ['description' => 'The experiment type. Valid values:<br>● `Baseline`: Indicates a baseline experiment.<br>● `Normal`: Indicates a normal experiment.<br><br>', 'type' => 'string', 'required' => true, 'example' => 'Baseline', 'title' => ''], + 'FlowPercent' => ['description' => 'The traffic distribution percentage.', 'type' => 'integer', 'format' => 'int32', 'example' => '100', 'title' => '', 'required' => false], + 'DebugUsers' => ['description' => 'The UIDs of Alibaba Cloud accounts or RAM users for debugging. Separate multiple UIDs with a comma.', 'type' => 'string', 'example' => '1124512470******,1124512471******,1124512472******', 'title' => '', 'required' => false], + 'DebugCrowdId' => ['description' => 'The ID of the debug crowd. Call the ListCrowds operation to obtain this ID.', 'type' => 'string', 'example' => '3', 'title' => '', 'required' => false], + 'Config' => ['description' => 'The experiment configuration.', 'type' => 'string', 'example' => '{"RankBy": "Score"}', 'title' => '', 'required' => false], + ], 'required' => false, - 'example' => '1', + 'title' => '', + 'example' => '', ], ], - [ - 'name' => 'PageSize', - 'in' => 'query', + ], + 'responses' => [ + 200 => [ 'schema' => [ - 'description' => '', - 'type' => 'integer', - 'format' => 'int32', - 'required' => false, - 'example' => '10', + 'title' => 'Schema of Response', + 'description' => 'The response schema.', + 'type' => 'object', + 'properties' => [ + 'RequestId' => ['title' => 'Id of the request', 'description' => 'The unique identifier for the request.', 'type' => 'string', 'example' => '3AAA45F6-0798-5461-9360-81D133823CE7'], + 'ExperimentId' => ['description' => 'The experiment ID.', 'type' => 'string', 'example' => '3', 'title' => ''], + ], + 'example' => '', ], ], + ], + 'staticInfo' => ['returnType' => 'synchronous'], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"3AAA45F6-0798-5461-9360-81D133823CE7\\",\\n \\"ExperimentId\\": \\"3\\"\\n}","type":"json"}]', + 'title' => 'Create Experiment', + 'changeSet' => [], + 'flowControl' => [ + 'flowControlList' => [], + ], + 'ramActions' => [ + [ + 'operationType' => 'create', + 'ramAction' => [ + 'action' => 'pairec:CreateExperiment', + 'authLevel' => 'operate', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'PAIRecService', 'resourceType' => 'All Resource', 'arn' => '*'], + ], + ], + ], + ], + ], + 'CreateExperimentGroup' => [ + 'path' => '/api/v1/experimentgroups', + 'methods' => ['post'], + 'schemes' => ['http', 'https'], + 'security' => [ [ - 'name' => 'SortBy', - 'in' => 'query', + 'AK' => [], + ], + ], + 'consumes' => ['application/json'], + 'produces' => ['application/json'], + 'operationType' => 'readAndWrite', + 'deprecated' => false, + 'systemTags' => [ + 'operationType' => 'create', + 'riskType' => 'none', + 'chargeType' => 'free', + 'abilityTreeCode' => '183389', + 'abilityTreeNodes' => ['FEATURElearnN0NAWV'], + ], + 'parameters' => [ + [ + 'name' => 'body', + 'in' => 'body', + 'style' => 'json', 'schema' => [ - 'description' => '', - 'type' => 'string', + 'title' => '', + 'description' => 'The request body.', + 'type' => 'object', + 'properties' => [ + 'LayerId' => ['description' => 'The ID of the layer. You can obtain this ID by calling the ListLayers operation.', 'type' => 'string', 'required' => true, 'example' => '3', 'title' => ''], + 'Name' => ['description' => 'The name of the experiment group.', 'type' => 'string', 'required' => true, 'example' => 'experiment_group_test', 'title' => ''], + 'Description' => ['description' => 'The description of the experiment group.', 'type' => 'string', 'example' => 'This is a test.', 'title' => '', 'required' => false], + 'DebugUsers' => ['description' => 'The UIDs of the debug users. The value must be the UID of an Alibaba Cloud account or a RAM user. Separate multiple UIDs with a comma.', 'type' => 'string', 'example' => '1124512470******,1124512471******,1124512472******', 'title' => '', 'required' => false], + 'DebugCrowdId' => ['description' => 'The ID of the debug crowd. You can obtain this ID by calling the ListCrowds operation.', 'type' => 'string', 'example' => '3', 'title' => '', 'required' => false], + 'NeedAA' => ['description' => 'Specifies whether to create an A/A experiment group.', 'type' => 'boolean', 'required' => true, 'title' => '', 'example' => 'true'], + 'Filter' => ['description' => 'The filter condition for crowd targeting.', 'type' => 'string', 'example' => 'gender=male', 'title' => '', 'required' => false], + 'CrowdId' => ['description' => 'The ID of the crowd for crowd targeting. You can obtain this ID by calling the ListCrowds operation.', 'type' => 'string', 'example' => '1', 'title' => '', 'required' => false], + 'DistributionType' => ['description' => 'The distribution type. Valid values: `UserId` (by user ID) and `TimeDuration` (by time duration).', 'type' => 'string', 'example' => 'UserId', 'title' => '', 'required' => false], + 'DistributionTimeDuration' => ['description' => 'The time duration for traffic distribution.', 'type' => 'integer', 'format' => 'int32', 'example' => '3', 'title' => '', 'required' => false], + 'Config' => ['description' => 'The configuration of the experiment group.', 'type' => 'string', 'example' => '{"RankBy": "Score"}', 'title' => '', 'required' => false], + 'ReservedBuckets' => ['description' => 'A comma-separated list of reserved bucket numbers.', 'type' => 'string', 'example' => '1,2,3', 'title' => '', 'required' => false], + 'InstanceId' => ['description' => 'The instance ID. You can obtain this ID by calling the ListInstances operation.', 'type' => 'string', 'required' => true, 'example' => 'pairec-test1', 'title' => ''], + 'CrowdTargetType' => ['description' => 'The crowd targeting type for the experiment group. Valid values:'."\n" + ."\n" + .'- `All`: All traffic'."\n" + ."\n" + .'- `Filter`: Traffic that matches the filter condition'."\n" + ."\n" + .'- `CrowdId`: Traffic from a specific crowd'."\n" + ."\n" + .'- `Random`: A random percentage of traffic', 'type' => 'string', 'required' => false, 'example' => 'All', 'title' => ''], + 'RandomFlow' => ['description' => 'The percentage of traffic to randomly allocate to this experiment group. This parameter is used only when `CrowdTargetType` is set to `Random`. Valid values: 0 to 100.', 'type' => 'integer', 'format' => 'int64', 'required' => false, 'example' => '20', 'title' => ''], + ], 'required' => false, - 'example' => 'GmtCreateTime', + 'example' => '', ], ], - [ - 'name' => 'Order', - 'in' => 'query', + ], + 'responses' => [ + 200 => [ 'schema' => [ - 'description' => '', - 'type' => 'string', - 'required' => false, - 'example' => 'ASC', + 'title' => 'Schema of Response', + 'description' => 'The response body.', + 'type' => 'object', + 'properties' => [ + 'RequestId' => ['title' => 'Id of the request', 'description' => 'The ID of the request.', 'type' => 'string', 'example' => 'A04CB8C0-E74A-5E83-BC61-64D153574EC7'], + 'ExperimentGroupId' => ['description' => 'The ID of the experiment group.', 'type' => 'string', 'example' => '3', 'title' => ''], + ], + 'example' => '', ], ], + ], + 'staticInfo' => ['returnType' => 'synchronous'], + 'title' => 'Create Experiment Group', + 'summary' => 'Creates an experiment group in a specified layer. You can use experiment groups to categorize experiments and observe their overall performance.', + 'changeSet' => [ + ['createdAt' => '2024-03-20T06:05:19.000Z', 'description' => 'Request parameters changed'], + ], + 'flowControl' => [ + 'flowControlList' => [], + ], + 'ramActions' => [ [ - 'name' => 'NextToken', - 'in' => 'query', - 'schema' => [ - 'description' => '', - 'type' => 'string', - 'required' => false, - 'example' => '""', + 'operationType' => 'create', + 'ramAction' => [ + 'action' => 'pairec:CreateExperimentGroup', + 'authLevel' => 'operate', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'PAIRecService', 'resourceType' => 'All Resource', 'arn' => '*'], + ], ], ], + ], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"A04CB8C0-E74A-5E83-BC61-64D153574EC7\\",\\n \\"ExperimentGroupId\\": \\"3\\"\\n}","type":"json"}]', + ], + 'CreateFeatureConsistencyCheckJob' => [ + 'summary' => 'Creates a feature consistency check job.', + 'path' => '/api/v1/featureconsistencycheck/jobs', + 'methods' => ['post'], + 'schemes' => ['http', 'https'], + 'security' => [ [ - 'name' => 'MaxResults', - 'in' => 'query', + 'AK' => [], + ], + ], + 'consumes' => ['application/json'], + 'produces' => ['application/json'], + 'operationType' => 'readAndWrite', + 'deprecated' => false, + 'systemTags' => [ + 'operationType' => 'create', + 'riskType' => 'none', + 'chargeType' => 'free', + 'abilityTreeNodes' => ['FEATURElearnN0NAWV'], + ], + 'parameters' => [ + [ + 'name' => 'body', + 'in' => 'body', + 'style' => 'json', 'schema' => [ - 'description' => '', - 'type' => 'integer', - 'format' => 'int32', + 'description' => 'The request body.', + 'type' => 'object', + 'properties' => [ + 'InstanceId' => ['description' => 'The instance ID. You can obtain the instance ID on the [Instances](~~2411819~~) page.', 'type' => 'string', 'required' => true, 'example' => 'pairec-cn-********', 'title' => ''], + 'FeatureConsistencyCheckJobConfigId' => ['description' => 'The feature consistency check job configuration ID. You can call the [ListFeatureConsistencyCheckJobConfigs](~~2557567~~) operation to obtain this ID.', 'type' => 'string', 'required' => true, 'example' => '3', 'title' => ''], + 'Environment' => ['description' => 'The environment where the job runs. Valid values:'."\n" + ."\n" + .'- Daily: the daily environment'."\n" + ."\n" + .'- Pre: the pre-production environment'."\n" + ."\n" + .'- Prod: the production environment', 'type' => 'string', 'required' => true, 'example' => 'Pre', 'title' => ''], + 'SamplingDuration' => ['description' => 'The sampling duration, in minutes.', 'type' => 'integer', 'format' => 'int32', 'required' => true, 'example' => '10', 'title' => ''], + ], 'required' => false, - 'example' => '0', + 'title' => '', + 'example' => '', ], ], ], 'responses' => [ 200 => [ 'schema' => [ - 'title' => 'Schema of Response', - 'description' => 'Schema of Response', + 'title' => '', + 'description' => 'The response body.', 'type' => 'object', 'properties' => [ - 'RequestId' => [ - 'title' => 'Id of the request', - 'description' => '', - 'type' => 'string', - 'example' => '728C5E01-ABF6-5AA8-B9FC-B3BA05DECC77', - ], - 'TotalCount' => [ - 'description' => '', - 'type' => 'string', - 'example' => '30', - ], - 'RecallManagementTables' => [ - 'description' => '', - 'type' => 'array', - 'items' => [ - 'description' => '', - 'type' => 'object', - 'properties' => [ - 'RecallManagementTableId' => [ - 'description' => '', - 'type' => 'string', - 'example' => '3', - ], - 'Name' => [ - 'description' => '', - 'type' => 'string', - 'example' => 'table-123', - ], - 'Description' => [ - 'description' => '', - 'type' => 'string', - 'example' => 'this is a test', - ], - 'Type' => [ - 'description' => '', - 'type' => 'string', - 'example' => 'Recall', - ], - 'RecallType' => [ - 'description' => '', - 'type' => 'string', - 'example' => 'X2I', - ], - 'DataSource' => [ - 'description' => '', - 'type' => 'string', - 'example' => 'Api', - ], - 'MaxcomputeProjectName' => [ - 'description' => '', - 'type' => 'string', - 'example' => 'test', - ], - 'MaxcomputeTableName' => [ - 'description' => '', - 'type' => 'string', - 'example' => 'table-1', - ], - 'CanDelete' => [ - 'description' => '', - 'type' => 'boolean', - 'example' => 'false', - ], - 'IndexVersionId' => [ - 'description' => '', - 'type' => 'string', - 'example' => '20250701', - ], - 'IndexEffectiveTime' => [ - 'description' => '', - 'type' => 'string', - 'example' => '2021-12-15T23:24:33.132+08:00', - ], - 'GmtCreateTime' => [ - 'description' => '', - 'type' => 'string', - 'example' => '2021-12-15T23:24:33.132+08:00', - ], - 'GmtModifiedTime' => [ - 'description' => '', - 'type' => 'string', - 'example' => '2021-12-15T23:24:33.132+08:00', - ], - 'MaxcomputeSchema' => [ - 'description' => 'maxcompute schema。'."\n", - 'type' => 'string', - 'example' => 'default', - ], - 'PartitionFields' => [ - 'description' => '', - 'type' => 'string', - 'example' => 'dt', - ], - ], - ], - ], - 'NextToken' => [ - 'description' => '', - 'type' => 'string', - 'example' => '""', - ], - 'MaxResults' => [ - 'description' => '', - 'type' => 'integer', - 'format' => 'int32', - 'example' => '0', - ], + 'RequestId' => ['title' => '', 'description' => 'The request ID.', 'type' => 'string', 'example' => '7D59453C-48AA-5FC5-8848-2D373BD1A17F'], + 'FeatureConsistencyCheckJobId' => ['description' => 'The feature consistency check job ID.', 'type' => 'string', 'example' => '4', 'title' => ''], ], + 'example' => '', ], ], ], - 'staticInfo' => [ - 'returnType' => 'synchronous', - ], - 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"728C5E01-ABF6-5AA8-B9FC-B3BA05DECC77\\",\\n \\"TotalCount\\": \\"30\\",\\n \\"RecallManagementTables\\": [\\n {\\n \\"RecallManagementTableId\\": \\"3\\",\\n \\"Name\\": \\"table-123\\",\\n \\"Description\\": \\"this is a test\\",\\n \\"Type\\": \\"Recall\\",\\n \\"RecallType\\": \\"X2I\\",\\n \\"DataSource\\": \\"Api\\",\\n \\"MaxcomputeProjectName\\": \\"test\\",\\n \\"MaxcomputeTableName\\": \\"table-1\\",\\n \\"CanDelete\\": false,\\n \\"IndexVersionId\\": \\"20250701\\",\\n \\"IndexEffectiveTime\\": \\"2021-12-15T23:24:33.132+08:00\\",\\n \\"GmtCreateTime\\": \\"2021-12-15T23:24:33.132+08:00\\",\\n \\"GmtModifiedTime\\": \\"2021-12-15T23:24:33.132+08:00\\",\\n \\"MaxcomputeSchema\\": \\"default\\",\\n \\"PartitionFields\\": \\"dt\\"\\n }\\n ],\\n \\"NextToken\\": \\"\\\\\\"\\\\\\"\\",\\n \\"MaxResults\\": 0\\n}","type":"json"}]', - ], - 'UpdateRecallManagementConfig' => [ - 'summary' => '更新召回管理初始化配置。', - 'path' => '/api/v1/recallmanagementconfigs', - 'methods' => [ - 'put', + 'staticInfo' => ['returnType' => 'synchronous'], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"7D59453C-48AA-5FC5-8848-2D373BD1A17F\\",\\n \\"FeatureConsistencyCheckJobId\\": \\"4\\"\\n}","type":"json"}]', + 'title' => 'Create a feature consistency check job', + 'changeSet' => [ + ['createdAt' => '2024-02-22T03:35:40.000Z', 'description' => 'Request parameters changed'], + ], + 'ramActions' => [ + [ + 'operationType' => 'create', + 'ramAction' => [ + 'action' => 'pairec:CreateFeatureConsistencyCheckJob', + 'authLevel' => 'operate', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'PAIRecService', 'resourceType' => 'All Resource', 'arn' => '*'], + ], + ], + ], ], - 'schemes' => [ - 'https', + 'flowControl' => [ + 'flowControlList' => [], ], + ], + 'CreateFeatureConsistencyCheckJobConfig' => [ + 'path' => '/api/v1/featureconsistencycheck/jobconfigs', + 'methods' => ['post'], + 'schemes' => ['http', 'https'], 'security' => [ [ 'AK' => [], ], ], - 'consumes' => [ - 'application/json', - ], - 'produces' => [ - 'application/json', - ], + 'consumes' => ['application/json'], + 'produces' => ['application/json'], 'operationType' => 'readAndWrite', 'deprecated' => false, 'systemTags' => [ - 'operationType' => 'none', + 'operationType' => 'create', 'riskType' => 'none', 'chargeType' => 'free', - 'abilityTreeNodes' => [ - 'FEATURElearnN0NAWV', - ], + 'abilityTreeCode' => '193262', + 'abilityTreeNodes' => ['FEATURElearnN0NAWV'], ], 'parameters' => [ [ @@ -2808,164 +2144,311 @@ 'in' => 'body', 'style' => 'json', 'schema' => [ - 'description' => '', + 'description' => 'The request body.', 'type' => 'object', 'properties' => [ - 'InstanceId' => [ - 'description' => '', - 'type' => 'string', - 'required' => false, - 'example' => '1', - ], - 'Password' => [ - 'description' => '', - 'type' => 'string', - 'required' => false, - 'example' => '12345', - ], - 'NetworkConfigs' => [ - 'description' => '', - 'type' => 'array', - 'items' => [ - 'description' => '', - 'type' => 'object', - 'properties' => [ - 'VpcId' => [ - 'description' => '', - 'type' => 'string', - 'required' => false, - 'example' => 'vpc-xxx', - ], - 'VswitchIds' => [ - 'description' => '', - 'type' => 'object', - 'required' => false, - 'additionalProperties' => [ - 'type' => 'string', - 'example' => 'vsw-xxx', - 'description' => '', - ], - 'example' => 'cn-hangzhou', - ], - ], - 'required' => false, - ], - 'required' => false, - ], + 'InstanceId' => ['description' => 'The instance ID. To obtain this ID, see [ListInstances](~~2411819~~).', 'type' => 'string', 'required' => true, 'example' => 'pairec-cn-********', 'title' => ''], + 'Name' => ['description' => 'The name of the feature consistency check.', 'type' => 'string', 'required' => true, 'example' => 'feature_consistency_check1', 'title' => ''], + 'SceneId' => ['description' => 'The scene ID.', 'type' => 'string', 'required' => true, 'example' => '3', 'title' => ''], + 'SampleRate' => ['description' => 'The sample rate. The value must be between 0 and 1, inclusive.', 'type' => 'number', 'format' => 'double', 'required' => true, 'example' => '0.89', 'title' => ''], + 'EasServiceName' => ['description' => 'The name of the PAI-EAS service. To obtain this name, see [ListServices](~~412109~~).', 'type' => 'string', 'required' => true, 'example' => 'service_123', 'title' => ''], + 'FeatureLandingResourceId' => ['description' => 'The ID of the data source where the feature data is saved.', 'type' => 'string', 'required' => true, 'example' => 'reso-********', 'title' => ''], + 'MaxcomputeSchema' => ['description' => 'The schema of the MaxCompute project.', 'type' => 'string', 'example' => 'default', 'title' => ''], + 'FgJsonFileName' => ['description' => 'The name of the `fg_json` file.', 'type' => 'string', 'required' => true, 'example' => 'file.json', 'title' => ''], + 'UserTable' => ['description' => 'The name of the user table.', 'type' => 'string', 'required' => false, 'example' => 'user_table', 'title' => ''], + 'UserIdField' => ['description' => 'The name of the `user_id` field.', 'type' => 'string', 'required' => false, 'example' => 'user_id', 'title' => ''], + 'UserTablePartitionField' => ['description' => 'The partition field of the user table.', 'type' => 'string', 'required' => false, 'example' => 'ds', 'title' => ''], + 'UserTablePartitionFieldFormat' => ['description' => 'The format of the partition field in the user table. Valid values:'."\n" + ."\n" + .'- `yyyymmdd`'."\n" + ."\n" + .'- `yyyy-mm-dd`', 'type' => 'string', 'required' => false, 'example' => 'yyyymmdd', 'title' => ''], + 'ItemTable' => ['description' => 'The name of the item table.', 'type' => 'string', 'required' => false, 'example' => 'item_table', 'title' => ''], + 'ItemIdField' => ['description' => 'The name of the `item_id` field.', 'type' => 'string', 'required' => false, 'example' => 'item_id', 'title' => ''], + 'ItemTablePartitionField' => ['description' => 'The partition field of the item table.', 'type' => 'string', 'required' => false, 'example' => 'ds', 'title' => ''], + 'ItemTablePartitionFieldFormat' => ['description' => 'The format of the partition field in the item table. Valid values:'."\n" + ."\n" + .'- `yyyymmdd`'."\n" + ."\n" + .'- `yyyy-mm-dd`', 'type' => 'string', 'required' => false, 'example' => 'yyyymmdd', 'title' => ''], + 'CompareFeature' => ['description' => 'Specifies whether to compare features.', 'type' => 'boolean', 'required' => true, 'title' => '', 'example' => 'true'], + 'GenerateZip' => ['description' => 'Specifies whether to generate a ZIP package.', 'type' => 'boolean', 'required' => true, 'title' => '', 'example' => 'true'], + 'ServiceId' => ['description' => 'The service ID.', 'type' => 'string', 'required' => true, 'example' => '4', 'title' => ''], + 'WorkflowName' => ['description' => 'The workflow name.', 'type' => 'string', 'example' => 'work_flow_1', 'title' => '', 'required' => false], + 'OssResourceId' => ['description' => 'The OSS data source ID.', 'type' => 'string', 'example' => 'reso-********', 'title' => '', 'required' => false], + 'EasyRecVersion' => ['description' => 'The EasyRec version.', 'type' => 'string', 'example' => '1.3.60', 'title' => '', 'required' => false], + 'EasyRecPackagePath' => ['description' => 'The path of the OSS bucket where the EasyRec package is stored.', 'type' => 'string', 'title' => '', 'required' => false, 'example' => 'oss://*******'], + 'FgJarVersion' => ['description' => 'The `fg_jar` version.', 'type' => 'string', 'example' => '1.0.0', 'title' => '', 'required' => false], + 'FeaturePriority' => ['description' => 'The feature priority. Use a comma (,) to separate multiple features.', 'type' => 'string', 'example' => 'feature1,feature2,feature3', 'title' => '', 'required' => false], + 'FeatureDisplayExclude' => ['description' => 'The features to exclude from the display. Use a comma (,) to separate multiple features.', 'type' => 'string', 'example' => 'feature1,feature2', 'title' => '', 'required' => false], + 'UseFeatureStore' => ['description' => 'Specifies whether to use a feature store. Valid values:'."\n" + ."\n" + .'- `true`: Use a feature store. The `FeatureStoreProjectId`, `FeatureStoreProjectName`, `FeatureStoreModelId`, `FeatureStoreUserId`, and `FeatureStoreItemId` parameters are required.'."\n" + ."\n" + .'- `false`: Do not use a feature store. The `UserTable`, `UserIdField`, `UserTablePartitionField`, `UserTablePartitionFieldFormat`, `ItemTable`, `ItemIdField`, `ItemTablePartitionField`, and `ItemTablePartitionFieldFormat` parameters are required.', 'type' => 'boolean', 'required' => true, 'default' => 'false', 'example' => 'true', 'title' => ''], + 'FeatureStoreProjectName' => ['description' => 'The feature store project name.', 'type' => 'string', 'required' => false, 'example' => 'project-1', 'title' => ''], + 'FeatureStoreModelId' => ['description' => 'The feature store model ID.', 'type' => 'string', 'required' => false, 'example' => '2', 'title' => ''], + 'FeatureStoreUserId' => ['description' => 'The primary key for the user side in the feature store.', 'type' => 'string', 'required' => false, 'example' => 'user', 'title' => ''], + 'FeatureStoreItemId' => ['description' => 'The primary key for the item side in the feature store.', 'type' => 'string', 'required' => false, 'example' => 'item', 'title' => ''], + 'FeatureStoreSeqFeatureView' => ['description' => 'The name of the feature view that contains the item features within sequence features.', 'type' => 'string', 'required' => false, 'example' => 'item-1', 'title' => ''], + 'FeatureStoreProjectId' => ['description' => 'The feature store project ID.', 'type' => 'string', 'required' => false, 'example' => 'prj-01', 'title' => ''], + 'WorkspaceId' => ['description' => 'The workspace ID.', 'type' => 'string', 'example' => 'test', 'required' => false, 'title' => ''], + 'VpcId' => ['description' => 'The VPC ID.', 'type' => 'string', 'example' => 'vpc-xxx', 'required' => false, 'title' => ''], + 'SwitchId' => ['description' => 'The vSwitch ID.', 'type' => 'string', 'example' => 'vswitch-xxx', 'required' => false, 'title' => ''], + 'SecurityGroupId' => ['description' => 'The security group ID.', 'type' => 'string', 'example' => 'thax-xxx', 'required' => false, 'title' => ''], + 'DefaultRoute' => ['description' => 'The default route.', 'type' => 'string', 'required' => false, 'example' => 'Eth0', 'title' => ''], + 'DatasetId' => ['description' => 'The dataset ID.', 'type' => 'string', 'example' => 's-xxx', 'required' => false, 'title' => ''], + 'DatasetType' => ['description' => 'The dataset type.', 'type' => 'string', 'example' => 'OSS', 'required' => false, 'title' => ''], + 'DatasetUri' => ['description' => 'The dataset URI.', 'type' => 'string', 'example' => 'oss-xxx', 'required' => false, 'title' => ''], + 'DatasetMountPath' => ['description' => 'The dataset mount path.', 'type' => 'string', 'example' => 'mnt/xxx', 'required' => false, 'title' => ''], + 'DatasetName' => ['description' => 'The dataset name.', 'type' => 'string', 'example' => 'test', 'required' => false, 'title' => ''], + 'PredictWorkerCount' => ['description' => 'The number of prediction workers.', 'type' => 'integer', 'format' => 'int32', 'example' => '1', 'required' => false, 'title' => ''], + 'PredictWorkerCpu' => ['description' => 'The number of CPU cores for each prediction worker.', 'type' => 'integer', 'format' => 'int32', 'example' => '4', 'required' => false, 'title' => ''], + 'PredictWorkerMemory' => ['description' => 'The memory size for each prediction worker, in megabytes (MB).', 'type' => 'integer', 'format' => 'int32', 'example' => '32000', 'required' => false, 'title' => ''], + 'ResourceConfig' => ['description' => 'The resource configuration.', 'type' => 'string', 'example' => '{}', 'required' => false, 'title' => ''], ], 'required' => false, + 'title' => '', + 'example' => '', ], ], ], 'responses' => [ 200 => [ 'schema' => [ - 'title' => 'Schema of Response', - 'description' => 'Schema of Response', + 'title' => '', + 'description' => 'The response object.', 'type' => 'object', 'properties' => [ - 'RequestId' => [ - 'title' => 'Id of the request', - 'description' => '', - 'type' => 'string', - 'example' => '728C5E01-ABF6-5AA8-B9FC-B3BA05DECC77', - ], + 'RequestId' => ['description' => 'The request ID.', 'type' => 'string', 'title' => '', 'example' => 'E15A1443-7917-5BE0-AE70-25538ECF398D'], + 'FeatureConsistencyCheckJobConfigId' => ['description' => 'The feature consistency check job configuration ID.', 'type' => 'string', 'example' => '4', 'title' => ''], ], + 'example' => '', ], ], ], - 'staticInfo' => [ - 'returnType' => 'synchronous', + 'staticInfo' => ['returnType' => 'synchronous'], + 'title' => 'Create a feature consistency check job configuration', + 'summary' => 'Configure a feature consistency check task.', + 'changeSet' => [ + ['createdAt' => '2025-06-04T10:10:20.000Z', 'description' => 'Request parameters changed'], + ['createdAt' => '2024-12-10T06:00:28.000Z', 'description' => 'Request parameters changed'], + ['createdAt' => '2024-11-12T09:17:26.000Z', 'description' => 'Request parameters changed'], + ['createdAt' => '2024-02-22T03:35:43.000Z', 'description' => 'Request parameters changed'], ], - 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"728C5E01-ABF6-5AA8-B9FC-B3BA05DECC77\\"\\n}","type":"json"}]', - ], - 'PublishRecallManagementTable' => [ - 'summary' => '将maxcompute的表同步到召回引擎中。', - 'path' => '/api/v1/recallmanagementtables/{RecallManagementTableId}/action/publish', - 'methods' => [ - 'post', + 'flowControl' => [ + 'flowControlList' => [], ], - 'schemes' => [ - 'https', + 'ramActions' => [ + [ + 'operationType' => 'create', + 'ramAction' => [ + 'action' => 'pairec:CreateFeatureConsistencyCheckJobConfig', + 'authLevel' => 'operate', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'PAIRecService', 'resourceType' => 'All Resource', 'arn' => '*'], + ], + ], + ], ], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"E15A1443-7917-5BE0-AE70-25538ECF398D\\",\\n \\"FeatureConsistencyCheckJobConfigId\\": \\"4\\"\\n}","type":"json"}]', + ], + 'CreateInstanceResource' => [ + 'summary' => 'Creates a configuration resource for a specified instance.', + 'path' => '/api/v1/instances/{InstanceId}/resources', + 'methods' => ['post'], + 'schemes' => ['http', 'https'], 'security' => [ [ 'AK' => [], ], ], - 'consumes' => [ - 'application/json', - ], - 'produces' => [ - 'application/json', - ], + 'consumes' => ['application/json'], + 'produces' => ['application/json'], 'operationType' => 'readAndWrite', 'deprecated' => false, 'systemTags' => [ - 'operationType' => 'none', + 'operationType' => 'create', 'riskType' => 'none', 'chargeType' => 'free', - 'abilityTreeNodes' => [ - 'FEATURElearnN0NAWV', - ], + 'abilityTreeNodes' => ['FEATURElearnN0NAWV'], ], 'parameters' => [ [ + 'name' => 'InstanceId', + 'in' => 'path', + 'schema' => ['description' => 'The instance ID. You can obtain this ID by calling the [ListInstances](~~2411819~~) operation.', 'type' => 'string', 'required' => true, 'example' => 'pairec-cn-test1', 'title' => ''], + ], + [ 'name' => 'body', 'in' => 'body', 'style' => 'json', 'schema' => [ - 'description' => '', + 'description' => 'The request body parameters.', 'type' => 'object', 'properties' => [ - 'InstanceId' => [ - 'description' => '', - 'type' => 'string', - 'required' => true, - 'example' => 'pairec-test1', - ], - 'Partition' => [ - 'description' => '', - 'type' => 'object', - 'required' => false, - 'additionalProperties' => [ - 'type' => 'string', - 'example' => '{"ds":"20250711"}', - 'description' => '', - ], - ], - 'SkipThresholdCheck' => [ - 'description' => '', - 'type' => 'boolean', - 'required' => false, - 'example' => 'false', - ], - 'Mode' => [ - 'description' => '', - 'type' => 'string', - 'required' => false, - 'example' => 'Merge', - ], - 'Partitions' => [ - 'title' => '分区信息。', - 'type' => 'object', - 'additionalProperties' => [ - 'title' => '分区值。', - 'type' => 'string', - ], - ], + 'Category' => ['description' => 'The resource category. Valid values:'."\n" + ."\n" + .'- DataManagement'."\n" + ."\n" + .'- Engine'."\n" + ."\n" + .'- Monitor', 'type' => 'string', 'required' => true, 'example' => 'DataManagement', 'title' => ''], + 'Group' => ['description' => 'The resource group.'."\n" + ."\n" + .'If the resource category is DataManagement, valid values are:'."\n" + ."\n" + .'- storage'."\n" + ."\n" + .'- modelpipeline'."\n" + ."\n" + .'- datastorage'."\n" + ."\n" + .'- modeltrain'."\n" + ."\n" + .'If the resource category is Engine, valid values are:'."\n" + ."\n" + .'- feature'."\n" + ."\n" + .'- predict'."\n" + ."\n" + .'- recall'."\n" + ."\n" + .'- recengine'."\n" + ."\n" + .'If the resource category is Monitor, valid values are:'."\n" + ."\n" + .'- logs'."\n" + ."\n" + .'- logsback'."\n" + ."\n" + .'- coldstart'."\n" + ."\n" + .'- deploy', 'type' => 'string', 'required' => true, 'example' => 'storage', 'title' => ''], + 'Type' => ['description' => 'The resource type. Valid values:'."\n" + ."\n" + .'- Hologres'."\n" + ."\n" + .'- EAS'."\n" + ."\n" + .'- BE'."\n" + ."\n" + .'- Rec'."\n" + ."\n" + .'- Platform'."\n" + ."\n" + .'- SLS'."\n" + ."\n" + .'- DataHub'."\n" + ."\n" + .'- ApsaraMQ for Kafka'."\n" + ."\n" + .'- Realtime Compute for Apache Flink'."\n" + ."\n" + .'- ACR'."\n" + ."\n" + .'- OSS'."\n" + ."\n" + .'- DataWorks'."\n" + ."\n" + .'- PAI'."\n" + ."\n" + .'- MaxCompute'."\n" + ."\n" + .'- Graph Compute'."\n" + ."\n" + .'- ApsaraDB for Redis', 'type' => 'string', 'required' => true, 'example' => 'OSS', 'title' => ''], + 'Uri' => ['description' => 'The resource URI.', 'type' => 'string', 'required' => true, 'example' => 'bucket-test-123', 'title' => ''], ], 'required' => false, + 'title' => '', + 'example' => '', ], ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'title' => 'Schema of Response', + 'description' => 'The response schema.', + 'type' => 'object', + 'properties' => [ + 'RequestId' => ['title' => 'Id of the request', 'description' => 'The request ID.', 'type' => 'string', 'example' => '6CF1E160-3F36-5E73-A170-C75504F05BBC'], + 'ResourceId' => ['description' => 'The resource ID.', 'type' => 'string', 'example' => 'reso-2s416t***', 'title' => ''], + ], + 'example' => '', + ], + ], + ], + 'staticInfo' => ['returnType' => 'synchronous'], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"6CF1E160-3F36-5E73-A170-C75504F05BBC\\",\\n \\"ResourceId\\": \\"reso-2s416t***\\"\\n}","type":"json"}]', + 'title' => 'Create Configuration Resource', + 'changeSet' => [ + ['createdAt' => '2024-02-22T03:35:44.000Z', 'description' => 'Request parameters changed'], + ], + 'flowControl' => [ + 'flowControlList' => [], + ], + 'ramActions' => [ + [ + 'operationType' => 'create', + 'ramAction' => [ + 'action' => 'pairec:CreateInstanceResource', + 'authLevel' => 'operate', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'PAIRecService', 'resourceType' => 'All Resource', 'arn' => '*'], + ], + ], + ], + ], + ], + 'CreateLaboratory' => [ + 'summary' => 'Creates a laboratory. A laboratory isolates a segment of traffic for running experiments.', + 'path' => '/api/v1/laboratories', + 'methods' => ['post'], + 'schemes' => ['http', 'https'], + 'security' => [ [ - 'name' => 'RecallManagementTableId', - 'in' => 'path', + 'AK' => [], + ], + ], + 'consumes' => ['application/json'], + 'produces' => ['application/json'], + 'operationType' => 'write', + 'deprecated' => false, + 'systemTags' => [ + 'operationType' => 'create', + 'riskType' => 'none', + 'chargeType' => 'free', + 'abilityTreeNodes' => ['FEATURElearnN0NAWV'], + ], + 'parameters' => [ + [ + 'name' => 'body', + 'in' => 'body', + 'style' => 'json', 'schema' => [ - 'description' => '', - 'type' => 'string', + 'title' => '', + 'description' => 'The request body.', + 'type' => 'object', + 'properties' => [ + 'SceneId' => ['description' => 'The scene ID. To get it, call the `ListScenes` operation.', 'type' => 'string', 'required' => true, 'example' => '3', 'title' => ''], + 'Name' => ['description' => 'The laboratory name.', 'type' => 'string', 'required' => true, 'example' => 'laboratory1', 'title' => ''], + 'Description' => ['description' => 'The laboratory description.', 'type' => 'string', 'example' => 'This is a test.', 'title' => '', 'required' => false], + 'DebugUsers' => ['description' => 'The UIDs of debug users, separated by commas. Each UID must belong to an Alibaba Cloud primary account or a RAM user.', 'type' => 'string', 'example' => '1124512470******,1124512471******,1124512472******', 'title' => '', 'required' => false], + 'DebugCrowdId' => ['description' => 'The debug crowd ID.', 'type' => 'string', 'example' => '3', 'title' => '', 'required' => false], + 'BucketCount' => ['description' => 'The number of buckets.', 'type' => 'integer', 'format' => 'int32', 'example' => '24', 'title' => '', 'required' => false], + 'Buckets' => ['description' => 'The assigned bucket numbers.', 'type' => 'string', 'example' => '1,2,3,10-20', 'title' => '', 'required' => false], + 'BucketType' => ['description' => 'The bucketing method. Valid values: ● `UidHash`: by UID hash (default) ● `Uid`: by UID ● `Filter`: filter-based', 'type' => 'string', 'required' => true, 'example' => 'UidHash', 'title' => ''], + 'Filter' => ['description' => 'The filter.', 'type' => 'string', 'example' => 'filter=xxx', 'title' => '', 'required' => false], + 'Environment' => ['description' => 'The environment. Valid values: ● `Daily`: daily ● `Pre`: staging ● `Prod`: production', 'type' => 'string', 'required' => true, 'example' => 'Daily', 'title' => ''], + 'Type' => ['description' => 'The laboratory type. Valid values: `Base` and `NonBase`.', 'type' => 'string', 'required' => true, 'example' => 'Base', 'title' => ''], + 'InstanceId' => ['description' => 'The instance ID. To get it, call the `ListInstances` operation.', 'type' => 'string', 'required' => true, 'example' => 'pairec-cn-abcdefg1234', 'title' => ''], + ], 'required' => false, - 'example' => '3', + 'example' => '', ], ], ], @@ -2973,140 +2456,218 @@ 200 => [ 'schema' => [ 'title' => 'Schema of Response', - 'description' => 'Schema of Response', + 'description' => 'The response body.', 'type' => 'object', 'properties' => [ - 'RequestId' => [ - 'title' => 'Id of the request', - 'description' => '', - 'type' => 'string', - 'example' => '728C5E01-ABF6-5AA8-B9FC-B3BA05DECC77', - ], - 'RecallManagementJobId' => [ - 'description' => '', - 'type' => 'string', - 'example' => '1', - ], + 'RequestId' => ['title' => 'Id of the request', 'description' => 'The request ID.', 'type' => 'string', 'example' => '42391E6D-822C-58F8-9F7E-D991BB86D6AD'], + 'LaboratoryId' => ['description' => 'The laboratory ID.', 'type' => 'string', 'example' => '3', 'title' => ''], ], + 'example' => '', ], ], ], - 'staticInfo' => [ - 'returnType' => 'synchronous', + 'staticInfo' => ['returnType' => 'synchronous'], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"42391E6D-822C-58F8-9F7E-D991BB86D6AD\\",\\n \\"LaboratoryId\\": \\"3\\"\\n}","type":"json"}]', + 'title' => 'Create Lab', + 'changeSet' => [], + 'flowControl' => [ + 'flowControlList' => [], + ], + 'ramActions' => [ + [ + 'operationType' => 'create', + 'ramAction' => [ + 'action' => 'pairec:CreateLaboratory', + 'authLevel' => 'operate', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'PAIRecService', 'resourceType' => 'All Resource', 'arn' => '*'], + ], + ], + ], ], - 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"728C5E01-ABF6-5AA8-B9FC-B3BA05DECC77\\",\\n \\"RecallManagementJobId\\": \\"1\\"\\n}","type":"json"}]', ], - 'OfflineRecallManagementService' => [ - 'summary' => '下线召回管理服务', - 'path' => '/api/v1/recallmanagementservices/{RecallManagementServiceId}/action/offline', - 'methods' => [ - 'post', - ], - 'schemes' => [ - 'https', - ], + 'CreateLayer' => [ + 'summary' => 'Creates a layer in a specified laboratory for layered experiments. Layers are orthogonal to each other, allowing experiments to run independently and preventing traffic starvation.', + 'path' => '/api/v1/layers', + 'methods' => ['post'], + 'schemes' => ['http', 'https'], 'security' => [ [ 'AK' => [], ], ], - 'consumes' => [ - 'application/json', - ], - 'produces' => [ - 'application/json', - ], + 'consumes' => ['application/json'], + 'produces' => ['application/json'], 'operationType' => 'write', 'deprecated' => false, 'systemTags' => [ - 'operationType' => 'none', + 'operationType' => 'create', 'riskType' => 'none', 'chargeType' => 'free', - 'abilityTreeNodes' => [ - 'FEATURElearnN0NAWV', - ], + 'abilityTreeNodes' => ['FEATURElearnN0NAWV'], ], 'parameters' => [ [ - 'name' => 'RecallManagementServiceId', - 'in' => 'path', + 'name' => 'body', + 'in' => 'body', + 'style' => 'json', 'schema' => [ - 'description' => '', - 'type' => 'string', + 'title' => '', + 'description' => 'The request body.', + 'type' => 'object', + 'properties' => [ + 'LaboratoryId' => ['description' => 'The ID of the laboratory. Call the `ListLaboratories` operation to obtain this value.', 'type' => 'string', 'required' => true, 'example' => '3', 'title' => ''], + 'Name' => ['description' => 'The name of the layer.', 'type' => 'string', 'required' => true, 'example' => 'layer1', 'title' => ''], + 'Description' => ['description' => 'The description of the layer.', 'type' => 'string', 'required' => true, 'example' => 'This is a test.', 'title' => ''], + 'InstanceId' => ['description' => 'The ID of the instance. Call the `ListInstances` operation to obtain this value.', 'type' => 'string', 'required' => true, 'example' => 'pairec-cn-abcdefg1234', 'title' => ''], + ], 'required' => false, - 'example' => '3', + 'example' => '', + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'title' => 'Schema of Response', + 'description' => 'The response schema.', + 'type' => 'object', + 'properties' => [ + 'RequestId' => ['title' => 'Id of the request', 'description' => 'The ID of the request.', 'type' => 'string', 'example' => '59CE7EC6-F268-5D71-9215-32922CC50D72'], + 'LayerId' => ['description' => 'The ID of the layer.', 'type' => 'string', 'example' => '3', 'title' => ''], + ], + 'example' => '', + ], + ], + ], + 'staticInfo' => ['returnType' => 'synchronous'], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"59CE7EC6-F268-5D71-9215-32922CC50D72\\",\\n \\"LayerId\\": \\"3\\"\\n}","type":"json"}]', + 'title' => 'Create Layer', + 'changeSet' => [], + 'flowControl' => [ + 'flowControlList' => [], + ], + 'ramActions' => [ + [ + 'operationType' => 'create', + 'ramAction' => [ + 'action' => 'pairec:CreateLayer', + 'authLevel' => 'operate', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'PAIRecService', 'resourceType' => 'All Resource', 'arn' => '*'], + ], ], ], + ], + ], + 'CreateParam' => [ + 'summary' => 'Creates an ABTest parameter for a specific scene in a specified environment.', + 'path' => '/api/v1/params', + 'methods' => ['post'], + 'schemes' => ['http', 'https'], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'consumes' => ['application/json'], + 'produces' => ['application/json'], + 'operationType' => 'write', + 'deprecated' => false, + 'systemTags' => [ + 'operationType' => 'create', + 'riskType' => 'none', + 'chargeType' => 'free', + 'abilityTreeNodes' => ['FEATURElearnN0NAWV'], + ], + 'parameters' => [ [ 'name' => 'body', 'in' => 'body', 'style' => 'json', 'schema' => [ - 'description' => '', + 'description' => 'The request body.', 'type' => 'object', 'properties' => [ - 'InstanceId' => [ - 'description' => '', - 'type' => 'string', - 'required' => false, - 'example' => 'pairec-cn-test123', - ], + 'SceneId' => ['title' => '', 'description' => 'The scene ID. You can call the ListScenes operation to obtain the scene ID.', 'type' => 'string', 'example' => '4', 'required' => false], + 'Name' => ['title' => '', 'description' => 'The parameter name.', 'type' => 'string', 'example' => 'home', 'required' => false], + 'Value' => ['title' => '', 'description' => 'The parameter value.', 'type' => 'string', 'example' => 'house', 'required' => false], + 'Environment' => ['title' => '', 'description' => 'The environment to which the parameter belongs. Valid values:'."\n" + .'- Daily: daily environment.'."\n" + .'- Pre: staging environment.'."\n" + .'- Prod: production environment.', 'type' => 'string', 'example' => 'Daily', 'required' => false], + 'InstanceId' => ['title' => '', 'description' => 'The instance ID. You can call the ListInstances operation to obtain the instance ID.', 'type' => 'string', 'example' => 'pairec-cn-abcdefg1234', 'required' => false], + 'Type' => ['description' => 'The parameter type. Valid values:'."\n" + ."\n" + .'- Normal: common parameter.'."\n" + ."\n" + .'- Encryption: encrypted parameter.', 'type' => 'string', 'required' => false, 'example' => 'Normal', 'title' => ''], ], 'required' => false, + 'title' => '', + 'example' => '', ], ], ], 'responses' => [ 200 => [ 'schema' => [ - 'title' => 'Schema of Response', + 'title' => '', 'description' => 'Schema of Response', 'type' => 'object', 'properties' => [ - 'RequestId' => [ - 'title' => 'Id of the request', - 'description' => 'Id of the request', - 'type' => 'string', - 'example' => '728C5E01-ABF6-5AA8-B9FC-B3BA05DECC77', - ], + 'RequestId' => ['title' => '', 'description' => 'Id of the request', 'type' => 'string', 'example' => 'F8F613A9-DF1C-551A-88E1-397A3981A785'], + 'ParamId' => ['title' => '', 'description' => 'The parameter ID.', 'type' => 'integer', 'format' => 'int64', 'example' => '4'], ], + 'example' => '', ], ], ], - 'staticInfo' => [ - 'returnType' => 'synchronous', + 'staticInfo' => ['returnType' => 'synchronous'], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"F8F613A9-DF1C-551A-88E1-397A3981A785\\",\\n \\"ParamId\\": 4\\n}","type":"json"}]', + 'title' => 'Create aBTest parameter', + 'description' => '## Operation description.', + 'changeSet' => [ + ['createdAt' => '2025-07-02T01:39:45.000Z', 'description' => 'Request parameters changed'], + ], + 'flowControl' => [ + 'flowControlList' => [], + ], + 'ramActions' => [ + [ + 'operationType' => 'create', + 'ramAction' => [ + 'action' => 'pairec:CreateParam', + 'authLevel' => 'operate', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'PAIRecService', 'resourceType' => 'All Resource', 'arn' => '*'], + ], + ], + ], ], - 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"728C5E01-ABF6-5AA8-B9FC-B3BA05DECC77\\"\\n}","type":"json"}]', ], - 'CreateRecallManagementTable' => [ - 'summary' => '创建召回管理表。', - 'path' => '/api/v1/recallmanagementtables', - 'methods' => [ - 'post', - ], - 'schemes' => [ - 'https', - ], + 'CreateRecallManagementConfig' => [ + 'summary' => 'Initializes a Recall Management configuration, including the instance ID, user information, and network configurations.', + 'path' => '/api/v1/recallmanagementconfigs', + 'methods' => ['post'], + 'schemes' => ['https'], 'security' => [ [ 'AK' => [], ], ], - 'consumes' => [ - 'application/json', - ], - 'produces' => [ - 'application/json', - ], + 'consumes' => ['application/json'], + 'produces' => ['application/json'], 'operationType' => 'write', 'deprecated' => false, 'systemTags' => [ 'operationType' => 'create', 'riskType' => 'none', 'chargeType' => 'free', - 'abilityTreeNodes' => [ - 'FEATURElearnN0NAWV', - ], + 'abilityTreeNodes' => ['FEATURElearnN0NAWV'], ], 'parameters' => [ [ @@ -3114,1022 +2675,622 @@ 'in' => 'body', 'style' => 'json', 'schema' => [ - 'description' => '', + 'description' => 'The request body.', 'type' => 'object', 'properties' => [ - 'InstanceId' => [ - 'description' => '', - 'type' => 'string', - 'required' => true, - 'example' => 'pairec-cn-test123', - ], - 'Name' => [ - 'description' => '', - 'type' => 'string', - 'required' => false, - 'example' => 'table-123', - ], - 'Description' => [ - 'description' => '', - 'type' => 'string', - 'required' => false, - 'example' => 'this is a test table', - ], - 'Type' => [ - 'description' => '', - 'type' => 'string', - 'required' => false, - 'example' => 'Recall', - ], - 'RecallType' => [ - 'description' => '', - 'type' => 'string', - 'required' => false, - 'example' => 'X2I', - ], - 'DataSource' => [ - 'description' => '', - 'type' => 'string', - 'required' => false, - 'example' => 'MaxcomputeAndApiApi', - ], - 'MaxcomputeProjectName' => [ - 'description' => '', - 'type' => 'string', - 'required' => false, - 'example' => 'test', - ], - 'MaxcomputeTableName' => [ - 'description' => '', - 'type' => 'string', - 'required' => false, - 'example' => 'table-1', - ], - 'Fields' => [ - 'description' => '', + 'InstanceId' => ['description' => '**The instance ID.**', 'type' => 'string', 'required' => false, 'example' => 'learn-pairec-xxx', 'title' => ''], + 'UserName' => ['description' => '**The user name.**', 'type' => 'string', 'required' => false, 'example' => 'zhhangsan', 'title' => ''], + 'Password' => ['description' => '**The password.**', 'type' => 'string', 'required' => false, 'example' => '12345', 'title' => ''], + 'NetworkConfigs' => [ + 'description' => '**The network configurations.**', 'type' => 'array', 'items' => [ - 'description' => '', + 'description' => 'Details of the network configurations.', 'type' => 'object', 'properties' => [ - 'Name' => [ - 'description' => '', - 'type' => 'string', - 'required' => false, - 'example' => 'age', - ], - 'Type' => [ - 'description' => '', - 'type' => 'string', + 'VpcId' => ['description' => 'The VPC ID.', 'type' => 'string', 'required' => false, 'example' => 'vpc-xxx', 'title' => ''], + 'VSwitchIds' => [ + 'description' => 'A map of availability zones to VSwitch IDs.', + 'additionalProperties' => ['description' => 'The VSwitch ID.', 'type' => 'string', 'example' => 'vsw-xxx', 'title' => ''], + 'type' => 'object', 'required' => false, + 'title' => '', 'example' => '', ], - 'Attributes' => [ - 'description' => '', - 'type' => 'array', - 'items' => [ - 'description' => '', - 'type' => 'string', - 'required' => false, - 'example' => 'Primary', - ], - 'required' => false, - ], - 'VectorDimension' => [ - 'description' => '', - 'type' => 'integer', - 'format' => 'int32', - 'required' => false, - 'example' => '32', - ], - 'VectorMetricType' => [ - 'description' => '', - 'type' => 'string', - 'required' => false, - 'example' => 'L2', - ], ], 'required' => false, + 'title' => '', + 'example' => '', ], 'required' => false, - ], - 'Config' => [ - 'description' => '', - 'type' => 'string', - 'required' => false, - 'example' => '{"":""}', - ], - 'EnableRowCountFluctuationThreshold' => [ - 'description' => '', - 'type' => 'boolean', - 'required' => false, - 'example' => 'true', - ], - 'MinRowCountFluctuationThreshold' => [ - 'description' => '', - 'type' => 'integer', - 'format' => 'int64', - 'required' => false, - 'example' => '10', - ], - 'MaxRowCountFluctuationThreshold' => [ - 'description' => '', - 'type' => 'integer', - 'format' => 'int64', - 'required' => false, - 'example' => '100', - ], - 'EnableDataSizeFluctuationThreshold' => [ - 'description' => '', - 'type' => 'boolean', - 'required' => false, - 'example' => 'true', - ], - 'MinDataSizeFluctuationThreshold' => [ - 'description' => '', - 'type' => 'integer', - 'format' => 'int64', - 'required' => false, - 'example' => '10', - ], - 'MaxDataSizeFluctuationThreshold' => [ - 'description' => '', - 'type' => 'integer', - 'format' => 'int64', - 'required' => false, - 'example' => '100', - ], - 'MaxcomputeSchema' => [ - 'description' => '', - 'type' => 'string', - 'required' => false, - 'example' => 'default', + 'title' => '', + 'example' => '', ], ], 'required' => false, + 'title' => '', + 'example' => '', ], ], ], 'responses' => [ 200 => [ 'schema' => [ + 'description' => 'The response object.', 'title' => 'Schema of Response', - 'description' => 'Schema of Response', 'type' => 'object', 'properties' => [ - 'RequestId' => [ - 'title' => 'Id of the request', - 'description' => '', - 'type' => 'string', - 'example' => '728C5E01-ABF6-5AA8-B9FC-B3BA05DECC77', - ], - 'RecallManagementTableId' => [ - 'description' => '', - 'type' => 'string', - 'example' => '3', - ], + 'RequestId' => ['title' => 'Id of the request', 'description' => 'The Request ID.', 'type' => 'string', 'example' => '728C5E01-ABF6-5AA8-B9FC-B3BA05DECC77'], ], + 'example' => '', ], ], ], - 'staticInfo' => [ - 'returnType' => 'synchronous', + 'staticInfo' => ['returnType' => 'synchronous'], + 'title' => 'Create Retrieval Management Configuration', + 'description' => '## Request', + 'changeSet' => [], + 'flowControl' => [ + 'flowControlList' => [], ], - 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"728C5E01-ABF6-5AA8-B9FC-B3BA05DECC77\\",\\n \\"RecallManagementTableId\\": \\"3\\"\\n}","type":"json"}]', - ], - 'CreateRecallManagementServiceVersionConfig' => [ - 'summary' => '创建召回管理服务版本配置', - 'path' => '/api/v1/recallmanagementservices/{RecallManagementServiceId}/versions/{RecallManagementServiceVersionId}/configs', - 'methods' => [ - 'post', - ], - 'schemes' => [ - 'https', + 'ramActions' => [ + [ + 'operationType' => 'create', + 'ramAction' => [ + 'action' => 'pairec:CreateRecallManagementConfig', + 'authLevel' => 'operate', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'PAIRecService', 'resourceType' => 'All Resource', 'arn' => '*'], + ], + ], + ], ], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"728C5E01-ABF6-5AA8-B9FC-B3BA05DECC77\\"\\n}","type":"json"}]', + ], + 'CreateRecallManagementService' => [ + 'summary' => 'Creates a new recall management service.', + 'path' => '/api/v1/recallmanagementservices', + 'methods' => ['post'], + 'schemes' => ['https'], 'security' => [ [ 'AK' => [], ], ], - 'consumes' => [ - 'application/json', - ], - 'produces' => [ - 'application/json', - ], + 'consumes' => ['application/json'], + 'produces' => ['application/json'], 'operationType' => 'write', 'deprecated' => false, 'systemTags' => [ - 'operationType' => 'none', + 'operationType' => 'create', 'riskType' => 'none', 'chargeType' => 'free', - 'abilityTreeNodes' => [ - 'FEATURElearnN0NAWV', - ], + 'abilityTreeNodes' => ['FEATURElearnN0NAWV'], ], 'parameters' => [ [ - 'name' => 'RecallManagementServiceId', - 'in' => 'path', - 'schema' => [ - 'description' => '', - 'type' => 'string', - 'required' => false, - 'example' => '2', - ], - ], - [ - 'name' => 'RecallManagementServiceVersionId', - 'in' => 'path', - 'schema' => [ - 'description' => '', - 'type' => 'string', - 'required' => false, - 'example' => '3', - ], - ], - [ 'name' => 'body', 'in' => 'body', 'style' => 'json', 'schema' => [ - 'description' => '', + 'description' => 'The request body.', 'type' => 'object', 'properties' => [ - 'InstanceId' => [ - 'description' => '', - 'type' => 'string', - 'required' => false, - 'example' => 'pai-teest-1', - ], - 'ConfigType' => [ - 'description' => '', - 'type' => 'string', - 'required' => false, - 'example' => 'Recall', - ], - 'RecallConfig' => [ - 'description' => '', - 'type' => 'object', - 'properties' => [ - 'Name' => [ - 'description' => '', - 'type' => 'string', - 'required' => false, - 'example' => 'etrec', - ], - 'Description' => [ - 'description' => '', - 'type' => 'string', - 'required' => false, - 'example' => 'this is etrec recall', - ], - 'Priority' => [ - 'description' => '', - 'type' => 'integer', - 'format' => 'int64', - 'required' => false, - 'example' => '2', - ], - 'RecallType' => [ - 'description' => '', - 'type' => 'string', - 'required' => false, - 'example' => 'X2I', - ], - 'RecallManagementTableId' => [ - 'description' => '', - 'type' => 'string', - 'required' => false, - 'example' => '3', - ], - 'UserVectorRecallManagementTableId' => [ - 'description' => '', - 'type' => 'string', - 'required' => false, - 'example' => '4', - ], - 'UserVectorField' => [ - 'description' => '', - 'type' => 'string', - 'required' => false, - 'example' => 'user_embedding', - ], - 'ItemVectorRecallManagementTableId' => [ - 'description' => '', - 'type' => 'string', - 'required' => false, - 'example' => '5', - ], - 'ItemVectorField' => [ - 'description' => '', - 'type' => 'string', - 'required' => false, - 'example' => 'item_embedding', - ], - 'Operators' => [ - 'description' => '', - 'type' => 'array', - 'items' => [ - 'description' => '', - 'type' => 'object', - 'properties' => [ - 'OperatorType' => [ - 'description' => '', - 'type' => 'string', - 'required' => false, - 'example' => 'Filter', - ], - 'TriggerConfig' => [ - 'description' => '', - 'type' => 'object', - 'properties' => [ - 'Field' => [ - 'description' => '', - 'type' => 'string', - 'required' => false, - 'example' => 'user_id', - ], - 'IsRandSort' => [ - 'description' => '', - 'type' => 'string', - 'required' => false, - 'example' => 'false', - ], - 'SortField' => [ - 'description' => '', - 'type' => 'string', - 'required' => false, - 'example' => 'create_time', - ], - 'FieldQuantityLimit' => [ - 'description' => '', - 'type' => 'string', - 'required' => false, - 'example' => '20', - ], - ], - 'required' => false, - ], - 'FilterConfig' => [ - 'description' => '', - 'type' => 'object', - 'properties' => [ - 'Experession' => [ - 'description' => '', - 'type' => 'string', - 'required' => false, - 'example' => 'age>20', - ], - ], - 'required' => false, - ], - 'FeatureConfig' => [ - 'description' => '', - 'type' => 'object', - 'properties' => [ - 'Name' => [ - 'description' => '', - 'type' => 'string', - 'required' => false, - 'example' => 'city', - ], - 'Type' => [ - 'description' => '', - 'type' => 'string', - 'required' => false, - 'example' => 'string', - ], - 'Expression' => [ - 'description' => '', - 'type' => 'string', - 'required' => false, - 'example' => 'category=3', - ], - ], - 'required' => false, - ], - 'JoinConfig' => [ - 'description' => '', - 'type' => 'object', - 'properties' => [ - 'Field' => [ - 'description' => '', - 'type' => 'string', - 'required' => false, - 'example' => 'item_id', - ], - 'RecallManagementTableId' => [ - 'description' => '', - 'type' => 'string', - 'required' => false, - 'example' => '3', - ], - 'OutputFields' => [ - 'description' => '', - 'type' => 'array', - 'items' => [ - 'description' => '', - 'type' => 'string', - 'required' => false, - 'example' => 'lang', - ], - 'required' => false, - ], - ], - 'required' => false, - ], - ], - 'required' => false, - ], - 'required' => false, - ], - 'ExtendedConfig' => [ - 'description' => '', - 'type' => 'string', - 'required' => false, - 'example' => '""', - ], - 'ItemConditionArray' => [ - 'description' => '', - 'type' => 'string', - 'required' => false, - 'example' => '[{"option":"<","field":"category","type":"STRING","value":"10"}]', - ], - 'ItemConditionExpression' => [ - 'title' => '物品条件表达式。', - 'type' => 'string', - 'example' => 'age>20', - ], - ], - 'required' => false, - ], - 'MergeConfig' => [ - 'description' => '', - 'type' => 'object', - 'properties' => [ - 'RecallManagementServiceVersionConfigId' => [ - 'description' => '', - 'type' => 'string', - 'required' => false, - 'example' => '1', - ], - 'MergeType' => [ - 'description' => '', - 'type' => 'string', - 'required' => false, - 'example' => 'Weight', - ], - 'FilterRecallManagementTableIds' => [ - 'description' => '', - 'type' => 'array', - 'items' => [ - 'description' => '', - 'type' => 'string', - 'required' => false, - 'example' => '3', - ], - 'required' => false, - ], - 'ItemRecallManagementTableId' => [ - 'description' => '', - 'type' => 'string', - 'required' => false, - 'example' => '2', - ], - 'ItemTableFields' => [ - 'description' => '', - 'type' => 'array', - 'items' => [ - 'description' => '', - 'type' => 'string', - 'required' => false, - 'example' => 'item_id', - ], - 'required' => false, - ], - 'FilterExpression' => [ - 'description' => '', - 'type' => 'string', - 'required' => false, - 'example' => 'age>20', - ], - 'ExtendedConfig' => [ - 'description' => '', - 'type' => 'string', - 'required' => false, - 'example' => '""', - ], - ], - 'required' => false, - ], + 'InstanceId' => ['description' => '**The instance ID.**', 'type' => 'string', 'required' => false, 'example' => 'pairec-cn-test123', 'title' => ''], + 'Name' => ['description' => '**The name of the recall management service.**', 'type' => 'string', 'required' => false, 'example' => 'hot_global_recall', 'title' => ''], + 'Description' => ['description' => '**The description for the recall management service.**', 'type' => 'string', 'required' => false, 'example' => 'this is a test recall', 'title' => ''], ], 'required' => false, + 'title' => '', + 'example' => '', ], ], ], 'responses' => [ 200 => [ 'schema' => [ + 'description' => 'The response object.', 'title' => 'Schema of Response', - 'description' => 'Schema of Response', 'type' => 'object', 'properties' => [ - 'RequestId' => [ - 'title' => 'Id of the request', - 'description' => '', - 'type' => 'string', - 'example' => 'F8F613A9-DF1C-551A-88E1-397A3981A785', - ], - 'RecallManagementServiceVersionConfigId' => [ - 'description' => '', - 'type' => 'string', - 'example' => '1', - ], + 'RequestId' => ['title' => 'Id of the request', 'description' => '**The request ID.**', 'type' => 'string', 'example' => '728C5E01-ABF6-5AA8-B9FC-B3BA05DECC77'], + 'RecallManagementServiceId' => ['description' => 'The recall management service ID.', 'type' => 'string', 'example' => '1', 'title' => ''], + 'RecallManagementServiceVersionId' => ['description' => 'The recall management service version ID.', 'type' => 'string', 'example' => '3', 'title' => ''], ], + 'example' => '', ], ], ], - 'staticInfo' => [ - 'returnType' => 'synchronous', + 'staticInfo' => ['returnType' => 'synchronous'], + 'title' => 'Create Retrieval Management Service', + 'description' => '## Description'."\n" + ."\n" + .'To create a recall management service, call this API with a specified instance ID, service name, and service description. Ensure that the `InstanceId` parameter is valid.', + 'changeSet' => [], + 'flowControl' => [ + 'flowControlList' => [], ], - 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"F8F613A9-DF1C-551A-88E1-397A3981A785\\",\\n \\"RecallManagementServiceVersionConfigId\\": \\"1\\"\\n}","type":"json"}]', + 'ramActions' => [ + [ + 'operationType' => 'create', + 'ramAction' => [ + 'action' => 'pairec:CreateRecallManagementService', + 'authLevel' => 'operate', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'PAIRecService', 'resourceType' => 'All Resource', 'arn' => '*'], + ], + ], + ], + ], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"728C5E01-ABF6-5AA8-B9FC-B3BA05DECC77\\",\\n \\"RecallManagementServiceId\\": \\"1\\",\\n \\"RecallManagementServiceVersionId\\": \\"3\\"\\n}","type":"json"}]', ], 'CreateRecallManagementServiceVersion' => [ - 'summary' => '创建召回管理版本', + 'summary' => 'Creates a new recall management service version that supports configuring multiple recall strategies.', 'path' => '/api/v1/recallmanagementservices/{RecallManagementServiceId}/versions', - 'methods' => [ - 'post', - ], - 'schemes' => [ - 'https', - ], + 'methods' => ['post'], + 'schemes' => ['https'], 'security' => [ [ 'AK' => [], ], ], - 'consumes' => [ - 'application/json', - ], - 'produces' => [ - 'application/json', - ], + 'consumes' => ['application/json'], + 'produces' => ['application/json'], 'operationType' => 'write', 'deprecated' => false, 'systemTags' => [ 'operationType' => 'none', 'riskType' => 'none', 'chargeType' => 'free', - 'abilityTreeNodes' => [ - 'FEATURElearnN0NAWV', - ], + 'abilityTreeNodes' => ['FEATURElearnN0NAWV'], ], 'parameters' => [ [ 'name' => 'RecallManagementServiceId', 'in' => 'path', - 'schema' => [ - 'description' => '', - 'type' => 'string', - 'required' => false, - 'example' => '2', - ], + 'schema' => ['description' => 'The ID of the recall management service.', 'type' => 'string', 'required' => false, 'example' => '2', 'title' => ''], ], [ 'name' => 'body', 'in' => 'body', 'style' => 'json', 'schema' => [ - 'description' => '', + 'description' => 'The request body.', 'type' => 'object', 'properties' => [ - 'SourceRecallManagementServiceVersionId' => [ - 'description' => '', - 'type' => 'string', - 'required' => false, - 'example' => '4', - ], + 'InstanceId' => ['description' => 'The instance ID.', 'type' => 'string', 'example' => 'learn-pairec-xxx', 'title' => '', 'required' => false], + 'SourceRecallManagementServiceVersionId' => ['description' => 'The source recall management service version ID.', 'type' => 'string', 'required' => false, 'example' => '4', 'title' => ''], 'Configs' => [ - 'description' => '', + 'description' => 'The configuration details.', 'type' => 'object', 'properties' => [ 'RecallConfigs' => [ - 'description' => '', + 'description' => 'A list of recall configurations.', 'type' => 'array', 'items' => [ - 'description' => '', + 'description' => 'A recall configuration.', 'type' => 'object', 'properties' => [ - 'Name' => [ - 'description' => '', - 'type' => 'string', - 'required' => false, - 'example' => 'etrec', - ], - 'Description' => [ - 'description' => '', - 'type' => 'string', - 'required' => false, - 'example' => 'this is etrec recall', - ], - 'Priority' => [ - 'description' => '', - 'type' => 'integer', - 'format' => 'int64', - 'required' => false, - 'example' => '1', - ], - 'RecallType' => [ - 'description' => '', - 'type' => 'string', - 'required' => false, - 'example' => 'X2I', - ], - 'RecallManagementTableId' => [ - 'description' => '', - 'type' => 'string', - 'required' => false, - 'example' => '1', - ], - 'UserVectorRecallManagementTableId' => [ - 'description' => '', - 'type' => 'string', - 'required' => false, - 'example' => '3', - ], - 'UserVectorField' => [ - 'description' => '', - 'type' => 'string', - 'required' => false, - 'example' => 'user_embedding', - ], - 'ItemVectorRecallManagementTableId' => [ - 'description' => '', - 'type' => 'string', - 'required' => false, - 'example' => '4', - ], - 'ItemVectorField' => [ - 'description' => '', - 'type' => 'string', - 'required' => false, - 'example' => 'item_embedding', - ], + 'Name' => ['description' => 'The recall name.', 'type' => 'string', 'required' => false, 'example' => 'etrec', 'title' => ''], + 'Description' => ['description' => 'The recall description.', 'type' => 'string', 'required' => false, 'example' => 'this is etrec recall', 'title' => ''], + 'Priority' => ['description' => 'The priority. A lower value indicates a higher priority.', 'type' => 'integer', 'format' => 'int64', 'required' => false, 'example' => '1', 'title' => ''], + 'RecallType' => ['description' => 'The recall type.', 'type' => 'string', 'required' => false, 'example' => 'X2I', 'title' => ''], + 'RecallManagementTableId' => ['description' => 'The recall management table ID.', 'type' => 'string', 'required' => false, 'example' => '1', 'title' => ''], + 'UserVectorRecallManagementTableId' => ['description' => 'The user vector recall management table ID.', 'type' => 'string', 'required' => false, 'example' => '3', 'title' => ''], + 'UserVectorField' => ['description' => 'The user vector field.', 'type' => 'string', 'required' => false, 'example' => 'user_embedding', 'title' => ''], + 'ItemVectorRecallManagementTableId' => ['description' => 'The item vector recall management table ID.', 'type' => 'string', 'required' => false, 'example' => '4', 'title' => ''], + 'ItemVectorField' => ['description' => 'The item vector field.', 'type' => 'string', 'required' => false, 'example' => 'item_embedding', 'title' => ''], + 'ItemConditionArray' => ['description' => 'The conditions for an item, formatted as an array.', 'type' => 'string', 'required' => false, 'example' => '[{"option":"<","field":"category","type":"STRING","value":"10"}]', 'title' => ''], + 'ItemConditionExpression' => ['description' => 'The item condition expression.', 'type' => 'string', 'example' => 'age>20', 'title' => '', 'required' => false], + 'SortFields' => ['description' => 'The sort fields.', 'type' => 'string', 'required' => false, 'example' => 'name', 'title' => ''], 'Operators' => [ - 'description' => '', + 'description' => 'A list of operators.', 'type' => 'array', 'items' => [ - 'description' => '', + 'description' => 'An operator configuration.', 'type' => 'object', 'properties' => [ - 'OperatorType' => [ - 'description' => '', - 'type' => 'string', - 'required' => false, - 'example' => 'Filter', - ], + 'OperatorType' => ['description' => 'The operator type.', 'type' => 'string', 'required' => false, 'example' => 'Filter', 'title' => ''], 'TriggerConfig' => [ - 'description' => '', + 'description' => 'The configuration for the Trigger operator.', 'type' => 'object', 'properties' => [ - 'Field' => [ - 'description' => '', - 'type' => 'string', - 'required' => false, - 'example' => 'user_id', - ], - 'IsRandSort' => [ - 'description' => '', - 'type' => 'string', - 'required' => false, - 'example' => 'false', - ], - 'SortField' => [ - 'description' => '', - 'type' => 'string', - 'required' => false, - 'example' => 'create_time', - ], - 'FieldQuantityLimit' => [ - 'description' => '', - 'type' => 'string', - 'required' => false, - 'example' => '20', - ], + 'Field' => ['description' => 'The field name.', 'type' => 'string', 'required' => false, 'example' => 'user_id', 'title' => ''], + 'IsRandSort' => ['description' => 'Specifies whether to sort randomly.', 'type' => 'boolean', 'required' => false, 'example' => 'false', 'title' => ''], + 'SortField' => ['description' => 'The sort field.', 'type' => 'string', 'required' => false, 'example' => 'create_time', 'title' => ''], + 'FieldQuantityLimit' => ['description' => 'The limit on the number of fields.', 'type' => 'integer', 'format' => 'int32', 'required' => false, 'example' => '20', 'title' => ''], ], 'required' => false, + 'title' => '', + 'example' => '', ], 'FilterConfig' => [ - 'description' => '', + 'description' => 'The configuration for the filter operator.', 'type' => 'object', 'properties' => [ - 'Experession' => [ - 'description' => '', - 'type' => 'string', - 'required' => false, - 'example' => 'age>20', - ], + 'Experession' => ['description' => 'The filter expression.', 'type' => 'string', 'required' => false, 'example' => 'age>20', 'title' => ''], ], 'required' => false, + 'title' => '', + 'example' => '', ], 'FeatureConfig' => [ - 'description' => '', + 'description' => 'The configuration for the feature operator.', 'type' => 'object', 'properties' => [ - 'Name' => [ - 'description' => '', - 'type' => 'string', - 'required' => false, - 'example' => 'city', - ], - 'Type' => [ - 'description' => '', - 'type' => 'string', - 'required' => false, - 'example' => 'string', - ], - 'Expression' => [ - 'description' => '', - 'type' => 'string', - 'required' => false, - 'example' => 'category=3', - ], + 'Name' => ['description' => 'The feature name.', 'type' => 'string', 'required' => false, 'example' => 'city', 'title' => ''], + 'Type' => ['description' => 'The feature type.', 'type' => 'string', 'required' => false, 'example' => 'string', 'title' => ''], + 'Expression' => ['description' => 'The feature expression.', 'type' => 'string', 'required' => false, 'example' => 'category=3', 'title' => ''], ], 'required' => false, + 'title' => '', + 'example' => '', ], 'JoinConfig' => [ - 'description' => '', + 'description' => 'The configuration for the Join operator.', 'type' => 'object', 'properties' => [ - 'Field' => [ - 'description' => '', - 'type' => 'string', - 'required' => false, - 'example' => 'item_id', - ], - 'RecallManagementTableId' => [ - 'description' => '', - 'type' => 'string', - 'required' => false, - 'example' => '4', - ], + 'Field' => ['description' => '**The field to join on.**', 'type' => 'string', 'required' => false, 'example' => 'item_id', 'title' => ''], + 'RecallManagementTableId' => ['description' => '**The ID of the table to join with.**', 'type' => 'string', 'required' => false, 'example' => '4', 'title' => ''], 'OutputFields' => [ - 'description' => '', + 'description' => '**The fields to include from the joined table.**', 'type' => 'array', + 'items' => ['description' => 'A field to include from the joined table.', 'type' => 'string', 'required' => false, 'example' => 'item_id', 'title' => ''], 'required' => false, 'example' => 'item_id', - 'items' => [ - 'type' => 'string', - ], + 'title' => '', ], ], 'required' => false, + 'title' => '', + 'example' => '', ], ], 'required' => false, + 'title' => '', + 'example' => '', ], 'required' => false, + 'title' => '', + 'example' => '', ], - 'ExtendedConfig' => [ - 'description' => '', - 'type' => 'string', - 'required' => false, - 'example' => '""', - ], - 'ItemConditionArray' => [ - 'description' => '', - 'type' => 'string', - 'required' => false, - 'example' => '[{"option":"<","field":"category","type":"STRING","value":"10"}]', - ], - 'ItemConditionExpression' => [ - 'title' => '物品条件过滤表达式。', - 'type' => 'string', - 'example' => 'age>10', - ], + 'ExtendedConfig' => ['description' => '**This parameter is reserved for future use.**', 'type' => 'string', 'required' => false, 'example' => '""', 'title' => ''], ], 'required' => false, + 'title' => '', + 'example' => '', ], 'required' => false, + 'title' => '', + 'example' => '', ], 'MergeConfig' => [ - 'description' => '', + 'description' => '**Specifies how to merge recall results.**', 'type' => 'object', 'properties' => [ - 'RecallManagementServiceVersionConfigId' => [ - 'description' => '', - 'type' => 'string', - 'required' => false, - 'example' => '1', - ], - 'MergeType' => [ - 'description' => '', - 'type' => 'string', - 'required' => false, - 'example' => 'Weight', - ], + 'RecallManagementServiceVersionConfigId' => ['description' => 'The recall management service version configuration ID.', 'type' => 'string', 'required' => false, 'example' => '1', 'title' => ''], + 'MergeType' => ['description' => 'The merge type. Valid values: `Weight` and `Alternate`.', 'type' => 'string', 'required' => false, 'example' => 'Weight', 'title' => ''], 'FilterRecallManagementTableIds' => [ - 'description' => '', + 'description' => 'The IDs of tables to use for filtering results.', 'type' => 'array', - 'items' => [ - 'description' => '', - 'type' => 'string', - 'required' => false, - 'example' => '3', - ], - 'required' => false, - ], - 'ItemRecallManagementTableId' => [ - 'description' => '', - 'type' => 'string', + 'items' => ['description' => 'The ID of a table used for filtering.', 'type' => 'string', 'required' => false, 'example' => '3', 'title' => ''], 'required' => false, - 'example' => '2', + 'title' => '', + 'example' => '', ], + 'ItemRecallManagementTableId' => ['description' => 'The item recall management table ID.', 'type' => 'string', 'required' => false, 'example' => '2', 'title' => ''], 'ItemTableFields' => [ - 'description' => '', + 'description' => 'The fields to return from the item table.', 'type' => 'array', - 'items' => [ - 'description' => '', - 'type' => 'string', - 'required' => false, - 'example' => 'item_id', - ], - 'required' => false, - ], - 'ExtendedConfig' => [ - 'description' => '', - 'type' => 'string', + 'items' => ['description' => 'A field to return from the item table.', 'type' => 'string', 'required' => false, 'example' => 'item_id', 'title' => ''], 'required' => false, - 'example' => '{"":""}', - ], - 'FilterExpression' => [ - 'description' => '', - 'type' => 'string', - 'required' => false, - 'example' => 'age>10', + 'title' => '', + 'example' => '', ], + 'FilterExpression' => ['description' => 'The filter expression.', 'type' => 'string', 'required' => false, 'example' => 'age>10', 'title' => ''], + 'ExtendedConfig' => ['description' => 'This parameter is reserved for future use.', 'type' => 'string', 'required' => false, 'example' => '{"":""}', 'title' => ''], ], 'required' => false, + 'title' => '', + 'example' => '', ], ], 'required' => false, + 'title' => '', + 'example' => '', ], ], 'required' => false, + 'title' => '', + 'example' => '', ], ], ], 'responses' => [ 200 => [ 'schema' => [ + 'description' => 'The response object.', 'title' => 'Schema of Response', - 'description' => 'Schema of Response', 'type' => 'object', 'properties' => [ - 'RequestId' => [ - 'title' => 'Id of the request', - 'description' => '', - 'type' => 'string', - 'example' => '728C5E01-ABF6-5AA8-B9FC-B3BA05DECC77', - ], - 'RecallManagementServiceVersionId' => [ - 'description' => '', - 'type' => 'string', - 'example' => '1', - ], + 'RequestId' => ['title' => 'Id of the request', 'description' => 'The ID of the request.', 'type' => 'string', 'example' => '728C5E01-ABF6-5AA8-B9FC-B3BA05DECC77'], + 'RecallManagementServiceVersionId' => ['description' => 'The ID of the recall management service version.', 'type' => 'string', 'example' => '1', 'title' => ''], ], + 'example' => '', ], ], ], - 'staticInfo' => [ - 'returnType' => 'synchronous', + 'staticInfo' => ['returnType' => 'synchronous'], + 'title' => 'Create Recall Management Service Version', + 'description' => '## Request'."\n" + ."\n" + .'- Use this API to create a new version of a recall management service.'."\n" + ."\n" + .'- To create a new version from an existing one, specify the source recall management service version ID.'."\n" + ."\n" + .'- You can configure detailed recall rules, such as the recall name, description, priority, and recall type.'."\n" + ."\n" + .'- Configure operators such as filter, trigger, feature extraction, and join.'."\n" + ."\n" + .'- The merge configuration specifies how to merge multiple recall results and supports two merge methods: weight-based and alternating.'."\n" + ."\n" + .'- All configuration items are optional.', + 'changeSet' => [], + 'flowControl' => [ + 'flowControlList' => [], + ], + 'ramActions' => [ + [ + 'operationType' => 'none', + 'ramAction' => [ + 'action' => 'pairec:CreateRecallManagementServiceVersion', + 'authLevel' => 'operate', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'PAIRecService', 'resourceType' => 'All Resource', 'arn' => '*'], + ], + ], + ], ], 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"728C5E01-ABF6-5AA8-B9FC-B3BA05DECC77\\",\\n \\"RecallManagementServiceVersionId\\": \\"1\\"\\n}","type":"json"}]', ], - 'CreateRecallManagementService' => [ - 'summary' => '创建召回管理服务', - 'path' => '/api/v1/recallmanagementservices', - 'methods' => [ - 'post', - ], - 'schemes' => [ - 'https', - ], + 'CreateRecallManagementServiceVersionConfig' => [ + 'summary' => 'Creates a configuration for a specified version of the Recall Manager service, including its recall and merge settings.', + 'path' => '/api/v1/recallmanagementservices/{RecallManagementServiceId}/versions/{RecallManagementServiceVersionId}/configs', + 'methods' => ['post'], + 'schemes' => ['https'], 'security' => [ [ 'AK' => [], ], ], - 'consumes' => [ - 'application/json', - ], - 'produces' => [ - 'application/json', - ], + 'consumes' => ['application/json'], + 'produces' => ['application/json'], 'operationType' => 'write', 'deprecated' => false, 'systemTags' => [ - 'operationType' => 'create', + 'operationType' => 'none', 'riskType' => 'none', 'chargeType' => 'free', - 'abilityTreeNodes' => [ - 'FEATURElearnN0NAWV', - ], + 'abilityTreeNodes' => ['FEATURElearnN0NAWV'], ], 'parameters' => [ [ + 'name' => 'RecallManagementServiceId', + 'in' => 'path', + 'schema' => ['description' => 'The recall management service ID.', 'type' => 'string', 'required' => false, 'example' => '2', 'title' => ''], + ], + [ + 'name' => 'RecallManagementServiceVersionId', + 'in' => 'path', + 'schema' => ['description' => 'The recall management service version ID.', 'type' => 'string', 'required' => false, 'example' => '3', 'title' => ''], + ], + [ 'name' => 'body', 'in' => 'body', 'style' => 'json', 'schema' => [ - 'description' => '', + 'description' => 'request body.', 'type' => 'object', 'properties' => [ - 'InstanceId' => [ - 'description' => '', - 'type' => 'string', - 'required' => false, - 'example' => 'pairec-cn-test123', - ], - 'Name' => [ - 'description' => '', - 'type' => 'string', + 'InstanceId' => ['description' => 'Instance ID.', 'type' => 'string', 'required' => false, 'example' => 'pai-teest-1', 'title' => ''], + 'ConfigType' => ['description' => 'The configuration type for the recall management version, which can be `Recall` for a recall config or `Merge` for a merge config.', 'type' => 'string', 'required' => false, 'example' => 'Recall', 'title' => ''], + 'RecallConfig' => [ + 'description' => 'Recall configuration.', + 'type' => 'object', + 'properties' => [ + 'Name' => ['description' => 'Recall name.', 'type' => 'string', 'required' => false, 'example' => 'etrec', 'title' => ''], + 'Description' => ['description' => 'Recall description.', 'type' => 'string', 'required' => false, 'example' => 'this is etrec recall', 'title' => ''], + 'Priority' => ['description' => 'Priority. The smaller the number, the higher the priority.', 'type' => 'integer', 'format' => 'int64', 'required' => false, 'example' => '2', 'title' => ''], + 'RecallType' => ['description' => 'Recall type.', 'type' => 'string', 'required' => false, 'example' => 'X2I', 'title' => ''], + 'RecallManagementTableId' => ['description' => 'Recall management table ID.', 'type' => 'string', 'required' => false, 'example' => '3', 'title' => ''], + 'UserVectorRecallManagementTableId' => ['description' => 'User vector recall table ID.', 'type' => 'string', 'required' => false, 'example' => '4', 'title' => ''], + 'UserVectorField' => ['description' => 'User vector field.', 'type' => 'string', 'required' => false, 'example' => 'user_embedding', 'title' => ''], + 'ItemVectorRecallManagementTableId' => ['description' => 'The ID of the item vector recall table.', 'type' => 'string', 'required' => false, 'example' => '5', 'title' => ''], + 'ItemVectorField' => ['description' => 'Item vector field.', 'type' => 'string', 'required' => false, 'example' => 'item_embedding', 'title' => ''], + 'ItemConditionArray' => ['description' => 'Item condition, setting array-formatted conditions', 'type' => 'string', 'required' => false, 'example' => '[{"option":"<","field":"category","type":"STRING","value":"10"}]', 'title' => ''], + 'ItemConditionExpression' => ['description' => 'Item condition expression.', 'type' => 'string', 'example' => 'age>20', 'title' => '', 'required' => false], + 'SortFields' => ['description' => 'Sort field.', 'type' => 'string', 'required' => false, 'example' => 'name', 'title' => ''], + 'Operators' => [ + 'description' => 'Operator list.', + 'type' => 'array', + 'items' => [ + 'description' => 'Operator details.', + 'type' => 'object', + 'properties' => [ + 'OperatorType' => ['description' => 'Operator type. Enumeration value: FilterFeatureTriggerFeature', 'type' => 'string', 'required' => false, 'example' => 'Filter', 'title' => ''], + 'TriggerConfig' => [ + 'description' => 'Trigger operator configuration.', + 'type' => 'object', + 'properties' => [ + 'Field' => ['description' => 'The name of the field.', 'type' => 'string', 'required' => false, 'example' => 'user_id', 'title' => ''], + 'IsRandSort' => ['description' => 'Whether to sort randomly.', 'type' => 'boolean', 'required' => false, 'example' => 'false', 'title' => ''], + 'SortField' => ['description' => 'Sort field.', 'type' => 'string', 'required' => false, 'example' => 'create_time', 'title' => ''], + 'FieldQuantityLimit' => ['description' => 'Number of fields limit.', 'type' => 'integer', 'format' => 'int32', 'required' => false, 'example' => '20', 'title' => ''], + ], + 'required' => false, + 'title' => '', + 'example' => '', + ], + 'FilterConfig' => [ + 'description' => 'Filter operator configuration.', + 'type' => 'object', + 'properties' => [ + 'Experession' => ['description' => 'Filter expression.', 'type' => 'string', 'required' => false, 'example' => 'age>20', 'title' => ''], + ], + 'required' => false, + 'title' => '', + 'example' => '', + ], + 'FeatureConfig' => [ + 'description' => '**Feature operator configuration.**', + 'type' => 'object', + 'properties' => [ + 'Name' => ['description' => '**Feature name.**', 'type' => 'string', 'required' => false, 'example' => 'city', 'title' => ''], + 'Type' => ['description' => '**Feature type.**', 'type' => 'string', 'required' => false, 'example' => 'string', 'title' => ''], + 'Expression' => ['description' => '**Feature expression.**', 'type' => 'string', 'required' => false, 'example' => 'category=3', 'title' => ''], + ], + 'required' => false, + 'title' => '', + 'example' => '', + ], + 'JoinConfig' => [ + 'description' => '**Join operator configuration.**', + 'type' => 'object', + 'properties' => [ + 'Field' => ['description' => 'Join field.', 'type' => 'string', 'required' => false, 'example' => 'item_id', 'title' => ''], + 'RecallManagementTableId' => ['description' => 'Join table ID.', 'type' => 'string', 'required' => false, 'example' => '3', 'title' => ''], + 'OutputFields' => [ + 'description' => 'Return field.', + 'type' => 'array', + 'items' => ['description' => 'Returns a list of fields.', 'type' => 'string', 'required' => false, 'example' => 'lang', 'title' => ''], + 'required' => false, + 'title' => '', + 'example' => '', + ], + ], + 'required' => false, + 'title' => '', + 'example' => '', + ], + ], + 'required' => false, + 'title' => '', + 'example' => '', + ], + 'required' => false, + 'title' => '', + 'example' => '', + ], + 'ExtendedConfig' => ['description' => 'Additional configuration for future feature expansion.', 'type' => 'string', 'required' => false, 'example' => '""', 'title' => ''], + ], 'required' => false, - 'example' => 'hot_global_recall', + 'title' => '', + 'example' => '', ], - 'Description' => [ - 'description' => '', - 'type' => 'string', + 'MergeConfig' => [ + 'description' => 'Merge configuration.', + 'type' => 'object', + 'properties' => [ + 'RecallManagementServiceVersionConfigId' => ['description' => 'recall management service version configuration ID.', 'type' => 'string', 'required' => false, 'example' => '1', 'title' => ''], + 'MergeType' => ['description' => 'Merge type. Enumerated values: `Weight` and `Alternate`.', 'type' => 'string', 'required' => false, 'example' => 'Weight', 'title' => ''], + 'FilterRecallManagementTableIds' => [ + 'description' => 'Filter table ID.', + 'type' => 'array', + 'items' => ['description' => 'List of filter table IDs.', 'type' => 'string', 'required' => false, 'example' => '3', 'title' => ''], + 'required' => false, + 'title' => '', + 'example' => '', + ], + 'ItemRecallManagementTableId' => ['description' => 'Item table ID.', 'type' => 'string', 'required' => false, 'example' => '2', 'title' => ''], + 'ItemTableFields' => [ + 'description' => 'Item table output fields.', + 'type' => 'array', + 'items' => ['description' => 'List of output fields for the item table.', 'type' => 'string', 'required' => false, 'example' => 'item_id', 'title' => ''], + 'required' => false, + 'title' => '', + 'example' => '', + ], + 'FilterExpression' => ['description' => 'Filter expression.', 'type' => 'string', 'required' => false, 'example' => 'age>20', 'title' => ''], + 'ExtendedConfig' => ['description' => 'Additional configurations for the merge configuration are provided to facilitate future feature extensions.', 'type' => 'string', 'required' => false, 'example' => '""', 'title' => ''], + ], 'required' => false, - 'example' => 'this is a test recall', + 'title' => '', + 'example' => '', ], ], 'required' => false, + 'title' => '', + 'example' => '', ], ], ], 'responses' => [ 200 => [ 'schema' => [ - 'title' => 'Schema of Response', - 'description' => 'Schema of Response', + 'description' => 'The response data.', + 'title' => 'Schema of Response ', 'type' => 'object', 'properties' => [ - 'RequestId' => [ - 'title' => 'Id of the request', - 'description' => '', - 'type' => 'string', - 'example' => '728C5E01-ABF6-5AA8-B9FC-B3BA05DECC77', - ], - 'RecallManagementServiceId' => [ - 'description' => '', - 'type' => 'string', - 'example' => '1', - ], - 'RecallManagementServiceVersionId' => [ - 'description' => '', - 'type' => 'string', - 'example' => '3', - ], + 'RequestId' => ['title' => 'Id of the request ', 'description' => 'The request ID.', 'type' => 'string', 'example' => 'F8F613A9-DF1C-551A-88E1-397A3981A785'], + 'RecallManagementServiceVersionConfigId' => ['description' => 'The ID of the recall management service version configuration.', 'type' => 'string', 'example' => '1', 'title' => ''], ], + 'example' => '', ], ], ], - 'staticInfo' => [ - 'returnType' => 'synchronous', + 'staticInfo' => ['returnType' => 'synchronous'], + 'title' => 'Create Retrieval Management Service Version Configuration ', + 'description' => '## Request'."\n" + ."\n" + .'- This API creates a configuration for a specific version of the Recall Management Service.'."\n" + ."\n" + .'- The `ConfigType` parameter specifies the configuration type, which can be either recall or merge.'."\n" + ."\n" + .'- Use the `RecallConfig` and `MergeConfig` parameters to provide the recall and merge configurations, respectively.'."\n" + ."\n" + .'- Required parameters must be provided in the specified data formats.'."\n" + ."\n" + .'- Optional parameter values must be consistent with your business logic.', + 'changeSet' => [], + 'flowControl' => [ + 'flowControlList' => [], + ], + 'ramActions' => [ + [ + 'operationType' => 'none', + 'ramAction' => [ + 'action' => 'pairec:CreateRecallManagementServiceVersionConfig', + 'authLevel' => 'operate', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'PAIRecService', 'resourceType' => 'All Resource', 'arn' => '*'], + ], + ], + ], ], - 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"728C5E01-ABF6-5AA8-B9FC-B3BA05DECC77\\",\\n \\"RecallManagementServiceId\\": \\"1\\",\\n \\"RecallManagementServiceVersionId\\": \\"3\\"\\n}","type":"json"}]', + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"F8F613A9-DF1C-551A-88E1-397A3981A785\\",\\n \\"RecallManagementServiceVersionConfigId\\": \\"1\\"\\n}","type":"json"}]', ], - 'CreateRecallManagementConfig' => [ - 'summary' => '创建召回管理初始化配置。', - 'path' => '/api/v1/recallmanagementconfigs', - 'methods' => [ - 'post', - ], - 'schemes' => [ - 'https', - ], + 'CreateRecallManagementTable' => [ + 'path' => '/api/v1/recallmanagementtables', + 'methods' => ['post'], + 'schemes' => ['https'], 'security' => [ [ 'AK' => [], ], ], - 'consumes' => [ - 'application/json', - ], - 'produces' => [ - 'application/json', - ], + 'consumes' => ['application/json'], + 'produces' => ['application/json'], 'operationType' => 'write', 'deprecated' => false, 'systemTags' => [ 'operationType' => 'create', 'riskType' => 'none', 'chargeType' => 'free', - 'abilityTreeNodes' => [ - 'FEATURElearnN0NAWV', - ], + 'abilityTreeNodes' => ['FEATURElearnN0NAWV'], ], 'parameters' => [ [ @@ -4137,141 +3298,175 @@ 'in' => 'body', 'style' => 'json', 'schema' => [ - 'description' => '', + 'description' => 'The request body.', 'type' => 'object', 'properties' => [ - 'InstanceId' => [ - 'description' => '', - 'type' => 'string', - 'required' => false, - 'example' => 'learn-pairec-xxx', - ], - 'UserName' => [ - 'description' => '', - 'type' => 'string', - 'required' => false, - 'example' => 'zhhangsan', - ], - 'Password' => [ - 'description' => '', - 'type' => 'string', - 'required' => false, - 'example' => '12345', - ], - 'NetworkConfigs' => [ - 'description' => '', + 'InstanceId' => ['description' => '**The instance ID.**', 'type' => 'string', 'required' => true, 'example' => 'pairec-cn-test123', 'title' => ''], + 'Name' => ['description' => '**The name of the table.**', 'type' => 'string', 'required' => false, 'example' => 'table-123', 'title' => ''], + 'Description' => ['description' => '**The description of the table.**', 'type' => 'string', 'required' => false, 'example' => 'this is a test table', 'title' => ''], + 'Type' => ['description' => '**The table type.**', 'type' => 'string', 'required' => false, 'example' => 'Recall', 'title' => ''], + 'RecallType' => ['description' => 'The recall type of the table.', 'type' => 'string', 'required' => false, 'example' => 'X2I', 'title' => ''], + 'DataSource' => ['description' => 'The data source.', 'type' => 'string', 'required' => false, 'example' => 'MaxcomputeAndApiApi', 'title' => ''], + 'MaxcomputeProjectName' => ['description' => 'The MaxCompute project.', 'type' => 'string', 'required' => false, 'example' => 'test', 'title' => ''], + 'MaxcomputeTableName' => ['description' => 'The name of the table in MaxCompute.', 'type' => 'string', 'required' => false, 'example' => 'table-1', 'title' => ''], + 'Fields' => [ + 'description' => 'The list of fields.', 'type' => 'array', 'items' => [ - 'description' => '', + 'description' => 'The details of a field.', 'type' => 'object', 'properties' => [ - 'VpcId' => [ - 'description' => 'Vpc id'."\n", - 'type' => 'string', - 'required' => false, - 'example' => 'vpc-xxx', - ], - 'VSwitchIds' => [ - 'description' => '', - 'type' => 'object', + 'Name' => ['description' => 'The name of the field.', 'type' => 'string', 'required' => false, 'example' => 'age', 'title' => ''], + 'Type' => ['description' => 'The data type of the field.', 'type' => 'string', 'required' => false, 'example' => 'STRING(全大写)', 'title' => ''], + 'Attributes' => [ + 'description' => 'The attributes of the field. Valid values:'."\n" + ."\n" + .'- `Primary`: The primary key field.'."\n" + ."\n" + .'- `Item`: The item field.'."\n" + ."\n" + .'- `Score`: The recall score field.'."\n" + ."\n" + .'- `Vector`: The vector field.'."\n" + ."\n" + .'- `Index`: The index field.', + 'type' => 'array', + 'items' => ['description' => 'An attribute of the field.', 'type' => 'string', 'required' => false, 'example' => 'Primary', 'title' => ''], 'required' => false, - 'additionalProperties' => [ - 'type' => 'string', - 'description' => '', - 'example' => 'vsw-xxx', - ], + 'title' => '', + 'example' => '', ], + 'VectorDimension' => ['description' => 'The vector dimension.', 'type' => 'integer', 'format' => 'int32', 'required' => false, 'example' => '32', 'title' => ''], + 'VectorMetricType' => ['description' => 'The vector metric type.', 'type' => 'string', 'required' => false, 'example' => 'L2', 'title' => ''], ], 'required' => false, + 'title' => '', + 'example' => '', ], 'required' => false, + 'title' => '', + 'example' => '', ], + 'Config' => ['description' => 'Additional settings for the table.', 'type' => 'string', 'required' => false, 'example' => '{"":""}', 'title' => ''], + 'EnableRowCountFluctuationThreshold' => ['description' => 'Whether to enable the row count fluctuation threshold.', 'type' => 'boolean', 'required' => false, 'example' => 'true', 'title' => ''], + 'MinRowCountFluctuationThreshold' => ['description' => 'The minimum row count fluctuation threshold.', 'type' => 'integer', 'format' => 'int64', 'required' => false, 'example' => '10', 'title' => ''], + 'MaxRowCountFluctuationThreshold' => ['description' => 'The maximum row count fluctuation threshold.', 'type' => 'integer', 'format' => 'int64', 'required' => false, 'example' => '100', 'title' => ''], + 'EnableDataSizeFluctuationThreshold' => ['description' => 'Whether to enable the data size fluctuation threshold.', 'type' => 'boolean', 'required' => false, 'example' => 'true', 'title' => ''], + 'MinDataSizeFluctuationThreshold' => ['description' => 'The minimum data size fluctuation threshold.', 'type' => 'integer', 'format' => 'int64', 'required' => false, 'example' => '10', 'title' => ''], + 'MaxDataSizeFluctuationThreshold' => ['description' => 'The maximum data size fluctuation threshold.', 'type' => 'integer', 'format' => 'int64', 'required' => false, 'example' => '100', 'title' => ''], + 'MaxcomputeSchema' => ['description' => '**The schema in MaxCompute.**', 'type' => 'string', 'required' => false, 'example' => 'default', 'title' => ''], ], 'required' => false, + 'title' => '', + 'example' => '', ], ], ], 'responses' => [ 200 => [ 'schema' => [ - 'title' => 'Schema of Response', - 'description' => 'Schema of Response', + 'description' => 'Response schema', + 'title' => 'Schema of Response ', 'type' => 'object', 'properties' => [ - 'RequestId' => [ - 'title' => 'Id of the request', - 'description' => '', - 'type' => 'string', - 'example' => '728C5E01-ABF6-5AA8-B9FC-B3BA05DECC77', - ], + 'RequestId' => ['title' => 'Id of the request ', 'description' => '**The ID of the request.**', 'type' => 'string', 'example' => '728C5E01-ABF6-5AA8-B9FC-B3BA05DECC77'], + 'RecallManagementTableId' => ['description' => '**The ID of the recall management table.**', 'type' => 'string', 'example' => '3', 'title' => ''], ], + 'example' => '', ], ], ], - 'staticInfo' => [ - 'returnType' => 'synchronous', + 'staticInfo' => ['returnType' => 'synchronous'], + 'title' => 'Create Retrieval Management Table ', + 'summary' => 'Creates a recall management table that supports multiple data sources and configuration options.', + 'description' => '## Request'."\n" + ."\n" + .'- The **InstanceId**, **Name**, **Description**, **Type**, and **DataSource** parameters are required.'."\n" + ."\n" + .'- The **RecallType** parameter is optional. If provided, it must be a valid enum value.'."\n" + ."\n" + .'- For each field in the **Fields** parameter, you must define its name, type, and attributes. You must mark at least one field as Primary.'."\n" + ."\n" + .'- If you use MaxCompute as the data source, you must specify the **MaxcomputeProjectName** and **MaxcomputeTableName** parameters. The **MaxcomputeSchema** parameter is optional.'."\n" + ."\n" + .'- For vector fields, the values of the **VectorDimension** and **VectorMetricType** parameters must match the actual data.'."\n" + ."\n" + .'- Use the **Config** field to provide additional configuration as a JSON string.'."\n" + ."\n" + .'- Use fluctuation threshold parameters, such as **EnableRowCountFluctuationThreshold**, to monitor changes in row count or table size. Enable these parameters and set appropriate thresholds as needed.', + 'changeSet' => [], + 'flowControl' => [ + 'flowControlList' => [], + ], + 'ramActions' => [ + [ + 'operationType' => 'create', + 'ramAction' => [ + 'action' => 'pairec:CreateRecallManagementTable', + 'authLevel' => 'operate', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'PAIRecService', 'resourceType' => 'All Resource', 'arn' => '*'], + ], + ], + ], ], - 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"728C5E01-ABF6-5AA8-B9FC-B3BA05DECC77\\"\\n}","type":"json"}]', + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"728C5E01-ABF6-5AA8-B9FC-B3BA05DECC77\\",\\n \\"RecallManagementTableId\\": \\"3\\"\\n}","type":"json"}]', ], - 'ListInstanceResourceSchemas' => [ - 'summary' => '获取数据资源下的Schema列表。', - 'path' => '/api/v1/instances/{InstanceId}/resources/{ResourceId}/schemas', - 'methods' => [ - 'get', - ], - 'schemes' => [ - 'https', - ], + 'CreateScene' => [ + 'summary' => 'Creates a scene for metric and experiment analysis.', + 'path' => '/api/v1/scenes', + 'methods' => ['post'], + 'schemes' => ['http', 'https'], 'security' => [ [ 'AK' => [], ], ], - 'consumes' => [ - 'application/json', - ], - 'produces' => [ - 'application/json', - ], - 'operationType' => 'read', + 'consumes' => ['application/json'], + 'produces' => ['application/json'], + 'operationType' => 'write', 'deprecated' => false, 'systemTags' => [ - 'operationType' => 'none', + 'operationType' => 'create', 'riskType' => 'none', 'chargeType' => 'free', - 'abilityTreeNodes' => [ - 'FEATURElearnN0NAWV', - ], + 'abilityTreeNodes' => ['FEATURElearnN0NAWV'], ], 'parameters' => [ [ - 'name' => 'InstanceId', - 'in' => 'path', - 'schema' => [ - 'description' => '', - 'type' => 'string', - 'required' => false, - 'example' => 'featureStore-cn-test1', - ], - ], - [ - 'name' => 'ResourceId', - 'in' => 'path', - 'schema' => [ - 'description' => '', - 'type' => 'string', - 'required' => false, - 'example' => '3', - ], - ], - [ - 'name' => 'SchemaName', - 'in' => 'query', + 'name' => 'body', + 'in' => 'body', + 'style' => 'json', 'schema' => [ - 'description' => '', - 'type' => 'string', + 'description' => 'The request body.', + 'type' => 'object', + 'properties' => [ + 'Name' => ['description' => 'The scene name.', 'type' => 'string', 'example' => 'scene1', 'title' => '', 'required' => false], + 'Description' => ['description' => 'The scene description.', 'type' => 'string', 'example' => 'This is a test.', 'title' => '', 'required' => false], + 'InstanceId' => ['description' => 'The instance ID. You can call the ListInstances operation to obtain the instance ID.', 'type' => 'string', 'required' => false, 'example' => 'pairec-cn-abcdefg1234', 'title' => ''], + 'Flows' => [ + 'title' => '', + 'description' => 'The flows.', + 'type' => 'array', + 'items' => [ + 'description' => 'The details of a flow.', + 'type' => 'object', + 'properties' => [ + 'FlowName' => ['description' => 'The flow name.', 'type' => 'string', 'example' => '流量1', 'title' => '', 'required' => false], + 'FlowCode' => ['description' => 'The flow code.', 'type' => 'string', 'example' => 'liuliang1', 'title' => '', 'required' => false], + ], + 'required' => false, + 'title' => '', + 'example' => '', + ], + 'required' => false, + 'example' => '', + ], + ], 'required' => false, - 'example' => 'default', + 'title' => '', + 'example' => '', ], ], ], @@ -4279,104 +3474,78 @@ 200 => [ 'schema' => [ 'title' => 'Schema of Response', - 'description' => 'Schema of Response', + 'description' => 'The response body.', 'type' => 'object', 'properties' => [ - 'RequestId' => [ - 'title' => 'Id of the request', - 'description' => '', - 'type' => 'string', - 'example' => '728C5E01-ABF6-5AA8-B9FC-B3BA05DECC77', - ], - 'TotalCount' => [ - 'description' => '', - 'type' => 'integer', - 'format' => 'int64', - 'example' => '10', - ], - 'Schemas' => [ - 'description' => '', - 'type' => 'array', - 'items' => [ - 'type' => 'object', - 'properties' => [ - 'SchemaName' => [ - 'description' => '', - 'type' => 'string', - 'example' => 'default', - ], - ], - ], - ], + 'RequestId' => ['title' => 'Id of the request', 'description' => 'The request ID.', 'type' => 'string', 'example' => 'FCF741D8-9C30-578E-807F-B935487DB34A'], + 'SceneId' => ['description' => 'The scene ID.', 'type' => 'string', 'example' => '3', 'title' => ''], ], + 'example' => '', ], ], ], - 'staticInfo' => [ - 'returnType' => 'synchronous', + 'staticInfo' => ['returnType' => 'synchronous'], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"FCF741D8-9C30-578E-807F-B935487DB34A\\",\\n \\"SceneId\\": \\"3\\"\\n}","type":"json"}]', + 'title' => 'Create Scene', + 'changeSet' => [], + 'flowControl' => [ + 'flowControlList' => [], + ], + 'ramActions' => [ + [ + 'operationType' => 'create', + 'ramAction' => [ + 'action' => 'pairec:CreateScene', + 'authLevel' => 'operate', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'PAIRecService', 'resourceType' => 'All Resource', 'arn' => '*'], + ], + ], + ], ], - 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"728C5E01-ABF6-5AA8-B9FC-B3BA05DECC77\\",\\n \\"TotalCount\\": 10,\\n \\"Schemas\\": [\\n {\\n \\"SchemaName\\": \\"default\\"\\n }\\n ]\\n}","type":"json"}]', ], - 'ListInstanceResourceTables' => [ - 'summary' => '获取数据源下数据表的列表。', - 'path' => '/api/v1/instances/{InstanceId}/resources/{ResourceId}/tables', - 'methods' => [ - 'get', - ], - 'schemes' => [ - 'http', - 'https', - ], + 'CreateSubCrowd' => [ + 'summary' => 'Creates a sub-crowd for a specified crowd.', + 'path' => '/api/v1/crowds/{CrowdId}/subcrowds', + 'methods' => ['post'], + 'schemes' => ['http', 'https'], 'security' => [ [ 'AK' => [], ], ], - 'consumes' => [ - 'application/json', - ], - 'produces' => [ - 'application/json', - ], - 'operationType' => 'read', + 'consumes' => ['application/json'], + 'produces' => ['application/json'], + 'operationType' => 'write', 'deprecated' => false, 'systemTags' => [ - 'operationType' => 'list', + 'operationType' => 'create', 'riskType' => 'none', 'chargeType' => 'free', - 'abilityTreeNodes' => [ - 'FEATURElearnN0NAWV', - ], + 'abilityTreeNodes' => ['FEATURElearnN0NAWV'], ], 'parameters' => [ [ - 'name' => 'InstanceId', - 'in' => 'path', - 'schema' => [ - 'description' => '', - 'type' => 'string', - 'required' => false, - 'example' => 'pairec-cn-xxx', - ], - ], - [ - 'name' => 'ResourceId', + 'name' => 'CrowdId', 'in' => 'path', - 'schema' => [ - 'description' => '', - 'type' => 'string', - 'required' => false, - 'example' => 'reso-*********', - ], + 'schema' => ['description' => 'The crowd ID. You can obtain the crowd ID by calling the ListCrowds API.', 'type' => 'string', 'required' => true, 'example' => '3', 'title' => ''], ], [ - 'name' => 'MaxcomputeSchema', - 'in' => 'query', + 'name' => 'body', + 'in' => 'body', + 'style' => 'json', 'schema' => [ - 'description' => '', - 'type' => 'string', + 'title' => '', + 'description' => 'The request body.', + 'type' => 'object', + 'properties' => [ + 'Source' => ['description' => 'The source of users for the sub-crowd. Valid values: ● ManualInput: manual input ● UploadFile: file upload', 'type' => 'string', 'required' => true, 'example' => 'ManualInput', 'title' => ''], + 'Users' => ['description' => 'A comma-separated list of users in the sub-crowd.', 'type' => 'string', 'required' => true, 'example' => 'user1,user2,user3', 'title' => ''], + 'InstanceId' => ['description' => 'The instance ID. You can obtain the instance ID by calling the ListInstances API.', 'type' => 'string', 'required' => true, 'example' => 'pairec-test1', 'title' => ''], + ], 'required' => false, - 'example' => 'jackal', + 'example' => '', ], ], ], @@ -4384,74 +3553,56 @@ 200 => [ 'schema' => [ 'title' => 'Schema of Response', - 'description' => 'Schema of Response', + 'description' => 'The response object.', 'type' => 'object', 'properties' => [ - 'RequestId' => [ - 'title' => 'Id of the request', - 'description' => 'Id of the request', - 'type' => 'string', - 'example' => '01D22D08-BA20-5F35-8302-99115F288220', - ], - 'TotalCount' => [ - 'description' => '', - 'type' => 'string', - 'example' => '30', - ], - 'Tables' => [ - 'description' => '', - 'type' => 'array', - 'items' => [ - 'description' => '', - 'type' => 'object', - 'properties' => [ - 'TableName' => [ - 'description' => '', - 'type' => 'string', - 'example' => 'table-1', - ], - ], - ], - ], + 'RequestId' => ['title' => 'Id of the request', 'description' => 'The request ID.', 'type' => 'string', 'example' => '9763624B-5FBB-5E3A-9193-B1ADB554CEAE'], + 'SubCrowdId' => ['description' => 'The sub-crowd ID.', 'type' => 'string', 'example' => '3', 'title' => ''], ], + 'example' => '', ], ], ], - 'staticInfo' => [ - 'returnType' => 'synchronous', + 'staticInfo' => ['returnType' => 'synchronous'], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"9763624B-5FBB-5E3A-9193-B1ADB554CEAE\\",\\n \\"SubCrowdId\\": \\"3\\"\\n}","type":"json"}]', + 'title' => 'Create Sub-audience', + 'changeSet' => [], + 'flowControl' => [ + 'flowControlList' => [], + ], + 'ramActions' => [ + [ + 'operationType' => 'create', + 'ramAction' => [ + 'action' => 'pairec:CreateSubCrowd', + 'authLevel' => 'operate', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'PAIRecService', 'resourceType' => 'All Resource', 'arn' => '*'], + ], + ], + ], ], - 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"01D22D08-BA20-5F35-8302-99115F288220\\",\\n \\"TotalCount\\": \\"30\\",\\n \\"Tables\\": [\\n {\\n \\"TableName\\": \\"table-1\\"\\n }\\n ]\\n}","type":"json"}]', ], - 'CheckInstanceResources' => [ - 'summary' => '检测实例下配置的资源的连接状态。', - 'path' => '/api/v1/instances/{InstanceId}/action/checkresources', - 'methods' => [ - 'post', - ], - 'schemes' => [ - 'http', - 'https', - ], + 'CreateTableMeta' => [ + 'summary' => 'Creates a data table.', + 'path' => '/api/v1/tablemetas', + 'methods' => ['post'], + 'schemes' => ['http', 'https'], 'security' => [ [ 'AK' => [], ], ], - 'consumes' => [ - 'application/json', - ], - 'produces' => [ - 'application/json', - ], - 'operationType' => 'read', + 'consumes' => ['application/json'], + 'produces' => ['application/json'], + 'operationType' => 'write', 'deprecated' => false, 'systemTags' => [ - 'operationType' => 'none', + 'operationType' => 'create', 'riskType' => 'none', 'chargeType' => 'free', - 'abilityTreeNodes' => [ - 'FEATURElearnN0NAWV', - ], + 'abilityTreeNodes' => ['FEATURElearnN0NAWV'], ], 'parameters' => [ [ @@ -4459,36 +3610,54 @@ 'in' => 'body', 'style' => 'json', 'schema' => [ - 'description' => '', + 'description' => 'The request body.', 'type' => 'object', 'properties' => [ - 'Type' => [ - 'description' => '', - 'type' => 'string', + 'Name' => ['description' => 'The name of the data table.', 'type' => 'string', 'required' => true, 'example' => 'table_test', 'title' => ''], + 'ResourceId' => ['description' => 'The resource ID. To get this ID, call the ListInstanceResources operation.', 'type' => 'string', 'required' => true, 'example' => 'reso-2s416t146ffjc3yefx', 'title' => ''], + 'TableName' => ['description' => 'The name of the table in the database.', 'type' => 'string', 'required' => true, 'example' => 'table_mysql', 'title' => ''], + 'Module' => ['description' => 'The module to which the data table belongs.'."\n" + ."\n" + .'- ABTest: The data table for A/B testing.'."\n" + ."\n" + .'- ExperimentTool: The data table for the experiment tool.'."\n" + ."\n" + .'- DataDiagnosis: The data table for data diagnosis.', 'type' => 'string', 'required' => true, 'example' => 'ABTest', 'title' => ''], + 'InstanceId' => ['description' => 'The instance ID. To get this ID, call the [ListInstances](~~2411819~~) operation.', 'type' => 'string', 'required' => true, 'example' => 'pairec-cn-test123', 'title' => ''], + 'Fields' => [ + 'description' => 'The list of fields.', + 'type' => 'array', + 'items' => [ + 'description' => 'Field information.', + 'type' => 'object', + 'properties' => [ + 'Name' => ['description' => 'The name of the field.', 'type' => 'string', 'required' => true, 'example' => 'gender', 'title' => ''], + 'Meaning' => ['description' => 'The business definition of the field.', 'type' => 'string', 'required' => true, 'example' => 'this is gender of people', 'title' => ''], + 'Type' => ['description' => 'The data type of the field.', 'type' => 'string', 'required' => true, 'example' => 'BIGINT', 'title' => ''], + 'IsDimensionField' => ['description' => 'Indicates whether the field is a dimension field.', 'type' => 'boolean', 'required' => true, 'example' => 'false', 'title' => ''], + 'DataType' => [ + 'description' => 'The logical data type of the field.', + 'enumValueTitles' => ['number' => 'Number', 'image' => 'Image', 'text' => 'Text', 'video' => 'Video', 'primary_key' => 'Primary key', 'url' => 'URL'], + 'type' => 'string', + 'required' => false, + 'example' => 'primary_key', + 'title' => '', + ], + 'IsPartitionField' => ['description' => 'Indicates whether the field is a partition field.', 'type' => 'string', 'required' => true, 'example' => 'true', 'title' => ''], + ], + 'required' => false, + 'title' => '', + 'example' => '', + ], 'required' => true, - 'example' => 'OSS', - ], - 'Uri' => [ - 'description' => '', - 'type' => 'string', - 'required' => false, - 'example' => 'bucket-test-123', - ], - 'ResourceId' => [ - 'type' => 'string', + 'title' => '', + 'example' => '', ], + 'Description' => ['description' => 'The description of the data table.', 'type' => 'string', 'required' => true, 'example' => 'this is a test table', 'title' => ''], ], 'required' => false, - ], - ], - [ - 'name' => 'InstanceId', - 'in' => 'path', - 'schema' => [ - 'description' => '', - 'type' => 'string', - 'required' => true, - 'example' => 'pairec-cn-test1', + 'title' => '', + 'example' => '', ], ], ], @@ -4496,123 +3665,274 @@ 200 => [ 'schema' => [ 'title' => 'Schema of Response', - 'description' => 'Schema of Response', + 'description' => 'The response data.', 'type' => 'object', 'properties' => [ - 'RequestId' => [ - 'title' => 'Id of the request', - 'description' => '', - 'type' => 'string', - 'example' => '9763624B-5FBB-5E3A-9193-B1ADB554CEAE', - ], - 'Resources' => [ - 'description' => '', - 'type' => 'array', - 'items' => [ - 'description' => '', - 'type' => 'object', - 'properties' => [ - 'Type' => [ - 'description' => '', - 'type' => 'string', - 'example' => 'OSS', - ], - 'Uri' => [ - 'description' => '', - 'type' => 'string', - 'example' => 'bucket-test-123', - ], - 'Status' => [ - 'description' => '', - 'type' => 'string', - 'example' => 'Success', - ], - ], - ], - ], + 'RequestId' => ['title' => 'Id of the request', 'description' => 'The request ID.', 'type' => 'string', 'example' => '728C5E01-ABF6-5AA8-B9FC-B3BA05DECC77'], + 'TableMetaId' => ['description' => 'The ID of the data table.', 'type' => 'string', 'example' => '2', 'title' => ''], ], + 'example' => '', ], ], ], - 'staticInfo' => [ - 'returnType' => 'synchronous', + 'staticInfo' => ['returnType' => 'synchronous'], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"728C5E01-ABF6-5AA8-B9FC-B3BA05DECC77\\",\\n \\"TableMetaId\\": \\"2\\"\\n}","type":"json"}]', + 'title' => 'Create Data Table', + 'changeSet' => [ + ['createdAt' => '2024-02-22T03:35:42.000Z', 'description' => 'Request parameters changed'], + ], + 'flowControl' => [ + 'flowControlList' => [], + ], + 'ramActions' => [ + [ + 'operationType' => 'create', + 'ramAction' => [ + 'action' => 'pairec:CreateTableMeta', + 'authLevel' => 'operate', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'PAIRecService', 'resourceType' => 'All Resource', 'arn' => '*'], + ], + ], + ], ], - 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"9763624B-5FBB-5E3A-9193-B1ADB554CEAE\\",\\n \\"Resources\\": [\\n {\\n \\"Type\\": \\"OSS\\",\\n \\"Uri\\": \\"bucket-test-123\\",\\n \\"Status\\": \\"Success\\"\\n }\\n ]\\n}","type":"json"}]', ], - 'UpdateInstanceResource' => [ - 'summary' => '更新指定实例下指定资源的信息。', - 'path' => '/api/v1/instances/{InstanceId}/resources/{ResourceId}', - 'methods' => [ - 'put', - ], - 'schemes' => [ - 'http', - 'https', - ], + 'CreateTrafficControlTarget' => [ + 'summary' => 'Creates a new traffic control target and sets its parameters, such as the item condition, event, and value.', + 'path' => '/api/v1/trafficcontroltargets', + 'methods' => ['post'], + 'schemes' => ['http', 'https'], 'security' => [ [ 'AK' => [], ], ], - 'consumes' => [ - 'application/json', - ], - 'produces' => [ - 'application/json', - ], - 'operationType' => 'readAndWrite', + 'consumes' => ['application/json'], + 'produces' => ['application/json'], + 'operationType' => 'write', 'deprecated' => false, 'systemTags' => [ - 'operationType' => 'update', + 'operationType' => 'create', 'riskType' => 'none', 'chargeType' => 'free', - 'abilityTreeNodes' => [ - 'FEATURElearnN0NAWV', - ], + 'abilityTreeCode' => '220592', + 'abilityTreeNodes' => ['FEATURElearnN0NAWV'], ], 'parameters' => [ [ - 'name' => 'InstanceId', - 'in' => 'path', + 'name' => 'body', + 'in' => 'body', + 'style' => 'json', 'schema' => [ - 'description' => '', - 'type' => 'string', - 'required' => true, - 'example' => 'pairec-cn-test1', + 'description' => 'The request body.', + 'type' => 'object', + 'properties' => [ + 'TrafficControlTaskId' => ['description' => 'The traffic control task ID.', 'type' => 'string', 'required' => false, 'example' => '1', 'title' => ''], + 'Name' => ['description' => 'The name of the traffic control target.', 'type' => 'string', 'required' => false, 'example' => 'target-1', 'title' => ''], + 'StartTime' => ['description' => 'The start time of the traffic control target.', 'type' => 'string', 'required' => false, 'example' => '2024-03-25', 'title' => ''], + 'EndTime' => ['description' => 'The end time of the traffic control target.', 'type' => 'string', 'required' => false, 'example' => '2024-04-25', 'title' => ''], + 'ItemConditionType' => ['description' => 'The item condition type.', 'type' => 'string', 'required' => false, 'example' => 'Array', 'title' => ''], + 'ItemConditionArray' => ['description' => 'The item condition in array format.', 'type' => 'string', 'required' => false, 'example' => '[{"field":"status","option":"=","value":"1"}]', 'title' => ''], + 'ItemConditionExpress' => ['description' => 'The item condition in expression format.', 'type' => 'string', 'required' => false, 'example' => 'status=1', 'title' => ''], + 'Event' => ['description' => 'The event for the traffic control target.', 'type' => 'string', 'required' => false, 'example' => 'click', 'title' => ''], + 'Value' => ['description' => 'The value of the traffic control target.', 'type' => 'number', 'format' => 'float', 'required' => false, 'example' => '10', 'title' => ''], + 'StatisPeriod' => ['description' => 'The statistical period.', 'type' => 'string', 'required' => false, 'example' => 'Daily', 'title' => ''], + 'ToleranceValue' => ['description' => 'The tolerance value for the traffic control target.', 'type' => 'integer', 'format' => 'int64', 'required' => false, 'example' => '10', 'title' => ''], + 'RecallName' => ['description' => 'The recall strategy name.', 'type' => 'string', 'required' => false, 'example' => 'recall-1', 'title' => ''], + 'Status' => ['description' => 'The status of the traffic control target.', 'type' => 'string', 'required' => false, 'example' => 'Opened', 'title' => ''], + 'NewProductRegulation' => ['description' => 'Specifies whether to enable new product regulation.', 'type' => 'boolean', 'required' => false, 'example' => 'false', 'title' => ''], + ], + 'required' => false, + 'title' => '', + 'example' => '', ], ], - [ - 'name' => 'ResourceId', - 'in' => 'path', + ], + 'responses' => [ + 200 => [ 'schema' => [ - 'description' => '', - 'type' => 'string', - 'required' => true, - 'example' => 'reso-2s416t***', + 'description' => 'The response data.', + 'title' => 'Schema of Response ', + 'type' => 'object', + 'properties' => [ + 'RequestId' => ['title' => 'Id of the request ', 'description' => 'The request ID.', 'type' => 'string', 'example' => '728C5E01-ABF6-5AA8-B9FC-B3BA05DECC77'], + 'TrafficControlTargetId' => ['description' => 'The traffic control target ID.', 'type' => 'string', 'example' => '1', 'title' => ''], + ], + 'example' => '', ], ], + ], + 'staticInfo' => ['returnType' => 'synchronous'], + 'title' => 'Create Traffic Control Target ', + 'description' => '## Usage notes'."\n" + ."\n" + .'- The `ItemConditionType` parameter supports two formats: array format (Array) and expression format (Expression). Based on the format you select, you must provide either `ItemConditionArray` or `ItemConditionExpress`.'."\n" + ."\n" + .'- The `StatisPeriod` parameter defaults to daily. For hourly statistics, you must set this parameter explicitly.'."\n" + ."\n" + .'- The `ToleranceValue` and `NewProductRegulation` parameters are optional.'."\n" + ."\n" + .'- The `Status` parameter controls whether a new traffic control target takes effect immediately. By default, new targets are inactive.', + 'changeSet' => [], + 'flowControl' => [ + 'flowControlList' => [], + ], + 'ramActions' => [ + [ + 'operationType' => 'create', + 'ramAction' => [ + 'action' => 'pairec:CreateTrafficControlTarget', + 'authLevel' => 'operate', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'PAIRecService', 'resourceType' => 'All Resource', 'arn' => '*'], + ], + ], + ], + ], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"728C5E01-ABF6-5AA8-B9FC-B3BA05DECC77\\",\\n \\"TrafficControlTargetId\\": \\"1\\"\\n}","type":"json"}]', + ], + 'CreateTrafficControlTask' => [ + 'path' => '/api/v1/trafficcontroltasks', + 'methods' => ['post'], + 'schemes' => ['http', 'https'], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'consumes' => ['application/json'], + 'produces' => ['application/json'], + 'operationType' => 'write', + 'deprecated' => false, + 'systemTags' => [ + 'operationType' => 'create', + 'riskType' => 'none', + 'chargeType' => 'free', + 'abilityTreeCode' => '220396', + 'abilityTreeNodes' => ['FEATURElearnN0NAWV'], + ], + 'parameters' => [ [ 'name' => 'body', 'in' => 'body', 'style' => 'json', 'schema' => [ - 'description' => '', + 'description' => 'The request body.', 'type' => 'object', 'properties' => [ - 'Uri' => [ - 'description' => '', - 'type' => 'string', + 'Name' => ['description' => 'The name of the traffic control task.', 'type' => 'string', 'required' => false, 'example' => 'task-1', 'title' => ''], + 'Description' => ['description' => 'The description of the traffic control task.', 'type' => 'string', 'required' => false, 'example' => 'this is a test task', 'title' => ''], + 'SceneId' => ['description' => 'The scene ID. You can get this ID by calling the [ListScenes](~~2402581~~) operation.', 'type' => 'string', 'required' => false, 'example' => '1', 'title' => ''], + 'ExecutionTime' => ['description' => 'The execution time.'."\n" + ."\n" + .'- Permanent: The task runs permanently.'."\n" + ."\n" + .'- TimeRange: The task runs within a specified time range. This option requires you to also specify the StartTime and EndTime parameters.', 'type' => 'string', 'required' => false, 'example' => 'TimeRange', 'title' => ''], + 'StartTime' => ['description' => 'The start time.', 'type' => 'string', 'required' => false, 'example' => '2024-03-25', 'title' => ''], + 'EndTime' => ['description' => 'The end time.', 'type' => 'string', 'required' => false, 'example' => '2024-03-26', 'title' => ''], + 'BehaviorTableMetaId' => ['description' => 'The behavior table ID.', 'type' => 'string', 'required' => false, 'example' => '1', 'title' => ''], + 'UserTableMetaId' => ['description' => 'The user table ID.', 'type' => 'string', 'required' => false, 'example' => '2', 'title' => ''], + 'ItemTableMetaId' => ['description' => 'The item table ID.', 'type' => 'string', 'required' => false, 'example' => '3', 'title' => ''], + 'UserConditionType' => ['description' => 'The condition type for the intervention user group.'."\n" + ."\n" + .'- Array: Specifies the array format.'."\n" + ."\n" + .'- Expression: Specifies the expression format.', 'type' => 'string', 'required' => false, 'example' => 'Array', 'title' => ''], + 'UserConditionArray' => ['description' => 'The intervention user group condition in array format.', 'type' => 'string', 'required' => false, 'example' => '[{\\"field\\":\\"gender\\",\\"option\\":\\"=\\",\\"value\\":\\"male\\"}]', 'title' => ''], + 'UserConditionExpress' => ['description' => 'The intervention user group condition in expression format.', 'type' => 'string', 'required' => false, 'example' => 'age<=30&&(3<=level<=6)&&gender=male', 'title' => ''], + 'StatisBehaviorConditionType' => ['description' => 'The condition type for the statistical behavior.'."\n" + ."\n" + .'- Array: Specifies the array format.'."\n" + ."\n" + .'- Expression: Specifies the expression format.', 'type' => 'string', 'required' => false, 'example' => 'Array', 'title' => ''], + 'StatisBehaviorConditionArray' => ['description' => 'The statistical behavior condition in array format.', 'type' => 'string', 'required' => false, 'example' => '[{\\"field\\":\\"click\\",\\"option\\":\\"<=\\",\\"value\\":\\"30\\"}]', 'title' => ''], + 'StatisBehaviorConditionExpress' => ['description' => 'The statistical behavior condition in expression format.', 'type' => 'string', 'required' => false, 'example' => 'click=30', 'title' => ''], + 'ControlType' => ['description' => 'The control type.'."\n" + ."\n" + .'- Percent: Controls traffic by percentage.'."\n" + ."\n" + .'- Quantity: Controls traffic by quantity.', 'type' => 'string', 'required' => false, 'example' => 'Percent', 'title' => ''], + 'ControlGranularity' => ['description' => 'The control granularity. Valid values: Global (applies globally) and Single (applies to a specific item).', 'type' => 'string', 'required' => false, 'example' => 'Global', 'title' => ''], + 'ControlLogic' => ['description' => 'The control logic.'."\n" + ."\n" + .'- Guaranteed: The system strictly enforces the control target.'."\n" + ."\n" + .'- Approach: The system attempts to meet the control target, but enforcement is not strict.', 'type' => 'string', 'required' => false, 'example' => 'Guaranteed', 'title' => ''], + 'ItemConditionType' => ['description' => 'The item condition type.'."\n" + ."\n" + .'- Array: Specifies the array format.'."\n" + ."\n" + .'- Expression: Specifies the expression format.', 'type' => 'string', 'required' => false, 'example' => 'Array', 'title' => ''], + 'ItemConditionExpress' => ['description' => 'The item condition in expression format.', 'type' => 'string', 'required' => false, 'example' => 'status=1', 'title' => ''], + 'TrafficControlTargets' => [ + 'description' => 'A list of traffic control targets.', + 'type' => 'array', + 'items' => [ + 'description' => 'A traffic control target.', + 'type' => 'object', + 'properties' => [ + 'Name' => ['description' => 'The name of the traffic control target.', 'type' => 'string', 'required' => false, 'example' => 'target_1', 'title' => ''], + 'StartTime' => ['description' => 'The start time of the traffic control target.', 'type' => 'string', 'required' => false, 'example' => '2024-03-25', 'title' => ''], + 'EndTime' => ['description' => 'The end time of the traffic control target.', 'type' => 'string', 'required' => false, 'example' => '2024-04-25', 'title' => ''], + 'ItemConditionType' => ['description' => 'The condition type for item control.'."\n" + ."\n" + .'- Array: Specifies the array format.'."\n" + ."\n" + .'- Expression: Specifies the expression format.', 'type' => 'string', 'required' => false, 'example' => 'Array', 'title' => ''], + 'ItemConditionArray' => ['description' => 'The item condition in array format.', 'type' => 'string', 'required' => false, 'example' => '[{\\"field\\":\\"status\\",\\"option\\":\\"=\\",\\"value\\":\\"1\\"}]', 'title' => ''], + 'ItemConditionExpress' => ['description' => 'The item condition in expression format.', 'type' => 'string', 'required' => false, 'example' => 'status=1', 'title' => ''], + 'Event' => ['description' => 'The event for the traffic control target.', 'type' => 'string', 'required' => false, 'example' => 'click', 'title' => ''], + 'Value' => ['description' => 'The value of the traffic control target.', 'type' => 'number', 'format' => 'float', 'required' => false, 'example' => '100', 'title' => ''], + 'StatisPeriod' => ['description' => 'The statistics period.'."\n" + ."\n" + .'- Daily: Statistics are aggregated daily.'."\n" + ."\n" + .'- Hour: Statistics are aggregated hourly.', 'type' => 'string', 'required' => false, 'example' => 'Daily', 'title' => ''], + 'ToleranceValue' => ['description' => 'The tolerance value for the traffic control target.', 'type' => 'integer', 'format' => 'int64', 'required' => false, 'example' => '20', 'title' => ''], + 'RecallName' => ['description' => 'The name of the recall strategy.', 'type' => 'string', 'required' => false, 'example' => 'recall_1', 'title' => ''], + 'Status' => ['description' => 'The status of the traffic control target.'."\n" + ."\n" + .'- Opened: The traffic control target is enabled.'."\n" + ."\n" + .'- Closed: The traffic control target is disabled.', 'type' => 'string', 'required' => false, 'example' => 'Opened', 'title' => ''], + 'NewProductRegulation' => ['description' => 'Specifies whether to enable new product regulation.', 'type' => 'boolean', 'required' => false, 'example' => 'false', 'title' => ''], + ], + 'required' => false, + 'title' => '', + 'example' => '', + ], 'required' => false, - 'example' => 'bucket-test-123', + 'title' => '', + 'example' => '', ], - 'Config' => [ - 'description' => '', - 'type' => 'string', + 'InstanceId' => ['description' => 'The instance ID. You can get this ID by calling the [ListInstances](~~2411819~~) operation.', 'type' => 'string', 'required' => false, 'example' => 'pairec-cn-***test', 'title' => ''], + 'ItemConditionArray' => ['description' => 'The item condition in array format.', 'type' => 'string', 'required' => false, 'example' => '[{\\"field\\":\\"status\\",\\"option\\":\\"=\\",\\"value\\":\\"1\\"}]', 'title' => ''], + 'ServiceId' => ['description' => 'The service ID.', 'type' => 'string', 'required' => true, 'example' => '1', 'title' => ''], + 'PreExperimentIds' => ['description' => 'The experiment IDs for the staging environment. Separate multiple IDs with a comma (,).', 'type' => 'string', 'required' => false, 'example' => '1,2,3', 'title' => ''], + 'ProdExperimentIds' => ['description' => 'The experiment IDs for the production environment. Separate multiple IDs with a comma (,).', 'type' => 'string', 'required' => false, 'example' => '4,5,6', 'title' => ''], + 'FlinkResourceId' => ['description' => 'The Flink data source ID.', 'type' => 'string', 'required' => false, 'example' => 'res-***', 'title' => ''], + 'EffectiveSceneIds' => [ + 'description' => 'A list of effective scene IDs.', + 'type' => 'array', + 'items' => ['description' => 'A scene ID.', 'type' => 'integer', 'format' => 'int32', 'required' => false, 'example' => '3', 'title' => ''], 'required' => false, - 'example' => '{}', + 'title' => '', + 'example' => '', + ], + 'ServiceIds' => [ + 'description' => 'A list of bound engine service IDs.', + 'type' => 'array', + 'items' => ['description' => 'An engine service ID.', 'type' => 'integer', 'format' => 'int32', 'required' => false, 'example' => '3', 'title' => ''], + 'required' => false, + 'title' => '', + 'example' => '', ], ], 'required' => false, + 'title' => '', + 'example' => '', ], ], ], @@ -4620,464 +3940,429 @@ 200 => [ 'schema' => [ 'title' => 'Schema of Response', - 'description' => 'Schema of Response', + 'description' => 'Response schema', 'type' => 'object', 'properties' => [ - 'RequestId' => [ - 'title' => 'Id of the request', - 'description' => '', - 'type' => 'string', - 'example' => '3AAA45F6-0798-5461-9360-81D133823CE7', - ], + 'RequestId' => ['title' => 'Id of the request', 'description' => 'The ID of the request.', 'type' => 'string', 'example' => '42391E6D-822C-58F8-9F7E-D991BB86D6AD'], + 'TrafficControlTaskId' => ['description' => 'The ID of the new traffic control task.', 'type' => 'string', 'example' => '1', 'title' => ''], ], + 'example' => '', ], ], ], - 'staticInfo' => [ - 'returnType' => 'synchronous', + 'staticInfo' => ['returnType' => 'synchronous'], + 'eventInfo' => [ + 'enable' => false, + 'eventNames' => [], + ], + 'title' => 'Create Traffic Control Job ', + 'summary' => 'Creates a new traffic control task with multiple conditions and target configurations.', + 'description' => '## Request'."\n" + ."\n" + .'- Use this API to create a new traffic control task. You can define a traffic control policy for different scenarios, time ranges, and conditions for users or items.'."\n" + ."\n" + .'- The `ExecutionTime` parameter specifies the execution time mode for the task. If you select the `TimeRange` mode, you must provide both the `StartTime` and `EndTime` parameters.'."\n" + ."\n" + .'- The `TrafficControlTargets` parameter is required. For each traffic control target, you must specify its name, time range, event type, and expected value.'."\n" + ."\n" + .'- You can use the `UserConditionType` and `ItemConditionType` parameters to define conditions for the target user group and items.'."\n" + ."\n" + .'- Set the `ControlLogic` parameter to `Guaranteed` for guaranteed control or to `Approach` for approach control.'."\n" + ."\n" + .'- To configure new product regulation, use the `NewProductRegulation` field.', + 'changeSet' => [], + 'flowControl' => [ + 'flowControlList' => [], + ], + 'ramActions' => [ + [ + 'operationType' => 'create', + 'ramAction' => [ + 'action' => 'pairec:CreateTrafficControlTask', + 'authLevel' => 'operate', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'PAIRecService', 'resourceType' => 'All Resource', 'arn' => '*'], + ], + ], + ], ], - 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"3AAA45F6-0798-5461-9360-81D133823CE7\\"\\n}","type":"json"}]', + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"42391E6D-822C-58F8-9F7E-D991BB86D6AD\\",\\n \\"TrafficControlTaskId\\": \\"1\\"\\n}","type":"json"}]', ], - 'GetInstanceResourceTable' => [ - 'summary' => '获取数据源下指定表的详细信息。', - 'path' => '/api/v1/instances/{InstanceId}/resources/{ResourceId}/tables/{TableName}', - 'methods' => [ - 'get', - ], - 'schemes' => [ - 'http', - 'https', - ], + 'DeleteABMetric' => [ + 'summary' => 'Deletes the specified A/B test metric.', + 'path' => '/api/v1/abmetrics/{ABMetricId}', + 'methods' => ['delete'], + 'schemes' => ['http', 'https'], 'security' => [ [ 'AK' => [], ], ], - 'consumes' => [ - 'application/json', - ], - 'produces' => [ - 'application/json', - ], - 'operationType' => 'read', + 'consumes' => ['application/json'], + 'produces' => ['application/json'], + 'operationType' => 'readAndWrite', 'deprecated' => false, 'systemTags' => [ - 'operationType' => 'none', + 'operationType' => 'delete', 'riskType' => 'none', 'chargeType' => 'free', - 'abilityTreeNodes' => [ - 'FEATURElearnN0NAWV', - ], + 'abilityTreeNodes' => ['FEATURElearnN0NAWV'], ], 'parameters' => [ [ - 'name' => 'InstanceId', + 'name' => 'ABMetricId', 'in' => 'path', - 'schema' => [ - 'description' => '', - 'type' => 'string', - 'required' => true, - 'example' => 'pairec-cn-test1', - ], + 'schema' => ['description' => 'The ID of the A/B test metric.', 'type' => 'string', 'required' => true, 'example' => '1', 'title' => ''], ], [ - 'name' => 'ResourceId', - 'in' => 'path', + 'name' => 'InstanceId', + 'in' => 'query', + 'schema' => ['description' => 'The instance ID. You can get this ID by calling the [ListInstances](~~2411819~~) operation.', 'type' => 'string', 'required' => true, 'example' => 'pairec-cn-test1', 'title' => ''], + ], + ], + 'responses' => [ + 200 => [ 'schema' => [ - 'description' => '', - 'type' => 'string', - 'required' => true, - 'example' => 'reso-2s416t***', + 'title' => 'Schema of Response', + 'description' => 'The response body.', + 'type' => 'object', + 'properties' => [ + 'RequestId' => ['title' => 'Id of the request', 'description' => 'The request ID.', 'type' => 'string', 'example' => '728C5E01-ABF6-5AA8-B9FC-B3BA05DECC77'], + ], + 'example' => '', ], ], + ], + 'staticInfo' => ['returnType' => 'synchronous'], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"728C5E01-ABF6-5AA8-B9FC-B3BA05DECC77\\"\\n}","type":"json"}]', + 'title' => 'Delete AB Metric', + 'changeSet' => [ + ['createdAt' => '2024-02-22T03:35:41.000Z', 'description' => 'Request parameters changed'], + ], + 'flowControl' => [ + 'flowControlList' => [], + ], + 'ramActions' => [ + [ + 'operationType' => 'delete', + 'ramAction' => [ + 'action' => 'pairec:DeleteABMetric', + 'authLevel' => 'operate', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'PAIRecService', 'resourceType' => 'All Resource', 'arn' => '*'], + ], + ], + ], + ], + ], + 'DeleteABMetricGroup' => [ + 'summary' => 'Deletes an A/B test metric group.', + 'path' => '/api/v1/abmetricgroups/{ABMetricGroupId}', + 'methods' => ['delete'], + 'schemes' => ['http', 'https'], + 'security' => [ [ - 'name' => 'TableName', + 'AK' => [], + ], + ], + 'consumes' => ['application/json'], + 'produces' => ['application/json'], + 'operationType' => 'write', + 'deprecated' => false, + 'systemTags' => [ + 'operationType' => 'delete', + 'riskType' => 'none', + 'chargeType' => 'free', + 'abilityTreeNodes' => ['FEATURElearnN0NAWV'], + ], + 'parameters' => [ + [ + 'name' => 'ABMetricGroupId', 'in' => 'path', - 'schema' => [ - 'description' => '', - 'type' => 'string', - 'required' => true, - 'example' => 'test_table', - ], + 'schema' => ['description' => 'The ID of the A/B test metric group.', 'type' => 'string', 'required' => true, 'example' => '1', 'title' => ''], + ], + [ + 'name' => 'InstanceId', + 'in' => 'query', + 'schema' => ['description' => 'The ID of the instance. You can obtain this value by calling the [ListInstances](~~2411819~~) operation.', 'type' => 'string', 'required' => true, 'example' => 'pairec-cn-test1', 'title' => ''], ], ], 'responses' => [ 200 => [ 'schema' => [ 'title' => 'Schema of Response', - 'description' => 'Schema of Response', + 'description' => 'The response object.', 'type' => 'object', 'properties' => [ - 'RequestId' => [ - 'title' => 'Id of the request', - 'description' => '', - 'type' => 'string', - 'example' => '74D958EF-3598-56FA-8296-FF1575CE43DF', - ], - 'TableName' => [ - 'description' => '', - 'type' => 'string', - 'example' => 'test_table', - ], - 'Fields' => [ - 'description' => '', - 'type' => 'array', - 'items' => [ - 'description' => '', - 'type' => 'object', - 'properties' => [ - 'Name' => [ - 'description' => '', - 'type' => 'string', - 'example' => 'age', - ], - 'Type' => [ - 'description' => '', - 'type' => 'string', - 'example' => 'BIGINT', - ], - 'Meaning' => [ - 'description' => '', - 'type' => 'string', - 'example' => '""', - ], - 'IsDimensionField' => [ - 'description' => '', - 'type' => 'boolean', - 'example' => 'false', - ], - 'IsPartitionField' => [ - 'type' => 'boolean', - ], - ], - ], - ], + 'RequestId' => ['title' => 'Id of the request', 'description' => 'The request ID.', 'type' => 'string', 'example' => 'BDB621CB-A81E-5D39-8793-39A365CBCC74'], ], + 'example' => '', ], ], ], - 'staticInfo' => [ - 'returnType' => 'synchronous', + 'staticInfo' => ['returnType' => 'synchronous'], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"BDB621CB-A81E-5D39-8793-39A365CBCC74\\"\\n}","type":"json"}]', + 'title' => 'Delete a metric group', + 'changeSet' => [ + ['createdAt' => '2024-02-22T03:35:41.000Z', 'description' => 'Request parameters changed'], + ], + 'flowControl' => [ + 'flowControlList' => [], + ], + 'ramActions' => [ + [ + 'operationType' => 'delete', + 'ramAction' => [ + 'action' => 'pairec:DeleteABMetricGroup', + 'authLevel' => 'operate', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'PAIRecService', 'resourceType' => 'All Resource', 'arn' => '*'], + ], + ], + ], ], - 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"74D958EF-3598-56FA-8296-FF1575CE43DF\\",\\n \\"TableName\\": \\"test_table\\",\\n \\"Fields\\": [\\n {\\n \\"Name\\": \\"age\\",\\n \\"Type\\": \\"BIGINT\\",\\n \\"Meaning\\": \\"\\\\\\"\\\\\\"\\",\\n \\"IsDimensionField\\": false,\\n \\"IsPartitionField\\": true\\n }\\n ]\\n}","type":"json"}]', ], - 'ListInstanceResources' => [ - 'summary' => '获取实例下配置的资源列表。', - 'path' => '/api/v1/instances/{InstanceId}/resources', - 'methods' => [ - 'get', - ], - 'schemes' => [ - 'http', - 'https', - ], + 'DeleteCrowd' => [ + 'summary' => 'Delete the specified audience.', + 'path' => '/api/v1/crowds/{CrowdId}', + 'methods' => ['delete'], + 'schemes' => ['http', 'https'], 'security' => [ [ 'AK' => [], ], ], - 'consumes' => [ - 'application/json', - ], - 'produces' => [ - 'application/json', - ], - 'operationType' => 'read', + 'consumes' => ['application/json'], + 'produces' => ['application/json'], + 'operationType' => 'write', 'deprecated' => false, 'systemTags' => [ - 'operationType' => 'list', + 'operationType' => 'delete', 'riskType' => 'none', 'chargeType' => 'free', - 'abilityTreeNodes' => [ - 'FEATURElearnN0NAWV', - ], + 'abilityTreeNodes' => ['FEATURElearnN0NAWV'], ], 'parameters' => [ [ - 'name' => 'InstanceId', + 'name' => 'CrowdId', 'in' => 'path', - 'schema' => [ - 'description' => '', - 'type' => 'string', - 'required' => true, - 'example' => 'pairec-cn-test1', - ], + 'schema' => ['title' => '', 'description' => 'Audience ID, which can be obtained by calling the ListCrowds API.', 'type' => 'string', 'required' => true, 'example' => '3'], ], [ - 'name' => 'Category', + 'name' => 'InstanceId', 'in' => 'query', + 'schema' => ['title' => '', 'description' => 'Instance ID, which can be obtained by calling the ListInstances API.', 'type' => 'string', 'required' => true, 'example' => 'pairec-cn-abcdefg1234'], + ], + ], + 'responses' => [ + 200 => [ 'schema' => [ - 'description' => '', - 'type' => 'string', - 'required' => false, - 'example' => 'DataManagement', + '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' => 'A04CB8C0-E74A-5E83-BC61-64D153574EC7'], + ], + 'example' => '', ], ], - [ - 'name' => 'Group', - 'in' => 'query', - 'schema' => [ - 'description' => '', - 'type' => 'string', - 'required' => false, - 'example' => 'storage', + ], + 'staticInfo' => ['returnType' => 'synchronous'], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"A04CB8C0-E74A-5E83-BC61-64D153574EC7\\"\\n}","type":"json"}]', + 'title' => 'Delete Audience', + 'changeSet' => [], + 'flowControl' => [ + 'flowControlList' => [], + ], + 'ramActions' => [ + [ + 'operationType' => 'delete', + 'ramAction' => [ + 'action' => 'pairec:DeleteCrowd', + 'authLevel' => 'operate', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'PAIRecService', 'resourceType' => 'All Resource', 'arn' => '*'], + ], ], ], + ], + ], + 'DeleteDataDiagnosis' => [ + 'path' => '/api/v1/datadiagnoses/{DataDiagnosisId}', + 'methods' => ['delete'], + 'schemes' => ['http', 'https'], + 'security' => [ [ - 'name' => 'Type', + 'AK' => [], + ], + ], + 'consumes' => ['application/json'], + 'produces' => ['application/json'], + 'operationType' => 'readAndWrite', + 'deprecated' => false, + 'systemTags' => [ + 'operationType' => 'delete', + 'riskType' => 'none', + 'chargeType' => 'free', + 'abilityTreeNodes' => ['FEATURElearnN0NAWV'], + ], + 'parameters' => [ + [ + 'name' => 'DataDiagnosisId', + 'in' => 'path', + 'schema' => ['description' => 'The ID of the data diagnosis.', 'type' => 'string', 'required' => true, 'example' => '3', 'title' => ''], + ], + [ + 'name' => 'InstanceId', 'in' => 'query', - 'schema' => [ - 'description' => '', - 'type' => 'string', - 'required' => false, - 'example' => 'OSS', - ], + 'schema' => ['description' => 'The ID of the instance.', 'type' => 'string', 'required' => true, 'example' => 'learn-pairec-xxx', 'title' => ''], ], ], 'responses' => [ 200 => [ 'schema' => [ + 'description' => 'The response body.', 'title' => 'Schema of Response', - 'description' => 'Schema of Response', 'type' => 'object', 'properties' => [ - 'RequestId' => [ - 'title' => 'Id of the request', - 'description' => '', - 'type' => 'string', - 'example' => '9763624B-5FBB-5E3A-9193-B1ADB554CEAE', - ], - 'TotalCount' => [ - 'description' => '', - 'type' => 'integer', - 'format' => 'int64', - 'example' => '10', - ], - 'Resources' => [ - 'description' => '', - 'type' => 'array', - 'items' => [ - 'description' => '', - 'type' => 'object', - 'properties' => [ - 'ResourceId' => [ - 'description' => '', - 'type' => 'string', - 'example' => 'reso-2s416t***'."\n", - ], - 'Category' => [ - 'description' => '', - 'type' => 'string', - 'example' => 'DataManagement', - ], - 'Group' => [ - 'description' => '', - 'type' => 'string', - 'example' => 'storage', - ], - 'Type' => [ - 'description' => '', - 'type' => 'string', - 'example' => 'OSS', - ], - 'Uri' => [ - 'description' => '', - 'type' => 'string', - 'example' => 'bucket-test-123', - ], - 'Config' => [ - 'description' => '', - 'type' => 'string', - 'example' => '{}', - ], - 'GmtCreateAt' => [ - 'description' => '', - 'type' => 'string', - 'example' => '2020-10-13 17:34:52'."\n", - ], - 'GmtModifiedAt' => [ - 'description' => '', - 'type' => 'string', - 'example' => '2020-10-13 17:34:52'."\n", - ], - ], - ], - ], + 'RequestId' => ['title' => 'Id of the request', 'description' => 'The ID of the request.', 'type' => 'string', 'example' => '59CE7EC6-F268-5D71-9215-32922CC50D72'], ], + 'example' => '', ], ], ], - 'staticInfo' => [ - 'returnType' => 'synchronous', - ], - 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"9763624B-5FBB-5E3A-9193-B1ADB554CEAE\\",\\n \\"TotalCount\\": 10,\\n \\"Resources\\": [\\n {\\n \\"ResourceId\\": \\"reso-2s416t***\\\\n\\",\\n \\"Category\\": \\"DataManagement\\",\\n \\"Group\\": \\"storage\\",\\n \\"Type\\": \\"OSS\\",\\n \\"Uri\\": \\"bucket-test-123\\",\\n \\"Config\\": \\"{}\\",\\n \\"GmtCreateAt\\": \\"2020-10-13 17:34:52\\\\n\\",\\n \\"GmtModifiedAt\\": \\"2020-10-13 17:34:52\\\\n\\"\\n }\\n ]\\n}","type":"json"}]', - ], - 'GetInstanceResource' => [ - 'summary' => '获取指定实例下指定资源的详细信息。', - 'path' => '/api/v1/instances/{InstanceId}/resources/{ResourceId}', - 'methods' => [ - 'get', + 'staticInfo' => ['returnType' => 'synchronous'], + 'title' => 'Delete data diagnosis', + 'summary' => 'Deletes a data diagnosis configuration using the specified DataDiagnosisId and InstanceId.', + 'description' => '## Description'."\n" + ."\n" + .'Ensure you provide the correct `DataDiagnosisId` and `InstanceId` to avoid accidental deletion.', + 'changeSet' => [], + 'flowControl' => [ + 'flowControlList' => [], ], - 'schemes' => [ - 'http', - 'https', + 'ramActions' => [ + [ + 'operationType' => 'delete', + 'ramAction' => [ + 'action' => 'pairec:DeleteDataDiagnosis', + 'authLevel' => 'operate', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'PAIRecService', 'resourceType' => 'All Resource', 'arn' => '*'], + ], + ], + ], ], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"59CE7EC6-F268-5D71-9215-32922CC50D72\\"\\n}","type":"json"}]', + ], + 'DeleteEngineConfig' => [ + 'summary' => 'Deletes a specified engine configuration.', + 'path' => '/api/v1/engineconfigs/{EngineConfigId}', + 'methods' => ['delete'], + 'schemes' => ['http', 'https'], 'security' => [ [ 'AK' => [], ], ], - 'consumes' => [ - 'application/json', - ], - 'produces' => [ - 'application/json', - ], - 'operationType' => 'read', + 'consumes' => ['application/json'], + 'produces' => ['application/json'], + 'operationType' => 'readAndWrite', 'deprecated' => false, 'systemTags' => [ 'operationType' => 'none', 'riskType' => 'none', 'chargeType' => 'free', - 'abilityTreeNodes' => [ - 'FEATURElearnN0NAWV', - ], + 'abilityTreeCode' => '180292', + 'abilityTreeNodes' => ['FEATURElearnN0NAWV'], ], 'parameters' => [ [ - 'name' => 'InstanceId', + 'name' => 'EngineConfigId', 'in' => 'path', - 'schema' => [ - 'description' => '', - 'type' => 'string', - 'required' => true, - 'example' => 'pairec-cn-test1', - ], + 'schema' => ['description' => 'The engine configuration ID.', 'type' => 'string', 'required' => false, 'example' => '21', 'title' => ''], ], [ - 'name' => 'ResourceId', - 'in' => 'path', - 'schema' => [ - 'description' => '', - 'type' => 'string', - 'required' => true, - 'example' => 'reso-2s416t***', - ], + 'name' => 'InstanceId', + 'in' => 'query', + 'schema' => ['description' => 'The instance ID. For information about how to obtain the instance ID, see [ListInstances](~~2411819~~).', 'type' => 'string', 'required' => false, 'example' => 'pairec-cn-***test1', 'title' => ''], + ], + [ + 'name' => 'DeleteAll', + 'in' => 'query', + 'schema' => ['title' => '', 'description' => 'Specifies whether to delete all engine configurations with the same name.', 'type' => 'boolean', 'required' => false, 'example' => 'False'], ], ], 'responses' => [ 200 => [ 'schema' => [ - 'title' => 'Schema of Response', + 'title' => '', 'description' => 'Schema of Response', 'type' => 'object', 'properties' => [ - 'RequestId' => [ - 'title' => 'Id of the request', - 'description' => '', - 'type' => 'string', - 'example' => 'D75C43DC-3D3A-5CC8-9AAC-8C77306C433B', - ], - 'ResourceId' => [ - 'description' => '', - 'type' => 'string', - 'example' => 'reso-2s416t***', - ], - 'Category' => [ - 'description' => '', - 'type' => 'string', - 'example' => 'DataManagement', - ], - 'Group' => [ - 'description' => '', - 'type' => 'string', - 'example' => 'storage', - ], - 'Type' => [ - 'description' => '', - 'type' => 'string', - 'example' => 'OSS', - ], - 'Uri' => [ - 'description' => '', - 'type' => 'string', - 'example' => 'bucket-test-123', - ], - 'Config' => [ - 'description' => '', - 'type' => 'string', - 'example' => '{}', - ], - 'GmtCreateTime' => [ - 'description' => '', - 'type' => 'string', - 'example' => '2020-10-13 17:34:52', - ], - 'GmtModifiedTime' => [ - 'description' => '', - 'type' => 'string', - 'example' => '2020-10-13 17:34:52', - ], + 'RequestId' => ['title' => '', 'description' => 'The request ID.', 'type' => 'string', 'example' => 'F7AC05FF-EDE7-5C2B-B9AE-33D6DF4178BA'], ], + 'example' => '', ], ], ], - 'staticInfo' => [ - 'returnType' => 'synchronous', + 'staticInfo' => ['returnType' => 'synchronous'], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"F7AC05FF-EDE7-5C2B-B9AE-33D6DF4178BA\\"\\n}","type":"json"}]', + 'title' => 'Delete an engine configuration', + 'description' => 'Deletes a specified engine configuration.', + 'changeSet' => [], + 'flowControl' => [ + 'flowControlList' => [], + ], + 'ramActions' => [ + [ + 'operationType' => 'none', + 'ramAction' => [ + 'action' => 'pairec:DeleteEngineConfig', + 'authLevel' => 'operate', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'PAIRecService', 'resourceType' => 'All Resource', 'arn' => '*'], + ], + ], + ], ], - 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"D75C43DC-3D3A-5CC8-9AAC-8C77306C433B\\",\\n \\"ResourceId\\": \\"reso-2s416t***\\",\\n \\"Category\\": \\"DataManagement\\",\\n \\"Group\\": \\"storage\\",\\n \\"Type\\": \\"OSS\\",\\n \\"Uri\\": \\"bucket-test-123\\",\\n \\"Config\\": \\"{}\\",\\n \\"GmtCreateTime\\": \\"2020-10-13 17:34:52\\",\\n \\"GmtModifiedTime\\": \\"2020-10-13 17:34:52\\"\\n}","type":"json"}]', ], - 'DeleteInstanceResource' => [ - 'summary' => '删除指定实例下的指定配置资源。', - 'path' => '/api/v1/instances/{InstanceId}/resources/{ResourceId}', - 'methods' => [ - 'delete', - ], - 'schemes' => [ - 'http', - 'https', - ], + 'DeleteExperiment' => [ + 'summary' => 'Delete the specified experiment.', + 'path' => '/api/v1/experiments/{ExperimentId}', + 'methods' => ['delete'], + 'schemes' => ['http', 'https'], 'security' => [ [ 'AK' => [], ], ], - 'consumes' => [ - 'application/json', - ], - 'produces' => [ - 'application/json', - ], + 'consumes' => ['application/json'], + 'produces' => ['application/json'], 'operationType' => 'readAndWrite', 'deprecated' => false, 'systemTags' => [ 'operationType' => 'delete', 'riskType' => 'none', 'chargeType' => 'free', - 'abilityTreeNodes' => [ - 'FEATURElearnN0NAWV', - ], + 'abilityTreeNodes' => ['FEATURElearnN0NAWV'], ], 'parameters' => [ [ - 'name' => 'InstanceId', + 'name' => 'ExperimentId', 'in' => 'path', - 'schema' => [ - 'description' => '', - 'type' => 'string', - 'required' => true, - 'example' => 'pairec-cn-test123', - ], + 'schema' => ['title' => '', 'description' => 'Experiment ID, which can be obtained by calling the ListExperiments API.', 'type' => 'string', 'required' => true, 'example' => '3'], ], [ - 'name' => 'ResourceId', - 'in' => 'path', - 'schema' => [ - 'description' => '', - 'type' => 'string', - 'required' => true, - 'example' => 'reso-2s416t***', - ], + 'name' => 'InstanceId', + 'in' => 'query', + 'schema' => ['title' => '', 'description' => 'Instance ID, which can be obtained by calling the ListInstances API.', 'type' => 'string', 'required' => true, 'example' => 'pairec-cn-abcdefg1234'], ], ], 'responses' => [ @@ -5087,98 +4372,63 @@ 'description' => 'Schema of Response', 'type' => 'object', 'properties' => [ - 'RequestId' => [ - 'title' => 'Id of the request', - 'description' => '', - 'type' => 'string', - 'example' => '7D59453C-48AA-5FC5-8848-2D373BD1A17F', - ], + 'RequestId' => ['title' => 'Id of the request', 'description' => 'Id of the request', 'type' => 'string', 'example' => '2A734D87-2212-5C84-B63A-1AC87CA843D4'], ], + 'example' => '', ], ], ], - 'staticInfo' => [ - 'returnType' => 'synchronous', + 'staticInfo' => ['returnType' => 'synchronous'], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"2A734D87-2212-5C84-B63A-1AC87CA843D4\\"\\n}","type":"json"}]', + 'title' => 'Delete Experiment', + 'changeSet' => [], + 'flowControl' => [ + 'flowControlList' => [], + ], + 'ramActions' => [ + [ + 'operationType' => 'delete', + 'ramAction' => [ + 'action' => 'pairec:DeleteExperiment', + 'authLevel' => 'operate', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'PAIRecService', 'resourceType' => 'All Resource', 'arn' => '*'], + ], + ], + ], ], - 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"7D59453C-48AA-5FC5-8848-2D373BD1A17F\\"\\n}","type":"json"}]', ], - 'CreateInstanceResource' => [ - 'summary' => '为指定实例配置创建新的配置资源', - 'path' => '/api/v1/instances/{InstanceId}/resources', - 'methods' => [ - 'post', - ], - 'schemes' => [ - 'http', - 'https', - ], + 'DeleteExperimentGroup' => [ + 'summary' => 'Delete the specified experiment group.', + 'path' => '/api/v1/experimentgroups/{ExperimentGroupId}', + 'methods' => ['delete'], + 'schemes' => ['http', 'https'], 'security' => [ [ 'AK' => [], ], ], - 'consumes' => [ - 'application/json', - ], - 'produces' => [ - 'application/json', - ], - 'operationType' => 'readAndWrite', + 'consumes' => ['application/json'], + 'produces' => ['application/json'], + 'operationType' => 'read', 'deprecated' => false, 'systemTags' => [ - 'operationType' => 'create', + 'operationType' => 'delete', 'riskType' => 'none', 'chargeType' => 'free', - 'abilityTreeNodes' => [ - 'FEATURElearnN0NAWV', - ], + 'abilityTreeNodes' => ['FEATURElearnN0NAWV'], ], 'parameters' => [ [ - 'name' => 'InstanceId', + 'name' => 'ExperimentGroupId', 'in' => 'path', - 'schema' => [ - 'description' => '', - 'type' => 'string', - 'required' => true, - 'example' => 'pairec-cn-test1', - ], + 'schema' => ['title' => '', 'description' => 'Experiment group ID, which can be obtained by calling the ListExperimentGroups API.', 'type' => 'string', 'required' => true, 'example' => '3'], ], [ - 'name' => 'body', - 'in' => 'body', - 'style' => 'json', - 'schema' => [ - 'description' => '', - 'type' => 'object', - 'properties' => [ - 'Category' => [ - 'description' => '', - 'type' => 'string', - 'required' => true, - 'example' => 'DataManagement', - ], - 'Group' => [ - 'description' => '', - 'type' => 'string', - 'required' => true, - 'example' => 'storage', - ], - 'Type' => [ - 'description' => '', - 'type' => 'string', - 'required' => true, - 'example' => 'OSS', - ], - 'Uri' => [ - 'description' => '', - 'type' => 'string', - 'required' => true, - 'example' => 'bucket-test-123', - ], - ], - 'required' => false, - ], + 'name' => 'InstanceId', + 'in' => 'query', + 'schema' => ['title' => '', 'description' => 'Instance ID, which can be obtained by calling the ListInstances API.', 'type' => 'string', 'required' => true, 'example' => 'pairec-cn-abcdefg1234'], ], ], 'responses' => [ @@ -5188,200 +4438,131 @@ 'description' => 'Schema of Response', 'type' => 'object', 'properties' => [ - 'RequestId' => [ - 'title' => 'Id of the request', - 'description' => '', - 'type' => 'string', - 'example' => '6CF1E160-3F36-5E73-A170-C75504F05BBC', - ], - 'ResourceId' => [ - 'description' => '', - 'type' => 'string', - 'example' => 'reso-2s416t***', - ], + 'RequestId' => ['title' => 'Id of the request', 'description' => 'Id of the request', 'type' => 'string', 'example' => 'A009D9BE-C85E-57B2-AE05-BD78BB6EBF50'], ], + 'example' => '', ], ], ], - 'staticInfo' => [ - 'returnType' => 'synchronous', + 'staticInfo' => ['returnType' => 'synchronous'], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"A009D9BE-C85E-57B2-AE05-BD78BB6EBF50\\"\\n}","type":"json"}]', + 'title' => 'Delete experiment group', + 'changeSet' => [], + 'flowControl' => [ + 'flowControlList' => [], + ], + 'ramActions' => [ + [ + 'operationType' => 'delete', + 'ramAction' => [ + 'action' => 'pairec:DeleteExperimentGroup', + 'authLevel' => 'operate', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'PAIRecService', 'resourceType' => 'All Resource', 'arn' => '*'], + ], + ], + ], ], - 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"6CF1E160-3F36-5E73-A170-C75504F05BBC\\",\\n \\"ResourceId\\": \\"reso-2s416t***\\"\\n}","type":"json"}]', ], - 'CreateScene' => [ - 'summary' => '创建场景', - 'path' => '/api/v1/scenes', - 'methods' => [ - 'post', - ], - 'schemes' => [ - 'http', - 'https', - ], + 'DeleteInstanceResource' => [ + 'summary' => 'Deletes a configuration resource from an instance.', + 'path' => '/api/v1/instances/{InstanceId}/resources/{ResourceId}', + 'methods' => ['delete'], + 'schemes' => ['http', 'https'], 'security' => [ [ 'AK' => [], ], ], - 'consumes' => [ - 'application/json', - ], - 'produces' => [ - 'application/json', - ], - 'operationType' => 'write', + 'consumes' => ['application/json'], + 'produces' => ['application/json'], + 'operationType' => 'readAndWrite', 'deprecated' => false, 'systemTags' => [ - 'operationType' => 'create', + 'operationType' => 'delete', 'riskType' => 'none', 'chargeType' => 'free', - 'abilityTreeNodes' => [ - 'FEATURElearnN0NAWV', - ], + 'abilityTreeNodes' => ['FEATURElearnN0NAWV'], ], 'parameters' => [ [ - 'name' => 'body', - 'in' => 'body', - 'style' => 'json', - 'schema' => [ - 'description' => '', - 'type' => 'object', - 'properties' => [ - 'Name' => [ - 'title' => '场景名称。', - 'description' => '', - 'type' => 'string', - 'required' => false, - 'example' => 'scene1', - ], - 'Description' => [ - 'title' => '场景描述。', - 'description' => '', - 'type' => 'string', - 'required' => false, - 'example' => 'This is a test.', - ], - 'InstanceId' => [ - 'title' => '实例ID。', - 'description' => '', - 'type' => 'string', - 'required' => false, - 'example' => 'pairec-cn-abcdefg1234', - ], - 'Flows' => [ - 'title' => '流量列表。', - 'description' => '', - 'type' => 'array', - 'items' => [ - 'description' => '', - 'type' => 'object', - 'properties' => [ - 'FlowName' => [ - 'title' => '流量名称。', - 'description' => '', - 'type' => 'string', - 'required' => false, - 'example' => '流量1', - ], - 'FlowCode' => [ - 'title' => '流量编码。', - 'description' => '', - 'type' => 'string', - 'required' => false, - 'example' => 'liuliang1', - ], - ], - 'required' => false, - ], - 'required' => false, - ], - ], - 'required' => false, - ], + 'name' => 'InstanceId', + 'in' => 'path', + 'schema' => ['description' => 'The instance ID. You can get the instance ID by calling the [ListInstances](~~2411819~~) operation.', 'type' => 'string', 'required' => true, 'example' => 'pairec-cn-test123', 'title' => ''], + ], + [ + 'name' => 'ResourceId', + 'in' => 'path', + 'schema' => ['description' => 'The resource ID.', 'type' => 'string', 'required' => true, 'example' => 'reso-2s416t***', 'title' => ''], ], ], 'responses' => [ 200 => [ 'schema' => [ 'title' => 'Schema of Response', - 'description' => 'Schema of Response', + 'description' => 'The response object.', 'type' => 'object', 'properties' => [ - 'RequestId' => [ - 'title' => 'Id of the request', - 'description' => 'Id of the request', - 'type' => 'string', - 'example' => 'FCF741D8-9C30-578E-807F-B935487DB34A', - ], - 'SceneId' => [ - 'title' => '场景ID。', - 'description' => '', - 'type' => 'string', - 'example' => '3', - ], + 'RequestId' => ['title' => 'Id of the request', 'description' => 'The request ID.', 'type' => 'string', 'example' => '7D59453C-48AA-5FC5-8848-2D373BD1A17F'], ], + 'example' => '', ], ], ], - 'staticInfo' => [ - 'returnType' => 'synchronous', + 'staticInfo' => ['returnType' => 'synchronous'], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"7D59453C-48AA-5FC5-8848-2D373BD1A17F\\"\\n}","type":"json"}]', + 'title' => 'Delete resource configuration', + 'changeSet' => [ + ['createdAt' => '2024-02-22T03:35:44.000Z', 'description' => 'Request parameters changed'], + ], + 'flowControl' => [ + 'flowControlList' => [], + ], + 'ramActions' => [ + [ + 'operationType' => 'delete', + 'ramAction' => [ + 'action' => 'pairec:DeleteInstanceResource', + 'authLevel' => 'operate', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'PAIRecService', 'resourceType' => 'All Resource', 'arn' => '*'], + ], + ], + ], ], - 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"FCF741D8-9C30-578E-807F-B935487DB34A\\",\\n \\"SceneId\\": \\"3\\"\\n}","type":"json"}]', ], - 'DeleteScene' => [ - 'summary' => '删除场景', - 'path' => '/api/v1/scenes/{SceneId}', - 'methods' => [ - 'delete', - ], - 'schemes' => [ - 'http', - 'https', - ], + 'DeleteLaboratory' => [ + 'summary' => 'Delete the specified Lab.', + 'path' => '/api/v1/laboratories/{LaboratoryId}', + 'methods' => ['delete'], + 'schemes' => ['http', 'https'], 'security' => [ [ 'AK' => [], ], ], - 'consumes' => [ - 'application/json', - ], - 'produces' => [ - 'application/json', - ], + 'consumes' => ['application/json'], + 'produces' => ['application/json'], 'operationType' => 'write', 'deprecated' => false, 'systemTags' => [ 'operationType' => 'delete', 'riskType' => 'none', 'chargeType' => 'free', - 'abilityTreeNodes' => [ - 'FEATURElearnN0NAWV', - ], + 'abilityTreeNodes' => ['FEATURElearnN0NAWV'], ], 'parameters' => [ [ - 'name' => 'SceneId', + 'name' => 'LaboratoryId', 'in' => 'path', - 'schema' => [ - 'title' => '场景ID。', - 'description' => '', - 'type' => 'string', - 'required' => false, - 'example' => '3', - ], + 'schema' => ['title' => '', 'description' => 'Laboratory ID, which can be obtained by calling the ListLaboratories API.', 'type' => 'string', 'required' => true, 'example' => '3'], ], [ 'name' => 'InstanceId', 'in' => 'query', - 'schema' => [ - 'title' => '实例ID。', - 'description' => '', - 'type' => 'string', - 'required' => false, - 'example' => 'pairec-cn-abcdefg1234', - ], + 'schema' => ['title' => '', 'description' => 'Instance ID, which can be obtained by calling the ListInstances API.', 'type' => 'string', 'required' => true, 'example' => 'pairec-cn-abcdefg1234'], ], ], 'responses' => [ @@ -5391,121 +4572,63 @@ 'description' => 'Schema of Response', 'type' => 'object', 'properties' => [ - 'RequestId' => [ - 'title' => 'Id of the request', - 'description' => 'Id of the request', - 'type' => 'string', - 'example' => 'D75C43DC-3D3A-5CC8-9AAC-8C77306C433B', - ], + 'RequestId' => ['title' => 'Id of the request', 'description' => 'Id of the request', 'type' => 'string', 'example' => '1C0898E5-9220-5443-B2D9-445FF0688215'], ], + 'example' => '', ], ], ], - 'staticInfo' => [ - 'returnType' => 'synchronous', + 'staticInfo' => ['returnType' => 'synchronous'], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"1C0898E5-9220-5443-B2D9-445FF0688215\\"\\n}","type":"json"}]', + 'title' => 'Delete Lab', + 'changeSet' => [], + 'flowControl' => [ + 'flowControlList' => [], + ], + 'ramActions' => [ + [ + 'operationType' => 'delete', + 'ramAction' => [ + 'action' => 'pairec:DeleteLaboratory', + 'authLevel' => 'operate', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'PAIRecService', 'resourceType' => 'All Resource', 'arn' => '*'], + ], + ], + ], ], - 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"D75C43DC-3D3A-5CC8-9AAC-8C77306C433B\\"\\n}","type":"json"}]', ], - 'UpdateScene' => [ - 'summary' => '更新场景', - 'path' => '/api/v1/scenes/{SceneId}', - 'methods' => [ - 'put', - ], - 'schemes' => [ - 'http', - 'https', - ], + 'DeleteLayer' => [ + 'summary' => 'Delete the specified layer.', + 'path' => '/api/v1/layers/{LayerId}', + 'methods' => ['delete'], + 'schemes' => ['http', 'https'], 'security' => [ [ 'AK' => [], ], ], - 'consumes' => [ - 'application/json', - ], - 'produces' => [ - 'application/json', - ], - 'operationType' => 'readAndWrite', + 'consumes' => ['application/json'], + 'produces' => ['application/json'], + 'operationType' => 'write', 'deprecated' => false, 'systemTags' => [ - 'operationType' => 'update', + 'operationType' => 'delete', 'riskType' => 'none', 'chargeType' => 'free', - 'abilityTreeNodes' => [ - 'FEATURElearnN0NAWV', - ], + 'abilityTreeNodes' => ['FEATURElearnN0NAWV'], ], 'parameters' => [ [ - 'name' => 'SceneId', + 'name' => 'LayerId', 'in' => 'path', - 'schema' => [ - 'description' => '', - 'type' => 'string', - 'required' => false, - 'example' => '3', - ], + 'schema' => ['title' => '', 'description' => 'Layer ID, which can be obtained by calling the ListLayers API.', 'type' => 'string', 'required' => false, 'example' => '3'], ], [ - 'name' => 'body', - 'in' => 'body', - 'style' => 'json', - 'schema' => [ - 'description' => '', - 'type' => 'object', - 'properties' => [ - 'Name' => [ - 'title' => '场景名称。', - 'description' => '', - 'type' => 'string', - 'required' => false, - 'example' => 'scene1', - ], - 'Description' => [ - 'title' => '场景描述。', - 'description' => '', - 'type' => 'string', - 'required' => false, - 'example' => 'This is a test.', - ], - 'InstanceId' => [ - 'title' => '实例ID。', - 'description' => '', - 'type' => 'string', - 'required' => false, - 'example' => 'pairec-cn-abcdefg1234', - ], - 'Flows' => [ - 'title' => '流量列表。', - 'description' => '', - 'type' => 'array', - 'items' => [ - 'type' => 'object', - 'properties' => [ - 'FlowName' => [ - 'title' => '流量名称。', - 'description' => '', - 'type' => 'string', - 'required' => false, - 'example' => '流量1', - ], - 'FlowCode' => [ - 'title' => '流量编码。', - 'description' => '', - 'type' => 'string', - 'required' => false, - 'example' => 'liuliang1', - ], - ], - 'required' => false, - ], - 'required' => false, - ], - ], - 'required' => false, - ], + 'name' => 'InstanceId', + 'in' => 'query', + 'schema' => ['title' => '', 'description' => 'Instance ID, which can be obtained by calling the ListInstances API.', 'type' => 'string', 'required' => false, 'example' => 'pairec-cn-abcdefg1234'], ], ], 'responses' => [ @@ -5515,74 +4638,63 @@ 'description' => 'Schema of Response', 'type' => 'object', 'properties' => [ - 'RequestId' => [ - 'title' => 'Id of the request', - 'description' => 'Id of the request', - 'type' => 'string', - 'example' => 'FC17887E-3C82-5096-8AA6-F4C2E7417245', - ], + 'RequestId' => ['title' => 'Id of the request', 'description' => 'Id of the request', 'type' => 'string', 'example' => '8F457D79-C4A2-5E8C-83E4-0D089456E2AC'], ], + 'example' => '', ], ], ], - 'staticInfo' => [ - 'returnType' => 'synchronous', + 'staticInfo' => ['returnType' => 'synchronous'], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"8F457D79-C4A2-5E8C-83E4-0D089456E2AC\\"\\n}","type":"json"}]', + 'title' => 'Delete Layer', + 'changeSet' => [], + 'flowControl' => [ + 'flowControlList' => [], + ], + 'ramActions' => [ + [ + 'operationType' => 'delete', + 'ramAction' => [ + 'action' => 'pairec:DeleteLayer', + 'authLevel' => 'operate', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'PAIRecService', 'resourceType' => 'All Resource', 'arn' => '*'], + ], + ], + ], ], - 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"FC17887E-3C82-5096-8AA6-F4C2E7417245\\"\\n}","type":"json"}]', ], - 'ListScenes' => [ - 'summary' => '获取场景列表', - 'path' => '/api/v1/scenes', - 'methods' => [ - 'get', - ], - 'schemes' => [ - 'http', - 'https', - ], + 'DeleteParam' => [ + 'summary' => 'Delete the specified parameter.', + 'path' => '/api/v1/params/{ParamId}', + 'methods' => ['delete'], + 'schemes' => ['http', 'https'], 'security' => [ [ 'AK' => [], ], ], - 'consumes' => [ - 'application/json', - ], - 'produces' => [ - 'application/json', - ], - 'operationType' => 'read', + 'consumes' => ['application/json'], + 'produces' => ['application/json'], + 'operationType' => 'write', 'deprecated' => false, 'systemTags' => [ - 'operationType' => 'list', + 'operationType' => 'delete', 'riskType' => 'none', 'chargeType' => 'free', - 'abilityTreeNodes' => [ - 'FEATURElearnN0NAWV', - ], + 'abilityTreeNodes' => ['FEATURElearnN0NAWV'], ], 'parameters' => [ [ - 'name' => 'InstanceId', - 'in' => 'query', - 'schema' => [ - 'title' => '实例ID。', - 'description' => '', - 'type' => 'string', - 'required' => false, - 'example' => 'pairec-cn-abcdefg1234', - ], + 'name' => 'ParamId', + 'in' => 'path', + 'schema' => ['title' => '', 'description' => 'Parameter ID, which can be obtained by calling the ListParams API.', 'type' => 'string', 'required' => false, 'example' => '3'], ], [ - 'name' => 'Name', + 'name' => 'InstanceId', 'in' => 'query', - 'schema' => [ - 'title' => '场景名称过滤。', - 'description' => '', - 'type' => 'string', - 'required' => false, - 'example' => 'scene1', - ], + 'schema' => ['title' => '', 'description' => 'Instance ID, which can be obtained by calling the ListInstances API.', 'type' => 'string', 'required' => false, 'example' => 'pairec-cn-abcdefg1234'], ], ], 'responses' => [ @@ -5592,513 +4704,362 @@ 'description' => 'Schema of Response', 'type' => 'object', 'properties' => [ - 'RequestId' => [ - 'title' => 'Id of the request', - 'description' => 'Id of the request', - 'type' => 'string', - 'example' => 'B8987BF7-6028-5B17-80E0-251B7BD67BBA', - ], - 'TotalCount' => [ - 'description' => '', - 'type' => 'integer', - 'format' => 'int64', - 'example' => '10', - ], - 'Scenes' => [ - 'title' => '场景列表。', - 'description' => '', - 'type' => 'array', - 'items' => [ - 'type' => 'object', - 'properties' => [ - 'SceneId' => [ - 'title' => '场景ID。', - 'description' => '', - 'type' => 'string', - 'example' => '3', - ], - 'Name' => [ - 'title' => '场景名称。', - 'description' => '', - 'type' => 'string', - 'example' => 'scene1', - ], - 'Description' => [ - 'title' => '场景描述。', - 'description' => '', - 'type' => 'string', - 'example' => 'This is a test.', - ], - 'Flows' => [ - 'title' => '流量列表。', - 'description' => '', - 'type' => 'array', - 'items' => [ - 'type' => 'object', - 'properties' => [ - 'FlowName' => [ - 'title' => '流量名称。', - 'description' => '', - 'type' => 'string', - 'example' => '流量1', - ], - 'FlowCode' => [ - 'title' => '流量编码。', - 'description' => '', - 'type' => 'string', - 'example' => 'liuliang1', - ], - ], - ], - ], - ], - ], - ], + 'RequestId' => ['title' => 'Id of the request', 'description' => 'Id of the request', 'type' => 'string', 'example' => 'F0AB6527-093F-5C44-B3BD-42C8C210C619'], ], + 'example' => '', ], ], ], - 'staticInfo' => [ - 'returnType' => 'synchronous', + 'staticInfo' => ['returnType' => 'synchronous'], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"F0AB6527-093F-5C44-B3BD-42C8C210C619\\"\\n}","type":"json"}]', + 'title' => 'Delete Parameter', + 'changeSet' => [], + 'flowControl' => [ + 'flowControlList' => [], + ], + 'ramActions' => [ + [ + 'operationType' => 'delete', + 'ramAction' => [ + 'action' => 'pairec:DeleteParam', + 'authLevel' => 'operate', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'PAIRecService', 'resourceType' => 'All Resource', 'arn' => '*'], + ], + ], + ], ], - 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"B8987BF7-6028-5B17-80E0-251B7BD67BBA\\",\\n \\"TotalCount\\": 10,\\n \\"Scenes\\": [\\n {\\n \\"SceneId\\": \\"3\\",\\n \\"Name\\": \\"scene1\\",\\n \\"Description\\": \\"This is a test.\\",\\n \\"Flows\\": [\\n {\\n \\"FlowName\\": \\"流量1\\",\\n \\"FlowCode\\": \\"liuliang1\\"\\n }\\n ]\\n }\\n ]\\n}","type":"json"}]', ], - 'GetScene' => [ - 'summary' => '获取场景详细信息', - 'path' => '/api/v1/scenes/{SceneId}', - 'methods' => [ - 'get', - ], - 'schemes' => [ - 'http', - 'https', - ], + 'DeleteRecallManagementService' => [ + 'summary' => 'Deletes a recall management service.', + 'path' => '/api/v1/recallmanagementservices/{RecallManagementServiceId}', + 'methods' => ['delete'], + 'schemes' => ['https'], 'security' => [ [ 'AK' => [], ], ], - 'consumes' => [ - 'application/json', - ], - 'produces' => [ - 'application/json', - ], - 'operationType' => 'read', + 'consumes' => ['application/json'], + 'produces' => ['application/json'], + 'operationType' => 'write', 'deprecated' => false, 'systemTags' => [ - 'operationType' => 'get', + 'operationType' => 'delete', 'riskType' => 'none', 'chargeType' => 'free', - 'abilityTreeNodes' => [ - 'FEATURElearnN0NAWV', - ], + 'abilityTreeNodes' => ['FEATURElearnN0NAWV'], ], 'parameters' => [ [ - 'name' => 'SceneId', + 'name' => 'RecallManagementServiceId', 'in' => 'path', - 'schema' => [ - 'title' => '场景ID。', - 'description' => '', - 'type' => 'string', - 'required' => false, - 'example' => '3', - ], + 'schema' => ['description' => 'The ID of the recall management service.', 'type' => 'string', 'required' => false, 'example' => '1', 'title' => ''], ], [ 'name' => 'InstanceId', 'in' => 'query', - 'schema' => [ - 'title' => '实例ID。', - 'description' => '', - 'type' => 'string', - 'required' => false, - 'example' => 'pairec-cn-abcdefg1234', - ], + 'schema' => ['description' => 'The ID of the instance.', 'type' => 'string', 'required' => false, 'example' => 'pairec-cn-test123', 'title' => ''], ], ], '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' => 'B8987BF7-6028-5B17-80E0-251B7BD67BBA', - ], - 'Name' => [ - 'title' => '场景名称。', - 'description' => '', - 'type' => 'string', - 'example' => 'scene1', - ], - 'Description' => [ - 'title' => '场景描述。', - 'description' => '', - 'type' => 'string', - 'example' => 'This is a test.', - ], - 'Flows' => [ - 'title' => '流量列表。', - 'description' => '', - 'type' => 'array', - 'items' => [ - 'type' => 'object', - 'properties' => [ - 'FlowName' => [ - 'title' => '流量名称。', - 'description' => '', - 'type' => 'string', - 'example' => '流量1', - ], - 'FlowCode' => [ - 'title' => '流量编码。', - 'description' => '', - 'type' => 'string', - 'example' => 'liuliang1', - ], - ], - ], - ], + 'RequestId' => ['description' => 'The ID of the request.', 'type' => 'string', 'title' => '', 'example' => '728C5E01-ABF6-5AA8-B9FC-B3BA05DECC77'], ], + 'title' => '', + 'description' => 'The response object.', + 'example' => '', ], ], ], - 'staticInfo' => [ - 'returnType' => 'synchronous', - ], - 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"B8987BF7-6028-5B17-80E0-251B7BD67BBA\\",\\n \\"Name\\": \\"scene1\\",\\n \\"Description\\": \\"This is a test.\\",\\n \\"Flows\\": [\\n {\\n \\"FlowName\\": \\"流量1\\",\\n \\"FlowCode\\": \\"liuliang1\\"\\n }\\n ]\\n}","type":"json"}]', - ], - 'GenerateAlgorithmCustomizationScript' => [ - 'summary' => '生成算法定制脚本', - 'path' => '/api/v1/algorithmcustomizations/{AlgorithmCustomizationId}/action/generatescript', - 'methods' => [ - 'post', + 'staticInfo' => ['returnType' => 'synchronous'], + 'title' => 'DeleteRecallManagementService', + 'description' => '## Request description'."\n" + ."\n" + .'This operation deletes a recall management service based on the RecallManagementServiceId and InstanceId. Before you call this API, ensure you have the correct information for the service to be deleted.', + 'changeSet' => [], + 'flowControl' => [ + 'flowControlList' => [], ], - 'schemes' => [ - 'http', - 'https', + 'ramActions' => [ + [ + 'operationType' => 'delete', + 'ramAction' => [ + 'action' => 'pairec:DeleteRecallManagementService', + 'authLevel' => 'operate', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'PAIRecService', 'resourceType' => 'All Resource', 'arn' => '*'], + ], + ], + ], ], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"728C5E01-ABF6-5AA8-B9FC-B3BA05DECC77\\"\\n}","type":"json"}]', + ], + 'DeleteRecallManagementServiceVersion' => [ + 'path' => '/api/v1/recallmanagementservices/{RecallManagementServiceId}/versions/{RecallManagementServiceVersionId}', + 'methods' => ['delete'], + 'schemes' => ['https'], 'security' => [ [ 'AK' => [], ], ], - 'consumes' => [ - 'application/json', - ], - 'produces' => [ - 'application/json', - ], - 'operationType' => 'readAndWrite', + 'consumes' => ['application/json'], + 'produces' => ['application/json'], + 'operationType' => 'write', 'deprecated' => false, 'systemTags' => [ 'operationType' => 'none', 'riskType' => 'none', 'chargeType' => 'free', - 'abilityTreeNodes' => [ - 'FEATURElearnN0NAWV', - ], + 'abilityTreeNodes' => ['FEATURElearnN0NAWV'], ], 'parameters' => [ [ - 'name' => 'AlgorithmCustomizationId', + 'name' => 'RecallManagementServiceId', 'in' => 'path', - 'schema' => [ - 'description' => '', - 'type' => 'string', - 'required' => false, - 'example' => '1', - ], + 'schema' => ['description' => 'The ID of the recall management service.', 'type' => 'string', 'required' => false, 'example' => '3', 'title' => ''], ], [ - 'name' => 'body', - 'in' => 'body', - 'style' => 'json', - 'schema' => [ - 'description' => '', - 'type' => 'object', - 'properties' => [ - 'InstanceId' => [ - 'description' => '', - 'type' => 'string', - 'required' => false, - 'example' => 'pairec-test-xxx', - ], - 'ModuleFieldTypes' => [ - 'description' => '', - 'type' => 'object', - 'required' => false, - 'example' => '{"item_table":"array"}', - ], - 'DeployMode' => [ - 'description' => '', - 'type' => 'string', - 'required' => false, - 'example' => 'EasyDeploy', - ], - ], - 'required' => false, - ], + 'name' => 'RecallManagementServiceVersionId', + 'in' => 'path', + 'schema' => ['description' => 'The ID of the recall management service version.', 'type' => 'string', 'required' => false, 'example' => '2', 'title' => ''], + ], + [ + 'name' => 'InstanceId', + 'in' => 'query', + 'schema' => ['description' => 'The instance ID.', 'type' => 'string', 'required' => false, 'example' => 'pairec-cn-test123', 'title' => ''], ], ], 'responses' => [ 200 => [ 'schema' => [ - 'title' => 'Schema of Response', - 'description' => 'Schema of Response', 'type' => 'object', 'properties' => [ - 'RequestId' => [ - 'title' => 'Id of the request', - 'description' => '', - 'type' => 'string', - 'example' => '6CF1E160-3F36-5E73-A170-C75504F05BBC', - ], - 'OssAddress' => [ - 'description' => '', - 'type' => 'string', - 'example' => 'oss:xxxx', - ], - 'LogId' => [ - 'description' => '', - 'type' => 'string', - 'example' => '4', - ], + 'RequestId' => ['description' => 'The request ID.', 'type' => 'string', 'title' => '', 'example' => '728C5E01-ABF6-5AA8-B9FC-B3BA05DECC77'], ], + 'title' => '', + 'description' => 'The response body.', + 'example' => '', ], ], ], - 'staticInfo' => [ - 'returnType' => 'synchronous', - ], - 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"6CF1E160-3F36-5E73-A170-C75504F05BBC\\",\\n \\"OssAddress\\": \\"oss:xxxx\\",\\n \\"LogId\\": \\"4\\"\\n}","type":"json"}]', - ], - 'CreateLaboratory' => [ - 'summary' => '创建实验室', - 'path' => '/api/v1/laboratories', - 'methods' => [ - 'post', + 'staticInfo' => ['returnType' => 'synchronous'], + 'title' => 'DeleteRecallManagementServiceVersion', + 'summary' => 'Deletes a specified version of a recall management service.', + 'description' => '## Request'."\n" + ."\n" + .'This operation deletes a specific version of a recall management service. You must provide the recall management service ID, the recall management service version ID, and the instance ID. This operation is irreversible, so back up all critical data before proceeding.', + 'changeSet' => [], + 'flowControl' => [ + 'flowControlList' => [], ], - 'schemes' => [ - 'http', - 'https', + 'ramActions' => [ + [ + 'operationType' => 'none', + 'ramAction' => [ + 'action' => 'pairec:DeleteRecallManagementServiceVersion', + 'authLevel' => 'operate', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'PAIRecService', 'resourceType' => 'All Resource', 'arn' => '*'], + ], + ], + ], ], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"728C5E01-ABF6-5AA8-B9FC-B3BA05DECC77\\"\\n}","type":"json"}]', + ], + 'DeleteRecallManagementServiceVersionConfig' => [ + 'summary' => 'Deletes the specified recall management service version configuration.', + 'path' => '/api/v1/recallmanagementservices/{RecallManagementServiceId}/versions/{RecallManagementServiceVersionId}/configs/{RecallManagementServiceVersionConfigId}', + 'methods' => ['delete'], + 'schemes' => ['https'], 'security' => [ [ 'AK' => [], ], ], - 'consumes' => [ - 'application/json', - ], - 'produces' => [ - 'application/json', - ], + 'consumes' => ['application/json'], + 'produces' => ['application/json'], 'operationType' => 'write', 'deprecated' => false, 'systemTags' => [ - 'operationType' => 'create', + 'operationType' => 'none', 'riskType' => 'none', 'chargeType' => 'free', - 'abilityTreeNodes' => [ - 'FEATURElearnN0NAWV', - ], + 'abilityTreeNodes' => ['FEATURElearnN0NAWV'], ], 'parameters' => [ [ - 'name' => 'body', - 'in' => 'body', - 'style' => 'json', + 'name' => 'RecallManagementServiceId', + 'in' => 'path', + 'schema' => ['description' => 'The recall management service ID.', 'type' => 'string', 'required' => false, 'example' => '3', 'title' => ''], + ], + [ + 'name' => 'RecallManagementServiceVersionId', + 'in' => 'path', + 'schema' => ['description' => 'The recall management version ID.', 'type' => 'string', 'required' => false, 'example' => '2', 'title' => ''], + ], + [ + 'name' => 'RecallManagementServiceVersionConfigId', + 'in' => 'path', + 'schema' => ['description' => 'The recall management configuration ID.', 'type' => 'string', 'required' => false, 'example' => '2', 'title' => ''], + ], + [ + 'name' => 'InstanceId', + 'in' => 'query', + 'schema' => ['description' => 'The instance ID.', 'type' => 'string', 'required' => false, 'example' => 'pairec-cn-test123', 'title' => ''], + ], + ], + 'responses' => [ + 200 => [ 'schema' => [ - 'title' => '请求body。', - 'description' => '', 'type' => 'object', 'properties' => [ - 'SceneId' => [ - 'title' => '场景ID。', - 'description' => '', - 'type' => 'string', - 'required' => true, - 'example' => '3', - ], - 'Name' => [ - 'title' => '实验室名称。', - 'description' => '', - 'type' => 'string', - 'required' => true, - 'example' => 'laboratory1', - ], - 'Description' => [ - 'title' => '实验室描述。', - 'description' => '', - 'type' => 'string', - 'required' => false, - 'example' => 'This is a test.', - ], - 'DebugUsers' => [ - 'title' => '调试用户。', - 'description' => '', - 'type' => 'string', - 'required' => false, - 'example' => '1124512470******,1124512471******,1124512472******', - ], - 'DebugCrowdId' => [ - 'title' => '调试人群ID。', - 'description' => '', - 'type' => 'string', - 'required' => false, - 'example' => '3', - ], - 'BucketCount' => [ - 'title' => '分桶数量。', - 'description' => '', - 'type' => 'integer', - 'format' => 'int32', - 'required' => false, - 'example' => '24', - ], - 'Buckets' => [ - 'title' => '分配桶号。', - 'description' => '', - 'type' => 'string', - 'required' => false, - 'example' => '1,2,3,10-20', - ], - 'BucketType' => [ - 'title' => '分桶方式'."\n" - .'● UidHash-UID哈希（默认）'."\n" - .'● Uid-UID分桶'."\n" - .'● Filter-过滤条件分桶', - 'description' => '', - 'type' => 'string', - 'required' => true, - 'example' => 'UidHash', - ], - 'Filter' => [ - 'title' => '过滤条件。', - 'description' => '', - 'type' => 'string', - 'required' => false, - 'example' => 'filter=xxx', - ], - 'Environment' => [ - 'title' => '运行环境'."\n" - .'● Daily-日常环境'."\n" - .'● Pre-预发环境'."\n" - .'● Prod-生产环', - 'description' => '', - 'type' => 'string', - 'required' => true, - 'example' => 'Daily', - ], - 'Type' => [ - 'title' => '实验室类型'."\n" - .'● Base'."\n" - .'● NonBase', - 'description' => '', - 'type' => 'string', - 'required' => true, - 'example' => 'Base', - ], - 'InstanceId' => [ - 'title' => '实例ID。', - 'description' => '', - 'type' => 'string', - 'required' => true, - 'example' => 'pairec-cn-abcdefg1234', - ], + 'RequestId' => ['description' => 'The request ID.', 'type' => 'string', 'title' => '', 'example' => '728C5E01-ABF6-5AA8-B9FC-B3BA05DECC77'], ], - 'required' => false, + 'title' => '', + 'description' => 'The response body.', + 'example' => '', ], ], ], + 'staticInfo' => ['returnType' => 'synchronous'], + 'title' => 'DeleteRecallManagementServiceVersionConfig', + 'description' => '## Usage notes'."\n" + ."\n" + .'- Specify the recall management service ID, recall management version ID, and recall management configuration ID.'."\n" + ."\n" + .'- `InstanceId` is a required query parameter.'."\n" + ."\n" + .'- The request fails if any of the specified IDs are invalid.', + 'changeSet' => [], + 'flowControl' => [ + 'flowControlList' => [], + ], + 'ramActions' => [ + [ + 'operationType' => 'none', + 'ramAction' => [ + 'action' => 'pairec:DeleteRecallManagementServiceVersionConfig', + 'authLevel' => 'operate', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'PAIRecService', 'resourceType' => 'All Resource', 'arn' => '*'], + ], + ], + ], + ], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"728C5E01-ABF6-5AA8-B9FC-B3BA05DECC77\\"\\n}","type":"json"}]', + ], + 'DeleteRecallManagementTable' => [ + 'summary' => 'This API deletes a recall management table using the specified recall management table ID and instance ID.', + 'path' => '/api/v1/recallmanagementtables/{RecallManagementTableId}', + 'methods' => ['delete'], + 'schemes' => ['https'], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'consumes' => ['application/json'], + 'produces' => ['application/json'], + 'operationType' => 'readAndWrite', + 'deprecated' => false, + 'systemTags' => [ + 'operationType' => 'delete', + 'riskType' => 'none', + 'chargeType' => 'free', + 'abilityTreeNodes' => ['FEATURElearnN0NAWV'], + ], + 'parameters' => [ + [ + 'name' => 'RecallManagementTableId', + 'in' => 'path', + 'schema' => ['description' => 'The ID of the recall management table.', 'type' => 'string', 'required' => true, 'example' => '3', 'title' => ''], + ], + [ + 'name' => 'InstanceId', + 'in' => 'query', + 'schema' => ['description' => 'The instance ID.', 'type' => 'string', 'required' => true, 'example' => 'pairec-cn-test123', 'title' => ''], + ], + ], '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' => '42391E6D-822C-58F8-9F7E-D991BB86D6AD', - ], - 'LaboratoryId' => [ - 'title' => '实验室ID。', - 'description' => '', - 'type' => 'string', - 'example' => '3', - ], + 'RequestId' => ['description' => 'The request ID.', 'type' => 'string', 'title' => '', 'example' => '728C5E01-ABF6-5AA8-B9FC-B3BA05DECC77'], ], + 'title' => '', + 'description' => 'The response body.', + 'example' => '', ], ], ], - 'staticInfo' => [ - 'returnType' => 'synchronous', + 'staticInfo' => ['returnType' => 'synchronous'], + 'title' => 'DeleteRecallManagementTable', + 'description' => '## Request'."\n" + ."\n" + .'- The required **path parameter** `RecallManagementTableId` specifies the ID of the recall management table to delete.'."\n" + ."\n" + .'- The required **query parameter** `InstanceId` specifies the ID of the instance.'."\n" + ."\n" + .'- A successful operation returns a `RequestId` in the response body for request tracking.', + 'changeSet' => [], + 'flowControl' => [ + 'flowControlList' => [], + ], + 'ramActions' => [ + [ + 'operationType' => 'delete', + 'ramAction' => [ + 'action' => 'pairec:DeleteRecallManagementTable', + 'authLevel' => 'operate', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'PAIRecService', 'resourceType' => 'All Resource', 'arn' => '*'], + ], + ], + ], ], - 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"42391E6D-822C-58F8-9F7E-D991BB86D6AD\\",\\n \\"LaboratoryId\\": \\"3\\"\\n}","type":"json"}]', + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"728C5E01-ABF6-5AA8-B9FC-B3BA05DECC77\\"\\n}","type":"json"}]', ], - 'DeleteLaboratory' => [ - 'summary' => '删除实验室。', - 'path' => '/api/v1/laboratories/{LaboratoryId}', - 'methods' => [ - 'delete', - ], - 'schemes' => [ - 'http', - 'https', - ], + 'DeleteScene' => [ + 'summary' => 'Delete the specified scenario.', + 'path' => '/api/v1/scenes/{SceneId}', + 'methods' => ['delete'], + 'schemes' => ['http', 'https'], 'security' => [ [ 'AK' => [], ], ], - 'consumes' => [ - 'application/json', - ], - 'produces' => [ - 'application/json', - ], + 'consumes' => ['application/json'], + 'produces' => ['application/json'], 'operationType' => 'write', 'deprecated' => false, 'systemTags' => [ 'operationType' => 'delete', 'riskType' => 'none', 'chargeType' => 'free', - 'abilityTreeNodes' => [ - 'FEATURElearnN0NAWV', - ], + 'abilityTreeNodes' => ['FEATURElearnN0NAWV'], ], 'parameters' => [ [ - 'name' => 'LaboratoryId', + 'name' => 'SceneId', 'in' => 'path', - 'schema' => [ - 'title' => '实验室ID。', - 'description' => '', - 'type' => 'string', - 'required' => true, - 'example' => '3', - ], + 'schema' => ['title' => '', 'description' => 'Scenario ID, which can be obtained by calling the ListScenes API.', 'type' => 'string', 'required' => false, 'example' => '3'], ], [ 'name' => 'InstanceId', 'in' => 'query', - 'schema' => [ - 'title' => '实例ID。', - 'description' => '', - 'type' => 'string', - 'required' => true, - 'example' => 'pairec-cn-abcdefg1234', - ], + 'schema' => ['title' => '', 'description' => 'Instance ID, which can be obtained by calling the ListInstances API.', 'type' => 'string', 'required' => false, 'example' => 'pairec-cn-abcdefg1234'], ], ], 'responses' => [ @@ -6108,817 +5069,554 @@ 'description' => 'Schema of Response', 'type' => 'object', 'properties' => [ - 'RequestId' => [ - 'title' => 'Id of the request', - 'description' => 'Id of the request', - 'type' => 'string', - 'example' => '1C0898E5-9220-5443-B2D9-445FF0688215', - ], + 'RequestId' => ['title' => 'Id of the request', 'description' => 'Id of the request', 'type' => 'string', 'example' => 'D75C43DC-3D3A-5CC8-9AAC-8C77306C433B'], ], + 'example' => '', ], ], ], - 'staticInfo' => [ - 'returnType' => 'synchronous', + 'staticInfo' => ['returnType' => 'synchronous'], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"D75C43DC-3D3A-5CC8-9AAC-8C77306C433B\\"\\n}","type":"json"}]', + 'title' => 'Delete Scenario', + 'changeSet' => [], + 'flowControl' => [ + 'flowControlList' => [], + ], + 'ramActions' => [ + [ + 'operationType' => 'delete', + 'ramAction' => [ + 'action' => 'pairec:DeleteScene', + 'authLevel' => 'operate', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'PAIRecService', 'resourceType' => 'All Resource', 'arn' => '*'], + ], + ], + ], ], - 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"1C0898E5-9220-5443-B2D9-445FF0688215\\"\\n}","type":"json"}]', ], - 'UpdateLaboratory' => [ - 'summary' => '更新实验室。', - 'path' => '/api/v1/laboratories/{LaboratoryId}', - 'methods' => [ - 'put', - ], - 'schemes' => [ - 'http', - 'https', - ], + 'DeleteSubCrowd' => [ + 'summary' => 'Deletes the specified subcrowd.', + 'path' => '/api/v1/crowds/{CrowdId}/subcrowds/{SubCrowdId}', + 'methods' => ['delete'], + 'schemes' => ['http', 'https'], 'security' => [ [ 'AK' => [], ], ], - 'consumes' => [ - 'application/json', - ], - 'produces' => [ - 'application/json', - ], - 'operationType' => 'readAndWrite', + 'consumes' => ['application/json'], + 'produces' => ['application/json'], + 'operationType' => 'write', 'deprecated' => false, 'systemTags' => [ - 'operationType' => 'update', + 'operationType' => 'delete', 'riskType' => 'none', 'chargeType' => 'free', - 'abilityTreeNodes' => [ - 'FEATURElearnN0NAWV', - ], + 'abilityTreeNodes' => ['FEATURElearnN0NAWV'], ], 'parameters' => [ [ - 'name' => 'LaboratoryId', + 'name' => 'CrowdId', 'in' => 'path', - 'schema' => [ - 'title' => '实验室ID。', - 'description' => '', - 'type' => 'string', - 'required' => true, - 'example' => '3', - ], + 'schema' => ['description' => 'The crowd ID. You can obtain this ID by calling the `ListCrowds` operation.', 'type' => 'string', 'required' => true, 'example' => '3', 'title' => ''], ], [ - 'name' => 'body', - 'in' => 'body', - 'style' => 'json', - 'schema' => [ - 'title' => '请求body。', - 'description' => '', - 'type' => 'object', - 'properties' => [ - 'Name' => [ - 'title' => '实验室名称。', - 'description' => '', - 'type' => 'string', - 'required' => true, - 'example' => 'laboratory1', - ], - 'Description' => [ - 'title' => '实验室介绍。', - 'description' => '', - 'type' => 'string', - 'required' => false, - 'example' => 'This is a test.', - ], - 'DebugUsers' => [ - 'title' => '调试用户。', - 'description' => '', - 'type' => 'string', - 'required' => false, - 'example' => '1124512470******,1124512471******,1124512472******', - ], - 'DebugCrowdId' => [ - 'title' => '调试人群ID。', - 'description' => '', - 'type' => 'string', - 'required' => false, - 'example' => '3', - ], - 'BucketCount' => [ - 'title' => '分桶数量。', - 'description' => '', - 'type' => 'integer', - 'format' => 'int32', - 'required' => false, - 'example' => '24', - ], - 'Buckets' => [ - 'title' => '分配桶号。', - 'description' => '', - 'type' => 'string', - 'required' => false, - 'example' => '1,2,3,10-20', - ], - 'BucketType' => [ - 'title' => '分桶方式。'."\n" - .'● Uid-UID分桶（默认）'."\n" - .'● UidHash-UID哈希'."\n" - .'● Filter-过滤条件分桶', - 'description' => '', - 'type' => 'string', - 'required' => true, - 'example' => 'Filter', - ], - 'Filter' => [ - 'title' => '过滤条件。', - 'description' => '', - 'type' => 'string', - 'required' => false, - 'example' => 'filter=xxx', - ], - 'Type' => [ - 'title' => '实验室类型。'."\n" - .'● Base'."\n" - .'● NonBase', - 'description' => '', - 'type' => 'string', - 'required' => true, - 'example' => 'Base', - ], - 'InstanceId' => [ - 'title' => '实例ID。', - 'description' => '', - 'type' => 'string', - 'required' => true, - 'example' => 'pairec-test1', - ], - 'Environment' => [ - 'title' => '运行环境'."\n" - .'● Daily-日常环境'."\n" - .'● Pre-预发环境'."\n" - .'● Prod-生产环境', - 'description' => '', - 'type' => 'string', - 'required' => false, - 'example' => 'Daily', - ], - ], - 'required' => false, - ], + 'name' => 'SubCrowdId', + 'in' => 'path', + 'schema' => ['description' => 'The subcrowd ID. You can obtain this ID by calling the `ListSubCrowds` operation.', 'type' => 'string', 'required' => true, 'example' => '3', 'title' => ''], + ], + [ + 'name' => 'InstanceId', + 'in' => 'query', + 'schema' => ['description' => 'The instance ID. You can obtain this ID by calling the `ListInstances` operation.', 'type' => 'string', 'required' => true, 'example' => 'pairec-cn-abcdefg1234', 'title' => ''], ], ], 'responses' => [ 200 => [ 'schema' => [ 'title' => 'Schema of Response', - 'description' => 'Schema of Response', + 'description' => 'Response body', 'type' => 'object', 'properties' => [ - 'RequestId' => [ - 'title' => 'Id of the request', - 'description' => 'Id of the request', - 'type' => 'string', - 'example' => 'A04CB8C0-E74A-5E83-BC61-64D153574EC7', - ], + 'RequestId' => ['title' => 'Id of the request', 'description' => 'The request ID.', 'type' => 'string', 'example' => 'EE97D06A-2AA0-5AD9-B6CF-8A267924D691'], ], + 'example' => '', ], ], ], - 'staticInfo' => [ - 'returnType' => 'synchronous', + 'staticInfo' => ['returnType' => 'synchronous'], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"EE97D06A-2AA0-5AD9-B6CF-8A267924D691\\"\\n}","type":"json"}]', + 'title' => 'Delete Sub-Audience', + 'changeSet' => [], + 'flowControl' => [ + 'flowControlList' => [], + ], + 'ramActions' => [ + [ + 'operationType' => 'delete', + 'ramAction' => [ + 'action' => 'pairec:DeleteSubCrowd', + 'authLevel' => 'operate', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'PAIRecService', 'resourceType' => 'All Resource', 'arn' => '*'], + ], + ], + ], ], - 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"A04CB8C0-E74A-5E83-BC61-64D153574EC7\\"\\n}","type":"json"}]', ], - 'ListLaboratories' => [ - 'summary' => '获取实验室列表。', - 'path' => '/api/v1/laboratories', - 'methods' => [ - 'get', - ], - 'schemes' => [ - 'http', - 'https', - ], + 'DeleteTableMeta' => [ + 'summary' => 'Deletes a data table.', + 'path' => '/api/v1/tablemetas/{TableMetaId}', + 'methods' => ['delete'], + 'schemes' => ['http', 'https'], 'security' => [ [ 'AK' => [], ], ], - 'consumes' => [ - 'application/json', - ], - 'produces' => [ - 'application/json', - ], - 'operationType' => 'read', + 'consumes' => ['application/json'], + 'produces' => ['application/json'], + 'operationType' => 'write', 'deprecated' => false, 'systemTags' => [ - 'operationType' => 'list', + 'operationType' => 'delete', 'riskType' => 'none', 'chargeType' => 'free', - 'abilityTreeNodes' => [ - 'FEATURElearnN0NAWV', - ], + 'abilityTreeNodes' => ['FEATURElearnN0NAWV'], ], 'parameters' => [ [ - 'name' => 'Environment', - 'in' => 'query', - 'schema' => [ - 'title' => '实验室所属的环境。'."\n" - .'● Daily-日常环境'."\n" - .'● Pre-预发环境'."\n" - .'● Prod-生产环境', - 'description' => '', - 'type' => 'string', - 'required' => false, - 'example' => 'Daily', - ], + 'name' => 'TableMetaId', + 'in' => 'path', + 'schema' => ['description' => 'The ID of the data table.', 'type' => 'string', 'required' => true, 'example' => '2', 'title' => ''], ], [ - 'name' => 'SceneId', + 'name' => 'InstanceId', 'in' => 'query', + 'schema' => ['description' => 'The ID of the instance. To obtain this ID, call the [ListInstances](~~2411819~~) operation.', 'type' => 'string', 'required' => true, 'example' => '实例ID pairec-cn-test1', 'title' => ''], + ], + ], + 'responses' => [ + 200 => [ 'schema' => [ - 'title' => '场景ID。', - 'description' => '', - 'type' => 'string', - 'required' => true, - 'example' => '3', + 'title' => 'Schema of Response', + 'description' => 'The response body.', + 'type' => 'object', + 'properties' => [ + 'RequestId' => ['title' => 'Id of the request', 'description' => 'The ID of the request.', 'type' => 'string', 'example' => '728C5E01-ABF6-5AA8-B9FC-B3BA05DECC77'], + ], + 'example' => '', ], ], - [ - 'name' => 'Status', - 'in' => 'query', - 'schema' => [ - 'title' => '状态。'."\n" - .'● Offline-未上线。'."\n" - .'● Online-已上线。', - 'description' => '', - 'type' => 'string', - 'required' => false, - 'example' => 'Offline', + ], + 'staticInfo' => ['returnType' => 'synchronous'], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"728C5E01-ABF6-5AA8-B9FC-B3BA05DECC77\\"\\n}","type":"json"}]', + 'title' => 'Delete a Data Table', + 'changeSet' => [ + ['createdAt' => '2024-02-22T03:35:42.000Z', 'description' => 'Request parameters changed'], + ], + 'flowControl' => [ + 'flowControlList' => [], + ], + 'ramActions' => [ + [ + 'operationType' => 'delete', + 'ramAction' => [ + 'action' => 'pairec:DeleteTableMeta', + 'authLevel' => 'operate', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'PAIRecService', 'resourceType' => 'All Resource', 'arn' => '*'], + ], ], ], + ], + ], + 'DeleteTrafficControlTarget' => [ + 'summary' => 'Deletes the specified traffic control target.', + 'path' => '/api/v1/trafficcontroltargets/{TrafficControlTargetId}', + 'methods' => ['delete'], + 'schemes' => ['http', 'https'], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'consumes' => ['application/json'], + 'produces' => ['application/json'], + 'operationType' => 'readAndWrite', + 'deprecated' => false, + 'systemTags' => [ + 'operationType' => 'delete', + 'riskType' => 'none', + 'chargeType' => 'free', + 'abilityTreeCode' => '220596', + 'abilityTreeNodes' => ['FEATURElearnN0NAWV'], + ], + 'parameters' => [ + [ + 'name' => 'TrafficControlTargetId', + 'in' => 'path', + 'schema' => ['description' => 'The traffic control target ID.', 'type' => 'string', 'required' => false, 'example' => '1', 'title' => ''], + ], [ 'name' => 'InstanceId', 'in' => 'query', - 'schema' => [ - 'title' => '实例ID。', - 'description' => '', - 'type' => 'string', - 'required' => true, - 'example' => 'pairec-test1', - ], + 'schema' => ['description' => 'The instance ID.', 'type' => 'string', 'required' => false, 'example' => 'pairec-1324***', 'title' => ''], ], ], 'responses' => [ 200 => [ 'schema' => [ + 'description' => 'The response body.', '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' => '1C0898E5-9220-5443-B2D9-445FF0688215', - ], - 'TotalCount' => [ - 'title' => '列表内元素总数。', - 'description' => '', - 'type' => 'integer', - 'format' => 'int64', - 'example' => '10', - ], - 'Laboratories' => [ - 'title' => '实验室列表。', - 'description' => '', - 'type' => 'array', - 'items' => [ - 'type' => 'object', - 'properties' => [ - 'LaboratoryId' => [ - 'title' => '实验室ID。', - 'description' => '', - 'type' => 'string', - 'example' => '3', - ], - 'SceneId' => [ - 'title' => '场景ID。', - 'description' => '', - 'type' => 'string', - 'example' => '3', - ], - 'Name' => [ - 'title' => '实验室名称。', - 'description' => '', - 'type' => 'string', - 'example' => 'laboratory1', - ], - 'Description' => [ - 'title' => '实验室描述。', - 'description' => '', - 'type' => 'string', - 'example' => 'This is a test.', - ], - 'DebugUsers' => [ - 'title' => '调试用户。', - 'description' => '', - 'type' => 'string', - 'example' => 'user1,user2,user3', - ], - 'DebugCrowdId' => [ - 'title' => '调试人群ID。', - 'description' => '', - 'type' => 'string', - 'example' => '3', - ], - 'BucketCount' => [ - 'title' => '分桶数量。', - 'description' => '', - 'type' => 'integer', - 'format' => 'int32', - 'example' => '100', - ], - 'Buckets' => [ - 'title' => '分配桶号。', - 'description' => '', - 'type' => 'string', - 'example' => '1,2,3,10-20', - ], - 'BucketType' => [ - 'title' => '分桶方式。'."\n" - .'● Uid-UID分桶（默认）'."\n" - .'● UidHash-UID哈希'."\n" - .'● Filter-过滤条件分桶', - 'description' => '', - 'type' => 'string', - 'example' => 'Filter', - ], - 'Filter' => [ - 'title' => '过滤条件。', - 'description' => '', - 'type' => 'string', - 'example' => 'filter=xxx', - ], - 'Environment' => [ - 'title' => '运行环境'."\n" - .'● Daily-日常环境'."\n" - .'● Pre-预发环境'."\n" - .'● Prod-生产环境', - 'description' => '', - 'type' => 'string', - 'example' => 'Daily', - ], - 'Type' => [ - 'title' => '实验室类型'."\n" - .'● Base'."\n" - .'● NonBase', - 'description' => '', - 'type' => 'string', - 'example' => 'Base', - ], - 'Status' => [ - 'title' => '状态。'."\n" - .'● Offline-未上线。'."\n" - .'● Online-已上线。', - 'description' => '', - 'type' => 'string', - 'example' => 'Offline', - ], - 'CrowdId' => [ - 'title' => '人群ID。', - 'description' => '', - 'type' => 'string', - 'example' => '3', - ], - ], - ], - ], + 'RequestId' => ['title' => 'Id of the request', 'description' => 'The request ID.', 'type' => 'string', 'example' => '728C5E01-ABF6-5AA8-B9FC-B3BA05DECC77'], ], + 'example' => '', ], ], ], - 'staticInfo' => [ - 'returnType' => 'synchronous', + 'staticInfo' => ['returnType' => 'synchronous'], + 'title' => 'Delete traffic control target', + 'description' => '## Request'."\n" + ."\n" + .'- **TrafficControlTargetId** is a required path parameter that specifies the traffic control target to delete.'."\n" + ."\n" + .'- **InstanceId** is a required query parameter that specifies the instance ID for this operation.'."\n" + ."\n" + .'- A successful response includes a `RequestId` field to track the request.', + 'changeSet' => [], + 'flowControl' => [ + 'flowControlList' => [], + ], + 'ramActions' => [ + [ + 'operationType' => 'delete', + 'ramAction' => [ + 'action' => 'pairec:DeleteTrafficControlTarget', + 'authLevel' => 'operate', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'PAIRecService', 'resourceType' => 'All Resource', 'arn' => '*'], + ], + ], + ], ], - 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"1C0898E5-9220-5443-B2D9-445FF0688215\\",\\n \\"TotalCount\\": 10,\\n \\"Laboratories\\": [\\n {\\n \\"LaboratoryId\\": \\"3\\",\\n \\"SceneId\\": \\"3\\",\\n \\"Name\\": \\"laboratory1\\",\\n \\"Description\\": \\"This is a test.\\",\\n \\"DebugUsers\\": \\"user1,user2,user3\\",\\n \\"DebugCrowdId\\": \\"3\\",\\n \\"BucketCount\\": 100,\\n \\"Buckets\\": \\"1,2,3,10-20\\",\\n \\"BucketType\\": \\"Filter\\",\\n \\"Filter\\": \\"filter=xxx\\",\\n \\"Environment\\": \\"Daily\\",\\n \\"Type\\": \\"Base\\",\\n \\"Status\\": \\"Offline\\",\\n \\"CrowdId\\": \\"3\\"\\n }\\n ]\\n}","type":"json"}]', + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"728C5E01-ABF6-5AA8-B9FC-B3BA05DECC77\\"\\n}","type":"json"}]', ], - 'GetLaboratory' => [ - 'summary' => '获取实验室详细信息。', - 'path' => '/api/v1/laboratories/{LaboratoryId}', - 'methods' => [ - 'get', - ], - 'schemes' => [ - 'http', - 'https', - ], + 'DeleteTrafficControlTask' => [ + 'path' => '/api/v1/trafficcontroltasks/{TrafficControlTaskId}', + 'methods' => ['delete'], + 'schemes' => ['http', 'https'], 'security' => [ [ 'AK' => [], ], ], - 'consumes' => [ - 'application/json', - ], - 'produces' => [ - 'application/json', - ], - 'operationType' => 'read', + 'consumes' => ['application/json'], + 'produces' => ['application/json'], + 'operationType' => 'readAndWrite', 'deprecated' => false, 'systemTags' => [ - 'operationType' => 'get', + 'operationType' => 'delete', 'riskType' => 'none', 'chargeType' => 'free', - 'abilityTreeNodes' => [ - 'FEATURElearnN0NAWV', - ], + 'abilityTreeCode' => '220408', + 'abilityTreeNodes' => ['FEATURElearnN0NAWV'], ], 'parameters' => [ [ - 'name' => 'LaboratoryId', + 'name' => 'TrafficControlTaskId', 'in' => 'path', - 'schema' => [ - 'title' => '实验室ID。', - 'description' => '', - 'type' => 'string', - 'required' => true, - 'example' => '3', - ], + 'schema' => ['description' => 'The ID of the traffic control task.', 'type' => 'string', 'required' => false, 'example' => '1', 'title' => ''], ], [ 'name' => 'InstanceId', 'in' => 'query', - 'schema' => [ - 'title' => '实例ID。', - 'description' => '', - 'type' => 'string', - 'required' => true, - 'example' => 'pairec-test1', - ], + 'schema' => ['description' => 'The ID of the instance.', 'type' => 'string', 'required' => false, 'example' => 'pairec-1324***', 'title' => ''], ], ], 'responses' => [ 200 => [ 'schema' => [ + 'description' => 'The data returned.', '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' => '1C0898E5-9220-5443-B2D9-445FF0688215', - ], - 'SceneId' => [ - 'title' => '场景ID。', - 'description' => '', - 'type' => 'string', - 'example' => '3', - ], - 'Name' => [ - 'title' => '实验室名称。', - 'description' => '', - 'type' => 'string', - 'example' => 'laboratory1', - ], - 'Description' => [ - 'title' => '实验室描述。', - 'description' => '', - 'type' => 'string', - 'example' => 'This is a test.', - ], - 'DebugUsers' => [ - 'title' => '调试用户。', - 'description' => '', - 'type' => 'string', - 'example' => 'user1,user2,user3', - ], - 'DebugCrowdId' => [ - 'title' => '调试人群ID。', - 'description' => '', - 'type' => 'string', - 'example' => '3', - ], - 'BucketCount' => [ - 'title' => '分桶数量。', - 'description' => '', - 'type' => 'integer', - 'format' => 'int32', - 'example' => '100', - ], - 'Buckets' => [ - 'title' => '分配桶号。', - 'description' => '', - 'type' => 'string', - 'example' => '1,2,3,10-20', - ], - 'BucketType' => [ - 'title' => '分桶方式。'."\n" - .'● Uid-UID分桶（默认）'."\n" - .'● UidHash-UID哈希'."\n" - .'● Filter-过滤条件分桶', - 'description' => '', - 'type' => 'string', - 'example' => 'Filter', - ], - 'Filter' => [ - 'title' => '过滤条件。', - 'description' => '', - 'type' => 'string', - 'example' => 'filter=xxx', - ], - 'Environment' => [ - 'title' => '运行环境'."\n" - .'● Daily-日常环境'."\n" - .'● Pre-预发环境'."\n" - .'● Prod-生产环境', - 'description' => '', - 'type' => 'string', - 'example' => 'Daily', - ], - 'Type' => [ - 'title' => '实验室类型'."\n" - .'● Base'."\n" - .'● NonBase', - 'description' => '', - 'type' => 'string', - 'example' => 'Base', - ], - 'Status' => [ - 'title' => '状态。'."\n" - .'● Offline-未上线。'."\n" - .'● Online-已上线。', - 'description' => '', - 'type' => 'string', - 'example' => 'Offline', - ], - 'CrowdId' => [ - 'title' => '人群ID。', - 'description' => '', - 'type' => 'string', - 'example' => '3', - ], + 'RequestId' => ['title' => 'Id of the request', 'description' => 'The ID of the request.', 'type' => 'string', 'example' => '728C5E01-ABF6-5AA8-B9FC-B3BA05DECC77'], ], + 'example' => '', ], ], ], - 'staticInfo' => [ - 'returnType' => 'synchronous', + 'staticInfo' => ['returnType' => 'synchronous'], + 'title' => 'Delete traffic control job', + 'summary' => 'Deletes a specified traffic control task.', + 'description' => '## Description'."\n" + ."\n" + .'- This API uses `TrafficControlTaskId` and `InstanceId` to delete a traffic control task.'."\n" + ."\n" + .'- Ensure the `TrafficControlTaskId` and `InstanceId` are correct, or the operation may fail.'."\n" + ."\n" + .'- This operation is irreversible. Proceed with caution.', + 'changeSet' => [], + 'flowControl' => [ + 'flowControlList' => [], + ], + 'ramActions' => [ + [ + 'operationType' => 'delete', + 'ramAction' => [ + 'action' => 'pairec:DeleteTrafficControlTask', + 'authLevel' => 'operate', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'PAIRecService', 'resourceType' => 'All Resource', 'arn' => '*'], + ], + ], + ], ], - 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"1C0898E5-9220-5443-B2D9-445FF0688215\\",\\n \\"SceneId\\": \\"3\\",\\n \\"Name\\": \\"laboratory1\\",\\n \\"Description\\": \\"This is a test.\\",\\n \\"DebugUsers\\": \\"user1,user2,user3\\",\\n \\"DebugCrowdId\\": \\"3\\",\\n \\"BucketCount\\": 100,\\n \\"Buckets\\": \\"1,2,3,10-20\\",\\n \\"BucketType\\": \\"Filter\\",\\n \\"Filter\\": \\"filter=xxx\\",\\n \\"Environment\\": \\"Daily\\",\\n \\"Type\\": \\"Base\\",\\n \\"Status\\": \\"Offline\\",\\n \\"CrowdId\\": \\"3\\"\\n}","type":"json"}]', + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"728C5E01-ABF6-5AA8-B9FC-B3BA05DECC77\\"\\n}","type":"json"}]', ], - 'OnlineLaboratory' => [ - 'summary' => '上线实验室。', - 'path' => '/api/v1/laboratories/{LaboratoryId}/action/online', - 'methods' => [ - 'post', - ], - 'schemes' => [ - 'http', - 'https', - ], + 'DeployTrafficControlTaskCode' => [ + 'summary' => 'Deploys Flink code for a traffic control task in a specified environment.', + 'path' => '/api/v1/trafficcontroltasks/{TrafficControlTaskId}/action/deploycode', + 'methods' => ['post'], + 'schemes' => ['https'], 'security' => [ [ 'AK' => [], ], ], - 'consumes' => [ - 'application/json', - ], - 'produces' => [ - 'application/json', - ], + 'consumes' => ['application/json'], + 'produces' => ['application/json'], 'operationType' => 'readAndWrite', 'deprecated' => false, 'systemTags' => [ 'operationType' => 'none', 'riskType' => 'none', 'chargeType' => 'free', - 'abilityTreeNodes' => [ - 'FEATURElearnN0NAWV', - ], + 'abilityTreeNodes' => ['FEATURElearnN0NAWV'], ], 'parameters' => [ [ - 'name' => 'LaboratoryId', - 'in' => 'path', - 'schema' => [ - 'title' => '实验室ID。', - 'description' => '', - 'type' => 'string', - 'required' => true, - 'example' => '3', - ], - ], - [ 'name' => 'body', 'in' => 'body', 'style' => 'json', 'schema' => [ - 'description' => '', + 'description' => 'The request body.', 'type' => 'object', 'properties' => [ - 'InstanceId' => [ - 'title' => '实例ID。', - 'description' => '', - 'type' => 'string', - 'required' => true, - 'example' => 'pairec-test1', - ], + 'InstanceId' => ['description' => 'The instance ID.', 'type' => 'string', 'required' => false, 'example' => 'pairec-test1', 'title' => ''], + 'Environment' => ['description' => 'The deployment environment. Valid values: Daily (daily environment), Pre (pre-production environment), and Prod (production environment).', 'type' => 'string', 'required' => false, 'example' => 'Daily', 'title' => ''], + 'RetryDeploy' => ['description' => 'Specifies whether to automatically retry a failed deployment.', 'type' => 'boolean', 'required' => false, 'title' => '', 'example' => ''], ], 'required' => false, + 'title' => '', + 'example' => '', ], ], + [ + 'name' => 'TrafficControlTaskId', + 'in' => 'path', + 'schema' => ['description' => 'The traffic control task ID.', 'type' => 'string', 'required' => false, 'example' => '3', 'title' => ''], + ], ], 'responses' => [ 200 => [ 'schema' => [ + 'description' => 'The returned data.', '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' => '8C27790E-CCA5-56BB-BA17-646295DEC0A2', - ], + 'RequestId' => ['title' => 'Id of the request', 'description' => 'The request ID.', 'type' => 'string', 'example' => '728C5E01-ABF6-5AA8-B9FC-B3BA05DECC77'], ], + 'example' => '', ], ], ], - 'staticInfo' => [ - 'returnType' => 'synchronous', + 'staticInfo' => ['returnType' => 'synchronous'], + 'title' => 'Deploy traffic control job code', + 'description' => '## Overview'."\n" + ."\n" + .'- This API deploys Flink code for a specific traffic control task.'."\n" + ."\n" + .'- `TrafficControlTaskId` is a path parameter and requires a valid task ID.'."\n" + ."\n" + .'- `InstanceId` and `Environment` are required request body parameters that specify the instance ID and the target deployment environment.'."\n" + ."\n" + .'- The optional `RetryDeploy` parameter specifies whether to automatically retry the deployment on failure. The default value is `false`.'."\n" + ."\n" + .'- The value for `Environment` must be one of the following: Daily, Pre, or Prod.', + 'changeSet' => [], + 'flowControl' => [ + 'flowControlList' => [], + ], + 'ramActions' => [ + [ + 'operationType' => 'none', + 'ramAction' => [ + 'action' => 'pairec:DeployTrafficControlTaskCode', + 'authLevel' => 'operate', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'PAIRecService', 'resourceType' => 'All Resource', 'arn' => '*'], + ], + ], + ], ], - 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"8C27790E-CCA5-56BB-BA17-646295DEC0A2\\"\\n}","type":"json"}]', + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"728C5E01-ABF6-5AA8-B9FC-B3BA05DECC77\\"\\n}","type":"json"}]', ], - 'OfflineLaboratory' => [ - 'summary' => '下线实验室。', - 'path' => '/api/v1/laboratories/{LaboratoryId}/action/offline', - 'methods' => [ - 'post', - ], - 'schemes' => [ - 'http', - 'https', - ], + 'ExportRecallManagementTable' => [ + 'summary' => 'Exports a specified table from the recall engine to a MaxCompute project.', + 'path' => '/api/v1/recallmanagementtables/{RecallManagementTableId}/action/export', + 'methods' => ['post'], + 'schemes' => ['https'], 'security' => [ [ 'AK' => [], ], ], - 'consumes' => [ - 'application/json', - ], - 'produces' => [ - 'application/json', - ], + 'consumes' => ['application/json'], + 'produces' => ['application/json'], 'operationType' => 'readAndWrite', 'deprecated' => false, 'systemTags' => [ 'operationType' => 'none', 'riskType' => 'none', 'chargeType' => 'free', - 'abilityTreeNodes' => [ - 'FEATURElearnN0NAWV', - ], + 'abilityTreeNodes' => ['FEATURElearnN0NAWV'], ], 'parameters' => [ [ - 'name' => 'LaboratoryId', + 'name' => 'RecallManagementTableId', 'in' => 'path', - 'schema' => [ - 'title' => '实验室ID。', - 'description' => '', - 'type' => 'string', - 'required' => true, - 'example' => '3', - ], + 'schema' => ['description' => 'The ID of the table to export.', 'type' => 'string', 'required' => false, 'example' => '3', 'title' => ''], ], [ 'name' => 'body', 'in' => 'body', 'style' => 'json', 'schema' => [ - 'title' => '请求body。', - 'description' => '', 'type' => 'object', 'properties' => [ - 'InstanceId' => [ - 'title' => '实例ID。', - 'description' => '', - 'type' => 'string', - 'required' => true, - 'example' => 'pairec-cn-abcdefg1234', + 'InstanceId' => ['description' => 'The instance ID.', 'type' => 'string', 'required' => false, 'example' => 'pairec-test1', 'title' => ''], + 'MaxcomputeProjectName' => ['description' => 'The MaxCompute project name.', 'type' => 'string', 'required' => false, 'example' => 'test', 'title' => ''], + 'MaxcomputeSchema' => ['description' => 'The MaxCompute project schema.', 'type' => 'string', 'required' => false, 'example' => 'default', 'title' => ''], + 'MaxcomputeTableName' => ['description' => 'The name of the destination table in MaxCompute.', 'type' => 'string', 'required' => false, 'example' => 'table-1', 'title' => ''], + 'Partitions' => [ + 'type' => 'object', + 'additionalProperties' => ['description' => 'The value of a partition field.', 'type' => 'string', 'example' => '20260101', 'title' => ''], + 'description' => 'The table partitions to export. The value must be a JSON object where each key is a partition field and its value is the corresponding partition value.', + 'required' => false, + 'title' => '', + 'example' => '', ], + 'RecallManagementTableVersionId' => ['description' => 'The version ID of the recall management table. This parameter defaults to the current published version.', 'type' => 'string', 'example' => '20250213000000', 'title' => '', 'required' => false], ], + 'description' => 'The request body.', 'required' => false, + 'title' => '', + 'example' => '', ], ], ], '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' => '59CE7EC6-F268-5D71-9215-32922CC50D72', - ], + 'RequestId' => ['description' => 'The request ID.', 'type' => 'string', 'title' => '', 'example' => '728C5E01-ABF6-5AA8-B9FC-B3BA05DECC77'], + 'RecallManagementJobId' => ['description' => 'The export job ID. Use this ID to track the job\'s status.', 'type' => 'string', 'example' => '1', 'title' => ''], ], + 'title' => '', + 'description' => 'The response data.', + 'example' => '', ], ], ], - 'staticInfo' => [ - 'returnType' => 'synchronous', + 'staticInfo' => ['returnType' => 'synchronous'], + 'title' => 'ExportRecallManagementTable', + 'description' => '## Description'."\n" + ."\n" + .'Use this API to export a specific table from the recall engine to Alibaba Cloud MaxCompute for further data processing or analysis. Ensure the provided MaxCompute project name, schema, and table name are valid and that you have the required permissions.'."\n" + ."\n" + .'### Usage notes'."\n" + ."\n" + .'- The `Partitions` field must be a JSON object that specifies the table partitions to export.'."\n" + ."\n" + .'- The request may fail if any required parameters are missing or incorrect.'."\n" + ."\n" + .'- The export process is asynchronous and may take some time. You can use the returned job ID to track the status of the job.', + 'changeSet' => [], + 'flowControl' => [ + 'flowControlList' => [], + ], + 'ramActions' => [ + [ + 'operationType' => 'none', + 'ramAction' => [ + 'action' => 'pairec:ExportRecallManagementTable', + 'authLevel' => 'operate', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'PAIRecService', 'resourceType' => 'All Resource', 'arn' => '*'], + ], + ], + ], ], - 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"59CE7EC6-F268-5D71-9215-32922CC50D72\\"\\n}","type":"json"}]', + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"728C5E01-ABF6-5AA8-B9FC-B3BA05DECC77\\",\\n \\"RecallManagementJobId\\": \\"1\\"\\n}","type":"json"}]', ], - 'CloneLaboratory' => [ - 'summary' => '克隆实验室。', - 'path' => '/api/v1/laboratories/{LaboratoryId}/action/clone', - 'methods' => [ - 'post', - ], - 'schemes' => [ - 'http', - 'https', - ], + 'GenerateAlgorithmCustomizationScript' => [ + 'summary' => 'Generates an algorithm customization script.', + 'path' => '/api/v1/algorithmcustomizations/{AlgorithmCustomizationId}/action/generatescript', + 'methods' => ['post'], + 'schemes' => ['http', 'https'], 'security' => [ [ 'AK' => [], ], ], - 'consumes' => [ - 'application/json', - ], - 'produces' => [ - 'application/json', - ], + 'consumes' => ['application/json'], + 'produces' => ['application/json'], 'operationType' => 'readAndWrite', 'deprecated' => false, 'systemTags' => [ 'operationType' => 'none', 'riskType' => 'none', 'chargeType' => 'free', - 'abilityTreeNodes' => [ - 'FEATURElearnN0NAWV', - ], + 'abilityTreeNodes' => ['FEATURElearnN0NAWV'], ], 'parameters' => [ [ - 'name' => 'LaboratoryId', + 'name' => 'AlgorithmCustomizationId', 'in' => 'path', - 'schema' => [ - 'title' => '实验室ID。', - 'description' => '', - 'type' => 'string', - 'required' => true, - 'example' => '3', - ], + 'schema' => ['description' => 'The algorithm customization ID.', 'type' => 'string', 'required' => false, 'example' => '1', 'title' => ''], ], [ 'name' => 'body', 'in' => 'body', 'style' => 'json', 'schema' => [ - 'title' => '请求body。', - 'description' => '', + 'description' => 'The request body.', 'type' => 'object', 'properties' => [ - 'InstanceId' => [ - 'title' => '实例ID。', - 'description' => '', - 'type' => 'string', - 'required' => true, - 'example' => 'pairec-cn-abcdefg1234', - ], - 'Environment' => [ - 'title' => '运行环境'."\n" - .'● Daily-日常环境'."\n" - .'● Pre-预发环境'."\n" - .'● Prod-生产环境', - 'description' => '', - 'type' => 'string', - 'required' => true, - 'example' => 'Daily', - ], - 'CloneExperimentGroup' => [ - 'title' => '是否克隆实验组。', - 'description' => '', - 'type' => 'boolean', - 'required' => true, - 'example' => 'true', - ], + 'InstanceId' => ['description' => 'The ID of the instance. To obtain this ID, see [ListInstances](~~2411819~~).', 'type' => 'string', 'required' => false, 'example' => 'pairec-test-xxx', 'title' => ''], + 'ModuleFieldTypes' => ['description' => 'The data types of fields in the JSON configuration.', 'type' => 'object', 'required' => false, 'example' => '{"item_table":"array"}', 'title' => ''], + 'DeployMode' => ['description' => 'The deployment mode. Valid values:'."\n" + ."\n" + .'- **EasyDeploy**: Performs a one-click deployment.'."\n" + ."\n" + .'- **GenerateScript**: Generates a deployment script.', 'type' => 'string', 'required' => false, 'example' => 'EasyDeploy', 'title' => ''], ], 'required' => false, + 'title' => '', + 'example' => '', ], ], ], @@ -6926,3195 +5624,5070 @@ 200 => [ 'schema' => [ 'title' => 'Schema of Response', - 'description' => 'Schema of Response', + 'description' => 'The response object.', 'type' => 'object', 'properties' => [ - 'RequestId' => [ - 'title' => 'Id of the request', - 'description' => 'Id of the request', - 'type' => 'string', - 'example' => '01D22D08-BA20-5F35-8302-99115F288220', - ], - 'LaboratoryId' => [ - 'title' => '克隆出的实验室的ID。', - 'description' => '', - 'type' => 'string', - 'example' => '3', - ], + 'RequestId' => ['title' => 'Id of the request', 'description' => 'The request ID.', 'type' => 'string', 'example' => '6CF1E160-3F36-5E73-A170-C75504F05BBC'], + 'OssAddress' => ['description' => 'The OSS address of the generated package.', 'type' => 'string', 'example' => 'oss:xxxx', 'title' => ''], + 'LogId' => ['description' => 'The log ID.', 'type' => 'string', 'example' => '4', 'title' => ''], ], + 'example' => '', ], ], ], - 'staticInfo' => [ - 'returnType' => 'synchronous', + 'staticInfo' => ['returnType' => 'synchronous'], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"6CF1E160-3F36-5E73-A170-C75504F05BBC\\",\\n \\"OssAddress\\": \\"oss:xxxx\\",\\n \\"LogId\\": \\"4\\"\\n}","type":"json"}]', + 'title' => 'Deploy algorithm customization', + 'changeSet' => [], + 'flowControl' => [ + 'flowControlList' => [], + ], + 'ramActions' => [ + [ + 'operationType' => 'none', + 'ramAction' => [ + 'action' => 'pairec:GenerateAlgorithmCustomizationScript', + 'authLevel' => 'operate', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'PAIRecService', 'resourceType' => 'All Resource', 'arn' => '*'], + ], + ], + ], ], - 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"01D22D08-BA20-5F35-8302-99115F288220\\",\\n \\"LaboratoryId\\": \\"3\\"\\n}","type":"json"}]', ], - 'CreateLayer' => [ - 'summary' => '创建层。', - 'path' => '/api/v1/layers', - 'methods' => [ - 'post', - ], - 'schemes' => [ - 'http', - 'https', - ], + 'GenerateTrafficControlTaskCode' => [ + 'summary' => 'Generates Flink code for a specified traffic control task ID and instance information.', + 'path' => '/api/v1/trafficcontroltasks/{TrafficControlTaskId}/action/generatecode', + 'methods' => ['post'], + 'schemes' => ['http', 'https'], 'security' => [ [ 'AK' => [], ], ], - 'consumes' => [ - 'application/json', - ], - 'produces' => [ - 'application/json', - ], - 'operationType' => 'write', + 'consumes' => ['application/json'], + 'produces' => ['application/json'], + 'operationType' => 'readAndWrite', 'deprecated' => false, 'systemTags' => [ - 'operationType' => 'create', + 'operationType' => 'none', 'riskType' => 'none', 'chargeType' => 'free', - 'abilityTreeNodes' => [ - 'FEATURElearnN0NAWV', - ], + 'abilityTreeCode' => '224228', + 'abilityTreeNodes' => ['FEATURElearnN0NAWV'], ], 'parameters' => [ [ + 'name' => 'TrafficControlTaskId', + 'in' => 'path', + 'schema' => ['description' => 'The traffic control task ID.', 'type' => 'string', 'required' => true, 'example' => '7', 'title' => ''], + ], + [ 'name' => 'body', 'in' => 'body', 'style' => 'json', 'schema' => [ - 'title' => '请求body。', - 'description' => '', + 'description' => 'The request body.', 'type' => 'object', 'properties' => [ - 'LaboratoryId' => [ - 'title' => '实验室ID。', - 'description' => '', - 'type' => 'string', - 'required' => true, - 'example' => '3', - ], - 'Name' => [ - 'title' => '层名称。', - 'description' => '', - 'type' => 'string', - 'required' => true, - 'example' => 'layer1', - ], - 'Description' => [ - 'title' => '层描述。', - 'description' => '', - 'type' => 'string', - 'required' => true, - 'example' => 'This is a test.', - ], - 'InstanceId' => [ - 'title' => '实例ID。', - 'description' => '', - 'type' => 'string', - 'required' => true, - 'example' => 'pairec-cn-abcdefg1234', - ], + 'InstanceId' => ['description' => 'The instance ID.', 'type' => 'string', 'required' => true, 'example' => 'pairec-test1', 'title' => ''], + 'Environment' => ['description' => 'The environment type. Valid values: `Daily` (daily environment), `Pre` (pre-release environment), and `Prod` (production environment).', 'type' => 'string', 'required' => false, 'example' => 'Daily', 'title' => ''], ], 'required' => false, + 'title' => '', + 'example' => '', ], ], ], 'responses' => [ 200 => [ 'schema' => [ - 'title' => 'Schema of Response', - 'description' => 'Schema of Response', + 'description' => 'The response schema.', + 'title' => 'Schema of Response ', 'type' => 'object', 'properties' => [ - 'RequestId' => [ - 'title' => 'Id of the request', - 'description' => 'Id of the request', - 'type' => 'string', - 'example' => '59CE7EC6-F268-5D71-9215-32922CC50D72', - ], - 'LayerId' => [ - 'title' => '层ID。', - 'description' => '', - 'type' => 'string', - 'example' => '3', - ], + 'RequestId' => ['title' => 'Id of the request ', 'description' => 'The request ID.', 'type' => 'string', 'example' => '728C5E01-ABF6-5AA8-B9FC-B3BA05DECC77'], + 'Code' => ['description' => 'The generated Flink code.', 'type' => 'string', 'example' => 'Create Table xxx.......', 'title' => ''], + 'PreNeedConfig' => ['description' => 'Indicates whether the engine configuration for the pre-release environment is incomplete.', 'type' => 'boolean', 'example' => 'False', 'title' => ''], ], + 'example' => '', ], ], ], - 'staticInfo' => [ - 'returnType' => 'synchronous', + 'staticInfo' => ['returnType' => 'synchronous'], + 'title' => 'Generate Traffic Control Job Code ', + 'description' => '## Description'."\n" + ."\n" + .'- This API generates Flink code for a specified traffic control task ID, instance ID, and environment type.'."\n" + ."\n" + .'- The `Environment` parameter accepts three values: `Daily` for the daily environment, `Pre` for the pre-release environment, and `Prod` for the production environment.'."\n" + ."\n" + .'- Check the `PreNeedConfig` field in the response. A `true` value indicates that necessary configuration information might be missing in the pre-release environment. If this occurs, add or adjust the required settings.', + 'changeSet' => [], + 'flowControl' => [ + 'flowControlList' => [], + ], + 'ramActions' => [ + [ + 'operationType' => 'none', + 'ramAction' => [ + 'action' => 'pairec:GenerateTrafficControlTaskCode', + 'authLevel' => 'operate', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'PAIRecService', 'resourceType' => 'All Resource', 'arn' => '*'], + ], + ], + ], ], - 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"59CE7EC6-F268-5D71-9215-32922CC50D72\\",\\n \\"LayerId\\": \\"3\\"\\n}","type":"json"}]', + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"728C5E01-ABF6-5AA8-B9FC-B3BA05DECC77\\",\\n \\"Code\\": \\"Create Table xxx.......\\",\\n \\"PreNeedConfig\\": true\\n}","type":"json"}]', ], - 'DeleteLayer' => [ - 'summary' => '删除层。', - 'path' => '/api/v1/layers/{LayerId}', - 'methods' => [ - 'delete', - ], - 'schemes' => [ - 'http', - 'https', - ], + 'GetABMetric' => [ + 'path' => '/api/v1/abmetrics/{ABMetricId}', + 'methods' => ['get'], + 'schemes' => ['http', 'https'], 'security' => [ [ 'AK' => [], ], ], - 'consumes' => [ - 'application/json', - ], - 'produces' => [ - 'application/json', - ], - 'operationType' => 'write', + 'consumes' => ['application/json'], + 'produces' => ['application/json'], + 'operationType' => 'read', 'deprecated' => false, 'systemTags' => [ - 'operationType' => 'delete', + 'operationType' => 'get', 'riskType' => 'none', 'chargeType' => 'free', - 'abilityTreeNodes' => [ - 'FEATURElearnN0NAWV', - ], + 'abilityTreeNodes' => ['FEATURElearnN0NAWV'], ], 'parameters' => [ [ - 'name' => 'LayerId', + 'name' => 'ABMetricId', 'in' => 'path', - 'schema' => [ - 'title' => '层ID。', - 'description' => '', - 'type' => 'string', - 'required' => false, - 'example' => '3', - ], + 'schema' => ['description' => 'The A/B metric ID.', 'type' => 'string', 'required' => true, 'example' => '1', 'title' => ''], ], [ 'name' => 'InstanceId', 'in' => 'query', - 'schema' => [ - 'title' => '实例ID。', - 'description' => '', - 'type' => 'string', - 'required' => false, - 'example' => 'pairec-cn-abcdefg1234', - ], + 'schema' => ['description' => 'The instance ID. To get this ID, call the [ListInstances](~~2411819~~) operation.', 'type' => 'string', 'required' => true, 'example' => 'pairec-cn-test1', 'title' => ''], ], ], 'responses' => [ 200 => [ 'schema' => [ 'title' => 'Schema of Response', - 'description' => 'Schema of Response', + 'description' => 'The response object.', 'type' => 'object', 'properties' => [ - 'RequestId' => [ - 'title' => 'Id of the request', - 'description' => 'Id of the request', - 'type' => 'string', - 'example' => '8F457D79-C4A2-5E8C-83E4-0D089456E2AC', - ], + 'RequestId' => ['title' => 'Id of the request', 'description' => 'The request ID.', 'type' => 'string', 'example' => '728C5E01-ABF6-5AA8-B9FC-B3BA05DECC77'], + 'Name' => ['description' => 'The metric name.', 'type' => 'string', 'example' => 'pv', 'title' => ''], + 'Description' => ['description' => 'The metric description.', 'type' => 'string', 'example' => '页面访问次数', 'title' => ''], + 'SceneId' => ['description' => 'The scene ID.', 'type' => 'string', 'example' => '1', 'title' => ''], + 'SceneName' => ['description' => 'The scene name.', 'type' => 'string', 'example' => 'home_feed', 'title' => ''], + 'Type' => ['description' => 'The type of the metric. Valid values:'."\n" + ."\n" + .'- `Single`: a single metric.'."\n" + ."\n" + .'- `Derived`: a derived metric.', 'type' => 'string', 'example' => 'Single', 'title' => ''], + 'Realtime' => ['description' => 'Specifies whether the metric is real-time. Valid values:'."\n" + ."\n" + .'- `true`: The metric is real-time.'."\n" + ."\n" + .'- `false`: The metric is not real-time.', 'type' => 'string', 'example' => 'false', 'title' => ''], + 'TableMetaId' => ['description' => 'The ID of the source table.', 'type' => 'string', 'example' => '2', 'title' => ''], + 'ResultTableMetaId' => ['description' => 'The ID of the results table.', 'type' => 'string', 'example' => '3', 'title' => ''], + 'ResultResourceId' => ['description' => 'The ID of the data source for the results table.', 'type' => 'string', 'example' => '5', 'title' => ''], + 'Definition' => ['description' => 'The metric definition.', 'type' => 'string', 'example' => 'sum(click_cnt)', 'title' => ''], + 'StatisticsCycle' => ['description' => 'The statistics cycle.', 'type' => 'integer', 'format' => 'int32', 'example' => '1', 'title' => ''], + 'LeftMetricId' => ['description' => 'The ID of the left operand metric for a derived metric.', 'type' => 'string', 'example' => '3', 'title' => ''], + 'RightMetricId' => ['description' => 'The ID of the right operand metric for a derived metric.', 'type' => 'string', 'example' => '2', 'title' => ''], + 'Operator' => ['description' => 'The operator for the derived metric. Valid values:'."\n" + ."\n" + .'- `Plus`: addition'."\n" + ."\n" + .'- `Minus`: subtraction'."\n" + ."\n" + .'- `Multiplication`: multiplication'."\n" + ."\n" + .'- `Division`: division', 'type' => 'string', 'example' => 'Division', 'title' => ''], + 'NeedSignificance' => ['description' => 'Specifies whether significance testing is required for this metric.', 'type' => 'boolean', 'title' => '', 'example' => ''], + 'AggregationByUser' => ['description' => 'Specifies whether to aggregate metrics by user.', 'type' => 'boolean', 'title' => '', 'example' => ''], + 'Numerator' => ['description' => 'The numerator of the derived metric formula.', 'type' => 'string', 'example' => 'click', 'title' => ''], + 'Denominator' => ['description' => 'The denominator of the derived metric formula.', 'type' => 'string', 'example' => 'pv', 'title' => ''], + 'IsBinomialDistribution' => ['description' => 'Specifies whether the metric follows a binomial distribution. This affects how significance is calculated.', 'type' => 'boolean', 'title' => '', 'example' => ''], ], + 'example' => '', ], ], ], - 'staticInfo' => [ - 'returnType' => 'synchronous', + 'staticInfo' => ['returnType' => 'synchronous'], + 'title' => 'Obtain AB Metric Details', + 'summary' => 'Gets the details of an A/B metric.', + 'changeSet' => [ + ['createdAt' => '2024-02-22T03:35:42.000Z', 'description' => 'Request parameters changed'], ], - 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"8F457D79-C4A2-5E8C-83E4-0D089456E2AC\\"\\n}","type":"json"}]', - ], - 'UpdateLayer' => [ - 'summary' => '更新层。', - 'path' => '/api/v1/layers/{LayerId}', - 'methods' => [ - 'put', + 'flowControl' => [ + 'flowControlList' => [], ], - 'schemes' => [ - 'http', - 'https', + 'ramActions' => [ + [ + 'operationType' => 'get', + 'ramAction' => [ + 'action' => 'pairec:GetABMetric', + 'authLevel' => 'operate', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'PAIRecService', 'resourceType' => 'All Resource', 'arn' => '*'], + ], + ], + ], ], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"728C5E01-ABF6-5AA8-B9FC-B3BA05DECC77\\",\\n \\"Name\\": \\"pv\\",\\n \\"Description\\": \\"页面访问次数\\",\\n \\"SceneId\\": \\"1\\",\\n \\"SceneName\\": \\"home_feed\\",\\n \\"Type\\": \\"Single\\",\\n \\"Realtime\\": \\"false\\",\\n \\"TableMetaId\\": \\"2\\",\\n \\"ResultTableMetaId\\": \\"3\\",\\n \\"ResultResourceId\\": \\"5\\",\\n \\"Definition\\": \\"sum(click_cnt)\\",\\n \\"StatisticsCycle\\": 1,\\n \\"LeftMetricId\\": \\"3\\",\\n \\"RightMetricId\\": \\"2\\",\\n \\"Operator\\": \\"Division\\",\\n \\"NeedSignificance\\": false,\\n \\"AggregationByUser\\": false,\\n \\"Numerator\\": \\"click\\",\\n \\"Denominator\\": \\"pv\\",\\n \\"IsBinomialDistribution\\": false\\n}","type":"json"}]', + ], + 'GetABMetricGroup' => [ + 'summary' => 'Retrieves the details of an A/B testing metric group.', + 'path' => '/api/v1/abmetricgroups/{ABMetricGroupId}', + 'methods' => ['get'], + 'schemes' => ['http', 'https'], 'security' => [ [ 'AK' => [], ], ], - 'consumes' => [ - 'application/json', - ], - 'produces' => [ - 'application/json', - ], - 'operationType' => 'readAndWrite', + 'consumes' => ['application/json'], + 'produces' => ['application/json'], + 'operationType' => 'read', 'deprecated' => false, 'systemTags' => [ - 'operationType' => 'update', + 'operationType' => 'get', 'riskType' => 'none', 'chargeType' => 'free', - 'abilityTreeNodes' => [ - 'FEATURElearnN0NAWV', - ], + 'abilityTreeNodes' => ['FEATURElearnN0NAWV'], ], 'parameters' => [ [ - 'name' => 'LayerId', + 'name' => 'ABMetricGroupId', 'in' => 'path', - 'schema' => [ - 'description' => '', - 'type' => 'string', - 'required' => true, - 'example' => '3', - ], + 'schema' => ['description' => 'The metric group ID.', 'type' => 'string', 'required' => true, 'example' => '1', 'title' => ''], ], [ - 'name' => 'body', - 'in' => 'body', - 'style' => 'json', - 'schema' => [ - 'title' => '请求body。', - 'description' => '', - 'type' => 'object', - 'properties' => [ - 'InstanceId' => [ - 'title' => '实例ID。', - 'description' => '', - 'type' => 'string', - 'required' => true, - 'example' => 'pairec-test1', - ], - 'Name' => [ - 'title' => '层名称。', - 'description' => '', - 'type' => 'string', - 'required' => true, - 'example' => 'layer1', - ], - 'Description' => [ - 'title' => '层描述。', - 'description' => '', - 'type' => 'string', - 'required' => true, - 'example' => 'This is a test.', - ], - ], - 'required' => false, - ], + 'name' => 'InstanceId', + 'in' => 'query', + 'schema' => ['description' => 'The instance ID. You can get this ID by calling the [ListInstances](~~2411819~~) operation.', 'type' => 'string', 'required' => true, 'example' => 'pairec-cn-test1', 'title' => ''], ], ], 'responses' => [ 200 => [ 'schema' => [ 'title' => 'Schema of Response', - 'description' => 'Schema of Response', + 'description' => 'The data returned for the request.', 'type' => 'object', 'properties' => [ - 'RequestId' => [ - 'title' => 'Id of the request', - 'description' => 'Id of the request', - 'type' => 'string', - 'example' => '0EA9215E-EC21-53AB-B8D9-D3DEA90D040A', - ], + 'RequestId' => ['title' => 'Id of the request', 'description' => 'The request ID.', 'type' => 'string', 'example' => '01D22D08-BA20-5F35-8302-99115F288220'], + 'Name' => ['description' => 'The metric group name.', 'type' => 'string', 'example' => 'visits', 'title' => ''], + 'SceneId' => ['description' => 'The scene ID. You can get this ID by calling the [ListScenes](https://icms.alibaba-inc.com/content/learn/pai?l=1\\&m=16768\\&n=4298955) operation.', 'type' => 'string', 'example' => '1', 'title' => ''], + 'Description' => ['description' => 'The metric group description.', 'type' => 'string', 'example' => '访问量相关指标', 'title' => ''], + 'Owner' => ['description' => 'The owner.', 'type' => 'string', 'example' => '2799614***'."\n", 'title' => ''], + 'ABMetricIds' => ['description' => 'A comma-separated list of A/B testing metric IDs.', 'type' => 'string', 'example' => '1,2', 'title' => ''], + 'ABMetricNames' => ['description' => 'A comma-separated list of A/B testing metric names.', 'type' => 'string', 'example' => 'pv,uv', 'title' => ''], + 'Realtime' => ['description' => 'Whether the metric group is a real-time metric group.', 'type' => 'boolean', 'example' => 'false', 'title' => ''], ], + 'example' => '', ], ], ], - 'staticInfo' => [ - 'returnType' => 'synchronous', + 'staticInfo' => ['returnType' => 'synchronous'], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"01D22D08-BA20-5F35-8302-99115F288220\\",\\n \\"Name\\": \\"visits\\",\\n \\"SceneId\\": \\"1\\",\\n \\"Description\\": \\"访问量相关指标\\",\\n \\"Owner\\": \\"2799614***\\\\n\\",\\n \\"ABMetricIds\\": \\"1,2\\",\\n \\"ABMetricNames\\": \\"pv,uv\\",\\n \\"Realtime\\": false\\n}","type":"json"}]', + 'title' => 'Retrieve Metric Group Details', + 'changeSet' => [ + ['createdAt' => '2024-02-22T03:35:41.000Z', 'description' => 'Request parameters changed'], + ], + 'flowControl' => [ + 'flowControlList' => [], + ], + 'ramActions' => [ + [ + 'operationType' => 'get', + 'ramAction' => [ + 'action' => 'pairec:GetABMetricGroup', + 'authLevel' => 'operate', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'PAIRecService', 'resourceType' => 'All Resource', 'arn' => '*'], + ], + ], + ], ], - 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"0EA9215E-EC21-53AB-B8D9-D3DEA90D040A\\"\\n}","type":"json"}]', ], - 'ListLayers' => [ - 'summary' => '获取层列表。', - 'path' => '/api/v1/layers', - 'methods' => [ - 'get', - ], - 'schemes' => [ - 'http', - 'https', - ], + 'GetCalculationJob' => [ + 'summary' => 'Gets the details of a specified calculation job.', + 'path' => '/api/v1/calculationjobs/{CalculationJobId}', + 'methods' => ['get'], + 'schemes' => ['http', 'https'], 'security' => [ [ 'AK' => [], ], ], - 'consumes' => [ - 'application/json', - ], - 'produces' => [ - 'application/json', - ], + 'consumes' => ['application/json'], + 'produces' => ['application/json'], 'operationType' => 'read', 'deprecated' => false, 'systemTags' => [ - 'operationType' => 'list', + 'operationType' => 'get', 'riskType' => 'none', 'chargeType' => 'free', - 'abilityTreeCode' => '183174', - 'abilityTreeNodes' => [ - 'FEATURElearnN0NAWV', - ], + 'abilityTreeNodes' => ['FEATURElearnN0NAWV'], ], 'parameters' => [ [ - 'name' => 'LaboratoryId', - 'in' => 'query', - 'schema' => [ - 'title' => '实验室ID。', - 'description' => '', - 'type' => 'string', - 'required' => true, - 'example' => '3', - ], + 'name' => 'CalculationJobId', + 'in' => 'path', + 'schema' => ['description' => 'The ID of the calculation job.', 'type' => 'string', 'required' => true, 'example' => '1', 'title' => ''], ], [ 'name' => 'InstanceId', 'in' => 'query', - 'schema' => [ - 'title' => '实例ID。', - 'description' => '', - 'type' => 'string', - 'required' => true, - 'example' => 'pairec-cn-abcdefg1234', - ], + 'schema' => ['description' => 'The ID of the instance. Call the [ListInstances](~~2411819~~) operation to obtain this ID.', 'type' => 'string', 'required' => true, 'example' => 'pairec-cn-test1', 'title' => ''], ], ], 'responses' => [ 200 => [ 'schema' => [ 'title' => 'Schema of Response', - 'description' => 'Schema of Response', + 'description' => 'The response schema.', 'type' => 'object', 'properties' => [ - 'RequestId' => [ - 'title' => 'Id of the request', - 'description' => 'Id of the request', - 'type' => 'string', - 'example' => '518C64F6-DFF7-11ED-85B0-00163E14B3D1', - ], - 'TotalCount' => [ - 'title' => '列表内元素总数。', - 'description' => '', - 'type' => 'integer', - 'format' => 'int64', - 'example' => '10', - ], - 'Layers' => [ - 'title' => '层列表。', - 'description' => '', + 'RequestId' => ['title' => 'Id of the request', 'description' => 'The request ID.', 'type' => 'string', 'example' => '7D59453C-48AA-5FC5-8848-2D373BD1A17F'], + 'ABMetricId' => ['description' => 'The ID of the AB metric.', 'type' => 'string', 'example' => '1', 'title' => ''], + 'ABMetricName' => ['description' => 'The name of the AB metric.', 'type' => 'string', 'example' => 'pv', 'title' => ''], + 'Status' => ['description' => 'The status of the calculation job. Valid values:'."\n" + ."\n" + .'- Success: The job completed successfully.'."\n" + ."\n" + .'- Failure: The job failed.'."\n" + ."\n" + .'- Initializing: The job is initializing.'."\n" + ."\n" + .'- Running: The job is running.', 'type' => 'string', 'example' => 'Success', 'title' => ''], + 'JobMessage' => [ + 'description' => 'The job messages.', 'type' => 'array', - 'items' => [ - 'type' => 'object', - 'properties' => [ - 'LayerId' => [ - 'title' => '层ID。', - 'description' => '', - 'type' => 'string', - 'example' => '3', - ], - 'LaboratoryId' => [ - 'title' => '实验室ID。', - 'description' => '', - 'type' => 'string', - 'example' => '3', - ], - 'SceneId' => [ - 'title' => '场景ID。', - 'description' => '', - 'type' => 'string', - 'example' => '3', - ], - 'Name' => [ - 'title' => '层名称。', - 'description' => '', - 'type' => 'string', - 'example' => 'layer1', - ], - 'Description' => [ - 'title' => '层描述。', - 'description' => '', - 'type' => 'string', - 'example' => 'This is a test.', - ], - 'ResidualFlow' => [ - 'type' => 'integer', - 'format' => 'int64', - ], - 'GmtCreateTime' => [ - 'type' => 'string', - ], - ], - ], + 'items' => ['description' => 'A job message.', 'type' => 'string', 'example' => 'success', 'title' => ''], + 'title' => '', + 'example' => '', ], + 'Config' => ['description' => 'The job configuration.', 'type' => 'string', 'example' => '{}', 'title' => ''], + 'GmtRanTime' => ['description' => 'The runtime of the job.', 'type' => 'string', 'example' => '2021-12-15T23:24:33.132+08:00', 'title' => ''], + 'BizDate' => ['description' => 'The business date.', 'type' => 'string', 'example' => '2021-12-15', 'title' => ''], + 'JobSource' => ['description' => 'The job source. Valid values:'."\n" + ."\n" + .'- CronOffline: An offline cron job.'."\n" + ."\n" + .'- DataRerun: A data rerun task.', 'type' => 'string', 'example' => 'CronOffline', 'title' => ''], ], + 'example' => '', ], ], ], - 'staticInfo' => [ - 'returnType' => 'synchronous', + 'staticInfo' => ['returnType' => 'synchronous'], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"7D59453C-48AA-5FC5-8848-2D373BD1A17F\\",\\n \\"ABMetricId\\": \\"1\\",\\n \\"ABMetricName\\": \\"pv\\",\\n \\"Status\\": \\"Success\\",\\n \\"JobMessage\\": [\\n \\"success\\"\\n ],\\n \\"Config\\": \\"{}\\",\\n \\"GmtRanTime\\": \\"2021-12-15T23:24:33.132+08:00\\",\\n \\"BizDate\\": \\"2021-12-15\\",\\n \\"JobSource\\": \\"CronOffline\\"\\n}","type":"json"}]', + 'title' => 'Obtain Script Task', + 'changeSet' => [ + ['createdAt' => '2024-02-22T03:35:40.000Z', 'description' => 'Request parameters changed'], + ], + 'flowControl' => [ + 'flowControlList' => [], + ], + 'ramActions' => [ + [ + 'operationType' => 'get', + 'ramAction' => [ + 'action' => 'pairec:GetCalculationJob', + 'authLevel' => 'operate', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'PAIRecService', 'resourceType' => 'All Resource', 'arn' => '*'], + ], + ], + ], ], - 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"518C64F6-DFF7-11ED-85B0-00163E14B3D1\\",\\n \\"TotalCount\\": 10,\\n \\"Layers\\": [\\n {\\n \\"LayerId\\": \\"3\\",\\n \\"LaboratoryId\\": \\"3\\",\\n \\"SceneId\\": \\"3\\",\\n \\"Name\\": \\"layer1\\",\\n \\"Description\\": \\"This is a test.\\",\\n \\"ResidualFlow\\": 10,\\n \\"GmtCreateTime\\": \\"2024-05-30T02:02:28.000Z\\"\\n }\\n ]\\n}","type":"json"}]', ], - 'GetLayer' => [ - 'summary' => '获取层详细信息。', - 'path' => '/api/v1/layers/{LayerId}', - 'methods' => [ - 'get', - ], - 'schemes' => [ - 'http', - 'https', - ], + 'GetDataDiagnosis' => [ + 'summary' => 'Retrieves details of a data diagnosis task using its data diagnosis task ID and instance ID.', + 'path' => '/api/v1/datadiagnoses/{DataDiagnosisId}', + 'methods' => ['get'], + 'schemes' => ['http', 'https'], 'security' => [ [ 'AK' => [], ], ], - 'consumes' => [ - 'application/json', + 'consumes' => ['application/json'], + 'produces' => ['application/json'], + 'operationType' => 'readAndWrite', + 'deprecated' => false, + 'systemTags' => ['operationType' => 'get', 'riskType' => 'none', 'chargeType' => 'free'], + 'parameters' => [ + [ + 'name' => 'DataDiagnosisId', + 'in' => 'path', + 'schema' => ['description' => 'The configuration ID of the data diagnosis task.', 'type' => 'string', 'required' => true, 'example' => '3', 'title' => ''], + ], + [ + 'name' => 'InstanceId', + 'in' => 'query', + 'schema' => ['description' => 'The instance ID.', 'type' => 'string', 'required' => true, 'example' => 'learn-pairec-xxx', 'title' => ''], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'description' => 'The response data.', + 'title' => 'Schema of Response', + 'type' => 'object', + 'properties' => [ + 'RequestId' => ['title' => 'Id of the request', 'description' => 'The request ID.', 'type' => 'string', 'example' => '728C5E01-ABF6-5AA8-B9FC-B3BA05DECC77'], + 'Name' => ['description' => 'The name of the data diagnosis task.', 'type' => 'string', 'example' => 'data_diagnosis_job1', 'title' => ''], + 'Type' => ['description' => 'The type of the data diagnosis task.', 'type' => 'string', 'example' => 'ChangeRate', 'title' => ''], + 'TableMetaId' => ['description' => 'The ID of the data table.', 'type' => 'string', 'example' => '3', 'title' => ''], + 'TableMetaName' => ['description' => 'The name of the data table.', 'type' => 'string', 'example' => 'table_meta_1', 'title' => ''], + 'LeftTableMetaId' => ['description' => 'The ID of the left data table.', 'type' => 'string', 'example' => '4', 'title' => ''], + 'RightTableMetaId' => ['description' => 'The ID of the right data table.', 'type' => 'string', 'example' => '5', 'title' => ''], + 'PartitionField' => ['description' => 'The partition field.', 'type' => 'string', 'example' => 'dt', 'title' => ''], + 'LeftTablePartitionField' => ['description' => 'The partition field of the left data table.', 'type' => 'string', 'example' => 'dt', 'title' => ''], + 'RightTablePartitionField' => ['description' => 'The partition field of the right data table.', 'type' => 'string', 'example' => 'dt', 'title' => ''], + 'Config' => ['description' => 'The configuration of the data diagnosis task.', 'type' => 'string', 'example' => '{"AnalysisField":"userid","PartitionFieldFormat":"yyyymmdd"}', 'title' => ''], + 'CycleTime' => ['description' => 'The time for periodic execution. If this field is empty, the task does not execute periodically.', 'type' => 'string', 'example' => '08:00', 'title' => ''], + 'TopNQuantity' => ['description' => 'The Top-N quantity.', 'type' => 'integer', 'format' => 'int64', 'example' => '10', 'title' => ''], + 'GmtCreateTime' => ['description' => 'The creation time.', 'type' => 'string', 'example' => '2021-12-15T23:24:33.132+08:00', 'title' => ''], + 'GmtModifiedTime' => ['description' => 'The modification time.', 'type' => 'string', 'example' => '2021-12-15T23:24:33.132+08:00', 'title' => ''], + ], + 'example' => '', + ], + ], + ], + 'staticInfo' => ['returnType' => 'synchronous'], + 'title' => 'Obtain data diagnosis details', + 'description' => '## Request'."\n" + ."\n" + .'- This API retrieves the details of a specific data diagnosis task using the provided `DataDiagnosisId` (data diagnosis task configuration ID) and `InstanceId` (instance ID).'."\n" + ."\n" + .'- The `CycleTime` field specifies the time for periodic execution. If this field is empty, the task does not execute periodically.'."\n" + ."\n" + .'- The value of `Type` determines the content of the `Config` field. For details about the required configuration for each type, see the relevant documentation.'."\n" + ."\n" + .'- `GmtCreateTime` and `GmtModifiedTime` are timestamps for the record\'s creation and modification times, respectively.', + 'changeSet' => [], + 'flowControl' => [ + 'flowControlList' => [], + ], + 'ramActions' => [ + [ + 'operationType' => 'get', + 'ramAction' => [ + 'action' => 'pairec:GetDataDiagnosis', + 'authLevel' => 'operate', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'PAIRecService', 'resourceType' => 'All Resource', 'arn' => '*'], + ], + ], + ], ], - 'produces' => [ - 'application/json', + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"728C5E01-ABF6-5AA8-B9FC-B3BA05DECC77\\",\\n \\"Name\\": \\"data_diagnosis_job1\\",\\n \\"Type\\": \\"ChangeRate\\",\\n \\"TableMetaId\\": \\"3\\",\\n \\"TableMetaName\\": \\"table_meta_1\\",\\n \\"LeftTableMetaId\\": \\"4\\",\\n \\"RightTableMetaId\\": \\"5\\",\\n \\"PartitionField\\": \\"dt\\",\\n \\"LeftTablePartitionField\\": \\"dt\\",\\n \\"RightTablePartitionField\\": \\"dt\\",\\n \\"Config\\": \\"{\\\\\\"AnalysisField\\\\\\":\\\\\\"userid\\\\\\",\\\\\\"PartitionFieldFormat\\\\\\":\\\\\\"yyyymmdd\\\\\\"}\\",\\n \\"CycleTime\\": \\"08:00\\",\\n \\"TopNQuantity\\": 10,\\n \\"GmtCreateTime\\": \\"2021-12-15T23:24:33.132+08:00\\",\\n \\"GmtModifiedTime\\": \\"2021-12-15T23:24:33.132+08:00\\"\\n}","type":"json"}]', + ], + 'GetEngineConfig' => [ + 'summary' => 'Gets the details of an engine configuration.', + 'path' => '/api/v1/engineconfigs/{EngineConfigId}', + 'methods' => ['get'], + 'schemes' => ['http', 'https'], + 'security' => [ + [ + 'AK' => [], + ], ], + 'consumes' => ['application/json'], + 'produces' => ['application/json'], 'operationType' => 'read', 'deprecated' => false, 'systemTags' => [ 'operationType' => 'get', 'riskType' => 'none', 'chargeType' => 'free', - 'abilityTreeCode' => '183176', - 'abilityTreeNodes' => [ - 'FEATURElearnN0NAWV', - ], + 'abilityTreeCode' => '180249', + 'abilityTreeNodes' => ['FEATURElearnN0NAWV'], ], 'parameters' => [ [ - 'name' => 'LayerId', + 'name' => 'EngineConfigId', 'in' => 'path', - 'schema' => [ - 'title' => '层ID。', - 'description' => '', - 'type' => 'string', - 'required' => true, - 'example' => '3', - ], + 'schema' => ['description' => 'The engine configuration ID.', 'type' => 'string', 'required' => false, 'example' => '9', 'title' => ''], ], [ 'name' => 'InstanceId', 'in' => 'query', - 'schema' => [ - 'title' => '实例ID。', - 'description' => '', - 'type' => 'string', - 'required' => true, - 'example' => 'pairec-cn-abcdefg1234', - ], + 'schema' => ['description' => 'The instance ID. Call the [ListInstances](~~2411819~~) operation to obtain this ID.', 'type' => 'string', 'required' => false, 'example' => 'pairec-cn-***test', 'title' => ''], ], ], 'responses' => [ 200 => [ 'schema' => [ 'title' => 'Schema of Response', - 'description' => 'Schema of Response', + 'description' => 'The response body.', 'type' => 'object', 'properties' => [ - 'RequestId' => [ - 'title' => 'Id of the request', - 'description' => 'Id of the request', - 'type' => 'string', - 'example' => 'EE97D06A-2AA0-5AD9-B6CF-8A267924D691', - ], - 'LaboratoryId' => [ - 'title' => '实验室ID。', - 'description' => '', - 'type' => 'string', - 'example' => '3', - ], - 'SceneId' => [ - 'title' => '场景ID。', - 'description' => '', - 'type' => 'string', - 'example' => '4', - ], - 'Name' => [ - 'title' => '层名称。', - 'description' => '', - 'type' => 'string', - 'example' => 'layer1', - ], - 'Description' => [ - 'title' => '层描述。', - 'description' => '', - 'type' => 'string', - 'example' => 'This is a test.', - ], - 'ResidualFlow' => [ - 'type' => 'integer', - 'format' => 'int64', - ], - 'GmtCreateTime' => [ - 'type' => 'string', - ], + 'RequestId' => ['title' => 'Id of the request', 'description' => 'The request ID.', 'type' => 'string', 'example' => '59CE7EC6-F268-5D71-9215-32922CC50D72'], + 'Name' => ['description' => 'The engine configuration name.', 'type' => 'string', 'example' => 'engine_config_v1', 'title' => ''], + 'ConfigValue' => ['description' => 'The content of the engine configuration.', 'type' => 'string', 'example' => '{}', 'title' => ''], + 'Environment' => ['description' => 'The environment. Valid values:'."\n" + ."\n" + .'- Daily: The daily environment.'."\n" + ."\n" + .'- Pre: The pre-production environment.'."\n" + ."\n" + .'- Prod: The production environment.', 'type' => 'string', 'example' => 'Pre', 'title' => ''], + 'Status' => ['description' => 'The status. Valid values:'."\n" + ."\n" + .'- Released: Published'."\n" + ."\n" + .'- UnReleased: Unpublished', 'type' => 'string', 'example' => 'Released', 'title' => ''], + 'GmtCreateTime' => ['description' => 'The time the engine configuration was created.', 'type' => 'string', 'example' => '2024-01-03T02:28:00.000Z', 'title' => ''], + 'GmtModifiedTime' => ['description' => 'The time the engine configuration was last modified.', 'type' => 'string', 'example' => '2024-08-27T12:00:00Z', 'title' => ''], + 'GmtReleasedTime' => ['description' => 'The time the engine configuration was published.', 'type' => 'string', 'example' => '2024-01-03 02:28:00', 'title' => ''], + 'Description' => ['description' => 'The description of the engine configuration.', 'type' => 'string', 'title' => '', 'example' => ''], ], + 'example' => '', ], ], ], - 'staticInfo' => [ - 'returnType' => 'synchronous', + 'staticInfo' => ['returnType' => 'synchronous'], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"59CE7EC6-F268-5D71-9215-32922CC50D72\\",\\n \\"Name\\": \\"engine_config_v1\\",\\n \\"ConfigValue\\": \\"{}\\",\\n \\"Environment\\": \\"Pre\\",\\n \\"Status\\": \\"Released\\",\\n \\"GmtCreateTime\\": \\"2024-01-03T02:28:00.000Z\\",\\n \\"GmtModifiedTime\\": \\"2024-08-27T12:00:00Z\\",\\n \\"GmtReleasedTime\\": \\"2024-01-03 02:28:00\\",\\n \\"Description\\": \\"\\"\\n}","type":"json"}]', + 'title' => 'Retrieve the details of an engine configuration', + 'changeSet' => [ + ['createdAt' => '2024-12-27T08:56:39.000Z', 'description' => 'Response parameters changed'], + ], + 'flowControl' => [ + 'flowControlList' => [], + ], + 'ramActions' => [ + [ + 'operationType' => 'get', + 'ramAction' => [ + 'action' => 'pairec:GetEngineConfig', + 'authLevel' => 'operate', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'PAIRecService', 'resourceType' => 'All Resource', 'arn' => '*'], + ], + ], + ], ], - 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"EE97D06A-2AA0-5AD9-B6CF-8A267924D691\\",\\n \\"LaboratoryId\\": \\"3\\",\\n \\"SceneId\\": \\"4\\",\\n \\"Name\\": \\"layer1\\",\\n \\"Description\\": \\"This is a test.\\",\\n \\"ResidualFlow\\": 10,\\n \\"GmtCreateTime\\": \\"2022-10-13 17:34:52.0\\"\\n}","type":"json"}]', ], - 'CreateExperimentGroup' => [ - 'summary' => '创建实验组。', - 'path' => '/api/v1/experimentgroups', - 'methods' => [ - 'post', - ], - 'schemes' => [ - 'http', - 'https', - ], + 'GetExperiment' => [ + 'summary' => 'Retrieves the details of a specified experiment.', + 'path' => '/api/v1/experiments/{ExperimentId}', + 'methods' => ['get'], + 'schemes' => ['http', 'https'], 'security' => [ [ 'AK' => [], ], ], - 'consumes' => [ - 'application/json', - ], - 'produces' => [ - 'application/json', - ], - 'operationType' => 'readAndWrite', + 'consumes' => ['application/json'], + 'produces' => ['application/json'], + 'operationType' => 'read', 'deprecated' => false, 'systemTags' => [ - 'operationType' => 'create', + 'operationType' => 'get', 'riskType' => 'none', 'chargeType' => 'free', - 'abilityTreeCode' => '183389', - 'abilityTreeNodes' => [ - 'FEATURElearnN0NAWV', - ], + 'abilityTreeNodes' => ['FEATURElearnN0NAWV'], ], 'parameters' => [ [ - 'name' => 'body', - 'in' => 'body', - 'style' => 'json', + 'name' => 'ExperimentId', + 'in' => 'path', + 'schema' => ['description' => 'The experiment ID. You can obtain this ID by calling the ListExperiments operation.', 'type' => 'string', 'required' => true, 'example' => '3', 'title' => ''], + ], + [ + 'name' => 'InstanceId', + 'in' => 'query', + 'schema' => ['description' => 'The instance ID. You can obtain this ID by calling the ListInstances operation.', 'type' => 'string', 'required' => true, 'example' => 'pairec-cn-abcdefg1234', 'title' => ''], + ], + ], + 'responses' => [ + 200 => [ 'schema' => [ - 'title' => '请求body。', - 'description' => '', + 'title' => 'Schema of Response', + 'description' => 'The response parameters.', 'type' => 'object', 'properties' => [ - 'LayerId' => [ - 'title' => '层ID。', - 'description' => '', - 'type' => 'string', - 'required' => true, - 'example' => '3', - ], - 'Name' => [ - 'title' => '实验组名称。', - 'description' => '', - 'type' => 'string', - 'required' => true, - 'example' => 'experiment_group_test', - ], - 'Description' => [ - 'title' => '实验组描述。', - 'description' => '', - 'type' => 'string', - 'required' => false, - 'example' => 'This is a test.', - ], - 'DebugUsers' => [ - 'title' => '调试用户。', - 'description' => '', - 'type' => 'string', - 'required' => false, - 'example' => '1124512470******,1124512471******,1124512472******', - ], - 'DebugCrowdId' => [ - 'title' => '调试人群ID。', - 'description' => '', - 'type' => 'string', - 'required' => false, - 'example' => '3', - ], - 'NeedAA' => [ - 'title' => '是否需要AA实验组。', - 'description' => '', - 'type' => 'boolean', - 'required' => true, - 'example' => 'true', - ], - 'Filter' => [ - 'title' => '人群定向指定的过滤条件。', - 'description' => '', - 'type' => 'string', - 'required' => false, - 'example' => 'gender=male', - ], - 'CrowdId' => [ - 'title' => '人群定向的指定人群ID。', - 'description' => '', - 'type' => 'string', - 'required' => false, - 'example' => '1', - ], - 'DistributionType' => [ - 'title' => '分流方式。'."\n" - .'● UserId-用户ID'."\n" - .'● TimeDuration-时段', - 'description' => '', - 'type' => 'string', - 'required' => false, - 'example' => 'UserId', - ], - 'DistributionTimeDuration' => [ - 'title' => '分流时段。', - 'description' => '', - 'type' => 'integer', - 'format' => 'int32', - 'required' => false, - 'example' => '3', - ], - 'Config' => [ - 'title' => '实验组配置。', - 'description' => '', - 'type' => 'string', - 'required' => false, - 'example' => '{"RankBy": "Score"}', - ], - 'ReservedBuckets' => [ - 'title' => '预留桶号。', - 'description' => '', - 'type' => 'string', - 'required' => false, - 'example' => '1,2,3', - ], - 'InstanceId' => [ - 'title' => '实例ID。', - 'description' => '', - 'type' => 'string', - 'required' => true, - 'example' => 'pairec-test1', - ], - 'CrowdTargetType' => [ - 'type' => 'string', - 'required' => false, - ], - 'RandomFlow' => [ - 'type' => 'integer', - 'format' => 'int64', - ], + 'RequestId' => ['title' => 'Id of the request', 'description' => 'The request ID.', 'type' => 'string', 'example' => '74D958EF-3598-56FA-8296-FF1575CE43DF'], + 'AliasExperimentId' => ['description' => 'The alias of the experiment.', 'type' => 'string', 'example' => 'L1#EG1#E1', 'title' => ''], + 'ExperimentGroupId' => ['description' => 'The experiment group ID.', 'type' => 'string', 'example' => '3', 'title' => ''], + 'LayerId' => ['description' => 'The layer ID.', 'type' => 'string', 'example' => '3', 'title' => ''], + 'LaboratoryId' => ['description' => 'The laboratory ID.', 'type' => 'string', 'example' => '3', 'title' => ''], + 'SceneId' => ['description' => 'The scene ID.', 'type' => 'string', 'example' => '3', 'title' => ''], + 'Name' => ['description' => 'The experiment name.', 'type' => 'string', 'example' => 'experiment_test1', 'title' => ''], + 'Description' => ['description' => 'The experiment description.', 'type' => 'string', 'example' => 'This is a test.', 'title' => ''], + 'Type' => ['description' => 'The type of the experiment. Valid values:<br>● Baseline: a baseline experiment.<br>● Normal: a normal experiment.<br><br>', 'type' => 'string', 'example' => 'Baseline', 'title' => ''], + 'FlowPercent' => ['description' => 'The traffic percentage.', 'type' => 'integer', 'format' => 'int32', 'default' => '100', 'title' => '', 'example' => '100'], + 'Buckets' => ['description' => 'A comma-separated list of bucket numbers.', 'type' => 'string', 'example' => '1,2,3', 'title' => ''], + 'DebugUsers' => ['description' => 'The UIDs of debug users, which can be the UIDs of an Alibaba Cloud main account or a RAM user. Separate multiple UIDs with a comma (,).', 'type' => 'string', 'example' => '1124512470******,1124512471******,1124512472******', 'title' => ''], + 'DebugCrowdId' => ['description' => 'The debug crowd ID.', 'type' => 'string', 'example' => '3', 'title' => ''], + 'Config' => ['description' => 'The experiment configuration, in JSON format.', 'type' => 'string', 'example' => '{"RankBy": "Score"}', 'title' => ''], + 'Status' => ['description' => 'The status of the experiment. Valid values:<br>● Offline<br>● Online<br><br>', 'type' => 'string', 'example' => 'Offline', 'title' => ''], + 'GmtCreateTime' => ['description' => 'The creation time, in ISO 8601 format.', 'type' => 'string', 'example' => '2021-12-15T23:24:33.132+08:00', 'title' => ''], + 'GmtModifiedTime' => ['description' => 'The modification time, in ISO 8601 format.', 'type' => 'string', 'example' => '2021-12-15T23:24:33.132+08:00', 'title' => ''], ], - 'required' => false, + 'example' => '', ], ], ], + 'staticInfo' => ['returnType' => 'synchronous'], + 'title' => 'Get Experiment Details', + 'changeSet' => [], + 'flowControl' => [ + 'flowControlList' => [], + ], + 'ramActions' => [ + [ + 'operationType' => 'get', + 'ramAction' => [ + 'action' => 'pairec:GetExperiment', + 'authLevel' => 'operate', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'PAIRecService', 'resourceType' => 'All Resource', 'arn' => '*'], + ], + ], + ], + ], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"74D958EF-3598-56FA-8296-FF1575CE43DF\\",\\n \\"AliasExperimentId\\": \\"L1#EG1#E1\\",\\n \\"ExperimentGroupId\\": \\"3\\",\\n \\"LayerId\\": \\"3\\",\\n \\"LaboratoryId\\": \\"3\\",\\n \\"SceneId\\": \\"3\\",\\n \\"Name\\": \\"experiment_test1\\",\\n \\"Description\\": \\"This is a test.\\",\\n \\"Type\\": \\"Baseline\\",\\n \\"FlowPercent\\": 100,\\n \\"Buckets\\": \\"1,2,3\\",\\n \\"DebugUsers\\": \\"1124512470******,1124512471******,1124512472******\\",\\n \\"DebugCrowdId\\": \\"3\\",\\n \\"Config\\": \\"{\\\\\\"RankBy\\\\\\": \\\\\\"Score\\\\\\"}\\",\\n \\"Status\\": \\"Offline\\",\\n \\"GmtCreateTime\\": \\"2021-12-15T23:24:33.132+08:00\\",\\n \\"GmtModifiedTime\\": \\"2021-12-15T23:24:33.132+08:00\\"\\n}","type":"json"}]', + ], + 'GetExperimentGroup' => [ + 'path' => '/api/v1/experimentgroups/{ExperimentGroupId}', + 'methods' => ['get'], + 'schemes' => ['http', 'https'], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'consumes' => ['application/json'], + 'produces' => ['application/json'], + 'operationType' => 'read', + 'deprecated' => false, + 'systemTags' => [ + 'operationType' => 'get', + 'riskType' => 'none', + 'chargeType' => 'free', + 'abilityTreeCode' => '183395', + 'abilityTreeNodes' => ['FEATURElearnN0NAWV'], + ], + 'parameters' => [ + [ + 'name' => 'ExperimentGroupId', + 'in' => 'path', + 'schema' => ['description' => 'The ID of the experiment group. You can call the `ListExperimentGroups` operation to obtain this ID.', 'type' => 'string', 'required' => true, 'example' => '3', 'title' => ''], + ], + [ + 'name' => 'InstanceId', + 'in' => 'query', + 'schema' => ['description' => 'The ID of the instance. You can call the `ListInstances` operation to obtain this ID.', 'type' => 'string', 'required' => true, 'example' => 'pairec-cn-abcdefg1234', 'title' => ''], + ], + ], 'responses' => [ 200 => [ 'schema' => [ 'title' => 'Schema of Response', - 'description' => 'Schema of Response', + 'description' => 'The data returned.', 'type' => 'object', 'properties' => [ - 'RequestId' => [ - 'title' => 'Id of the request', - 'description' => 'Id of the request', - 'type' => 'string', - 'example' => 'A04CB8C0-E74A-5E83-BC61-64D153574EC7', - ], - 'ExperimentGroupId' => [ - 'title' => '实验组ID。', - 'description' => '', - 'type' => 'string', - 'example' => '3', - ], + 'RequestId' => ['title' => 'Id of the request', 'description' => 'The request ID.', 'type' => 'string', 'example' => 'BDB621CB-A81E-5D39-8793-39A365CBCC74'], + 'LayerId' => ['description' => 'The ID of the layer.', 'type' => 'string', 'example' => '3', 'title' => ''], + 'LaboratoryId' => ['description' => 'The ID of the laboratory.', 'type' => 'string', 'example' => '4', 'title' => ''], + 'SceneId' => ['description' => 'The ID of the scene.', 'type' => 'string', 'example' => '1', 'title' => ''], + 'Name' => ['description' => 'The name of the experiment group.', 'type' => 'string', 'example' => 'experiment_group1', 'title' => ''], + 'Description' => ['description' => 'The description of the experiment group.', 'type' => 'string', 'example' => 'This is a test.', 'title' => ''], + 'DebugUsers' => ['description' => 'The user IDs for debugging, separated by commas.', 'type' => 'string', 'example' => '1124512470******,1124512471******,1124512472******', 'title' => ''], + 'DebugCrowdId' => ['description' => 'The ID of the debug crowd.', 'type' => 'string', 'example' => '4', 'title' => ''], + 'Owner' => ['description' => 'The owner of the experiment group.', 'type' => 'string', 'example' => '1124512470******', 'title' => ''], + 'NeedAA' => ['description' => 'Indicates whether an A/B test is required.', 'type' => 'boolean', 'title' => '', 'example' => 'true'], + 'Filter' => ['description' => 'The filter.', 'type' => 'string', 'example' => 'gender=female', 'title' => ''], + 'DistributionType' => ['description' => 'The traffic distribution method.'."\n" + .'● `UserId`: Distributes traffic by user ID.'."\n" + .'● `TimeDuration`: Distributes traffic by time period.', 'type' => 'string', 'example' => 'UserId', 'title' => ''], + 'DistributionTimeDuration' => ['description' => 'The distribution duration.', 'type' => 'integer', 'format' => 'int32', 'example' => '5', 'title' => ''], + 'CrowdId' => ['description' => 'The ID of the crowd.', 'type' => 'string', 'example' => '3', 'title' => ''], + 'Config' => ['description' => 'The configuration of the experiment group.', 'type' => 'string', 'example' => '{"RankBy": "Score"}', 'title' => ''], + 'ReservedBuckets' => ['description' => 'The reserved bucket IDs.', 'type' => 'string', 'example' => '1,2,3,4', 'title' => ''], + 'Status' => ['description' => 'The status of the experiment group. Valid values:'."\n" + .'● `Offline`: The experiment group is not launched.'."\n" + .'● `Online`: The experiment group is launched.'."\n" + .'● `Pushed`: The experiment group is fully launched.', 'type' => 'string', 'example' => 'Offline', 'title' => ''], + 'CrowdTargetType' => ['description' => 'The method for targeting traffic to the experiment group. Valid values:'."\n" + ."\n" + .'- `All`: all traffic'."\n" + ."\n" + .'- `Filter`: traffic that matches the filter'."\n" + ."\n" + .'- `CrowdId`: traffic from the specified crowd'."\n" + ."\n" + .'- `Random`: a random percentage of traffic', 'type' => 'string', 'example' => 'All', 'title' => ''], + 'RandomFlow' => ['description' => 'The percentage of traffic from 0 to 100 that is randomly allocated to this experiment group. This parameter is returned only when `CrowdTargetType` is set to `Random`.', 'type' => 'integer', 'format' => 'int64', 'example' => '20', 'title' => ''], + 'HoldingBuckets' => ['description' => 'The bucket IDs that correspond to the `RandomFlow` percentage. This parameter is returned only when `CrowdTargetType` is set to `Random`.', 'type' => 'string', 'example' => '1,2,3,4', 'title' => ''], ], + 'example' => '', ], ], ], - 'staticInfo' => [ - 'returnType' => 'synchronous', + 'staticInfo' => ['returnType' => 'synchronous'], + 'title' => 'Obtain experiment group details', + 'summary' => 'Retrieves details for a specified experiment group.', + 'changeSet' => [ + ['createdAt' => '2024-03-20T06:05:19.000Z', 'description' => 'Response parameters changed'], ], - 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"A04CB8C0-E74A-5E83-BC61-64D153574EC7\\",\\n \\"ExperimentGroupId\\": \\"3\\"\\n}","type":"json"}]', - ], - 'DeleteExperimentGroup' => [ - 'summary' => '删除指定实验组。', - 'path' => '/api/v1/experimentgroups/{ExperimentGroupId}', - 'methods' => [ - 'delete', + 'flowControl' => [ + 'flowControlList' => [], ], - 'schemes' => [ - 'http', - 'https', + 'ramActions' => [ + [ + 'operationType' => 'get', + 'ramAction' => [ + 'action' => 'pairec:GetExperimentGroup', + 'authLevel' => 'operate', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'PAIRecService', 'resourceType' => 'All Resource', 'arn' => '*'], + ], + ], + ], ], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"BDB621CB-A81E-5D39-8793-39A365CBCC74\\",\\n \\"LayerId\\": \\"3\\",\\n \\"LaboratoryId\\": \\"4\\",\\n \\"SceneId\\": \\"1\\",\\n \\"Name\\": \\"experiment_group1\\",\\n \\"Description\\": \\"This is a test.\\",\\n \\"DebugUsers\\": \\"1124512470******,1124512471******,1124512472******\\",\\n \\"DebugCrowdId\\": \\"4\\",\\n \\"Owner\\": \\"1124512470******\\",\\n \\"NeedAA\\": true,\\n \\"Filter\\": \\"gender=female\\",\\n \\"DistributionType\\": \\"UserId\\",\\n \\"DistributionTimeDuration\\": 5,\\n \\"CrowdId\\": \\"3\\",\\n \\"Config\\": \\"{\\\\\\"RankBy\\\\\\": \\\\\\"Score\\\\\\"}\\",\\n \\"ReservedBuckets\\": \\"1,2,3,4\\",\\n \\"Status\\": \\"Offline\\",\\n \\"CrowdTargetType\\": \\"All\\",\\n \\"RandomFlow\\": 20,\\n \\"HoldingBuckets\\": \\"1,2,3,4\\"\\n}","type":"json"}]', + ], + 'GetFeatureConsistencyCheckJob' => [ + 'summary' => 'Gets the details of a feature consistency check job.', + 'path' => '/api/v1/featureconsistencycheck/jobs/{FeatureConsistencyCheckJobId}', + 'methods' => ['get'], + 'schemes' => ['http', 'https'], 'security' => [ [ 'AK' => [], ], ], - 'consumes' => [ - 'application/json', - ], - 'produces' => [ - 'application/json', - ], + 'consumes' => ['application/json'], + 'produces' => ['application/json'], 'operationType' => 'read', 'deprecated' => false, 'systemTags' => [ - 'operationType' => 'delete', + 'operationType' => 'get', 'riskType' => 'none', 'chargeType' => 'free', - 'abilityTreeNodes' => [ - 'FEATURElearnN0NAWV', - ], + 'abilityTreeNodes' => ['FEATURElearnN0NAWV'], ], 'parameters' => [ [ - 'name' => 'ExperimentGroupId', + 'name' => 'FeatureConsistencyCheckJobId', 'in' => 'path', - 'schema' => [ - 'title' => '实验组ID。', - 'description' => '', - 'type' => 'string', - 'required' => true, - 'example' => '3', - ], + 'schema' => ['description' => 'The feature consistency check job ID. To obtain the job ID, see [ListFeatureConsistencyCheckJobs](~~2557571~~).', 'type' => 'string', 'example' => '4', 'title' => '', 'required' => false], ], [ 'name' => 'InstanceId', 'in' => 'query', - 'schema' => [ - 'title' => '实例ID。', - 'description' => '', - 'type' => 'string', - 'required' => true, - 'example' => 'pairec-cn-abcdefg1234', - ], + 'schema' => ['description' => 'The instance ID. To obtain the instance ID, see [ListInstances](~~2411819~~).', 'type' => 'string', 'example' => 'pairec-cn-********', 'title' => '', 'required' => false], ], ], 'responses' => [ 200 => [ 'schema' => [ 'title' => 'Schema of Response', - 'description' => 'Schema of Response', + 'description' => 'The data returned for the request.', 'type' => 'object', 'properties' => [ - 'RequestId' => [ - 'title' => 'Id of the request', - 'description' => 'Id of the request', - 'type' => 'string', - 'example' => 'A009D9BE-C85E-57B2-AE05-BD78BB6EBF50', + 'RequestId' => ['title' => 'Id of the request', 'description' => 'The request ID.', 'type' => 'string', 'example' => 'A04CB8C0-E74A-5E83-BC61-64D153574EC7'], + 'FeatureConsistencyCheckJobConfigId' => ['description' => 'The ID of the feature consistency check job configuration.', 'type' => 'string', 'example' => '5', 'title' => ''], + 'FeatureConsistencyCheckJobConfigName' => ['description' => 'The name of the feature consistency check job configuration.', 'type' => 'string', 'example' => 'feature_consistency_check_1', 'title' => ''], + 'GmtStartTime' => ['description' => 'The start time of the job.', 'type' => 'string', 'example' => '2021-12-15T23:24:33.132+08:00', 'title' => ''], + 'GmtEndTime' => ['description' => 'The end time of the job.', 'type' => 'string', 'example' => '2021-12-15T23:24:33.132+08:00', 'title' => ''], + 'Status' => ['description' => 'The status of the job. Valid values:'."\n" + ."\n" + .'- `ToRun`: The job is waiting to run.'."\n" + ."\n" + .'- `Running`: The job is in progress.'."\n" + ."\n" + .'- `Success`: The job completed successfully.'."\n" + ."\n" + .'- `Failure`: The job failed.'."\n" + ."\n" + .'- `Terminated`: The job was stopped or canceled.', 'type' => 'string', 'example' => 'Running', 'title' => ''], + 'Config' => ['description' => 'The job config, as a JSON string.', 'type' => 'string', 'example' => '{}', 'title' => ''], + 'Logs' => [ + 'title' => '', + 'description' => 'The logs generated by the job.', + 'type' => 'array', + 'items' => ['description' => 'A log entry.', 'type' => 'string', 'example' => '2023-02-21 14:28:04 INFO: epoch [1][745/127291]tlr: 2.925e-05, eta: 2 days, 2:11:04, iter_time: 1.682, data_load_time: 0.997, memory: 12898, loss: 1.3768', 'title' => ''], + 'example' => '', ], ], + 'example' => '', ], ], ], - 'staticInfo' => [ - 'returnType' => 'synchronous', + 'staticInfo' => ['returnType' => 'synchronous'], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"A04CB8C0-E74A-5E83-BC61-64D153574EC7\\",\\n \\"FeatureConsistencyCheckJobConfigId\\": \\"5\\",\\n \\"FeatureConsistencyCheckJobConfigName\\": \\"feature_consistency_check_1\\",\\n \\"GmtStartTime\\": \\"2021-12-15T23:24:33.132+08:00\\",\\n \\"GmtEndTime\\": \\"2021-12-15T23:24:33.132+08:00\\",\\n \\"Status\\": \\"Running\\",\\n \\"Config\\": \\"{}\\",\\n \\"Logs\\": [\\n \\"2023-02-21 14:28:04 INFO: epoch [1][745/127291]tlr: 2.925e-05, eta: 2 days, 2:11:04, iter_time: 1.682, data_load_time: 0.997, memory: 12898, loss: 1.3768\\"\\n ]\\n}","type":"json"}]', + 'title' => 'Retrieve the details of a feature consistency check job', + 'changeSet' => [], + 'flowControl' => [ + 'flowControlList' => [], + ], + 'ramActions' => [ + [ + 'operationType' => 'get', + 'ramAction' => [ + 'action' => 'pairec:GetFeatureConsistencyCheckJob', + 'authLevel' => 'operate', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'PAIRecService', 'resourceType' => 'All Resource', 'arn' => '*'], + ], + ], + ], ], - 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"A009D9BE-C85E-57B2-AE05-BD78BB6EBF50\\"\\n}","type":"json"}]', ], - 'UpdateExperimentGroup' => [ - 'summary' => '更新指定实验组。', - 'path' => '/api/v1/experimentgroups/{ExperimentGroupId}', - 'methods' => [ - 'put', - ], - 'schemes' => [ - 'http', - 'https', - ], + 'GetFeatureConsistencyCheckJobConfig' => [ + 'summary' => 'Retrieves the configuration details of a feature consistency check task.', + 'path' => '/api/v1/featureconsistencycheck/jobconfigs/{FeatureConsistencyCheckJobConfigId}', + 'methods' => ['get'], + 'schemes' => ['http', 'https'], 'security' => [ [ 'AK' => [], ], ], - 'consumes' => [ - 'application/json', - ], - 'produces' => [ - 'application/json', - ], + 'consumes' => ['application/json'], + 'produces' => ['application/json'], 'operationType' => 'read', 'deprecated' => false, 'systemTags' => [ 'operationType' => 'get', 'riskType' => 'none', 'chargeType' => 'free', - 'abilityTreeCode' => '183398', - 'abilityTreeNodes' => [ - 'FEATURElearnN0NAWV', - ], + 'abilityTreeCode' => '193280', + 'abilityTreeNodes' => ['FEATURElearnN0NAWV'], ], 'parameters' => [ [ - 'name' => 'ExperimentGroupId', + 'name' => 'FeatureConsistencyCheckJobConfigId', 'in' => 'path', + 'schema' => ['description' => 'The ID of the feature consistency check configuration. For information about how to obtain the ID, see [ListFeatureConsistencyCheckJobConfigs](~~2557567~~).', 'type' => 'string', 'required' => true, 'example' => '3', 'title' => ''], + ], + [ + 'name' => 'InstanceId', + 'in' => 'query', + 'schema' => ['description' => 'The ID of the instance. See [ListInstances](~~2411819~~) for details on how to obtain it.', 'type' => 'string', 'required' => true, 'example' => 'pairec-cn-********', 'title' => ''], + ], + ], + 'responses' => [ + 200 => [ 'schema' => [ - 'description' => '', - 'type' => 'string', - 'required' => true, - 'example' => '3', + 'title' => 'Schema of Response', + 'description' => 'The response schema.', + 'type' => 'object', + 'properties' => [ + 'RequestId' => ['title' => 'Id of the request', 'description' => 'The request ID.', 'type' => 'string', 'example' => '728C5E01-ABF6-5AA8-B9FC-B3BA05DECC77'], + 'Name' => ['description' => 'The name of the feature consistency check configuration.', 'type' => 'string', 'example' => 'feature_consistency_check1', 'title' => ''], + 'SceneId' => ['description' => 'The scene ID.', 'type' => 'string', 'example' => '3', 'title' => ''], + 'SceneName' => ['description' => 'The scene name.', 'type' => 'string', 'example' => 'scene1', 'title' => ''], + 'Status' => ['description' => 'The status of the configuration. Valid values:'."\n" + ."\n" + .'- `Editable`: The configuration can be edited.'."\n" + ."\n" + .'- `Uneditable`: The configuration cannot be edited.', 'type' => 'string', 'example' => 'Editable', 'title' => ''], + 'CompareFeature' => ['description' => 'Whether to enable feature comparison.', 'type' => 'boolean', 'title' => '', 'example' => 'true'], + 'LatestJobId' => ['description' => 'The ID of the most recent job created from this configuration.', 'type' => 'string', 'example' => '3', 'title' => ''], + 'LatestJobGmtSamplingStartTime' => ['description' => 'The start time of the most recent job.', 'type' => 'string', 'example' => '2021-12-15T23:24:33.132+08:00', 'title' => ''], + 'LatestJobGmtSamplingEndTime' => ['description' => 'The end time of the most recent job.', 'type' => 'string', 'example' => '2021-12-15T23:24:33.132+08:00', 'title' => ''], + 'SampleRate' => ['description' => 'The sample rate. The value must be between 0 and 1.', 'type' => 'string', 'example' => '0.89', 'title' => ''], + 'FeatureLandingResourceId' => ['description' => 'The ID of the data source for feature fallback.', 'type' => 'string', 'example' => 'reso-********', 'title' => ''], + 'FeatureLandingResourceUri' => ['description' => 'The URI of the data source for feature fallback.', 'type' => 'string', 'example' => 'mc_project_1', 'title' => ''], + 'EasServiceName' => ['description' => 'The EAS service name.', 'type' => 'string', 'example' => 'eas_service_1', 'title' => ''], + 'FgJsonFileName' => ['description' => 'The name of the `fg_json` file.', 'type' => 'string', 'example' => 'file.json', 'title' => ''], + 'UserTable' => ['description' => 'The user table name.', 'type' => 'string', 'example' => 'user_table', 'title' => ''], + 'UserIdField' => ['description' => 'The name of the `user_id` field.', 'type' => 'string', 'example' => 'user_id', 'title' => ''], + 'UserTablePartitionField' => ['description' => 'The partition field of the user table.', 'type' => 'string', 'example' => 'ds', 'title' => ''], + 'UserTablePartitionFieldFormat' => ['description' => 'The format of the partition field in the user table. Valid values:'."\n" + ."\n" + .'- `yyyymmdd`'."\n" + ."\n" + .'- `yyyy-mm-dd`', 'type' => 'string', 'example' => 'yyyymmdd', 'title' => ''], + 'ItemTable' => ['description' => 'The item table name.', 'type' => 'string', 'example' => 'item_table', 'title' => ''], + 'ItemIdField' => ['description' => 'The name of the `item_id` field.', 'type' => 'string', 'example' => 'item_id', 'title' => ''], + 'ItemTablePartitionField' => ['description' => 'The partition field of the item table.', 'type' => 'string', 'example' => 'ds', 'title' => ''], + 'ItemTablePartitionFieldFormat' => ['description' => 'The format of the partition field in the item table. Valid values:'."\n" + ."\n" + .'- `yyyymmdd`'."\n" + ."\n" + .'- `yyyy-mm-dd`', 'type' => 'string', 'example' => 'yyyymmdd', 'title' => ''], + 'GenerateZip' => ['description' => 'Whether to generate a ZIP package.', 'type' => 'boolean', 'title' => '', 'example' => 'true'], + 'ServiceId' => ['description' => 'The service ID.', 'type' => 'string', 'example' => '4', 'title' => ''], + 'ServiceName' => ['description' => 'The service name.', 'type' => 'string', 'example' => 'service1', 'title' => ''], + 'WorkflowName' => ['description' => 'The workflow name.', 'type' => 'string', 'example' => 'work_flow_1', 'title' => ''], + 'OssResourceId' => ['description' => 'The ID of the OSS data source.', 'type' => 'string', 'example' => 'reso-********', 'title' => ''], + 'OssBucket' => ['description' => 'The OSS bucket name.', 'type' => 'string', 'example' => 'oss_bucket_1', 'title' => ''], + 'EasyRecVersion' => ['description' => 'The EasyRec version.', 'type' => 'string', 'example' => '1.3.60', 'title' => ''], + 'EasyRecPackagePath' => ['description' => 'The path of the EasyRec package.', 'type' => 'string', 'title' => '', 'example' => 'oss://*******'], + 'FgJarVersion' => ['description' => 'The version of the `fg_jar` file.', 'type' => 'string', 'example' => '1.0.0', 'title' => ''], + 'FeaturePriority' => ['description' => 'A comma-separated list of features, ordered by priority.', 'type' => 'string', 'example' => 'feature1,feature2,feature3', 'title' => ''], + 'FeatureDisplayExclude' => ['description' => 'A comma-separated list of features to exclude from the display.', 'type' => 'string', 'example' => 'feature1,feature2', 'title' => ''], + 'GmtCreateTime' => ['description' => 'The time the configuration was created.', 'type' => 'string', 'example' => '2021-12-15T23:24:33.132+08:00', 'title' => ''], + 'GmtModifiedTime' => ['description' => 'The time the configuration was last updated.', 'type' => 'string', 'example' => '2021-12-15T23:24:33.132+08:00', 'title' => ''], + 'UseFeatureStore' => ['description' => 'Whether to use a Feature Store. Valid values:'."\n" + ."\n" + .'- `true`: A Feature Store is used. In this case, the response also returns `FeatureStoreProjectId`, `FeatureStoreProjectName`, `FeatureStoreModelId`, `FeatureStoreUserId`, and `FeatureStoreItemId`.'."\n" + ."\n" + .'- `false`: A Feature Store is not used. In this case, the `UserTable`, `UserIdField`, `UserTablePartitionField`, `UserTablePartitionFieldFormat`, `ItemTable`, `ItemIdField`, `ItemTablePartitionField`, and `ItemTablePartitionFieldFormat` parameters are returned.', 'type' => 'boolean', 'example' => 'true', 'title' => ''], + 'FeatureStoreProjectName' => ['description' => 'The Feature Store project name.', 'type' => 'string', 'example' => 'project-1', 'title' => ''], + 'FeatureStoreModelId' => ['description' => 'The Feature Store model ID.', 'type' => 'string', 'example' => '2', 'title' => ''], + 'FeatureStoreUserId' => ['description' => 'The primary key for users in the Feature Store.', 'type' => 'string', 'example' => 'user', 'title' => ''], + 'FeatureStoreItemId' => ['description' => 'The primary key for items in the Feature Store.', 'type' => 'string', 'example' => 'item', 'title' => ''], + 'FeatureStoreSeqFeatureView' => ['description' => 'The name of the feature view that contains item features within sequence features.', 'type' => 'string', 'example' => 'item-1', 'title' => ''], + 'FeatureStoreProjectId' => ['description' => 'The Feature Store project ID.', 'type' => 'string', 'example' => 'prj-01', 'title' => ''], + 'WorkspaceId' => ['type' => 'string', 'description' => '', 'title' => '', 'example' => ''], + 'VpcId' => ['type' => 'string', 'description' => '', 'title' => '', 'example' => ''], + 'SwitchId' => ['type' => 'string', 'description' => '', 'title' => '', 'example' => ''], + 'SecurityGroupId' => ['type' => 'string', 'description' => '', 'title' => '', 'example' => ''], + 'DefaultRoute' => ['type' => 'string', 'description' => '', 'title' => '', 'example' => ''], + 'DatasetId' => ['type' => 'string', 'description' => '', 'title' => '', 'example' => ''], + 'DatasetType' => ['type' => 'string', 'description' => '', 'title' => '', 'example' => ''], + 'DatasetUri' => ['type' => 'string', 'description' => '', 'title' => '', 'example' => ''], + 'DatasetMountPath' => ['type' => 'string', 'description' => '', 'title' => '', 'example' => ''], + 'DatasetName' => ['type' => 'string', 'description' => '', 'title' => '', 'example' => ''], + 'PredictWorkerCount' => ['type' => 'integer', 'format' => 'int32', 'description' => '', 'title' => '', 'example' => ''], + 'PredictWorkerCpu' => ['type' => 'integer', 'format' => 'int32', 'description' => '', 'title' => '', 'example' => ''], + 'PredictWorkerMemory' => ['type' => 'integer', 'format' => 'int32', 'description' => '', 'title' => '', 'example' => ''], + 'ResourceConfig' => ['type' => 'string', 'description' => '', 'title' => '', 'example' => ''], + ], + 'example' => '', ], ], + ], + 'staticInfo' => ['returnType' => 'synchronous'], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"728C5E01-ABF6-5AA8-B9FC-B3BA05DECC77\\",\\n \\"Name\\": \\"feature_consistency_check1\\",\\n \\"SceneId\\": \\"3\\",\\n \\"SceneName\\": \\"scene1\\",\\n \\"Status\\": \\"Editable\\",\\n \\"CompareFeature\\": true,\\n \\"LatestJobId\\": \\"3\\",\\n \\"LatestJobGmtSamplingStartTime\\": \\"2021-12-15T23:24:33.132+08:00\\",\\n \\"LatestJobGmtSamplingEndTime\\": \\"2021-12-15T23:24:33.132+08:00\\",\\n \\"SampleRate\\": \\"0.89\\",\\n \\"FeatureLandingResourceId\\": \\"reso-********\\",\\n \\"FeatureLandingResourceUri\\": \\"mc_project_1\\",\\n \\"EasServiceName\\": \\"eas_service_1\\",\\n \\"FgJsonFileName\\": \\"file.json\\",\\n \\"UserTable\\": \\"user_table\\",\\n \\"UserIdField\\": \\"user_id\\",\\n \\"UserTablePartitionField\\": \\"ds\\",\\n \\"UserTablePartitionFieldFormat\\": \\"yyyymmdd\\",\\n \\"ItemTable\\": \\"item_table\\",\\n \\"ItemIdField\\": \\"item_id\\",\\n \\"ItemTablePartitionField\\": \\"ds\\",\\n \\"ItemTablePartitionFieldFormat\\": \\"yyyymmdd\\",\\n \\"GenerateZip\\": true,\\n \\"ServiceId\\": \\"4\\",\\n \\"ServiceName\\": \\"service1\\",\\n \\"WorkflowName\\": \\"work_flow_1\\",\\n \\"OssResourceId\\": \\"reso-********\\",\\n \\"OssBucket\\": \\"oss_bucket_1\\",\\n \\"EasyRecVersion\\": \\"1.3.60\\",\\n \\"EasyRecPackagePath\\": \\"oss://*******\\",\\n \\"FgJarVersion\\": \\"1.0.0\\",\\n \\"FeaturePriority\\": \\"feature1,feature2,feature3\\",\\n \\"FeatureDisplayExclude\\": \\"feature1,feature2\\",\\n \\"GmtCreateTime\\": \\"2021-12-15T23:24:33.132+08:00\\",\\n \\"GmtModifiedTime\\": \\"2021-12-15T23:24:33.132+08:00\\",\\n \\"UseFeatureStore\\": true,\\n \\"FeatureStoreProjectName\\": \\"project-1\\",\\n \\"FeatureStoreModelId\\": \\"2\\",\\n \\"FeatureStoreUserId\\": \\"user\\",\\n \\"FeatureStoreItemId\\": \\"item\\",\\n \\"FeatureStoreSeqFeatureView\\": \\"item-1\\",\\n \\"FeatureStoreProjectId\\": \\"prj-01\\",\\n \\"WorkspaceId\\": \\"\\",\\n \\"VpcId\\": \\"\\",\\n \\"SwitchId\\": \\"\\",\\n \\"SecurityGroupId\\": \\"\\",\\n \\"DefaultRoute\\": \\"\\",\\n \\"DatasetId\\": \\"\\",\\n \\"DatasetType\\": \\"\\",\\n \\"DatasetUri\\": \\"\\",\\n \\"DatasetMountPath\\": \\"\\",\\n \\"DatasetName\\": \\"\\",\\n \\"PredictWorkerCount\\": 0,\\n \\"PredictWorkerCpu\\": 0,\\n \\"PredictWorkerMemory\\": 0,\\n \\"ResourceConfig\\": \\"\\"\\n}","type":"json"}]', + 'title' => 'Obtain the configuration details of a feature consistency check job.', + 'changeSet' => [ + ['createdAt' => '2025-06-04T10:10:20.000Z', 'description' => 'Response parameters changed'], + ['createdAt' => '2024-12-10T06:00:28.000Z', 'description' => 'Response parameters changed'], + ['createdAt' => '2024-11-12T09:17:26.000Z', 'description' => 'Response parameters changed'], + ['createdAt' => '2024-02-22T03:35:43.000Z', 'description' => 'Response parameters changed'], + ], + 'flowControl' => [ + 'flowControlList' => [], + ], + 'ramActions' => [ + [ + 'operationType' => 'get', + 'ramAction' => [ + 'action' => 'pairec:GetFeatureConsistencyCheckJobConfig', + 'authLevel' => 'operate', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'PAIRecService', 'resourceType' => 'All Resource', 'arn' => '*'], + ], + ], + ], + ], + ], + 'GetInstance' => [ + 'summary' => 'Gets the details of a specified PAI-REC instance.', + 'path' => '/api/v1/instances/{InstanceId}', + 'methods' => ['get'], + 'schemes' => ['http', 'https'], + 'security' => [ [ - 'name' => 'body', - 'in' => 'body', - 'style' => 'json', + 'AK' => [], + ], + ], + 'consumes' => ['application/json'], + 'produces' => ['application/json'], + 'operationType' => 'read', + 'deprecated' => false, + 'systemTags' => [ + 'operationType' => 'get', + 'riskType' => 'none', + 'chargeType' => 'free', + 'abilityTreeCode' => '163068', + 'abilityTreeNodes' => ['FEATURElearnN0NAWV'], + ], + 'parameters' => [ + [ + 'name' => 'InstanceId', + 'in' => 'path', + 'schema' => ['description' => 'The ID of the instance. You can get it by calling ListInstances.', 'type' => 'string', 'example' => 'pairec-cn-abcdefg1234', 'title' => '', 'required' => false], + ], + ], + 'responses' => [ + 200 => [ 'schema' => [ - 'title' => '请求body。', - 'description' => '', + 'title' => 'Schema of Response', + 'description' => 'The response body.', 'type' => 'object', 'properties' => [ - 'LayerId' => [ - 'title' => '层ID。', - 'description' => '', - 'type' => 'string', - 'required' => true, - 'example' => '3', - ], - 'Name' => [ - 'title' => '实验组名称。', - 'description' => '', - 'type' => 'string', - 'required' => true, - 'example' => 'experiment_group1', - ], - 'Description' => [ - 'title' => '实验组描述。', - 'description' => '', - 'type' => 'string', - 'required' => true, - 'example' => 'This is a test.', - ], - 'DebugUsers' => [ - 'title' => '调试用户。', - 'description' => '', - 'type' => 'string', - 'required' => false, - 'example' => 'user1,user2,user3', - ], - 'DebugCrowdId' => [ - 'title' => '调试人群ID。', - 'description' => '', - 'type' => 'string', - 'required' => false, - 'example' => '3', - ], - 'NeedAA' => [ - 'title' => '是否需要AA实验组。', - 'description' => '', - 'type' => 'boolean', - 'required' => false, - 'example' => 'true', - ], - 'Filter' => [ - 'title' => '人群定向指定的过滤条件。', - 'description' => '', - 'type' => 'string', - 'required' => false, - 'example' => 'gender=male', - ], - 'CrowdId' => [ - 'title' => '人群定向的指定人群ID。', - 'description' => '', - 'type' => 'string', - 'required' => false, - 'example' => '3', - ], - 'DistributionType' => [ - 'title' => '分流方式。'."\n" - .'● UserId-用户ID'."\n" - .'● TimeDuration-时段', - 'description' => '', - 'type' => 'string', - 'required' => false, - 'example' => 'UserId', - ], - 'DistributionTimeDuration' => [ - 'title' => '分流时段。', - 'description' => '', - 'type' => 'integer', - 'format' => 'int32', - 'required' => false, - 'example' => '3', - ], + 'RequestId' => ['description' => 'The request ID.', 'type' => 'string', 'example' => '728C5E01-ABF6-5AA8-B9FC-B3BA05DECC77', 'title' => ''], + 'InstanceId' => ['description' => 'The instance ID.', 'type' => 'string', 'example' => 'pairec-test1', 'title' => ''], + 'Type' => ['description' => 'The instance type. Valid values:<br>● basic: Basic<br>● highlevel: High-level<br>● advanced: Advanced<br>● standard: Standard<br><br><br><br>', 'type' => 'string', 'example' => 'basic', 'title' => ''], + 'Status' => ['description' => 'The instance status. Valid values:<br>● Initializing<br>● Stopped<br>● Running<br><br><br>', 'type' => 'string', 'example' => 'Initializing', 'title' => ''], + 'RegionId' => ['description' => 'The region ID. Valid values:<br>● cn-shenzhen: Shenzhen<br>● cn-hangzhou: Hangzhou<br>● cn-beijing: Beijing<br>● cn-shanghai: Shanghai<br><br><br><br>', 'type' => 'string', 'example' => 'cn-shenzhen', 'title' => ''], + 'GmtCreateTime' => ['description' => 'The time when the instance was created.', 'type' => 'string', 'example' => '2022-10-13 17:34:52.0', 'title' => ''], + 'GmtModifiedTime' => ['description' => 'The time when the instance was last updated.', 'type' => 'string', 'example' => '2022-11-05 09:02:30.0', 'title' => ''], + 'ExpiredTime' => ['description' => 'The time when the instance expires.', 'type' => 'string', 'example' => '2022-12-14 00:00:00.0', 'title' => ''], + 'CommodityCode' => ['description' => 'The commodity code of the instance.', 'type' => 'string', 'example' => 'airec_developers_public_cn', 'title' => ''], + 'ChargeType' => ['description' => 'The billing method of the instance. The value is fixed as Subscription.', 'type' => 'string', 'example' => 'Subscription', 'title' => ''], 'Config' => [ - 'title' => '实验组配置。', - 'description' => '', - 'type' => 'string', - 'required' => false, - 'example' => '{"RankBy": "Score"}', - ], - 'ReservcedBuckets' => [ - 'title' => '预留桶号。', - 'description' => '', - 'type' => 'string', - 'required' => false, - 'example' => '1,2,3', - ], - 'InstanceId' => [ - 'title' => '实例ID。', - 'description' => '', - 'type' => 'string', - 'required' => true, - 'example' => 'pairec-cn-abcdefg1234', - ], - 'CrowdTargetType' => [ - 'type' => 'string', + 'title' => '', + 'description' => 'The instance configurations.', + 'type' => 'object', + 'properties' => [ + 'Engines' => [ + 'title' => '', + 'description' => 'The list of service engines.', + 'type' => 'array', + 'items' => [ + 'type' => 'object', + 'properties' => [ + 'ComponentCode' => ['description' => 'The component code.', 'type' => 'string', 'example' => 'feature', 'title' => ''], + 'Type' => ['description' => 'The component type.', 'type' => 'string', 'example' => 'Hologres', 'title' => ''], + 'Meta' => ['description' => 'The metadata.', 'type' => 'object', 'title' => '', 'example' => ''], + ], + 'description' => '', + 'title' => '', + 'example' => '', + ], + 'example' => '', + ], + 'Monitors' => [ + 'title' => '', + 'description' => 'The list of monitoring components.', + 'type' => 'array', + 'items' => [ + 'type' => 'object', + 'properties' => [ + 'ComponentCode' => ['description' => 'The component code.', 'type' => 'string', 'example' => 'featuresets', 'title' => ''], + 'Type' => ['description' => 'The component type.', 'type' => 'string', 'example' => 'Platform', 'title' => ''], + 'Meta' => ['description' => 'The metadata.', 'type' => 'object', 'title' => '', 'example' => ''], + ], + 'description' => '', + 'title' => '', + 'example' => '', + ], + 'example' => '', + ], + 'DataManagements' => [ + 'title' => '', + 'description' => 'The list of modeling environments.', + 'type' => 'array', + 'items' => [ + 'type' => 'object', + 'properties' => [ + 'ComponentCode' => ['description' => 'The component code.', 'type' => 'string', 'example' => 'storage', 'title' => ''], + 'Type' => ['description' => 'The component type.', 'type' => 'string', 'example' => 'OSS', 'title' => ''], + 'Meta' => ['description' => 'The metadata.', 'type' => 'object', 'title' => '', 'example' => ''], + ], + 'description' => '', + 'title' => '', + 'example' => '', + ], + 'example' => '', + ], + ], + 'example' => '', ], - 'RandomFlow' => [ - 'type' => 'integer', - 'format' => 'int64', + 'OperatingTool' => [ + 'description' => 'The operating tool configurations.', + 'type' => 'object', + 'properties' => [ + 'IsEnable' => ['description' => 'Indicates whether the operating tool is enabled for the instance. Valid values:'."\n" + ."\n" + .'- True: Enabled'."\n" + ."\n" + .'- False: Disabled', 'type' => 'boolean', 'example' => 'True', 'title' => ''], + ], + 'title' => '', + 'example' => '', ], ], - 'required' => false, + 'example' => '', + ], + ], + ], + 'staticInfo' => ['returnType' => 'synchronous'], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"728C5E01-ABF6-5AA8-B9FC-B3BA05DECC77\\",\\n \\"InstanceId\\": \\"pairec-test1\\",\\n \\"Type\\": \\"basic\\",\\n \\"Status\\": \\"Initializing\\",\\n \\"RegionId\\": \\"cn-shenzhen\\",\\n \\"GmtCreateTime\\": \\"2022-10-13 17:34:52.0\\",\\n \\"GmtModifiedTime\\": \\"2022-11-05 09:02:30.0\\",\\n \\"ExpiredTime\\": \\"2022-12-14 00:00:00.0\\",\\n \\"CommodityCode\\": \\"airec_developers_public_cn\\",\\n \\"ChargeType\\": \\"Subscription\\",\\n \\"Config\\": {\\n \\"Engines\\": [\\n {\\n \\"ComponentCode\\": \\"feature\\",\\n \\"Type\\": \\"Hologres\\",\\n \\"Meta\\": {\\n \\"test\\": \\"test\\",\\n \\"test2\\": 1\\n }\\n }\\n ],\\n \\"Monitors\\": [\\n {\\n \\"ComponentCode\\": \\"featuresets\\",\\n \\"Type\\": \\"Platform\\",\\n \\"Meta\\": {\\n \\"test\\": \\"test\\",\\n \\"test2\\": 1\\n }\\n }\\n ],\\n \\"DataManagements\\": [\\n {\\n \\"ComponentCode\\": \\"storage\\",\\n \\"Type\\": \\"OSS\\",\\n \\"Meta\\": {\\n \\"test\\": \\"test\\",\\n \\"test2\\": 1\\n }\\n }\\n ]\\n },\\n \\"OperatingTool\\": {\\n \\"IsEnable\\": true\\n }\\n}","type":"json"}]', + 'title' => 'Obtain Instance Details ', + 'changeSet' => [ + ['createdAt' => '2024-08-05T08:37:23.000Z', 'description' => 'Response parameters changed'], + ], + 'flowControl' => [ + 'flowControlList' => [ + ['threshold' => '100', 'countWindow' => 1, 'regionId' => '*', 'api' => 'GetInstance'], + ], + ], + 'ramActions' => [ + [ + 'operationType' => 'get', + 'ramAction' => [ + 'action' => 'pairec:GetInstance', + 'authLevel' => 'operate', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'PAIRecService', 'resourceType' => 'All Resource', 'arn' => '*'], + ], ], ], ], + ], + 'GetInstanceResource' => [ + 'summary' => 'Retrieves the details of a specific resource in a specified instance.', + 'path' => '/api/v1/instances/{InstanceId}/resources/{ResourceId}', + 'methods' => ['get'], + 'schemes' => ['http', 'https'], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'consumes' => ['application/json'], + 'produces' => ['application/json'], + 'operationType' => 'read', + 'deprecated' => false, + 'systemTags' => [ + 'operationType' => 'none', + 'riskType' => 'none', + 'chargeType' => 'free', + 'abilityTreeNodes' => ['FEATURElearnN0NAWV'], + ], + 'parameters' => [ + [ + 'name' => 'InstanceId', + 'in' => 'path', + 'schema' => ['description' => 'The instance ID. You can call the [ListInstances](~~2411819~~) operation to obtain the instance ID.', 'type' => 'string', 'required' => true, 'example' => 'pairec-cn-test1', 'title' => ''], + ], + [ + 'name' => 'ResourceId', + 'in' => 'path', + 'schema' => ['description' => 'The resource ID.', 'type' => 'string', 'required' => true, 'example' => 'reso-2s416t***', 'title' => ''], + ], + ], 'responses' => [ 200 => [ 'schema' => [ 'title' => 'Schema of Response', - 'description' => 'Schema of Response', + 'description' => 'The response object.', 'type' => 'object', 'properties' => [ - 'RequestId' => [ - 'title' => 'Id of the request', - 'description' => 'Id of the request', - 'type' => 'string', - 'example' => 'F7AC05FF-EDE7-5C2B-B9AE-33D6DF4178BA', - ], + 'RequestId' => ['title' => 'Id of the request', 'description' => 'The request ID.', 'type' => 'string', 'example' => 'D75C43DC-3D3A-5CC8-9AAC-8C77306C433B'], + 'ResourceId' => ['description' => 'The resource ID.', 'type' => 'string', 'example' => 'reso-2s416t***', 'title' => ''], + 'Category' => ['description' => 'The resource category. Valid values:'."\n" + ."\n" + .'- DataManagement'."\n" + ."\n" + .'- Engine'."\n" + ."\n" + .'- Monitor', 'type' => 'string', 'example' => 'DataManagement', 'title' => ''], + 'Group' => ['description' => 'The resource group.'."\n" + ."\n" + .'If `Category` is `DataManagement`, the valid values are:'."\n" + ."\n" + .'- storage'."\n" + ."\n" + .'- modelpipeline'."\n" + ."\n" + .'- datastorage'."\n" + ."\n" + .'- modeltrain'."\n" + ."\n" + .'If `Category` is `Engine`, the valid values are:'."\n" + ."\n" + .'- feature'."\n" + ."\n" + .'- predict'."\n" + ."\n" + .'- recall'."\n" + ."\n" + .'- recengine'."\n" + ."\n" + .'If `Category` is `Monitor`, the valid values are:'."\n" + ."\n" + .'- logs'."\n" + ."\n" + .'- logsback'."\n" + ."\n" + .'- coldstart'."\n" + ."\n" + .'- deploy', 'type' => 'string', 'example' => 'storage', 'title' => ''], + 'Type' => ['description' => 'The resource type. Valid values:'."\n" + ."\n" + .'- Hologres'."\n" + ."\n" + .'- EAS'."\n" + ."\n" + .'- BE'."\n" + ."\n" + .'- Rec'."\n" + ."\n" + .'- Platform'."\n" + ."\n" + .'- SLS'."\n" + ."\n" + .'- DataHub'."\n" + ."\n" + .'- ApsaraMQ for Kafka'."\n" + ."\n" + .'- Realtime Compute for Apache Flink'."\n" + ."\n" + .'- ACR'."\n" + ."\n" + .'- OSS'."\n" + ."\n" + .'- DataWorks'."\n" + ."\n" + .'- PAI'."\n" + ."\n" + .'- MaxCompute'."\n" + ."\n" + .'- Graph Compute Service'."\n" + ."\n" + .'- ApsaraDB for Redis', 'type' => 'string', 'example' => 'OSS', 'title' => ''], + 'Uri' => ['description' => 'The resource URI.', 'type' => 'string', 'example' => 'bucket-test-123', 'title' => ''], + 'Config' => ['description' => 'The resource configuration.', 'type' => 'string', 'example' => '{}', 'title' => ''], + 'GmtCreateTime' => ['description' => 'The creation time.', 'type' => 'string', 'example' => '2020-10-13 17:34:52', 'title' => ''], + 'GmtModifiedTime' => ['description' => 'The last modification time.', 'type' => 'string', 'example' => '2020-10-13 17:34:52', 'title' => ''], ], + 'example' => '', ], ], ], - 'staticInfo' => [ - 'returnType' => 'synchronous', + 'staticInfo' => ['returnType' => 'synchronous'], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"D75C43DC-3D3A-5CC8-9AAC-8C77306C433B\\",\\n \\"ResourceId\\": \\"reso-2s416t***\\",\\n \\"Category\\": \\"DataManagement\\",\\n \\"Group\\": \\"storage\\",\\n \\"Type\\": \\"OSS\\",\\n \\"Uri\\": \\"bucket-test-123\\",\\n \\"Config\\": \\"{}\\",\\n \\"GmtCreateTime\\": \\"2020-10-13 17:34:52\\",\\n \\"GmtModifiedTime\\": \\"2020-10-13 17:34:52\\"\\n}","type":"json"}]', + 'title' => 'Obtain Resource Details', + 'changeSet' => [ + ['createdAt' => '2024-02-22T03:35:44.000Z', 'description' => 'Request parameters changed'], + ], + 'flowControl' => [ + 'flowControlList' => [], + ], + 'ramActions' => [ + [ + 'operationType' => 'none', + 'ramAction' => [ + 'action' => 'pairec:GetInstanceResource', + 'authLevel' => 'operate', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'PAIRecService', 'resourceType' => 'All Resource', 'arn' => '*'], + ], + ], + ], ], - 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"F7AC05FF-EDE7-5C2B-B9AE-33D6DF4178BA\\"\\n}","type":"json"}]', ], - 'ListExperimentGroups' => [ - 'summary' => '获取实验组列表。', - 'path' => '/api/v1/experimentgroups', - 'methods' => [ - 'get', - ], - 'schemes' => [ - 'http', - 'https', - ], + 'GetInstanceResourceTable' => [ + 'summary' => 'Retrieves the schema of a specified data table within a resource.', + 'path' => '/api/v1/instances/{InstanceId}/resources/{ResourceId}/tables/{TableName}', + 'methods' => ['get'], + 'schemes' => ['http', 'https'], 'security' => [ [ 'AK' => [], ], ], - 'consumes' => [ - 'application/json', + 'consumes' => ['application/json'], + 'produces' => ['application/json'], + 'operationType' => 'read', + 'deprecated' => false, + 'systemTags' => [ + 'operationType' => 'none', + 'riskType' => 'none', + 'chargeType' => 'free', + 'abilityTreeNodes' => ['FEATURElearnN0NAWV'], ], - 'produces' => [ - 'application/json', + 'parameters' => [ + [ + 'name' => 'InstanceId', + 'in' => 'path', + 'schema' => ['description' => 'The instance ID. You can call the [ListInstances](~~2411819~~) operation to obtain this ID.', 'type' => 'string', 'required' => true, 'example' => 'pairec-cn-test1', 'title' => ''], + ], + [ + 'name' => 'ResourceId', + 'in' => 'path', + 'schema' => ['description' => 'The resource ID.', 'type' => 'string', 'required' => true, 'example' => 'reso-2s416t***', 'title' => ''], + ], + [ + 'name' => 'TableName', + 'in' => 'path', + 'schema' => ['description' => 'The name of the data table.', 'type' => 'string', 'required' => true, 'example' => 'test_table', 'title' => ''], + ], ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'title' => 'Schema of Response', + 'description' => 'The schema of the response.', + 'type' => 'object', + 'properties' => [ + 'RequestId' => ['title' => 'Id of the request', 'description' => 'The request ID.', 'type' => 'string', 'example' => '74D958EF-3598-56FA-8296-FF1575CE43DF'], + 'TableName' => ['description' => 'The table name.', 'type' => 'string', 'example' => 'test_table', 'title' => ''], + 'Fields' => [ + 'description' => 'The list of fields in the data table.', + 'type' => 'array', + 'items' => [ + 'description' => 'The details of a field.', + 'type' => 'object', + 'properties' => [ + 'Name' => ['description' => 'The field name.', 'type' => 'string', 'example' => 'age', 'title' => ''], + 'Type' => ['description' => 'The field type.', 'type' => 'string', 'example' => 'BIGINT', 'title' => ''], + 'Meaning' => ['description' => 'The meaning of the field.', 'type' => 'string', 'example' => '""', 'title' => ''], + 'IsDimensionField' => ['description' => 'Indicates whether the field is a dimension field.', 'type' => 'boolean', 'example' => 'false', 'title' => ''], + 'IsPartitionField' => ['description' => 'Indicates whether the field is a partition field.', 'type' => 'boolean', 'example' => 'true', 'title' => ''], + ], + 'title' => '', + 'example' => '', + ], + 'title' => '', + 'example' => '', + ], + ], + 'example' => '', + ], + ], + ], + 'staticInfo' => ['returnType' => 'synchronous'], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"74D958EF-3598-56FA-8296-FF1575CE43DF\\",\\n \\"TableName\\": \\"test_table\\",\\n \\"Fields\\": [\\n {\\n \\"Name\\": \\"age\\",\\n \\"Type\\": \\"BIGINT\\",\\n \\"Meaning\\": \\"\\\\\\"\\\\\\"\\",\\n \\"IsDimensionField\\": false,\\n \\"IsPartitionField\\": true\\n }\\n ]\\n}","type":"json"}]', + 'title' => 'Retrieve table information under a resource', + 'changeSet' => [ + ['createdAt' => '2024-02-22T03:35:44.000Z', 'description' => 'Request parameters changed, Response parameters changed'], + ], + 'flowControl' => [ + 'flowControlList' => [], + ], + 'ramActions' => [ + [ + 'operationType' => 'none', + 'ramAction' => [ + 'action' => 'pairec:GetInstanceResourceTable', + 'authLevel' => 'operate', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'PAIRecService', 'resourceType' => 'All Resource', 'arn' => '*'], + ], + ], + ], + ], + ], + 'GetLaboratory' => [ + 'path' => '/api/v1/laboratories/{LaboratoryId}', + 'methods' => ['get'], + 'schemes' => ['http', 'https'], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'consumes' => ['application/json'], + 'produces' => ['application/json'], 'operationType' => 'read', 'deprecated' => false, 'systemTags' => [ - 'operationType' => 'list', + 'operationType' => 'get', 'riskType' => 'none', 'chargeType' => 'free', - 'abilityTreeCode' => '183391', - 'abilityTreeNodes' => [ - 'FEATURElearnN0NAWV', - ], + 'abilityTreeNodes' => ['FEATURElearnN0NAWV'], ], 'parameters' => [ [ - 'name' => 'LayerId', + 'name' => 'LaboratoryId', + 'in' => 'path', + 'schema' => ['description' => 'The laboratory ID. You can obtain this ID by calling the ListLaboratories operation.', 'type' => 'string', 'required' => true, 'example' => '3', 'title' => ''], + ], + [ + 'name' => 'InstanceId', 'in' => 'query', + 'schema' => ['description' => 'The instance ID. You can obtain this ID by calling the ListInstances operation.', 'type' => 'string', 'required' => true, 'example' => 'pairec-test1', 'title' => ''], + ], + ], + 'responses' => [ + 200 => [ 'schema' => [ - 'title' => '层ID。', - 'description' => '', - 'type' => 'string', - 'required' => false, - 'example' => '3', + 'title' => 'Schema of Response', + 'description' => 'The data returned in the response.', + 'type' => 'object', + 'properties' => [ + 'RequestId' => ['title' => 'Id of the request', 'description' => 'The request ID.', 'type' => 'string', 'example' => '1C0898E5-9220-5443-B2D9-445FF0688215'], + 'SceneId' => ['description' => 'The scene ID.', 'type' => 'string', 'example' => '3', 'title' => ''], + 'Name' => ['description' => 'The laboratory name.', 'type' => 'string', 'example' => 'laboratory1', 'title' => ''], + 'Description' => ['description' => 'The laboratory description.', 'type' => 'string', 'example' => 'This is a test.', 'title' => ''], + 'DebugUsers' => ['description' => 'The debug users.', 'type' => 'string', 'example' => 'user1,user2,user3', 'title' => ''], + 'DebugCrowdId' => ['description' => 'The debug crowd ID.', 'type' => 'string', 'example' => '3', 'title' => ''], + 'BucketCount' => ['description' => 'The number of buckets.', 'type' => 'integer', 'format' => 'int32', 'example' => '100', 'title' => ''], + 'Buckets' => ['description' => 'The assigned buckets.', 'type' => 'string', 'example' => '1,2,3,10-20', 'title' => ''], + 'BucketType' => ['description' => 'The bucketing method. Valid values:', 'type' => 'string', 'example' => 'Filter', 'title' => ''], + 'Filter' => ['description' => 'The filter.', 'type' => 'string', 'example' => 'filter=xxx', 'title' => ''], + 'Environment' => ['description' => 'The environment. Valid values:', 'type' => 'string', 'example' => 'Daily', 'title' => ''], + 'Type' => ['description' => 'The laboratory type. Valid values:', 'type' => 'string', 'example' => 'Base', 'title' => ''], + 'Status' => ['description' => 'The status of the laboratory. Valid values:', 'type' => 'string', 'example' => 'Offline', 'title' => ''], + 'CrowdId' => ['description' => 'The crowd ID.', 'type' => 'string', 'example' => '3', 'title' => ''], + ], + 'example' => '', ], ], + ], + 'staticInfo' => ['returnType' => 'synchronous'], + 'title' => 'Obtain Lab Details', + 'summary' => 'Retrieves the details of a specified laboratory.', + 'changeSet' => [], + 'flowControl' => [ + 'flowControlList' => [], + ], + 'ramActions' => [ [ - 'name' => 'Status', - 'in' => 'query', - 'schema' => [ - 'title' => '状态过滤'."\n" - .'● Offline-未上线'."\n" - .'● Online-已上线'."\n" - .'● Pushed-已推全', - 'description' => '', - 'type' => 'string', - 'required' => false, - 'example' => 'Online', + 'operationType' => 'get', + 'ramAction' => [ + 'action' => 'pairec:GetLaboratory', + 'authLevel' => 'operate', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'PAIRecService', 'resourceType' => 'All Resource', 'arn' => '*'], + ], ], ], + ], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"1C0898E5-9220-5443-B2D9-445FF0688215\\",\\n \\"SceneId\\": \\"3\\",\\n \\"Name\\": \\"laboratory1\\",\\n \\"Description\\": \\"This is a test.\\",\\n \\"DebugUsers\\": \\"user1,user2,user3\\",\\n \\"DebugCrowdId\\": \\"3\\",\\n \\"BucketCount\\": 100,\\n \\"Buckets\\": \\"1,2,3,10-20\\",\\n \\"BucketType\\": \\"Filter\\",\\n \\"Filter\\": \\"filter=xxx\\",\\n \\"Environment\\": \\"Daily\\",\\n \\"Type\\": \\"Base\\",\\n \\"Status\\": \\"Offline\\",\\n \\"CrowdId\\": \\"3\\"\\n}","type":"json"}]', + ], + 'GetLayer' => [ + 'summary' => 'Retrieves the details of a specified layer.', + 'path' => '/api/v1/layers/{LayerId}', + 'methods' => ['get'], + 'schemes' => ['http', 'https'], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'consumes' => ['application/json'], + 'produces' => ['application/json'], + 'operationType' => 'read', + 'deprecated' => false, + 'systemTags' => [ + 'operationType' => 'get', + 'riskType' => 'none', + 'chargeType' => 'free', + 'abilityTreeCode' => '183176', + 'abilityTreeNodes' => ['FEATURElearnN0NAWV'], + ], + 'parameters' => [ + [ + 'name' => 'LayerId', + 'in' => 'path', + 'schema' => ['description' => 'The ID of the layer. You can call the ListLayers operation to obtain this ID.', 'type' => 'string', 'required' => true, 'example' => '3', 'title' => ''], + ], [ 'name' => 'InstanceId', 'in' => 'query', + 'schema' => ['description' => 'The ID of the instance. You can call the ListInstances operation to obtain this ID.', 'type' => 'string', 'required' => true, 'example' => 'pairec-cn-abcdefg1234', 'title' => ''], + ], + ], + 'responses' => [ + 200 => [ 'schema' => [ - 'title' => '实例ID。', - 'description' => '', - 'type' => 'string', - 'required' => true, - 'example' => 'pairec-cn-abcdefg1234', + 'title' => 'Schema of Response', + 'description' => 'The response object.', + 'type' => 'object', + 'properties' => [ + 'RequestId' => ['title' => 'Id of the request', 'description' => 'The ID of the request.', 'type' => 'string', 'example' => 'EE97D06A-2AA0-5AD9-B6CF-8A267924D691'], + 'LaboratoryId' => ['description' => 'The ID of the laboratory.', 'type' => 'string', 'example' => '3', 'title' => ''], + 'SceneId' => ['description' => 'The ID of the scene.', 'type' => 'string', 'example' => '4', 'title' => ''], + 'Name' => ['description' => 'The name of the layer.', 'type' => 'string', 'example' => 'layer1', 'title' => ''], + 'Description' => ['description' => 'The description of the layer.', 'type' => 'string', 'example' => 'This is a test.', 'title' => ''], + 'ResidualFlow' => ['description' => 'The residual traffic in the experiment layer.', 'type' => 'integer', 'format' => 'int64', 'example' => '10', 'title' => ''], + 'GmtCreateTime' => ['description' => 'The time when the experiment layer was created.', 'type' => 'string', 'example' => '2022-10-13 17:34:52.0', 'title' => ''], + ], + 'example' => '', ], ], + ], + 'staticInfo' => ['returnType' => 'synchronous'], + 'title' => 'Obtain Layer Details', + 'changeSet' => [ + ['createdAt' => '2024-03-20T06:05:19.000Z', 'description' => 'Response parameters changed'], + ], + 'flowControl' => [ + 'flowControlList' => [], + ], + 'ramActions' => [ [ - 'name' => 'RegionId', - 'in' => 'query', - 'schema' => [ - 'type' => 'string', + 'operationType' => 'get', + 'ramAction' => [ + 'action' => 'pairec:GetLayer', + 'authLevel' => 'operate', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'PAIRecService', 'resourceType' => 'All Resource', 'arn' => '*'], + ], ], ], + ], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"EE97D06A-2AA0-5AD9-B6CF-8A267924D691\\",\\n \\"LaboratoryId\\": \\"3\\",\\n \\"SceneId\\": \\"4\\",\\n \\"Name\\": \\"layer1\\",\\n \\"Description\\": \\"This is a test.\\",\\n \\"ResidualFlow\\": 10,\\n \\"GmtCreateTime\\": \\"2022-10-13 17:34:52.0\\"\\n}","type":"json"}]', + ], + 'GetRecallManagementConfig' => [ + 'summary' => 'Retrieves the recall management configuration.', + 'path' => '/api/v1/recallmanagementconfigs', + 'methods' => ['get'], + 'schemes' => ['https'], + 'security' => [ [ - 'name' => 'TimeRangeStart', - 'in' => 'query', - 'schema' => [ - 'type' => 'string', - ], + 'AK' => [], ], + ], + 'consumes' => ['application/json'], + 'produces' => ['application/json'], + 'operationType' => 'read', + 'deprecated' => false, + 'systemTags' => [ + 'operationType' => 'get', + 'riskType' => 'none', + 'chargeType' => 'free', + 'abilityTreeNodes' => ['FEATURElearnN0NAWV'], + ], + 'parameters' => [ [ - 'name' => 'TimeRangeEnd', + 'name' => 'InstanceId', 'in' => 'query', - 'schema' => [ - 'type' => 'string', - ], + 'schema' => ['description' => 'The instance ID. You can call the ListInstances operation to obtain the instance ID.', 'type' => 'string', 'required' => false, 'example' => 'learn-pairec-xxx', 'title' => ''], ], ], 'responses' => [ 200 => [ 'schema' => [ - 'title' => 'Schema of Response', + 'title' => '', 'description' => 'Schema of Response', 'type' => 'object', 'properties' => [ - 'RequestId' => [ - 'title' => 'Id of the request', - 'description' => 'Id of the request', - 'type' => 'string', - 'example' => '59CE7EC6-F268-5D71-9215-32922CC50D72', - ], - 'TotalCount' => [ - 'title' => '列表内元素总数。', - 'description' => '', - 'type' => 'integer', - 'format' => 'int64', - 'example' => '10', - ], - 'ExperimentGroups' => [ - 'title' => '实验组列表。', - 'description' => '', + 'RequestId' => ['title' => '', 'description' => 'Id of the request', 'type' => 'string', 'example' => '728C5E01-ABF6-5AA8-B9FC-B3BA05DECC77'], + 'UserName' => ['description' => 'The username.', 'type' => 'string', 'example' => 'scene_test', 'title' => ''], + 'NetworkConfigs' => [ + 'description' => 'The network configuration information.', 'type' => 'array', 'items' => [ + 'description' => 'The network configuration details.', 'type' => 'object', 'properties' => [ - 'ExperimentGroupId' => [ - 'title' => '实验组ID。', - 'description' => '', - 'type' => 'string', - 'example' => '3', - ], - 'LayerId' => [ - 'title' => '层ID。', - 'description' => '', - 'type' => 'string', - 'example' => '3', - ], - 'LaboratoryId' => [ - 'title' => '实验室ID。', - 'description' => '', - 'type' => 'string', - 'example' => '4', - ], - 'SceneId' => [ - 'title' => '场景ID。', - 'description' => '', - 'type' => 'string', - 'example' => '1', - ], - 'Name' => [ - 'title' => '实验组名称。', - 'description' => '', - 'type' => 'string', - 'example' => 'experiment_group1', - ], - 'Description' => [ - 'title' => '实验组描述。', - 'description' => '', - 'type' => 'string', - 'example' => 'This is a test.', - ], - 'DebugUsers' => [ - 'title' => '调试用户。', - 'description' => '', - 'type' => 'string', - 'example' => '1124512470******,1124512471******,1124512472******', - ], - 'DebugCrowdId' => [ - 'title' => '调试人群ID。', - 'description' => '', - 'type' => 'string', - 'example' => '4', - ], - 'Owner' => [ - 'title' => '创建人。', - 'description' => '', - 'type' => 'string', - 'example' => '1124512470******', - ], - 'NeedAA' => [ - 'title' => '是否需要AB实验组。', - 'description' => '', - 'type' => 'boolean', - 'example' => 'true', - ], - 'Filter' => [ - 'title' => '过滤条件。', - 'description' => '', - 'type' => 'string', - 'example' => 'gender=female', - ], - 'DistributionType' => [ - 'title' => '分流方式。'."\n" - .'● UserId-用户ID'."\n" - .'● TimeDuration-时段', - 'description' => '', - 'type' => 'string', - 'example' => 'UserId', - ], - 'DistributionTimeDuration' => [ - 'title' => '分流时段。', - 'description' => '', - 'type' => 'integer', - 'format' => 'int32', - 'example' => '5', - ], - 'CrowdId' => [ - 'title' => '人群ID。', - 'description' => '', - 'type' => 'string', - 'example' => '3', - ], - 'Config' => [ - 'title' => '实验组配置。', - 'description' => '', - 'type' => 'string', - 'example' => '{}', - ], - 'ReservedBuckets' => [ - 'title' => '预留桶号。', - 'description' => '', - 'type' => 'string', - 'example' => '1,2,3,4', - ], - 'Status' => [ - 'title' => '实验组状态。'."\n" - .'● Offline-未上线'."\n" - .'● Online-已上线'."\n" - .'● Pushed-已推全', - 'description' => '', - 'type' => 'string', - 'example' => 'Offline', - ], - 'CrowdTargetType' => [ - 'type' => 'string', - ], - 'RandomFlow' => [ - 'type' => 'integer', - 'format' => 'int64', - ], - 'HoldingBuckets' => [ - 'type' => 'string', + 'VpcId' => ['description' => 'The virtual private cloud (VPC) ID.', 'type' => 'string', 'example' => 'vpc-xxx', 'title' => ''], + 'Status' => ['description' => 'The network connectivity status. Valid values:'."\n" + ."\n" + .'- Connecting: connecting.'."\n" + ."\n" + .'- Connected: connected.'."\n" + ."\n" + .'- ConnectionFailed: connection failed.'."\n" + ."\n" + .'- Updating: updating.'."\n" + ."\n" + .'- UpdateFailed: update failed.', 'type' => 'string', 'example' => 'Connecting', 'title' => ''], + 'VswitchIds' => [ + 'description' => 'The zones.', + 'type' => 'object', + 'additionalProperties' => ['description' => 'The vSwitch information.', 'type' => 'string', 'example' => 'vsw-xxx', 'title' => ''], + 'title' => '', + 'example' => '', ], + 'PrivateLinkAddress' => ['description' => 'The private endpoint.', 'type' => 'string', 'example' => 'http://xxx', 'title' => ''], + 'PublicEndpoint' => ['title' => '', 'description' => 'The public endpoint.', 'type' => 'string', 'example' => '""'], + 'Token' => ['title' => '', 'description' => 'The public network connection token.', 'type' => 'string', 'example' => '""'], ], + 'title' => '', + 'example' => '', ], + 'title' => '', + 'example' => '', ], ], + 'example' => '', ], ], ], - 'staticInfo' => [ - 'returnType' => 'synchronous', + 'staticInfo' => ['returnType' => 'synchronous'], + 'title' => 'Retrieve recall management configuration', + 'changeSet' => [], + 'flowControl' => [ + 'flowControlList' => [], ], - 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"59CE7EC6-F268-5D71-9215-32922CC50D72\\",\\n \\"TotalCount\\": 10,\\n \\"ExperimentGroups\\": [\\n {\\n \\"ExperimentGroupId\\": \\"3\\",\\n \\"LayerId\\": \\"3\\",\\n \\"LaboratoryId\\": \\"4\\",\\n \\"SceneId\\": \\"1\\",\\n \\"Name\\": \\"experiment_group1\\",\\n \\"Description\\": \\"This is a test.\\",\\n \\"DebugUsers\\": \\"1124512470******,1124512471******,1124512472******\\",\\n \\"DebugCrowdId\\": \\"4\\",\\n \\"Owner\\": \\"1124512470******\\",\\n \\"NeedAA\\": true,\\n \\"Filter\\": \\"gender=female\\",\\n \\"DistributionType\\": \\"UserId\\",\\n \\"DistributionTimeDuration\\": 5,\\n \\"CrowdId\\": \\"3\\",\\n \\"Config\\": \\"{}\\",\\n \\"ReservedBuckets\\": \\"1,2,3,4\\",\\n \\"Status\\": \\"Offline\\",\\n \\"CrowdTargetType\\": \\"All\\",\\n \\"RandomFlow\\": 20,\\n \\"HoldingBuckets\\": \\"1,2,3,4\\"\\n }\\n ]\\n}","type":"json"}]', - ], - 'GetExperimentGroup' => [ - 'summary' => '获取指定实验组详细信息。', - 'path' => '/api/v1/experimentgroups/{ExperimentGroupId}', - 'methods' => [ - 'get', - ], - 'schemes' => [ - 'http', - 'https', + 'ramActions' => [ + [ + 'operationType' => 'get', + 'ramAction' => [ + 'action' => 'pairec:GetRecallManagementConfig', + 'authLevel' => 'operate', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'PAIRecService', 'resourceType' => 'All Resource', 'arn' => '*'], + ], + ], + ], ], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"728C5E01-ABF6-5AA8-B9FC-B3BA05DECC77\\",\\n \\"UserName\\": \\"scene_test\\",\\n \\"NetworkConfigs\\": [\\n {\\n \\"VpcId\\": \\"vpc-xxx\\",\\n \\"Status\\": \\"Connecting\\",\\n \\"VswitchIds\\": {\\n \\"key\\": \\"vsw-xxx\\"\\n },\\n \\"PrivateLinkAddress\\": \\"http://xxx\\",\\n \\"PublicEndpoint\\": \\"\\\\\\"\\\\\\"\\",\\n \\"Token\\": \\"\\\\\\"\\\\\\"\\"\\n }\\n ]\\n}","type":"json"}]', + ], + 'GetRecallManagementJob' => [ + 'path' => '/api/v1/recallmanagementjobs/{RecallManagementJobId}', + 'methods' => ['get'], + 'schemes' => ['https'], 'security' => [ [ 'AK' => [], ], ], - 'consumes' => [ - 'application/json', - ], - 'produces' => [ - 'application/json', - ], + 'consumes' => ['application/json'], + 'produces' => ['application/json'], 'operationType' => 'read', 'deprecated' => false, 'systemTags' => [ 'operationType' => 'get', 'riskType' => 'none', 'chargeType' => 'free', - 'abilityTreeCode' => '183395', - 'abilityTreeNodes' => [ - 'FEATURElearnN0NAWV', - ], + 'abilityTreeNodes' => ['FEATURElearnN0NAWV'], ], 'parameters' => [ [ - 'name' => 'ExperimentGroupId', + 'name' => 'RecallManagementJobId', 'in' => 'path', - 'schema' => [ - 'title' => '实验组ID。', - 'description' => '', - 'type' => 'string', - 'required' => true, - 'example' => '3', - ], + 'schema' => ['description' => 'The job ID.', 'type' => 'string', 'required' => true, 'example' => '1', 'title' => ''], ], [ 'name' => 'InstanceId', 'in' => 'query', - 'schema' => [ - 'title' => '实例ID。', - 'description' => '', - 'type' => 'string', - 'required' => true, - 'example' => 'pairec-cn-abcdefg1234', - ], + 'schema' => ['description' => 'The instance ID.', 'type' => 'string', 'required' => true, 'example' => 'pairec-1324***', 'title' => ''], ], ], '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' => 'BDB621CB-A81E-5D39-8793-39A365CBCC74', - ], - 'LayerId' => [ - 'title' => '层ID。', - 'description' => '', - 'type' => 'string', - 'example' => '3', - ], - 'LaboratoryId' => [ - 'title' => '实验室ID。', - 'description' => '', - 'type' => 'string', - 'example' => '4', - ], - 'SceneId' => [ - 'title' => '场景ID。', - 'description' => '', - 'type' => 'string', - 'example' => '1', - ], - 'Name' => [ - 'title' => '实验组名称。', - 'description' => '', - 'type' => 'string', - 'example' => 'experiment_group1', - ], - 'Description' => [ - 'title' => '实验组描述。', - 'description' => '', - 'type' => 'string', - 'example' => 'This is a test.', - ], - 'DebugUsers' => [ - 'title' => '调试用户。', - 'description' => '', - 'type' => 'string', - 'example' => '1124512470******,1124512471******,1124512472******', - ], - 'DebugCrowdId' => [ - 'title' => '调试人群ID。', - 'description' => '', - 'type' => 'string', - 'example' => '4', - ], - 'Owner' => [ - 'title' => '创建人。', - 'description' => '', - 'type' => 'string', - 'example' => '1124512470******', - ], - 'NeedAA' => [ - 'title' => '是否需要AB实验组。', - 'description' => '', - 'type' => 'boolean', - 'example' => 'true', - ], - 'Filter' => [ - 'title' => '过滤条件。', - 'description' => '', - 'type' => 'string', - 'example' => 'gender=female', - ], - 'DistributionType' => [ - 'title' => '分流方式。'."\n" - .'● UserId-用户ID'."\n" - .'● TimeDuration-时段', - 'description' => '', - 'type' => 'string', - 'example' => 'UserId', - ], - 'DistributionTimeDuration' => [ - 'title' => '分流时段。', - 'description' => '', - 'type' => 'integer', - 'format' => 'int32', - 'example' => '5', - ], - 'CrowdId' => [ - 'title' => '人群ID。', - 'description' => '', - 'type' => 'string', - 'example' => '3', - ], - 'Config' => [ - 'title' => '实验组配置。', - 'description' => '', - 'type' => 'string', - 'example' => '{"RankBy": "Score"}', - ], - 'ReservedBuckets' => [ - 'title' => '预留桶号。', - 'description' => '', - 'type' => 'string', - 'example' => '1,2,3,4', - ], - 'Status' => [ - 'title' => '实验组状态。'."\n" - .'● Offline-未上线'."\n" - .'● Online-已上线'."\n" - .'● Pushed-已推全', - 'description' => '', - 'type' => 'string', - 'example' => 'Offline', - ], - 'CrowdTargetType' => [ - 'type' => 'string', - ], - 'RandomFlow' => [ - 'type' => 'integer', - 'format' => 'int64', + 'RequestId' => ['description' => 'The request ID.', 'type' => 'string', 'title' => '', 'example' => '728C5E01-ABF6-5AA8-B9FC-B3BA05DECC77'], + 'RecallManagementJobId' => ['description' => 'The recall management job ID.', 'type' => 'string', 'example' => '1', 'title' => ''], + 'RecallManagerTableInfo' => [ + 'type' => 'object', + 'properties' => [ + 'RecallManagerTableVersionId' => ['description' => 'The recall management table version ID.', 'type' => 'string', 'example' => '20250101000', 'title' => ''], + 'DataVersion' => ['description' => 'The data version.', 'type' => 'string', 'example' => 'ds=20250701', 'title' => ''], + 'SourceTableRowCount' => ['description' => 'The number of rows in the source table.', 'type' => 'string', 'example' => '100', 'title' => ''], + 'SourceTableDataSize' => ['description' => 'The data size of the source table.', 'type' => 'string', 'example' => '10000', 'title' => ''], + ], + 'description' => 'Details of the recall management table.', + 'title' => '', + 'example' => '', ], - 'HoldingBuckets' => [ - 'type' => 'string', + 'Log' => ['description' => 'The log of the job.', 'type' => 'string', 'example' => '"success"', 'title' => ''], + 'Status' => ['description' => 'The status of the job. Valid values are:'."\n" + ."\n" + .'- `Init`: Initializing.'."\n" + ."\n" + .'- `Running`: Running.'."\n" + ."\n" + .'- `Success`: Successful.'."\n" + ."\n" + .'- `Failed`: Failed.', 'type' => 'string', 'example' => 'Running', 'title' => ''], + 'StartTime' => ['description' => 'The time when the job started.', 'type' => 'string', 'example' => '2021-12-15T22:24:33.132', 'title' => ''], + 'EndTime' => ['description' => 'The time when the job ended.', 'type' => 'string', 'example' => '2021-12-15T23:24:33.132', 'title' => ''], + 'RecallManagementTableInfo' => [ + 'type' => 'object', + 'properties' => [ + 'RecallManagementTableVersionId' => ['description' => 'The recall management table version ID.', 'type' => 'string', 'example' => '20250101000', 'title' => ''], + 'DataVersion' => ['description' => 'The data version.', 'type' => 'string', 'example' => 'ds=20250701', 'title' => ''], + 'SourceTableRowCount' => ['description' => 'The number of rows in the source table.', 'type' => 'string', 'example' => '100', 'title' => ''], + 'SourceTableDataSize' => ['description' => 'The data size of the source table.', 'type' => 'string', 'example' => '10000', 'title' => ''], + ], + 'description' => 'Details of the recall management table.', + 'title' => '', + 'example' => '', ], ], + 'title' => '', + 'description' => 'The response body.', + 'example' => '', ], ], ], - 'staticInfo' => [ - 'returnType' => 'synchronous', + 'staticInfo' => ['returnType' => 'synchronous'], + 'title' => 'GetRecallManagementJob', + 'summary' => 'Retrieves the details of a specific recall management job, including its status and log.', + 'description' => '## Description'."\n" + ."\n" + .'Retrieves the details of a specific recall management job using its `RecallManagementJobId` and `InstanceId`. The response includes the job\'s status (such as Init, Running, Success, or Failed), start and end times, related table information, and operation log. To make a request, specify the `RecallManagementJobId` as a path parameter and the `InstanceId` as a query parameter.', + 'changeSet' => [], + 'flowControl' => [ + 'flowControlList' => [], ], - 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"BDB621CB-A81E-5D39-8793-39A365CBCC74\\",\\n \\"LayerId\\": \\"3\\",\\n \\"LaboratoryId\\": \\"4\\",\\n \\"SceneId\\": \\"1\\",\\n \\"Name\\": \\"experiment_group1\\",\\n \\"Description\\": \\"This is a test.\\",\\n \\"DebugUsers\\": \\"1124512470******,1124512471******,1124512472******\\",\\n \\"DebugCrowdId\\": \\"4\\",\\n \\"Owner\\": \\"1124512470******\\",\\n \\"NeedAA\\": true,\\n \\"Filter\\": \\"gender=female\\",\\n \\"DistributionType\\": \\"UserId\\",\\n \\"DistributionTimeDuration\\": 5,\\n \\"CrowdId\\": \\"3\\",\\n \\"Config\\": \\"{\\\\\\"RankBy\\\\\\": \\\\\\"Score\\\\\\"}\\",\\n \\"ReservedBuckets\\": \\"1,2,3,4\\",\\n \\"Status\\": \\"Offline\\",\\n \\"CrowdTargetType\\": \\"All\\",\\n \\"RandomFlow\\": 20,\\n \\"HoldingBuckets\\": \\"1,2,3,4\\"\\n}","type":"json"}]', - ], - 'CloneExperimentGroup' => [ - 'summary' => '克隆实验组，并克隆实验组下的所有实验至新的实验组中。', - 'path' => '/api/v1/experimentgroups/{ExperimentGroupId}/action/clone', - 'methods' => [ - 'post', - ], - 'schemes' => [ - 'http', - 'https', + 'ramActions' => [ + [ + 'operationType' => 'get', + 'ramAction' => [ + 'action' => 'pairec:GetRecallManagementJob', + 'authLevel' => 'operate', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'PAIRecService', 'resourceType' => 'All Resource', 'arn' => '*'], + ], + ], + ], ], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"728C5E01-ABF6-5AA8-B9FC-B3BA05DECC77\\",\\n \\"RecallManagementJobId\\": \\"1\\",\\n \\"RecallManagerTableInfo\\": {\\n \\"RecallManagerTableVersionId\\": \\"20250101000\\",\\n \\"DataVersion\\": \\"ds=20250701\\",\\n \\"SourceTableRowCount\\": \\"100\\",\\n \\"SourceTableDataSize\\": \\"10000\\"\\n },\\n \\"Log\\": \\"\\\\\\"success\\\\\\"\\",\\n \\"Status\\": \\"Running\\",\\n \\"StartTime\\": \\"2021-12-15T22:24:33.132\\",\\n \\"EndTime\\": \\"2021-12-15T23:24:33.132\\",\\n \\"RecallManagementTableInfo\\": {\\n \\"RecallManagementTableVersionId\\": \\"20250101000\\",\\n \\"DataVersion\\": \\"ds=20250701\\",\\n \\"SourceTableRowCount\\": \\"100\\",\\n \\"SourceTableDataSize\\": \\"10000\\"\\n }\\n}","type":"json"}]', + ], + 'GetRecallManagementService' => [ + 'path' => '/api/v1/recallmanagementservices/{RecallManagementServiceId}', + 'methods' => ['get'], + 'schemes' => ['https'], 'security' => [ [ 'AK' => [], ], ], - 'consumes' => [ - 'application/json', - ], - 'produces' => [ - 'application/json', - ], - 'operationType' => 'readAndWrite', + 'consumes' => ['application/json'], + 'produces' => ['application/json'], + 'operationType' => 'read', 'deprecated' => false, 'systemTags' => [ - 'operationType' => 'none', + 'operationType' => 'get', 'riskType' => 'none', 'chargeType' => 'free', - 'abilityTreeNodes' => [ - 'FEATURElearnN0NAWV', - ], + 'abilityTreeNodes' => ['FEATURElearnN0NAWV'], ], 'parameters' => [ [ - 'name' => 'ExperimentGroupId', + 'name' => 'RecallManagementServiceId', 'in' => 'path', - 'schema' => [ - 'title' => '实验组ID。', - 'description' => '', - 'type' => 'string', - 'required' => true, - 'example' => '3', - ], + 'schema' => ['description' => 'The ID of the recall management service.', 'type' => 'string', 'required' => false, 'example' => '3', 'title' => ''], ], [ - 'name' => 'body', - 'in' => 'body', - 'style' => 'json', + 'name' => 'InstanceId', + 'in' => 'query', + 'schema' => ['description' => 'The instance ID.', 'type' => 'string', 'required' => false, 'example' => 'pairec-cn-test123', 'title' => ''], + ], + ], + 'responses' => [ + 200 => [ 'schema' => [ - 'title' => '请求body。', - 'description' => '', 'type' => 'object', 'properties' => [ - 'InstanceId' => [ - 'title' => '实例ID。', - 'description' => '', - 'type' => 'string', - 'required' => true, - 'example' => 'pairec-cn-abcdefg1234'."\n", - ], - 'LayerId' => [ - 'title' => '层ID。', - 'description' => '', - 'type' => 'string', - 'required' => true, - 'example' => '3', - ], - 'Environment' => [ - 'title' => '克隆到的环境。'."\n" - .'● Daily-日常环境'."\n" - .'● Pre-预发环境'."\n" - .'● Prod-生产环境', - 'description' => '', - 'type' => 'string', - 'required' => true, - 'example' => 'Daily', - ], + 'RequestId' => ['description' => 'The request ID.', 'type' => 'string', 'title' => '', 'example' => '728C5E01-ABF6-5AA8-B9FC-B3BA05DECC77'], + 'RecallManagementServiceId' => ['description' => 'The ID of the recall management service.', 'type' => 'string', 'example' => '3', 'title' => ''], + 'Name' => ['description' => 'The name of the recall management service.', 'type' => 'string', 'example' => 'hot_group_recall', 'title' => ''], + 'Description' => ['description' => 'The description of the recall management service.', 'type' => 'string', 'example' => 'this is a test recall', 'title' => ''], + 'CurrentRecallManagementServiceVersionId' => ['description' => 'The ID of the active version of the recall management service.', 'type' => 'string', 'example' => '1', 'title' => ''], + 'CurrentRecallManagementServiceVersionName' => ['description' => 'The name of the active version of the recall management service.', 'type' => 'string', 'example' => 'version-1', 'title' => ''], + 'Status' => ['description' => 'The status of the recall management service. Valid values:'."\n" + ."\n" + .'- Online: The service is running and available.'."\n" + ."\n" + .'- Offline: The service is stopped or unavailable.', 'type' => 'string', 'example' => 'Online', 'title' => ''], + 'GmtCreateTime' => ['description' => 'The creation time.', 'type' => 'string', 'example' => '2021-12-15T23:24:33.132+08:00', 'title' => ''], + 'GmtModifiedTime' => ['description' => 'The modification time.', 'type' => 'string', 'example' => '2021-12-15T23:24:33.132+08:00', 'title' => ''], ], - 'required' => false, + 'title' => '', + 'description' => 'The response object.', + 'example' => '', ], ], ], + 'staticInfo' => ['returnType' => 'synchronous'], + 'title' => 'GetRecallManagementService', + 'summary' => 'Retrieves the details of a specified recall management service, including its status and version.', + 'description' => '## Request', + 'changeSet' => [], + 'flowControl' => [ + 'flowControlList' => [], + ], + 'ramActions' => [ + [ + 'operationType' => 'get', + 'ramAction' => [ + 'action' => 'pairec:GetRecallManagementService', + 'authLevel' => 'operate', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'PAIRecService', 'resourceType' => 'All Resource', 'arn' => '*'], + ], + ], + ], + ], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"728C5E01-ABF6-5AA8-B9FC-B3BA05DECC77\\",\\n \\"RecallManagementServiceId\\": \\"3\\",\\n \\"Name\\": \\"hot_group_recall\\",\\n \\"Description\\": \\"this is a test recall\\",\\n \\"CurrentRecallManagementServiceVersionId\\": \\"1\\",\\n \\"CurrentRecallManagementServiceVersionName\\": \\"version-1\\",\\n \\"Status\\": \\"Online\\",\\n \\"GmtCreateTime\\": \\"2021-12-15T23:24:33.132+08:00\\",\\n \\"GmtModifiedTime\\": \\"2021-12-15T23:24:33.132+08:00\\"\\n}","type":"json"}]', + ], + 'GetRecallManagementServiceVersion' => [ + 'summary' => 'Retrieves the version details of the recall management service.', + 'path' => '/api/v1/recallmanagementservices/{RecallManagementServiceId}/versions/{RecallManagementServiceVersionId}', + 'methods' => ['get'], + 'schemes' => ['https'], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'consumes' => ['application/json'], + 'produces' => ['application/json'], + 'operationType' => 'read', + 'deprecated' => false, + 'systemTags' => [ + 'operationType' => 'none', + 'riskType' => 'none', + 'chargeType' => 'free', + 'abilityTreeNodes' => ['FEATURElearnN0NAWV'], + ], + 'parameters' => [ + [ + 'name' => 'RecallManagementServiceId', + 'in' => 'path', + 'schema' => ['description' => 'The ID of the recall management service.', 'type' => 'string', 'required' => false, 'example' => '3', 'title' => ''], + ], + [ + 'name' => 'RecallManagementServiceVersionId', + 'in' => 'path', + 'schema' => ['description' => 'The ID of the recall management service version.', 'type' => 'string', 'required' => false, 'example' => '2', 'title' => ''], + ], + [ + 'name' => 'InstanceId', + 'in' => 'query', + 'schema' => ['description' => 'The ID of the instance.', 'type' => 'string', 'required' => false, 'example' => 'learn-pairec-xxx', 'title' => ''], + ], + ], 'responses' => [ 200 => [ 'schema' => [ - 'title' => 'Schema of Response', - 'description' => 'Schema of Response', + 'description' => 'The response schema.', + 'title' => 'Schema of Response ', 'type' => 'object', 'properties' => [ - 'RequestId' => [ - 'title' => 'Id of the request', - 'description' => 'Id of the request', - 'type' => 'string', - 'example' => '12A65C6C-AFA1-59B2-9A66-A9E0BB73F0E5', - ], - 'ExperimentGroupId' => [ - 'title' => '克隆后的实验组ID。', - 'description' => '', - 'type' => 'string', - 'example' => '3', + 'RequestId' => ['title' => 'Id of the request ', 'description' => 'The request ID.', 'type' => 'string', 'example' => 'E15A1443-7917-5BE0-AE70-25538ECF398D'], + 'RecallManagementServiceVersionId' => ['description' => 'The identifier of the recall service version.', 'type' => 'string', 'example' => '2', 'title' => ''], + 'Name' => ['description' => 'The name of the recall service version.', 'type' => 'string', 'example' => 'V1', 'title' => ''], + 'IsEffective' => ['description' => 'Indicates whether the current version is effective.', 'type' => 'boolean', 'default' => 'false', 'title' => '', 'example' => ''], + 'Configs' => [ + 'description' => 'The configuration details.', + 'type' => 'object', + 'properties' => [ + 'RecallConfigs' => [ + 'description' => 'The recall service version configurations.', + 'type' => 'array', + 'items' => [ + 'description' => 'A recall service version configuration.', + 'type' => 'object', + 'properties' => [ + 'RecallManagementServiceVersionConfigId' => ['description' => 'The identifier of the recall service version configuration.', 'type' => 'string', 'example' => '5', 'title' => ''], + 'Name' => ['description' => 'The recall name.', 'type' => 'string', 'example' => 'etrec', 'title' => ''], + 'Description' => ['description' => 'The recall description.', 'type' => 'string', 'example' => 'this is etrec recall', 'title' => ''], + 'Priority' => ['description' => 'The priority. A smaller value indicates a higher priority.', 'type' => 'integer', 'format' => 'int64', 'example' => '10', 'title' => ''], + 'RecallType' => ['description' => 'The recall type.', 'type' => 'string', 'example' => 'X2I', 'title' => ''], + 'RecallManagementTableId' => ['description' => 'The identifier of the recall management table.', 'type' => 'string', 'example' => '2', 'title' => ''], + 'UserVectorRecallManagementTableId' => ['description' => 'The identifier of the user vector recall table.', 'type' => 'string', 'example' => '3', 'title' => ''], + 'UserVectorField' => ['description' => 'The user vector field.', 'type' => 'string', 'example' => 'user_embedding', 'title' => ''], + 'ItemVectorRecallManagementTableId' => ['description' => 'The identifier of the item vector recall table.', 'type' => 'string', 'example' => '4', 'title' => ''], + 'ItemVectorField' => ['description' => 'The item vector field.', 'type' => 'string', 'example' => 'item_embedding', 'title' => ''], + 'ItemConditionArray' => ['description' => 'The item conditions, specified as a string in JSON array format.', 'type' => 'string', 'example' => '[{"option":"<","field":"category","type":"STRING","value":"10"}]', 'title' => ''], + 'ItemConditionExpression' => ['description' => 'The item condition expression.', 'type' => 'string', 'example' => 'age>20', 'title' => ''], + 'SortFields' => ['description' => 'The sort fields.', 'type' => 'string', 'example' => 'name', 'title' => ''], + 'Operators' => [ + 'description' => 'The list of operators to apply.', + 'type' => 'array', + 'items' => [ + 'description' => 'An operator configuration.', + 'type' => 'object', + 'properties' => [ + 'OperatorType' => ['description' => 'The operator type.', 'type' => 'string', 'example' => 'Filter', 'title' => ''], + 'TriggerConfig' => [ + 'description' => 'The configuration for the Trigger operator.', + 'type' => 'object', + 'properties' => [ + 'Field' => ['description' => 'The field name.', 'type' => 'string', 'example' => 'user_id', 'title' => ''], + 'IsRandSort' => ['description' => 'Indicates whether to perform a random sort.', 'type' => 'boolean', 'example' => 'false', 'title' => ''], + 'SortField' => ['description' => 'The sort field.', 'type' => 'string', 'example' => 'create_time', 'title' => ''], + 'FieldQuantityLimit' => ['description' => 'The maximum number of fields.', 'type' => 'integer', 'format' => 'int32', 'example' => '20', 'title' => ''], + ], + 'title' => '', + 'example' => '', + ], + 'FilterConfig' => [ + 'description' => 'The configuration for the Filter operator.', + 'type' => 'object', + 'properties' => [ + 'Experession' => ['description' => 'The filter expression.', 'type' => 'string', 'example' => 'age > 10', 'title' => ''], + ], + 'title' => '', + 'example' => '', + ], + 'FeatureConfig' => [ + 'description' => 'The configuration for the Feature operator.', + 'type' => 'object', + 'properties' => [ + 'Name' => ['description' => 'The feature name.', 'type' => 'string', 'example' => 'city', 'title' => ''], + 'Type' => ['description' => 'The feature type.', 'type' => 'string', 'example' => 'STRING', 'title' => ''], + 'Expression' => ['description' => 'The feature expression.', 'type' => 'string', 'example' => 'city = \'hangzhou\'', 'title' => ''], + ], + 'title' => '', + 'example' => '', + ], + 'JoinConfig' => [ + 'description' => 'The configuration for the Join operator.', + 'type' => 'object', + 'properties' => [ + 'Field' => ['description' => 'The join field.', 'type' => 'string', 'example' => 'item_id', 'title' => ''], + 'RecallManagementTableId' => ['description' => 'The identifier of the join table.', 'type' => 'string', 'example' => '3', 'title' => ''], + 'OutputFields' => [ + 'description' => 'The fields to return.', + 'type' => 'array', + 'items' => ['description' => 'A field to return.', 'type' => 'string', 'example' => 'category', 'title' => ''], + 'title' => '', + 'example' => '', + ], + ], + 'title' => '', + 'example' => '', + ], + ], + 'title' => '', + 'example' => '', + ], + 'title' => '', + 'example' => '', + ], + 'ExtendedConfig' => ['description' => 'Reserved for future use.', 'type' => 'string', 'example' => '""', 'title' => ''], + ], + 'title' => '', + 'example' => '', + ], + 'title' => '', + 'example' => '', + ], + 'MergeConfig' => [ + 'description' => 'The merge configuration.', + 'type' => 'object', + 'properties' => [ + 'RecallManagementServiceVersionConfigId' => ['description' => 'The identifier of the recall service version configuration.', 'type' => 'string', 'example' => '1', 'title' => ''], + 'MergeType' => ['description' => 'The merge type.', 'type' => 'string', 'example' => 'Weight', 'title' => ''], + 'FilterRecallManagementTableIds' => [ + 'description' => 'The identifiers of the tables to filter.', + 'type' => 'array', + 'items' => ['description' => 'The identifier of a table to filter.', 'type' => 'string', 'example' => '3', 'title' => ''], + 'title' => '', + 'example' => '', + ], + 'ItemRecallManagementTableId' => ['description' => 'The identifier of the item table.', 'type' => 'string', 'example' => '2', 'title' => ''], + 'ItemTableFields' => [ + 'description' => 'The output fields from the item table.', + 'type' => 'array', + 'items' => ['description' => 'An output field from the item table.', 'type' => 'string', 'example' => 'item_id', 'title' => ''], + 'title' => '', + 'example' => '', + ], + 'FilterExpression' => ['description' => 'The filter expression.', 'type' => 'string', 'example' => 'age>20', 'title' => ''], + 'ExtendedConfig' => ['description' => 'Reserved for future use.', 'type' => 'string', 'example' => '""', 'title' => ''], + ], + 'title' => '', + 'example' => '', + ], + ], + 'title' => '', + 'example' => '', ], + 'GmtCreateTime' => ['description' => 'The creation time.', 'type' => 'string', 'example' => '2021-12-15T23:24:33.132+08:00', 'title' => ''], + 'GmtModifiedTime' => ['description' => 'The modification time.', 'type' => 'string', 'example' => '2021-12-15T23:24:33.132+08:00', 'title' => ''], ], + 'example' => '', ], ], ], - 'staticInfo' => [ - 'returnType' => 'synchronous', + 'staticInfo' => ['returnType' => 'synchronous'], + 'title' => 'Obtain details of a retrieval management service version', + 'changeSet' => [], + 'flowControl' => [ + 'flowControlList' => [], ], - 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"12A65C6C-AFA1-59B2-9A66-A9E0BB73F0E5\\",\\n \\"ExperimentGroupId\\": \\"3\\"\\n}","type":"json"}]', - ], - 'OnlineExperimentGroup' => [ - 'summary' => '上线实验组。', - 'path' => '/api/v1/experimentgroups/{ExperimentGroupId}/action/online', - 'methods' => [ - 'post', - ], - 'schemes' => [ - 'http', - 'https', + 'ramActions' => [ + [ + 'operationType' => 'none', + 'ramAction' => [ + 'action' => 'pairec:GetRecallManagementServiceVersion', + 'authLevel' => 'operate', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'PAIRecService', 'resourceType' => 'All Resource', 'arn' => '*'], + ], + ], + ], ], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"E15A1443-7917-5BE0-AE70-25538ECF398D\\",\\n \\"RecallManagementServiceVersionId\\": \\"2\\",\\n \\"Name\\": \\"V1\\",\\n \\"IsEffective\\": false,\\n \\"Configs\\": {\\n \\"RecallConfigs\\": [\\n {\\n \\"RecallManagementServiceVersionConfigId\\": \\"5\\",\\n \\"Name\\": \\"etrec\\",\\n \\"Description\\": \\"this is etrec recall\\",\\n \\"Priority\\": 10,\\n \\"RecallType\\": \\"X2I\\",\\n \\"RecallManagementTableId\\": \\"2\\",\\n \\"UserVectorRecallManagementTableId\\": \\"3\\",\\n \\"UserVectorField\\": \\"user_embedding\\",\\n \\"ItemVectorRecallManagementTableId\\": \\"4\\",\\n \\"ItemVectorField\\": \\"item_embedding\\",\\n \\"ItemConditionArray\\": \\"[{\\\\\\"option\\\\\\":\\\\\\"<\\\\\\",\\\\\\"field\\\\\\":\\\\\\"category\\\\\\",\\\\\\"type\\\\\\":\\\\\\"STRING\\\\\\",\\\\\\"value\\\\\\":\\\\\\"10\\\\\\"}]\\",\\n \\"ItemConditionExpression\\": \\"age>20\\",\\n \\"SortFields\\": \\"name\\",\\n \\"Operators\\": [\\n {\\n \\"OperatorType\\": \\"Filter\\",\\n \\"TriggerConfig\\": {\\n \\"Field\\": \\"user_id\\",\\n \\"IsRandSort\\": false,\\n \\"SortField\\": \\"create_time\\",\\n \\"FieldQuantityLimit\\": 20\\n },\\n \\"FilterConfig\\": {\\n \\"Experession\\": \\"age > 10\\"\\n },\\n \\"FeatureConfig\\": {\\n \\"Name\\": \\"city\\",\\n \\"Type\\": \\"STRING\\",\\n \\"Expression\\": \\"city = \'hangzhou\'\\"\\n },\\n \\"JoinConfig\\": {\\n \\"Field\\": \\"item_id\\",\\n \\"RecallManagementTableId\\": \\"3\\",\\n \\"OutputFields\\": [\\n \\"category\\"\\n ]\\n }\\n }\\n ],\\n \\"ExtendedConfig\\": \\"\\\\\\"\\\\\\"\\"\\n }\\n ],\\n \\"MergeConfig\\": {\\n \\"RecallManagementServiceVersionConfigId\\": \\"1\\",\\n \\"MergeType\\": \\"Weight\\",\\n \\"FilterRecallManagementTableIds\\": [\\n \\"3\\"\\n ],\\n \\"ItemRecallManagementTableId\\": \\"2\\",\\n \\"ItemTableFields\\": [\\n \\"item_id\\"\\n ],\\n \\"FilterExpression\\": \\"age>20\\",\\n \\"ExtendedConfig\\": \\"\\\\\\"\\\\\\"\\"\\n }\\n },\\n \\"GmtCreateTime\\": \\"2021-12-15T23:24:33.132+08:00\\",\\n \\"GmtModifiedTime\\": \\"2021-12-15T23:24:33.132+08:00\\"\\n}","type":"json"}]', + ], + 'GetRecallManagementServiceVersionConfig' => [ + 'summary' => 'This API retrieves the configuration details of a specific recall management service version.', + 'path' => '/api/v1/recallmanagementservices/{RecallManagementServiceId}/versions/{RecallManagementServiceVersionId}/configs/{RecallManagementServiceVersionConfigId}', + 'methods' => ['get'], + 'schemes' => ['https'], 'security' => [ [ 'AK' => [], ], ], - 'consumes' => [ - 'application/json', - ], - 'produces' => [ - 'application/json', - ], - 'operationType' => 'readAndWrite', + 'consumes' => ['application/json'], + 'produces' => ['application/json'], + 'operationType' => 'read', 'deprecated' => false, 'systemTags' => [ 'operationType' => 'none', 'riskType' => 'none', 'chargeType' => 'free', - 'abilityTreeNodes' => [ - 'FEATURElearnN0NAWV', - ], + 'abilityTreeNodes' => ['FEATURElearnN0NAWV'], ], 'parameters' => [ [ - 'name' => 'ExperimentGroupId', + 'name' => 'RecallManagementServiceId', 'in' => 'path', - 'schema' => [ - 'title' => '实验组ID。', - 'description' => '', - 'type' => 'string', - 'required' => true, - 'example' => '3', - ], + 'schema' => ['description' => 'The ID of the RecallManagementService.', 'type' => 'string', 'required' => false, 'example' => '3', 'title' => ''], ], [ - 'name' => 'body', - 'in' => 'body', - 'style' => 'json', + 'name' => 'RecallManagementServiceVersionId', + 'in' => 'path', + 'schema' => ['description' => 'The ID of the RecallManagementServiceVersion.', 'type' => 'string', 'required' => false, 'example' => '2', 'title' => ''], + ], + [ + 'name' => 'RecallManagementServiceVersionConfigId', + 'in' => 'path', + 'schema' => ['description' => 'The ID of the RecallManagementServiceVersionConfig.', 'type' => 'string', 'required' => false, 'example' => '3', 'title' => ''], + ], + [ + 'name' => 'InstanceId', + 'in' => 'query', + 'schema' => ['description' => 'The ID of the instance.', 'type' => 'string', 'required' => false, 'example' => 'learn-pairec-xxx', 'title' => ''], + ], + ], + 'responses' => [ + 200 => [ 'schema' => [ - 'description' => '', + 'description' => 'The response schema.', + 'title' => 'Schema of Response', 'type' => 'object', 'properties' => [ - 'InstanceId' => [ - 'title' => '实例ID。', - 'description' => '', - 'type' => 'string', - 'required' => true, - 'example' => 'pairec-cn-abcdefg1234'."\n", + 'RequestId' => ['title' => 'ID of the request', 'description' => 'The request ID.', 'type' => 'string', 'example' => '728C5E01-ABF6-5AA8-B9FC-B3BA05DECC77'], + 'RecallManagementServiceId' => ['description' => 'The recall management service ID.', 'type' => 'string', 'example' => '3', 'title' => ''], + 'RecallManagementServiceVersionId' => ['description' => 'The recall management service version ID.', 'type' => 'string', 'example' => '2', 'title' => ''], + 'RecallManagementServiceVersionConfigId' => ['description' => 'The recall management service version configuration ID.', 'type' => 'string', 'example' => '2', 'title' => ''], + 'ConfigType' => ['description' => 'The configuration type. Valid values: Recall (recall configuration) and Merge (merge configuration).', 'type' => 'string', 'example' => 'Recall', 'title' => ''], + 'RecallConfig' => [ + 'description' => 'The recall configuration.', + 'type' => 'object', + 'properties' => [ + 'RecallManagementServiceVersionConfigId' => ['description' => 'The recall management service version configuration ID.', 'type' => 'string', 'example' => '4', 'title' => ''], + 'Name' => ['description' => 'The recall name.', 'type' => 'string', 'example' => 'etrec', 'title' => ''], + 'Description' => ['description' => 'The recall description.', 'type' => 'string', 'example' => 'this is etrec recall', 'title' => ''], + 'Priority' => ['description' => 'The priority. A lower value indicates a higher priority.', 'type' => 'integer', 'format' => 'int64', 'example' => '10', 'title' => ''], + 'RecallType' => ['description' => 'The recall type.', 'type' => 'string', 'example' => 'X2I', 'title' => ''], + 'RecallManagementTableId' => ['description' => 'The recall management table ID.', 'type' => 'string', 'example' => '3', 'title' => ''], + 'UserVectorRecallManagementTableId' => ['description' => 'The user vector recall table ID.', 'type' => 'string', 'example' => '2', 'title' => ''], + 'UserVectorField' => ['description' => 'The user vector field.', 'type' => 'string', 'example' => 'user_embedding', 'title' => ''], + 'ItemVectorRecallManagementTableId' => ['description' => 'The item vector recall table ID.', 'type' => 'string', 'example' => '2', 'title' => ''], + 'ItemVectorField' => ['description' => 'The item vector field.', 'type' => 'string', 'example' => 'item_embedding', 'title' => ''], + 'ItemConditionArray' => ['description' => 'The item conditions, as a JSON array string.', 'type' => 'string', 'example' => '[{"option":"<","field":"category","type":"STRING","value":"10"}]', 'title' => ''], + 'ItemConditionExpression' => ['description' => 'The item condition expression.', 'type' => 'string', 'example' => 'age>20', 'title' => ''], + 'SortFields' => ['description' => 'The sort fields.', 'type' => 'string', 'example' => 'name', 'title' => ''], + 'Operators' => [ + 'description' => 'A list of operators.', + 'type' => 'array', + 'items' => [ + 'description' => 'The details of an operator.', + 'type' => 'object', + 'properties' => [ + 'OperatorType' => ['description' => 'The operator type.', 'type' => 'string', 'example' => 'Filter', 'title' => ''], + 'TriggerConfig' => [ + 'description' => 'The configuration for the Trigger operator.', + 'type' => 'object', + 'properties' => [ + 'Field' => ['description' => 'The field name.', 'type' => 'string', 'example' => 'user_id', 'title' => ''], + 'IsRandSort' => ['description' => 'Indicates whether to randomly sort the items.', 'type' => 'boolean', 'example' => 'false', 'title' => ''], + 'SortField' => ['description' => 'The sort field.', 'type' => 'string', 'example' => 'create_time', 'title' => ''], + 'FieldQuantityLimit' => ['description' => 'The limit on the number of fields.', 'type' => 'integer', 'format' => 'int32', 'example' => '20', 'title' => ''], + ], + 'title' => '', + 'example' => '', + ], + 'FilterConfig' => [ + 'description' => 'The configuration for the filter operator.', + 'type' => 'object', + 'properties' => [ + 'Expression' => ['description' => 'The filter expression.', 'type' => 'string', 'example' => 'age>20', 'title' => ''], + ], + 'title' => '', + 'example' => '', + ], + 'FeatureConfig' => [ + 'description' => 'The configuration for the feature operator.', + 'type' => 'object', + 'properties' => [ + 'Name' => ['description' => 'The feature name.', 'type' => 'string', 'example' => 'age', 'title' => ''], + 'Type' => ['description' => 'The feature type.', 'type' => 'string', 'example' => 'STRING', 'title' => ''], + 'Expression' => ['description' => 'The feature expression.', 'type' => 'string', 'example' => 'category=3', 'title' => ''], + ], + 'title' => '', + 'example' => '', + ], + 'JoinConfig' => [ + 'description' => 'The configuration for the Join operator.', + 'type' => 'object', + 'properties' => [ + 'Field' => ['description' => 'The join field.', 'type' => 'string', 'example' => 'item_id', 'title' => ''], + 'RecallManagementTableId' => ['description' => 'The join table ID.', 'type' => 'string', 'example' => '3', 'title' => ''], + 'OutputFields' => [ + 'description' => 'The output fields.', + 'type' => 'array', + 'items' => ['description' => 'An output field.', 'type' => 'string', 'example' => 'item_id', 'title' => ''], + 'title' => '', + 'example' => '', + ], + ], + 'title' => '', + 'example' => '', + ], + ], + 'title' => '', + 'example' => '', + ], + 'title' => '', + 'example' => '', + ], + 'ExtendedConfig' => ['description' => 'Extended configuration, reserved for future use.', 'type' => 'string', 'example' => '{"":""}', 'title' => ''], + ], + 'title' => '', + 'example' => '', ], + 'MergeConfig' => [ + 'description' => 'The merge configuration.', + 'type' => 'object', + 'properties' => [ + 'RecallManagementServiceVersionConfigId' => ['description' => 'The recall management service version configuration ID.', 'type' => 'string', 'example' => '1', 'title' => ''], + 'MergeType' => ['description' => 'The merge type. Valid values:'."\n" + ."\n" + .'- Weight: Merges items based on assigned weights.'."\n" + ."\n" + .'- Alternate: Merges items in an alternating sequence.', 'type' => 'string', 'example' => 'Weight', 'title' => ''], + 'FilterRecallManagementTableIds' => [ + 'description' => 'A list of filter table IDs.', + 'type' => 'array', + 'items' => ['description' => 'A filter table ID.', 'type' => 'string', 'example' => '3', 'title' => ''], + 'title' => '', + 'example' => '', + ], + 'ItemRecallManagementTableId' => ['description' => 'The item table ID.', 'type' => 'string', 'example' => '2', 'title' => ''], + 'ItemTableFields' => [ + 'description' => 'A list of output fields from the item table.', + 'type' => 'array', + 'items' => ['description' => 'An output field from the item table.', 'type' => 'string', 'example' => 'item_id', 'title' => ''], + 'title' => '', + 'example' => '', + ], + 'FilterExpression' => ['description' => 'The filter expression.', 'type' => 'string', 'example' => 'age>20', 'title' => ''], + 'ExtendedConfig' => ['description' => 'Additional configuration for the merge operation, reserved for future enhancements.', 'type' => 'string', 'example' => '{"":""}', 'title' => ''], + ], + 'title' => '', + 'example' => '', + ], + 'GmtCreateTime' => ['description' => 'The creation time, in ISO 8601 format.', 'type' => 'string', 'example' => '2021-12-15T23:24:33.132+08:00', 'title' => ''], + 'GmtModifiedTime' => ['description' => 'The last modification time, in ISO 8601 format.', 'type' => 'string', 'example' => '2021-12-15T23:24:33.132+08:00', 'title' => ''], + ], + 'example' => '', + ], + ], + ], + 'staticInfo' => ['returnType' => 'synchronous'], + 'title' => 'Get Retrieval Management Service Version Configuration', + 'description' => '## Request'."\n" + ."\n" + .'Retrieves the configuration details for a specific version of a Recall Management Service by specifying its service, version, and configuration IDs. Ensure the parameter values are correct. The `InstanceId` is crucial for locating the correct instance.'."\n" + ."\n" + .'- **Note**: All path parameters (`RecallManagementServiceId`, `RecallManagementServiceVersionId`, and `RecallManagementServiceVersionConfigId`) are required and must reference an existing resource.'."\n" + ."\n" + .'- **Extended configuration**: The response includes the `ExtendedConfig` field, which is used for future extensions and custom settings. Parse this field as needed.', + 'changeSet' => [], + 'flowControl' => [ + 'flowControlList' => [], + ], + 'ramActions' => [ + [ + 'operationType' => 'none', + 'ramAction' => [ + 'action' => 'pairec:GetRecallManagementServiceVersionConfig', + 'authLevel' => 'operate', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'PAIRecService', 'resourceType' => 'All Resource', 'arn' => '*'], ], - 'required' => false, ], ], ], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"728C5E01-ABF6-5AA8-B9FC-B3BA05DECC77\\",\\n \\"RecallManagementServiceId\\": \\"3\\",\\n \\"RecallManagementServiceVersionId\\": \\"2\\",\\n \\"RecallManagementServiceVersionConfigId\\": \\"2\\",\\n \\"ConfigType\\": \\"Recall\\",\\n \\"RecallConfig\\": {\\n \\"RecallManagementServiceVersionConfigId\\": \\"4\\",\\n \\"Name\\": \\"etrec\\",\\n \\"Description\\": \\"this is etrec recall\\",\\n \\"Priority\\": 10,\\n \\"RecallType\\": \\"X2I\\",\\n \\"RecallManagementTableId\\": \\"3\\",\\n \\"UserVectorRecallManagementTableId\\": \\"2\\",\\n \\"UserVectorField\\": \\"user_embedding\\",\\n \\"ItemVectorRecallManagementTableId\\": \\"2\\",\\n \\"ItemVectorField\\": \\"item_embedding\\",\\n \\"ItemConditionArray\\": \\"[{\\\\\\"option\\\\\\":\\\\\\"<\\\\\\",\\\\\\"field\\\\\\":\\\\\\"category\\\\\\",\\\\\\"type\\\\\\":\\\\\\"STRING\\\\\\",\\\\\\"value\\\\\\":\\\\\\"10\\\\\\"}]\\",\\n \\"ItemConditionExpression\\": \\"age>20\\",\\n \\"SortFields\\": \\"name\\",\\n \\"Operators\\": [\\n {\\n \\"OperatorType\\": \\"Filter\\",\\n \\"TriggerConfig\\": {\\n \\"Field\\": \\"user_id\\",\\n \\"IsRandSort\\": false,\\n \\"SortField\\": \\"create_time\\",\\n \\"FieldQuantityLimit\\": 20\\n },\\n \\"FilterConfig\\": {\\n \\"Expression\\": \\"age>20\\"\\n },\\n \\"FeatureConfig\\": {\\n \\"Name\\": \\"age\\",\\n \\"Type\\": \\"STRING\\",\\n \\"Expression\\": \\"category=3\\"\\n },\\n \\"JoinConfig\\": {\\n \\"Field\\": \\"item_id\\",\\n \\"RecallManagementTableId\\": \\"3\\",\\n \\"OutputFields\\": [\\n \\"item_id\\"\\n ]\\n }\\n }\\n ],\\n \\"ExtendedConfig\\": \\"{\\\\\\"\\\\\\":\\\\\\"\\\\\\"}\\"\\n },\\n \\"MergeConfig\\": {\\n \\"RecallManagementServiceVersionConfigId\\": \\"1\\",\\n \\"MergeType\\": \\"Weight\\",\\n \\"FilterRecallManagementTableIds\\": [\\n \\"3\\"\\n ],\\n \\"ItemRecallManagementTableId\\": \\"2\\",\\n \\"ItemTableFields\\": [\\n \\"item_id\\"\\n ],\\n \\"FilterExpression\\": \\"age>20\\",\\n \\"ExtendedConfig\\": \\"{\\\\\\"\\\\\\":\\\\\\"\\\\\\"}\\"\\n },\\n \\"GmtCreateTime\\": \\"2021-12-15T23:24:33.132+08:00\\",\\n \\"GmtModifiedTime\\": \\"2021-12-15T23:24:33.132+08:00\\"\\n}","type":"json"}]', + ], + 'GetRecallManagementTable' => [ + 'summary' => 'Retrieves the details of a specified recall management table, including its table structure and configuration.', + 'path' => '/api/v1/recallmanagementtables/{RecallManagementTableId}', + 'methods' => ['get'], + 'schemes' => ['https'], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'consumes' => ['application/json'], + 'produces' => ['application/json'], + 'operationType' => 'read', + 'deprecated' => false, + 'systemTags' => [ + 'operationType' => 'get', + 'riskType' => 'none', + 'chargeType' => 'free', + 'abilityTreeNodes' => ['FEATURElearnN0NAWV'], + ], + 'parameters' => [ + [ + 'name' => 'RecallManagementTableId', + 'in' => 'path', + 'schema' => ['description' => 'The ID of the recall management table.', 'type' => 'string', 'required' => true, 'example' => '3', 'title' => ''], + ], + [ + 'name' => 'InstanceId', + 'in' => 'query', + 'schema' => ['description' => 'The instance ID.', 'type' => 'string', 'required' => true, 'example' => 'pairec-cn-test123', 'title' => ''], + ], + ], 'responses' => [ 200 => [ 'schema' => [ + 'description' => 'The response 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' => '47F761ED-BE4E-51A6-B678-78E1490DF313', + 'RequestId' => ['title' => 'Id of the request', 'description' => 'The request ID.', 'type' => 'string', 'example' => '728C5E01-ABF6-5AA8-B9FC-B3BA05DECC77'], + 'RecallManagementTableId' => ['description' => 'The data table ID.', 'type' => 'string', 'example' => '3', 'title' => ''], + 'Name' => ['description' => 'The data table name.', 'type' => 'string', 'example' => 'table-123', 'title' => ''], + 'Description' => ['description' => 'The data table description.', 'type' => 'string', 'example' => 'this is a test', 'title' => ''], + 'Type' => ['description' => 'The table type.', 'type' => 'string', 'example' => 'Recall', 'title' => ''], + 'RecallType' => ['description' => 'The recall type.', 'type' => 'string', 'example' => 'X2I', 'title' => ''], + 'DataSource' => ['description' => 'The data source.', 'type' => 'string', 'example' => 'Api', 'title' => ''], + 'MaxcomputeProjectName' => ['description' => 'The MaxCompute project name.', 'type' => 'string', 'example' => 'test', 'title' => ''], + 'MaxcomputeTableName' => ['description' => 'The MaxCompute table name.', 'type' => 'string', 'example' => 'table-1', 'title' => ''], + 'CanDelete' => ['description' => 'Specifies whether the table can be deleted.', 'type' => 'boolean', 'example' => 'true', 'title' => ''], + 'IndexVersionId' => ['description' => 'The index version ID.', 'type' => 'string', 'example' => '20250701', 'title' => ''], + 'IndexEffectiveTime' => ['description' => 'The index effective time.', 'type' => 'string', 'example' => '2021-12-15T23:24:33.132+08:00', 'title' => ''], + 'Config' => ['description' => 'Additional configurations for the table.', 'type' => 'string', 'example' => '{"item_id":""}', 'title' => ''], + 'EnableRowCountFluctuationThreshold' => ['description' => 'Specifies whether to enable the fluctuation threshold for the row count.', 'type' => 'boolean', 'example' => 'true', 'title' => ''], + 'MinRowCountFluctuationThreshold' => ['description' => 'The minimum row count fluctuation threshold.', 'type' => 'integer', 'format' => 'int32', 'example' => '10', 'title' => ''], + 'MaxRowCountFluctuationThreshold' => ['description' => 'The maximum row count fluctuation threshold.', 'type' => 'integer', 'format' => 'int32', 'example' => '100', 'title' => ''], + 'EnableDataSizeFluctuationThreshold' => ['description' => 'Specifies whether to enable the fluctuation threshold for the data size.', 'type' => 'boolean', 'example' => 'false', 'title' => ''], + 'MinDataSizeFluctuationThreshold' => ['description' => 'The minimum data size fluctuation threshold.', 'type' => 'integer', 'format' => 'int32', 'example' => '10', 'title' => ''], + 'MaxDataSizeFluctuationThreshold' => ['description' => 'The maximum data size fluctuation threshold.', 'type' => 'integer', 'format' => 'int32', 'example' => '100', 'title' => ''], + 'GmtCreateTime' => ['description' => 'The creation time.', 'type' => 'string', 'example' => '2021-12-15T23:24:33.132+08:00', 'title' => ''], + 'GmtModifiedTime' => ['description' => 'The modification time.', 'type' => 'string', 'example' => '2021-12-15T23:24:33.132+08:00', 'title' => ''], + 'MaxcomputeSchema' => ['description' => 'The MaxCompute schema.', 'type' => 'string', 'example' => 'default', 'title' => ''], + 'PartitionFields' => ['description' => 'The partition fields.', 'type' => 'string', 'example' => 'dt', 'title' => ''], + 'Fields' => [ + 'description' => 'A list of fields.', + 'type' => 'array', + 'items' => [ + 'type' => 'object', + 'properties' => [ + 'Name' => ['description' => 'The field name.', 'type' => 'string', 'example' => 'age', 'title' => ''], + 'Type' => ['description' => 'The field type.', 'type' => 'string', 'example' => 'STRING', 'title' => ''], + 'Attributes' => [ + 'type' => 'array', + 'items' => ['description' => 'A field attribute.', 'type' => 'string', 'example' => 'Primary', 'title' => ''], + 'title' => '', + 'description' => 'A list of field attributes.', + 'example' => '', + ], + 'VectorDimension' => ['description' => 'The vector dimension.', 'type' => 'integer', 'format' => 'int32', 'example' => '32', 'title' => ''], + 'VectorMetricType' => ['description' => 'The vector metric type.', 'type' => 'string', 'example' => 'L2', 'title' => ''], + ], + 'title' => '', + 'description' => 'The properties of a single field.', + 'example' => '', + ], + 'title' => '', + 'example' => '', ], ], + 'example' => '', ], ], ], - 'staticInfo' => [ - 'returnType' => 'synchronous', + 'staticInfo' => ['returnType' => 'synchronous'], + 'title' => 'Get Recall Management Data Table Detail', + 'description' => '## Request'."\n" + ."\n" + .'This API retrieves details of a specific recall management table using the provided `RecallManagementTableId` and `InstanceId`. Ensure you provide the correct values for these parameters.'."\n" + ."\n" + .'- **Note**: The `CanDelete` field indicates whether the data table supports delete operations. Use this value to control delete functionality in your application.'."\n" + ."\n" + .'- The `Fields` list contains the definitions for each field in the data table, including their name, type, and properties.'."\n" + ."\n" + .'- To monitor data changes, you can configure or query the fluctuation thresholds for row count and size using the corresponding fields.', + 'changeSet' => [], + 'flowControl' => [ + 'flowControlList' => [], + ], + 'ramActions' => [ + [ + 'operationType' => 'get', + 'ramAction' => [ + 'action' => 'pairec:GetRecallManagementTable', + 'authLevel' => 'operate', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'PAIRecService', 'resourceType' => 'All Resource', 'arn' => '*'], + ], + ], + ], ], - 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"47F761ED-BE4E-51A6-B678-78E1490DF313\\"\\n}","type":"json"}]', + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"728C5E01-ABF6-5AA8-B9FC-B3BA05DECC77\\",\\n \\"RecallManagementTableId\\": \\"3\\",\\n \\"Name\\": \\"table-123\\",\\n \\"Description\\": \\"this is a test\\",\\n \\"Type\\": \\"Recall\\",\\n \\"RecallType\\": \\"X2I\\",\\n \\"DataSource\\": \\"Api\\",\\n \\"MaxcomputeProjectName\\": \\"test\\",\\n \\"MaxcomputeTableName\\": \\"table-1\\",\\n \\"CanDelete\\": true,\\n \\"IndexVersionId\\": \\"20250701\\",\\n \\"IndexEffectiveTime\\": \\"2021-12-15T23:24:33.132+08:00\\",\\n \\"Config\\": \\"{\\\\\\"item_id\\\\\\":\\\\\\"\\\\\\"}\\",\\n \\"EnableRowCountFluctuationThreshold\\": true,\\n \\"MinRowCountFluctuationThreshold\\": 10,\\n \\"MaxRowCountFluctuationThreshold\\": 100,\\n \\"EnableDataSizeFluctuationThreshold\\": false,\\n \\"MinDataSizeFluctuationThreshold\\": 10,\\n \\"MaxDataSizeFluctuationThreshold\\": 100,\\n \\"GmtCreateTime\\": \\"2021-12-15T23:24:33.132+08:00\\",\\n \\"GmtModifiedTime\\": \\"2021-12-15T23:24:33.132+08:00\\",\\n \\"MaxcomputeSchema\\": \\"default\\",\\n \\"PartitionFields\\": \\"dt\\",\\n \\"Fields\\": [\\n {\\n \\"Name\\": \\"age\\",\\n \\"Type\\": \\"STRING\\",\\n \\"Attributes\\": [\\n \\"Primary\\"\\n ],\\n \\"VectorDimension\\": 32,\\n \\"VectorMetricType\\": \\"L2\\"\\n }\\n ]\\n}","type":"json"}]', ], - 'OfflineExperimentGroup' => [ - 'summary' => '下线实验组。', - 'path' => '/api/v1/experimentgroups/{ExperimentGroupId}/action/offline', - 'methods' => [ - 'post', - ], - 'schemes' => [ - 'http', - 'https', - ], + 'GetScene' => [ + 'summary' => 'Retrieves the details of a specified scene.', + 'path' => '/api/v1/scenes/{SceneId}', + 'methods' => ['get'], + 'schemes' => ['http', 'https'], 'security' => [ [ 'AK' => [], ], ], - 'consumes' => [ - 'application/json', - ], - 'produces' => [ - 'application/json', - ], - 'operationType' => 'readAndWrite', + 'consumes' => ['application/json'], + 'produces' => ['application/json'], + 'operationType' => 'read', 'deprecated' => false, 'systemTags' => [ - 'operationType' => 'none', + 'operationType' => 'get', 'riskType' => 'none', 'chargeType' => 'free', - 'abilityTreeNodes' => [ - 'FEATURElearnN0NAWV', - ], + 'abilityTreeNodes' => ['FEATURElearnN0NAWV'], ], 'parameters' => [ [ - 'name' => 'ExperimentGroupId', + 'name' => 'SceneId', 'in' => 'path', - 'schema' => [ - 'title' => '实验组ID。', - 'description' => '', - 'type' => 'string', - 'required' => true, - 'example' => '3', - ], + 'schema' => ['description' => 'The scene ID. You can get this ID by calling the ListScenes operation.', 'type' => 'string', 'example' => '3', 'title' => '', 'required' => false], ], [ - 'name' => 'body', - 'in' => 'body', - 'style' => 'json', + 'name' => 'InstanceId', + 'in' => 'query', + 'schema' => ['description' => 'The instance ID. You can get this ID by calling the ListInstances operation.', 'type' => 'string', 'example' => 'pairec-cn-abcdefg1234', 'title' => '', 'required' => false], + ], + ], + 'responses' => [ + 200 => [ 'schema' => [ - 'title' => '请求body。', - 'description' => '', + 'title' => 'Schema of Response', + 'description' => 'The response parameters.', 'type' => 'object', 'properties' => [ - 'InstanceId' => [ - 'title' => '实例ID。', - 'description' => '', - 'type' => 'string', - 'required' => true, - 'example' => 'pairec-cn-abcdefg1234'."\n", + 'RequestId' => ['title' => 'Id of the request', 'description' => 'The request ID.', 'type' => 'string', 'example' => 'B8987BF7-6028-5B17-80E0-251B7BD67BBA'], + 'Name' => ['description' => 'The scene name.', 'type' => 'string', 'example' => 'scene1', 'title' => ''], + 'Description' => ['description' => 'The scene description.', 'type' => 'string', 'example' => 'This is a test.', 'title' => ''], + 'Flows' => [ + 'title' => '', + 'description' => 'A list of flows.', + 'type' => 'array', + 'items' => [ + 'type' => 'object', + 'properties' => [ + 'FlowName' => ['description' => 'The flow name.', 'type' => 'string', 'example' => '流量1', 'title' => ''], + 'FlowCode' => ['description' => 'The flow code.', 'type' => 'string', 'example' => 'liuliang1', 'title' => ''], + ], + 'description' => '', + 'title' => '', + 'example' => '', + ], + 'example' => '', ], ], - 'required' => false, + 'example' => '', ], ], ], + 'staticInfo' => ['returnType' => 'synchronous'], + 'title' => 'Obtain Scenario Details', + 'changeSet' => [], + 'flowControl' => [ + 'flowControlList' => [], + ], + 'ramActions' => [ + [ + 'operationType' => 'get', + 'ramAction' => [ + 'action' => 'pairec:GetScene', + 'authLevel' => 'operate', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'PAIRecService', 'resourceType' => 'All Resource', 'arn' => '*'], + ], + ], + ], + ], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"B8987BF7-6028-5B17-80E0-251B7BD67BBA\\",\\n \\"Name\\": \\"scene1\\",\\n \\"Description\\": \\"This is a test.\\",\\n \\"Flows\\": [\\n {\\n \\"FlowName\\": \\"流量1\\",\\n \\"FlowCode\\": \\"liuliang1\\"\\n }\\n ]\\n}","type":"json"}]', + ], + 'GetService' => [ + 'summary' => 'Retrieves the details of a service.', + 'path' => '/api/v1/services/{ServiceId}', + 'methods' => ['get'], + 'schemes' => ['http', 'https'], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'consumes' => ['application/json'], + 'produces' => ['application/json'], + 'operationType' => 'read', + 'deprecated' => false, + 'systemTags' => [ + 'operationType' => 'get', + 'riskType' => 'none', + 'chargeType' => 'free', + 'abilityTreeNodes' => ['FEATURElearnN0NAWV'], + ], + 'parameters' => [ + [ + 'name' => 'ServiceId', + 'in' => 'path', + 'schema' => ['description' => 'The service ID.', 'type' => 'string', 'required' => false, 'example' => '1', 'title' => ''], + ], + [ + 'name' => 'InstanceId', + 'in' => 'query', + 'schema' => ['description' => 'The instance ID. You can call [ListInstances](~~2411819~~) to obtain the instance ID.', 'type' => 'string', 'required' => false, 'example' => 'pairec-test-xxx', 'title' => ''], + ], + ], 'responses' => [ 200 => [ 'schema' => [ - 'title' => 'Schema of Response', + 'title' => '', 'description' => 'Schema of Response', 'type' => 'object', 'properties' => [ - 'RequestId' => [ - 'title' => 'Id of the request', - 'description' => 'Id of the request', - 'type' => 'string', - 'example' => '518C64F6-DFF7-11ED-85B0-00163E14B3D1', + 'RequestId' => ['title' => '', 'description' => 'The request ID.', 'type' => 'string', 'example' => 'D75C43DC-3D3A-5CC8-9AAC-8C77306C433B'], + 'Name' => ['description' => 'The service name.', 'type' => 'string', 'example' => 'test_rec', 'title' => ''], + 'Description' => ['description' => 'The service description.', 'type' => 'string', 'example' => 'this is a test rec engine', 'title' => ''], + 'Region' => ['description' => 'The region where the service is deployed.', 'type' => 'string', 'example' => 'cn-beijing', 'title' => ''], + 'EngineConfigId' => ['description' => 'The engine configuration ID.', 'type' => 'string', 'example' => '3', 'title' => ''], + 'CrInstanceId' => ['title' => '', 'description' => 'The Container Registry Enterprise instance ID selected by the user when a non-official image is used.', 'type' => 'string', 'example' => 'cri-xxx'], + 'RepositoryId' => ['title' => '', 'description' => 'The Container Registry Enterprise Edition repository ID selected by the user when a non-official image is used.', 'type' => 'string', 'example' => 'crr-xxx'], + 'ImageName' => ['description' => 'The image name.', 'type' => 'string', 'example' => 'registry-vpc.cn-beijing.aliyuncs.com/***/***', 'title' => ''], + 'ImageAuth' => ['description' => 'The image secret.', 'type' => 'string', 'example' => '********', 'title' => ''], + 'ServiceResourceUri' => ['description' => 'The resource address used to publish the service, such as the resource group name in Elastic Algorithm Service (EAS).', 'type' => 'string', 'example' => 'eas-resource-xxx', 'title' => ''], + 'ServiceConfig' => ['description' => 'The configuration used to publish the service, such as the service configuration in EAS.', 'type' => 'string', 'example' => '{"Port":8080}', 'title' => ''], + 'GmtReleasedTime' => ['description' => 'The time of the most recent production release.', 'type' => 'string', 'example' => '2021-12-15T23:24:33.132+08:00', 'title' => ''], + 'LatestProdReleaseOrder' => [ + 'description' => 'The most recent production release record.', + 'type' => 'object', + 'properties' => [ + 'ReleaseOrderId' => ['description' => 'The release order ID.', 'type' => 'string', 'example' => '3', 'title' => ''], + 'Topic' => ['description' => 'The release title.', 'type' => 'string', 'example' => 'update version', 'title' => ''], + 'Content' => ['description' => 'The release content.', 'type' => 'string', 'example' => 'update golang version to 1.22', 'title' => ''], + 'ImageVersion' => ['description' => 'The image version.', 'type' => 'string', 'example' => '2.0.0', 'title' => ''], + 'Releaser' => ['description' => 'The publisher, including the name and UID of the Resource Access Management (RAM) users.', 'type' => 'string', 'example' => 'E-xxx.xxx-@xxx.onaliyun.com', 'title' => ''], + 'ReleaseInfo' => ['description' => 'The release information.', 'type' => 'string', 'example' => '{'."\n" + .' "Pre": {'."\n" + .' "Status": "Released",'."\n" + .' "GmtReleasedTime" : "2021-12-15T23:24:33.132+08:00",'."\n" + .' },'."\n" + .' "Prod": {'."\n" + .' "Status": "Released",'."\n" + .' "GmtReleasedTime" : "2021-12-15T23:24:33.132+08:00",'."\n" + .' }'."\n" + .'}', 'title' => ''], + ], + 'title' => '', + 'example' => '', ], ], + 'example' => '', ], ], ], - 'staticInfo' => [ - 'returnType' => 'synchronous', - ], - 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"518C64F6-DFF7-11ED-85B0-00163E14B3D1\\"\\n}","type":"json"}]', - ], - 'CreateExperiment' => [ - 'summary' => '创建实验。', - 'path' => '/api/v1/experiments', - 'methods' => [ - 'post', + 'staticInfo' => ['returnType' => 'synchronous'], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"D75C43DC-3D3A-5CC8-9AAC-8C77306C433B\\",\\n \\"Name\\": \\"test_rec\\",\\n \\"Description\\": \\"this is a test rec engine\\",\\n \\"Region\\": \\"cn-beijing\\",\\n \\"EngineConfigId\\": \\"3\\",\\n \\"CrInstanceId\\": \\"cri-xxx\\",\\n \\"RepositoryId\\": \\"crr-xxx\\",\\n \\"ImageName\\": \\"registry-vpc.cn-beijing.aliyuncs.com/***/***\\",\\n \\"ImageAuth\\": \\"********\\",\\n \\"ServiceResourceUri\\": \\"eas-resource-xxx\\",\\n \\"ServiceConfig\\": \\"{\\\\\\"Port\\\\\\":8080}\\",\\n \\"GmtReleasedTime\\": \\"2021-12-15T23:24:33.132+08:00\\",\\n \\"LatestProdReleaseOrder\\": {\\n \\"ReleaseOrderId\\": \\"3\\",\\n \\"Topic\\": \\"update version\\",\\n \\"Content\\": \\"update golang version to 1.22\\",\\n \\"ImageVersion\\": \\"2.0.0\\",\\n \\"Releaser\\": \\"E-xxx.xxx-@xxx.onaliyun.com\\",\\n \\"ReleaseInfo\\": \\"{\\\\n\\\\t\\\\\\"Pre\\\\\\": {\\\\n \\\\\\"Status\\\\\\": \\\\\\"Released\\\\\\",\\\\n \\\\\\"GmtReleasedTime\\\\\\" : \\\\\\"2021-12-15T23:24:33.132+08:00\\\\\\",\\\\n },\\\\n \\\\\\"Prod\\\\\\": {\\\\n \\\\\\"Status\\\\\\": \\\\\\"Released\\\\\\",\\\\n \\\\\\"GmtReleasedTime\\\\\\" : \\\\\\"2021-12-15T23:24:33.132+08:00\\\\\\",\\\\n }\\\\n}\\"\\n }\\n}","type":"json"}]', + 'title' => 'Get service details', + 'changeSet' => [], + 'flowControl' => [ + 'flowControlList' => [], ], - 'schemes' => [ - 'http', - 'https', + 'ramActions' => [ + [ + 'operationType' => 'get', + 'ramAction' => [ + 'action' => 'pairec:GetService', + 'authLevel' => 'operate', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'PAIRecService', 'resourceType' => 'All Resource', 'arn' => '*'], + ], + ], + ], ], + ], + 'GetSubCrowd' => [ + 'summary' => 'Retrieves the details of a sub-crowd.', + 'path' => '/api/v1/crowds/{CrowdId}/subcrowds/{SubCrowdId}', + 'methods' => ['get'], + 'schemes' => ['http', 'https'], 'security' => [ [ 'AK' => [], ], ], - 'consumes' => [ - 'application/json', - ], - 'produces' => [ - 'application/json', - ], - 'operationType' => 'readAndWrite', + 'consumes' => ['application/json'], + 'produces' => ['application/json'], + 'operationType' => 'read', 'deprecated' => false, 'systemTags' => [ - 'operationType' => 'create', + 'operationType' => 'get', 'riskType' => 'none', 'chargeType' => 'free', - 'abilityTreeNodes' => [ - 'FEATURElearnN0NAWV', - ], + 'abilityTreeNodes' => ['FEATURElearnN0NAWV'], ], 'parameters' => [ [ - 'name' => 'body', - 'in' => 'body', - 'style' => 'json', + 'name' => 'CrowdId', + 'in' => 'path', + 'schema' => ['description' => 'The ID of the crowd. You can call the `ListCrowds` operation to obtain this ID.', 'type' => 'string', 'required' => true, 'example' => '3', 'title' => ''], + ], + [ + 'name' => 'SubCrowdId', + 'in' => 'path', + 'schema' => ['description' => 'The ID of the sub-crowd. You can call the `ListSubCrowds` operation to obtain this ID.', 'type' => 'string', 'required' => true, 'example' => '4', 'title' => ''], + ], + [ + 'name' => 'InstanceId', + 'in' => 'query', + 'schema' => ['description' => 'The ID of the instance. You can call the `ListInstances` operation to obtain this ID.', 'type' => 'string', 'required' => true, 'example' => 'pairec-cn-abcdefg1234', 'title' => ''], + ], + ], + 'responses' => [ + 200 => [ 'schema' => [ - 'description' => '', + 'title' => 'Schema of Response', + 'description' => 'The response object.', 'type' => 'object', 'properties' => [ - 'InstanceId' => [ - 'title' => '实例ID。', - 'description' => '', - 'type' => 'string', - 'required' => true, - 'example' => 'pairec-test1', - ], - 'ExperimentGroupId' => [ - 'title' => '实验组ID。', - 'description' => '', - 'type' => 'string', - 'required' => true, - 'example' => '3', - ], - 'Name' => [ - 'title' => '实验名称。', - 'description' => '', - 'type' => 'string', - 'required' => true, - 'example' => 'experiment_test', - ], - 'Description' => [ - 'title' => '实验描述。', - 'description' => '', - 'type' => 'string', - 'required' => true, - 'example' => 'This is a test.', - ], - 'Type' => [ - 'title' => '实验类型。'."\n" - .'● Baseline-基准实验。'."\n" - .'● Normal-普通实验。', - 'description' => '', - 'type' => 'string', - 'required' => true, - 'example' => 'Baseline', - ], - 'FlowPercent' => [ - 'title' => '流量分配百分比。', - 'description' => '', - 'type' => 'integer', - 'format' => 'int32', - 'required' => false, - 'example' => '100', - ], - 'DebugUsers' => [ - 'title' => '调试用户。', - 'description' => '', - 'type' => 'string', - 'required' => false, - 'example' => '1124512470******,1124512471******,1124512472******', - ], - 'DebugCrowdId' => [ - 'title' => '调试人群ID。', - 'description' => '', - 'type' => 'string', - 'required' => false, - 'example' => '3', - ], - 'Config' => [ - 'title' => '实验配置。', - 'description' => '', - 'type' => 'string', - 'required' => false, - 'example' => '{"RankBy": "Score"}', - ], + 'RequestId' => ['title' => 'Id of the request', 'description' => 'The request ID.', 'type' => 'string', 'example' => '01D22D08-BA20-5F35-8302-99115F288220'], + 'Source' => ['description' => 'The source of the sub-crowd. Valid values:', 'type' => 'string', 'example' => 'ManualInput', 'title' => ''], + 'Users' => ['description' => 'The users in the sub-crowd.', 'type' => 'string', 'example' => 'user1,user2', 'title' => ''], + 'Quantity' => ['description' => 'The number of users in the sub-crowd.', 'type' => 'string', 'example' => '3', 'title' => ''], + 'GmtCreateTime' => ['description' => 'The time when the sub-crowd was created.', 'type' => 'string', 'example' => '2021-12-15T23:24:33.132+08:00', 'title' => ''], + ], + 'example' => '', + ], + ], + ], + 'staticInfo' => ['returnType' => 'synchronous'], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"01D22D08-BA20-5F35-8302-99115F288220\\",\\n \\"Source\\": \\"ManualInput\\",\\n \\"Users\\": \\"user1,user2\\",\\n \\"Quantity\\": \\"3\\",\\n \\"GmtCreateTime\\": \\"2021-12-15T23:24:33.132+08:00\\"\\n}","type":"json"}]', + 'title' => 'Obtain Sub-Audience Details', + 'changeSet' => [], + 'flowControl' => [ + 'flowControlList' => [], + ], + 'ramActions' => [ + [ + 'operationType' => 'get', + 'ramAction' => [ + 'action' => 'pairec:GetSubCrowd', + 'authLevel' => 'operate', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'PAIRecService', 'resourceType' => 'All Resource', 'arn' => '*'], ], - 'required' => false, ], ], ], + ], + 'GetTableMeta' => [ + 'path' => '/api/v1/tablemetas/{TableMetaId}', + 'methods' => ['get'], + 'schemes' => ['http', 'https'], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'consumes' => ['application/json'], + 'produces' => ['application/json'], + 'operationType' => 'read', + 'deprecated' => false, + 'systemTags' => [ + 'operationType' => 'get', + 'riskType' => 'none', + 'chargeType' => 'free', + 'abilityTreeNodes' => ['FEATURElearnN0NAWV'], + ], + 'parameters' => [ + [ + 'name' => 'TableMetaId', + 'in' => 'path', + 'schema' => ['description' => 'The table ID.', 'type' => 'string', 'required' => true, 'example' => '2', 'title' => ''], + ], + [ + 'name' => 'InstanceId', + 'in' => 'query', + 'schema' => ['description' => 'The ID of the instance. Call the [ListInstances](~~2411819~~) API to obtain it.', 'type' => 'string', 'required' => true, 'example' => '实例ID pairec-cn-test1', 'title' => ''], + ], + ], 'responses' => [ 200 => [ 'schema' => [ 'title' => 'Schema of Response', - 'description' => 'Schema of Response', + 'description' => 'The data returned.', 'type' => 'object', 'properties' => [ - 'RequestId' => [ - 'title' => 'Id of the request', - 'description' => 'Id of the request', - 'type' => 'string', - 'example' => '3AAA45F6-0798-5461-9360-81D133823CE7', - ], - 'ExperimentId' => [ - 'title' => '实验ID。', - 'description' => '', - 'type' => 'string', - 'example' => '3', + 'RequestId' => ['title' => 'Id of the request', 'description' => 'The request ID.', 'type' => 'string', 'example' => '28C5E01-ABF6-5AA8-B9FC-B3BA05DECC77'], + 'Name' => ['description' => 'The table name.', 'type' => 'string', 'example' => 'test_table', 'title' => ''], + 'Description' => ['description' => 'The table description.', 'type' => 'string', 'example' => 'this is a test table', 'title' => ''], + 'ResourceId' => ['description' => 'The resource ID.', 'type' => 'string', 'example' => 'reso-wkgo***', 'title' => ''], + 'ResourceType' => ['type' => 'string', 'example' => 'Maxcompute', 'description' => '', 'title' => ''], + 'ResourceUri' => ['type' => 'string', 'example' => 'test', 'description' => '', 'title' => ''], + 'TableName' => ['description' => 'The name of the table in the database.', 'type' => 'string', 'example' => 'table_mysql', 'title' => ''], + 'Type' => ['description' => 'The table type. Valid values:'."\n" + ."\n" + .'- `MaxCompute`'."\n" + ."\n" + .'- `Hologres`', 'type' => 'string', 'example' => 'MaxCompute', 'title' => ''], + 'Module' => ['description' => 'The table module. Valid values:'."\n" + ."\n" + .'- `ABTest`: An A/B testing data table.'."\n" + ."\n" + .'- `ExperimentTool`: An experiment tool table.'."\n" + ."\n" + .'- `DataDiagnosis`: A table for data diagnosis.', 'type' => 'string', 'example' => 'ABTest', 'title' => ''], + 'CanDelete' => ['description' => 'Indicates whether the table can be deleted. The value is `false` if other resources reference the table.', 'type' => 'boolean', 'example' => 'false', 'title' => ''], + 'GmtCreateTime' => ['description' => 'The creation time.', 'type' => 'string', 'example' => '2021-12-15:24:33', 'title' => ''], + 'GmtModifiedTime' => ['description' => 'The modification time.', 'type' => 'string', 'example' => '2021-12-15:24:33', 'title' => ''], + 'Fields' => [ + 'description' => 'The fields in the table.', + 'type' => 'array', + 'items' => [ + 'description' => 'Information about a field.', + 'type' => 'object', + 'properties' => [ + 'Name' => ['description' => 'The field name.', 'type' => 'string', 'example' => 'gender', 'title' => ''], + 'Meaning' => ['description' => 'The field meaning.', 'type' => 'string', 'example' => 'the gender of people', 'title' => ''], + 'Type' => ['description' => 'The field type.', 'type' => 'string', 'example' => 'BIGINT', 'title' => ''], + 'IsDimensionField' => ['description' => 'Whether the field is a dimension field.', 'type' => 'boolean', 'example' => 'false', 'title' => ''], + ], + 'title' => '', + 'example' => '', + ], + 'title' => '', + 'example' => '', ], + 'Url' => ['description' => 'The URL of the table in Data Map. This parameter is returned only for MaxCompute tables.', 'type' => 'string', 'example' => 'https://dmc-xxx.com/dm/table/xxx'."\n", 'title' => ''], + 'TableMetaId' => ['description' => 'The table ID.', 'type' => 'string', 'example' => '3', 'title' => ''], + 'GmtImportedTime' => ['description' => 'The import time.', 'type' => 'string', 'example' => '2021-12-15T23:24:33.132+08:00', 'title' => ''], + 'Config' => ['description' => 'Additional configurations for the table, provided as a JSON string.', 'type' => 'string', 'example' => '{"table_type":"item"}', 'title' => ''], ], + 'example' => '', ], ], ], - 'staticInfo' => [ - 'returnType' => 'synchronous', + 'staticInfo' => ['returnType' => 'synchronous'], + 'title' => 'Retrieve Data Table', + 'summary' => 'Returns the details of a table.', + 'changeSet' => [ + ['createdAt' => '2024-02-22T08:15:54.000Z', 'description' => 'Response parameters changed'], + ['createdAt' => '2024-02-22T03:35:42.000Z', 'description' => 'Request parameters changed, Response parameters changed'], ], - 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"3AAA45F6-0798-5461-9360-81D133823CE7\\",\\n \\"ExperimentId\\": \\"3\\"\\n}","type":"json"}]', - ], - 'DeleteExperiment' => [ - 'summary' => '删除实验。', - 'path' => '/api/v1/experiments/{ExperimentId}', - 'methods' => [ - 'delete', + 'flowControl' => [ + 'flowControlList' => [], ], - 'schemes' => [ - 'http', - 'https', + 'ramActions' => [ + [ + 'operationType' => 'get', + 'ramAction' => [ + 'action' => 'pairec:GetTableMeta', + 'authLevel' => 'operate', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'PAIRecService', 'resourceType' => 'All Resource', 'arn' => '*'], + ], + ], + ], ], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"28C5E01-ABF6-5AA8-B9FC-B3BA05DECC77\\",\\n \\"Name\\": \\"test_table\\",\\n \\"Description\\": \\"this is a test table\\",\\n \\"ResourceId\\": \\"reso-wkgo***\\",\\n \\"ResourceType\\": \\"Maxcompute\\",\\n \\"ResourceUri\\": \\"test\\",\\n \\"TableName\\": \\"table_mysql\\",\\n \\"Type\\": \\"MaxCompute\\",\\n \\"Module\\": \\"ABTest\\",\\n \\"CanDelete\\": false,\\n \\"GmtCreateTime\\": \\"2021-12-15:24:33\\",\\n \\"GmtModifiedTime\\": \\"2021-12-15:24:33\\",\\n \\"Fields\\": [\\n {\\n \\"Name\\": \\"gender\\",\\n \\"Meaning\\": \\"the gender of people\\",\\n \\"Type\\": \\"BIGINT\\",\\n \\"IsDimensionField\\": false\\n }\\n ],\\n \\"Url\\": \\"https://dmc-xxx.com/dm/table/xxx\\\\n\\",\\n \\"TableMetaId\\": \\"3\\",\\n \\"GmtImportedTime\\": \\"2021-12-15T23:24:33.132+08:00\\",\\n \\"Config\\": \\"{\\\\\\"table_type\\\\\\":\\\\\\"item\\\\\\"}\\"\\n}","type":"json"}]', + ], + 'GetTrafficControlTarget' => [ + 'path' => '/api/v1/trafficcontroltargets/{TrafficControlTargetId}', + 'methods' => ['get'], + 'schemes' => ['http', 'https'], 'security' => [ [ 'AK' => [], ], ], - 'consumes' => [ - 'application/json', - ], - 'produces' => [ - 'application/json', - ], - 'operationType' => 'readAndWrite', + 'consumes' => ['application/json'], + 'produces' => ['application/json'], + 'operationType' => 'read', 'deprecated' => false, 'systemTags' => [ - 'operationType' => 'delete', + 'operationType' => 'get', 'riskType' => 'none', 'chargeType' => 'free', - 'abilityTreeNodes' => [ - 'FEATURElearnN0NAWV', - ], + 'abilityTreeCode' => '220593', + 'abilityTreeNodes' => ['FEATURElearnN0NAWV'], ], 'parameters' => [ [ - 'name' => 'ExperimentId', + 'name' => 'TrafficControlTargetId', 'in' => 'path', - 'schema' => [ - 'title' => '实验ID。', - 'description' => '', - 'type' => 'string', - 'required' => true, - 'example' => '3', - ], + 'schema' => ['description' => 'The ID of the traffic control target.', 'type' => 'string', 'required' => true, 'example' => '2', 'title' => ''], ], [ 'name' => 'InstanceId', 'in' => 'query', - 'schema' => [ - 'title' => '实例ID。', - 'description' => '', - 'type' => 'string', - 'required' => true, - 'example' => 'pairec-cn-abcdefg1234', - ], + 'schema' => ['description' => 'The instance ID.', 'type' => 'string', 'required' => true, 'example' => 'pairec-1324***', 'title' => ''], ], ], 'responses' => [ 200 => [ 'schema' => [ + 'description' => 'The response body.', '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' => '2A734D87-2212-5C84-B63A-1AC87CA843D4', + 'RequestId' => ['title' => 'Id of the request', 'description' => 'The request ID.', 'type' => 'string', 'example' => '728C5E01-ABF6-5AA8-B9FC-B3BA05DECC77'], + 'TrafficControlTargetId' => ['description' => 'The ID of the traffic control target.', 'type' => 'string', 'example' => '1', 'title' => ''], + 'Name' => ['description' => 'The name of the traffic control target.', 'type' => 'string', 'example' => 'target-1', 'title' => ''], + 'StartTime' => ['description' => 'The start time.', 'type' => 'string', 'example' => '2024-03-25', 'title' => ''], + 'EndTime' => ['description' => 'The end time.', 'type' => 'string', 'example' => '2024-04-25', 'title' => ''], + 'ItemConditionType' => ['description' => 'The item condition type.', 'type' => 'string', 'example' => 'Array', 'title' => ''], + 'ItemConditionArray' => ['description' => 'The item condition, specified in an array format.', 'type' => 'string', 'example' => '[{"field":"status","option":"=","value":"1"}]', 'title' => ''], + 'ItemConditionExpress' => ['description' => 'The item condition, specified in an expression format.', 'type' => 'string', 'example' => 'status=1', 'title' => ''], + 'Event' => ['description' => 'The event of the control target.', 'type' => 'string', 'example' => 'click', 'title' => ''], + 'Value' => ['description' => 'The value of the control target.', 'type' => 'number', 'format' => 'float', 'example' => '30', 'title' => ''], + 'StatisPeriod' => ['description' => 'The statistics period.', 'type' => 'string', 'example' => 'Daily', 'title' => ''], + 'ToleranceValue' => ['description' => 'The tolerance value.', 'type' => 'integer', 'format' => 'int64', 'example' => '10', 'title' => ''], + 'RecallName' => ['description' => 'The name of the recall strategy.', 'type' => 'string', 'example' => 'recall-1', 'title' => ''], + 'Status' => ['description' => 'The status of the traffic control target.', 'type' => 'string', 'example' => '枚举值：开启：Opened关闭：Closed', 'title' => ''], + 'GmtCreateTime' => ['description' => 'The time when the traffic control target was created.', 'type' => 'string', 'example' => '2024-01-03T02:28:00.000Z', 'title' => ''], + 'SplitParts' => [ + 'description' => 'The piecewise control settings.', + 'type' => 'object', + 'properties' => [ + 'TimePoints' => [ + 'description' => 'The time points.', + 'type' => 'array', + 'items' => ['description' => 'A time point.', 'type' => 'integer', 'format' => 'int64', 'example' => '5', 'title' => ''], + 'title' => '', + 'example' => '', + ], + 'SetValues' => [ + 'description' => 'The set values.', + 'type' => 'array', + 'items' => ['description' => 'A set value.', 'type' => 'integer', 'format' => 'int64', 'example' => '10', 'title' => ''], + 'title' => '', + 'example' => '', + ], + 'SetPoints' => [ + 'description' => 'The set points.', + 'type' => 'array', + 'items' => ['description' => 'A set point.', 'type' => 'integer', 'format' => 'int64', 'example' => '10', 'title' => ''], + 'title' => '', + 'example' => '', + ], + ], + 'title' => '', + 'example' => '', ], + 'NewProductRegulation' => ['description' => 'Indicates whether new product regulation is enabled.', 'type' => 'boolean', 'example' => 'false', 'title' => ''], + 'TrafficControlTaskId' => ['description' => 'The ID of the traffic control task.', 'type' => 'string', 'example' => '1', 'title' => ''], ], + 'example' => '', ], ], ], - 'staticInfo' => [ - 'returnType' => 'synchronous', + 'staticInfo' => ['returnType' => 'synchronous'], + 'title' => 'Retrieve traffic regulation target details', + 'summary' => 'Gets the details of a traffic throttling objective by its ID.', + 'description' => '## Request'."\n" + ."\n" + .'Retrieves the detailed configuration of a traffic control target. The configuration includes the target name, time range, and condition settings. This operation requires the `TrafficControlTargetId` and `InstanceId` parameters.', + 'changeSet' => [], + 'flowControl' => [ + 'flowControlList' => [], ], - 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"2A734D87-2212-5C84-B63A-1AC87CA843D4\\"\\n}","type":"json"}]', - ], - 'UpdateExperiment' => [ - 'summary' => '更新实验。', - 'path' => '/api/v1/experiments/{ExperimentId}', - 'methods' => [ - 'put', - ], - 'schemes' => [ - 'http', - 'https', + 'ramActions' => [ + [ + 'operationType' => 'get', + 'ramAction' => [ + 'action' => 'pairec:GetTrafficControlTarget', + 'authLevel' => 'operate', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'PAIRecService', 'resourceType' => 'All Resource', 'arn' => '*'], + ], + ], + ], ], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"728C5E01-ABF6-5AA8-B9FC-B3BA05DECC77\\",\\n \\"TrafficControlTargetId\\": \\"1\\",\\n \\"Name\\": \\"target-1\\",\\n \\"StartTime\\": \\"2024-03-25\\",\\n \\"EndTime\\": \\"2024-04-25\\",\\n \\"ItemConditionType\\": \\"Array\\",\\n \\"ItemConditionArray\\": \\"[{\\\\\\"field\\\\\\":\\\\\\"status\\\\\\",\\\\\\"option\\\\\\":\\\\\\"=\\\\\\",\\\\\\"value\\\\\\":\\\\\\"1\\\\\\"}]\\",\\n \\"ItemConditionExpress\\": \\"status=1\\",\\n \\"Event\\": \\"click\\",\\n \\"Value\\": 30,\\n \\"StatisPeriod\\": \\"Daily\\",\\n \\"ToleranceValue\\": 10,\\n \\"RecallName\\": \\"recall-1\\",\\n \\"Status\\": \\"枚举值：开启：Opened关闭：Closed\\",\\n \\"GmtCreateTime\\": \\"2024-01-03T02:28:00.000Z\\",\\n \\"SplitParts\\": {\\n \\"TimePoints\\": [\\n 5\\n ],\\n \\"SetValues\\": [\\n 10\\n ],\\n \\"SetPoints\\": [\\n 10\\n ]\\n },\\n \\"NewProductRegulation\\": false,\\n \\"TrafficControlTaskId\\": \\"1\\"\\n}","type":"json"}]', + ], + 'GetTrafficControlTask' => [ + 'path' => '/api/v1/trafficcontroltasks/{TrafficControlTaskId}', + 'methods' => ['get'], + 'schemes' => ['http', 'https'], 'security' => [ [ 'AK' => [], ], ], - 'consumes' => [ - 'application/json', - ], - 'produces' => [ - 'application/json', - ], - 'operationType' => 'readAndWrite', + 'consumes' => ['application/json'], + 'produces' => ['application/json'], + 'operationType' => 'read', 'deprecated' => false, 'systemTags' => [ - 'operationType' => 'update', + 'operationType' => 'get', 'riskType' => 'none', 'chargeType' => 'free', - 'abilityTreeNodes' => [ - 'FEATURElearnN0NAWV', - ], + 'abilityTreeCode' => '220404', + 'abilityTreeNodes' => ['FEATURElearnN0NAWV'], ], 'parameters' => [ [ - 'name' => 'body', - 'in' => 'body', - 'style' => 'json', + 'name' => 'TrafficControlTaskId', + 'in' => 'path', + 'schema' => ['description' => 'The ID of the traffic control task.', 'type' => 'string', 'required' => true, 'example' => '1', 'title' => ''], + ], + [ + 'name' => 'Environment', + 'in' => 'query', + 'schema' => ['description' => 'The environment to which the parameter belongs. Valid values:'."\n" + .'- Daily: daily environment'."\n" + .'- Pre: staging environment'."\n" + .'- Prod: production environment.', 'type' => 'string', 'required' => false, 'example' => 'Daily', 'title' => ''], + ], + [ + 'name' => 'Version', + 'in' => 'query', + 'schema' => ['description' => 'The version.', 'type' => 'string', 'required' => false, 'example' => 'Latest', 'title' => ''], + ], + [ + 'name' => 'ControlTargetFilter', + 'in' => 'query', + 'schema' => ['description' => 'The filter for traffic control targets.', 'type' => 'string', 'required' => false, 'example' => 'All', 'title' => ''], + ], + [ + 'name' => 'RegionId', + 'in' => 'query', + 'schema' => ['description' => 'The region ID.', 'type' => 'string', 'required' => false, 'example' => 'cn-hangzhou', 'title' => ''], + ], + [ + 'name' => 'InstanceId', + 'in' => 'query', + 'schema' => ['description' => 'The instance ID.', 'type' => 'string', 'required' => false, 'example' => 'pairec-1324***', 'title' => ''], + ], + ], + 'responses' => [ + 200 => [ 'schema' => [ - 'description' => '', + 'title' => '', + 'description' => 'Schema of Response', 'type' => 'object', 'properties' => [ - 'InstanceId' => [ - 'title' => '实例ID。', - 'description' => '', - 'type' => 'string', - 'required' => true, - 'example' => 'pairec-cn-abcdefg1234', - ], - 'Name' => [ - 'title' => '实验名称。', - 'description' => '', - 'type' => 'string', - 'required' => true, - 'example' => 'experiment_test', - ], - 'Description' => [ - 'title' => '实验描述。', - 'description' => '', - 'type' => 'string', - 'required' => true, - 'example' => 'This is a test.', - ], - 'Type' => [ - 'title' => '实验类型。'."\n" - .'● Baseline-基准实验。'."\n" - .'● Normal-普通实验。', - 'description' => '', - 'type' => 'string', - 'required' => true, - 'example' => 'Baseline', - ], - 'FlowPercent' => [ - 'title' => '流量分配百分比。', - 'description' => '', - 'type' => 'integer', - 'format' => 'int32', - 'required' => false, - 'example' => '100', + 'RequestId' => ['title' => '', 'description' => 'The request ID.', 'type' => 'string', 'example' => '728C5E01-ABF6-5AA8-B9FC-B3BA05DECC77'], + 'TrafficControlTaskId' => ['description' => 'The ID of the traffic control task.', 'type' => 'string', 'example' => '1', 'title' => ''], + 'Name' => ['description' => 'The name of the traffic control task.', 'type' => 'string', 'example' => 'task-1', 'title' => ''], + 'Description' => ['description' => 'The description of the traffic control task.', 'type' => 'string', 'example' => 'this is a test task', 'title' => ''], + 'SceneId' => ['description' => 'The scene ID.', 'type' => 'string', 'example' => '2', 'title' => ''], + 'SceneName' => ['description' => 'The scene name.', 'type' => 'string', 'example' => 'scene-2', 'title' => ''], + 'ProductStatus' => ['description' => 'The production environment status.', 'type' => 'string', 'example' => 'Running', 'title' => ''], + 'PrepubStatus' => ['description' => 'The staging environment status.', 'type' => 'string', 'example' => 'Running', 'title' => ''], + 'ExecutionTime' => ['description' => 'The execution time.', 'type' => 'string', 'example' => 'Permanent', 'title' => ''], + 'StartTime' => ['description' => 'The start time.', 'type' => 'string', 'example' => '2024-03-25', 'title' => ''], + 'EndTime' => ['description' => 'The end time.', 'type' => 'string', 'example' => '2024-04-25', 'title' => ''], + 'BehaviorTableMetaId' => ['description' => 'The behavior table ID.', 'type' => 'string', 'example' => '1', 'title' => ''], + 'UserTableMetaId' => ['description' => 'The user table ID.', 'type' => 'string', 'example' => '2', 'title' => ''], + 'ItemTableMetaId' => ['description' => 'The item table ID.', 'type' => 'string', 'example' => '3', 'title' => ''], + 'UserConditionType' => ['description' => 'The condition type for the target user group.', 'type' => 'string', 'example' => 'Array', 'title' => ''], + 'UserConditionArray' => ['description' => 'The target user group conditions in array format.', 'type' => 'string', 'example' => '[{"field":"gender","option":"=","value":"male"}]', 'title' => ''], + 'UserConditionExpress' => ['description' => 'The target user group conditions in expression format.', 'type' => 'string', 'example' => 'age<=30&&(3<=level<=6)&&gender=male', 'title' => ''], + 'StatisBehaviorConditionType' => ['description' => 'The behavior statistics condition type.', 'type' => 'string', 'example' => 'Array', 'title' => ''], + 'StatisBehaviorConditionArray' => ['description' => 'The behavior statistics conditions in array format.', 'type' => 'string', 'example' => '[{"field":"click","option":"<=","value":"30"}]', 'title' => ''], + 'StatisBehaviorConditionExpress' => ['description' => 'The behavior statistics conditions in expression format.', 'type' => 'string', 'example' => 'click=30', 'title' => ''], + 'ControlType' => ['description' => 'The control type.', 'type' => 'string', 'example' => 'Percent', 'title' => ''], + 'ControlGranularity' => ['description' => 'The control granularity.', 'type' => 'string', 'example' => 'Global', 'title' => ''], + 'ControlLogic' => ['description' => 'The control logic.', 'type' => 'string', 'example' => 'Guaranteed', 'title' => ''], + 'ItemConditionType' => ['description' => 'The item condition type.', 'type' => 'string', 'example' => 'Array', 'title' => ''], + 'ItemConditionArray' => ['description' => 'The item conditions in array format.', 'type' => 'string', 'example' => '[{"field":"status","option":"=","value":"1"}]', 'title' => ''], + 'ItemConditionExpress' => ['description' => 'The item conditions in expression format.', 'type' => 'string', 'example' => 'status=1', 'title' => ''], + 'GmtCreateTime' => ['description' => 'The creation time.', 'type' => 'string', 'example' => '2024-01-11T02:27:38.208Z', 'title' => ''], + 'GmtModifiedTime' => ['description' => 'The last modification time.', 'type' => 'string', 'example' => '2024-01-11T02:27:38.208Z', 'title' => ''], + 'TrafficControlTargets' => [ + 'description' => 'The list of traffic control targets.', + 'type' => 'array', + 'items' => [ + 'description' => 'The details of a traffic control target.', + 'type' => 'object', + 'properties' => [ + 'TrafficControlTargetId' => ['description' => 'The ID of the traffic control target.', 'type' => 'string', 'example' => '1', 'title' => ''], + 'Name' => ['description' => 'The name of the control target.', 'type' => 'string', 'example' => 'target-1', 'title' => ''], + 'StartTime' => ['description' => 'The start time.', 'type' => 'string', 'example' => '2024-03-25', 'title' => ''], + 'EndTime' => ['description' => 'The end time.', 'type' => 'string', 'example' => '2024-04-25', 'title' => ''], + 'ItemConditionType' => ['description' => 'The item condition type.', 'type' => 'string', 'example' => 'Array', 'title' => ''], + 'ItemConditionArray' => ['description' => 'The item conditions in array format.', 'type' => 'string', 'example' => '[{"field":"status","option":"=","value":"1"}]', 'title' => ''], + 'ItemConditionExpress' => ['description' => 'The item conditions in expression format.', 'type' => 'string', 'example' => 'status=1', 'title' => ''], + 'Event' => ['description' => 'The control target event.', 'type' => 'string', 'example' => 'click', 'title' => ''], + 'Value' => ['description' => 'The control target value.', 'type' => 'number', 'format' => 'float', 'example' => '30', 'title' => ''], + 'StatisPeriod' => ['description' => 'The statistical period.', 'type' => 'string', 'example' => 'Daily', 'title' => ''], + 'ToleranceValue' => ['description' => 'The tolerance range of the control target.', 'type' => 'integer', 'format' => 'int64', 'example' => '10', 'title' => ''], + 'RecallName' => ['description' => 'The recall Policy Name.', 'type' => 'string', 'example' => 'recall-1', 'title' => ''], + 'Status' => ['description' => 'The status.', 'type' => 'string', 'example' => 'Opened', 'title' => ''], + 'GmtCreateTime' => ['description' => 'The creation time.', 'type' => 'string', 'example' => '2024-03-25T06:04:28.441Z', 'title' => ''], + 'GmtModifiedTime' => ['description' => 'The last modification time.', 'type' => 'string', 'example' => '2024-03-25T06:04:28.441Z', 'title' => ''], + 'SplitParts' => [ + 'description' => 'The split configuration of the control target.', + 'type' => 'object', + 'properties' => [ + 'TimePoints' => [ + 'description' => 'The time points for splitting the control target.', + 'type' => 'array', + 'items' => ['description' => 'The time split point.', 'type' => 'integer', 'format' => 'int32', 'example' => '2', 'title' => ''], + 'title' => '', + 'example' => '', + ], + 'SetPoints' => [ + 'description' => 'The list of target value split points.', + 'type' => 'array', + 'items' => ['description' => 'The target value split point.', 'type' => 'integer', 'format' => 'int32', 'example' => '10', 'title' => ''], + 'title' => '', + 'example' => '', + ], + 'SetValues' => [ + 'description' => 'The list of control target set values.', + 'type' => 'array', + 'items' => ['description' => 'The target set value.', 'type' => 'integer', 'format' => 'int64', 'example' => '10', 'title' => ''], + 'title' => '', + 'example' => '', + ], + ], + 'title' => '', + 'example' => '', + ], + 'NewProductRegulation' => ['description' => 'Indicates whether this is a new product regulation.', 'type' => 'boolean', 'example' => 'false', 'title' => ''], + 'TrafficControlTaskId' => ['description' => 'The ID of the traffic control task.', 'type' => 'string', 'example' => '1', 'title' => ''], + ], + 'title' => '', + 'example' => '', + ], + 'title' => '', + 'example' => '', ], - 'DebugUsers' => [ - 'title' => '调试用户。', - 'description' => '', - 'type' => 'string', - 'required' => false, - 'example' => '1124512470******,1124512471******,1124512472******', + 'EverPublished' => ['description' => 'Indicates whether the task has ever been published.', 'type' => 'boolean', 'example' => 'true', 'title' => ''], + 'ServiceId' => ['description' => 'The service ID.', 'type' => 'string', 'example' => '1', 'title' => ''], + 'PreExperimentIds' => ['description' => 'The experiment IDs in the staging environment.', 'type' => 'string', 'example' => '1,2,3', 'title' => ''], + 'ProdExperimentIds' => ['description' => 'The experiment IDs in the production environment.', 'type' => 'string', 'example' => '4,5,6', 'title' => ''], + 'FlinkResourceId' => ['description' => 'The Flink resource ID.', 'type' => 'string', 'example' => 'resource-xxx', 'title' => ''], + 'FlinkResourceName' => ['description' => 'The Flink resource name.', 'type' => 'string', 'example' => 'flink_test', 'title' => ''], + 'EffectiveSceneIds' => [ + 'description' => 'The list of effective scene IDs.', + 'type' => 'array', + 'items' => ['description' => 'The effective service ID.', 'type' => 'integer', 'format' => 'int32', 'example' => '3', 'title' => ''], + 'title' => '', + 'example' => '', ], - 'DebugCrowdId' => [ - 'title' => '调试人群ID。', - 'description' => '', - 'type' => 'string', - 'required' => false, - 'example' => '3', + 'EffectiveSceneNames' => [ + 'description' => 'The list of effective scene names.', + 'type' => 'array', + 'items' => ['description' => 'The list of effective scene names.', 'type' => 'string', 'example' => 'home_feed', 'title' => ''], + 'title' => '', + 'example' => '', ], - 'Config' => [ - 'title' => '实验配置。', - 'description' => '', - 'type' => 'string', - 'required' => false, - 'example' => '{"RankBy": "Score"}', + 'ServiceIds' => [ + 'description' => 'The list of service IDs.', + 'type' => 'array', + 'items' => ['description' => 'The service ID.', 'type' => 'integer', 'format' => 'int32', 'example' => '2', 'title' => ''], + 'title' => '', + 'example' => '', ], ], - 'required' => false, + 'example' => '', ], ], + ], + 'staticInfo' => ['returnType' => 'synchronous'], + 'eventInfo' => [ + 'enable' => false, + 'eventNames' => [], + ], + 'title' => 'Get traffic control task details', + 'summary' => 'Queries the details of a traffic control task with a specified ID.', + 'description' => '## Description'."\n" + .'- This operation retrieves the details of a specific traffic control task, including but not limited to the task name, description, and status.'."\n" + .'- TrafficControlTaskId and InstanceId are required parameters that specify the task ID and instance ID to query.'."\n" + .'- Optional parameters such as Environment, Version, and ControlTargetFilter help refine the request to retrieve more specific task data or version information.'."\n" + .'- Check the returned data structure, especially the TrafficControlTargets section, which contains multiple control targets and their related properties.', + 'changeSet' => [], + 'flowControl' => [ + 'flowControlList' => [], + ], + 'ramActions' => [ + [ + 'operationType' => 'get', + 'ramAction' => [ + 'action' => 'pairec:GetTrafficControlTask', + 'authLevel' => 'operate', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'PAIRecService', 'resourceType' => 'All Resource', 'arn' => '*'], + ], + ], + ], + ], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"728C5E01-ABF6-5AA8-B9FC-B3BA05DECC77\\",\\n \\"TrafficControlTaskId\\": \\"1\\",\\n \\"Name\\": \\"task-1\\",\\n \\"Description\\": \\"this is a test task\\",\\n \\"SceneId\\": \\"2\\",\\n \\"SceneName\\": \\"scene-2\\",\\n \\"ProductStatus\\": \\"Running\\",\\n \\"PrepubStatus\\": \\"Running\\",\\n \\"ExecutionTime\\": \\"Permanent\\",\\n \\"StartTime\\": \\"2024-03-25\\",\\n \\"EndTime\\": \\"2024-04-25\\",\\n \\"BehaviorTableMetaId\\": \\"1\\",\\n \\"UserTableMetaId\\": \\"2\\",\\n \\"ItemTableMetaId\\": \\"3\\",\\n \\"UserConditionType\\": \\"Array\\",\\n \\"UserConditionArray\\": \\"[{\\\\\\"field\\\\\\":\\\\\\"gender\\\\\\",\\\\\\"option\\\\\\":\\\\\\"=\\\\\\",\\\\\\"value\\\\\\":\\\\\\"male\\\\\\"}]\\",\\n \\"UserConditionExpress\\": \\"age<=30&&(3<=level<=6)&&gender=male\\",\\n \\"StatisBehaviorConditionType\\": \\"Array\\",\\n \\"StatisBehaviorConditionArray\\": \\"[{\\\\\\"field\\\\\\":\\\\\\"click\\\\\\",\\\\\\"option\\\\\\":\\\\\\"<=\\\\\\",\\\\\\"value\\\\\\":\\\\\\"30\\\\\\"}]\\",\\n \\"StatisBehaviorConditionExpress\\": \\"click=30\\",\\n \\"ControlType\\": \\"Percent\\",\\n \\"ControlGranularity\\": \\"Global\\",\\n \\"ControlLogic\\": \\"Guaranteed\\",\\n \\"ItemConditionType\\": \\"Array\\",\\n \\"ItemConditionArray\\": \\"[{\\\\\\"field\\\\\\":\\\\\\"status\\\\\\",\\\\\\"option\\\\\\":\\\\\\"=\\\\\\",\\\\\\"value\\\\\\":\\\\\\"1\\\\\\"}]\\",\\n \\"ItemConditionExpress\\": \\"status=1\\",\\n \\"GmtCreateTime\\": \\"2024-01-11T02:27:38.208Z\\",\\n \\"GmtModifiedTime\\": \\"2024-01-11T02:27:38.208Z\\",\\n \\"TrafficControlTargets\\": [\\n {\\n \\"TrafficControlTargetId\\": \\"1\\",\\n \\"Name\\": \\"target-1\\",\\n \\"StartTime\\": \\"2024-03-25\\",\\n \\"EndTime\\": \\"2024-04-25\\",\\n \\"ItemConditionType\\": \\"Array\\",\\n \\"ItemConditionArray\\": \\"[{\\\\\\"field\\\\\\":\\\\\\"status\\\\\\",\\\\\\"option\\\\\\":\\\\\\"=\\\\\\",\\\\\\"value\\\\\\":\\\\\\"1\\\\\\"}]\\",\\n \\"ItemConditionExpress\\": \\"status=1\\",\\n \\"Event\\": \\"click\\",\\n \\"Value\\": 30,\\n \\"StatisPeriod\\": \\"Daily\\",\\n \\"ToleranceValue\\": 10,\\n \\"RecallName\\": \\"recall-1\\",\\n \\"Status\\": \\"Opened\\",\\n \\"GmtCreateTime\\": \\"2024-03-25T06:04:28.441Z\\",\\n \\"GmtModifiedTime\\": \\"2024-03-25T06:04:28.441Z\\",\\n \\"SplitParts\\": {\\n \\"TimePoints\\": [\\n 2\\n ],\\n \\"SetPoints\\": [\\n 10\\n ],\\n \\"SetValues\\": [\\n 10\\n ]\\n },\\n \\"NewProductRegulation\\": false,\\n \\"TrafficControlTaskId\\": \\"1\\"\\n }\\n ],\\n \\"EverPublished\\": true,\\n \\"ServiceId\\": \\"1\\",\\n \\"PreExperimentIds\\": \\"1,2,3\\",\\n \\"ProdExperimentIds\\": \\"4,5,6\\",\\n \\"FlinkResourceId\\": \\"resource-xxx\\",\\n \\"FlinkResourceName\\": \\"flink_test\\",\\n \\"EffectiveSceneIds\\": [\\n 3\\n ],\\n \\"EffectiveSceneNames\\": [\\n \\"home_feed\\"\\n ],\\n \\"ServiceIds\\": [\\n 2\\n ]\\n}","type":"json"}]', + ], + 'GetTrafficControlTaskTraffic' => [ + 'summary' => 'Retrieves traffic allocation details for a specific traffic control task.', + 'path' => '/api/v1/trafficcontroltasks/{TrafficControlTaskId}/trafficinfo', + 'methods' => ['get'], + 'schemes' => ['http', 'https'], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'consumes' => ['application/json'], + 'produces' => ['application/json'], + 'operationType' => 'read', + 'deprecated' => false, + 'systemTags' => [ + 'operationType' => 'none', + 'riskType' => 'none', + 'chargeType' => 'free', + 'abilityTreeCode' => '220416', + 'abilityTreeNodes' => ['FEATURElearnN0NAWV'], + ], + 'parameters' => [ [ - 'name' => 'ExperimentId', + 'name' => 'TrafficControlTaskId', 'in' => 'path', - 'schema' => [ - 'title' => '实验ID。', - 'description' => '', - 'type' => 'string', - 'required' => true, - 'example' => '3', - ], + 'schema' => ['description' => 'The ID of the traffic control task.', 'type' => 'string', 'required' => false, 'example' => '1', 'title' => ''], + ], + [ + 'name' => 'InstanceId', + 'in' => 'query', + 'schema' => ['description' => 'The instance ID. For more information, see [ListInstances](~~2411819~~).', 'type' => 'string', 'required' => false, 'example' => 'pairec-test-xxx', 'title' => ''], + ], + [ + 'name' => 'Environment', + 'in' => 'query', + 'schema' => ['description' => 'The environment. Valid values:'."\n" + ."\n" + .'- `Daily`: The daily environment.'."\n" + ."\n" + .'- `Pre`: The staging environment.'."\n" + ."\n" + .'- `Prod`: The production environment.', 'type' => 'string', 'required' => false, 'example' => 'Pre', 'title' => ''], ], ], 'responses' => [ 200 => [ 'schema' => [ 'title' => 'Schema of Response', - 'description' => 'Schema of Response', + 'description' => 'The data returned in the response.', 'type' => 'object', 'properties' => [ - 'RequestId' => [ - 'title' => 'Id of the request', - 'description' => 'Id of the request', - 'type' => 'string', - 'example' => 'A760D972-1475-58C0-BBB3-92B5FB08904F', + 'RequestId' => ['title' => 'Id of the request', 'description' => 'The request ID.', 'type' => 'string', 'example' => '6CF1E160-3F36-5E73-A170-C75504F05BBC'], + 'TrafficControlTaskTrafficInfo' => [ + 'description' => 'Details of the reported traffic data.', + 'type' => 'object', + 'properties' => [ + 'TaskTraffics' => [ + 'description' => 'The reported traffic data for the traffic control task.', + 'type' => 'object', + 'additionalProperties' => [ + 'type' => 'object', + 'properties' => [ + 'Traffic' => ['description' => 'The reported traffic for this experiment.', 'type' => 'number', 'format' => 'double', 'example' => '100', 'title' => ''], + ], + 'description' => 'A map where each key is an experiment ID.', + 'title' => '', + 'example' => '', + ], + 'title' => '', + 'example' => '', + ], + 'TargetTraffics' => [ + 'description' => 'The traffic data for each traffic control target.', + 'type' => 'array', + 'items' => [ + 'description' => 'The reported traffic data for the traffic control target.', + 'type' => 'object', + 'properties' => [ + 'TrafficContorlTargetId' => ['description' => 'The traffic control target ID.', 'type' => 'string', 'example' => '2', 'title' => ''], + 'Data' => [ + 'description' => 'The detailed data reported for this traffic control target.', + 'type' => 'object', + 'additionalProperties' => [ + 'type' => 'object', + 'properties' => [ + 'Traffic' => ['description' => 'The reported traffic for this target within the experiment.', 'type' => 'number', 'format' => 'double', 'example' => '80', 'title' => ''], + 'RecordTime' => ['description' => 'The timestamp indicating when the data was reported.', 'type' => 'integer', 'format' => 'int64', 'example' => '1760319273', 'title' => ''], + ], + 'description' => 'A map where each key is an experiment ID.', + 'title' => '', + 'example' => '', + ], + 'title' => '', + 'example' => '', + ], + ], + 'title' => '', + 'example' => '', + ], + 'title' => '', + 'example' => '', + ], + ], + 'title' => '', + 'example' => '', ], ], + 'example' => '', ], ], ], - 'staticInfo' => [ - 'returnType' => 'synchronous', + 'staticInfo' => ['returnType' => 'synchronous'], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"6CF1E160-3F36-5E73-A170-C75504F05BBC\\",\\n \\"TrafficControlTaskTrafficInfo\\": {\\n \\"TaskTraffics\\": {\\n \\"key\\": {\\n \\"Traffic\\": 100\\n }\\n },\\n \\"TargetTraffics\\": [\\n {\\n \\"TrafficContorlTargetId\\": \\"2\\",\\n \\"Data\\": {\\n \\"key\\": {\\n \\"Traffic\\": 80,\\n \\"RecordTime\\": 1760319273\\n }\\n }\\n }\\n ]\\n }\\n}","type":"json"}]', + 'title' => 'Retrieve Reported Traffic for a Traffic Control Job', + 'description' => '## Description'."\n" + ."\n" + .'This API retrieves the traffic details for a specific traffic control task. The request must include the `TrafficControlTaskId`, `InstanceId`, and `Environment`.'."\n" + ."\n" + .'- `TrafficControlTaskId`: The unique identifier for the traffic control task.'."\n" + ."\n" + .'- `InstanceId`: The instance ID.'."\n" + ."\n" + .'- `Environment`: The environment type, such as the production environment (Prod).'."\n" + ."\n" + .'The response includes the traffic allocation for each experiment and traffic control target. This data allows you to analyze and manage your traffic control strategies.', + 'changeSet' => [ + ['createdAt' => '2025-10-14T05:30:57.000Z', 'description' => 'Response parameters changed'], + ], + 'flowControl' => [ + 'flowControlList' => [], + ], + 'ramActions' => [ + [ + 'operationType' => 'none', + 'ramAction' => [ + 'action' => 'pairec:GetTrafficControlTaskTraffic', + 'authLevel' => 'operate', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'PAIRecService', 'resourceType' => 'All Resource', 'arn' => '*'], + ], + ], + ], ], - 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"A760D972-1475-58C0-BBB3-92B5FB08904F\\"\\n}","type":"json"}]', ], - 'GetExperiment' => [ - 'summary' => '获取实验详细信息。', - 'path' => '/api/v1/experiments/{ExperimentId}', - 'methods' => [ - 'get', - ], - 'schemes' => [ - 'http', - 'https', - ], + 'ListABMetricGroups' => [ + 'summary' => 'Retrieves a list of A/B metric groups.', + 'path' => '/api/v1/abmetricgroups', + 'methods' => ['get'], + 'schemes' => ['http', 'https'], 'security' => [ [ 'AK' => [], ], ], - 'consumes' => [ - 'application/json', - ], - 'produces' => [ - 'application/json', - ], + 'consumes' => ['application/json'], + 'produces' => ['application/json'], 'operationType' => 'read', 'deprecated' => false, 'systemTags' => [ - 'operationType' => 'get', + 'operationType' => 'list', 'riskType' => 'none', 'chargeType' => 'free', - 'abilityTreeNodes' => [ - 'FEATURElearnN0NAWV', - ], + 'abilityTreeNodes' => ['FEATURElearnN0NAWV'], ], 'parameters' => [ [ - 'name' => 'ExperimentId', - 'in' => 'path', - 'schema' => [ - 'title' => '实验ID。', - 'description' => '', - 'type' => 'string', - 'required' => true, - 'example' => '3', - ], + 'name' => 'SceneId', + 'in' => 'query', + 'schema' => ['description' => 'The scene ID. You can call the [ListScenes](\\(~~2402581~~\\)) operation to obtain this ID.', 'type' => 'string', 'required' => false, 'example' => '1', 'title' => ''], ], [ 'name' => 'InstanceId', 'in' => 'query', - 'schema' => [ - 'title' => '实例ID。', - 'description' => '', - 'type' => 'string', - 'required' => true, - 'example' => 'pairec-test1', - ], + 'schema' => ['description' => 'The instance ID. You can call the [ListInstances](~~2411819~~) operation to obtain this ID.', 'type' => 'string', 'required' => true, 'example' => 'pairec-cn-test1', 'title' => ''], + ], + [ + 'name' => 'PageNumber', + 'in' => 'query', + 'schema' => ['description' => 'The page number.', 'type' => 'integer', 'format' => 'int32', 'required' => false, 'example' => '1', 'title' => ''], + ], + [ + 'name' => 'PageSize', + 'in' => 'query', + 'schema' => ['description' => 'The number of entries to return on each page.', 'type' => 'integer', 'format' => 'int32', 'required' => false, 'example' => '10', 'title' => ''], + ], + [ + 'name' => 'Realtime', + 'in' => 'query', + 'schema' => ['description' => 'Specifies whether to return only real-time A/B metric groups.', 'type' => 'boolean', 'required' => false, 'example' => 'false', 'title' => ''], + ], + [ + 'name' => 'SortBy', + 'in' => 'query', + 'schema' => ['description' => 'The field to sort the results by. Valid values:'."\n" + ."\n" + .'- GmtCreateTime: creation time.'."\n" + ."\n" + .'- GmtModifiedTime: modification time.', 'type' => 'string', 'required' => false, 'example' => 'GmtCreateTime', 'title' => ''], + ], + [ + 'name' => 'Order', + 'in' => 'query', + 'schema' => ['description' => 'The sort order. Valid values:'."\n" + ."\n" + .'- ASC: ascending.'."\n" + ."\n" + .'- DESC: descending.', 'type' => 'string', 'required' => false, 'example' => 'ASC', 'title' => ''], ], ], 'responses' => [ 200 => [ 'schema' => [ 'title' => 'Schema of Response', - 'description' => 'Schema of Response', + 'description' => 'The data returned.', 'type' => 'object', 'properties' => [ - 'RequestId' => [ - 'title' => 'Id of the request', - 'description' => 'Id of the request', - 'type' => 'string', - 'example' => '74D958EF-3598-56FA-8296-FF1575CE43DF', - ], - 'AliasExperimentId' => [ - 'title' => '实验ID别名。', - 'description' => '', - 'type' => 'string', - 'example' => 'L1#EG1#E1', - ], - 'ExperimentGroupId' => [ - 'title' => '实验组ID。', - 'description' => '', - 'type' => 'string', - 'example' => '3', - ], - 'LayerId' => [ - 'title' => '层ID。', - 'description' => '', - 'type' => 'string', - 'example' => '3', - ], - 'LaboratoryId' => [ - 'title' => '实验室ID。', - 'description' => '', - 'type' => 'string', - 'example' => '3', - ], - 'SceneId' => [ - 'title' => '场景ID。', - 'description' => '', - 'type' => 'string', - 'example' => '3', - ], - 'Name' => [ - 'title' => '实验名称。', - 'description' => '', - 'type' => 'string', - 'example' => 'experiment_test1', - ], - 'Description' => [ - 'title' => '实验描述。', - 'description' => '', - 'type' => 'string', - 'example' => 'This is a test.', - ], - 'Type' => [ - 'title' => '实验类型。'."\n" - .'● Baseline-基准实验。'."\n" - .'● Normal-普通实验。', - 'description' => '', - 'type' => 'string', - 'example' => 'Baseline', - ], - 'FlowPercent' => [ - 'title' => '流量分配百分比。', - 'description' => '', - 'type' => 'integer', - 'format' => 'int32', - 'example' => '100', - 'default' => '100', - ], - 'Buckets' => [ - 'title' => '分配桶号。', - 'description' => '', - 'type' => 'string', - 'example' => '1,2,3', - ], - 'DebugUsers' => [ - 'title' => '调试用户。', - 'description' => '', - 'type' => 'string', - 'example' => 'uid1,uid2,uid3', - ], - 'DebugCrowdId' => [ - 'title' => '调试人群ID。', - 'description' => '', - 'type' => 'string', - 'example' => '3', - ], - 'Config' => [ - 'title' => '实验配置。', - 'description' => '', - 'type' => 'string', - 'example' => '{}', - ], - 'Status' => [ - 'title' => '状态过滤。'."\n" - .'● Offline-未上线'."\n" - .'● Online-已上线', - 'description' => '', - 'type' => 'string', - 'example' => 'Offline', - ], - 'GmtCreateTime' => [ - 'title' => '创建时间。', - 'description' => '', - 'type' => 'string', - 'example' => '2021-12-15T23:24:33.132+08:00', - ], - 'GmtModifiedTime' => [ - 'title' => '更新时间。', - 'description' => '', - 'type' => 'string', - 'example' => '2021-12-15T23:24:33.132+08:00', + 'RequestId' => ['title' => 'Id of the request', 'description' => 'The request ID.', 'type' => 'string', 'example' => 'E15A1443-7917-5BE0-AE70-25538ECF398D'], + 'TotalCount' => ['description' => 'The total number of A/B metric groups.', 'type' => 'integer', 'format' => 'int64', 'example' => '10', 'title' => ''], + 'ABMetricGroups' => [ + 'description' => 'The A/B metric groups.', + 'type' => 'array', + 'items' => [ + 'description' => 'An A/B metric group.', + 'type' => 'object', + 'properties' => [ + 'ABMetricGroupId' => ['description' => 'The A/B metric group ID.', 'type' => 'string', 'example' => '1', 'title' => ''], + 'Name' => ['description' => 'The A/B metric group name.', 'type' => 'string', 'example' => 'visits', 'title' => ''], + 'SceneId' => ['description' => 'The scene ID.', 'type' => 'string', 'example' => '1', 'title' => ''], + 'Description' => ['description' => 'The description of the A/B metric group.', 'type' => 'string', 'example' => '访问量相关指标', 'title' => ''], + 'Owner' => ['description' => 'The owner.', 'type' => 'string', 'example' => '2799614***', 'title' => ''], + 'ABMetricIds' => ['description' => 'The comma-separated IDs of the A/B metrics in the group.', 'type' => 'string', 'example' => '1,2', 'title' => ''], + 'ABMetricNames' => ['description' => 'The comma-separated names of the A/B metrics in the group.', 'type' => 'string', 'example' => 'pv,uv', 'title' => ''], + 'Realtime' => ['description' => 'Indicates whether the A/B metric group is a real-time group.', 'type' => 'boolean', 'example' => 'false', 'title' => ''], + ], + 'title' => '', + 'example' => '', + ], + 'title' => '', + 'example' => '', ], ], + 'example' => '', ], ], ], - 'staticInfo' => [ - 'returnType' => 'synchronous', + 'staticInfo' => ['returnType' => 'synchronous'], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"E15A1443-7917-5BE0-AE70-25538ECF398D\\",\\n \\"TotalCount\\": 10,\\n \\"ABMetricGroups\\": [\\n {\\n \\"ABMetricGroupId\\": \\"1\\",\\n \\"Name\\": \\"visits\\",\\n \\"SceneId\\": \\"1\\",\\n \\"Description\\": \\"访问量相关指标\\",\\n \\"Owner\\": \\"2799614***\\",\\n \\"ABMetricIds\\": \\"1,2\\",\\n \\"ABMetricNames\\": \\"pv,uv\\",\\n \\"Realtime\\": false\\n }\\n ]\\n}","type":"json"}]', + 'title' => 'Retrieve the Metric Group List', + 'changeSet' => [ + ['createdAt' => '2024-02-22T03:35:43.000Z', 'description' => 'Request parameters changed'], + ], + 'flowControl' => [ + 'flowControlList' => [], + ], + 'ramActions' => [ + [ + 'operationType' => 'list', + 'ramAction' => [ + 'action' => 'pairec:ListABMetricGroups', + 'authLevel' => 'operate', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'PAIRecService', 'resourceType' => 'All Resource', 'arn' => '*'], + ], + ], + ], ], - 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"74D958EF-3598-56FA-8296-FF1575CE43DF\\",\\n \\"AliasExperimentId\\": \\"L1#EG1#E1\\",\\n \\"ExperimentGroupId\\": \\"3\\",\\n \\"LayerId\\": \\"3\\",\\n \\"LaboratoryId\\": \\"3\\",\\n \\"SceneId\\": \\"3\\",\\n \\"Name\\": \\"experiment_test1\\",\\n \\"Description\\": \\"This is a test.\\",\\n \\"Type\\": \\"Baseline\\",\\n \\"FlowPercent\\": 100,\\n \\"Buckets\\": \\"1,2,3\\",\\n \\"DebugUsers\\": \\"1124512470******,1124512471******,1124512472******\\",\\n \\"DebugCrowdId\\": \\"3\\",\\n \\"Config\\": \\"{\\\\\\"RankBy\\\\\\": \\\\\\"Score\\\\\\"}\\",\\n \\"Status\\": \\"Offline\\",\\n \\"GmtCreateTime\\": \\"2021-12-15T23:24:33.132+08:00\\",\\n \\"GmtModifiedTime\\": \\"2021-12-15T23:24:33.132+08:00\\"\\n}","type":"json"}]', ], - 'ListExperiments' => [ - 'summary' => '获取实验列表。', - 'path' => '/api/v1/experiments', - 'methods' => [ - 'get', - ], - 'schemes' => [ - 'http', - 'https', - ], + 'ListABMetrics' => [ + 'path' => '/api/v1/abmetrics', + 'methods' => ['get'], + 'schemes' => ['http', 'https'], 'security' => [ [ 'AK' => [], ], ], - 'consumes' => [ - 'application/json', - ], - 'produces' => [ - 'application/json', - ], + 'consumes' => ['application/json'], + 'produces' => ['application/json'], 'operationType' => 'read', 'deprecated' => false, 'systemTags' => [ 'operationType' => 'list', 'riskType' => 'none', 'chargeType' => 'free', - 'abilityTreeNodes' => [ - 'FEATURElearnN0NAWV', - ], + 'abilityTreeNodes' => ['FEATURElearnN0NAWV'], ], 'parameters' => [ [ - 'name' => 'ExperimentGroupId', + 'name' => 'Type', 'in' => 'query', - 'schema' => [ - 'description' => '', - 'type' => 'string', - 'required' => false, - 'example' => '3', - ], + 'schema' => ['description' => 'The metric type. You can use this parameter to filter the results. Valid values:'."\n" + ."\n" + .'- `Single`: A single metric.'."\n" + ."\n" + .'- `Derived`: A derived metric.', 'type' => 'string', 'required' => false, 'example' => 'Single', 'title' => ''], ], [ - 'name' => 'Status', + 'name' => 'Realtime', 'in' => 'query', - 'schema' => [ - 'title' => '状态过滤。'."\n" - .'● Offline-未上线'."\n" - .'● Online-已上线', - 'description' => '', - 'type' => 'string', - 'required' => false, - 'example' => 'Offline', - ], + 'schema' => ['description' => 'Specifies whether to filter for real-time metrics.', 'type' => 'boolean', 'required' => false, 'example' => 'false', 'title' => ''], + ], + [ + 'name' => 'PageNumber', + 'in' => 'query', + 'schema' => ['description' => 'The page number.', 'type' => 'integer', 'format' => 'int32', 'required' => false, 'example' => '1', 'title' => ''], + ], + [ + 'name' => 'PageSize', + 'in' => 'query', + 'schema' => ['description' => 'The number of entries to return per page.', 'type' => 'integer', 'format' => 'int32', 'required' => false, 'example' => '10', 'title' => ''], + ], + [ + 'name' => 'Name', + 'in' => 'query', + 'schema' => ['description' => 'The name to use for filtering metrics.', 'type' => 'string', 'required' => false, 'example' => 'home', 'title' => ''], + ], + [ + 'name' => 'TableMetaId', + 'in' => 'query', + 'schema' => ['description' => 'The data table ID. Call the ListTableMetas operation to obtain the ID.', 'type' => 'string', 'required' => false, 'example' => '1', 'title' => ''], ], [ 'name' => 'InstanceId', 'in' => 'query', - 'schema' => [ - 'title' => '实例ID。', - 'description' => '', - 'type' => 'string', - 'required' => true, - 'example' => 'pairec-test1', - ], + 'schema' => ['description' => 'The instance ID. Call the [ListInstances](~~2411819~~) operation to obtain the ID.', 'type' => 'string', 'required' => true, 'example' => 'pairec-cn-test1', 'title' => ''], ], [ - 'name' => 'Query', + 'name' => 'SceneId', 'in' => 'query', - 'schema' => [ - 'title' => '快速查询时的过滤参数。会返回与名称/标签匹配的所有实验。', - 'description' => '', - 'type' => 'string', - 'required' => false, - 'example' => 'experiment_test1', - ], + 'schema' => ['description' => 'The scene ID. Call the [ListScenes](~~2402581~~) operation to obtain the ID.', 'type' => 'string', 'required' => false, 'example' => '1', 'title' => ''], ], ], 'responses' => [ 200 => [ 'schema' => [ 'title' => 'Schema of Response', - 'description' => 'Schema of Response', + 'description' => 'The response body.', 'type' => 'object', 'properties' => [ - 'RequestId' => [ - 'title' => 'Id of the request', - 'description' => 'Id of the request', - 'type' => 'string', - 'example' => '68075085-1A7D-55C2-B51D-7AD9B02A6DD6', - ], - 'TotalCount' => [ - 'description' => '', - 'type' => 'integer', - 'format' => 'int64', - 'example' => '10', - ], - 'Experiments' => [ - 'title' => '实验列表', - 'description' => '', + 'RequestId' => ['title' => 'Id of the request', 'description' => 'The request ID.', 'type' => 'string', 'example' => 'F7AC05FF-EDE7-5C2B-B9AE-33D6DF4178BA'], + 'TotalCount' => ['description' => 'The total number of AB metrics returned.', 'type' => 'integer', 'format' => 'int64', 'example' => '10', 'title' => ''], + 'ABMetrics' => [ + 'description' => 'The list of AB metrics.', 'type' => 'array', 'items' => [ + 'description' => 'The details of an AB metric.', 'type' => 'object', 'properties' => [ - 'ExperimentId' => [ - 'title' => '实验ID。', - 'description' => '', - 'type' => 'string', - 'example' => '3', - ], - 'AliasExperimentId' => [ - 'title' => '实验ID别名。', - 'description' => '', - 'type' => 'string', - 'example' => 'L1#EG1#E1', - ], - 'ExperimentGroupId' => [ - 'title' => '实验组ID。', - 'description' => '', - 'type' => 'string', - 'example' => '3', - ], - 'LayerId' => [ - 'title' => '层ID。', - 'description' => '', - 'type' => 'string', - 'example' => '3', - ], - 'LaboratoryId' => [ - 'title' => '实验室ID。', - 'description' => '', - 'type' => 'string', - 'example' => '3', - ], - 'SceneId' => [ - 'title' => '场景ID。', - 'description' => '', - 'type' => 'string', - 'example' => '3', - ], - 'Name' => [ - 'title' => '实验名称。', - 'description' => '', - 'type' => 'string', - 'example' => 'experiment_test1', - ], - 'Description' => [ - 'title' => '实验描述。', - 'description' => '', - 'type' => 'string', - 'example' => 'This is a test.', - ], - 'Type' => [ - 'title' => '实验类型。'."\n" - .'● Baseline-基准实验。'."\n" - .'● Normal-普通实验。', - 'description' => '', - 'type' => 'string', - 'example' => 'Baseline', - ], - 'FlowPercent' => [ - 'title' => '流量分配百分比。', - 'description' => '', - 'type' => 'integer', - 'format' => 'int32', - 'example' => '100', - 'default' => '100', - ], - 'Buckets' => [ - 'title' => '分配桶号。', - 'description' => '', - 'type' => 'string', - 'example' => '1,2,3', - ], - 'DebugUsers' => [ - 'title' => '调试用户。', - 'description' => '', - 'type' => 'string', - 'example' => 'uid1,uid2,uid3', - ], - 'DebugCrowdId' => [ - 'title' => '调试人群ID。', - 'description' => '', - 'type' => 'string', - 'example' => '3', - ], - 'Config' => [ - 'title' => '实验配置。', - 'description' => '', - 'type' => 'string', - 'example' => '{}', - ], - 'Status' => [ - 'title' => '状态过滤。'."\n" - .'● Offline-未上线'."\n" - .'● Online-已上线', - 'description' => '', - 'type' => 'string', - 'example' => 'Offline', - ], - 'GmtCreateTime' => [ - 'title' => '创建时间。', - 'description' => '', - 'type' => 'string', - 'example' => '2021-12-15T23:24:33.132+08:00', - ], - 'GmtModifiedTime' => [ - 'title' => '更新时间。', - 'description' => '', - 'type' => 'string', - 'example' => '2021-12-15T23:24:33.132+08:00', - ], + 'ABMetricId' => ['description' => 'The AB metric ID.', 'type' => 'string', 'example' => '1', 'title' => ''], + 'Name' => ['description' => 'The metric name.', 'type' => 'string', 'example' => 'pv', 'title' => ''], + 'Description' => ['description' => 'The metric description.', 'type' => 'string', 'example' => 'pv指标', 'title' => ''], + 'SceneId' => ['description' => 'The scene ID.', 'type' => 'string', 'example' => '1', 'title' => ''], + 'SceneName' => ['description' => 'The scene name.', 'type' => 'string', 'example' => 'home_feed', 'title' => ''], + 'Type' => ['description' => 'The metric type. Valid values:'."\n" + ."\n" + .'- `Single`: a single metric.'."\n" + ."\n" + .'- `Derived`: a derived metric.', 'type' => 'string', 'example' => 'Single', 'title' => ''], + 'Realtime' => ['description' => 'Indicates whether the metric is a real-time metric.'."\n" + ."\n" + .'- `true`: The metric is calculated in real time.'."\n" + ."\n" + .'- `false`: The metric is not calculated in real time.', 'type' => 'string', 'example' => 'false', 'title' => ''], + 'TableMetaId' => ['description' => 'The data table ID.', 'type' => 'string', 'example' => '1', 'title' => ''], + 'ResultTableMetaId' => ['description' => 'The ID of the data table to which the results are written.', 'type' => 'string', 'example' => '2', 'title' => ''], + 'ResultResourceId' => ['description' => 'The ID of the data source for the data table to which the results are written.', 'type' => 'string', 'example' => '3', 'title' => ''], + 'Definition' => ['description' => 'The metric definition.', 'type' => 'string', 'example' => 'sum(click_cnt)', 'title' => ''], + 'StatisticsCycle' => ['description' => 'The statistical period.', 'type' => 'integer', 'format' => 'int32', 'example' => '1', 'title' => ''], + 'LeftMetricId' => ['description' => 'The ID of the left-hand metric in the formula for the derived metric.', 'type' => 'string', 'example' => '3', 'title' => ''], + 'RightMetricId' => ['description' => 'The ID of the right-hand metric in the formula for the derived metric.', 'type' => 'string', 'example' => '2', 'title' => ''], + 'Operator' => ['description' => 'The operator used to calculate the derived metric. Valid values:'."\n" + ."\n" + .'- `Plus`: addition'."\n" + ."\n" + .'- `Minus`: subtraction'."\n" + ."\n" + .'- `Multiplication`: multiplication'."\n" + ."\n" + .'- `Division`: division', 'type' => 'string', 'example' => 'Division', 'title' => ''], + 'NeedSignificance' => ['description' => 'Indicates whether significance calculation is required.', 'type' => 'boolean', 'title' => '', 'example' => ''], + 'AggregationByUser' => ['description' => 'Indicates whether to aggregate data by user.', 'type' => 'boolean', 'title' => '', 'example' => ''], + 'Numerator' => ['description' => 'The numerator of the derived metric.', 'type' => 'string', 'example' => 'click', 'title' => ''], + 'Denominator' => ['description' => 'The denominator of the derived metric.', 'type' => 'string', 'example' => 'pv', 'title' => ''], + 'IsBinomialDistribution' => ['description' => 'Indicates whether the metric follows a binomial distribution.', 'type' => 'boolean', 'title' => '', 'example' => ''], ], + 'title' => '', + 'example' => '', ], + 'title' => '', + 'example' => '', ], ], + 'example' => '', ], ], ], - 'staticInfo' => [ - 'returnType' => 'synchronous', - ], - 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"68075085-1A7D-55C2-B51D-7AD9B02A6DD6\\",\\n \\"TotalCount\\": 10,\\n \\"Experiments\\": [\\n {\\n \\"ExperimentId\\": \\"3\\",\\n \\"AliasExperimentId\\": \\"L1#EG1#E1\\",\\n \\"ExperimentGroupId\\": \\"3\\",\\n \\"LayerId\\": \\"3\\",\\n \\"LaboratoryId\\": \\"3\\",\\n \\"SceneId\\": \\"3\\",\\n \\"Name\\": \\"experiment_test1\\",\\n \\"Description\\": \\"This is a test.\\",\\n \\"Type\\": \\"Baseline\\",\\n \\"FlowPercent\\": 100,\\n \\"Buckets\\": \\"1,2,3\\",\\n \\"DebugUsers\\": \\"uid1,uid2,uid3\\",\\n \\"DebugCrowdId\\": \\"3\\",\\n \\"Config\\": \\"{}\\",\\n \\"Status\\": \\"Offline\\",\\n \\"GmtCreateTime\\": \\"2021-12-15T23:24:33.132+08:00\\",\\n \\"GmtModifiedTime\\": \\"2021-12-15T23:24:33.132+08:00\\"\\n }\\n ]\\n}","type":"json"}]', - ], - 'CloneExperiment' => [ - 'summary' => '克隆实验。', - 'path' => '/api/v1/experiments/{ExperimentId}/action/clone', - 'methods' => [ - 'post', + 'staticInfo' => ['returnType' => 'synchronous'], + 'title' => 'Obtain the AB Metrics List', + 'summary' => 'Lists A/B testing metrics.', + 'changeSet' => [], + 'flowControl' => [ + 'flowControlList' => [], ], - 'schemes' => [ - 'http', - 'https', + 'ramActions' => [ + [ + 'operationType' => 'list', + 'ramAction' => [ + 'action' => 'pairec:ListABMetrics', + 'authLevel' => 'operate', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'PAIRecService', 'resourceType' => 'All Resource', 'arn' => '*'], + ], + ], + ], ], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"F7AC05FF-EDE7-5C2B-B9AE-33D6DF4178BA\\",\\n \\"TotalCount\\": 10,\\n \\"ABMetrics\\": [\\n {\\n \\"ABMetricId\\": \\"1\\",\\n \\"Name\\": \\"pv\\",\\n \\"Description\\": \\"pv指标\\",\\n \\"SceneId\\": \\"1\\",\\n \\"SceneName\\": \\"home_feed\\",\\n \\"Type\\": \\"Single\\",\\n \\"Realtime\\": \\"false\\",\\n \\"TableMetaId\\": \\"1\\",\\n \\"ResultTableMetaId\\": \\"2\\",\\n \\"ResultResourceId\\": \\"3\\",\\n \\"Definition\\": \\"sum(click_cnt)\\",\\n \\"StatisticsCycle\\": 1,\\n \\"LeftMetricId\\": \\"3\\",\\n \\"RightMetricId\\": \\"2\\",\\n \\"Operator\\": \\"Division\\",\\n \\"NeedSignificance\\": false,\\n \\"AggregationByUser\\": false,\\n \\"Numerator\\": \\"click\\",\\n \\"Denominator\\": \\"pv\\",\\n \\"IsBinomialDistribution\\": false\\n }\\n ]\\n}","type":"json"}]', + ], + 'ListCalculationJobs' => [ + 'summary' => 'Lists calculation jobs.', + 'path' => '/api/v1/calculationjobs', + 'methods' => ['get'], + 'schemes' => ['http', 'https'], 'security' => [ [ 'AK' => [], ], ], - 'consumes' => [ - 'application/json', - ], - 'produces' => [ - 'application/json', - ], - 'operationType' => 'readAndWrite', + 'consumes' => ['application/json'], + 'produces' => ['application/json'], + 'operationType' => 'read', 'deprecated' => false, 'systemTags' => [ - 'operationType' => 'none', + 'operationType' => 'list', 'riskType' => 'none', 'chargeType' => 'free', - 'abilityTreeNodes' => [ - 'FEATURElearnN0NAWV', - ], + 'abilityTreeNodes' => ['FEATURElearnN0NAWV'], ], 'parameters' => [ [ - 'name' => 'ExperimentId', - 'in' => 'path', - 'schema' => [ - 'title' => '实验ID。', - 'description' => '', - 'type' => 'string', - 'required' => true, - 'example' => '3', - ], + 'name' => 'PageNumber', + 'in' => 'query', + 'schema' => ['description' => 'The page number.', 'type' => 'integer', 'format' => 'int32', 'required' => false, 'example' => '1', 'title' => ''], ], [ - 'name' => 'body', - 'in' => 'body', - 'style' => 'json', - 'schema' => [ - 'description' => '', - 'type' => 'object', - 'properties' => [ - 'InstanceId' => [ - 'title' => '实例ID。', - 'description' => '', - 'type' => 'string', - 'required' => true, - 'example' => 'pairec-cn-abcdefg1234'."\n", - ], - ], - 'required' => false, - ], + 'name' => 'PageSize', + 'in' => 'query', + 'schema' => ['description' => 'The page size.', 'type' => 'integer', 'format' => 'int32', 'required' => false, 'example' => '10', 'title' => ''], + ], + [ + 'name' => 'InstanceId', + 'in' => 'query', + 'schema' => ['description' => 'The instance ID. To obtain this ID, call the [ListInstances](~~2411819~~) operation.', 'type' => 'string', 'required' => true, 'example' => 'pairec-cn-test1', 'title' => ''], + ], + [ + 'name' => 'SceneId', + 'in' => 'query', + 'schema' => ['description' => 'The scene ID. To obtain this ID, call the [ListScenes](~~2402581~~) operation.', 'type' => 'string', 'required' => true, 'example' => '1', 'title' => ''], + ], + [ + 'name' => 'Status', + 'in' => 'query', + 'schema' => ['description' => 'The status of the calculation job. Valid values:'."\n" + ."\n" + .'- Success'."\n" + ."\n" + .'- Failure'."\n" + ."\n" + .'- Initializing'."\n" + ."\n" + .'- Running', 'type' => 'string', 'required' => false, 'example' => 'Success', 'title' => ''], ], ], 'responses' => [ 200 => [ 'schema' => [ 'title' => 'Schema of Response', - 'description' => 'Schema of Response', + 'description' => 'The data returned.', 'type' => 'object', 'properties' => [ - 'RequestId' => [ - 'title' => 'Id of the request', - 'description' => 'Id of the request', - 'type' => 'string', - 'example' => 'F8F613A9-DF1C-551A-88E1-397A3981A785', - ], - 'ExperimentId' => [ - 'description' => '', - 'type' => 'string', - 'example' => '3', + 'RequestId' => ['title' => 'Id of the request', 'description' => 'The request ID.', 'type' => 'string', 'example' => 'F7AC05FF-EDE7-5C2B-B9AE-33D6DF4178BA'], + 'TotalCount' => ['description' => 'The total number of entries.', 'type' => 'integer', 'format' => 'int64', 'example' => '10', 'title' => ''], + 'CalculationJobs' => [ + 'description' => 'A list of calculation jobs.', + 'type' => 'array', + 'items' => [ + 'description' => 'Details of a calculation job.', + 'type' => 'object', + 'properties' => [ + 'CalculationJobId' => ['description' => 'The calculation job ID.', 'type' => 'string', 'example' => '2', 'title' => ''], + 'ABMetricName' => ['description' => 'The name of the A/B metric.', 'type' => 'string', 'example' => 'pv', 'title' => ''], + 'Status' => ['description' => 'The status of the job. Valid values:'."\n" + ."\n" + .'- Success'."\n" + ."\n" + .'- Failure'."\n" + ."\n" + .'- Initializing'."\n" + ."\n" + .'- Running', 'type' => 'string', 'example' => 'Success', 'title' => ''], + 'JobMessage' => [ + 'description' => 'The job messages.', + 'type' => 'array', + 'items' => ['description' => 'A message about the job.', 'type' => 'string', 'example' => 'success', 'title' => ''], + 'title' => '', + 'example' => '', + ], + 'Config' => ['description' => 'The job configuration.', 'type' => 'string', 'example' => '{}', 'title' => ''], + 'GmtRanTime' => ['description' => 'The time when the job was run.', 'type' => 'string', 'example' => '2021-12-15T23:24:33.132+08:00', 'title' => ''], + 'BizDate' => ['description' => 'The business date.', 'type' => 'string', 'example' => '2021-12-15', 'title' => ''], + 'JobSource' => ['description' => 'The source of the job. Valid values:'."\n" + ."\n" + .'- CronOffline: The job is an offline scheduled task.'."\n" + ."\n" + .'- DataRerun: The job is a data rerun task.', 'type' => 'string', 'example' => 'CronOffline', 'title' => ''], + ], + 'title' => '', + 'example' => '', + ], + 'title' => '', + 'example' => '', ], ], + 'example' => '', ], ], ], - 'staticInfo' => [ - 'returnType' => 'synchronous', + 'staticInfo' => ['returnType' => 'synchronous'], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"F7AC05FF-EDE7-5C2B-B9AE-33D6DF4178BA\\",\\n \\"TotalCount\\": 10,\\n \\"CalculationJobs\\": [\\n {\\n \\"CalculationJobId\\": \\"2\\",\\n \\"ABMetricName\\": \\"pv\\",\\n \\"Status\\": \\"Success\\",\\n \\"JobMessage\\": [\\n \\"success\\"\\n ],\\n \\"Config\\": \\"{}\\",\\n \\"GmtRanTime\\": \\"2021-12-15T23:24:33.132+08:00\\",\\n \\"BizDate\\": \\"2021-12-15\\",\\n \\"JobSource\\": \\"CronOffline\\"\\n }\\n ]\\n}","type":"json"}]', + 'title' => 'Obtain the Script Task List', + 'changeSet' => [ + ['createdAt' => '2024-02-22T03:35:41.000Z', 'description' => 'Request parameters changed'], + ], + 'flowControl' => [ + 'flowControlList' => [], + ], + 'ramActions' => [ + [ + 'operationType' => 'list', + 'ramAction' => [ + 'action' => 'pairec:ListCalculationJobs', + 'authLevel' => 'operate', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'PAIRecService', 'resourceType' => 'All Resource', 'arn' => '*'], + ], + ], + ], ], - 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"F8F613A9-DF1C-551A-88E1-397A3981A785\\",\\n \\"ExperimentId\\": \\"3\\"\\n}","type":"json"}]', ], - 'OfflineExperiment' => [ - 'summary' => '上线实验。', - 'path' => '/api/v1/experiments/{ExperimentId}/action/offline', - 'methods' => [ - 'post', - ], - 'schemes' => [ - 'http', - 'https', - ], + 'ListCrowdUsers' => [ + 'path' => '/api/v1/crowds/{CrowdId}/users', + 'methods' => ['get'], + 'schemes' => ['http', 'https'], 'security' => [ [ 'AK' => [], ], ], - 'consumes' => [ - 'application/json', - ], - 'produces' => [ - 'application/json', - ], - 'operationType' => 'readAndWrite', + 'consumes' => ['application/json'], + 'produces' => ['application/json'], + 'operationType' => 'read', 'deprecated' => false, 'systemTags' => [ - 'operationType' => 'none', + 'operationType' => 'list', 'riskType' => 'none', 'chargeType' => 'free', - 'abilityTreeNodes' => [ - 'FEATURElearnN0NAWV', - ], + 'abilityTreeNodes' => ['FEATURElearnN0NAWV'], ], 'parameters' => [ [ - 'name' => 'ExperimentId', + 'name' => 'CrowdId', 'in' => 'path', - 'schema' => [ - 'title' => '实验ID。', - 'description' => '', - 'type' => 'string', - 'required' => true, - 'example' => '3', - ], + 'schema' => ['description' => 'The ID of the crowd. You can call the ListCrowds operation to obtain this ID.', 'type' => 'string', 'required' => true, 'example' => '1', 'title' => ''], ], [ - 'name' => 'body', - 'in' => 'body', - 'style' => 'json', + 'name' => 'InstanceId', + 'in' => 'query', + 'schema' => ['description' => 'The ID of the instance. You can call the ListInstances operation to obtain this ID.', 'type' => 'string', 'required' => true, 'example' => 'pairec-cn-abcdefg1234', 'title' => ''], + ], + ], + 'responses' => [ + 200 => [ 'schema' => [ - 'description' => '', + 'title' => 'Schema of Response', + 'description' => 'The response object.', 'type' => 'object', 'properties' => [ - 'InstanceId' => [ - 'title' => '实例ID。', - 'description' => '', - 'type' => 'string', - 'required' => true, - 'example' => 'pairec-cn-abcdefg1234', + 'RequestId' => ['title' => 'Id of the request', 'description' => 'The ID of the request.', 'type' => 'string', 'example' => 'F0AB6527-093F-5C44-B3BD-42C8C210C619'], + 'TotalCount' => ['description' => 'The total number of entries.', 'type' => 'integer', 'format' => 'int64', 'example' => '3', 'title' => ''], + 'Users' => [ + 'title' => '', + 'description' => 'The list of users.', + 'type' => 'array', + 'items' => ['description' => 'The user ID.', 'type' => 'string', 'example' => 'user1', 'title' => ''], + 'example' => '', ], ], - 'required' => false, + 'example' => '', ], ], ], + 'staticInfo' => ['returnType' => 'synchronous'], + 'title' => 'Retrieve User List Under an Audience', + 'summary' => 'Retrieves all users within a specified crowd, including those in its sub-crowds.', + 'changeSet' => [], + 'flowControl' => [ + 'flowControlList' => [], + ], + 'ramActions' => [ + [ + 'operationType' => 'list', + 'ramAction' => [ + 'action' => 'pairec:ListCrowdUsers', + 'authLevel' => 'operate', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'PAIRecService', 'resourceType' => 'All Resource', 'arn' => '*'], + ], + ], + ], + ], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"F0AB6527-093F-5C44-B3BD-42C8C210C619\\",\\n \\"TotalCount\\": 3,\\n \\"Users\\": [\\n \\"user1\\"\\n ]\\n}","type":"json"}]', + ], + 'ListCrowds' => [ + 'summary' => 'Lists the Crowds in a specified instance.', + 'path' => '/api/v1/crowds', + 'methods' => ['get'], + 'schemes' => ['http', 'https'], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'consumes' => ['application/json'], + 'produces' => ['application/json'], + 'operationType' => 'read', + 'deprecated' => false, + 'systemTags' => [ + 'operationType' => 'list', + 'riskType' => 'none', + 'chargeType' => 'free', + 'abilityTreeNodes' => ['FEATURElearnN0NAWV'], + ], + 'parameters' => [ + [ + 'name' => 'InstanceId', + 'in' => 'query', + 'schema' => ['description' => 'The ID of the instance. Call the `ListInstances` operation to obtain this ID.', 'type' => 'string', 'required' => true, 'example' => 'pairec-cn-abcdefg1234', 'title' => ''], + ], + ], 'responses' => [ 200 => [ 'schema' => [ 'title' => 'Schema of Response', - 'description' => 'Schema of Response', + 'description' => 'The response object.', 'type' => 'object', 'properties' => [ - 'RequestId' => [ - 'title' => 'Id of the request', - 'description' => 'Id of the request', - 'type' => 'string', - 'example' => '872951C9-7755-5FA1-AACD-7F9375A6D27A', + 'RequestId' => ['title' => 'Id of the request', 'description' => 'The request ID.', 'type' => 'string', 'example' => '9763624B-5FBB-5E3A-9193-B1ADB554CEAE'], + 'TotalCount' => ['description' => 'The total number of Crowds.', 'type' => 'integer', 'format' => 'int64', 'example' => '10', 'title' => ''], + 'Crowds' => [ + 'title' => '', + 'description' => 'The list of Crowds.', + 'type' => 'array', + 'items' => [ + 'type' => 'object', + 'properties' => [ + 'CrowdId' => ['description' => 'The Crowd ID.', 'type' => 'string', 'example' => '3', 'title' => ''], + 'Name' => ['description' => 'The Crowd name.', 'type' => 'string', 'example' => 'crowd1', 'title' => ''], + 'Description' => ['description' => 'The Crowd description.', 'type' => 'string', 'example' => 'This is a test.', 'title' => ''], + 'Label' => ['description' => 'The label of the Crowd.', 'type' => 'string', 'example' => 'os=android', 'title' => ''], + 'Source' => ['description' => 'The source of the Crowd. Valid values:'."\n" + ."\n" + .'- `ManualInput`: The Crowd is created from a manual entry of users.'."\n" + ."\n" + .'- `UploadFile`: The Crowd is created from an uploaded file.', 'type' => 'string', 'example' => 'ManualInput', 'title' => ''], + 'Quantity' => ['description' => 'The number of users in the Crowd.', 'type' => 'string', 'example' => '10', 'title' => ''], + 'Users' => ['description' => 'The user IDs in the Crowd, separated by commas.', 'type' => 'string', 'example' => 'user1,user2', 'title' => ''], + 'GmtCreateTime' => ['description' => 'The time when the Crowd was created.', 'type' => 'string', 'example' => '2021-12-15T23:24:33.132+08:00', 'title' => ''], + ], + 'description' => '', + 'title' => '', + 'example' => '', + ], + 'example' => '', ], ], + 'example' => '', ], ], ], - 'staticInfo' => [ - 'returnType' => 'synchronous', - ], - 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"872951C9-7755-5FA1-AACD-7F9375A6D27A\\"\\n}","type":"json"}]', - ], - 'PushAllExperiment' => [ - 'summary' => '推全。', - 'path' => '/api/v1/experiments/{ExperimentId}/action/pushall', - 'methods' => [ - 'post', + 'staticInfo' => ['returnType' => 'synchronous'], + 'title' => 'Obtain Audience List ', + 'changeSet' => [], + 'flowControl' => [ + 'flowControlList' => [], ], - 'schemes' => [ - 'http', - 'https', + 'ramActions' => [ + [ + 'operationType' => 'list', + 'ramAction' => [ + 'action' => 'pairec:ListCrowds', + 'authLevel' => 'operate', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'PAIRecService', 'resourceType' => 'All Resource', 'arn' => '*'], + ], + ], + ], ], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"9763624B-5FBB-5E3A-9193-B1ADB554CEAE\\",\\n \\"TotalCount\\": 10,\\n \\"Crowds\\": [\\n {\\n \\"CrowdId\\": \\"3\\",\\n \\"Name\\": \\"crowd1\\",\\n \\"Description\\": \\"This is a test.\\",\\n \\"Label\\": \\"os=android\\",\\n \\"Source\\": \\"ManualInput\\",\\n \\"Quantity\\": \\"10\\",\\n \\"Users\\": \\"user1,user2\\",\\n \\"GmtCreateTime\\": \\"2021-12-15T23:24:33.132+08:00\\"\\n }\\n ]\\n}","type":"json"}]', + ], + 'ListDataDiagnoses' => [ + 'path' => '/api/v1/datadiagnoses', + 'methods' => ['get'], + 'schemes' => ['http', 'https'], 'security' => [ [ 'AK' => [], ], ], - 'consumes' => [ - 'application/json', - ], - 'produces' => [ - 'application/json', - ], + 'consumes' => ['application/json'], + 'produces' => ['application/json'], 'operationType' => 'readAndWrite', 'deprecated' => false, 'systemTags' => [ - 'operationType' => 'none', + 'operationType' => 'get', 'riskType' => 'none', 'chargeType' => 'free', - 'abilityTreeNodes' => [ - 'FEATURElearnN0NAWV', - ], + 'abilityTreeNodes' => ['FEATURElearnN0NAWV'], ], 'parameters' => [ [ - 'name' => 'ExperimentId', - 'in' => 'path', - 'schema' => [ - 'title' => '实验ID。', - 'description' => '', - 'type' => 'string', - 'required' => true, - 'example' => '3', - ], - ], - [ - 'name' => 'body', - 'in' => 'body', - 'style' => 'json', + 'name' => 'Types', + 'in' => 'query', + 'style' => 'simple', 'schema' => [ - 'description' => '', - 'type' => 'object', - 'properties' => [ - 'InstanceId' => [ - 'title' => '实例ID。', - 'description' => '', - 'type' => 'string', - 'required' => false, - 'example' => 'pairec-cn-abcdefg1234', - ], + 'enumValueTitles' => [], + 'description' => 'A list of diagnosis types.', + 'type' => 'array', + 'items' => [ + 'description' => '- ChangeRate: Analyzes the change rate of items or users.'."\n" + ."\n" + .'- PreferenceStatisticsCycle: Analyzes the cycle of user preference statistics.'."\n" + ."\n" + .'- JoinTables: Performs join table analysis.'."\n" + ."\n" + .'- BaseStatistics: Performs basic statistical analysis.'."\n" + ."\n" + .'- AbnormalBehavior: Performs abnormal behavior analysis.', + 'enumValueTitles' => ['AbnormalBehavior' => 'AbnormalBehavior', 'JoinTables' => 'JoinTables', 'PreferenceStatisticsCycle' => 'PreferenceStatisticsCycle', 'BaseStatistics' => 'BaseStatistics', 'ChangeRate' => 'ChangeRate'], + 'type' => 'string', + 'required' => false, + 'example' => 'Diagnosis Type', + 'title' => '', ], 'required' => false, + 'title' => '', + 'example' => '', ], ], + [ + 'name' => 'PageNumber', + 'in' => 'query', + 'schema' => ['description' => 'The page number.', 'type' => 'integer', 'format' => 'int32', 'required' => false, 'example' => '1', 'title' => ''], + ], + [ + 'name' => 'PageSize', + 'in' => 'query', + 'schema' => ['description' => 'The page size.', 'type' => 'integer', 'format' => 'int32', 'required' => false, 'example' => '10', 'title' => ''], + ], + [ + 'name' => 'InstanceId', + 'in' => 'query', + 'schema' => ['description' => 'The instance ID.', 'type' => 'string', 'required' => true, 'example' => 'pairec-test1', 'title' => ''], + ], ], 'responses' => [ 200 => [ 'schema' => [ + 'description' => 'The data returned.', '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' => '74D958EF-3598-56FA-8296-FF1575CE43DF', + 'RequestId' => ['title' => 'Id of the request', 'description' => 'The request ID.', 'type' => 'string', 'example' => '728C5E01-ABF6-5AA8-B9FC-B3BA05DECC77'], + 'TotalCount' => ['description' => 'The total number of entries returned.', 'type' => 'integer', 'format' => 'int64', 'example' => '20', 'title' => ''], + 'DataDiagnoses' => [ + 'description' => 'The list of data diagnoses.', + 'type' => 'array', + 'items' => [ + 'description' => 'The details of a data diagnosis.', + 'type' => 'object', + 'properties' => [ + 'DataDiagnosisId' => ['description' => 'The data diagnosis ID.', 'type' => 'string', 'example' => '3', 'title' => ''], + 'Name' => ['description' => 'The name of the data diagnosis.', 'type' => 'string', 'example' => 'data_diagnosis_job1', 'title' => ''], + 'Type' => ['description' => 'The type of data diagnosis. Valid values:'."\n" + ."\n" + .'- `ChangeRate`: Change Rate Analysis.'."\n" + ."\n" + .'- `PreferenceStatisticsCycle`: Preference Statistics Cycle Analysis.'."\n" + ."\n" + .'- `JoinTables`: Join Tables Analysis.'."\n" + ."\n" + .'- `BaseStatistics`: Base Statistics Analysis.'."\n" + ."\n" + .'- `AbnormalBehavior`: Abnormal Behavior Analysis.', 'type' => 'string', 'example' => 'ChangeRate', 'title' => ''], + 'TableMetaId' => ['description' => 'The data table ID.', 'type' => 'string', 'example' => '3', 'title' => ''], + 'TableMetaName' => ['description' => 'The name of the data table.', 'type' => 'string', 'example' => 'table_meta_1', 'title' => ''], + 'LeftTableMetaId' => ['description' => 'The ID of the left data table.', 'type' => 'string', 'example' => '4', 'title' => ''], + 'RightTableMetaId' => ['description' => 'The ID of the right data table.', 'type' => 'string', 'example' => '5', 'title' => ''], + 'PartitionField' => ['description' => 'The partition field.', 'type' => 'string', 'example' => 'dt', 'title' => ''], + 'LeftTablePartitionField' => ['description' => 'The partition field of the left table.', 'type' => 'string', 'example' => 'dt', 'title' => ''], + 'RightTablePartitionField' => ['description' => 'The partition field of the right table.', 'type' => 'string', 'example' => 'dt', 'title' => ''], + 'Config' => ['description' => 'The configuration for the data diagnosis task, in JSON format. The required fields depend on the `Type` value:<br>', 'type' => 'string', 'example' => '{"AnalysisField": "userid","PartitionFieldFormat": "yyyymmdd"}', 'title' => ''], + 'CycleTime' => ['description' => 'The time at which the task is scheduled to run periodically. If this parameter is empty, the task runs only once.', 'type' => 'string', 'example' => '08:00', 'title' => ''], + 'TopNQuantity' => ['description' => 'The number of top results to return.', 'type' => 'integer', 'format' => 'int64', 'example' => '10', 'title' => ''], + 'GmtCreateTime' => ['description' => 'The time when the task was created.', 'type' => 'string', 'example' => '2021-12-15T23:24:33.132+08:00', 'title' => ''], + 'GmtModifiedTime' => ['description' => 'The time when the task was last updated.', 'type' => 'string', 'example' => '2021-12-15T23:24:33.132+08:00', 'title' => ''], + ], + 'title' => '', + 'example' => '', + ], + 'title' => '', + 'example' => '', ], ], + 'example' => '', ], ], ], - 'staticInfo' => [ - 'returnType' => 'synchronous', + 'staticInfo' => ['returnType' => 'synchronous'], + 'title' => 'Obtain the data diagnosis list', + 'summary' => 'Lists the data diagnostic tasks for the specified instance.', + 'description' => '## Request'."\n" + ."\n" + .'This API retrieves a list of data diagnosis tasks. It requires the `InstanceId` parameter and accepts optional parameters—such as data diagnosis type, page number, and page size—for filtering and pagination.'."\n" + ."\n" + .'- The **Types** parameter accepts multiple data diagnosis types, allowing you to view reports for all selected types at once.'."\n" + ."\n" + .'- To paginate results, use the `PageNumber` and `PageSize` parameters.', + 'changeSet' => [], + 'flowControl' => [ + 'flowControlList' => [], + ], + 'ramActions' => [ + [ + 'operationType' => 'get', + 'ramAction' => [ + 'action' => 'pairec:ListDataDiagnoses', + 'authLevel' => 'operate', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'PAIRecService', 'resourceType' => 'All Resource', 'arn' => '*'], + ], + ], + ], ], - 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"74D958EF-3598-56FA-8296-FF1575CE43DF\\"\\n}","type":"json"}]', + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"728C5E01-ABF6-5AA8-B9FC-B3BA05DECC77\\",\\n \\"TotalCount\\": 20,\\n \\"DataDiagnoses\\": [\\n {\\n \\"DataDiagnosisId\\": \\"3\\",\\n \\"Name\\": \\"data_diagnosis_job1\\",\\n \\"Type\\": \\"ChangeRate\\",\\n \\"TableMetaId\\": \\"3\\",\\n \\"TableMetaName\\": \\"table_meta_1\\",\\n \\"LeftTableMetaId\\": \\"4\\",\\n \\"RightTableMetaId\\": \\"5\\",\\n \\"PartitionField\\": \\"dt\\",\\n \\"LeftTablePartitionField\\": \\"dt\\",\\n \\"RightTablePartitionField\\": \\"dt\\",\\n \\"Config\\": \\"{\\\\\\"AnalysisField\\\\\\": \\\\\\"userid\\\\\\",\\\\\\"PartitionFieldFormat\\\\\\": \\\\\\"yyyymmdd\\\\\\"}\\",\\n \\"CycleTime\\": \\"08:00\\",\\n \\"TopNQuantity\\": 10,\\n \\"GmtCreateTime\\": \\"2021-12-15T23:24:33.132+08:00\\",\\n \\"GmtModifiedTime\\": \\"2021-12-15T23:24:33.132+08:00\\"\\n }\\n ]\\n}","type":"json"}]', ], - 'OnlineExperiment' => [ - 'summary' => '上线实验', - 'path' => '/api/v1/experiments/{ExperimentId}/action/online', - 'methods' => [ - 'post', - ], - 'schemes' => [ - 'http', - 'https', - ], + 'ListDataDiagnosisJobs' => [ + 'summary' => 'Queries data diagnosis jobs for a specified instance.', + 'path' => '/api/v1/datadiagnosisjobs', + 'methods' => ['get'], + 'schemes' => ['http', 'https'], 'security' => [ [ 'AK' => [], ], ], - 'consumes' => [ - 'application/json', - ], - 'produces' => [ - 'application/json', - ], + 'consumes' => ['application/json'], + 'produces' => ['application/json'], 'operationType' => 'readAndWrite', 'deprecated' => false, 'systemTags' => [ - 'operationType' => 'none', + 'operationType' => 'get', 'riskType' => 'none', 'chargeType' => 'free', - 'abilityTreeNodes' => [ - 'FEATURElearnN0NAWV', - ], + 'abilityTreeNodes' => ['FEATURElearnN0NAWV'], ], 'parameters' => [ [ - 'name' => 'ExperimentId', - 'in' => 'path', - 'schema' => [ - 'title' => '实验ID。', - 'description' => '', - 'type' => 'string', - 'required' => true, - 'example' => '3', - ], + 'name' => 'InstanceId', + 'in' => 'query', + 'schema' => ['description' => 'The instance ID.', 'type' => 'string', 'required' => true, 'example' => 'pairec-test1', 'title' => ''], ], [ - 'name' => 'body', - 'in' => 'body', - 'style' => 'json', + 'name' => 'Status', + 'in' => 'query', + 'schema' => ['description' => 'The task status. Valid values:'."\n" + ."\n" + .'- Initializing: The job is being initialized.'."\n" + ."\n" + .'- Running: The job is in progress.'."\n" + ."\n" + .'- Success: The job succeeded.'."\n" + ."\n" + .'- Failure: The job failed to complete.', 'type' => 'string', 'required' => false, 'example' => 'Initializing', 'title' => ''], + ], + [ + 'name' => 'PageNumber', + 'in' => 'query', + 'schema' => ['description' => 'The page number.', 'type' => 'string', 'required' => false, 'example' => '1', 'title' => ''], + ], + [ + 'name' => 'PageSize', + 'in' => 'query', + 'schema' => ['description' => 'The page size.', 'type' => 'string', 'required' => false, 'example' => '10', 'title' => ''], + ], + [ + 'name' => 'Types', + 'in' => 'query', + 'style' => 'simple', 'schema' => [ - 'description' => '', - 'type' => 'object', - 'properties' => [ - 'InstanceId' => [ - 'title' => '实例ID。', - 'description' => '', - 'type' => 'string', - 'required' => false, - 'example' => 'pairec-cn-abcdefg1234', - ], - ], + 'description' => 'A list of data diagnosis types.', + 'type' => 'array', + 'items' => ['description' => '- ChangeRate: Item/user change rate analysis.'."\n" + ."\n" + .'- PreferenceStatisticsCycle: User preference statistics cycle analysis.'."\n" + ."\n" + .'- JoinTables: Two-table join analysis.'."\n" + ."\n" + .'- BaseStatistics: Basic statistics analysis.'."\n" + ."\n" + .'- AbnormalBehavior: Abnormal behavior analysis.', 'type' => 'string', 'required' => false, 'example' => 'ChangeRate', 'title' => ''], 'required' => false, + 'title' => '', + 'example' => '', ], ], ], 'responses' => [ 200 => [ 'schema' => [ + 'description' => 'The response object.', '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' => '6CF1E160-3F36-5E73-A170-C75504F05BBC', + 'RequestId' => ['title' => 'Id of the request', 'description' => 'The request ID.', 'type' => 'string', 'example' => '728C5E01-ABF6-5AA8-B9FC-B3BA05DECC77'], + 'TotalCount' => ['description' => 'The total number of entries.', 'type' => 'integer', 'format' => 'int64', 'example' => '20', 'title' => ''], + 'DataDiagnosisJobs' => [ + 'description' => 'The returned data diagnosis jobs.', + 'type' => 'array', + 'items' => [ + 'description' => 'Details of a data diagnosis job.', + 'type' => 'object', + 'properties' => [ + 'DataDiagnosisJobId' => ['description' => 'The data diagnosis job ID.', 'type' => 'string', 'example' => '3', 'title' => ''], + 'DataDiagnosisConfigId' => ['description' => 'The data diagnosis configuration ID.', 'type' => 'string', 'example' => '3', 'title' => ''], + 'DataDiagnosisConfigName' => ['description' => 'The data diagnosis configuration name.', 'type' => 'string', 'example' => '异常行为分析-xxx', 'title' => ''], + 'Type' => ['description' => 'The data diagnosis type.', 'type' => 'string', 'example' => 'ChangeRate', 'title' => ''], + 'Status' => ['description' => 'The task status.', 'type' => 'string', 'example' => 'Initializing', 'title' => ''], + 'JobSource' => ['description' => 'The job source. Valid values:'."\n" + ."\n" + .'- Rerun: A manual rerun.'."\n" + ."\n" + .'- Cycle: A periodic run.'."\n" + ."\n" + .'- ByInitializing: Generated during initialization.', 'type' => 'string', 'example' => 'Cycle', 'title' => ''], + 'Logs' => [ + 'description' => 'The log messages.', + 'type' => 'array', + 'items' => ['description' => 'A log message.', 'type' => 'string', 'example' => '""', 'title' => ''], + 'title' => '', + 'example' => '', + ], + 'BizDate' => ['description' => 'The business date.', 'type' => 'string', 'example' => '2023-05-28', 'title' => ''], + 'Config' => ['description' => 'The job configuration.', 'type' => 'string', 'example' => '{}', 'title' => ''], + 'GmtCreateTime' => ['description' => 'The time when the job was created.', 'type' => 'string', 'example' => '2021-12-15T23:24:33.132+08:00', 'title' => ''], + 'GmtStartTime' => ['description' => 'The time when the job started.', 'type' => 'string', 'example' => '2021-12-15T23:24:33.132+08:00', 'title' => ''], + ], + 'title' => '', + 'example' => '', + ], + 'title' => '', + 'example' => '', ], ], + 'example' => '', ], ], ], - 'staticInfo' => [ - 'returnType' => 'synchronous', + 'staticInfo' => ['returnType' => 'synchronous'], + 'title' => 'Retrieve the list of data diagnosis jobs', + 'description' => '## Description'."\n" + ."\n" + .'This API retrieves data diagnosis jobs for a specific instance. You can filter the jobs by parameters such as `InstanceId` and `Status`, and use the `PageNumber` and `PageSize` parameters to control pagination.'."\n" + ."\n" + .'- The **InstanceId** parameter is required and specifies the instance to query.'."\n" + ."\n" + .'- Optional parameters include **Status**, **Types**, **PageNumber**, and **PageSize**.'."\n" + ."\n" + .'- Note: If you omit filter conditions, the operation returns all matching data diagnosis jobs.', + 'changeSet' => [], + 'flowControl' => [ + 'flowControlList' => [], + ], + 'ramActions' => [ + [ + 'operationType' => 'get', + 'ramAction' => [ + 'action' => 'pairec:ListDataDiagnosisJobs', + 'authLevel' => 'operate', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'PAIRecService', 'resourceType' => 'All Resource', 'arn' => '*'], + ], + ], + ], ], - 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"6CF1E160-3F36-5E73-A170-C75504F05BBC\\"\\n}","type":"json"}]', + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"728C5E01-ABF6-5AA8-B9FC-B3BA05DECC77\\",\\n \\"TotalCount\\": 20,\\n \\"DataDiagnosisJobs\\": [\\n {\\n \\"DataDiagnosisJobId\\": \\"3\\",\\n \\"DataDiagnosisConfigId\\": \\"3\\",\\n \\"DataDiagnosisConfigName\\": \\"异常行为分析-xxx\\",\\n \\"Type\\": \\"ChangeRate\\",\\n \\"Status\\": \\"Initializing\\",\\n \\"JobSource\\": \\"Cycle\\",\\n \\"Logs\\": [\\n \\"\\\\\\"\\\\\\"\\"\\n ],\\n \\"BizDate\\": \\"2023-05-28\\",\\n \\"Config\\": \\"{}\\",\\n \\"GmtCreateTime\\": \\"2021-12-15T23:24:33.132+08:00\\",\\n \\"GmtStartTime\\": \\"2021-12-15T23:24:33.132+08:00\\"\\n }\\n ]\\n}","type":"json"}]', ], - 'CreateParam' => [ - 'summary' => '创建参数。', - 'path' => '/api/v1/params', - 'methods' => [ - 'post', - ], - 'schemes' => [ - 'http', - 'https', - ], + 'ListDataDiagnosisReports' => [ + 'path' => '/api/v1/datadiagnoses/{DataDiagnosisId}/reports', + 'methods' => ['get'], + 'schemes' => ['http', 'https'], 'security' => [ [ 'AK' => [], ], ], - 'consumes' => [ - 'application/json', - ], - 'produces' => [ - 'application/json', - ], - 'operationType' => 'write', + 'consumes' => ['application/json'], + 'produces' => ['application/json'], + 'operationType' => 'readAndWrite', 'deprecated' => false, 'systemTags' => [ - 'operationType' => 'create', + 'operationType' => 'get', 'riskType' => 'none', 'chargeType' => 'free', - 'abilityTreeNodes' => [ - 'FEATURElearnN0NAWV', - ], + 'abilityTreeNodes' => ['FEATURElearnN0NAWV'], ], 'parameters' => [ [ - 'name' => 'body', - 'in' => 'body', - 'style' => 'json', + 'name' => 'DataDiagnosisId', + 'in' => 'path', + 'schema' => ['description' => 'The data diagnosis ID.', 'type' => 'string', 'required' => true, 'example' => '3', 'title' => ''], + ], + [ + 'name' => 'InstanceId', + 'in' => 'query', + 'schema' => ['description' => 'The instance ID.', 'type' => 'string', 'required' => true, 'example' => 'pairec-test1', 'title' => ''], + ], + [ + 'name' => 'StartDate', + 'in' => 'query', + 'schema' => ['description' => 'The start date.', 'type' => 'string', 'required' => true, 'example' => '2022-01-01', 'title' => ''], + ], + [ + 'name' => 'EndDate', + 'in' => 'query', + 'schema' => ['description' => 'The end date.', 'type' => 'string', 'required' => true, 'example' => '2022-02-01', 'title' => ''], + ], + [ + 'name' => 'FeatureName', + 'in' => 'query', + 'schema' => ['description' => 'The feature name.', 'type' => 'string', 'required' => false, 'example' => 'feature1', 'title' => ''], + ], + [ + 'name' => 'TopN', + 'in' => 'query', + 'schema' => ['description' => 'The number of top results to return.', 'type' => 'integer', 'format' => 'int64', 'required' => false, 'example' => '3', 'title' => ''], + ], + [ + 'name' => 'RemainRateType', + 'in' => 'query', + 'schema' => ['description' => 'The retention rate report type.'."\n" + ."\n" + .'- Period: A report for the specified time period.', 'type' => 'string', 'required' => false, 'example' => 'Period', 'title' => ''], + ], + ], + 'responses' => [ + 200 => [ 'schema' => [ - 'description' => '', + 'description' => 'Schema of Response', + 'title' => 'Schema of Response ', 'type' => 'object', 'properties' => [ - 'SceneId' => [ - 'title' => '场景ID。', - 'description' => '', - 'type' => 'string', - 'required' => false, - 'example' => '4', + 'RequestId' => ['title' => 'Id of the request', 'description' => 'The request ID.', 'type' => 'string', 'example' => '728C5E01-ABF6-5AA8-B9FC-B3BA05DECC77'], + 'Type' => ['description' => 'The data diagnosis task type. Valid values:'."\n" + ."\n" + .'- `ChangeRate`: item/user change rate analysis.'."\n" + ."\n" + .'- `PreferenceStatisticsCycle`: user preference statistics cycle analysis.'."\n" + ."\n" + .'- `JoinTables`: table join analysis.'."\n" + ."\n" + .'- `BaseStatistics`: basic statistical analysis.'."\n" + ."\n" + .'- `AbnormalBehavior`: abnormal behavior analysis.', 'type' => 'string', 'example' => 'ChangeRate', 'title' => ''], + 'ReportsOfChangeRateData' => [ + 'description' => 'Reports for the item/user change rate analysis task.', + 'type' => 'array', + 'items' => [ + 'description' => 'The data list.', + 'type' => 'array', + 'items' => [ + 'description' => 'Details of a single data entry.', + 'type' => 'object', + 'properties' => [ + 'Ds' => ['description' => 'The date.', 'type' => 'string', 'example' => '20230509', 'title' => ''], + 'Flag' => ['description' => 'A flag that indicates the type of change.', 'type' => 'string', 'example' => 'add', 'title' => ''], + 'ChangeCount' => ['description' => 'The item/user change count.', 'type' => 'string', 'example' => '1231', 'title' => ''], + 'ChangeRate' => ['description' => 'The item/user change rate.', 'type' => 'string', 'example' => '0.1231', 'title' => ''], + ], + 'title' => '', + 'example' => '', + ], + 'title' => '', + 'example' => '', + ], + 'title' => '', + 'example' => '', ], - 'Name' => [ - 'title' => '参数名称。', - 'description' => '', - 'type' => 'string', - 'required' => false, - 'example' => 'home', + 'ReportsOfPreferenceStatisticsCycle' => [ + 'description' => 'Reports for the user preference statistics cycle analysis task.', + 'type' => 'array', + 'items' => [ + 'description' => 'The data list.', + 'type' => 'array', + 'items' => [ + 'description' => 'Details of a single data entry.', + 'type' => 'object', + 'properties' => [ + 'CycleRemainRate' => ['description' => 'The periodic user retention rate.', 'type' => 'string', 'example' => '0.73', 'title' => ''], + 'SingleRemainRate' => ['description' => 'The daily user retention rate.', 'type' => 'string', 'example' => '0.52', 'title' => ''], + 'Ds' => ['description' => 'The date.', 'type' => 'string', 'example' => '20230509', 'title' => ''], + 'Days' => ['description' => 'The value of k for the k-day retention rate or k-day ever-appeared rate.', 'type' => 'string', 'example' => '7', 'title' => ''], + 'EverAppearedRate' => ['description' => 'The k-day ever-appeared rate.', 'type' => 'string', 'example' => '0.67', 'title' => ''], + 'Period' => ['description' => 'The statistical period.', 'type' => 'string', 'example' => 'week', 'title' => ''], + 'PeriodRemainRate' => ['description' => 'The periodic retention rate.', 'type' => 'string', 'example' => '0.33', 'title' => ''], + 'PeriodRemainCount' => ['description' => 'The periodic retention count.', 'type' => 'integer', 'format' => 'int64', 'example' => '1', 'title' => ''], + 'PeriodInternal' => ['description' => 'The number of period intervals.', 'type' => 'integer', 'format' => 'int64', 'example' => '1', 'title' => ''], + ], + 'title' => '', + 'example' => '', + ], + 'title' => '', + 'example' => '', + ], + 'title' => '', + 'example' => '', ], - 'Value' => [ - 'title' => '参数值。', - 'description' => '', - 'type' => 'string', - 'required' => false, - 'example' => 'house', + 'ReportsOfJoinTables' => [ + 'description' => 'Reports for the table join analysis task.', + 'type' => 'array', + 'items' => [ + 'description' => 'The data list.', + 'type' => 'array', + 'items' => [ + 'description' => 'Details of a single data entry.', + 'type' => 'object', + 'properties' => [ + 'Ds' => ['description' => 'The date.', 'type' => 'string', 'example' => '20230509', 'title' => ''], + 'JoinField' => ['description' => 'The join field.', 'type' => 'string', 'example' => 'user_id', 'title' => ''], + 'LeftExceptRate' => ['description' => 'The left table join exception rate.', 'type' => 'string', 'example' => '0.53', 'title' => ''], + 'RightExceptRate' => ['description' => 'The right table join exception rate.', 'type' => 'string', 'example' => '0.0', 'title' => ''], + 'Flag' => ['description' => 'A flag that indicates the type of change.', 'type' => 'string', 'example' => 'add', 'title' => ''], + 'FeatureName' => ['description' => 'The feature name.', 'type' => 'string', 'example' => 'register_time', 'title' => ''], + 'FeatureValue' => ['description' => 'The feature value.', 'type' => 'string', 'example' => '1683562246', 'title' => ''], + 'Percent' => ['description' => 'The feature percentage.', 'type' => 'string', 'example' => '1', 'title' => ''], + 'Quantile' => ['description' => 'The quantile.', 'type' => 'string', 'example' => '1', 'title' => ''], + 'ValueCount' => ['description' => 'The value count.', 'type' => 'string', 'example' => '1', 'title' => ''], + 'ValuePercent' => ['description' => 'The value percentage.', 'type' => 'string', 'example' => '0.019996000799', 'title' => ''], + 'ValueQuantile' => ['description' => 'The value quantile.', 'type' => 'string', 'example' => '0.72616', 'title' => ''], + ], + 'title' => '', + 'example' => '', + ], + 'title' => '', + 'example' => '', + ], + 'title' => '', + 'example' => '', ], - 'Environment' => [ - 'title' => '参数所属的环境。'."\n" - .'● Daily-日常环境'."\n" - .'● Pre-预发环境'."\n" - .'● Prod-生产环境', - 'description' => '', - 'type' => 'string', - 'required' => false, - 'example' => 'Daily', + 'ReportsOfBaseStatistics' => [ + 'description' => 'Reports for the basic statistical analysis task.', + 'type' => 'array', + 'items' => [ + 'description' => 'The data list.', + 'type' => 'array', + 'items' => [ + 'description' => 'Details of a single data entry.', + 'type' => 'object', + 'properties' => [ + 'DefaultNullCount' => ['description' => 'The equivalent null count. This refers to the count of specific characters, such as `\\N`, that are treated as null values.', 'type' => 'string', 'example' => '\\\\N', 'title' => ''], + 'DefaultNullRate' => ['description' => 'The equivalent null rate.', 'type' => 'string', 'example' => '\\\\N', 'title' => ''], + 'Ds' => ['description' => 'The date.', 'type' => 'string', 'example' => '20230509', 'title' => ''], + 'FeatureName' => ['description' => 'The feature name.', 'type' => 'string', 'example' => 'register_time', 'title' => ''], + 'FeatureType' => ['description' => 'The feature type.', 'type' => 'string', 'example' => 'string', 'title' => ''], + 'NullCount' => ['description' => 'The null count.', 'type' => 'string', 'example' => '55095', 'title' => ''], + 'NullRate' => ['description' => 'The null rate.', 'type' => 'string', 'example' => '0.5580879448141732', 'title' => ''], + 'TotalCount' => ['description' => 'The total number of entries.', 'type' => 'string', 'example' => '98721', 'title' => ''], + 'UniqueCount' => ['description' => 'The number of unique values.', 'type' => 'string', 'example' => '29', 'title' => ''], + 'ValueMax' => ['description' => 'The maximum value.', 'type' => 'string', 'example' => '52.0', 'title' => ''], + 'ValueMedian' => ['description' => 'The median value.', 'type' => 'string', 'example' => '35.0', 'title' => ''], + 'ValueMin' => ['description' => 'The minimum value.', 'type' => 'string', 'example' => '18.0', 'title' => ''], + 'ValueQuantile1' => ['description' => 'The 1st percentile value.', 'type' => 'string', 'example' => '18.0', 'title' => ''], + 'ValueQuantile5' => ['description' => 'The 5th percentile value.', 'type' => 'string', 'example' => '18.0', 'title' => ''], + 'ValueQuantile25' => ['description' => 'The 25th percentile value.', 'type' => 'string', 'example' => '18.0', 'title' => ''], + 'ValueQuantile75' => ['description' => 'The 75th percentile value.', 'type' => 'string', 'example' => '18.0', 'title' => ''], + 'ValueQuantile95' => ['description' => 'The 95th percentile value.', 'type' => 'string', 'example' => '18.0', 'title' => ''], + 'ValueQuantile99' => ['description' => 'The 99th percentile value.', 'type' => 'string', 'example' => '18.0', 'title' => ''], + 'Rn' => ['description' => 'The rank.', 'type' => 'string', 'example' => '3', 'title' => ''], + 'FrequencyMax' => ['description' => 'The maximum frequency.', 'type' => 'string', 'example' => '91149.0', 'title' => ''], + 'FrequencyMedian' => ['description' => 'The median frequency.', 'type' => 'string', 'example' => '1349.0', 'title' => ''], + 'FrequencyMin' => ['description' => 'The minimum frequency.', 'type' => 'string', 'example' => '289.0', 'title' => ''], + 'FrequencyQuantile1' => ['description' => 'The 1st frequency percentile.', 'type' => 'string', 'example' => '289.0', 'title' => ''], + 'FrequencyQuantile5' => ['description' => 'The 5th frequency percentile.', 'type' => 'string', 'example' => '289.0', 'title' => ''], + 'FrequencyQuantile25' => ['description' => 'The 25th frequency percentile.', 'type' => 'string', 'example' => '289.0', 'title' => ''], + 'FrequencyQuantile75' => ['description' => 'The 75th frequency percentile.', 'type' => 'string', 'example' => '289.0', 'title' => ''], + 'FrequencyQuantile95' => ['description' => 'The 95th frequency percentile.', 'type' => 'string', 'example' => '289.0'."\n", 'title' => ''], + 'FrequencyQuantile99' => ['description' => 'The 99th frequency percentile.', 'type' => 'string', 'example' => '289.0', 'title' => ''], + 'Distribution' => ['description' => 'The feature distribution.', 'type' => 'string', 'example' => '{678.8225: 91, 5270.4675: 95}', 'title' => ''], + 'RankId' => ['description' => 'The rank of the statistical indicator.', 'type' => 'string', 'example' => '1', 'title' => ''], + 'FeatureValue' => ['description' => 'The feature value.', 'type' => 'string', 'example' => '1683562246', 'title' => ''], + 'ValueCount' => ['description' => 'The value count.', 'type' => 'string', 'example' => '1', 'title' => ''], + 'ValuePercent' => ['description' => 'The value percentage.', 'type' => 'string', 'example' => '0.000019996000799840032', 'title' => ''], + 'ValueQuantile' => ['description' => 'The value quantile.', 'type' => 'string', 'example' => '0.7261657444926671', 'title' => ''], + 'FeatureFrequency' => ['description' => 'The frequency of the feature value.', 'type' => 'string', 'example' => '427', 'title' => ''], + 'FrequencyCount' => ['description' => 'The number of feature values with this frequency.', 'type' => 'string', 'example' => '1', 'title' => ''], + 'FrequencyPercent' => ['description' => 'The percentage of feature values with this frequency.', 'type' => 'string', 'example' => '0.5', 'title' => ''], + 'FrequencyQuantile' => ['description' => 'The percentile of the frequency of field values.', 'type' => 'string', 'example' => '5', 'title' => ''], + ], + 'title' => '', + 'example' => '', + ], + 'title' => '', + 'example' => '', + ], + 'title' => '', + 'example' => '', ], - 'InstanceId' => [ - 'title' => '实例ID。', - 'description' => '', - 'type' => 'string', - 'required' => false, - 'example' => 'pairec-cn-abcdefg1234', + 'ReportsOfAbnormalBehavior' => [ + 'description' => 'Reports for the abnormal behavior analysis task.', + 'type' => 'array', + 'items' => [ + 'description' => 'The data list.', + 'type' => 'array', + 'items' => [ + 'description' => 'Details of a single data entry.', + 'type' => 'object', + 'properties' => [ + 'Ds' => ['description' => 'The date.', 'type' => 'string', 'example' => '20250114', 'title' => ''], + 'RankId' => ['description' => 'The rank.', 'type' => 'string', 'example' => '1', 'title' => ''], + 'ConversionRate' => ['description' => 'The conversion rate from upstream behavior to downstream behavior.', 'type' => 'string', 'example' => '1.0', 'title' => ''], + 'ConversionRateIds' => ['description' => 'The ID corresponding to the statistical granularity.', 'type' => 'string', 'example' => '100010050+259203779', 'title' => ''], + 'DownStreamCount' => ['description' => 'The count of downstream behaviors.', 'type' => 'string', 'example' => '2.0', 'title' => ''], + 'DownStreamCountIds' => ['description' => 'The ID corresponding to the granularity of the downstream behavior.', 'type' => 'string', 'example' => '189814043+272292277', 'title' => ''], + 'Granularity' => ['description' => 'The statistical granularity.', 'type' => 'string', 'example' => 'pair', 'title' => ''], + 'UpStreamCount' => ['description' => 'The count of upstream behaviors.', 'type' => 'string', 'example' => '2.0', 'title' => ''], + 'UpStreamCountIds' => ['description' => 'The ID corresponding to the granularity of the upstream behavior.', 'type' => 'string', 'example' => '104684044+249445882', 'title' => ''], + 'Distribution' => ['description' => 'The feature distribution.', 'type' => 'string', 'example' => '{678.8225: 91, 5270.4675: 95}', 'title' => ''], + 'IndicatorName' => ['description' => 'The indicator name.', 'type' => 'string', 'example' => 'conversion_rate', 'title' => ''], + 'ExceptionRate' => ['description' => 'The exception rate.', 'type' => 'string', 'example' => '0.0', 'title' => ''], + ], + 'title' => '', + 'example' => '', + ], + 'title' => '', + 'example' => '', + ], + 'title' => '', + 'example' => '', ], - 'Type' => [ - 'type' => 'string', + 'ExceptionRate' => [ + 'description' => 'The exception report list.', + 'type' => 'array', + 'items' => [ + 'description' => 'Details of a single exception report.', + 'type' => 'object', + 'properties' => [ + 'Group' => ['description' => 'The exception group.', 'type' => 'string', 'example' => 'add', 'title' => ''], + 'Message' => ['description' => 'The exception message.', 'type' => 'string', 'example' => 'change_rate 大于 0.2，请确认是否正常', 'title' => ''], + 'Type' => ['description' => 'The type or level of the exception.', 'type' => 'string', 'example' => 'WARN', 'title' => ''], + ], + 'title' => '', + 'example' => '', + ], + 'title' => '', + 'example' => '', ], ], - 'required' => false, + 'example' => '', + ], + ], + ], + 'staticInfo' => ['returnType' => 'synchronous'], + 'title' => 'Retrieve data diagnostic report ', + 'summary' => 'Specify parameters to retrieve data diagnosis reports for a specific time range.', + 'description' => '## Request'."\n" + ."\n" + .'- This API retrieves data diagnosis reports based on parameters such as the data diagnosis ID, instance ID, and a date range.'."\n" + ."\n" + .'- The `FeatureName` parameter filters reports by a specific feature, and the `TopN` parameter limits the number of results.'."\n" + ."\n" + .'- The `RemainRateType` parameter specifies the type of retention rate report, such as a periodic report.'."\n" + ."\n" + .'- Report content includes item and user change rate analysis, periodic user preference analysis, correlation analysis, basic statistical analysis, and anomaly detection.'."\n" + ."\n" + .'- Important: All date values must use the `YYYY-MM-DD` format.', + 'changeSet' => [], + 'flowControl' => [ + 'flowControlList' => [], + ], + 'ramActions' => [ + [ + 'operationType' => 'get', + 'ramAction' => [ + 'action' => 'pairec:ListDataDiagnosisReports', + 'authLevel' => 'operate', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'PAIRecService', 'resourceType' => 'All Resource', 'arn' => '*'], + ], ], ], ], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"728C5E01-ABF6-5AA8-B9FC-B3BA05DECC77\\",\\n \\"Type\\": \\"ChangeRate\\",\\n \\"ReportsOfChangeRateData\\": [\\n [\\n {\\n \\"Ds\\": \\"20230509\\",\\n \\"Flag\\": \\"add\\",\\n \\"ChangeCount\\": \\"1231\\",\\n \\"ChangeRate\\": \\"0.1231\\"\\n }\\n ]\\n ],\\n \\"ReportsOfPreferenceStatisticsCycle\\": [\\n [\\n {\\n \\"CycleRemainRate\\": \\"0.73\\",\\n \\"SingleRemainRate\\": \\"0.52\\",\\n \\"Ds\\": \\"20230509\\",\\n \\"Days\\": \\"7\\",\\n \\"EverAppearedRate\\": \\"0.67\\",\\n \\"Period\\": \\"week\\",\\n \\"PeriodRemainRate\\": \\"0.33\\",\\n \\"PeriodRemainCount\\": 1,\\n \\"PeriodInternal\\": 1\\n }\\n ]\\n ],\\n \\"ReportsOfJoinTables\\": [\\n [\\n {\\n \\"Ds\\": \\"20230509\\",\\n \\"JoinField\\": \\"user_id\\",\\n \\"LeftExceptRate\\": \\"0.53\\",\\n \\"RightExceptRate\\": \\"0.0\\",\\n \\"Flag\\": \\"add\\",\\n \\"FeatureName\\": \\"register_time\\",\\n \\"FeatureValue\\": \\"1683562246\\",\\n \\"Percent\\": \\"1\\",\\n \\"Quantile\\": \\"1\\",\\n \\"ValueCount\\": \\"1\\",\\n \\"ValuePercent\\": \\"0.019996000799\\",\\n \\"ValueQuantile\\": \\"0.72616\\"\\n }\\n ]\\n ],\\n \\"ReportsOfBaseStatistics\\": [\\n [\\n {\\n \\"DefaultNullCount\\": \\"\\\\\\\\\\\\\\\\N\\",\\n \\"DefaultNullRate\\": \\"\\\\\\\\\\\\\\\\N\\",\\n \\"Ds\\": \\"20230509\\",\\n \\"FeatureName\\": \\"register_time\\",\\n \\"FeatureType\\": \\"string\\",\\n \\"NullCount\\": \\"55095\\",\\n \\"NullRate\\": \\"0.5580879448141732\\",\\n \\"TotalCount\\": \\"98721\\",\\n \\"UniqueCount\\": \\"29\\",\\n \\"ValueMax\\": \\"52.0\\",\\n \\"ValueMedian\\": \\"35.0\\",\\n \\"ValueMin\\": \\"18.0\\",\\n \\"ValueQuantile1\\": \\"18.0\\",\\n \\"ValueQuantile5\\": \\"18.0\\",\\n \\"ValueQuantile25\\": \\"18.0\\",\\n \\"ValueQuantile75\\": \\"18.0\\",\\n \\"ValueQuantile95\\": \\"18.0\\",\\n \\"ValueQuantile99\\": \\"18.0\\",\\n \\"Rn\\": \\"3\\",\\n \\"FrequencyMax\\": \\"91149.0\\",\\n \\"FrequencyMedian\\": \\"1349.0\\",\\n \\"FrequencyMin\\": \\"289.0\\",\\n \\"FrequencyQuantile1\\": \\"289.0\\",\\n \\"FrequencyQuantile5\\": \\"289.0\\",\\n \\"FrequencyQuantile25\\": \\"289.0\\",\\n \\"FrequencyQuantile75\\": \\"289.0\\",\\n \\"FrequencyQuantile95\\": \\"289.0\\\\n\\",\\n \\"FrequencyQuantile99\\": \\"289.0\\",\\n \\"Distribution\\": \\"{678.8225: 91, 5270.4675: 95}\\",\\n \\"RankId\\": \\"1\\",\\n \\"FeatureValue\\": \\"1683562246\\",\\n \\"ValueCount\\": \\"1\\",\\n \\"ValuePercent\\": \\"0.000019996000799840032\\",\\n \\"ValueQuantile\\": \\"0.7261657444926671\\",\\n \\"FeatureFrequency\\": \\"427\\",\\n \\"FrequencyCount\\": \\"1\\",\\n \\"FrequencyPercent\\": \\"0.5\\",\\n \\"FrequencyQuantile\\": \\"5\\"\\n }\\n ]\\n ],\\n \\"ReportsOfAbnormalBehavior\\": [\\n [\\n {\\n \\"Ds\\": \\"20250114\\",\\n \\"RankId\\": \\"1\\",\\n \\"ConversionRate\\": \\"1.0\\",\\n \\"ConversionRateIds\\": \\"100010050+259203779\\",\\n \\"DownStreamCount\\": \\"2.0\\",\\n \\"DownStreamCountIds\\": \\"189814043+272292277\\",\\n \\"Granularity\\": \\"pair\\",\\n \\"UpStreamCount\\": \\"2.0\\",\\n \\"UpStreamCountIds\\": \\"104684044+249445882\\",\\n \\"Distribution\\": \\"{678.8225: 91, 5270.4675: 95}\\",\\n \\"IndicatorName\\": \\"conversion_rate\\",\\n \\"ExceptionRate\\": \\"0.0\\"\\n }\\n ]\\n ],\\n \\"ExceptionRate\\": [\\n {\\n \\"Group\\": \\"add\\",\\n \\"Message\\": \\"change_rate 大于 0.2，请确认是否正常\\",\\n \\"Type\\": \\"WARN\\"\\n }\\n ]\\n}","type":"json"}]', + ], + 'ListEngineConfigs' => [ + 'summary' => 'Retrieves a list of engine configurations.', + 'path' => '/api/v1/engineconfigs', + 'methods' => ['get'], + 'schemes' => ['http', 'https'], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'consumes' => ['application/json'], + 'produces' => ['application/json'], + 'operationType' => 'read', + 'deprecated' => false, + 'systemTags' => [ + 'operationType' => 'list', + 'riskType' => 'none', + 'chargeType' => 'free', + 'abilityTreeCode' => '180248', + 'abilityTreeNodes' => ['FEATURElearnN0NAWV'], + ], + 'parameters' => [ + [ + 'name' => 'Environment', + 'in' => 'query', + 'schema' => ['description' => 'The environment. Valid values:'."\n" + ."\n" + .'- **Daily**: the development and test environment.'."\n" + ."\n" + .'- **Pre**: the pre-production environment.'."\n" + ."\n" + .'- **Prod**: the production environment.', 'type' => 'string', 'required' => false, 'example' => 'Pre', 'title' => ''], + ], + [ + 'name' => 'Status', + 'in' => 'query', + 'schema' => ['description' => 'The status to filter by. Valid values:'."\n" + ."\n" + .'- **Released**: returns only released configurations.'."\n" + ."\n" + .'- **Unreleased**: returns only unreleased configurations.', 'type' => 'string', 'required' => false, 'example' => 'Released', 'title' => ''], + ], + [ + 'name' => 'Name', + 'in' => 'query', + 'schema' => ['description' => 'The name of the engine configuration.', 'type' => 'string', 'required' => false, 'example' => 'engine_config_v1', 'title' => ''], + ], + [ + 'name' => 'PageNumber', + 'in' => 'query', + 'schema' => ['description' => 'The page number.', 'type' => 'integer', 'format' => 'int32', 'required' => false, 'example' => '1', 'title' => ''], + ], + [ + 'name' => 'PageSize', + 'in' => 'query', + 'schema' => ['description' => 'The page size.', 'type' => 'integer', 'format' => 'int32', 'required' => false, 'example' => '10', 'title' => ''], + ], + [ + 'name' => 'Version', + 'in' => 'query', + 'schema' => ['description' => 'The version to filter by.'."\n" + ."\n" + .'Set this parameter to `latest` to retrieve the most recently updated version.', 'type' => 'string', 'required' => false, 'example' => 'latest', 'title' => ''], + ], + [ + 'name' => 'InstanceId', + 'in' => 'query', + 'schema' => ['description' => 'The instance ID. To obtain this ID, call the [ListInstances](~~2411819~~) operation.', 'type' => 'string', 'required' => true, 'example' => 'pairec-cn-***test', 'title' => ''], + ], + ], 'responses' => [ 200 => [ 'schema' => [ 'title' => 'Schema of Response', - 'description' => 'Schema of Response', + 'description' => 'The response object.', 'type' => 'object', 'properties' => [ - 'RequestId' => [ - 'title' => 'Id of the request', - 'description' => 'Id of the request', - 'type' => 'string', - 'example' => 'F8F613A9-DF1C-551A-88E1-397A3981A785', - ], - 'ParamId' => [ - 'title' => '参数ID。', - 'description' => '', - 'type' => 'integer', - 'format' => 'int64', - 'example' => '4', + 'RequestId' => ['title' => 'Id of the request', 'description' => 'The request ID.', 'type' => 'string', 'example' => '74D958EF-3598-56FA-8296-FF1575CE43DF'], + 'TotalCount' => ['description' => 'The total number of entries.', 'type' => 'integer', 'format' => 'int64', 'example' => '10', 'title' => ''], + 'EngineConfigs' => [ + 'description' => 'A list of engine configurations.', + 'type' => 'array', + 'items' => [ + 'type' => 'object', + 'properties' => [ + 'EngineConfigId' => ['description' => 'The ID of the engine configuration.', 'type' => 'string', 'example' => '2', 'title' => ''], + 'Name' => ['description' => 'The name of the engine configuration.', 'type' => 'string', 'example' => 'engine_config_v1', 'title' => ''], + 'ConfigValue' => ['description' => 'The content of the engine configuration.', 'type' => 'string', 'example' => '{}', 'title' => ''], + 'Environment' => ['description' => 'The environment. Valid values:'."\n" + ."\n" + .'- **Daily**: the development and test environment.'."\n" + ."\n" + .'- **Pre**: the pre-production environment.'."\n" + ."\n" + .'- **Prod**: the production environment.', 'type' => 'string', 'example' => 'Pre', 'title' => ''], + 'Version' => ['description' => 'The version of the currently released or most recently updated engine configuration.', 'type' => 'string', 'example' => '20230509161300', 'title' => ''], + 'Status' => ['description' => 'The status of the engine configuration. Valid values:'."\n" + ."\n" + .'- **Released**: The configuration has been released.'."\n" + ."\n" + .'- **Unreleased**: The configuration has not been released.', 'type' => 'string', 'example' => 'Released', 'title' => ''], + 'GmtCreateTime' => ['description' => 'The creation time.', 'type' => 'string', 'example' => '2023-08-07T01:43:42Z', 'title' => ''], + 'GmtModifiedTime' => ['description' => 'The modification time.', 'type' => 'string', 'example' => '2023-08-27T12:00:00Z', 'title' => ''], + 'GmtReleasedTime' => ['description' => 'The release time.', 'type' => 'string', 'example' => '2023-08-29 12:00:00', 'title' => ''], + 'Description' => ['description' => 'The description of the engine configuration.', 'type' => 'string', 'title' => '', 'example' => ''], + ], + 'description' => '', + 'title' => '', + 'example' => '', + ], + 'title' => '', + 'example' => '', ], ], + 'example' => '', ], ], ], - 'staticInfo' => [ - 'returnType' => 'synchronous', + 'staticInfo' => ['returnType' => 'synchronous'], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"74D958EF-3598-56FA-8296-FF1575CE43DF\\",\\n \\"TotalCount\\": 10,\\n \\"EngineConfigs\\": [\\n {\\n \\"EngineConfigId\\": \\"2\\",\\n \\"Name\\": \\"engine_config_v1\\",\\n \\"ConfigValue\\": \\"{}\\",\\n \\"Environment\\": \\"Pre\\",\\n \\"Version\\": \\"20230509161300\\",\\n \\"Status\\": \\"Released\\",\\n \\"GmtCreateTime\\": \\"2023-08-07T01:43:42Z\\",\\n \\"GmtModifiedTime\\": \\"2023-08-27T12:00:00Z\\",\\n \\"GmtReleasedTime\\": \\"2023-08-29 12:00:00\\",\\n \\"Description\\": \\"\\"\\n }\\n ]\\n}","type":"json"}]', + 'title' => 'List Engine Configurations', + 'changeSet' => [ + ['createdAt' => '2024-12-27T08:56:39.000Z', 'description' => 'Response parameters changed'], + ], + 'flowControl' => [ + 'flowControlList' => [], + ], + 'ramActions' => [ + [ + 'operationType' => 'list', + 'ramAction' => [ + 'action' => 'pairec:ListEngineConfigs', + 'authLevel' => 'operate', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'PAIRecService', 'resourceType' => 'All Resource', 'arn' => '*'], + ], + ], + ], ], - 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"F8F613A9-DF1C-551A-88E1-397A3981A785\\",\\n \\"ParamId\\": 4\\n}","type":"json"}]', ], - 'DeleteParam' => [ - 'summary' => '删除指定参数。', - 'path' => '/api/v1/params/{ParamId}', - 'methods' => [ - 'delete', - ], - 'schemes' => [ - 'http', - 'https', - ], + 'ListExperimentGroups' => [ + 'summary' => 'Returns a list of experiment groups.', + 'path' => '/api/v1/experimentgroups', + 'methods' => ['get'], + 'schemes' => ['http', 'https'], 'security' => [ [ 'AK' => [], ], ], - 'consumes' => [ - 'application/json', - ], - 'produces' => [ - 'application/json', - ], - 'operationType' => 'write', + 'consumes' => ['application/json'], + 'produces' => ['application/json'], + 'operationType' => 'read', 'deprecated' => false, 'systemTags' => [ - 'operationType' => 'delete', + 'operationType' => 'list', 'riskType' => 'none', 'chargeType' => 'free', - 'abilityTreeNodes' => [ - 'FEATURElearnN0NAWV', - ], + 'abilityTreeCode' => '183391', + 'abilityTreeNodes' => ['FEATURElearnN0NAWV'], ], 'parameters' => [ [ - 'name' => 'ParamId', - 'in' => 'path', - 'schema' => [ - 'title' => '参数ID。', - 'description' => '', - 'type' => 'string', - 'required' => false, - 'example' => '3', - ], + 'name' => 'LayerId', + 'in' => 'query', + 'schema' => ['description' => 'The layer ID. You can get this ID by calling the ListLayers operation.', 'type' => 'string', 'example' => '3', 'title' => '', 'required' => false], + ], + [ + 'name' => 'Status', + 'in' => 'query', + 'schema' => ['description' => 'The status of the experiment group. Valid values: Offline, Online, and Pushed.', 'type' => 'string', 'example' => 'Online', 'title' => '', 'required' => false], ], [ 'name' => 'InstanceId', 'in' => 'query', - 'schema' => [ - 'title' => '实例ID。', - 'description' => '', - 'type' => 'string', - 'required' => false, - 'example' => 'pairec-cn-abcdefg1234', - ], + 'schema' => ['description' => 'The instance ID. You can get this ID by calling the ListInstances operation.', 'type' => 'string', 'required' => true, 'example' => 'pairec-cn-abcdefg1234', 'title' => ''], + ], + [ + 'name' => 'TimeRangeStart', + 'in' => 'query', + 'schema' => ['description' => 'The start time for filtering experiment groups.', 'type' => 'string', 'required' => false, 'example' => '2024-08-30 12:00:00', 'title' => ''], + ], + [ + 'name' => 'TimeRangeEnd', + 'in' => 'query', + 'schema' => ['description' => 'The end time for filtering experiment groups.', 'type' => 'string', 'required' => false, 'example' => '2024-08-31 12:00:00', 'title' => ''], ], ], 'responses' => [ 200 => [ 'schema' => [ 'title' => 'Schema of Response', - 'description' => 'Schema of Response', + 'description' => 'The response schema.', 'type' => 'object', 'properties' => [ - 'RequestId' => [ - 'title' => 'Id of the request', - 'description' => 'Id of the request', - 'type' => 'string', - 'example' => 'F0AB6527-093F-5C44-B3BD-42C8C210C619', + 'RequestId' => ['title' => 'Id of the request', 'description' => 'The ID of the request.', 'type' => 'string', 'example' => '59CE7EC6-F268-5D71-9215-32922CC50D72'], + 'TotalCount' => ['description' => 'The total number of entries.', 'type' => 'integer', 'format' => 'int64', 'example' => '10', 'title' => ''], + 'ExperimentGroups' => [ + 'title' => '', + 'description' => 'The list of experiment groups.', + 'type' => 'array', + 'items' => [ + 'type' => 'object', + 'properties' => [ + 'ExperimentGroupId' => ['description' => 'The experiment group ID.', 'type' => 'string', 'example' => '3', 'title' => ''], + 'LayerId' => ['description' => 'The layer ID.', 'type' => 'string', 'example' => '3', 'title' => ''], + 'LaboratoryId' => ['description' => 'The laboratory ID.', 'type' => 'string', 'example' => '4', 'title' => ''], + 'SceneId' => ['description' => 'The scene ID.', 'type' => 'string', 'example' => '1', 'title' => ''], + 'Name' => ['description' => 'The experiment group name.', 'type' => 'string', 'example' => 'experiment_group1', 'title' => ''], + 'Description' => ['description' => 'The experiment group description.', 'type' => 'string', 'example' => 'This is a test.', 'title' => ''], + 'DebugUsers' => ['description' => 'The IDs of debug users, separated by commas.', 'type' => 'string', 'example' => '1124512470******,1124512471******,1124512472******', 'title' => ''], + 'DebugCrowdId' => ['description' => 'The debug crowd ID.', 'type' => 'string', 'example' => '4', 'title' => ''], + 'Owner' => ['description' => 'The owner of the experiment group.', 'type' => 'string', 'example' => '1124512470******', 'title' => ''], + 'NeedAA' => ['description' => 'Specifies whether to enable A/B testing for the experiment group.', 'type' => 'boolean', 'title' => '', 'example' => 'true'], + 'Filter' => ['description' => 'The filter condition.', 'type' => 'string', 'example' => 'gender=female', 'title' => ''], + 'DistributionType' => ['description' => 'The traffic distribution method.<br>● `UserId`: by user ID<br>● `TimeDuration`: by time duration<br><br>', 'type' => 'string', 'example' => 'UserId', 'title' => ''], + 'DistributionTimeDuration' => ['description' => 'The distribution duration. This parameter is required only when `DistributionType` is `TimeDuration`.', 'type' => 'integer', 'format' => 'int32', 'example' => '5', 'title' => ''], + 'CrowdId' => ['description' => 'The crowd ID.', 'type' => 'string', 'example' => '3', 'title' => ''], + 'Config' => ['description' => 'The configuration for the experiment group, in JSON format.', 'type' => 'string', 'example' => '{}', 'title' => ''], + 'ReservedBuckets' => ['description' => 'The IDs of reserved buckets, separated by commas.', 'type' => 'string', 'example' => '1,2,3,4', 'title' => ''], + 'Status' => ['description' => 'The status of the experiment group. Valid values:<br>● `Offline`: The experiment group is inactive.<br>● `Online`: The experiment group is active.<br>● `Pushed`: The experiment group is fully rolled out.<br><br><br>', 'type' => 'string', 'example' => 'Offline', 'title' => ''], + 'CrowdTargetType' => ['description' => 'The traffic targeting method for the experiment group. Valid values:'."\n" + ."\n" + .'- `All`: All traffic.'."\n" + ."\n" + .'- `Filter`: Traffic that matches the filter.'."\n" + ."\n" + .'- `CrowdId`: Traffic from a specified crowd.'."\n" + ."\n" + .'- `Random`: A random percentage of traffic.', 'type' => 'string', 'example' => 'All', 'title' => ''], + 'RandomFlow' => ['description' => 'If `CrowdTargetType` is set to `Random`, this parameter specifies the percentage of traffic (an integer from 0 to 100) randomly allocated to the experiment group.', 'type' => 'integer', 'format' => 'int64', 'example' => '20', 'title' => ''], + 'HoldingBuckets' => ['description' => 'If `CrowdTargetType` is set to `Random`, this parameter returns the comma-separated IDs of buckets allocated based on the `RandomFlow` value.', 'type' => 'string', 'example' => '1,2,3,4', 'title' => ''], + ], + 'description' => '', + 'title' => '', + 'example' => '', + ], + 'example' => '', ], ], + 'example' => '', ], ], ], - 'staticInfo' => [ - 'returnType' => 'synchronous', + 'staticInfo' => ['returnType' => 'synchronous'], + 'title' => 'Retrieve experiment group list ', + 'changeSet' => [ + ['createdAt' => '2024-06-25T02:52:46.000Z', 'description' => 'Request parameters changed'], + ['createdAt' => '2024-03-20T06:05:19.000Z', 'description' => 'Request parameters changed, Response parameters changed'], ], - 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"F0AB6527-093F-5C44-B3BD-42C8C210C619\\"\\n}","type":"json"}]', - ], - 'UpdateParam' => [ - 'summary' => '更新参数。', - 'path' => '/api/v1/params/{ParamId}', - 'methods' => [ - 'put', + 'flowControl' => [ + 'flowControlList' => [], ], - 'schemes' => [ - 'http', - 'https', + 'ramActions' => [ + [ + 'operationType' => 'list', + 'ramAction' => [ + 'action' => 'pairec:ListExperimentGroups', + 'authLevel' => 'operate', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'PAIRecService', 'resourceType' => 'All Resource', 'arn' => '*'], + ], + ], + ], ], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"59CE7EC6-F268-5D71-9215-32922CC50D72\\",\\n \\"TotalCount\\": 10,\\n \\"ExperimentGroups\\": [\\n {\\n \\"ExperimentGroupId\\": \\"3\\",\\n \\"LayerId\\": \\"3\\",\\n \\"LaboratoryId\\": \\"4\\",\\n \\"SceneId\\": \\"1\\",\\n \\"Name\\": \\"experiment_group1\\",\\n \\"Description\\": \\"This is a test.\\",\\n \\"DebugUsers\\": \\"1124512470******,1124512471******,1124512472******\\",\\n \\"DebugCrowdId\\": \\"4\\",\\n \\"Owner\\": \\"1124512470******\\",\\n \\"NeedAA\\": true,\\n \\"Filter\\": \\"gender=female\\",\\n \\"DistributionType\\": \\"UserId\\",\\n \\"DistributionTimeDuration\\": 5,\\n \\"CrowdId\\": \\"3\\",\\n \\"Config\\": \\"{}\\",\\n \\"ReservedBuckets\\": \\"1,2,3,4\\",\\n \\"Status\\": \\"Offline\\",\\n \\"CrowdTargetType\\": \\"All\\",\\n \\"RandomFlow\\": 20,\\n \\"HoldingBuckets\\": \\"1,2,3,4\\"\\n }\\n ]\\n}","type":"json"}]', + ], + 'ListExperiments' => [ + 'path' => '/api/v1/experiments', + 'methods' => ['get'], + 'schemes' => ['http', 'https'], 'security' => [ [ 'AK' => [], ], ], - 'consumes' => [ - 'application/json', - ], - 'produces' => [ - 'application/json', - ], - 'operationType' => 'readAndWrite', + 'consumes' => ['application/json'], + 'produces' => ['application/json'], + 'operationType' => 'read', 'deprecated' => false, 'systemTags' => [ - 'operationType' => 'update', + 'operationType' => 'list', 'riskType' => 'none', 'chargeType' => 'free', - 'abilityTreeNodes' => [ - 'FEATURElearnN0NAWV', - ], + 'abilityTreeNodes' => ['FEATURElearnN0NAWV'], ], 'parameters' => [ [ - 'name' => 'ParamId', - 'in' => 'path', - 'schema' => [ - 'title' => '参数ID。', - 'description' => '', - 'type' => 'string', - 'required' => false, - 'example' => '3', - ], + 'name' => 'ExperimentGroupId', + 'in' => 'query', + 'schema' => ['description' => 'The ID of the experiment group.', 'type' => 'string', 'required' => false, 'example' => '3', 'title' => ''], ], [ - 'name' => 'body', - 'in' => 'body', - 'style' => 'json', + 'name' => 'Status', + 'in' => 'query', + 'schema' => ['description' => 'The status of the experiment. Valid values:'."\n" + ."\n" + .'- Offline'."\n" + ."\n" + .'- Online', 'type' => 'string', 'example' => 'Offline', 'title' => '', 'required' => false], + ], + [ + 'name' => 'InstanceId', + 'in' => 'query', + 'schema' => ['description' => 'The instance ID. You can call the ListInstances operation to obtain the ID.', 'type' => 'string', 'required' => true, 'example' => 'pairec-cn-abcdefg1234', 'title' => ''], + ], + [ + 'name' => 'Query', + 'in' => 'query', + 'schema' => ['description' => 'The filter parameter for quick search. All experiments that match the names or tags are returned.', 'type' => 'string', 'example' => 'experiment_test1', 'title' => '', 'required' => false], + ], + ], + 'responses' => [ + 200 => [ 'schema' => [ - 'title' => '请求body。', - 'description' => '', + 'title' => 'Schema of Response', + 'description' => 'The response schema.', 'type' => 'object', 'properties' => [ - 'Value' => [ - 'title' => '参数值。', - 'description' => '', - 'type' => 'string', - 'required' => false, - 'example' => 'house', - ], - 'InstanceId' => [ - 'title' => '实例ID。', - 'description' => '', - 'type' => 'string', - 'required' => false, - 'example' => 'pairec-cn-abcdefg1234', + 'RequestId' => ['title' => 'Id of the request', 'description' => 'The ID of the request.', 'type' => 'string', 'example' => '68075085-1A7D-55C2-B51D-7AD9B02A6DD6'], + 'TotalCount' => ['description' => 'The total number of experiments returned.', 'type' => 'integer', 'format' => 'int64', 'example' => '10', 'title' => ''], + 'Experiments' => [ + 'title' => '', + 'description' => 'The list of experiments.', + 'type' => 'array', + 'items' => [ + 'type' => 'object', + 'properties' => [ + 'ExperimentId' => ['description' => 'The ID of the experiment.', 'type' => 'string', 'example' => '3', 'title' => ''], + 'AliasExperimentId' => ['description' => 'The alias for the experiment ID.', 'type' => 'string', 'example' => 'L1#EG1#E1', 'title' => ''], + 'ExperimentGroupId' => ['description' => 'The ID of the experiment group.', 'type' => 'string', 'example' => '3', 'title' => ''], + 'LayerId' => ['description' => 'The ID of the layer.', 'type' => 'string', 'example' => '3', 'title' => ''], + 'LaboratoryId' => ['description' => 'The ID of the laboratory.', 'type' => 'string', 'example' => '3', 'title' => ''], + 'SceneId' => ['description' => 'The ID of the scene.', 'type' => 'string', 'example' => '3', 'title' => ''], + 'Name' => ['description' => 'The name of the experiment.', 'type' => 'string', 'example' => 'experiment_test1', 'title' => ''], + 'Description' => ['description' => 'The description of the experiment.', 'type' => 'string', 'example' => 'This is a test.', 'title' => ''], + 'Type' => ['description' => 'The type of the experiment. Valid values:'."\n" + ."\n" + .'- `Baseline`: The control experiment.'."\n" + ."\n" + .'- `Normal`: A variant experiment.', 'type' => 'string', 'example' => 'Baseline', 'title' => ''], + 'FlowPercent' => ['description' => 'The percentage of flow allocated to the experiment.', 'type' => 'integer', 'format' => 'int32', 'default' => '100', 'title' => '', 'example' => '100'], + 'Buckets' => ['description' => 'The allocated bucket numbers.', 'type' => 'string', 'example' => '1,2,3', 'title' => ''], + 'DebugUsers' => ['description' => 'A comma-separated list of user IDs for debugging.', 'type' => 'string', 'example' => 'uid1,uid2,uid3', 'title' => ''], + 'DebugCrowdId' => ['description' => 'The ID of the debug crowd.', 'type' => 'string', 'example' => '3', 'title' => ''], + 'Config' => ['description' => 'The configuration of the experiment.', 'type' => 'string', 'example' => '{}', 'title' => ''], + 'Status' => ['description' => 'The status of the experiment. Valid values:'."\n" + ."\n" + .'- `Offline`: The experiment is inactive and does not receive flow.'."\n" + ."\n" + .'- `Online`: The experiment is active and can receive flow.', 'type' => 'string', 'example' => 'Offline', 'title' => ''], + 'GmtCreateTime' => ['description' => 'The timestamp indicating when the experiment was created.', 'type' => 'string', 'example' => '2021-12-15T23:24:33.132+08:00', 'title' => ''], + 'GmtModifiedTime' => ['description' => 'The timestamp indicating when the experiment was last modified.', 'type' => 'string', 'example' => '2021-12-15T23:24:33.132+08:00', 'title' => ''], + ], + 'description' => '', + 'title' => '', + 'example' => '', + ], + 'example' => '', ], ], - 'required' => false, + 'example' => '', ], ], ], + 'staticInfo' => ['returnType' => 'synchronous'], + 'title' => 'Retrieve experiment list', + 'summary' => 'Lists the experiments in the specified experiment group.', + 'changeSet' => [], + 'flowControl' => [ + 'flowControlList' => [], + ], + 'ramActions' => [ + [ + 'operationType' => 'list', + 'ramAction' => [ + 'action' => 'pairec:ListExperiments', + 'authLevel' => 'operate', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'PAIRecService', 'resourceType' => 'All Resource', 'arn' => '*'], + ], + ], + ], + ], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"68075085-1A7D-55C2-B51D-7AD9B02A6DD6\\",\\n \\"TotalCount\\": 10,\\n \\"Experiments\\": [\\n {\\n \\"ExperimentId\\": \\"3\\",\\n \\"AliasExperimentId\\": \\"L1#EG1#E1\\",\\n \\"ExperimentGroupId\\": \\"3\\",\\n \\"LayerId\\": \\"3\\",\\n \\"LaboratoryId\\": \\"3\\",\\n \\"SceneId\\": \\"3\\",\\n \\"Name\\": \\"experiment_test1\\",\\n \\"Description\\": \\"This is a test.\\",\\n \\"Type\\": \\"Baseline\\",\\n \\"FlowPercent\\": 100,\\n \\"Buckets\\": \\"1,2,3\\",\\n \\"DebugUsers\\": \\"uid1,uid2,uid3\\",\\n \\"DebugCrowdId\\": \\"3\\",\\n \\"Config\\": \\"{}\\",\\n \\"Status\\": \\"Offline\\",\\n \\"GmtCreateTime\\": \\"2021-12-15T23:24:33.132+08:00\\",\\n \\"GmtModifiedTime\\": \\"2021-12-15T23:24:33.132+08:00\\"\\n }\\n ]\\n}","type":"json"}]', + ], + 'ListFeatureConsistencyCheckJobConfigs' => [ + 'summary' => 'Retrieves a list of feature consistency check task configurations.', + 'path' => '/api/v1/featureconsistencycheck/jobconfigs', + 'methods' => ['get'], + 'schemes' => ['http', 'https'], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'consumes' => ['application/json'], + 'produces' => ['application/json'], + 'operationType' => 'read', + 'deprecated' => false, + 'systemTags' => [ + 'operationType' => 'list', + 'riskType' => 'none', + 'chargeType' => 'free', + 'abilityTreeCode' => '193273', + 'abilityTreeNodes' => ['FEATURElearnN0NAWV'], + ], + 'parameters' => [ + [ + 'name' => 'InstanceId', + 'in' => 'query', + 'schema' => ['description' => 'The instance ID. To obtain an instance ID, see [ListInstances](~~2411819~~).', 'type' => 'string', 'required' => true, 'example' => 'pairec-cn-********', 'title' => ''], + ], + [ + 'name' => 'PageNumber', + 'in' => 'query', + 'schema' => ['description' => 'The page number. The value starts at 1. The default value is 1.', 'type' => 'string', 'example' => '1', 'title' => '', 'required' => false], + ], + [ + 'name' => 'PageSize', + 'in' => 'query', + 'schema' => ['description' => 'The page size.', 'type' => 'string', 'example' => '10', 'title' => '', 'required' => false], + ], + [ + 'name' => 'SortBy', + 'in' => 'query', + 'schema' => ['description' => 'The field to sort by.'."\n" + ."\n" + .'- `GmtCreateTime`: Creation time.'."\n" + ."\n" + .'- `GmtModifiedTime`: Modified time.', 'type' => 'string', 'example' => 'GmtCreateTime', 'title' => '', 'required' => false], + ], + [ + 'name' => 'Order', + 'in' => 'query', + 'schema' => ['description' => 'The sort order.'."\n" + ."\n" + .'- `ASC`: Ascending order.'."\n" + ."\n" + .'- `DESC`: Descending order.', 'type' => 'string', 'example' => 'ASC', 'title' => '', 'required' => false], + ], + ], 'responses' => [ 200 => [ 'schema' => [ 'title' => 'Schema of Response', - 'description' => 'Schema of Response', + 'description' => 'The data returned.', 'type' => 'object', 'properties' => [ - 'RequestId' => [ - 'title' => 'Id of the request', - 'description' => 'Id of the request', - 'type' => 'string', - 'example' => 'BBD41FBF-E75C-551A-92FA-CAD654AA006F', + 'RequestId' => ['title' => 'Id of the request', 'description' => 'The request ID.', 'type' => 'string', 'example' => 'FCF741D8-9C30-578E-807F-B935487DB34A'], + 'TotalCount' => ['description' => 'The total number of configurations.', 'type' => 'integer', 'format' => 'int64', 'example' => '10', 'title' => ''], + 'FeatureConsistencyCheckConfigs' => [ + 'title' => '', + 'description' => 'The list of feature consistency check configurations.', + 'type' => 'array', + 'items' => [ + 'type' => 'object', + 'properties' => [ + 'FeatureConsistencyCheckJobConfigId' => ['description' => 'The ID of the feature consistency check configuration.', 'type' => 'string', 'example' => '3', 'title' => ''], + 'Name' => ['description' => 'The name of the feature consistency check configuration.', 'type' => 'string', 'example' => 'feature_consistency_check1', 'title' => ''], + 'SceneId' => ['description' => 'The ID of the scene.', 'type' => 'string', 'example' => '3', 'title' => ''], + 'SceneName' => ['description' => 'The name of the scene.', 'type' => 'string', 'example' => 'scene1', 'title' => ''], + 'Status' => ['description' => 'The status of the configuration. Valid values:'."\n" + ."\n" + .'- `Editable`: The configuration is editable.'."\n" + ."\n" + .'- `Uneditable`: The configuration is not editable.', 'type' => 'string', 'example' => 'Editable', 'title' => ''], + 'CompareFeature' => ['description' => 'Indicates whether to enable feature comparison.', 'type' => 'boolean', 'title' => '', 'example' => 'true'], + 'LatestJobId' => ['description' => 'The ID of the most recent job created from this configuration.', 'type' => 'string', 'example' => '3', 'title' => ''], + 'LatestJobGmtSamplingStartTime' => ['description' => 'The start time of the latest job based on this configuration.', 'type' => 'string', 'example' => '2021-12-15T23:24:33.132+08:00', 'title' => ''], + 'LatestJobGmtSamplingEndTime' => ['description' => 'The end time of the latest job based on this configuration.', 'type' => 'string', 'example' => '2021-12-15T23:24:33.132+08:00', 'title' => ''], + 'SampleRate' => ['description' => 'The sample rate, a value from 0 to 1.', 'type' => 'string', 'example' => '0.89', 'title' => ''], + 'FeatureLandingResourceId' => ['description' => 'The ID of the data source for feature landing.', 'type' => 'string', 'example' => 'reso-********', 'title' => ''], + 'FeatureLandingResourceUri' => ['description' => 'The URI of the data source for feature landing.', 'type' => 'string', 'example' => 'mc_project_1', 'title' => ''], + 'EasServiceName' => ['description' => 'The name of the EAS service.', 'type' => 'string', 'example' => 'eas_service_1', 'title' => ''], + 'FgJsonFileName' => ['description' => 'The name of the `fg_json` file.', 'type' => 'string', 'example' => 'file.json', 'title' => ''], + 'UserTable' => ['description' => 'The name of the user table.', 'type' => 'string', 'example' => 'user_table', 'title' => ''], + 'UserIdField' => ['description' => 'The name of the `user_id` field.', 'type' => 'string', 'example' => 'user_id', 'title' => ''], + 'UserTablePartitionField' => ['description' => 'The partition field of the user table.', 'type' => 'string', 'example' => 'ds', 'title' => ''], + 'UserTablePartitionFieldFormat' => ['description' => 'The format of the partition field of the user table. Valid values:'."\n" + ."\n" + .'- `yyyymmdd`'."\n" + ."\n" + .'- `yyyy-mm-dd`', 'type' => 'string', 'example' => 'yyyymmdd', 'title' => ''], + 'ItemTable' => ['description' => 'The name of the item table.', 'type' => 'string', 'example' => 'item_table', 'title' => ''], + 'ItemIdField' => ['description' => 'The name of the `item_id` field.', 'type' => 'string', 'example' => 'item_id', 'title' => ''], + 'ItemTablePartitionField' => ['description' => 'The partition field of the item table.', 'type' => 'string', 'example' => 'ds', 'title' => ''], + 'ItemTablePartitionFieldFormat' => ['description' => 'The format of the partition field of the item table. Valid values:'."\n" + ."\n" + .'- `yyyymmdd`'."\n" + ."\n" + .'- `yyyy-mm-dd`', 'type' => 'string', 'example' => 'yyyymmdd', 'title' => ''], + 'GenerateZip' => ['description' => 'Indicates whether to generate a ZIP package.', 'type' => 'boolean', 'title' => '', 'example' => 'true'], + 'ServiceId' => ['description' => 'The ID of the service.', 'type' => 'string', 'example' => '4', 'title' => ''], + 'ServiceName' => ['description' => 'The name of the service.', 'type' => 'string', 'example' => 'service1', 'title' => ''], + 'WorkflowName' => ['description' => 'The name of the workflow.', 'type' => 'string', 'example' => 'work_flow_1', 'title' => ''], + 'OssResourceId' => ['description' => 'The ID of the OSS data source.', 'type' => 'string', 'example' => 'reso-********', 'title' => ''], + 'OssBucket' => ['description' => 'The name of the OSS bucket.', 'type' => 'string', 'example' => 'oss_bucket_1', 'title' => ''], + 'EasyRecVersion' => ['description' => 'The version of EasyRec.', 'type' => 'string', 'example' => '1.3.60', 'title' => ''], + 'EasyRecPackagePath' => ['description' => 'The path of the EasyRec package.', 'type' => 'string', 'title' => '', 'example' => 'oss://*******'], + 'FgJarVersion' => ['description' => 'The version of the `fg_jar` file.', 'type' => 'string', 'example' => '1.0.0', 'title' => ''], + 'FeaturePriority' => ['description' => 'The high-priority features to read from the user table. If a feature is not found, the system retrieves it from the behavior table. Separate multiple features with a comma (,).', 'type' => 'string', 'example' => 'feature1,feature2,feature3', 'title' => ''], + 'FeatureDisplayExclude' => ['description' => 'The features to exclude from the results. Separate multiple features with a comma (,).', 'type' => 'string', 'example' => 'feature1,feature2', 'title' => ''], + 'GmtCreateTime' => ['description' => 'The time when the configuration was created.', 'type' => 'string', 'example' => '2021-12-15T23:24:33.132+08:00', 'title' => ''], + 'GmtModifiedTime' => ['description' => 'The time when the configuration was last updated.', 'type' => 'string', 'example' => '2021-12-15T23:24:33.132+08:00', 'title' => ''], + 'UseFeatureStore' => ['description' => 'Indicates whether to use a feature store. Valid values:'."\n" + ."\n" + .'- `true`: A feature store is used. In this case, the response includes parameters such as `FeatureStoreProjectId`, `FeatureStoreProjectName`, `FeatureStoreModelId`, `FeatureStoreUserId`, and `FeatureStoreItemId`.'."\n" + ."\n" + .'- `false`: A feature store is not used. In this case, the response includes parameters such as `UserTable`, `UserIdField`, `UserTablePartitionField`, `UserTablePartitionFieldFormat`, `ItemTable`, `ItemIdField`, `ItemTablePartitionField`, and `ItemTablePartitionFieldFormat`.', 'type' => 'string', 'example' => 'true', 'title' => ''], + 'FeatureStoreProjectName' => ['description' => 'The name of the feature store project.', 'type' => 'string', 'example' => 'project-1', 'title' => ''], + 'FeatureStoreModelId' => ['description' => 'The ID of the model in the feature store.', 'type' => 'string', 'example' => '2'."\n", 'title' => ''], + 'FeatureStoreUserId' => ['description' => 'The primary key for the user side in the feature store.', 'type' => 'string', 'example' => 'user', 'title' => ''], + 'FeatureStoreItemId' => ['description' => 'The primary key for the item side in the feature store.', 'type' => 'string', 'example' => 'item', 'title' => ''], + 'FeatureStoreSeqFeatureView' => ['description' => 'The name of the feature view that contains item features within the sequence features.', 'type' => 'string', 'example' => 'item-1', 'title' => ''], + 'FeatureStoreProjectId' => ['description' => 'The ID of the feature store project.', 'type' => 'string', 'example' => 'prj-01', 'title' => ''], + 'WorkspaceId' => ['type' => 'string', 'description' => '', 'title' => '', 'example' => ''], + 'VpcId' => ['type' => 'string', 'description' => '', 'title' => '', 'example' => ''], + 'SwitchId' => ['type' => 'string', 'description' => '', 'title' => '', 'example' => ''], + 'SecurityGroupId' => ['type' => 'string', 'description' => '', 'title' => '', 'example' => ''], + 'DefaultRoute' => ['type' => 'string', 'description' => '', 'title' => '', 'example' => ''], + 'DatasetId' => ['type' => 'string', 'description' => '', 'title' => '', 'example' => ''], + 'DatasetType' => ['type' => 'string', 'description' => '', 'title' => '', 'example' => ''], + 'DatasetUri' => ['type' => 'string', 'description' => '', 'title' => '', 'example' => ''], + 'DatasetMountPath' => ['type' => 'string', 'description' => '', 'title' => '', 'example' => ''], + 'DatasetName' => ['type' => 'string', 'description' => '', 'title' => '', 'example' => ''], + 'PredictWorkerCount' => ['type' => 'integer', 'format' => 'int32', 'description' => '', 'title' => '', 'example' => ''], + 'PredictWorkerCpu' => ['type' => 'integer', 'format' => 'int32', 'description' => '', 'title' => '', 'example' => ''], + 'PredictWorkerMemory' => ['type' => 'integer', 'format' => 'int32', 'description' => '', 'title' => '', 'example' => ''], + 'ResourceConfig' => ['type' => 'string', 'description' => '', 'title' => '', 'example' => ''], + ], + 'description' => '', + 'title' => '', + 'example' => '', + ], + 'example' => '', ], ], + 'example' => '', ], ], ], - 'staticInfo' => [ - 'returnType' => 'synchronous', + 'staticInfo' => ['returnType' => 'synchronous'], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"FCF741D8-9C30-578E-807F-B935487DB34A\\",\\n \\"TotalCount\\": 10,\\n \\"FeatureConsistencyCheckConfigs\\": [\\n {\\n \\"FeatureConsistencyCheckJobConfigId\\": \\"3\\",\\n \\"Name\\": \\"feature_consistency_check1\\",\\n \\"SceneId\\": \\"3\\",\\n \\"SceneName\\": \\"scene1\\",\\n \\"Status\\": \\"Editable\\",\\n \\"CompareFeature\\": true,\\n \\"LatestJobId\\": \\"3\\",\\n \\"LatestJobGmtSamplingStartTime\\": \\"2021-12-15T23:24:33.132+08:00\\",\\n \\"LatestJobGmtSamplingEndTime\\": \\"2021-12-15T23:24:33.132+08:00\\",\\n \\"SampleRate\\": \\"0.89\\",\\n \\"FeatureLandingResourceId\\": \\"reso-********\\",\\n \\"FeatureLandingResourceUri\\": \\"mc_project_1\\",\\n \\"EasServiceName\\": \\"eas_service_1\\",\\n \\"FgJsonFileName\\": \\"file.json\\",\\n \\"UserTable\\": \\"user_table\\",\\n \\"UserIdField\\": \\"user_id\\",\\n \\"UserTablePartitionField\\": \\"ds\\",\\n \\"UserTablePartitionFieldFormat\\": \\"yyyymmdd\\",\\n \\"ItemTable\\": \\"item_table\\",\\n \\"ItemIdField\\": \\"item_id\\",\\n \\"ItemTablePartitionField\\": \\"ds\\",\\n \\"ItemTablePartitionFieldFormat\\": \\"yyyymmdd\\",\\n \\"GenerateZip\\": true,\\n \\"ServiceId\\": \\"4\\",\\n \\"ServiceName\\": \\"service1\\",\\n \\"WorkflowName\\": \\"work_flow_1\\",\\n \\"OssResourceId\\": \\"reso-********\\",\\n \\"OssBucket\\": \\"oss_bucket_1\\",\\n \\"EasyRecVersion\\": \\"1.3.60\\",\\n \\"EasyRecPackagePath\\": \\"oss://*******\\",\\n \\"FgJarVersion\\": \\"1.0.0\\",\\n \\"FeaturePriority\\": \\"feature1,feature2,feature3\\",\\n \\"FeatureDisplayExclude\\": \\"feature1,feature2\\",\\n \\"GmtCreateTime\\": \\"2021-12-15T23:24:33.132+08:00\\",\\n \\"GmtModifiedTime\\": \\"2021-12-15T23:24:33.132+08:00\\",\\n \\"UseFeatureStore\\": \\"true\\",\\n \\"FeatureStoreProjectName\\": \\"project-1\\",\\n \\"FeatureStoreModelId\\": \\"2\\\\n\\",\\n \\"FeatureStoreUserId\\": \\"user\\",\\n \\"FeatureStoreItemId\\": \\"item\\",\\n \\"FeatureStoreSeqFeatureView\\": \\"item-1\\",\\n \\"FeatureStoreProjectId\\": \\"prj-01\\",\\n \\"WorkspaceId\\": \\"\\",\\n \\"VpcId\\": \\"\\",\\n \\"SwitchId\\": \\"\\",\\n \\"SecurityGroupId\\": \\"\\",\\n \\"DefaultRoute\\": \\"\\",\\n \\"DatasetId\\": \\"\\",\\n \\"DatasetType\\": \\"\\",\\n \\"DatasetUri\\": \\"\\",\\n \\"DatasetMountPath\\": \\"\\",\\n \\"DatasetName\\": \\"\\",\\n \\"PredictWorkerCount\\": 0,\\n \\"PredictWorkerCpu\\": 0,\\n \\"PredictWorkerMemory\\": 0,\\n \\"ResourceConfig\\": \\"\\"\\n }\\n ]\\n}","type":"json"}]', + 'title' => 'Retrieve the list of feature consistency check job configurations', + 'changeSet' => [ + ['createdAt' => '2025-06-04T10:10:19.000Z', 'description' => 'Response parameters changed'], + ['createdAt' => '2024-12-10T06:00:28.000Z', 'description' => 'Response parameters changed'], + ['createdAt' => '2024-11-12T09:17:26.000Z', 'description' => 'Response parameters changed'], + ['createdAt' => '2024-02-22T03:35:43.000Z', 'description' => 'Response parameters changed'], + ], + 'flowControl' => [ + 'flowControlList' => [], + ], + 'ramActions' => [ + [ + 'operationType' => 'list', + 'ramAction' => [ + 'action' => 'pairec:ListFeatureConsistencyCheckJobConfigs', + 'authLevel' => 'operate', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'PAIRecService', 'resourceType' => 'All Resource', 'arn' => '*'], + ], + ], + ], ], - 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"BBD41FBF-E75C-551A-92FA-CAD654AA006F\\"\\n}","type":"json"}]', ], - 'ListParams' => [ - 'summary' => '获取参数列表。', - 'path' => '/api/v1/params', - 'methods' => [ - 'get', - ], - 'schemes' => [ - 'http', - 'https', - ], + 'ListFeatureConsistencyCheckJobFeatureReports' => [ + 'summary' => 'Lists feature reports for a feature consistency check job.', + 'path' => '/api/v1/featureconsistencycheck/jobs/{FeatureConsistencyCheckJobId}/featurereports', + 'methods' => ['get'], + 'schemes' => ['http', 'https'], 'security' => [ [ 'AK' => [], ], ], - 'consumes' => [ - 'application/json', - ], - 'produces' => [ - 'application/json', - ], + 'consumes' => ['application/json'], + 'produces' => ['application/json'], 'operationType' => 'read', 'deprecated' => false, 'systemTags' => [ 'operationType' => 'list', 'riskType' => 'none', 'chargeType' => 'free', - 'abilityTreeNodes' => [ - 'FEATURElearnN0NAWV', - ], + 'abilityTreeNodes' => ['FEATURElearnN0NAWV'], ], 'parameters' => [ [ - 'name' => 'SceneId', - 'in' => 'query', - 'schema' => [ - 'title' => '场景ID。', - 'description' => '', - 'type' => 'string', - 'required' => true, - 'example' => '3', - ], + 'name' => 'FeatureConsistencyCheckJobId', + 'in' => 'path', + 'schema' => ['description' => 'The ID of the feature consistency check job. To obtain the ID, see [ListFeatureConsistencyCheckJobs](~~2557571~~).', 'type' => 'string', 'required' => true, 'example' => '3', 'title' => ''], ], [ - 'name' => 'Name', + 'name' => 'InstanceId', 'in' => 'query', - 'schema' => [ - 'title' => '参数名称。', - 'description' => '', - 'type' => 'string', - 'required' => false, - 'example' => 'home', - ], + 'schema' => ['description' => 'The ID of the instance. To obtain the ID, see [ListInstances](~~2411819~~).', 'type' => 'string', 'required' => true, 'example' => 'pairec-cn-********', 'title' => ''], ], [ - 'name' => 'Environment', + 'name' => 'LogUserId', 'in' => 'query', - 'schema' => [ - 'title' => '参数所属的环境。'."\n" - .'● Daily-日常环境'."\n" - .'● Pre-预发环境'."\n" - .'● Prod-生产环境', - 'description' => '', - 'type' => 'string', - 'required' => false, - 'example' => 'Daily', - ], + 'schema' => ['description' => 'The user ID used for feature comparison.', 'type' => 'string', 'required' => true, 'example' => '1010', 'title' => ''], ], [ - 'name' => 'PageNumber', + 'name' => 'LogItemId', 'in' => 'query', - 'schema' => [ - 'title' => '页码。', - 'description' => '', - 'type' => 'integer', - 'format' => 'int32', - 'required' => false, - 'example' => '1', - ], + 'schema' => ['description' => 'The item ID used for feature comparison.', 'type' => 'string', 'required' => true, 'example' => '9010', 'title' => ''], ], [ - 'name' => 'PageSize', + 'name' => 'LogRequestId', 'in' => 'query', + 'schema' => ['description' => 'The request ID used for feature comparison.', 'type' => 'string', 'required' => true, 'example' => 'F7AC05FF-EDE7-5C2B-B9AE-33D6DF4178BA', 'title' => ''], + ], + ], + 'responses' => [ + 200 => [ 'schema' => [ - 'title' => '页大小。', - 'description' => '', - 'type' => 'integer', - 'format' => 'int32', - 'required' => false, - 'example' => '50', + 'title' => 'Schema of Response', + 'description' => 'The data returned.', + 'type' => 'object', + 'properties' => [ + 'RequestId' => ['title' => 'Id of the request', 'description' => 'The request ID.', 'type' => 'string', 'example' => 'BBD41FBF-E75C-551A-92FA-CAD654AA006F'], + 'ReportsOfFeatureDiff' => [ + 'title' => '', + 'description' => 'The feature comparison reports.', + 'type' => 'array', + 'items' => [ + 'title' => '', + 'description' => '', + 'type' => 'object', + 'properties' => [ + 'LogUserId' => ['description' => 'The user ID.', 'type' => 'string', 'example' => '1010', 'title' => ''], + 'LogItemId' => ['description' => 'The item ID.', 'type' => 'string', 'example' => '9010', 'title' => ''], + 'LogRequestId' => ['description' => 'The request ID.', 'type' => 'string', 'example' => 'F7AC05FF-EDE7-5C2B-B9AE-33D6DF4178BA', 'title' => ''], + 'FeatureName' => ['description' => 'The feature name.', 'type' => 'string', 'example' => 'gender', 'title' => ''], + 'OfflineValue' => ['description' => 'The offline value.', 'type' => 'string', 'example' => 'male', 'title' => ''], + 'OnlineValue' => ['description' => 'The online value.', 'type' => 'string', 'example' => 'male', 'title' => ''], + ], + 'example' => '', + ], + 'example' => '', + ], + 'DataPath' => ['description' => 'The data path.', 'type' => 'string', 'example' => 'https://********', 'title' => ''], + 'OssPath' => ['description' => 'The OSS path.', 'type' => 'string', 'example' => 'oss://********', 'title' => ''], + ], + 'example' => '', ], ], + ], + 'staticInfo' => ['returnType' => 'synchronous'], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"BBD41FBF-E75C-551A-92FA-CAD654AA006F\\",\\n \\"ReportsOfFeatureDiff\\": [\\n {\\n \\"LogUserId\\": \\"1010\\",\\n \\"LogItemId\\": \\"9010\\",\\n \\"LogRequestId\\": \\"F7AC05FF-EDE7-5C2B-B9AE-33D6DF4178BA\\",\\n \\"FeatureName\\": \\"gender\\",\\n \\"OfflineValue\\": \\"male\\",\\n \\"OnlineValue\\": \\"male\\"\\n }\\n ],\\n \\"DataPath\\": \\"https://********\\",\\n \\"OssPath\\": \\"oss://********\\"\\n}","type":"json"}]', + 'title' => 'Obtain the feature report of a feature consistency check job.', + 'changeSet' => [], + 'flowControl' => [ + 'flowControlList' => [], + ], + 'ramActions' => [ + [ + 'operationType' => 'list', + 'ramAction' => [ + 'action' => 'pairec:ListFeatureConsistencyCheckJobFeatureReports', + 'authLevel' => 'operate', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'PAIRecService', 'resourceType' => 'All Resource', 'arn' => '*'], + ], + ], + ], + ], + ], + 'ListFeatureConsistencyCheckJobScoreReports' => [ + 'summary' => 'Retrieves the score difference reports for a feature consistency check job.', + 'path' => '/api/v1/featureconsistencycheck/jobs/{FeatureConsistencyCheckJobId}/scorereports', + 'methods' => ['get'], + 'schemes' => ['http', 'https'], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'consumes' => ['application/json'], + 'produces' => ['application/json'], + 'operationType' => 'read', + 'deprecated' => false, + 'systemTags' => [ + 'operationType' => 'list', + 'riskType' => 'none', + 'chargeType' => 'free', + 'abilityTreeNodes' => ['FEATURElearnN0NAWV'], + ], + 'parameters' => [ + [ + 'name' => 'FeatureConsistencyCheckJobId', + 'in' => 'path', + 'schema' => ['description' => 'The ID of the feature consistency check job. To obtain the job ID, see [ListFeatureConsistencyCheckJobs](~~2557561~~).', 'type' => 'string', 'required' => true, 'example' => '3', 'title' => ''], + ], [ 'name' => 'InstanceId', 'in' => 'query', - 'schema' => [ - 'title' => '实例ID。', - 'description' => '', - 'type' => 'string', - 'required' => true, - 'example' => 'pairec-cn-abcdefg1234', - ], + 'schema' => ['description' => 'The ID of the instance. To obtain the instance ID, see [ListInstances](~~2411819~~).', 'type' => 'string', 'example' => 'pairec-cn-********', 'title' => '', 'required' => false], ], [ - 'name' => 'Encrypted', + 'name' => 'ExcludeRequestIds', 'in' => 'query', + 'style' => 'json', 'schema' => [ - 'type' => 'boolean', + 'title' => '', + 'description' => 'A list of request IDs to exclude from the feature comparison.', + 'type' => 'array', + 'items' => ['description' => 'The request ID.', 'type' => 'string', 'required' => false, 'example' => '728C5E01-ABF6-5AA8-B9FC-B3BA05DECC77', 'title' => ''], + 'required' => false, + 'example' => '', ], ], ], @@ -10122,1774 +10695,2690 @@ 200 => [ 'schema' => [ 'title' => 'Schema of Response', - 'description' => 'Schema of Response', + 'description' => 'The returned data.', 'type' => 'object', 'properties' => [ - 'RequestId' => [ - 'title' => 'Id of the request', - 'description' => 'Id of the request', - 'type' => 'string', - 'example' => 'A2D07551-38DA-531E-9B22-877D1D86A579', - ], - 'TotalCount' => [ - 'title' => '列表内元素总数。', - 'description' => '', - 'type' => 'integer', - 'format' => 'int64', - 'example' => '10', - ], - 'Params' => [ - 'title' => '参数列表。', - 'description' => '', + 'RequestId' => ['title' => 'Id of the request', 'description' => 'The ID of the request.', 'type' => 'string', 'example' => 'F0AB6527-093F-5C44-B3BD-42C8C210C619'], + 'ReportsOfScoreDiff' => [ + 'title' => '', + 'description' => 'A list of score difference reports.', 'type' => 'array', 'items' => [ 'type' => 'object', 'properties' => [ - 'ParamId' => [ - 'title' => '参数ID。', - 'description' => '', - 'type' => 'string', - 'example' => '4', - ], - 'Name' => [ - 'title' => '参数名称。', - 'description' => '', - 'type' => 'string', - 'example' => 'home', - ], - 'Value' => [ - 'title' => '参数值。', - 'description' => '', - 'type' => 'string', - 'example' => 'house', - ], - 'Environment' => [ - 'title' => '参数所属的环境。'."\n" - .'● Daily-日常环境'."\n" - .'● Prepub-预发环境'."\n" - .'● Product-生产环境', - 'description' => '', - 'type' => 'string', - 'example' => 'Daily', - ], - 'GmtModifiedTime' => [ - 'title' => '更新时间。', - 'description' => '', - 'type' => 'string', - 'example' => '2021-12-15T23:24:33.132+08:00', - ], + 'LogUserId' => ['description' => 'The user ID.', 'type' => 'string', 'example' => '3', 'title' => ''], + 'LogItemId' => ['description' => 'The item ID.', 'type' => 'string', 'example' => '4', 'title' => ''], + 'LogRequestId' => ['description' => 'The request ID recorded in the log.', 'type' => 'string', 'example' => '323', 'title' => ''], + 'ScoreDiff' => ['description' => 'The score difference.', 'type' => 'string', 'example' => '0.00000234', 'title' => ''], + 'ScoreDiffDetail' => ['description' => 'The score difference details.', 'type' => 'string', 'example' => '{}', 'title' => ''], ], + 'description' => '', + 'title' => '', + 'example' => '', ], + 'example' => '', ], + 'DataPath' => ['description' => 'The data path.', 'type' => 'string', 'title' => '', 'example' => 'http://*******'], + 'OssPath' => ['description' => 'The OSS path.', 'type' => 'string', 'title' => '', 'example' => 'oss://********'], ], + 'example' => '', ], ], ], - 'staticInfo' => [ - 'returnType' => 'synchronous', + 'staticInfo' => ['returnType' => 'synchronous'], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"F0AB6527-093F-5C44-B3BD-42C8C210C619\\",\\n \\"ReportsOfScoreDiff\\": [\\n {\\n \\"LogUserId\\": \\"3\\",\\n \\"LogItemId\\": \\"4\\",\\n \\"LogRequestId\\": \\"323\\",\\n \\"ScoreDiff\\": \\"0.00000234\\",\\n \\"ScoreDiffDetail\\": \\"{}\\"\\n }\\n ],\\n \\"DataPath\\": \\"http://*******\\",\\n \\"OssPath\\": \\"oss://********\\"\\n}","type":"json"}]', + 'title' => 'Obtain the feature consistency check job score report', + 'changeSet' => [], + 'flowControl' => [ + 'flowControlList' => [], + ], + 'ramActions' => [ + [ + 'operationType' => 'list', + 'ramAction' => [ + 'action' => 'pairec:ListFeatureConsistencyCheckJobScoreReports', + 'authLevel' => 'operate', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'PAIRecService', 'resourceType' => 'All Resource', 'arn' => '*'], + ], + ], + ], ], - 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"A2D07551-38DA-531E-9B22-877D1D86A579\\",\\n \\"TotalCount\\": 10,\\n \\"Params\\": [\\n {\\n \\"ParamId\\": \\"4\\",\\n \\"Name\\": \\"home\\",\\n \\"Value\\": \\"house\\",\\n \\"Environment\\": \\"Daily\\",\\n \\"GmtModifiedTime\\": \\"2021-12-15T23:24:33.132+08:00\\"\\n }\\n ]\\n}","type":"json"}]', ], - 'CreateCrowd' => [ - 'summary' => '创建人群。', - 'path' => '/api/v1/crowds', - 'methods' => [ - 'post', - ], - 'schemes' => [ - 'http', - 'https', - ], + 'ListFeatureConsistencyCheckJobs' => [ + 'summary' => 'Retrieves a list of feature consistency check jobs.', + 'path' => '/api/v1/featureconsistencycheck/jobs', + 'methods' => ['get'], + 'schemes' => ['http', 'https'], 'security' => [ [ 'AK' => [], ], ], - 'consumes' => [ - 'application/json', - ], - 'produces' => [ - 'application/json', - ], - 'operationType' => 'write', + 'consumes' => ['application/json'], + 'produces' => ['application/json'], + 'operationType' => 'read', 'deprecated' => false, 'systemTags' => [ - 'operationType' => 'create', + 'operationType' => 'get', 'riskType' => 'none', 'chargeType' => 'free', - 'abilityTreeNodes' => [ - 'FEATURElearnN0NAWV', - ], + 'abilityTreeNodes' => ['FEATURElearnN0NAWV'], ], 'parameters' => [ [ - 'name' => 'body', - 'in' => 'body', - 'style' => 'json', + 'name' => 'InstanceId', + 'in' => 'query', + 'schema' => ['description' => 'The instance ID. To obtain the instance ID, see [ListInstances](~~2411819~~).', 'type' => 'string', 'required' => true, 'example' => 'pairec-cn-********', 'title' => ''], + ], + [ + 'name' => 'PageNumber', + 'in' => 'query', + 'schema' => ['description' => 'The page number.', 'type' => 'string', 'example' => '1', 'title' => '', 'required' => false], + ], + [ + 'name' => 'PageSize', + 'in' => 'query', + 'schema' => ['description' => 'The page size.', 'type' => 'string', 'example' => '10', 'title' => '', 'required' => false], + ], + [ + 'name' => 'SortBy', + 'in' => 'query', + 'schema' => ['description' => 'The field to sort the results by. Valid values:'."\n" + ."\n" + .'- `GmtCreateTime`: Sorts by creation time.'."\n" + ."\n" + .'- `GmtModifiedTime`: Sorts by modification time.', 'type' => 'string', 'example' => 'GmtCreateTime', 'title' => '', 'required' => false], + ], + [ + 'name' => 'Order', + 'in' => 'query', + 'schema' => ['description' => 'The sort order. Valid values:'."\n" + ."\n" + .'- `ASC`: Ascending order.'."\n" + ."\n" + .'- `DESC`: Descending order.', 'type' => 'string', 'example' => 'ASC', 'title' => '', 'required' => false], + ], + [ + 'name' => 'Status', + 'in' => 'query', + 'schema' => ['description' => 'The status of the job. Valid values:'."\n" + ."\n" + .'- `ToRun`: Waiting to run.'."\n" + ."\n" + .'- `Running`: In progress.'."\n" + ."\n" + .'- `Success`: Successful.'."\n" + ."\n" + .'- `Failure`: Failed.'."\n" + ."\n" + .'- `Stopped`: Stopped or canceled.', 'type' => 'string', 'example' => 'Running', 'title' => '', 'required' => false], + ], + ], + 'responses' => [ + 200 => [ 'schema' => [ - 'title' => '请求body。', - 'description' => '', + 'title' => 'Schema of Response', + 'description' => 'The response schema.', 'type' => 'object', 'properties' => [ - 'InstanceId' => [ - 'title' => '实例ID。', - 'description' => '', - 'type' => 'string', - 'required' => true, - 'example' => 'pairec-cn-abcdefg1234', - ], - 'Name' => [ - 'title' => '人群名称。', - 'description' => '', - 'type' => 'string', - 'required' => true, - 'example' => 'xx人群', - ], - 'Description' => [ - 'title' => '人群描述。', - 'description' => '', - 'type' => 'string', - 'required' => true, - 'example' => 'This is a test.', - ], - 'Label' => [ - 'title' => '人群标签。', - 'description' => '', - 'type' => 'string', - 'required' => false, - 'example' => 'os=android', - ], - 'Source' => [ - 'title' => '人群来源。'."\n" - .'● ManualInput-手工输入'."\n" - .'● UploadFile-文件上传', - 'description' => '', - 'type' => 'string', - 'required' => false, - 'example' => 'ManualInput', - ], - 'Users' => [ - 'title' => '人群中包含的用户，多个用户间用逗号隔开。', - 'description' => '', - 'type' => 'string', - 'required' => false, - 'example' => 'user1,user2,user3', + 'RequestId' => ['title' => 'Id of the request', 'description' => 'The request ID.', 'type' => 'string', 'example' => 'A04CB8C0-E74A-5E83-BC61-64D153574EC7'], + 'TotalCount' => ['description' => 'The total number of jobs.', 'type' => 'string', 'example' => '10', 'title' => ''], + 'FeatureConsistencyCheckJobs' => [ + 'title' => '', + 'description' => 'The list of feature consistency check jobs.', + 'type' => 'array', + 'items' => [ + 'type' => 'object', + 'properties' => [ + 'FeatureConsistencyCheckJobId' => ['description' => 'The ID of the feature consistency check job.', 'type' => 'string', 'example' => '4', 'title' => ''], + 'FeatureConsistencyCheckJobConfigId' => ['description' => 'The ID of the feature consistency check configuration.', 'type' => 'string', 'example' => '5', 'title' => ''], + 'FeatureConsistencyCheckJobConfigName' => ['description' => 'The name of the feature consistency check job configuration.', 'type' => 'string', 'example' => 'feature_consistency_check_1', 'title' => ''], + 'GmtStartTime' => ['description' => 'The start time of the job.', 'type' => 'string', 'example' => '2021-12-15T23:24:33.132+08:00', 'title' => ''], + 'GmtEndTime' => ['description' => 'The end time of the job.', 'type' => 'string', 'example' => '2021-12-15T23:24:33.132+08:00', 'title' => ''], + 'Status' => ['description' => 'The status of the job. Valid values:'."\n" + ."\n" + .'- `ToRun`: Waiting to run.'."\n" + ."\n" + .'- `Running`: In progress.'."\n" + ."\n" + .'- `Success`: Successful.'."\n" + ."\n" + .'- `Failure`: Failed.'."\n" + ."\n" + .'- `Stopped`: Stopped or canceled.', 'type' => 'string', 'example' => 'Running', 'title' => ''], + 'Config' => ['description' => 'The configuration of the job.', 'type' => 'string', 'example' => '{}', 'title' => ''], + 'Logs' => [ + 'title' => '', + 'description' => 'A list of log entries.', + 'type' => 'array', + 'items' => ['description' => 'A log entry.', 'type' => 'string', 'example' => '2022/09/26 02:16:24 INFO: job status: Created', 'title' => ''], + 'example' => '', + ], + ], + 'description' => '', + 'title' => '', + 'example' => '', + ], + 'example' => '', ], ], - 'required' => false, + 'example' => '', ], ], ], + 'staticInfo' => ['returnType' => 'synchronous'], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"A04CB8C0-E74A-5E83-BC61-64D153574EC7\\",\\n \\"TotalCount\\": \\"10\\",\\n \\"FeatureConsistencyCheckJobs\\": [\\n {\\n \\"FeatureConsistencyCheckJobId\\": \\"4\\",\\n \\"FeatureConsistencyCheckJobConfigId\\": \\"5\\",\\n \\"FeatureConsistencyCheckJobConfigName\\": \\"feature_consistency_check_1\\",\\n \\"GmtStartTime\\": \\"2021-12-15T23:24:33.132+08:00\\",\\n \\"GmtEndTime\\": \\"2021-12-15T23:24:33.132+08:00\\",\\n \\"Status\\": \\"Running\\",\\n \\"Config\\": \\"{}\\",\\n \\"Logs\\": [\\n \\"2022/09/26 02:16:24 INFO: job status: Created\\"\\n ]\\n }\\n ]\\n}","type":"json"}]', + 'title' => 'Retrieve the feature consistency check job list ', + 'changeSet' => [], + 'flowControl' => [ + 'flowControlList' => [], + ], + 'ramActions' => [ + [ + 'operationType' => 'get', + 'ramAction' => [ + 'action' => 'pairec:ListFeatureConsistencyCheckJobs', + 'authLevel' => 'operate', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'PAIRecService', 'resourceType' => 'All Resource', 'arn' => '*'], + ], + ], + ], + ], + ], + 'ListInstanceResourceSchemas' => [ + 'path' => '/api/v1/instances/{InstanceId}/resources/{ResourceId}/schemas', + 'methods' => ['get'], + 'schemes' => ['https'], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'consumes' => ['application/json'], + 'produces' => ['application/json'], + 'operationType' => 'read', + 'deprecated' => false, + 'systemTags' => [ + 'operationType' => 'none', + 'riskType' => 'none', + 'chargeType' => 'free', + 'abilityTreeNodes' => ['FEATURElearnN0NAWV'], + ], + 'parameters' => [ + [ + 'name' => 'InstanceId', + 'in' => 'path', + 'schema' => ['description' => 'The instance ID.', 'type' => 'string', 'required' => false, 'example' => 'featureStore-cn-test1', 'title' => ''], + ], + [ + 'name' => 'ResourceId', + 'in' => 'path', + 'schema' => ['description' => 'The resource ID.', 'type' => 'string', 'required' => false, 'example' => '3', 'title' => ''], + ], + [ + 'name' => 'SchemaName', + 'in' => 'query', + 'schema' => ['description' => 'Filters schemas by a name prefix.', 'type' => 'string', 'required' => false, 'example' => 'default', 'title' => ''], + ], + ], 'responses' => [ 200 => [ 'schema' => [ + 'description' => 'The data returned in the response.', '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' => '59CE7EC6-F268-5D71-9215-32922CC50D72', - ], - 'CrowdId' => [ - 'title' => '人群ID。', - 'description' => '', - 'type' => 'string', - 'example' => '3', + 'RequestId' => ['title' => 'Id of the request', 'description' => 'The request ID.', 'type' => 'string', 'example' => '728C5E01-ABF6-5AA8-B9FC-B3BA05DECC77'], + 'TotalCount' => ['description' => 'The total count of schemas.', 'type' => 'integer', 'format' => 'int64', 'example' => '10', 'title' => ''], + 'Schemas' => [ + 'description' => 'The list of schemas.', + 'type' => 'array', + 'items' => [ + 'description' => '', + 'type' => 'object', + 'properties' => [ + 'SchemaName' => ['description' => 'The schema name.', 'type' => 'string', 'example' => 'default', 'title' => ''], + ], + 'title' => '', + 'example' => '', + ], + 'title' => '', + 'example' => '', ], ], + 'example' => '', ], ], ], - 'staticInfo' => [ - 'returnType' => 'synchronous', + 'staticInfo' => ['returnType' => 'synchronous'], + 'title' => 'Retrieve Schemas Under an Instance Resource', + 'summary' => 'Lists all schemas for a specified resource in an instance.', + 'description' => '## Description'."\n" + ."\n" + .'To retrieve a list of all schemas for a specified resource, provide the instance ID (InstanceId) and resource ID (ResourceId). Use the optional SchemaName parameter to filter the schemas by a name prefix.', + 'changeSet' => [], + 'flowControl' => [ + 'flowControlList' => [], ], - 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"59CE7EC6-F268-5D71-9215-32922CC50D72\\",\\n \\"CrowdId\\": \\"3\\"\\n}","type":"json"}]', - ], - 'CreateSubCrowd' => [ - 'summary' => '在指定人群下创建子人群。', - 'path' => '/api/v1/crowds/{CrowdId}/subcrowds', - 'methods' => [ - 'post', - ], - 'schemes' => [ - 'http', - 'https', + 'ramActions' => [ + [ + 'operationType' => 'none', + 'ramAction' => [ + 'action' => 'pairec:ListInstanceResourceSchemas', + 'authLevel' => 'operate', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'PAIRecService', 'resourceType' => 'All Resource', 'arn' => '*'], + ], + ], + ], ], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"728C5E01-ABF6-5AA8-B9FC-B3BA05DECC77\\",\\n \\"TotalCount\\": 10,\\n \\"Schemas\\": [\\n {\\n \\"SchemaName\\": \\"default\\"\\n }\\n ]\\n}","type":"json"}]', + ], + 'ListInstanceResourceTables' => [ + 'path' => '/api/v1/instances/{InstanceId}/resources/{ResourceId}/tables', + 'methods' => ['get'], + 'schemes' => ['http', 'https'], 'security' => [ [ 'AK' => [], ], ], - 'consumes' => [ - 'application/json', - ], - 'produces' => [ - 'application/json', - ], - 'operationType' => 'write', + 'consumes' => ['application/json'], + 'produces' => ['application/json'], + 'operationType' => 'read', 'deprecated' => false, 'systemTags' => [ - 'operationType' => 'create', + 'operationType' => 'list', 'riskType' => 'none', 'chargeType' => 'free', - 'abilityTreeNodes' => [ - 'FEATURElearnN0NAWV', - ], + 'abilityTreeNodes' => ['FEATURElearnN0NAWV'], ], 'parameters' => [ [ - 'name' => 'CrowdId', + 'name' => 'InstanceId', 'in' => 'path', - 'schema' => [ - 'title' => '人群ID。', - 'description' => '', - 'type' => 'string', - 'required' => true, - 'example' => '3', - ], + 'schema' => ['description' => 'The instance ID.', 'type' => 'string', 'required' => false, 'example' => 'pairec-cn-xxx', 'title' => ''], ], [ - 'name' => 'body', - 'in' => 'body', - 'style' => 'json', + 'name' => 'ResourceId', + 'in' => 'path', + 'schema' => ['description' => 'The data source ID.', 'type' => 'string', 'required' => false, 'example' => 'reso-*********', 'title' => ''], + ], + [ + 'name' => 'MaxcomputeSchema', + 'in' => 'query', + 'schema' => ['description' => 'The MaxCompute schema.', 'type' => 'string', 'required' => false, 'example' => 'jackal', 'title' => ''], + ], + ], + 'responses' => [ + 200 => [ 'schema' => [ - 'title' => '请求body。', - 'description' => '', + 'description' => 'The response object.', + 'title' => 'Schema of Response', 'type' => 'object', 'properties' => [ - 'Source' => [ - 'title' => '人群来源。'."\n" - .'● ManualInput-手工输入'."\n" - .'● UploadFile-文件上传', - 'description' => '', - 'type' => 'string', - 'required' => true, - 'example' => 'ManualInput', - ], - 'Users' => [ - 'title' => '人群中包含的用户，多个用户间用逗号隔开。', - 'description' => '', - 'type' => 'string', - 'required' => true, - 'example' => 'user1,user2,user3', - ], - 'InstanceId' => [ - 'title' => '实例ID。', - 'description' => '', - 'type' => 'string', - 'required' => true, - 'example' => 'pairec-test1', + 'RequestId' => ['title' => 'ID of the request', 'description' => 'The ID of the request.', 'type' => 'string', 'example' => '01D22D08-BA20-5F35-8302-99115F288220'], + 'TotalCount' => ['description' => 'The total count of data tables.', 'type' => 'string', 'example' => '30', 'title' => ''], + 'Tables' => [ + 'description' => 'A list of data tables.', + 'type' => 'array', + 'items' => [ + 'description' => 'The details of a data table.', + 'type' => 'object', + 'properties' => [ + 'TableName' => ['description' => 'The table name.', 'type' => 'string', 'example' => 'table-1', 'title' => ''], + ], + 'title' => '', + 'example' => '', + ], + 'title' => '', + 'example' => '', ], ], - 'required' => false, + 'example' => '', + ], + ], + ], + 'staticInfo' => ['returnType' => 'synchronous'], + 'title' => 'Retrieve the List of Data Tables Under an Instance Resource', + 'summary' => 'Retrieves a list of data tables for a specified instance and data source.', + 'description' => '## Description'."\n" + ."\n" + .'Provide the instance ID (InstanceId) and data source ID (ResourceId) to retrieve a list of data tables from the specified data source. Use the optional `MaxcomputeSchema` parameter to filter the results by a MaxCompute schema.', + 'changeSet' => [], + 'flowControl' => [ + 'flowControlList' => [], + ], + 'ramActions' => [ + [ + 'operationType' => 'list', + 'ramAction' => [ + 'action' => 'pairec:ListInstanceResourceTables', + 'authLevel' => 'operate', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'PAIRecService', 'resourceType' => 'All Resource', 'arn' => '*'], + ], ], ], ], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"01D22D08-BA20-5F35-8302-99115F288220\\",\\n \\"TotalCount\\": \\"30\\",\\n \\"Tables\\": [\\n {\\n \\"TableName\\": \\"table-1\\"\\n }\\n ]\\n}","type":"json"}]', + ], + 'ListInstanceResources' => [ + 'summary' => 'Lists the resources configured for an instance.', + 'path' => '/api/v1/instances/{InstanceId}/resources', + 'methods' => ['get'], + 'schemes' => ['http', 'https'], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'consumes' => ['application/json'], + 'produces' => ['application/json'], + 'operationType' => 'read', + 'deprecated' => false, + 'systemTags' => [ + 'operationType' => 'list', + 'riskType' => 'none', + 'chargeType' => 'free', + 'abilityTreeNodes' => ['FEATURElearnN0NAWV'], + ], + 'parameters' => [ + [ + 'name' => 'InstanceId', + 'in' => 'path', + 'schema' => ['description' => 'The instance ID. You can obtain the instance ID by calling the [ListInstances](~~2411819~~) operation.', 'type' => 'string', 'required' => true, 'example' => 'pairec-cn-test1', 'title' => ''], + ], + [ + 'name' => 'Category', + 'in' => 'query', + 'schema' => ['description' => 'The category of the resource. Valid values:'."\n" + ."\n" + .'- DataManagement'."\n" + ."\n" + .'- Engine'."\n" + ."\n" + .'- Monitor', 'type' => 'string', 'required' => false, 'example' => 'DataManagement', 'title' => ''], + ], + [ + 'name' => 'Group', + 'in' => 'query', + 'schema' => ['description' => 'The group of the resource.'."\n" + ."\n" + .'If `Category` is `DataManagement`, valid values are:'."\n" + ."\n" + .'- storage'."\n" + ."\n" + .'- modelpipeline'."\n" + ."\n" + .'- datastorage'."\n" + ."\n" + .'- modeltrain'."\n" + ."\n" + .'If `Category` is `Engine`, valid values are:'."\n" + ."\n" + .'- feature'."\n" + ."\n" + .'- predict'."\n" + ."\n" + .'- recall'."\n" + ."\n" + .'- recengine'."\n" + ."\n" + .'If `Category` is `Monitor`, valid values are:'."\n" + ."\n" + .'- logs'."\n" + ."\n" + .'- logsback'."\n" + ."\n" + .'- coldstart'."\n" + ."\n" + .'- deploy', 'type' => 'string', 'required' => false, 'example' => 'storage', 'title' => ''], + ], + [ + 'name' => 'Type', + 'in' => 'query', + 'schema' => ['description' => 'The type of the resource. If specified, only resources of this type are returned.'."\n" + ."\n" + .'- Hologres'."\n" + ."\n" + .'- EAS'."\n" + ."\n" + .'- BE'."\n" + ."\n" + .'- Rec'."\n" + ."\n" + .'- Platform'."\n" + ."\n" + .'- SLS'."\n" + ."\n" + .'- DataHub'."\n" + ."\n" + .'- ApsaraMQ for Kafka'."\n" + ."\n" + .'- Realtime Compute for Apache Flink'."\n" + ."\n" + .'- ACR'."\n" + ."\n" + .'- OSS'."\n" + ."\n" + .'- DataWorks'."\n" + ."\n" + .'- PAI'."\n" + ."\n" + .'- MaxCompute'."\n" + ."\n" + .'- Graph Compute Service'."\n" + ."\n" + .'- ApsaraDB for Redis', 'type' => 'string', 'required' => false, 'example' => 'OSS', 'title' => ''], + ], + ], 'responses' => [ 200 => [ 'schema' => [ 'title' => 'Schema of Response', - 'description' => 'Schema of Response', + 'description' => 'The response object.', 'type' => 'object', 'properties' => [ - 'RequestId' => [ - 'title' => 'Id of the request', - 'description' => 'Id of the request', - 'type' => 'string', - 'example' => '9763624B-5FBB-5E3A-9193-B1ADB554CEAE', - ], - 'SubCrowdId' => [ - 'title' => '子人群ID。', - 'description' => '', - 'type' => 'string', - 'example' => '3', + 'RequestId' => ['title' => 'Id of the request', 'description' => 'The request ID.', 'type' => 'string', 'example' => '9763624B-5FBB-5E3A-9193-B1ADB554CEAE'], + 'TotalCount' => ['description' => 'The total number of resources.', 'type' => 'integer', 'format' => 'int64', 'example' => '10', 'title' => ''], + 'Resources' => [ + 'description' => 'A list of resource objects.', + 'type' => 'array', + 'items' => [ + 'description' => 'The details of a resource.', + 'type' => 'object', + 'properties' => [ + 'ResourceId' => ['description' => 'The resource ID.', 'type' => 'string', 'example' => 'reso-2s416t***'."\n", 'title' => ''], + 'Category' => ['description' => 'The category of the resource. Valid values:'."\n" + ."\n" + .'- DataManagement'."\n" + ."\n" + .'- Engine'."\n" + ."\n" + .'- Monitor', 'type' => 'string', 'example' => 'DataManagement', 'title' => ''], + 'Group' => ['description' => 'The group of the resource.'."\n" + ."\n" + .'If `Category` is `DataManagement`, valid values are:'."\n" + ."\n" + .'- storage'."\n" + ."\n" + .'- modelpipeline'."\n" + ."\n" + .'- datastorage'."\n" + ."\n" + .'- modeltrain'."\n" + ."\n" + .'If `Category` is `Engine`, valid values are:'."\n" + ."\n" + .'- feature'."\n" + ."\n" + .'- predict'."\n" + ."\n" + .'- recall'."\n" + ."\n" + .'- recengine'."\n" + ."\n" + .'If `Category` is `Monitor`, valid values are:'."\n" + ."\n" + .'- logs'."\n" + ."\n" + .'- logsback'."\n" + ."\n" + .'- coldstart'."\n" + ."\n" + .'- deploy', 'type' => 'string', 'example' => 'storage', 'title' => ''], + 'Type' => ['description' => 'The type of the resource.'."\n" + ."\n" + .'- Hologres'."\n" + ."\n" + .'- EAS'."\n" + ."\n" + .'- BE'."\n" + ."\n" + .'- Rec'."\n" + ."\n" + .'- Platform'."\n" + ."\n" + .'- SLS'."\n" + ."\n" + .'- DataHub'."\n" + ."\n" + .'- ApsaraMQ for Kafka'."\n" + ."\n" + .'- Realtime Compute for Apache Flink'."\n" + ."\n" + .'- ACR'."\n" + ."\n" + .'- OSS'."\n" + ."\n" + .'- DataWorks'."\n" + ."\n" + .'- PAI'."\n" + ."\n" + .'- MaxCompute'."\n" + ."\n" + .'- Graph Compute Service'."\n" + ."\n" + .'- ApsaraDB for Redis', 'type' => 'string', 'example' => 'OSS', 'title' => ''], + 'Uri' => ['description' => 'The resource URI.', 'type' => 'string', 'example' => 'bucket-test-123', 'title' => ''], + 'Config' => ['description' => 'The configuration of the resource.', 'type' => 'string', 'example' => '{}', 'title' => ''], + 'GmtCreateAt' => ['description' => 'The creation time.', 'type' => 'string', 'example' => '2020-10-13 17:34:52'."\n", 'title' => ''], + 'GmtModifiedAt' => ['description' => 'The update time.', 'type' => 'string', 'example' => '2020-10-13 17:34:52'."\n", 'title' => ''], + ], + 'title' => '', + 'example' => '', + ], + 'title' => '', + 'example' => '', ], ], + 'example' => '', ], ], ], - 'staticInfo' => [ - 'returnType' => 'synchronous', + 'staticInfo' => ['returnType' => 'synchronous'], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"9763624B-5FBB-5E3A-9193-B1ADB554CEAE\\",\\n \\"TotalCount\\": 10,\\n \\"Resources\\": [\\n {\\n \\"ResourceId\\": \\"reso-2s416t***\\\\n\\",\\n \\"Category\\": \\"DataManagement\\",\\n \\"Group\\": \\"storage\\",\\n \\"Type\\": \\"OSS\\",\\n \\"Uri\\": \\"bucket-test-123\\",\\n \\"Config\\": \\"{}\\",\\n \\"GmtCreateAt\\": \\"2020-10-13 17:34:52\\\\n\\",\\n \\"GmtModifiedAt\\": \\"2020-10-13 17:34:52\\\\n\\"\\n }\\n ]\\n}","type":"json"}]', + 'title' => 'List resources', + 'changeSet' => [ + ['createdAt' => '2024-02-22T03:35:44.000Z', 'description' => 'Request parameters changed'], + ], + 'flowControl' => [ + 'flowControlList' => [], + ], + 'ramActions' => [ + [ + 'operationType' => 'list', + 'ramAction' => [ + 'action' => 'pairec:ListInstanceResources', + 'authLevel' => 'operate', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'PAIRecService', 'resourceType' => 'All Resource', 'arn' => '*'], + ], + ], + ], ], - 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"9763624B-5FBB-5E3A-9193-B1ADB554CEAE\\",\\n \\"SubCrowdId\\": \\"3\\"\\n}","type":"json"}]', ], - 'DeleteCrowd' => [ - 'summary' => '删除指定人群。', - 'path' => '/api/v1/crowds/{CrowdId}', - 'methods' => [ - 'delete', - ], - 'schemes' => [ - 'http', - 'https', - ], + 'ListInstances' => [ + 'summary' => 'Gets a list of PAIRec instances.', + 'path' => '/api/v1/instances', + 'methods' => ['get'], + 'schemes' => ['http', 'https'], 'security' => [ [ 'AK' => [], ], ], - 'consumes' => [ - 'application/json', - ], - 'produces' => [ - 'application/json', - ], - 'operationType' => 'write', + 'consumes' => ['application/json'], + 'produces' => ['application/json'], + 'operationType' => 'read', 'deprecated' => false, 'systemTags' => [ - 'operationType' => 'delete', + 'operationType' => 'none', 'riskType' => 'none', 'chargeType' => 'free', - 'abilityTreeNodes' => [ - 'FEATURElearnN0NAWV', - ], + 'abilityTreeCode' => '163069', + 'abilityTreeNodes' => ['FEATURElearnN0NAWV'], ], 'parameters' => [ [ - 'name' => 'CrowdId', - 'in' => 'path', - 'schema' => [ - 'title' => '人群ID。', - 'description' => '', - 'type' => 'string', - 'required' => true, - 'example' => '3', - ], + 'name' => 'InstanceId', + 'in' => 'query', + 'schema' => ['description' => 'The ID of the instance. You can use this parameter to perform a fuzzy search for instances.', 'type' => 'string', 'example' => 'pairec-test1', 'title' => '', 'required' => false], ], [ - 'name' => 'InstanceId', + 'name' => 'SortBy', 'in' => 'query', - 'schema' => [ - 'title' => '实例ID。', - 'description' => '', - 'type' => 'string', - 'required' => true, - 'example' => 'pairec-cn-abcdefg1234', - ], + 'schema' => ['description' => 'The field by which to sort the results.', 'type' => 'string', 'example' => 'Type', 'title' => '', 'required' => false], + ], + [ + 'name' => 'Order', + 'in' => 'query', + 'schema' => ['description' => 'The sort order. Valid values: `Asc` (ascending) and `Desc` (descending).', 'type' => 'string', 'example' => 'Desc', 'title' => '', 'required' => false], + ], + [ + 'name' => 'PageNumber', + 'in' => 'query', + 'schema' => ['description' => 'The number of entries per page.', 'type' => 'integer', 'format' => 'int32', 'example' => '1', 'title' => '', 'required' => false], + ], + [ + 'name' => 'PageSize', + 'in' => 'query', + 'schema' => ['description' => 'The page number.', 'type' => 'integer', 'format' => 'int32', 'example' => '50', 'title' => '', 'required' => false], + ], + [ + 'name' => 'Type', + 'in' => 'query', + 'schema' => ['description' => 'The instance type. Valid values:'."\n" + ."\n" + .'- `basic`: Basic edition'."\n" + ."\n" + .'- `high-level`: High-level edition'."\n" + ."\n" + .'- `advanced`: Advanced edition'."\n" + ."\n" + .'- `standard`: Standard edition', 'type' => 'string', 'example' => 'basic', 'title' => '', 'required' => false], ], ], 'responses' => [ 200 => [ 'schema' => [ 'title' => 'Schema of Response', - 'description' => 'Schema of Response', + 'description' => 'The returned data.', 'type' => 'object', 'properties' => [ - 'RequestId' => [ - 'title' => 'Id of the request', - 'description' => 'Id of the request', - 'type' => 'string', - 'example' => 'A04CB8C0-E74A-5E83-BC61-64D153574EC7', + 'RequestId' => ['description' => 'The request ID.', 'type' => 'string', 'example' => 'BDB621CB-A81E-5D39-8793-39A365CBCC74', 'title' => ''], + 'Instances' => [ + 'description' => 'A list of instances.', + 'type' => 'array', + 'items' => [ + 'type' => 'object', + 'properties' => [ + 'InstanceId' => ['description' => 'The instance ID.', 'type' => 'string', 'example' => 'pairec-test1', 'title' => ''], + 'Type' => ['description' => 'The instance type. Valid values:'."\n" + ."\n" + .'- `basic`: Basic Edition'."\n" + ."\n" + .'- `high-level`: High-level Edition'."\n" + ."\n" + .'- `advanced`: Advanced Edition'."\n" + ."\n" + .'- `standard`: Standard Edition', 'type' => 'string', 'example' => 'basic', 'title' => ''], + 'Status' => ['description' => 'The instance status. Valid values:'."\n" + ."\n" + .'- `Initializing`: The instance is initializing.'."\n" + ."\n" + .'- `Stopped`: The instance is stopped.'."\n" + ."\n" + .'- `Running`: The instance is running.', 'type' => 'string', 'example' => 'Initializing', 'title' => ''], + 'RegionId' => ['description' => 'The region ID. Valid values:'."\n" + ."\n" + .'- `cn-shenzhen`: China (Shenzhen)'."\n" + ."\n" + .'- `cn-hangzhou`: China (Hangzhou)'."\n" + ."\n" + .'- `cn-beijing`: China (Beijing)'."\n" + ."\n" + .'- `cn-shanghai`: China (Shanghai)', 'type' => 'string', 'example' => 'cn-shenzhen', 'title' => ''], + 'GmtCreateTime' => ['description' => 'The time when the instance was created.', 'type' => 'string', 'example' => '2022-10-13 17:34:52.0', 'title' => ''], + 'GmtModifiedTime' => ['description' => 'The time when the instance was last modified.', 'type' => 'string', 'example' => '2022-11-05 09:02:30.0', 'title' => ''], + 'ExpiredTime' => ['description' => 'The time when the instance expires.', 'type' => 'string', 'example' => '2022-12-14 00:00:00.0', 'title' => ''], + 'CommodityCode' => ['description' => 'The commodity code of the instance.', 'type' => 'string', 'example' => 'airec_developers_public_cn', 'title' => ''], + 'ChargeType' => ['description' => 'The billing method of the instance. Only `Subscription` (prepaid) is supported.', 'type' => 'string', 'example' => 'Subscription', 'title' => ''], + 'Config' => [ + 'title' => '', + 'description' => 'The instance configuration.', + 'type' => 'object', + 'properties' => [ + 'Engines' => [ + 'title' => '', + 'description' => 'A list of service engines.', + 'type' => 'array', + 'items' => [ + 'type' => 'object', + 'properties' => [ + 'ComponentCode' => ['description' => 'The component code.', 'type' => 'string', 'example' => 'feature', 'title' => ''], + 'Type' => ['description' => 'The component type.', 'type' => 'string', 'example' => 'Hologres', 'title' => ''], + 'Meta' => ['description' => 'The metadata of the component.', 'type' => 'object', 'title' => '', 'example' => ''], + ], + 'description' => '', + 'title' => '', + 'example' => '', + ], + 'example' => '', + ], + 'Monitors' => [ + 'title' => '', + 'description' => 'A list of monitoring components.', + 'type' => 'array', + 'items' => [ + 'type' => 'object', + 'properties' => [ + 'ComponentCode' => ['description' => 'The component code.', 'type' => 'string', 'example' => 'featuresets', 'title' => ''], + 'Type' => ['description' => 'The component type.', 'type' => 'string', 'example' => 'Platform', 'title' => ''], + 'Meta' => ['description' => 'The metadata of the component.', 'type' => 'object', 'title' => '', 'example' => ''], + ], + 'description' => '', + 'title' => '', + 'example' => '', + ], + 'example' => '', + ], + 'DataManagements' => [ + 'title' => '', + 'description' => 'A list of data management configurations.', + 'type' => 'array', + 'items' => [ + 'type' => 'object', + 'properties' => [ + 'ComponentCode' => ['description' => 'The component code.', 'type' => 'string', 'example' => 'storage', 'title' => ''], + 'Type' => ['description' => 'The component type.', 'type' => 'string', 'example' => 'OSS', 'title' => ''], + 'Meta' => ['description' => 'The metadata of the component.', 'type' => 'object', 'title' => '', 'example' => ''], + ], + 'description' => '', + 'title' => '', + 'example' => '', + ], + 'example' => '', + ], + ], + 'example' => '', + ], + 'OperatingTool' => [ + 'description' => 'The configuration of the operating tool.', + 'type' => 'object', + 'properties' => [ + 'IsEnable' => ['description' => 'Specifies whether the operating tool is enabled for the instance. Valid values:'."\n" + ."\n" + .'- `true`: The tool is enabled.'."\n" + ."\n" + .'- `false`: The tool is disabled.', 'type' => 'boolean', 'example' => 'true', 'title' => ''], + ], + 'title' => '', + 'example' => '', + ], + ], + 'description' => '', + 'title' => '', + 'example' => '', + ], + 'title' => '', + 'example' => '', ], + 'TotalCount' => ['description' => 'The total number of returned instances.', 'type' => 'integer', 'format' => 'int32', 'title' => '', 'example' => '7'], ], + 'example' => '', ], ], ], - 'staticInfo' => [ - 'returnType' => 'synchronous', + 'staticInfo' => ['returnType' => 'synchronous'], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"BDB621CB-A81E-5D39-8793-39A365CBCC74\\",\\n \\"Instances\\": [\\n {\\n \\"InstanceId\\": \\"pairec-test1\\",\\n \\"Type\\": \\"basic\\",\\n \\"Status\\": \\"Initializing\\",\\n \\"RegionId\\": \\"cn-shenzhen\\",\\n \\"GmtCreateTime\\": \\"2022-10-13 17:34:52.0\\",\\n \\"GmtModifiedTime\\": \\"2022-11-05 09:02:30.0\\",\\n \\"ExpiredTime\\": \\"2022-12-14 00:00:00.0\\",\\n \\"CommodityCode\\": \\"airec_developers_public_cn\\",\\n \\"ChargeType\\": \\"Subscription\\",\\n \\"Config\\": {\\n \\"Engines\\": [\\n {\\n \\"ComponentCode\\": \\"feature\\",\\n \\"Type\\": \\"Hologres\\",\\n \\"Meta\\": {\\n \\"test\\": \\"test\\",\\n \\"test2\\": 1\\n }\\n }\\n ],\\n \\"Monitors\\": [\\n {\\n \\"ComponentCode\\": \\"featuresets\\",\\n \\"Type\\": \\"Platform\\",\\n \\"Meta\\": {\\n \\"test\\": \\"test\\",\\n \\"test2\\": 1\\n }\\n }\\n ],\\n \\"DataManagements\\": [\\n {\\n \\"ComponentCode\\": \\"storage\\",\\n \\"Type\\": \\"OSS\\",\\n \\"Meta\\": {\\n \\"test\\": \\"test\\",\\n \\"test2\\": 1\\n }\\n }\\n ]\\n },\\n \\"OperatingTool\\": {\\n \\"IsEnable\\": true\\n }\\n }\\n ],\\n \\"TotalCount\\": 7\\n}","type":"json"}]', + 'title' => 'Retrieve Instance List ', + 'changeSet' => [ + ['createdAt' => '2024-08-05T08:37:23.000Z', 'description' => 'Response parameters changed'], ], - 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"A04CB8C0-E74A-5E83-BC61-64D153574EC7\\"\\n}","type":"json"}]', - ], - 'DeleteSubCrowd' => [ - 'summary' => '删除指定人群下的指定子人群。', - 'path' => '/api/v1/crowds/{CrowdId}/subcrowds/{SubCrowdId}', - 'methods' => [ - 'delete', + 'flowControl' => [ + 'flowControlList' => [ + ['threshold' => '100', 'countWindow' => 1, 'regionId' => '*', 'api' => 'ListInstances'], + ], ], - 'schemes' => [ - 'http', - 'https', + 'ramActions' => [ + [ + 'operationType' => 'none', + 'ramAction' => [ + 'action' => 'pairec:ListInstances', + 'authLevel' => 'operate', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'PAIRecService', 'resourceType' => 'All Resource', 'arn' => '*'], + ], + ], + ], ], + ], + 'ListLaboratories' => [ + 'summary' => 'Retrieves the laboratories in a specified scene.', + 'path' => '/api/v1/laboratories', + 'methods' => ['get'], + 'schemes' => ['http', 'https'], 'security' => [ [ 'AK' => [], ], ], - 'consumes' => [ - 'application/json', - ], - 'produces' => [ - 'application/json', - ], - 'operationType' => 'write', + 'consumes' => ['application/json'], + 'produces' => ['application/json'], + 'operationType' => 'read', 'deprecated' => false, 'systemTags' => [ - 'operationType' => 'delete', + 'operationType' => 'list', 'riskType' => 'none', 'chargeType' => 'free', - 'abilityTreeNodes' => [ - 'FEATURElearnN0NAWV', - ], + 'abilityTreeNodes' => ['FEATURElearnN0NAWV'], ], 'parameters' => [ [ - 'name' => 'CrowdId', - 'in' => 'path', - 'schema' => [ - 'title' => '人群ID。', - 'description' => '', - 'type' => 'string', - 'required' => true, - 'example' => '3', - ], + 'name' => 'Environment', + 'in' => 'query', + 'schema' => ['description' => 'The laboratory environment.'."\n" + ."\n" + .'- `Daily`: the daily environment'."\n" + ."\n" + .'- `Pre`: the pre-production environment'."\n" + ."\n" + .'- `Prod`: the production environment', 'type' => 'string', 'example' => 'Daily', 'title' => '', 'required' => false], ], [ - 'name' => 'SubCrowdId', - 'in' => 'path', - 'schema' => [ - 'title' => '子人群ID。', - 'description' => '', - 'type' => 'string', - 'required' => true, - 'example' => '3', - ], + 'name' => 'SceneId', + 'in' => 'query', + 'schema' => ['description' => 'The ID of the scene. You can obtain this ID by calling the `ListScenes` API.', 'type' => 'string', 'required' => true, 'example' => '3', 'title' => ''], + ], + [ + 'name' => 'Status', + 'in' => 'query', + 'schema' => ['description' => 'The laboratory status.'."\n" + ."\n" + .'- `Offline`: The laboratory is offline.'."\n" + ."\n" + .'- `Online`: The laboratory is online.', 'type' => 'string', 'example' => 'Offline', 'title' => '', 'required' => false], ], [ 'name' => 'InstanceId', 'in' => 'query', - 'schema' => [ - 'title' => '实例ID。', - 'description' => '', - 'type' => 'string', - 'required' => true, - 'example' => 'pairec-cn-abcdefg1234', - ], + 'schema' => ['description' => 'The ID of the instance. You can obtain this ID by calling the `ListInstances` API.', 'type' => 'string', 'required' => true, 'example' => 'pairec-test1', 'title' => ''], ], ], 'responses' => [ 200 => [ 'schema' => [ 'title' => 'Schema of Response', - 'description' => 'Schema of Response', + 'description' => 'The response data.', 'type' => 'object', 'properties' => [ - 'RequestId' => [ - 'title' => 'Id of the request', - 'description' => 'Id of the request', - 'type' => 'string', - 'example' => 'EE97D06A-2AA0-5AD9-B6CF-8A267924D691', + 'RequestId' => ['title' => 'Id of the request', 'description' => 'The request ID.', 'type' => 'string', 'example' => '1C0898E5-9220-5443-B2D9-445FF0688215'], + 'TotalCount' => ['description' => 'The total number of laboratories.', 'type' => 'integer', 'format' => 'int64', 'example' => '10', 'title' => ''], + 'Laboratories' => [ + 'title' => '', + 'description' => 'A list of laboratories.', + 'type' => 'array', + 'items' => [ + 'type' => 'object', + 'properties' => [ + 'LaboratoryId' => ['description' => 'The laboratory ID.', 'type' => 'string', 'example' => '3', 'title' => ''], + 'SceneId' => ['description' => 'The scene ID.', 'type' => 'string', 'example' => '3', 'title' => ''], + 'Name' => ['description' => 'The laboratory name.', 'type' => 'string', 'example' => 'laboratory1', 'title' => ''], + 'Description' => ['description' => 'The laboratory description.', 'type' => 'string', 'example' => 'This is a test.', 'title' => ''], + 'DebugUsers' => ['description' => 'The debug users, separated by commas.', 'type' => 'string', 'example' => 'user1,user2,user3', 'title' => ''], + 'DebugCrowdId' => ['description' => 'The debug crowd ID.', 'type' => 'string', 'example' => '3', 'title' => ''], + 'BucketCount' => ['description' => 'The bucket count.', 'type' => 'integer', 'format' => 'int32', 'example' => '100', 'title' => ''], + 'Buckets' => ['description' => 'The assigned buckets, specified as numbers or ranges separated by commas.', 'type' => 'string', 'example' => '1,2,3,10-20', 'title' => ''], + 'BucketType' => ['description' => 'The bucketing method.'."\n" + ."\n" + .'- `Uid-UID`: Bucketing by UID (default)'."\n" + ."\n" + .'- `UidHash`: Bucketing by UID hash'."\n" + ."\n" + .'- `Filter`: Bucketing by a filter condition', 'type' => 'string', 'example' => 'Filter', 'title' => ''], + 'Filter' => ['description' => 'The filter condition.', 'type' => 'string', 'example' => 'filter=xxx', 'title' => ''], + 'Environment' => ['description' => 'The laboratory environment.'."\n" + ."\n" + .'- `Daily`: the daily environment'."\n" + ."\n" + .'- `Pre`: the pre-production environment'."\n" + ."\n" + .'- `Prod`: the production environment', 'type' => 'string', 'example' => 'Daily', 'title' => ''], + 'Type' => ['description' => 'The laboratory type.'."\n" + ."\n" + .'- `Base`: A base laboratory.'."\n" + ."\n" + .'- `NonBase`: A non-base laboratory.', 'type' => 'string', 'example' => 'Base', 'title' => ''], + 'Status' => ['description' => 'The laboratory status.'."\n" + ."\n" + .'- `Offline`: The laboratory is offline.'."\n" + ."\n" + .'- `Online`: The laboratory is online.', 'type' => 'string', 'example' => 'Offline', 'title' => ''], + 'CrowdId' => ['description' => 'The crowd ID.', 'type' => 'string', 'example' => '3', 'title' => ''], + ], + 'description' => '', + 'title' => '', + 'example' => '', + ], + 'example' => '', ], ], + 'example' => '', ], ], ], - 'staticInfo' => [ - 'returnType' => 'synchronous', + 'staticInfo' => ['returnType' => 'synchronous'], + 'title' => 'Obtain the Lab List', + 'changeSet' => [], + 'flowControl' => [ + 'flowControlList' => [], ], - 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"EE97D06A-2AA0-5AD9-B6CF-8A267924D691\\"\\n}","type":"json"}]', - ], - 'UpdateCrowd' => [ - 'summary' => '更新指定人群。', - 'path' => '/api/v1/crowds/{CrowdId}', - 'methods' => [ - 'put', - ], - 'schemes' => [ - 'http', - 'https', + 'ramActions' => [ + [ + 'operationType' => 'list', + 'ramAction' => [ + 'action' => 'pairec:ListLaboratories', + 'authLevel' => 'operate', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'PAIRecService', 'resourceType' => 'All Resource', 'arn' => '*'], + ], + ], + ], ], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"1C0898E5-9220-5443-B2D9-445FF0688215\\",\\n \\"TotalCount\\": 10,\\n \\"Laboratories\\": [\\n {\\n \\"LaboratoryId\\": \\"3\\",\\n \\"SceneId\\": \\"3\\",\\n \\"Name\\": \\"laboratory1\\",\\n \\"Description\\": \\"This is a test.\\",\\n \\"DebugUsers\\": \\"user1,user2,user3\\",\\n \\"DebugCrowdId\\": \\"3\\",\\n \\"BucketCount\\": 100,\\n \\"Buckets\\": \\"1,2,3,10-20\\",\\n \\"BucketType\\": \\"Filter\\",\\n \\"Filter\\": \\"filter=xxx\\",\\n \\"Environment\\": \\"Daily\\",\\n \\"Type\\": \\"Base\\",\\n \\"Status\\": \\"Offline\\",\\n \\"CrowdId\\": \\"3\\"\\n }\\n ]\\n}","type":"json"}]', + ], + 'ListLayers' => [ + 'path' => '/api/v1/layers', + 'methods' => ['get'], + 'schemes' => ['http', 'https'], 'security' => [ [ 'AK' => [], ], ], - 'consumes' => [ - 'application/json', - ], - 'produces' => [ - 'application/json', - ], - 'operationType' => 'readAndWrite', + 'consumes' => ['application/json'], + 'produces' => ['application/json'], + 'operationType' => 'read', 'deprecated' => false, 'systemTags' => [ - 'operationType' => 'update', + 'operationType' => 'list', 'riskType' => 'none', 'chargeType' => 'free', - 'abilityTreeNodes' => [ - 'FEATURElearnN0NAWV', - ], + 'abilityTreeCode' => '183174', + 'abilityTreeNodes' => ['FEATURElearnN0NAWV'], ], 'parameters' => [ [ - 'name' => 'body', - 'in' => 'body', - 'style' => 'json', + 'name' => 'LaboratoryId', + 'in' => 'query', + 'schema' => ['description' => 'The laboratory ID. You can obtain this ID by calling the ListLaboratories API.', 'type' => 'string', 'required' => true, 'example' => '3', 'title' => ''], + ], + [ + 'name' => 'InstanceId', + 'in' => 'query', + 'schema' => ['description' => 'The instance ID. You can obtain this ID by calling the ListInstances API.', 'type' => 'string', 'required' => true, 'example' => 'pairec-cn-abcdefg1234', 'title' => ''], + ], + ], + 'responses' => [ + 200 => [ 'schema' => [ - 'description' => '', + 'title' => 'Schema of Response', + 'description' => 'The response body.', 'type' => 'object', 'properties' => [ - 'Name' => [ - 'title' => '人群名称。', - 'description' => '', - 'type' => 'string', - 'required' => true, - 'example' => 'xx人群', - ], - 'Description' => [ - 'title' => '人群描述。', - 'description' => '', - 'type' => 'string', - 'required' => true, - 'example' => 'This is a test.', - ], - 'InstanceId' => [ - 'title' => '实例ID。', - 'description' => '', - 'type' => 'string', - 'required' => true, - 'example' => 'pairec-test1', + 'RequestId' => ['title' => 'Id of the request', 'description' => 'The request ID.', 'type' => 'string', 'example' => '518C64F6-DFF7-11ED-85B0-00163E14B3D1'], + 'TotalCount' => ['description' => 'The total count of layers.', 'type' => 'integer', 'format' => 'int64', 'example' => '10', 'title' => ''], + 'Layers' => [ + 'title' => '', + 'description' => 'An array of layers.', + 'type' => 'array', + 'items' => [ + 'type' => 'object', + 'properties' => [ + 'LayerId' => ['description' => 'The layer ID.', 'type' => 'string', 'example' => '3', 'title' => ''], + 'LaboratoryId' => ['description' => 'The laboratory ID.', 'type' => 'string', 'example' => '3', 'title' => ''], + 'SceneId' => ['description' => 'The scene ID.', 'type' => 'string', 'example' => '3', 'title' => ''], + 'Name' => ['description' => 'The layer name.', 'type' => 'string', 'example' => 'layer1', 'title' => ''], + 'Description' => ['description' => 'The layer description.', 'type' => 'string', 'example' => 'This is a test.', 'title' => ''], + 'ResidualFlow' => ['description' => 'The remaining traffic for the layer.', 'type' => 'integer', 'format' => 'int64', 'example' => '10', 'title' => ''], + 'GmtCreateTime' => ['description' => 'The time when the layer was created.', 'type' => 'string', 'example' => '2024-05-30T02:02:28.000Z', 'title' => ''], + ], + 'description' => '', + 'title' => '', + 'example' => '', + ], + 'example' => '', ], ], - 'required' => false, + 'example' => '', ], ], + ], + 'staticInfo' => ['returnType' => 'synchronous'], + 'title' => 'Retrieve the layer list ', + 'summary' => 'Retrieves a list of layers in a specified laboratory.', + 'changeSet' => [ + ['createdAt' => '2024-03-20T06:05:19.000Z', 'description' => 'Response parameters changed'], + ], + 'flowControl' => [ + 'flowControlList' => [], + ], + 'ramActions' => [ [ - 'name' => 'CrowdId', - 'in' => 'path', - 'schema' => [ - 'title' => '人群ID。', - 'description' => '', - 'type' => 'string', - 'required' => true, - 'example' => '3', + 'operationType' => 'list', + 'ramAction' => [ + 'action' => 'pairec:ListLayers', + 'authLevel' => 'operate', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'PAIRecService', 'resourceType' => 'All Resource', 'arn' => '*'], + ], ], ], ], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"518C64F6-DFF7-11ED-85B0-00163E14B3D1\\",\\n \\"TotalCount\\": 10,\\n \\"Layers\\": [\\n {\\n \\"LayerId\\": \\"3\\",\\n \\"LaboratoryId\\": \\"3\\",\\n \\"SceneId\\": \\"3\\",\\n \\"Name\\": \\"layer1\\",\\n \\"Description\\": \\"This is a test.\\",\\n \\"ResidualFlow\\": 10,\\n \\"GmtCreateTime\\": \\"2024-05-30T02:02:28.000Z\\"\\n }\\n ]\\n}","type":"json"}]', + ], + 'ListParams' => [ + 'path' => '/api/v1/params', + 'methods' => ['get'], + 'schemes' => ['http', 'https'], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'consumes' => ['application/json'], + 'produces' => ['application/json'], + 'operationType' => 'read', + 'deprecated' => false, + 'systemTags' => [ + 'operationType' => 'list', + 'riskType' => 'none', + 'chargeType' => 'free', + 'abilityTreeNodes' => ['FEATURElearnN0NAWV'], + ], + 'parameters' => [ + [ + 'name' => 'SceneId', + 'in' => 'query', + 'schema' => ['description' => 'The scene ID. You can call the ListScenes operation to obtain it.', 'type' => 'string', 'required' => true, 'example' => '3', 'title' => ''], + ], + [ + 'name' => 'Name', + 'in' => 'query', + 'schema' => ['description' => 'The parameter name.', 'type' => 'string', 'example' => 'home', 'title' => '', 'required' => false], + ], + [ + 'name' => 'Environment', + 'in' => 'query', + 'schema' => ['description' => 'The environment to which the parameter belongs. Valid values:'."\n" + ."\n" + .'- Daily: A test environment for daily use.'."\n" + ."\n" + .'- Prepub: A staging environment that mirrors the production environment.'."\n" + ."\n" + .'- Product: The production environment.', 'type' => 'string', 'example' => 'Daily', 'title' => '', 'required' => false], + ], + [ + 'name' => 'PageNumber', + 'in' => 'query', + 'schema' => ['description' => 'The page number.', 'type' => 'integer', 'format' => 'int32', 'example' => '1', 'title' => '', 'required' => false], + ], + [ + 'name' => 'PageSize', + 'in' => 'query', + 'schema' => ['description' => 'The number of entries to return on each page.', 'type' => 'integer', 'format' => 'int32', 'example' => '50', 'title' => '', 'required' => false], + ], + [ + 'name' => 'InstanceId', + 'in' => 'query', + 'schema' => ['description' => 'The instance ID. You can call the ListInstances operation to obtain it.', 'type' => 'string', 'required' => true, 'example' => 'pairec-cn-abcdefg1234', 'title' => ''], + ], + [ + 'name' => 'Encrypted', + 'in' => 'query', + 'schema' => ['type' => 'boolean', 'description' => '', 'required' => false, 'title' => '', 'example' => ''], + ], + ], 'responses' => [ 200 => [ 'schema' => [ 'title' => 'Schema of Response', - 'description' => 'Schema of Response', + 'description' => 'The response object.', 'type' => 'object', 'properties' => [ - 'RequestId' => [ - 'title' => 'Id of the request', - 'description' => 'Id of the request', - 'type' => 'string', - 'example' => '8C27790E-CCA5-56BB-BA17-646295DEC0A2', + 'RequestId' => ['title' => 'Id of the request', 'description' => 'The ID of the request.', 'type' => 'string', 'example' => 'A2D07551-38DA-531E-9B22-877D1D86A579'], + 'TotalCount' => ['description' => 'The total number of parameters.', 'type' => 'integer', 'format' => 'int64', 'example' => '10', 'title' => ''], + 'Params' => [ + 'title' => '', + 'description' => 'A list of parameters.', + 'type' => 'array', + 'items' => [ + 'type' => 'object', + 'properties' => [ + 'ParamId' => ['description' => 'The parameter ID.', 'type' => 'string', 'example' => '4', 'title' => ''], + 'Name' => ['description' => 'The parameter name.', 'type' => 'string', 'example' => 'home', 'title' => ''], + 'Value' => ['description' => 'The parameter value.', 'type' => 'string', 'example' => 'house', 'title' => ''], + 'Environment' => ['description' => 'The environment to which the parameter belongs. Valid values:'."\n" + ."\n" + .'- Daily: A test environment for daily use.'."\n" + ."\n" + .'- Prepub: A staging environment that mirrors the production environment.'."\n" + ."\n" + .'- Product: The production environment.', 'type' => 'string', 'example' => 'Daily', 'title' => ''], + 'GmtModifiedTime' => ['description' => 'The time when the parameter was last modified.', 'type' => 'string', 'example' => '2021-12-15T23:24:33.132+08:00', 'title' => ''], + ], + 'description' => '', + 'title' => '', + 'example' => '', + ], + 'example' => '', ], ], + 'example' => '', ], ], ], - 'staticInfo' => [ - 'returnType' => 'synchronous', + 'staticInfo' => ['returnType' => 'synchronous'], + 'title' => 'Retrieve the parameter list ', + 'summary' => 'Lists parameters.', + 'changeSet' => [ + ['createdAt' => '2025-07-02T01:39:45.000Z', 'description' => 'Request parameters changed'], ], - 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"8C27790E-CCA5-56BB-BA17-646295DEC0A2\\"\\n}","type":"json"}]', - ], - 'ListCrowds' => [ - 'summary' => '获取人群列表。', - 'path' => '/api/v1/crowds', - 'methods' => [ - 'get', + 'flowControl' => [ + 'flowControlList' => [], ], - 'schemes' => [ - 'http', - 'https', + 'ramActions' => [ + [ + 'operationType' => 'list', + 'ramAction' => [ + 'action' => 'pairec:ListParams', + 'authLevel' => 'operate', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'PAIRecService', 'resourceType' => 'All Resource', 'arn' => '*'], + ], + ], + ], ], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"A2D07551-38DA-531E-9B22-877D1D86A579\\",\\n \\"TotalCount\\": 10,\\n \\"Params\\": [\\n {\\n \\"ParamId\\": \\"4\\",\\n \\"Name\\": \\"home\\",\\n \\"Value\\": \\"house\\",\\n \\"Environment\\": \\"Daily\\",\\n \\"GmtModifiedTime\\": \\"2021-12-15T23:24:33.132+08:00\\"\\n }\\n ]\\n}","type":"json"}]', + ], + 'ListRecallManagementJobs' => [ + 'summary' => 'Retrieves a list of recall management tasks that match specified conditions.', + 'path' => '/api/v1/recallmanagementjobs', + 'methods' => ['get'], + 'schemes' => ['https'], 'security' => [ [ 'AK' => [], ], ], - 'consumes' => [ - 'application/json', - ], - 'produces' => [ - 'application/json', - ], + 'consumes' => ['application/json'], + 'produces' => ['application/json'], 'operationType' => 'read', 'deprecated' => false, 'systemTags' => [ 'operationType' => 'list', 'riskType' => 'none', 'chargeType' => 'free', - 'abilityTreeNodes' => [ - 'FEATURElearnN0NAWV', - ], + 'abilityTreeNodes' => ['FEATURElearnN0NAWV'], ], 'parameters' => [ [ 'name' => 'InstanceId', 'in' => 'query', - 'schema' => [ - 'title' => '实例ID。', - 'description' => '', - 'type' => 'string', - 'required' => true, - 'example' => 'pairec-cn-abcdefg1234', - ], + 'schema' => ['description' => 'The instance ID.', 'type' => 'string', 'required' => false, 'example' => 'pairec-test1', 'title' => ''], + ], + [ + 'name' => 'Type', + 'in' => 'query', + 'schema' => ['description' => 'The task type.', 'type' => 'string', 'required' => false, 'example' => 'Table', 'title' => ''], + ], + [ + 'name' => 'Condition', + 'in' => 'query', + 'style' => 'flat', + 'schema' => ['description' => 'The filter condition. Filtering is supported only for the `Table` type. For example: `{"RecallManagementTableId":"1"}`', 'type' => 'object', 'required' => false, 'example' => '{"RecallManagementTableId":"1"}', 'title' => ''], + ], + [ + 'name' => 'SortBy', + 'in' => 'query', + 'schema' => ['description' => 'The sorting basis. Valid values: `GmtCreateTime` (creation time) and `GmtModifiedTime` (update time).', 'type' => 'string', 'required' => false, 'example' => 'GmtCreateTime', 'title' => ''], + ], + [ + 'name' => 'Order', + 'in' => 'query', + 'schema' => ['description' => 'The sort order. Valid values: `ASC` (ascending) and `DESC` (descending).', 'type' => 'string', 'required' => false, 'example' => 'ASC', 'title' => ''], + ], + [ + 'name' => 'PageNumber', + 'in' => 'query', + 'schema' => ['description' => 'The page number. Default value: 1.', 'type' => 'integer', 'format' => 'int32', 'required' => false, 'example' => '1', 'title' => ''], + ], + [ + 'name' => 'PageSize', + 'in' => 'query', + 'schema' => ['description' => 'The page size. Default value: 10.', 'type' => 'integer', 'format' => 'int32', 'required' => false, 'example' => '10', 'title' => ''], + ], + [ + 'name' => 'MaxResults', + 'in' => 'query', + 'schema' => ['description' => 'This parameter is not used.', 'type' => 'integer', 'format' => 'int32', 'required' => false, 'example' => '0', 'title' => ''], + ], + [ + 'name' => 'NextToken', + 'in' => 'query', + 'schema' => ['description' => 'This parameter is not used.', 'type' => 'string', 'required' => false, 'example' => '""', 'title' => ''], ], ], 'responses' => [ 200 => [ 'schema' => [ - 'title' => 'Schema of Response', - 'description' => 'Schema of Response', + 'description' => 'The response object.', + 'title' => 'Schema of Response ', 'type' => 'object', 'properties' => [ - 'RequestId' => [ - 'title' => 'Id of the request', - 'description' => 'Id of the request', - 'type' => 'string', - 'example' => '9763624B-5FBB-5E3A-9193-B1ADB554CEAE', - ], - 'TotalCount' => [ - 'title' => '列表内元素总数。', - 'description' => '', - 'type' => 'integer', - 'format' => 'int64', - 'example' => '10', - ], - 'Crowds' => [ - 'title' => '人群列表。', - 'description' => '', + 'RequestId' => ['title' => 'Id of the request ', 'description' => 'The request ID.', 'type' => 'string', 'example' => '728C5E01-ABF6-5AA8-B9FC-B3BA05DECC77'], + 'TotalCount' => ['description' => 'The total count of synchronization jobs.', 'type' => 'string', 'example' => '30', 'title' => ''], + 'RecallManagementJobs' => [ + 'description' => 'A list of synchronization jobs.', 'type' => 'array', 'items' => [ + 'description' => 'Details of the synchronization jobs.', 'type' => 'object', 'properties' => [ - 'CrowdId' => [ - 'title' => '人群ID。', - 'description' => '', - 'type' => 'string', - 'example' => '3', - ], - 'Name' => [ - 'title' => '人群名称。', - 'description' => '', - 'type' => 'string', - 'example' => 'crowd1', - ], - 'Description' => [ - 'title' => '人群描述。', - 'description' => '', - 'type' => 'string', - 'example' => 'This is a test.', - ], - 'Label' => [ - 'title' => '人群标签。', - 'description' => '', - 'type' => 'string', - 'example' => 'os=android', - ], - 'Source' => [ - 'title' => '人群来源。'."\n" - .'● ManualInput-手工输入'."\n" - .'● UploadFile-文件上传', - 'description' => '', - 'type' => 'string', - 'example' => 'ManualInput', - ], - 'Quantity' => [ - 'title' => '数量。', - 'description' => '', - 'type' => 'string', - 'example' => '10', - ], - 'Users' => [ - 'title' => '人群内包含的用户，多个用户间以逗号隔开。', - 'description' => '', - 'type' => 'string', - 'example' => 'user1,user2', + 'RecallManagementJobId' => ['description' => 'The synchronization job ID.', 'type' => 'string', 'example' => '1', 'title' => ''], + 'RecallManagerTableInfo' => [ + 'description' => 'This parameter is deprecated.', + 'type' => 'object', + 'properties' => [ + 'RecallManagementTableVersionId' => ['description' => 'This parameter is deprecated.', 'type' => 'string', 'example' => '2', 'title' => ''], + 'DataVersion' => ['description' => 'This parameter is deprecated.', 'type' => 'string', 'example' => 'ds=20250701', 'title' => ''], + 'SourceTableRowCount' => ['description' => 'This parameter is deprecated.', 'type' => 'string', 'example' => '100', 'title' => ''], + 'SourceTableDataSize' => ['description' => 'This parameter is deprecated.', 'type' => 'string', 'example' => '1000', 'title' => ''], + ], + 'title' => '', + 'example' => '', ], - 'GmtCreateTime' => [ - 'title' => '人群创建时间。', - 'description' => '', - 'type' => 'string', - 'example' => '2021-12-15T23:24:33.132+08:00', + 'Status' => ['description' => 'The status of the synchronization job. Valid values: `Init` (initializing), `Running` (running), `Success` (succeeded), and `Failed` (failed).', 'type' => 'string', 'example' => 'Running', 'title' => ''], + 'StartTime' => ['description' => 'The start time of the synchronization job.', 'type' => 'string', 'example' => '2025-01-28T10:00:00Z', 'title' => ''], + 'EndTime' => ['description' => 'The end time of the synchronization job.', 'type' => 'string', 'example' => '2025-03-28T10:24Z', 'title' => ''], + 'RecallManagementTableInfo' => [ + 'description' => 'Information about the recall management table.', + 'type' => 'object', + 'properties' => [ + 'RecallManagementTableVersionId' => ['description' => 'The table version ID.', 'type' => 'string', 'example' => '2', 'title' => ''], + 'DataVersion' => ['description' => 'The data version.', 'type' => 'string', 'example' => 'ds=20250701', 'title' => ''], + 'SourceTableRowCount' => ['description' => 'The source table row count.', 'type' => 'string', 'example' => '100', 'title' => ''], + 'SourceTableDataSize' => ['description' => 'The source table data size.', 'type' => 'string', 'example' => '100', 'title' => ''], + ], + 'title' => '', + 'example' => '', ], ], + 'title' => '', + 'example' => '', ], + 'title' => '', + 'example' => '', ], + 'NextToken' => ['description' => 'Reserved.', 'type' => 'string', 'example' => '""', 'title' => ''], + 'MaxResults' => ['description' => 'Reserved.', 'type' => 'integer', 'format' => 'int32', 'example' => '0', 'title' => ''], ], + 'example' => '', ], ], ], - 'staticInfo' => [ - 'returnType' => 'synchronous', + 'staticInfo' => ['returnType' => 'synchronous'], + 'title' => 'Retrieve the recall management job list', + 'description' => '## Request'."\n" + ."\n" + .'- Use this API operation to retrieve a list of recall management tasks.'."\n" + ."\n" + .'- The `InstanceId` and `Type` parameters are required. All other parameters are optional.'."\n" + ."\n" + .'- Use the `Condition` parameter to set filter conditions on specific table types, such as filtering by `RecallManagementTableId`.'."\n" + ."\n" + .'- Use the `SortBy` and `Order` parameters to control the sort order of the results. The default sort order is ascending by creation time.'."\n" + ."\n" + .'- Use the `PageNumber` and `PageSize` parameters for pagination. The `PageNumber` parameter defaults to 1, and the `PageSize` parameter defaults to 10.'."\n" + ."\n" + .'- The response includes details about each recall management task, such as its basic information and status.', + 'changeSet' => [], + 'flowControl' => [ + 'flowControlList' => [], + ], + 'ramActions' => [ + [ + 'operationType' => 'list', + 'ramAction' => [ + 'action' => 'pairec:ListRecallManagementJobs', + 'authLevel' => 'operate', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'PAIRecService', 'resourceType' => 'All Resource', 'arn' => '*'], + ], + ], + ], ], - 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"9763624B-5FBB-5E3A-9193-B1ADB554CEAE\\",\\n \\"TotalCount\\": 10,\\n \\"Crowds\\": [\\n {\\n \\"CrowdId\\": \\"3\\",\\n \\"Name\\": \\"crowd1\\",\\n \\"Description\\": \\"This is a test.\\",\\n \\"Label\\": \\"os=android\\",\\n \\"Source\\": \\"ManualInput\\",\\n \\"Quantity\\": \\"10\\",\\n \\"Users\\": \\"user1,user2\\",\\n \\"GmtCreateTime\\": \\"2021-12-15T23:24:33.132+08:00\\"\\n }\\n ]\\n}","type":"json"}]', + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"728C5E01-ABF6-5AA8-B9FC-B3BA05DECC77\\",\\n \\"TotalCount\\": \\"30\\",\\n \\"RecallManagementJobs\\": [\\n {\\n \\"RecallManagementJobId\\": \\"1\\",\\n \\"RecallManagerTableInfo\\": {\\n \\"RecallManagementTableVersionId\\": \\"2\\",\\n \\"DataVersion\\": \\"ds=20250701\\",\\n \\"SourceTableRowCount\\": \\"100\\",\\n \\"SourceTableDataSize\\": \\"1000\\"\\n },\\n \\"Status\\": \\"Running\\",\\n \\"StartTime\\": \\"2025-01-28T10:00:00Z\\",\\n \\"EndTime\\": \\"2025-03-28T10:24Z\\",\\n \\"RecallManagementTableInfo\\": {\\n \\"RecallManagementTableVersionId\\": \\"2\\",\\n \\"DataVersion\\": \\"ds=20250701\\",\\n \\"SourceTableRowCount\\": \\"100\\",\\n \\"SourceTableDataSize\\": \\"100\\"\\n }\\n }\\n ],\\n \\"NextToken\\": \\"\\\\\\"\\\\\\"\\",\\n \\"MaxResults\\": 0\\n}","type":"json"}]', ], - 'ListCrowdUsers' => [ - 'summary' => '获取人群下的所有用户。', - 'path' => '/api/v1/crowds/{CrowdId}/users', - 'methods' => [ - 'get', - ], - 'schemes' => [ - 'http', - 'https', - ], + 'ListRecallManagementServiceVersions' => [ + 'summary' => 'Retrieves a list of all versions for a specified Recall Management Service.', + 'path' => '/api/v1/recallmanagementservices/{RecallManagementServiceId}/versions', + 'methods' => ['get'], + 'schemes' => ['https'], 'security' => [ [ 'AK' => [], ], ], - 'consumes' => [ - 'application/json', - ], - 'produces' => [ - 'application/json', - ], + 'consumes' => ['application/json'], + 'produces' => ['application/json'], 'operationType' => 'read', 'deprecated' => false, 'systemTags' => [ - 'operationType' => 'list', + 'operationType' => 'none', 'riskType' => 'none', 'chargeType' => 'free', - 'abilityTreeNodes' => [ - 'FEATURElearnN0NAWV', - ], + 'abilityTreeNodes' => ['FEATURElearnN0NAWV'], ], 'parameters' => [ [ - 'name' => 'CrowdId', + 'name' => 'RecallManagementServiceId', 'in' => 'path', - 'schema' => [ - 'title' => '人群ID。', - 'description' => '', - 'type' => 'string', - 'required' => true, - 'example' => '1', - ], + 'schema' => ['description' => 'The ID of the Recall Management Service.', 'type' => 'string', 'required' => false, 'example' => '3', 'title' => ''], ], [ 'name' => 'InstanceId', 'in' => 'query', - 'schema' => [ - 'title' => '实例ID。', - 'description' => '', - 'type' => 'string', - 'required' => true, - 'example' => 'pairec-cn-abcdefg1234', - ], + 'schema' => ['description' => 'The instance ID.', 'type' => 'string', 'required' => false, 'example' => 'pairec-cn-test123', 'title' => ''], + ], + [ + 'name' => 'PageNumber', + 'in' => 'query', + 'schema' => ['description' => 'The page number.', 'type' => 'integer', 'format' => 'int64', 'required' => false, 'example' => '1', 'title' => ''], + ], + [ + 'name' => 'PageSize', + 'in' => 'query', + 'schema' => ['description' => 'The number of entries to return on each page.', 'type' => 'integer', 'format' => 'int64', 'required' => false, 'example' => '50', 'title' => ''], + ], + [ + 'name' => 'SortBy', + 'in' => 'query', + 'schema' => ['description' => 'The field to sort the results by. Valid values: `GmtCreateTime` for creation time and `GmtModifiedTime` for modification time.', 'type' => 'string', 'required' => false, 'example' => 'GmtCreateTime', 'title' => ''], + ], + [ + 'name' => 'Order', + 'in' => 'query', + 'schema' => ['description' => 'The sort order. Valid values: `ASC` for ascending order and `DESC` for descending order.', 'type' => 'string', 'required' => false, 'example' => 'ASC', 'title' => ''], ], ], 'responses' => [ 200 => [ 'schema' => [ - 'title' => 'Schema of Response', - 'description' => 'Schema of Response', + 'description' => 'The response object.', + 'title' => 'Schema of Response ', 'type' => 'object', 'properties' => [ - 'RequestId' => [ - 'title' => 'Id of the request', - 'description' => 'Id of the request', - 'type' => 'string', - 'example' => 'F0AB6527-093F-5C44-B3BD-42C8C210C619', - ], - 'TotalCount' => [ - 'title' => '列表内元素总个数。', - 'description' => '', - 'type' => 'integer', - 'format' => 'int64', - 'example' => '3', - ], - 'Users' => [ - 'title' => '用户列表。', - 'description' => '', + 'RequestId' => ['title' => 'Id of the request ', 'description' => 'The request ID.', 'type' => 'string', 'example' => '728C5E01-ABF6-5AA8-B9FC-B3BA05DECC77'], + 'TotalCount' => ['description' => 'The total number of entries.', 'type' => 'string', 'example' => '30', 'title' => ''], + 'RecallManagementServiceVersions' => [ + 'description' => 'A list of Recall Management Service versions.', 'type' => 'array', 'items' => [ - 'description' => '', - 'type' => 'string', - 'example' => 'user1', + 'description' => 'The details of a Recall Management Service version.', + 'type' => 'object', + 'properties' => [ + 'RecallManagementServiceVersionId' => ['description' => 'The version ID of the Recall Management Service.', 'type' => 'string', 'example' => '1', 'title' => ''], + 'Name' => ['description' => 'The version name.', 'type' => 'string', 'example' => 'version-1', 'title' => ''], + 'IsEffective' => ['description' => 'Indicates whether the version is effective.', 'type' => 'boolean', 'title' => '', 'example' => ''], + 'GmtCreateTime' => ['description' => 'The creation time.', 'type' => 'string', 'example' => '2021-12-15T23:24:33.132+08:00', 'title' => ''], + 'GmtModifiedTime' => ['description' => 'The modification time.', 'type' => 'string', 'example' => '2021-12-15T23:24:33.132+08:00', 'title' => ''], + ], + 'title' => '', + 'example' => '', ], + 'title' => '', + 'example' => '', ], ], + 'example' => '', ], ], ], - 'staticInfo' => [ - 'returnType' => 'synchronous', + 'staticInfo' => ['returnType' => 'synchronous'], + 'title' => 'List of Retrieval Management Service Versions', + 'description' => '## Description'."\n" + ."\n" + .'This operation queries the details of all versions for a specific Recall Management Service, including the version ID, name, effective status, creation time, and modification time. For accurate results, provide the correct `RecallManagementServiceId` and `InstanceId`.'."\n" + ."\n" + .'- Use the `PageNumber` and `PageSize` parameters for pagination. By default, the query starts from the first page and returns 50 entries per page.'."\n" + ."\n" + .'- Use the `SortBy` parameter to sort the results by creation time or modification time. By default, the results are sorted by creation time in ascending order.'."\n" + ."\n" + .'- The `Order` parameter specifies the sort order. Valid values are `ASC` for ascending order and `DESC` for descending order.', + 'changeSet' => [], + 'flowControl' => [ + 'flowControlList' => [], + ], + 'ramActions' => [ + [ + 'operationType' => 'none', + 'ramAction' => [ + 'action' => 'pairec:ListRecallManagementServiceVersions', + 'authLevel' => 'operate', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'PAIRecService', 'resourceType' => 'All Resource', 'arn' => '*'], + ], + ], + ], ], - 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"F0AB6527-093F-5C44-B3BD-42C8C210C619\\",\\n \\"TotalCount\\": 3,\\n \\"Users\\": [\\n \\"user1\\"\\n ]\\n}","type":"json"}]', + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"728C5E01-ABF6-5AA8-B9FC-B3BA05DECC77\\",\\n \\"TotalCount\\": \\"30\\",\\n \\"RecallManagementServiceVersions\\": [\\n {\\n \\"RecallManagementServiceVersionId\\": \\"1\\",\\n \\"Name\\": \\"version-1\\",\\n \\"IsEffective\\": false,\\n \\"GmtCreateTime\\": \\"2021-12-15T23:24:33.132+08:00\\",\\n \\"GmtModifiedTime\\": \\"2021-12-15T23:24:33.132+08:00\\"\\n }\\n ]\\n}","type":"json"}]', ], - 'ListSubCrowds' => [ - 'summary' => '获取人群下的所有子人群。', - 'path' => '/api/v1/crowds/{CrowdId}/subcrowds', - 'methods' => [ - 'get', - ], - 'schemes' => [ - 'http', - 'https', - ], + 'ListRecallManagementServices' => [ + 'path' => '/api/v1/recallmanagementservices', + 'methods' => ['get'], + 'schemes' => ['https'], 'security' => [ [ 'AK' => [], ], ], - 'consumes' => [ - 'application/json', - ], - 'produces' => [ - 'application/json', - ], + 'consumes' => ['application/json'], + 'produces' => ['application/json'], 'operationType' => 'read', 'deprecated' => false, 'systemTags' => [ 'operationType' => 'list', 'riskType' => 'none', 'chargeType' => 'free', - 'abilityTreeNodes' => [ - 'FEATURElearnN0NAWV', - ], + 'abilityTreeNodes' => ['FEATURElearnN0NAWV'], ], 'parameters' => [ [ - 'name' => 'CrowdId', - 'in' => 'path', - 'schema' => [ - 'title' => '人群ID。', - 'description' => '', - 'type' => 'string', - 'required' => true, - 'example' => '3', - ], + 'name' => 'InstanceId', + 'in' => 'query', + 'schema' => ['description' => '**The ID of the instance.**', 'type' => 'string', 'required' => false, 'example' => 'pairec-cn-test123', 'title' => ''], ], [ - 'name' => 'InstanceId', + 'name' => 'PageNumber', 'in' => 'query', - 'schema' => [ - 'title' => '实例ID。', - 'description' => '', - 'type' => 'string', - 'required' => true, - 'example' => 'pairec-cn-abcdefg1234', - ], + 'schema' => ['description' => '**The number of the page to return.**', 'type' => 'integer', 'format' => 'int64', 'required' => false, 'example' => '1', 'title' => ''], + ], + [ + 'name' => 'PageSize', + 'in' => 'query', + 'schema' => ['description' => '**The number of entries to return on each page.**', 'type' => 'integer', 'format' => 'int64', 'required' => false, 'example' => '50', 'title' => ''], + ], + [ + 'name' => 'SortBy', + 'in' => 'query', + 'schema' => ['description' => '**The field to sort by.** Valid values:'."\n" + ."\n" + .'- GmtCreateTime: Sort by creation time.'."\n" + ."\n" + .'- GmtModifiedTime: Sort by modification time.', 'type' => 'string', 'required' => false, 'example' => 'GmtCreateTime', 'title' => ''], + ], + [ + 'name' => 'Order', + 'in' => 'query', + 'schema' => ['description' => '**The sort order.** Valid values:'."\n" + ."\n" + .'- ASC: ascending order.'."\n" + ."\n" + .'- DESC: descending order.', 'type' => 'string', 'required' => false, 'example' => 'ASC', 'title' => ''], + ], + [ + 'name' => 'MaxResults', + 'in' => 'query', + 'schema' => ['description' => 'This parameter is not yet available.', 'type' => 'integer', 'format' => 'int32', 'required' => false, 'example' => '""', 'title' => ''], + ], + [ + 'name' => 'NextToken', + 'in' => 'query', + 'schema' => ['description' => 'This parameter is not yet available.', 'type' => 'string', 'required' => false, 'example' => '0', 'title' => ''], ], ], 'responses' => [ 200 => [ 'schema' => [ - 'title' => 'Schema of Response', 'description' => 'Schema of Response', + 'title' => 'Schema of Response ', 'type' => 'object', 'properties' => [ - 'RequestId' => [ - 'title' => 'Id of the request', - 'description' => 'Id of the request', - 'type' => 'string', - 'example' => 'C5AEB79E-FAA4-5DCE-8CD7-1CAF549ECC3E', - ], - 'TotalCount' => [ - 'title' => '列表内元素总数。', - 'description' => '', - 'type' => 'integer', - 'format' => 'int64', - 'example' => '10', - ], - 'SubCrowds' => [ - 'title' => '子人群列表。', - 'description' => '', + 'RequestId' => ['title' => 'Id of the request ', 'description' => 'The request ID.', 'type' => 'string', 'example' => '728C5E01-ABF6-5AA8-B9FC-B3BA05DECC77'], + 'TotalCount' => ['description' => 'The total count.', 'type' => 'string', 'example' => '10', 'title' => ''], + 'RecallManagementServices' => [ + 'description' => 'The list of recall management services.', 'type' => 'array', 'items' => [ + 'description' => 'The details of a recall management service.', 'type' => 'object', 'properties' => [ - 'SubCrowdId' => [ - 'title' => '子人群ID。', - 'description' => '', - 'type' => 'string', - 'example' => '3', - ], - 'Source' => [ - 'title' => '人群来源。'."\n" - .'● ManualInput-手工输入'."\n" - .'● UploadFile-文件上传', - 'description' => '', - 'type' => 'string', - 'example' => 'ManualInput', - ], - 'Users' => [ - 'title' => '人群分组中的用户。', - 'description' => '', - 'type' => 'string', - 'example' => 'user1,user2', - ], - 'Quantity' => [ - 'title' => '人群分组所含的用户量。', - 'description' => '', - 'type' => 'integer', - 'format' => 'int32', - 'example' => '2', - ], - 'GmtCreateTime' => [ - 'title' => '创建时间。', - 'description' => '', - 'type' => 'string', - 'example' => '2021-12-15T23:24:33.132+08:00', - ], + 'RecallManagementServiceId' => ['description' => 'The recall management service ID.', 'type' => 'string', 'example' => '3', 'title' => ''], + 'Name' => ['description' => 'The recall management service name.', 'type' => 'string', 'example' => 'hot_group_recall', 'title' => ''], + 'Description' => ['description' => 'The recall management service description.', 'type' => 'string', 'example' => 'this is a test recall', 'title' => ''], + 'CurrentRecallManagementServiceVersionId' => ['description' => 'The ID of the current recall management service version.', 'type' => 'string', 'example' => '1', 'title' => ''], + 'CurrentRecallManagementServiceVersionName' => ['description' => 'The name of the current recall management service version.', 'type' => 'string', 'example' => 'version-1', 'title' => ''], + 'Status' => ['description' => 'The status. Valid values:'."\n" + ."\n" + .'- Online: online.'."\n" + ."\n" + .'- Offline: offline.', 'type' => 'string', 'example' => 'Online', 'title' => ''], + 'GmtCreateTime' => ['description' => 'The creation time.', 'type' => 'string', 'example' => '2021-12-15T23:24:33.132+08:00', 'title' => ''], + 'GmtModifiedTime' => ['description' => 'The modification time.', 'type' => 'string', 'example' => '2021-12-15T23:24:33.132+08:00', 'title' => ''], ], + 'title' => '', + 'example' => '', ], + 'title' => '', + 'example' => '', ], + 'NextToken' => ['description' => 'This parameter is not yet available.', 'type' => 'string', 'example' => '""', 'title' => ''], + 'MaxResults' => ['description' => 'This parameter is not yet available.', 'type' => 'integer', 'format' => 'int32', 'example' => '0', 'title' => ''], ], + 'example' => '', ], ], ], - 'staticInfo' => [ - 'returnType' => 'synchronous', + 'staticInfo' => ['returnType' => 'synchronous'], + 'title' => 'Retrieve the recall management service list', + 'summary' => 'This API returns a list of recall management services for a specified instance.', + 'description' => '## Description'."\n" + ."\n" + .'Call `ListRecallManagementServices` to retrieve a list of recall management services for a specified instance based on parameters such as `InstanceId`, `PageNumber`, and `PageSize`. You can sort the results by creation time or modification time in ascending or descending order.'."\n" + ."\n" + .'- **InstanceId** is required. It specifies the target instance.'."\n" + ."\n" + .'- The pagination parameters **PageNumber** and **PageSize** control the number of returned items and the page from which to start. This operation returns the first page of results by default.'."\n" + ."\n" + .'- Use the **SortBy** and **Order** parameters to customize the sort order of the list.', + 'changeSet' => [], + 'flowControl' => [ + 'flowControlList' => [], + ], + 'ramActions' => [ + [ + 'operationType' => 'list', + 'ramAction' => [ + 'action' => 'pairec:ListRecallManagementServices', + 'authLevel' => 'operate', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'PAIRecService', 'resourceType' => 'All Resource', 'arn' => '*'], + ], + ], + ], ], - 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"C5AEB79E-FAA4-5DCE-8CD7-1CAF549ECC3E\\",\\n \\"TotalCount\\": 10,\\n \\"SubCrowds\\": [\\n {\\n \\"SubCrowdId\\": \\"3\\",\\n \\"Source\\": \\"ManualInput\\",\\n \\"Users\\": \\"user1,user2\\",\\n \\"Quantity\\": 2,\\n \\"GmtCreateTime\\": \\"2021-12-15T23:24:33.132+08:00\\"\\n }\\n ]\\n}","type":"json"}]', + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"728C5E01-ABF6-5AA8-B9FC-B3BA05DECC77\\",\\n \\"TotalCount\\": \\"10\\",\\n \\"RecallManagementServices\\": [\\n {\\n \\"RecallManagementServiceId\\": \\"3\\",\\n \\"Name\\": \\"hot_group_recall\\",\\n \\"Description\\": \\"this is a test recall\\",\\n \\"CurrentRecallManagementServiceVersionId\\": \\"1\\",\\n \\"CurrentRecallManagementServiceVersionName\\": \\"version-1\\",\\n \\"Status\\": \\"Online\\",\\n \\"GmtCreateTime\\": \\"2021-12-15T23:24:33.132+08:00\\",\\n \\"GmtModifiedTime\\": \\"2021-12-15T23:24:33.132+08:00\\"\\n }\\n ],\\n \\"NextToken\\": \\"\\\\\\"\\\\\\"\\",\\n \\"MaxResults\\": 0\\n}","type":"json"}]', ], - 'GetSubCrowd' => [ - 'summary' => '获取指定人群下的指定子人群的详细信息。', - 'path' => '/api/v1/crowds/{CrowdId}/subcrowds/{SubCrowdId}', - 'methods' => [ - 'get', - ], - 'schemes' => [ - 'http', - 'https', - ], + 'ListRecallManagementTableVersions' => [ + 'summary' => 'Lists all versions of a specified RecallManagementTable.', + 'path' => '/api/v1/recallmanagementtables/{RecallManagementTableId}/versions', + 'methods' => ['get'], + 'schemes' => ['https'], 'security' => [ [ 'AK' => [], ], ], - 'consumes' => [ - 'application/json', - ], - 'produces' => [ - 'application/json', - ], + 'consumes' => ['application/json'], + 'produces' => ['application/json'], 'operationType' => 'read', 'deprecated' => false, 'systemTags' => [ - 'operationType' => 'get', + 'operationType' => 'none', 'riskType' => 'none', 'chargeType' => 'free', - 'abilityTreeNodes' => [ - 'FEATURElearnN0NAWV', - ], + 'abilityTreeNodes' => ['FEATURElearnN0NAWV'], ], 'parameters' => [ [ - 'name' => 'CrowdId', + 'name' => 'RecallManagementTableId', 'in' => 'path', - 'schema' => [ - 'title' => '人群ID。', - 'description' => '', - 'type' => 'string', - 'required' => true, - 'example' => '3', - ], + 'schema' => ['description' => 'The ID of the RecallManagementTable.', 'type' => 'string', 'required' => true, 'example' => '1', 'title' => ''], ], [ - 'name' => 'SubCrowdId', - 'in' => 'path', + 'name' => 'InstanceId', + 'in' => 'query', + 'schema' => ['description' => 'The ID of the instance.', 'type' => 'string', 'required' => true, 'example' => 'pairec-1324***', 'title' => ''], + ], + [ + 'name' => 'SortBy', + 'in' => 'query', + 'schema' => ['description' => 'The field to sort by. Valid values: `GmtCreateTime` (creation time) and `GmtModifiedTime` (update time).', 'type' => 'string', 'required' => false, 'example' => 'GmtCreateTime', 'title' => ''], + ], + [ + 'name' => 'Order', + 'in' => 'query', + 'schema' => ['description' => 'The sort order. Valid values: `ASC` (ascending order) and `DESC` (descending order).', 'type' => 'string', 'required' => false, 'example' => 'ASC', 'title' => ''], + ], + [ + 'name' => 'PageNumber', + 'in' => 'query', + 'schema' => ['description' => 'The page number.', 'type' => 'integer', 'format' => 'int32', 'required' => false, 'example' => '1', 'title' => ''], + ], + [ + 'name' => 'PageSize', + 'in' => 'query', + 'schema' => ['description' => 'The page size.', 'type' => 'integer', 'format' => 'int32', 'required' => false, 'example' => '10', 'title' => ''], + ], + ], + 'responses' => [ + 200 => [ 'schema' => [ - 'title' => '子人群ID。', - 'description' => '', - 'type' => 'string', - 'required' => true, - 'example' => '4', + 'type' => 'object', + 'properties' => [ + 'RequestId' => ['description' => 'The request ID.', 'type' => 'string', 'title' => '', 'example' => '728C5E01-ABF6-5AA8-B9FC-B3BA05DECC77'], + 'TotalCount' => ['description' => 'The total count.', 'type' => 'integer', 'format' => 'int64', 'example' => '10', 'title' => ''], + 'RecallManagementTableVersions' => [ + 'type' => 'array', + 'items' => [ + 'type' => 'object', + 'properties' => [ + 'RecallManagementTableVersionId' => ['description' => 'The ID of the RecallManagementTable version.', 'type' => 'string', 'example' => '202507010000', 'title' => ''], + 'EffectiveTime' => ['description' => 'The effective time.', 'type' => 'string', 'example' => '2021-12-15T23:24:33.132', 'title' => ''], + 'DataVersion' => ['description' => 'The data version.', 'type' => 'string', 'example' => 'ds=20250701', 'title' => ''], + 'SourceTableRowCount' => ['description' => 'The source table row count.', 'type' => 'integer', 'format' => 'int64', 'example' => '100', 'title' => ''], + 'SourceTableDataSize' => ['description' => 'The source table data size.', 'type' => 'integer', 'format' => 'int64', 'example' => '1000', 'title' => ''], + 'Status' => ['description' => 'The status of the version. Valid values:'."\n" + ."\n" + .'- Online: The version is online.'."\n" + ."\n" + .'- Offline: The version is offline.', 'type' => 'string', 'example' => 'Online', 'title' => ''], + 'PublishStartTime' => ['description' => 'The sync start time.', 'type' => 'string', 'example' => '2021-12-15T22:24:33.132', 'title' => ''], + 'PublishEndTime' => ['description' => 'The sync end time.', 'type' => 'string', 'example' => '2021-12-15T23:24:33.132', 'title' => ''], + ], + 'description' => '', + 'title' => '', + 'example' => '', + ], + 'description' => 'The list of RecallManagementTable versions.', + 'title' => '', + 'example' => '', + ], + ], + 'title' => '', + 'description' => 'The response schema', + 'example' => '', ], ], + ], + 'staticInfo' => ['returnType' => 'synchronous'], + 'title' => 'ListRecallManagementTableVersions', + 'description' => '## Usage'."\n" + ."\n" + .'- To retrieve the version history of a specific RecallManagementTable, provide the `RecallManagementTableId` and `InstanceId`.'."\n" + ."\n" + .'- Use the `SortBy` parameter to sort the results by creation time or update time. By default, the results are sorted by creation time in ascending order.'."\n" + ."\n" + .'- The `PageNumber` and `PageSize` parameters enable pagination, which allows you to control the number of items to return and the page to display.'."\n" + ."\n" + .'- If the `Order` parameter is not specified, the results are sorted in ascending order by default.', + 'changeSet' => [], + 'flowControl' => [ + 'flowControlList' => [], + ], + 'ramActions' => [ + [ + 'operationType' => 'none', + 'ramAction' => [ + 'action' => 'pairec:ListRecallManagementTableVersions', + 'authLevel' => 'operate', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'PAIRecService', 'resourceType' => 'All Resource', 'arn' => '*'], + ], + ], + ], + ], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"728C5E01-ABF6-5AA8-B9FC-B3BA05DECC77\\",\\n \\"TotalCount\\": 10,\\n \\"RecallManagementTableVersions\\": [\\n {\\n \\"RecallManagementTableVersionId\\": \\"202507010000\\",\\n \\"EffectiveTime\\": \\"2021-12-15T23:24:33.132\\",\\n \\"DataVersion\\": \\"ds=20250701\\",\\n \\"SourceTableRowCount\\": 100,\\n \\"SourceTableDataSize\\": 1000,\\n \\"Status\\": \\"Online\\",\\n \\"PublishStartTime\\": \\"2021-12-15T22:24:33.132\\",\\n \\"PublishEndTime\\": \\"2021-12-15T23:24:33.132\\"\\n }\\n ]\\n}","type":"json"}]', + ], + 'ListRecallManagementTables' => [ + 'summary' => 'Retrieves the recall management tables for a specified instance. Pagination and sorting are supported.', + 'path' => '/api/v1/recallmanagementtables', + 'methods' => ['get'], + 'schemes' => ['https'], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'consumes' => ['application/json'], + 'produces' => ['application/json'], + 'operationType' => 'read', + 'deprecated' => false, + 'systemTags' => [ + 'operationType' => 'list', + 'riskType' => 'none', + 'chargeType' => 'free', + 'abilityTreeNodes' => ['FEATURElearnN0NAWV'], + ], + 'parameters' => [ [ 'name' => 'InstanceId', 'in' => 'query', - 'schema' => [ - 'title' => '实例ID。', - 'description' => '', - 'type' => 'string', - 'required' => true, - 'example' => 'pairec-cn-abcdefg1234', - ], + 'schema' => ['description' => 'The ID of the instance.', 'type' => 'string', 'required' => true, 'example' => 'pairec-cn-test123', 'title' => ''], + ], + [ + 'name' => 'Name', + 'in' => 'query', + 'schema' => ['description' => 'The table name.', 'type' => 'string', 'required' => false, 'example' => 'table-1', 'title' => ''], + ], + [ + 'name' => 'Type', + 'in' => 'query', + 'schema' => ['description' => 'The table type. Valid values: `X2I` (U2I recall or I2I recall), `Vector` (vector recall), and `Random` (random recall).', 'type' => 'string', 'required' => false, 'example' => 'X2I', 'title' => ''], + ], + [ + 'name' => 'PageNumber', + 'in' => 'query', + 'schema' => ['description' => 'The page number.', 'type' => 'integer', 'format' => 'int32', 'required' => false, 'example' => '1', 'title' => ''], + ], + [ + 'name' => 'PageSize', + 'in' => 'query', + 'schema' => ['description' => 'The number of entries per page.', 'type' => 'integer', 'format' => 'int32', 'required' => false, 'example' => '10', 'title' => ''], + ], + [ + 'name' => 'SortBy', + 'in' => 'query', + 'schema' => ['description' => 'The field to sort the results by. Valid values: `GmtCreateTime` (creation time) and `GmtModifiedTime` (update time).', 'type' => 'string', 'required' => false, 'example' => 'GmtCreateTime', 'title' => ''], + ], + [ + 'name' => 'Order', + 'in' => 'query', + 'schema' => ['description' => 'The sort order for the results. Valid values: `ASC` (ascending) and `DESC` (descending).', 'type' => 'string', 'required' => false, 'example' => 'ASC', 'title' => ''], + ], + [ + 'name' => 'NextToken', + 'in' => 'query', + 'schema' => ['description' => 'This parameter is reserved for future use.', 'type' => 'string', 'required' => false, 'example' => '""', 'title' => ''], + ], + [ + 'name' => 'MaxResults', + 'in' => 'query', + 'schema' => ['description' => 'This parameter is reserved for future use.', 'type' => 'integer', 'format' => 'int32', 'required' => false, 'example' => '0', 'title' => ''], ], ], 'responses' => [ 200 => [ 'schema' => [ + 'description' => 'A container for the response data.', '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' => '01D22D08-BA20-5F35-8302-99115F288220', - ], - 'Source' => [ - 'title' => '人群来源。'."\n" - .'● ManualInput-手工输入'."\n" - .'● UploadFile-文件上传', - 'description' => '', - 'type' => 'string', - 'example' => 'ManualInput', - ], - 'Users' => [ - 'title' => '人群分组中的用户。', - 'description' => '', - 'type' => 'string', - 'example' => 'user1,user2', - ], - 'Quantity' => [ - 'title' => '人群分组所含的用户量。', - 'description' => '', - 'type' => 'string', - 'example' => '3', - ], - 'GmtCreateTime' => [ - 'title' => '人群创建时间。', - 'description' => '', - 'type' => 'string', - 'example' => '2021-12-15T23:24:33.132+08:00', + 'RequestId' => ['title' => 'Id of the request', 'description' => 'The request ID.', 'type' => 'string', 'example' => '728C5E01-ABF6-5AA8-B9FC-B3BA05DECC77'], + 'TotalCount' => ['description' => 'The total number of recall management tables.', 'type' => 'string', 'example' => '30', 'title' => ''], + 'RecallManagementTables' => [ + 'description' => 'A list of recall management tables.', + 'type' => 'array', + 'items' => [ + 'description' => 'The details of a recall management table.', + 'type' => 'object', + 'properties' => [ + 'RecallManagementTableId' => ['description' => 'The ID of the recall management table.', 'type' => 'string', 'example' => '3', 'title' => ''], + 'Name' => ['description' => 'The name of the recall management table.', 'type' => 'string', 'example' => 'table-123', 'title' => ''], + 'Description' => ['description' => 'The description of the recall management table.', 'type' => 'string', 'example' => 'this is a test', 'title' => ''], + 'Type' => ['description' => 'The type of the table.', 'type' => 'string', 'example' => 'Recall', 'title' => ''], + 'RecallType' => ['description' => 'The recall type of the table.', 'type' => 'string', 'example' => 'X2I', 'title' => ''], + 'DataSource' => ['description' => 'The data source.', 'type' => 'string', 'example' => 'Api', 'title' => ''], + 'MaxcomputeProjectName' => ['description' => 'The name of the MaxCompute project.', 'type' => 'string', 'example' => 'test', 'title' => ''], + 'MaxcomputeTableName' => ['description' => 'The name of the table in MaxCompute.', 'type' => 'string', 'example' => 'table-1', 'title' => ''], + 'CanDelete' => ['description' => 'Indicates whether the table can be deleted.', 'type' => 'boolean', 'example' => 'false', 'title' => ''], + 'IndexVersionId' => ['description' => 'The ID of the index version.', 'type' => 'string', 'example' => '20250701', 'title' => ''], + 'IndexEffectiveTime' => ['description' => 'The time when the index takes effect. The time is in the ISO 8601 format.', 'type' => 'string', 'example' => '2021-12-15T23:24:33.132+08:00', 'title' => ''], + 'GmtCreateTime' => ['description' => 'The time when the table was created. The time is in the ISO 8601 format.', 'type' => 'string', 'example' => '2021-12-15T23:24:33.132+08:00', 'title' => ''], + 'GmtModifiedTime' => ['description' => 'The time when the table was last modified. The time is in the ISO 8601 format.', 'type' => 'string', 'example' => '2021-12-15T23:24:33.132+08:00', 'title' => ''], + 'MaxcomputeSchema' => ['description' => 'The schema of the MaxCompute table.', 'type' => 'string', 'example' => 'default', 'title' => ''], + 'PartitionFields' => ['description' => 'The partition fields of the table.', 'type' => 'string', 'example' => 'dt', 'title' => ''], + ], + 'title' => '', + 'example' => '', + ], + 'title' => '', + 'example' => '', ], + 'NextToken' => ['description' => 'This parameter is reserved for future use.', 'type' => 'string', 'example' => '""', 'title' => ''], + 'MaxResults' => ['description' => 'This parameter is reserved for future use.', 'type' => 'integer', 'format' => 'int32', 'example' => '0', 'title' => ''], ], + 'example' => '', ], ], ], - 'staticInfo' => [ - 'returnType' => 'synchronous', + 'staticInfo' => ['returnType' => 'synchronous'], + 'title' => 'Retrieve the List of Recall Management Tables ', + 'description' => '## Request'."\n" + ."\n" + .'- **InstanceId** is a required parameter specifying the instance to query.'."\n" + ."\n" + .'- The **Name** and **Type** parameters filter recall management tables by name or type.'."\n" + ."\n" + .'- The **PageNumber** and **PageSize** parameters control pagination. By default, the query returns the first 50 records.'."\n" + ."\n" + .'- You can sort results by creation time (GmtCreateTime) or modification time (GmtModifiedTime) in ascending (ASC) or descending (DESC) order.', + 'changeSet' => [], + 'flowControl' => [ + 'flowControlList' => [], + ], + 'ramActions' => [ + [ + 'operationType' => 'list', + 'ramAction' => [ + 'action' => 'pairec:ListRecallManagementTables', + 'authLevel' => 'operate', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'PAIRecService', 'resourceType' => 'All Resource', 'arn' => '*'], + ], + ], + ], ], - 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"01D22D08-BA20-5F35-8302-99115F288220\\",\\n \\"Source\\": \\"ManualInput\\",\\n \\"Users\\": \\"user1,user2\\",\\n \\"Quantity\\": \\"3\\",\\n \\"GmtCreateTime\\": \\"2021-12-15T23:24:33.132+08:00\\"\\n}","type":"json"}]', + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"728C5E01-ABF6-5AA8-B9FC-B3BA05DECC77\\",\\n \\"TotalCount\\": \\"30\\",\\n \\"RecallManagementTables\\": [\\n {\\n \\"RecallManagementTableId\\": \\"3\\",\\n \\"Name\\": \\"table-123\\",\\n \\"Description\\": \\"this is a test\\",\\n \\"Type\\": \\"Recall\\",\\n \\"RecallType\\": \\"X2I\\",\\n \\"DataSource\\": \\"Api\\",\\n \\"MaxcomputeProjectName\\": \\"test\\",\\n \\"MaxcomputeTableName\\": \\"table-1\\",\\n \\"CanDelete\\": false,\\n \\"IndexVersionId\\": \\"20250701\\",\\n \\"IndexEffectiveTime\\": \\"2021-12-15T23:24:33.132+08:00\\",\\n \\"GmtCreateTime\\": \\"2021-12-15T23:24:33.132+08:00\\",\\n \\"GmtModifiedTime\\": \\"2021-12-15T23:24:33.132+08:00\\",\\n \\"MaxcomputeSchema\\": \\"default\\",\\n \\"PartitionFields\\": \\"dt\\"\\n }\\n ],\\n \\"NextToken\\": \\"\\\\\\"\\\\\\"\\",\\n \\"MaxResults\\": 0\\n}","type":"json"}]', ], - 'UpdateTableMeta' => [ - 'summary' => '获取数据表详细信息。', - 'path' => '/api/v1/tablemetas/{TableMetaId}', - 'methods' => [ - 'put', - ], - 'schemes' => [ - 'http', - 'https', - ], + 'ListScenes' => [ + 'path' => '/api/v1/scenes', + 'methods' => ['get'], + 'schemes' => ['http', 'https'], 'security' => [ [ 'AK' => [], ], ], - 'consumes' => [ - 'application/json', - ], - 'produces' => [ - 'application/json', - ], - 'operationType' => 'readAndWrite', + 'consumes' => ['application/json'], + 'produces' => ['application/json'], + 'operationType' => 'read', 'deprecated' => false, 'systemTags' => [ - 'operationType' => 'update', + 'operationType' => 'list', 'riskType' => 'none', 'chargeType' => 'free', - 'abilityTreeNodes' => [ - 'FEATURElearnN0NAWV', - ], + 'abilityTreeNodes' => ['FEATURElearnN0NAWV'], ], 'parameters' => [ [ - 'name' => 'TableMetaId', - 'in' => 'path', - 'schema' => [ - 'description' => '', - 'type' => 'string', - 'required' => true, - 'example' => '1', - ], + 'name' => 'InstanceId', + 'in' => 'query', + 'schema' => ['description' => 'The ID of the instance. You can obtain this ID by calling the `ListInstances` operation.', 'type' => 'string', 'example' => 'pairec-cn-abcdefg1234', 'title' => '', 'required' => false], ], [ - 'name' => 'body', - 'in' => 'body', - 'style' => 'json', + 'name' => 'Name', + 'in' => 'query', + 'schema' => ['description' => 'The name of the scene to use as a filter.', 'type' => 'string', 'example' => 'scene1', 'title' => '', 'required' => false], + ], + ], + 'responses' => [ + 200 => [ 'schema' => [ - 'description' => '', + 'title' => 'Schema of Response', + 'description' => 'The response object.', 'type' => 'object', 'properties' => [ - 'Name' => [ - 'description' => '', - 'type' => 'string', - 'required' => true, - 'example' => 'table_test', - ], - 'ResourceId' => [ - 'description' => '', - 'type' => 'string', - 'required' => true, - 'example' => 'reso-2s416t***', - ], - 'TableName' => [ - 'description' => '', - 'type' => 'string', - 'required' => true, - 'example' => 'table_mysql', - ], - 'Module' => [ - 'description' => '', - 'type' => 'string', - 'required' => true, - 'example' => 'ABTest', - ], - 'InstanceId' => [ - 'description' => '', - 'type' => 'string', - 'required' => true, - 'example' => 'pairec-cn-test1', - ], - 'Fields' => [ - 'description' => '', + 'RequestId' => ['title' => 'Id of the request', 'description' => 'The unique identifier for the request.', 'type' => 'string', 'example' => 'B8987BF7-6028-5B17-80E0-251B7BD67BBA'], + 'TotalCount' => ['description' => 'The total number of scenes.', 'type' => 'integer', 'format' => 'int64', 'example' => '10', 'title' => ''], + 'Scenes' => [ + 'title' => '', + 'description' => 'The list of scenes.', 'type' => 'array', 'items' => [ - 'description' => '', 'type' => 'object', 'properties' => [ - 'Name' => [ - 'description' => '', - 'type' => 'string', - 'required' => true, - 'example' => 'name', - ], - 'Meaning' => [ - 'description' => '', - 'type' => 'string', - 'required' => true, + 'SceneId' => ['description' => 'The unique ID of the scene.', 'type' => 'string', 'example' => '3', 'title' => ''], + 'Name' => ['description' => 'The name of the scene.', 'type' => 'string', 'example' => 'scene1', 'title' => ''], + 'Description' => ['description' => 'The description of the scene.', 'type' => 'string', 'example' => 'This is a test.', 'title' => ''], + 'Flows' => [ + 'title' => '', + 'description' => 'The list of flows associated with the scene.', + 'type' => 'array', + 'items' => [ + 'type' => 'object', + 'properties' => [ + 'FlowName' => ['description' => 'The name of the flow.', 'type' => 'string', 'example' => '流量1', 'title' => ''], + 'FlowCode' => ['description' => 'The code of the flow.', 'type' => 'string', 'example' => 'liuliang1', 'title' => ''], + ], + 'description' => '', + 'title' => '', + 'example' => '', + ], 'example' => '', ], - 'Type' => [ - 'description' => '', - 'type' => 'string', - 'required' => true, - 'example' => 'BIGINT', - ], - 'IsDimensionField' => [ - 'description' => '', - 'type' => 'boolean', - 'required' => true, - 'example' => 'false', - ], - 'DataType' => [ - 'type' => 'string', - ], - 'IsPartitionField' => [ - 'type' => 'string', - 'required' => true, - ], ], - 'required' => false, + 'description' => '', + 'title' => '', + 'example' => '', ], - 'required' => true, - ], - 'Description' => [ - 'description' => '', - 'type' => 'string', - 'required' => false, - 'example' => 'this is a test table', + 'example' => '', ], ], - 'required' => false, + 'example' => '', ], ], ], + 'staticInfo' => ['returnType' => 'synchronous'], + 'title' => 'Obtain the scenario list ', + 'summary' => 'Retrieves a list of scenes.', + 'changeSet' => [], + 'flowControl' => [ + 'flowControlList' => [], + ], + 'ramActions' => [ + [ + 'operationType' => 'list', + 'ramAction' => [ + 'action' => 'pairec:ListScenes', + 'authLevel' => 'operate', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'PAIRecService', 'resourceType' => 'All Resource', 'arn' => '*'], + ], + ], + ], + ], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"B8987BF7-6028-5B17-80E0-251B7BD67BBA\\",\\n \\"TotalCount\\": 10,\\n \\"Scenes\\": [\\n {\\n \\"SceneId\\": \\"3\\",\\n \\"Name\\": \\"scene1\\",\\n \\"Description\\": \\"This is a test.\\",\\n \\"Flows\\": [\\n {\\n \\"FlowName\\": \\"流量1\\",\\n \\"FlowCode\\": \\"liuliang1\\"\\n }\\n ]\\n }\\n ]\\n}","type":"json"}]', + ], + 'ListSubCrowds' => [ + 'summary' => 'Lists the subcrowds for a specified crowd.', + 'path' => '/api/v1/crowds/{CrowdId}/subcrowds', + 'methods' => ['get'], + 'schemes' => ['http', 'https'], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'consumes' => ['application/json'], + 'produces' => ['application/json'], + 'operationType' => 'read', + 'deprecated' => false, + 'systemTags' => [ + 'operationType' => 'list', + 'riskType' => 'none', + 'chargeType' => 'free', + 'abilityTreeNodes' => ['FEATURElearnN0NAWV'], + ], + 'parameters' => [ + [ + 'name' => 'CrowdId', + 'in' => 'path', + 'schema' => ['description' => 'The crowd ID. You can call the ListCrowds operation to obtain this ID.', 'type' => 'string', 'required' => true, 'example' => '3', 'title' => ''], + ], + [ + 'name' => 'InstanceId', + 'in' => 'query', + 'schema' => ['description' => 'The instance ID. You can call the ListInstances operation to obtain this ID.', 'type' => 'string', 'required' => true, 'example' => 'pairec-cn-abcdefg1234', 'title' => ''], + ], + ], 'responses' => [ 200 => [ 'schema' => [ 'title' => 'Schema of Response', - 'description' => 'Schema of Response', + 'description' => 'The response object.', 'type' => 'object', 'properties' => [ - 'RequestId' => [ - 'title' => 'Id of the request', - 'description' => '', - 'type' => 'string', - 'example' => '728C5E01-ABF6-5AA8-B9FC-B3BA05DECC77', + 'RequestId' => ['title' => 'Id of the request', 'description' => 'The ID of the request.', 'type' => 'string', 'example' => 'C5AEB79E-FAA4-5DCE-8CD7-1CAF549ECC3E'], + 'TotalCount' => ['description' => 'The total number of subcrowds.', 'type' => 'integer', 'format' => 'int64', 'example' => '10', 'title' => ''], + 'SubCrowds' => [ + 'title' => '', + 'description' => 'The list of subcrowds.', + 'type' => 'array', + 'items' => [ + 'type' => 'object', + 'properties' => [ + 'SubCrowdId' => ['description' => 'The subcrowd ID.', 'type' => 'string', 'example' => '3', 'title' => ''], + 'Source' => ['description' => 'The source of the subcrowd.<br>● ManualInput: Users were added manually.<br>● UploadFile: Users were added by uploading a file.<br><br>', 'type' => 'string', 'example' => 'ManualInput', 'title' => ''], + 'Users' => ['description' => 'The users in the subcrowd.', 'type' => 'string', 'example' => 'user1,user2', 'title' => ''], + 'Quantity' => ['description' => 'The number of users in the subcrowd.', 'type' => 'integer', 'format' => 'int32', 'example' => '2', 'title' => ''], + 'GmtCreateTime' => ['description' => 'The time when the subcrowd was created.', 'type' => 'string', 'example' => '2021-12-15T23:24:33.132+08:00', 'title' => ''], + ], + 'description' => '', + 'title' => '', + 'example' => '', + ], + 'example' => '', ], ], + 'example' => '', ], ], ], - 'staticInfo' => [ - 'returnType' => 'synchronous', + 'staticInfo' => ['returnType' => 'synchronous'], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"C5AEB79E-FAA4-5DCE-8CD7-1CAF549ECC3E\\",\\n \\"TotalCount\\": 10,\\n \\"SubCrowds\\": [\\n {\\n \\"SubCrowdId\\": \\"3\\",\\n \\"Source\\": \\"ManualInput\\",\\n \\"Users\\": \\"user1,user2\\",\\n \\"Quantity\\": 2,\\n \\"GmtCreateTime\\": \\"2021-12-15T23:24:33.132+08:00\\"\\n }\\n ]\\n}","type":"json"}]', + 'title' => 'Obtain the sub-audience list ', + 'changeSet' => [], + 'flowControl' => [ + 'flowControlList' => [], + ], + 'ramActions' => [ + [ + 'operationType' => 'list', + 'ramAction' => [ + 'action' => 'pairec:ListSubCrowds', + 'authLevel' => 'operate', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'PAIRecService', 'resourceType' => 'All Resource', 'arn' => '*'], + ], + ], + ], ], - 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"728C5E01-ABF6-5AA8-B9FC-B3BA05DECC77\\"\\n}","type":"json"}]', ], 'ListTableMetas' => [ - 'summary' => '获取数据表列表。', + 'summary' => 'Retrieves a list of data tables.', 'path' => '/api/v1/tablemetas', - 'methods' => [ - 'get', - ], - 'schemes' => [ - 'http', - 'https', - ], + 'methods' => ['get'], + 'schemes' => ['http', 'https'], 'security' => [ [ 'AK' => [], ], ], - 'consumes' => [ - 'application/json', - ], - 'produces' => [ - 'application/json', - ], + 'consumes' => ['application/json'], + 'produces' => ['application/json'], 'operationType' => 'read', 'deprecated' => false, 'systemTags' => [ 'operationType' => 'list', 'riskType' => 'none', 'chargeType' => 'free', - 'abilityTreeNodes' => [ - 'FEATURElearnN0NAWV', - ], + 'abilityTreeNodes' => ['FEATURElearnN0NAWV'], ], 'parameters' => [ [ 'name' => 'Type', 'in' => 'query', - 'schema' => [ - 'description' => '', - 'type' => 'string', - 'required' => false, - 'example' => 'MaxCompute', - ], + 'schema' => ['description' => 'The type of the data table. Valid values:'."\n" + ."\n" + .'- MaxCompute'."\n" + ."\n" + .'- Hologres', 'type' => 'string', 'required' => false, 'example' => 'MaxCompute', 'title' => ''], ], [ 'name' => 'Name', 'in' => 'query', - 'schema' => [ - 'description' => '', - 'type' => 'string', - 'required' => false, - 'example' => 'test1', - ], + 'schema' => ['description' => 'The table name to filter on.', 'type' => 'string', 'required' => false, 'example' => 'test1', 'title' => ''], ], [ 'name' => 'Module', 'in' => 'query', - 'schema' => [ - 'description' => '', - 'type' => 'string', - 'required' => true, - 'example' => 'ABTest', - ], + 'schema' => ['description' => 'The module of the data table. Valid values:'."\n" + ."\n" + .'- ABTest: A/B testing data tables'."\n" + ."\n" + .'- ExperimentTool: experiment tool tables'."\n" + ."\n" + .'- DataDiagnosis: data diagnosis tables', 'type' => 'string', 'required' => true, 'example' => 'ABTest', 'title' => ''], ], [ 'name' => 'PageNumber', 'in' => 'query', - 'schema' => [ - 'description' => '', - 'type' => 'integer', - 'format' => 'int32', - 'required' => false, - 'example' => '1', - ], + 'schema' => ['description' => 'The page number.', 'type' => 'integer', 'format' => 'int32', 'required' => false, 'example' => '1', 'title' => ''], ], [ 'name' => 'PageSize', 'in' => 'query', - 'schema' => [ - 'description' => '', - 'type' => 'integer', - 'format' => 'int32', - 'required' => false, - 'example' => '10', - ], + 'schema' => ['description' => 'The number of entries to return on each page.', 'type' => 'integer', 'format' => 'int32', 'required' => false, 'example' => '10', 'title' => ''], ], [ 'name' => 'InstanceId', 'in' => 'query', - 'schema' => [ - 'description' => '', - 'type' => 'string', - 'required' => true, - 'example' => 'pairec-cn-test1', - ], + 'schema' => ['description' => 'The instance ID. You can get this ID by calling the [ListInstances](~~2411819~~) operation.', 'type' => 'string', 'required' => true, 'example' => 'pairec-cn-test1', 'title' => ''], ], ], 'responses' => [ 200 => [ 'schema' => [ 'title' => 'Schema of Response', - 'description' => 'Schema of Response', + 'description' => 'The data returned.', 'type' => 'object', 'properties' => [ - 'RequestId' => [ - 'title' => 'Id of the request', - 'description' => '', - 'type' => 'string', - 'example' => '728C5E01-ABF6-5AA8-B9FC-B3BA05DECC77', - ], - 'TotalCount' => [ - 'description' => '', - 'type' => 'integer', - 'format' => 'int64', - 'example' => '20', - ], + 'RequestId' => ['title' => 'Id of the request', 'description' => 'The request ID.', 'type' => 'string', 'example' => '728C5E01-ABF6-5AA8-B9FC-B3BA05DECC77'], + 'TotalCount' => ['description' => 'The total number of data tables.', 'type' => 'integer', 'format' => 'int64', 'example' => '20', 'title' => ''], 'TableMetas' => [ - 'description' => '', + 'description' => 'The list of data tables.', 'type' => 'array', 'items' => [ - 'description' => '', + 'description' => 'The metadata of a data table.', 'type' => 'object', 'properties' => [ - 'TableMetaId' => [ - 'description' => '', - 'type' => 'string', - 'example' => '3', - ], - 'Name' => [ - 'description' => '', - 'type' => 'string', - 'example' => 'test_table', - ], - 'Description' => [ - 'description' => '', - 'type' => 'string', - 'example' => 'this is a test table', - ], - 'ResourceId' => [ - 'description' => '', - 'type' => 'string', - 'example' => 'reso-2s416t***', - ], - 'TableName' => [ - 'description' => '', - 'type' => 'string', - 'example' => 'table_mysql', - ], - 'Type' => [ - 'description' => '', - 'type' => 'string', - 'example' => 'MaxCompute', - ], - 'Module' => [ - 'description' => '', - 'type' => 'string', - 'example' => 'ABTest', - ], - 'CanDelete' => [ - 'description' => '', - 'type' => 'boolean', - 'example' => 'true', - ], - 'GmtCreateTime' => [ - 'description' => '', - 'type' => 'string', - 'example' => '2021-12-12 12:24:33', - ], - 'GmtModifiedTime' => [ - 'description' => '', - 'type' => 'string', - 'example' => '2021-12-12 12:24:33', - ], - 'GmtImportedTime' => [ - 'description' => '', - 'type' => 'string', - 'example' => 'imprecation', - ], + 'TableMetaId' => ['description' => 'The ID of the data table.', 'type' => 'string', 'example' => '3', 'title' => ''], + 'Name' => ['description' => 'The name of the data table.', 'type' => 'string', 'example' => 'test_table', 'title' => ''], + 'Description' => ['description' => 'The description of the data table.', 'type' => 'string', 'example' => 'this is a test table', 'title' => ''], + 'ResourceId' => ['description' => 'The resource ID.', 'type' => 'string', 'example' => 'reso-2s416t***', 'title' => ''], + 'TableName' => ['description' => 'The name of the table in the database.', 'type' => 'string', 'example' => 'table_mysql', 'title' => ''], + 'Type' => ['description' => 'The type of the data table. Valid values:'."\n" + ."\n" + .'- MaxCompute'."\n" + ."\n" + .'- Hologres', 'type' => 'string', 'example' => 'MaxCompute', 'title' => ''], + 'Module' => ['description' => 'The module of the data table. Valid values:'."\n" + ."\n" + .'- ABTest: A/B testing'."\n" + ."\n" + .'- ExperimentTool: Experiment tool'."\n" + ."\n" + .'- DataDiagnosis: data diagnosis', 'type' => 'string', 'example' => 'ABTest', 'title' => ''], + 'CanDelete' => ['description' => 'Indicates whether the data table can be deleted. A value of `false` indicates that the table is in use by other resources.', 'type' => 'boolean', 'example' => 'true', 'title' => ''], + 'GmtCreateTime' => ['description' => 'The time when the data table was created.', 'type' => 'string', 'example' => '2021-12-12 12:24:33', 'title' => ''], + 'GmtModifiedTime' => ['description' => 'The time when the data table was last modified.', 'type' => 'string', 'example' => '2021-12-12 12:24:33', 'title' => ''], + 'GmtImportedTime' => ['description' => 'The time when the fields were imported.', 'type' => 'string', 'example' => 'imprecation', 'title' => ''], 'Fields' => [ - 'description' => '', + 'description' => 'The fields in the data table.', 'type' => 'array', 'items' => [ - 'description' => '', + 'description' => 'The details of a field.', 'type' => 'object', 'properties' => [ - 'Name' => [ - 'description' => '', - 'type' => 'string', - 'example' => 'gender', - ], - 'Meaning' => [ - 'description' => '', - 'type' => 'string', - 'example' => 'the gender of people', - ], - 'Type' => [ - 'description' => '', - 'type' => 'string', - 'example' => 'BIGINT', - ], - 'IsDimensionField' => [ - 'description' => '', - 'type' => 'boolean', - 'example' => 'false', - ], + 'Name' => ['description' => 'The name of the field.', 'type' => 'string', 'example' => 'gender', 'title' => ''], + 'Meaning' => ['description' => 'The business meaning of the field.', 'type' => 'string', 'example' => 'the gender of people', 'title' => ''], + 'Type' => ['description' => 'The data type of the field.', 'type' => 'string', 'example' => 'BIGINT', 'title' => ''], + 'IsDimensionField' => ['description' => 'Indicates whether the field is a dimension field.', 'type' => 'boolean', 'example' => 'false', 'title' => ''], ], + 'title' => '', + 'example' => '', ], + 'title' => '', + 'example' => '', ], - 'Url' => [ - 'description' => '', - 'type' => 'string', - 'example' => 'https://dmc-xxx.com/dm/table/xxx', - ], - 'Config' => [ - 'type' => 'string', - ], + 'Url' => ['description' => 'The URL of the table in Data Map. This parameter is returned only for MaxCompute data tables.', 'type' => 'string', 'example' => 'https://dmc-xxx.com/dm/table/xxx', 'title' => ''], + 'Config' => ['description' => 'The additional configurations for the data table.', 'type' => 'string', 'example' => '{"table_type":"item"}', 'title' => ''], + 'ResourceType' => ['type' => 'string', 'example' => 'Maxcompute', 'description' => '', 'title' => ''], + 'ResourceUri' => ['type' => 'string', 'example' => 'test', 'description' => '', 'title' => ''], ], + 'title' => '', + 'example' => '', ], + 'title' => '', + 'example' => '', ], ], + 'example' => '', ], ], ], - 'staticInfo' => [ - 'returnType' => 'synchronous', + 'staticInfo' => ['returnType' => 'synchronous'], + 'title' => 'Obtain Data Table List', + 'changeSet' => [ + ['createdAt' => '2024-02-22T03:35:43.000Z', 'description' => 'Request parameters changed, Response parameters changed'], ], - 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"728C5E01-ABF6-5AA8-B9FC-B3BA05DECC77\\",\\n \\"TotalCount\\": 20,\\n \\"TableMetas\\": [\\n {\\n \\"TableMetaId\\": \\"3\\",\\n \\"Name\\": \\"test_table\\",\\n \\"Description\\": \\"this is a test table\\",\\n \\"ResourceId\\": \\"reso-2s416t***\\",\\n \\"TableName\\": \\"table_mysql\\",\\n \\"Type\\": \\"MaxCompute\\",\\n \\"Module\\": \\"ABTest\\",\\n \\"CanDelete\\": true,\\n \\"GmtCreateTime\\": \\"2021-12-12 12:24:33\\",\\n \\"GmtModifiedTime\\": \\"2021-12-12 12:24:33\\",\\n \\"GmtImportedTime\\": \\"imprecation\\",\\n \\"Fields\\": [\\n {\\n \\"Name\\": \\"gender\\",\\n \\"Meaning\\": \\"the gender of people\\",\\n \\"Type\\": \\"BIGINT\\",\\n \\"IsDimensionField\\": false\\n }\\n ],\\n \\"Url\\": \\"https://dmc-xxx.com/dm/table/xxx\\",\\n \\"Config\\": \\"{\\\\\\"table_type\\\\\\":\\\\\\"item\\\\\\"}\\"\\n }\\n ]\\n}","type":"json"}]', - ], - 'GetTableMeta' => [ - 'summary' => '获取数据表详细信息。', - 'path' => '/api/v1/tablemetas/{TableMetaId}', - 'methods' => [ - 'get', + 'flowControl' => [ + 'flowControlList' => [], ], - 'schemes' => [ - 'http', - 'https', + 'ramActions' => [ + [ + 'operationType' => 'list', + 'ramAction' => [ + 'action' => 'pairec:ListTableMetas', + 'authLevel' => 'operate', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'PAIRecService', 'resourceType' => 'All Resource', 'arn' => '*'], + ], + ], + ], ], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"728C5E01-ABF6-5AA8-B9FC-B3BA05DECC77\\",\\n \\"TotalCount\\": 20,\\n \\"TableMetas\\": [\\n {\\n \\"TableMetaId\\": \\"3\\",\\n \\"Name\\": \\"test_table\\",\\n \\"Description\\": \\"this is a test table\\",\\n \\"ResourceId\\": \\"reso-2s416t***\\",\\n \\"TableName\\": \\"table_mysql\\",\\n \\"Type\\": \\"MaxCompute\\",\\n \\"Module\\": \\"ABTest\\",\\n \\"CanDelete\\": true,\\n \\"GmtCreateTime\\": \\"2021-12-12 12:24:33\\",\\n \\"GmtModifiedTime\\": \\"2021-12-12 12:24:33\\",\\n \\"GmtImportedTime\\": \\"imprecation\\",\\n \\"Fields\\": [\\n {\\n \\"Name\\": \\"gender\\",\\n \\"Meaning\\": \\"the gender of people\\",\\n \\"Type\\": \\"BIGINT\\",\\n \\"IsDimensionField\\": false\\n }\\n ],\\n \\"Url\\": \\"https://dmc-xxx.com/dm/table/xxx\\",\\n \\"Config\\": \\"{\\\\\\"table_type\\\\\\":\\\\\\"item\\\\\\"}\\",\\n \\"ResourceType\\": \\"Maxcompute\\",\\n \\"ResourceUri\\": \\"test\\"\\n }\\n ]\\n}","type":"json"}]', + ], + 'ListTrafficControlTargetTrafficHistory' => [ + 'path' => '/api/v1/trafficcontroltargets/{TrafficControlTargetId}/traffichistories', + 'methods' => ['get'], + 'schemes' => ['http', 'https'], 'security' => [ [ 'AK' => [], ], ], - 'consumes' => [ - 'application/json', - ], - 'produces' => [ - 'application/json', - ], - 'operationType' => 'read', + 'consumes' => ['application/json'], + 'produces' => ['application/json'], + 'operationType' => 'readAndWrite', 'deprecated' => false, 'systemTags' => [ - 'operationType' => 'get', + 'operationType' => 'none', 'riskType' => 'none', 'chargeType' => 'free', - 'abilityTreeNodes' => [ - 'FEATURElearnN0NAWV', - ], + 'abilityTreeCode' => '220605', + 'abilityTreeNodes' => ['FEATURElearnN0NAWV'], ], 'parameters' => [ [ - 'name' => 'TableMetaId', + 'name' => 'TrafficControlTargetId', 'in' => 'path', - 'schema' => [ - 'description' => '', - 'type' => 'string', - 'required' => true, - 'example' => '2', - ], + 'schema' => ['description' => 'The ID of the traffic control target.', 'type' => 'string', 'required' => false, 'example' => '2', 'title' => ''], + ], + [ + 'name' => 'Environment', + 'in' => 'query', + 'schema' => ['description' => 'The target environment. Valid values: Daily, Pre, and Prod.', 'type' => 'string', 'required' => false, 'example' => 'Pre', 'title' => ''], + ], + [ + 'name' => 'StartTime', + 'in' => 'query', + 'schema' => ['description' => 'The start of the time range.', 'type' => 'string', 'required' => false, 'example' => '2024-01-01 13:13:20', 'title' => ''], + ], + [ + 'name' => 'EndTime', + 'in' => 'query', + 'schema' => ['description' => 'The end of the time range.', 'type' => 'string', 'required' => false, 'example' => '2024-01-10 13:13:20', 'title' => ''], + ], + [ + 'name' => 'Threshold', + 'in' => 'query', + 'schema' => ['description' => 'The threshold value.', 'type' => 'string', 'required' => false, 'example' => '20', 'title' => ''], + ], + [ + 'name' => 'ExperimentId', + 'in' => 'query', + 'schema' => ['description' => 'The ID of the experiment.', 'type' => 'string', 'required' => false, 'example' => 'ER_All', 'title' => ''], + ], + [ + 'name' => 'ExperimentGroupId', + 'in' => 'query', + 'schema' => ['description' => 'The ID of the experiment group.', 'type' => 'string', 'required' => false, 'example' => '2', 'title' => ''], + ], + [ + 'name' => 'ItemId', + 'in' => 'query', + 'schema' => ['description' => 'The ID of the item.', 'type' => 'string', 'required' => false, 'example' => '1001', 'title' => ''], ], [ 'name' => 'InstanceId', 'in' => 'query', - 'schema' => [ - 'description' => '', - 'type' => 'string', - 'required' => true, - 'example' => '', - ], + 'schema' => ['description' => 'The ID of the instance.', 'type' => 'string', 'required' => false, 'example' => 'pairec-1324***', 'title' => ''], ], ], 'responses' => [ 200 => [ 'schema' => [ - 'title' => 'Schema of Response', - 'description' => 'Schema of Response', + 'description' => 'The response body.', + 'title' => 'Schema of Response ', 'type' => 'object', 'properties' => [ - 'RequestId' => [ - 'title' => 'Id of the request', - 'description' => '', - 'type' => 'string', - 'example' => '28C5E01-ABF6-5AA8-B9FC-B3BA05DECC77', - ], - 'Name' => [ - 'description' => '', - 'type' => 'string', - 'example' => 'test_table', - ], - 'Description' => [ - 'description' => '', - 'type' => 'string', - 'example' => 'this is a test table', - ], - 'ResourceId' => [ - 'description' => '', - 'type' => 'string', - 'example' => 'reso-wkgo***', - ], - 'TableName' => [ - 'description' => '', - 'type' => 'string', - 'example' => 'table_mysql', - ], - 'Type' => [ - 'description' => '', - 'type' => 'string', - 'example' => 'MaxCompute', - ], - 'Module' => [ - 'description' => '', - 'type' => 'string', - 'example' => 'ABTest', - ], - 'CanDelete' => [ - 'description' => '', - 'type' => 'boolean', - 'example' => 'false', - ], - 'GmtCreateTime' => [ - 'description' => '', - 'type' => 'string', - 'example' => '2021-12-15:24:33', - ], - 'GmtModifiedTime' => [ - 'description' => '', - 'type' => 'string', - 'example' => '2021-12-15:24:33', - ], - 'Fields' => [ - 'description' => '', + 'RequestId' => ['title' => 'Id of the request ', 'description' => 'The ID of the request.', 'type' => 'string', 'example' => '728C5E01-ABF6-5AA8-B9FC-B3BA05DECC77'], + 'TotalCount' => ['description' => 'The total count of historical records.', 'type' => 'string', 'example' => '10', 'title' => ''], + 'TrafficControlTaskTrafficHistories' => [ + 'description' => 'A list of the traffic control history records.', 'type' => 'array', 'items' => [ - 'description' => '', + 'description' => 'The details of a single traffic control history record.', 'type' => 'object', 'properties' => [ - 'Name' => [ - 'description' => '', - 'type' => 'string', - 'example' => 'gender', - ], - 'Meaning' => [ - 'description' => '', - 'type' => 'string', - 'example' => 'the gender of people', - ], - 'Type' => [ - 'description' => '', - 'type' => 'string', - 'example' => 'BIGINT', - ], - 'IsDimensionField' => [ - 'description' => '', - 'type' => 'boolean', - 'example' => 'false', - ], + 'RecordTime' => ['description' => 'The timestamp of the record.', 'type' => 'string', 'example' => '2023-10-10 10:10:58', 'title' => ''], + 'ItemId' => ['description' => 'The ID of the item.', 'type' => 'string', 'example' => '1001', 'title' => ''], + 'ExperimentId' => ['description' => 'The ID of the experiment.', 'type' => 'string', 'example' => 'E1', 'title' => ''], + 'TrafficControlTargetTraffic' => ['description' => 'The actual traffic of the traffic control target.', 'type' => 'number', 'format' => 'double', 'example' => '20', 'title' => ''], + 'TrafficControlTargetAimTraffic' => ['description' => 'The intended traffic for the traffic control target.', 'type' => 'number', 'format' => 'double', 'example' => '30', 'title' => ''], + 'TrafficControlTaskTraffic' => ['description' => 'The overall traffic of the traffic control task.', 'type' => 'number', 'format' => 'double', 'example' => '60', 'title' => ''], ], + 'title' => '', + 'example' => '', ], - ], - 'Url' => [ - 'description' => '', - 'type' => 'string', - 'example' => 'https://dmc-xxx.com/dm/table/xxx'."\n", - ], - 'TableMetaId' => [ - 'type' => 'string', - ], - 'GmtImportedTime' => [ - 'type' => 'string', - ], - 'Config' => [ - 'type' => 'string', + 'title' => '', + 'example' => '', ], ], + 'example' => '', ], ], ], - 'staticInfo' => [ - 'returnType' => 'synchronous', + 'staticInfo' => ['returnType' => 'synchronous'], + 'eventInfo' => [ + 'enable' => false, + 'eventNames' => [], + ], + 'title' => 'Retrieve traffic control task history', + 'summary' => 'Retrieves the historical traffic records for a specific traffic control target.', + 'description' => '## Usage notes'."\n" + ."\n" + .'- The `TrafficControlTargetId`, `InstanceId`, and `Environment` parameters are required.'."\n" + ."\n" + .'- You can use `StartTime` and `EndTime` to specify the time range.'."\n" + ."\n" + .'- The `Threshold` parameter is optional.'."\n" + ."\n" + .'- Use `ExperimentId` and `ExperimentGroupId` to filter data for a specific experiment or experiment group.'."\n" + ."\n" + .'- Use `ItemId` to filter traffic data for a specific item.'."\n" + ."\n" + .'- The supported environments are the Daily environment, pre-production environment (Pre), and production environment (Prod).', + 'changeSet' => [], + 'flowControl' => [ + 'flowControlList' => [], + ], + 'ramActions' => [ + [ + 'operationType' => 'none', + 'ramAction' => [ + 'action' => 'pairec:ListTrafficControlTargetTrafficHistory', + 'authLevel' => 'operate', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'PAIRecService', 'resourceType' => 'All Resource', 'arn' => '*'], + ], + ], + ], ], - 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"28C5E01-ABF6-5AA8-B9FC-B3BA05DECC77\\",\\n \\"Name\\": \\"test_table\\",\\n \\"Description\\": \\"this is a test table\\",\\n \\"ResourceId\\": \\"reso-wkgo***\\",\\n \\"TableName\\": \\"table_mysql\\",\\n \\"Type\\": \\"MaxCompute\\",\\n \\"Module\\": \\"ABTest\\",\\n \\"CanDelete\\": false,\\n \\"GmtCreateTime\\": \\"2021-12-15:24:33\\",\\n \\"GmtModifiedTime\\": \\"2021-12-15:24:33\\",\\n \\"Fields\\": [\\n {\\n \\"Name\\": \\"gender\\",\\n \\"Meaning\\": \\"the gender of people\\",\\n \\"Type\\": \\"BIGINT\\",\\n \\"IsDimensionField\\": false\\n }\\n ],\\n \\"Url\\": \\"https://dmc-xxx.com/dm/table/xxx\\\\n\\",\\n \\"TableMetaId\\": \\"3\\",\\n \\"GmtImportedTime\\": \\"2021-12-15T23:24:33.132+08:00\\",\\n \\"Config\\": \\"{\\\\\\"table_type\\\\\\":\\\\\\"item\\\\\\"}\\"\\n}","type":"json"}]', + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"728C5E01-ABF6-5AA8-B9FC-B3BA05DECC77\\",\\n \\"TotalCount\\": \\"10\\",\\n \\"TrafficControlTaskTrafficHistories\\": [\\n {\\n \\"RecordTime\\": \\"2023-10-10 10:10:58\\",\\n \\"ItemId\\": \\"1001\\",\\n \\"ExperimentId\\": \\"E1\\",\\n \\"TrafficControlTargetTraffic\\": 20,\\n \\"TrafficControlTargetAimTraffic\\": 30,\\n \\"TrafficControlTaskTraffic\\": 60\\n }\\n ]\\n}","type":"json"}]', ], - 'DeleteTableMeta' => [ - 'summary' => '删除数据表。', - 'path' => '/api/v1/tablemetas/{TableMetaId}', - 'methods' => [ - 'delete', - ], - 'schemes' => [ - 'http', - 'https', - ], + 'ListTrafficControlTasks' => [ + 'summary' => 'Lists traffic control tasks that meet specified conditions.', + 'path' => '/api/v1/trafficcontroltasks', + 'methods' => ['get'], + 'schemes' => ['http', 'https'], 'security' => [ [ 'AK' => [], ], ], - 'consumes' => [ - 'application/json', - ], - 'produces' => [ - 'application/json', - ], - 'operationType' => 'write', + 'consumes' => ['application/json'], + 'produces' => ['application/json'], + 'operationType' => 'read', 'deprecated' => false, 'systemTags' => [ - 'operationType' => 'delete', + 'operationType' => 'list', 'riskType' => 'none', 'chargeType' => 'free', - 'abilityTreeNodes' => [ - 'FEATURElearnN0NAWV', - ], + 'abilityTreeCode' => '220400', + 'abilityTreeNodes' => ['FEATURElearnN0NAWV'], ], 'parameters' => [ [ - 'name' => 'TableMetaId', - 'in' => 'path', - 'schema' => [ - 'description' => '', - 'type' => 'string', - 'required' => true, - 'example' => '2', - ], + 'name' => 'Name', + 'in' => 'query', + 'schema' => ['description' => 'The name of the traffic control task.', 'type' => 'string', 'required' => false, 'example' => 'task_1', 'title' => ''], + ], + [ + 'name' => 'TrafficControlTaskId', + 'in' => 'query', + 'schema' => ['description' => 'The ID of the traffic control task.', 'type' => 'string', 'required' => false, 'example' => '1', 'title' => ''], + ], + [ + 'name' => 'SceneId', + 'in' => 'query', + 'schema' => ['description' => 'The ID of the scene. You can obtain this ID by calling the [ListScenes](~~2402581~~) operation.', 'type' => 'string', 'required' => false, 'example' => '1', 'title' => ''], + ], + [ + 'name' => 'Environment', + 'in' => 'query', + 'schema' => ['description' => 'The environment. Valid values:'."\n" + ."\n" + .'- `Daily`: the daily environment'."\n" + ."\n" + .'- `Pre`: the pre-production environment'."\n" + ."\n" + .'- `Prod`: the production environment', 'type' => 'string', 'required' => false, 'example' => 'Pre', 'title' => ''], + ], + [ + 'name' => 'Status', + 'in' => 'query', + 'schema' => ['description' => 'The status of the task. Valid values:'."\n" + ."\n" + .'- `NotRunning`: The task is not running.'."\n" + ."\n" + .'- `Ready`: The task is ready to run.'."\n" + ."\n" + .'- `Running`: The task is running.'."\n" + ."\n" + .'- `Finished`: The task is finished.', 'type' => 'string', 'required' => false, 'example' => 'Running', 'title' => ''], + ], + [ + 'name' => 'Version', + 'in' => 'query', + 'schema' => ['description' => 'The version. Valid values:'."\n" + ."\n" + .'- `Latest`: The latest version. This is the default value.'."\n" + ."\n" + .'- `Released`: the released version', 'type' => 'string', 'required' => false, 'example' => 'Latest', 'title' => ''], + ], + [ + 'name' => 'ControlTargetFilter', + 'in' => 'query', + 'schema' => ['description' => 'The filter for traffic control targets. Valid values:'."\n" + ."\n" + .'- `All`: Returns all traffic control targets.'."\n" + ."\n" + .'- `Valid`: Returns only active traffic control targets. A traffic control target is active if the current time is within the specified start and end time.'."\n" + ."\n" + .'- `None`: Does not return any traffic control targets.', 'type' => 'string', 'required' => false, 'example' => 'All', 'title' => ''], + ], + [ + 'name' => 'SortBy', + 'in' => 'query', + 'schema' => ['description' => 'The field by which to sort the results. Valid values:'."\n" + ."\n" + .'- `GmtCreateTime`: Sorts the results by creation time.'."\n" + ."\n" + .'- `GmtModifiedTime`: Sorts the results by modification time.', 'type' => 'string', 'required' => false, 'example' => 'GmtCreateTime', 'title' => ''], + ], + [ + 'name' => 'Order', + 'in' => 'query', + 'schema' => ['description' => 'The sort order. Valid values:'."\n" + ."\n" + .'- `ASC`: ascending order'."\n" + ."\n" + .'- `DESC`: descending order', 'type' => 'string', 'required' => false, 'example' => 'ASC', 'title' => ''], + ], + [ + 'name' => 'PageNumber', + 'in' => 'query', + 'schema' => ['description' => 'The page number. Pages start from 1. Default value: 1.', 'type' => 'string', 'required' => false, 'example' => '1', 'title' => ''], + ], + [ + 'name' => 'PageSize', + 'in' => 'query', + 'schema' => ['description' => 'The number of entries per page. Default value: 10.', 'type' => 'string', 'required' => false, 'example' => '10', 'title' => ''], + ], + [ + 'name' => 'All', + 'in' => 'query', + 'schema' => ['description' => 'Specifies whether to return all results without pagination.', 'type' => 'boolean', 'required' => false, 'example' => 'false', 'title' => ''], ], [ 'name' => 'InstanceId', 'in' => 'query', - 'schema' => [ - 'description' => '', - 'type' => 'string', - 'required' => true, - 'example' => '', - ], + 'schema' => ['description' => 'The instance ID. You can obtain this ID by calling the [ListInstances](https://icms.alibaba-inc.com/content/learn/pai?l=1\\&m=16768\\&n=4300782) operation.', 'type' => 'string', 'required' => false, 'example' => 'pairec-cn-********', 'title' => ''], ], ], 'responses' => [ 200 => [ 'schema' => [ + 'description' => 'The data returned.', 'title' => 'Schema of Response', - 'description' => 'Schema of Response', 'type' => 'object', 'properties' => [ - 'RequestId' => [ - 'title' => 'Id of the request', - 'description' => '', - 'type' => 'string', - 'example' => '728C5E01-ABF6-5AA8-B9FC-B3BA05DECC77', + 'RequestId' => ['title' => 'Id of the request', 'description' => 'The request ID.', 'type' => 'string', 'example' => '3AAA45F6-0798-5461-9360-81D133823CE7'], + 'TotalCount' => ['description' => 'The total number of traffic control tasks.', 'type' => 'string', 'example' => '20', 'title' => ''], + 'TrafficControlTasks' => [ + 'description' => 'The list of traffic control tasks.', + 'type' => 'array', + 'items' => [ + 'description' => 'The details of a traffic control task.', + 'type' => 'object', + 'properties' => [ + 'TrafficControlTaskId' => ['description' => 'The traffic control task ID.', 'type' => 'string', 'example' => '1', 'title' => ''], + 'Name' => ['description' => 'The name of the traffic control task.', 'type' => 'string', 'example' => 'task_1', 'title' => ''], + 'Description' => ['description' => 'The description of the traffic control task.', 'type' => 'string', 'example' => 'this is a test task', 'title' => ''], + 'SceneId' => ['description' => 'The scene ID. You can obtain this ID by calling the `ListScenes` operation.', 'type' => 'string', 'example' => '4', 'title' => ''], + 'SceneName' => ['description' => 'The name of the scene.', 'type' => 'string', 'example' => 'home_feed', 'title' => ''], + 'ProductStatus' => ['description' => 'The production environment status.', 'type' => 'string', 'example' => 'Runnning', 'title' => ''], + 'PrepubStatus' => ['description' => 'The staging environment status.', 'type' => 'string', 'example' => 'Runnning', 'title' => ''], + 'ExecutionTime' => ['description' => 'The execution schedule for the task. Valid values:'."\n" + ."\n" + .'- `Permanent`: The task runs indefinitely.'."\n" + ."\n" + .'- `TimeRange`: The task runs within a specified time range. If you set this parameter to this value, you must also specify the `StartTime` and `EndTime` parameters.', 'type' => 'string', 'example' => 'Permanent', 'title' => ''], + 'StartTime' => ['description' => 'The start time.', 'type' => 'string', 'example' => '2024-03-25', 'title' => ''], + 'EndTime' => ['description' => 'The end time.', 'type' => 'string', 'example' => '2024-04-25', 'title' => ''], + 'BehaviorTableMetaId' => ['description' => 'The behavior table ID.', 'type' => 'string', 'example' => '1', 'title' => ''], + 'UserTableMetaId' => ['description' => 'The user table ID.', 'type' => 'string', 'example' => '2', 'title' => ''], + 'ItemTableMetaId' => ['description' => 'The item table ID.', 'type' => 'string', 'example' => '3', 'title' => ''], + 'UserConditionType' => ['description' => 'The condition type for the target user group.', 'type' => 'string', 'example' => 'Array', 'title' => ''], + 'UserConditionArray' => ['description' => 'The condition for the target user group, in an array format.', 'type' => 'string', 'example' => '[{"field":"gender","option":"=","value":"male"}]', 'title' => ''], + 'UserConditionExpress' => ['description' => 'The condition for the target user group, in an expression format.', 'type' => 'string', 'example' => 'age<=30&&(3<=level<=6)&&gender=male', 'title' => ''], + 'StatisBehaviorConditionType' => ['description' => 'The condition type for behavior statistics.', 'type' => 'string', 'example' => 'Array', 'title' => ''], + 'StatisBehaviorConditionArray' => ['description' => 'The behavior statistics condition, in an array format.', 'type' => 'string', 'example' => '[{"field":"click","option":"<=","value":"30"}]', 'title' => ''], + 'StatisBahaviorConditionExpress' => ['description' => 'The behavior statistics expression.', 'type' => 'string', 'example' => 'event=click', 'title' => ''], + 'ControlType' => ['description' => 'The control type.', 'type' => 'string', 'example' => 'Percent', 'title' => ''], + 'ControlGranularity' => ['description' => 'The control granularity.', 'type' => 'string', 'example' => 'Global', 'title' => ''], + 'ControlLogic' => ['description' => 'The control logic.', 'type' => 'string', 'example' => 'Guaranteed', 'title' => ''], + 'ItemConditionType' => ['description' => 'The item condition type.', 'type' => 'string', 'example' => 'Array', 'title' => ''], + 'ItemConditionArray' => ['description' => 'The item condition, in an array format.', 'type' => 'string', 'example' => '[{"field":"status","option":"=","value":"1"}]', 'title' => ''], + 'ItemConditionExpress' => ['description' => 'The item condition, in an expression format.', 'type' => 'string', 'example' => 'status=1', 'title' => ''], + 'GmtCreateTime' => ['description' => 'The creation time of the task.', 'type' => 'string', 'example' => '2024-03-25T06:04:28.441Z', 'title' => ''], + 'GmtModifiedTime' => ['description' => 'The last update time of the task.', 'type' => 'string', 'example' => '2024-03-25T06:04:28.441Z', 'title' => ''], + 'TrafficControlTargets' => [ + 'description' => 'The list of traffic control targets.', + 'type' => 'array', + 'items' => [ + 'description' => 'The details of a traffic control target.', + 'type' => 'object', + 'properties' => [ + 'TrafficControlTargetId' => ['description' => 'The traffic control target ID.', 'type' => 'string', 'example' => '1', 'title' => ''], + 'Name' => ['description' => 'The name of the traffic control target.', 'type' => 'string', 'example' => 'target-1', 'title' => ''], + 'StartTime' => ['description' => 'The start time.', 'type' => 'string', 'example' => '2024-03-25', 'title' => ''], + 'EndTime' => ['description' => 'The end time.', 'type' => 'string', 'example' => '2024-04-25', 'title' => ''], + 'ItemConditionType' => ['description' => 'The item condition type.', 'type' => 'string', 'example' => 'Array', 'title' => ''], + 'ItemConditionArray' => ['description' => 'The item condition, in an array format.', 'type' => 'string', 'example' => '[{"field":"status","option":"=","value":"1"}]', 'title' => ''], + 'ItemConditionExpress' => ['description' => 'The item condition, in an expression format.', 'type' => 'string', 'example' => 'status=1', 'title' => ''], + 'Event' => ['description' => 'The event for the traffic control target.', 'type' => 'string', 'example' => 'click', 'title' => ''], + 'Value' => ['description' => 'The value of the traffic control target.', 'type' => 'number', 'format' => 'float', 'example' => '30', 'title' => ''], + 'StatisPeriod' => ['description' => 'The statistics period.', 'type' => 'string', 'example' => 'Daily', 'title' => ''], + 'ToleranceValue' => ['description' => 'The tolerance value for the traffic control target.', 'type' => 'integer', 'format' => 'int64', 'example' => '10', 'title' => ''], + 'RecallName' => ['description' => 'The name of the recall strategy.', 'type' => 'string', 'example' => 'recall-1', 'title' => ''], + 'Status' => ['description' => 'The status of the traffic control target.', 'type' => 'string', 'example' => 'Opened', 'title' => ''], + 'GmtCreateTime' => ['description' => 'The creation time of the target.', 'type' => 'string', 'example' => '2025-06-03T15:08:10.58+08:00', 'title' => ''], + 'GmtModifiedTime' => ['description' => 'The last update time of the target.', 'type' => 'string', 'example' => '2025-11-21T16:26:58.57+08:00', 'title' => ''], + 'SplitParts' => [ + 'description' => 'The details of the split points.', + 'type' => 'object', + 'properties' => [ + 'TimePoints' => [ + 'description' => 'The list of time-based split points.', + 'type' => 'array', + 'items' => ['description' => 'A time-based split point.', 'type' => 'integer', 'format' => 'int64', 'example' => '10', 'title' => ''], + 'title' => '', + 'example' => '', + ], + 'SetValues' => [ + 'description' => 'The list of value-based split points for the target.', + 'type' => 'array', + 'items' => ['description' => 'A value-based split point for the target.', 'type' => 'integer', 'format' => 'int64', 'example' => '3', 'title' => ''], + 'title' => '', + 'example' => '', + ], + ], + 'title' => '', + 'example' => '', + ], + 'NewProductRegulation' => ['description' => 'Indicates whether the traffic control target is for a new product recall.', 'type' => 'boolean', 'example' => 'false', 'title' => ''], + 'TrafficControlTaskId' => ['description' => 'The traffic control task ID.', 'type' => 'string', 'example' => '1', 'title' => ''], + ], + 'title' => '', + 'example' => '', + ], + 'title' => '', + 'example' => '', + ], + 'EverPublished' => ['description' => 'Indicates whether the task has ever been published.', 'type' => 'boolean', 'example' => 'false', 'title' => ''], + 'ServiceId' => ['description' => 'The service ID.', 'type' => 'string', 'example' => '1', 'title' => ''], + 'PreExperimentIds' => ['description' => 'A comma-separated list of staging experiment IDs.', 'type' => 'string', 'example' => '1,2', 'title' => ''], + 'ProdExperimentIds' => ['description' => 'A comma-separated list of production experiment IDs.', 'type' => 'string', 'example' => '6,7', 'title' => ''], + 'FlinkResourceId' => ['description' => 'The Flink resource ID.', 'type' => 'string', 'example' => 'resource-xxx', 'title' => ''], + 'FlinkResourceName' => ['description' => 'The name of the Flink resource.', 'type' => 'string', 'example' => 'flink_test', 'title' => ''], + 'StatisBehaviorConditionExpress' => ['description' => 'The behavior statistics expression.', 'type' => 'string', 'example' => 'event=exposure', 'title' => ''], + 'EffectiveSceneIds' => [ + 'description' => 'The list of effective scene IDs.', + 'type' => 'array', + 'items' => ['description' => 'An effective scene ID.', 'type' => 'integer', 'format' => 'int32', 'example' => '4', 'title' => ''], + 'title' => '', + 'example' => '', + ], + 'EffectiveSceneNames' => [ + 'description' => 'The list of effective scene names.', + 'type' => 'array', + 'items' => ['description' => 'The name of an effective scene.', 'type' => 'integer', 'format' => 'int32', 'example' => 'home_feed', 'title' => ''], + 'title' => '', + 'example' => '', + ], + 'ServiceIds' => [ + 'description' => 'The list of bound engine service IDs.', + 'type' => 'array', + 'items' => ['description' => 'An engine service ID.', 'type' => 'string', 'example' => '4', 'title' => ''], + 'title' => '', + 'example' => '', + ], + 'EffectiveSceneNameList' => [ + 'description' => 'The list of effective scene names.', + 'type' => 'array', + 'items' => ['description' => 'The name of an effective scene.', 'type' => 'string', 'example' => 'home_feed', 'title' => ''], + 'title' => '', + 'example' => '', + ], + 'ServiceIdList' => [ + 'description' => 'The list of service IDs.', + 'type' => 'array', + 'items' => ['description' => 'A service ID.', 'type' => 'integer', 'format' => 'int32', 'example' => '3', 'title' => ''], + 'title' => '', + 'example' => '', + ], + ], + 'title' => '', + 'example' => '', + ], + 'title' => '', + 'example' => '', ], ], + 'example' => '', ], ], ], - 'staticInfo' => [ - 'returnType' => 'synchronous', + 'staticInfo' => ['returnType' => 'synchronous'], + 'eventInfo' => [ + 'enable' => false, + 'eventNames' => [], + ], + 'title' => 'Retrieve the traffic control job list', + 'description' => '## Request'."\n" + ."\n" + .'- This API retrieves a list of traffic control tasks.'."\n" + ."\n" + .'- Use query parameters to filter and sort the results.'."\n" + ."\n" + .'- This operation supports pagination. You can also retrieve all results in a single response.'."\n" + ."\n" + .'- Note: The `InstanceId` is a required parameter. All other parameters are optional.', + 'changeSet' => [], + 'flowControl' => [ + 'flowControlList' => [], + ], + 'ramActions' => [ + [ + 'operationType' => 'list', + 'ramAction' => [ + 'action' => 'pairec:ListTrafficControlTasks', + 'authLevel' => 'operate', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'PAIRecService', 'resourceType' => 'All Resource', 'arn' => '*'], + ], + ], + ], ], - 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"728C5E01-ABF6-5AA8-B9FC-B3BA05DECC77\\"\\n}","type":"json"}]', + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"3AAA45F6-0798-5461-9360-81D133823CE7\\",\\n \\"TotalCount\\": \\"20\\",\\n \\"TrafficControlTasks\\": [\\n {\\n \\"TrafficControlTaskId\\": \\"1\\",\\n \\"Name\\": \\"task_1\\",\\n \\"Description\\": \\"this is a test task\\",\\n \\"SceneId\\": \\"4\\",\\n \\"SceneName\\": \\"home_feed\\",\\n \\"ProductStatus\\": \\"Runnning\\",\\n \\"PrepubStatus\\": \\"Runnning\\",\\n \\"ExecutionTime\\": \\"Permanent\\",\\n \\"StartTime\\": \\"2024-03-25\\",\\n \\"EndTime\\": \\"2024-04-25\\",\\n \\"BehaviorTableMetaId\\": \\"1\\",\\n \\"UserTableMetaId\\": \\"2\\",\\n \\"ItemTableMetaId\\": \\"3\\",\\n \\"UserConditionType\\": \\"Array\\",\\n \\"UserConditionArray\\": \\"[{\\\\\\"field\\\\\\":\\\\\\"gender\\\\\\",\\\\\\"option\\\\\\":\\\\\\"=\\\\\\",\\\\\\"value\\\\\\":\\\\\\"male\\\\\\"}]\\",\\n \\"UserConditionExpress\\": \\"age<=30&&(3<=level<=6)&&gender=male\\",\\n \\"StatisBehaviorConditionType\\": \\"Array\\",\\n \\"StatisBehaviorConditionArray\\": \\"[{\\\\\\"field\\\\\\":\\\\\\"click\\\\\\",\\\\\\"option\\\\\\":\\\\\\"<=\\\\\\",\\\\\\"value\\\\\\":\\\\\\"30\\\\\\"}]\\",\\n \\"StatisBahaviorConditionExpress\\": \\"event=click\\",\\n \\"ControlType\\": \\"Percent\\",\\n \\"ControlGranularity\\": \\"Global\\",\\n \\"ControlLogic\\": \\"Guaranteed\\",\\n \\"ItemConditionType\\": \\"Array\\",\\n \\"ItemConditionArray\\": \\"[{\\\\\\"field\\\\\\":\\\\\\"status\\\\\\",\\\\\\"option\\\\\\":\\\\\\"=\\\\\\",\\\\\\"value\\\\\\":\\\\\\"1\\\\\\"}]\\",\\n \\"ItemConditionExpress\\": \\"status=1\\",\\n \\"GmtCreateTime\\": \\"2024-03-25T06:04:28.441Z\\",\\n \\"GmtModifiedTime\\": \\"2024-03-25T06:04:28.441Z\\",\\n \\"TrafficControlTargets\\": [\\n {\\n \\"TrafficControlTargetId\\": \\"1\\",\\n \\"Name\\": \\"target-1\\",\\n \\"StartTime\\": \\"2024-03-25\\",\\n \\"EndTime\\": \\"2024-04-25\\",\\n \\"ItemConditionType\\": \\"Array\\",\\n \\"ItemConditionArray\\": \\"[{\\\\\\"field\\\\\\":\\\\\\"status\\\\\\",\\\\\\"option\\\\\\":\\\\\\"=\\\\\\",\\\\\\"value\\\\\\":\\\\\\"1\\\\\\"}]\\",\\n \\"ItemConditionExpress\\": \\"status=1\\",\\n \\"Event\\": \\"click\\",\\n \\"Value\\": 30,\\n \\"StatisPeriod\\": \\"Daily\\",\\n \\"ToleranceValue\\": 10,\\n \\"RecallName\\": \\"recall-1\\",\\n \\"Status\\": \\"Opened\\",\\n \\"GmtCreateTime\\": \\"2025-06-03T15:08:10.58+08:00\\",\\n \\"GmtModifiedTime\\": \\"2025-11-21T16:26:58.57+08:00\\",\\n \\"SplitParts\\": {\\n \\"TimePoints\\": [\\n 10\\n ],\\n \\"SetValues\\": [\\n 3\\n ]\\n },\\n \\"NewProductRegulation\\": false,\\n \\"TrafficControlTaskId\\": \\"1\\"\\n }\\n ],\\n \\"EverPublished\\": false,\\n \\"ServiceId\\": \\"1\\",\\n \\"PreExperimentIds\\": \\"1,2\\",\\n \\"ProdExperimentIds\\": \\"6,7\\",\\n \\"FlinkResourceId\\": \\"resource-xxx\\",\\n \\"FlinkResourceName\\": \\"flink_test\\",\\n \\"StatisBehaviorConditionExpress\\": \\"event=exposure\\",\\n \\"EffectiveSceneIds\\": [\\n 4\\n ],\\n \\"EffectiveSceneNames\\": [\\n 0\\n ],\\n \\"ServiceIds\\": [\\n \\"4\\"\\n ],\\n \\"EffectiveSceneNameList\\": [\\n \\"home_feed\\"\\n ],\\n \\"ServiceIdList\\": [\\n 3\\n ]\\n }\\n ]\\n}","type":"json"}]', ], - 'CreateTableMeta' => [ - 'summary' => '创建数据表。', - 'path' => '/api/v1/tablemetas', - 'methods' => [ - 'post', - ], - 'schemes' => [ - 'http', - 'https', - ], + 'OfflineExperiment' => [ + 'summary' => 'Takes an experiment offline.', + 'path' => '/api/v1/experiments/{ExperimentId}/action/offline', + 'methods' => ['post'], + 'schemes' => ['http', 'https'], 'security' => [ [ 'AK' => [], ], ], - 'consumes' => [ - 'application/json', - ], - 'produces' => [ - 'application/json', - ], - 'operationType' => 'write', + 'consumes' => ['application/json'], + 'produces' => ['application/json'], + 'operationType' => 'readAndWrite', 'deprecated' => false, 'systemTags' => [ - 'operationType' => 'create', + 'operationType' => 'none', 'riskType' => 'none', 'chargeType' => 'free', - 'abilityTreeNodes' => [ - 'FEATURElearnN0NAWV', - ], + 'abilityTreeNodes' => ['FEATURElearnN0NAWV'], ], 'parameters' => [ [ + 'name' => 'ExperimentId', + 'in' => 'path', + 'schema' => ['description' => 'The ID of the experiment. You can get this ID by calling the ListExperiments API.', 'type' => 'string', 'required' => true, 'example' => '3', 'title' => ''], + ], + [ 'name' => 'body', 'in' => 'body', 'style' => 'json', 'schema' => [ - 'description' => '', + 'description' => 'Specifies the parameters of the request body.', 'type' => 'object', 'properties' => [ - 'Name' => [ - 'description' => '', - 'type' => 'string', - 'required' => true, - 'example' => 'table_test', - ], - 'ResourceId' => [ - 'description' => '', - 'type' => 'string', - 'required' => true, - 'example' => 'reso-2s416t146ffjc3yefx', - ], - 'TableName' => [ - 'description' => '', - 'type' => 'string', - 'required' => true, - 'example' => 'table_mysql', - ], - 'Module' => [ - 'description' => '', - 'type' => 'string', - 'required' => true, - 'example' => 'ABTest', - ], - 'InstanceId' => [ - 'description' => '', - 'type' => 'string', - 'required' => true, - 'example' => 'pairec-cn-test123', - ], - 'Fields' => [ - 'description' => '', - 'type' => 'array', - 'items' => [ - 'description' => '', - 'type' => 'object', - 'properties' => [ - 'Name' => [ - 'description' => '', - 'type' => 'string', - 'required' => true, - 'example' => 'gender', - ], - 'Meaning' => [ - 'description' => '', - 'type' => 'string', - 'required' => true, - 'example' => 'this is gender of people', - ], - 'Type' => [ - 'description' => '', - 'type' => 'string', - 'required' => true, - 'example' => 'BIGINT', - ], - 'IsDimensionField' => [ - 'description' => '', - 'type' => 'boolean', - 'required' => true, - 'example' => 'false', - ], - 'DataType' => [ - 'type' => 'string', - ], - 'IsPartitionField' => [ - 'type' => 'string', - 'required' => true, - ], - ], - 'required' => false, - ], - 'required' => true, - ], - 'Description' => [ - 'description' => '', - 'type' => 'string', - 'required' => true, - 'example' => 'this is a test table', - ], + 'InstanceId' => ['description' => 'The ID of the instance. You can get this ID by calling the ListInstances API.', 'type' => 'string', 'required' => true, 'example' => 'pairec-cn-abcdefg1234', 'title' => ''], ], 'required' => false, + 'title' => '', + 'example' => '', ], ], ], @@ -11897,160 +13386,75 @@ 200 => [ 'schema' => [ 'title' => 'Schema of Response', - 'description' => 'Schema of Response', + 'description' => 'The data returned for the request.', 'type' => 'object', 'properties' => [ - 'RequestId' => [ - 'title' => 'Id of the request', - 'description' => '', - 'type' => 'string', - 'example' => '728C5E01-ABF6-5AA8-B9FC-B3BA05DECC77', - ], - 'TableMetaId' => [ - 'description' => '', - 'type' => 'string', - 'example' => '2', - ], + 'RequestId' => ['title' => 'Id of the request', 'description' => 'The ID of the request.', 'type' => 'string', 'example' => '872951C9-7755-5FA1-AACD-7F9375A6D27A'], ], + 'example' => '', ], ], ], - 'staticInfo' => [ - 'returnType' => 'synchronous', + 'staticInfo' => ['returnType' => 'synchronous'], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"872951C9-7755-5FA1-AACD-7F9375A6D27A\\"\\n}","type":"json"}]', + 'title' => 'Unpublish Experiment', + 'changeSet' => [], + 'flowControl' => [ + 'flowControlList' => [], + ], + 'ramActions' => [ + [ + 'operationType' => 'none', + 'ramAction' => [ + 'action' => 'pairec:OfflineExperiment', + 'authLevel' => 'operate', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'PAIRecService', 'resourceType' => 'All Resource', 'arn' => '*'], + ], + ], + ], ], - 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"728C5E01-ABF6-5AA8-B9FC-B3BA05DECC77\\",\\n \\"TableMetaId\\": \\"2\\"\\n}","type":"json"}]', ], - 'UpdateABMetric' => [ - 'summary' => '更新AB Test实验指标。', - 'path' => '/api/v1/abmetrics/{ABMetricId}', - 'methods' => [ - 'put', - ], - 'schemes' => [ - 'http', - 'https', - ], + 'OfflineExperimentGroup' => [ + 'summary' => 'Takes a specified experiment group offline.', + 'path' => '/api/v1/experimentgroups/{ExperimentGroupId}/action/offline', + 'methods' => ['post'], + 'schemes' => ['http', 'https'], 'security' => [ [ 'AK' => [], ], ], - 'consumes' => [ - 'application/json', - ], - 'produces' => [ - 'application/json', - ], + 'consumes' => ['application/json'], + 'produces' => ['application/json'], 'operationType' => 'readAndWrite', 'deprecated' => false, 'systemTags' => [ - 'operationType' => 'update', + 'operationType' => 'none', 'riskType' => 'none', 'chargeType' => 'free', - 'abilityTreeNodes' => [ - 'FEATURElearnN0NAWV', - ], + 'abilityTreeNodes' => ['FEATURElearnN0NAWV'], ], 'parameters' => [ [ - 'name' => 'ABMetricId', + 'name' => 'ExperimentGroupId', 'in' => 'path', - 'schema' => [ - 'description' => '', - 'type' => 'string', - 'required' => true, - 'example' => '1', - ], + 'schema' => ['description' => 'The ID of the experiment group. You can obtain this ID by calling the ListExperimentGroups operation.', 'type' => 'string', 'required' => true, 'example' => '3', 'title' => ''], ], [ 'name' => 'body', 'in' => 'body', 'style' => 'json', 'schema' => [ - 'description' => '', + 'title' => '', + 'description' => 'The request body.', 'type' => 'object', 'properties' => [ - 'Name' => [ - 'description' => '', - 'type' => 'string', - 'required' => true, - 'example' => 'pv', - ], - 'Description' => [ - 'description' => '', - 'type' => 'string', - 'required' => true, - 'example' => '', - ], - 'SceneId' => [ - 'description' => '', - 'type' => 'string', - 'required' => true, - 'example' => '1', - ], - 'Type' => [ - 'description' => '', - 'type' => 'string', - 'required' => true, - 'example' => 'Single', - ], - 'Realtime' => [ - 'description' => '', - 'type' => 'boolean', - 'required' => true, - 'example' => 'false', - ], - 'TableMetaId' => [ - 'description' => '', - 'type' => 'string', - 'required' => true, - 'example' => '2', - ], - 'ResultResourceId' => [ - 'description' => '', - 'type' => 'string', - 'required' => false, - 'example' => '3', - ], - 'Definition' => [ - 'description' => '', - 'type' => 'string', - 'required' => true, - 'example' => 'sum(click_cnt)', - ], - 'StatisticsCycle' => [ - 'description' => '', - 'type' => 'integer', - 'format' => 'int32', - 'required' => false, - 'example' => '1', - ], - 'LeftMetricId' => [ - 'description' => '', - 'type' => 'string', - 'required' => false, - 'example' => '2', - ], - 'RightMetricId' => [ - 'description' => '', - 'type' => 'string', - 'required' => false, - 'example' => '3', - ], - 'Operator' => [ - 'description' => '', - 'type' => 'string', - 'required' => false, - 'example' => 'Division', - ], - 'InstanceId' => [ - 'description' => '', - 'type' => 'string', - 'required' => true, - 'example' => 'pairec-cn-test123', - ], + 'InstanceId' => ['description' => 'The instance ID.', 'type' => 'string', 'required' => true, 'example' => 'pairec-cn-abcdefg1234'."\n", 'title' => ''], ], 'required' => false, + 'example' => '', ], ], ], @@ -12058,145 +13462,75 @@ 200 => [ 'schema' => [ 'title' => 'Schema of Response', - 'description' => 'Schema of Response', + 'description' => 'The response parameters.', 'type' => 'object', 'properties' => [ - 'RequestId' => [ - 'title' => 'Id of the request', - 'description' => '', - 'type' => 'string', - 'example' => '6CF1E160-3F36-5E73-A170-C75504F05BBC', - ], + 'RequestId' => ['title' => 'Id of the request', 'description' => 'The ID of the request.', 'type' => 'string', 'example' => '518C64F6-DFF7-11ED-85B0-00163E14B3D1'], ], + 'example' => '', ], ], ], - 'staticInfo' => [ - 'returnType' => 'synchronous', + 'staticInfo' => ['returnType' => 'synchronous'], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"518C64F6-DFF7-11ED-85B0-00163E14B3D1\\"\\n}","type":"json"}]', + 'title' => 'Unpublish experiment group', + 'changeSet' => [], + 'flowControl' => [ + 'flowControlList' => [], + ], + 'ramActions' => [ + [ + 'operationType' => 'none', + 'ramAction' => [ + 'action' => 'pairec:OfflineExperimentGroup', + 'authLevel' => 'operate', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'PAIRecService', 'resourceType' => 'All Resource', 'arn' => '*'], + ], + ], + ], ], - 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"6CF1E160-3F36-5E73-A170-C75504F05BBC\\"\\n}","type":"json"}]', ], - 'CreateABMetric' => [ - 'summary' => '创建AB test实验指标', - 'path' => '/api/v1/abmetrics', - 'methods' => [ - 'post', - ], - 'schemes' => [ - 'http', - 'https', - ], + 'OfflineLaboratory' => [ + 'summary' => 'Takes the specified laboratory offline.', + 'path' => '/api/v1/laboratories/{LaboratoryId}/action/offline', + 'methods' => ['post'], + 'schemes' => ['http', 'https'], 'security' => [ [ 'AK' => [], ], ], - 'consumes' => [ - 'application/json', - ], - 'produces' => [ - 'application/json', - ], + 'consumes' => ['application/json'], + 'produces' => ['application/json'], 'operationType' => 'readAndWrite', 'deprecated' => false, 'systemTags' => [ - 'operationType' => 'create', + 'operationType' => 'none', 'riskType' => 'none', 'chargeType' => 'free', - 'abilityTreeNodes' => [ - 'FEATURElearnN0NAWV', - ], + 'abilityTreeNodes' => ['FEATURElearnN0NAWV'], ], 'parameters' => [ [ + 'name' => 'LaboratoryId', + 'in' => 'path', + 'schema' => ['description' => 'The laboratory ID. Call the `ListLaboratories` operation to obtain this ID.', 'type' => 'string', 'required' => true, 'example' => '3', 'title' => ''], + ], + [ 'name' => 'body', 'in' => 'body', 'style' => 'json', 'schema' => [ - 'description' => '', + 'title' => '', + 'description' => 'The request body.', 'type' => 'object', 'properties' => [ - 'Name' => [ - 'description' => '', - 'type' => 'string', - 'required' => true, - 'example' => 'pv', - ], - 'Description' => [ - 'description' => '', - 'type' => 'string', - 'required' => true, - 'example' => '', - ], - 'SceneId' => [ - 'description' => '', - 'type' => 'string', - 'required' => true, - 'example' => '1', - ], - 'Type' => [ - 'description' => '', - 'type' => 'string', - 'required' => true, - 'example' => 'Single', - ], - 'Realtime' => [ - 'description' => '', - 'type' => 'boolean', - 'required' => true, - 'example' => 'false', - ], - 'TableMetaId' => [ - 'description' => '', - 'type' => 'string', - 'required' => true, - 'example' => '2', - ], - 'ResultResourceId' => [ - 'description' => '', - 'type' => 'string', - 'required' => false, - 'example' => '3', - ], - 'Definition' => [ - 'description' => '', - 'type' => 'string', - 'required' => true, - 'example' => 'sum(click_cnt)', - ], - 'StatisticsCycle' => [ - 'description' => '', - 'type' => 'integer', - 'format' => 'int32', - 'required' => false, - 'example' => '1', - ], - 'LeftMetricId' => [ - 'description' => '', - 'type' => 'string', - 'required' => false, - 'example' => '2', - ], - 'RightMetricId' => [ - 'description' => '', - 'type' => 'string', - 'required' => false, - 'example' => '3', - ], - 'Operator' => [ - 'description' => '', - 'type' => 'string', - 'required' => false, - 'example' => 'Division', - ], - 'InstanceId' => [ - 'description' => '', - 'type' => 'string', - 'required' => true, - 'example' => 'pairec-cn-test1', - ], + 'InstanceId' => ['description' => 'The instance ID. Call the `ListInstances` operation to obtain this ID.', 'type' => 'string', 'required' => true, 'example' => 'pairec-cn-abcdefg1234', 'title' => ''], ], 'required' => false, + 'example' => '', ], ], ], @@ -12204,141 +13538,158 @@ 200 => [ 'schema' => [ 'title' => 'Schema of Response', - 'description' => 'Schema of Response', + 'description' => 'The response object.', 'type' => 'object', 'properties' => [ - 'RequestId' => [ - 'title' => 'Id of the request', - 'description' => '', - 'type' => 'string', - 'example' => 'F7AC05FF-EDE7-5C2B-B9AE-33D6DF4178BA', - ], - 'ABMetricId' => [ - 'description' => '', - 'type' => 'string', - 'example' => '1', - ], + 'RequestId' => ['title' => 'Id of the request', 'description' => 'The unique ID generated for the request.', 'type' => 'string', 'example' => '59CE7EC6-F268-5D71-9215-32922CC50D72'], ], + 'example' => '', ], ], ], - 'staticInfo' => [ - 'returnType' => 'synchronous', + 'staticInfo' => ['returnType' => 'synchronous'], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"59CE7EC6-F268-5D71-9215-32922CC50D72\\"\\n}","type":"json"}]', + 'title' => 'Unpublish Lab', + 'changeSet' => [], + 'flowControl' => [ + 'flowControlList' => [], + ], + 'ramActions' => [ + [ + 'operationType' => 'none', + 'ramAction' => [ + 'action' => 'pairec:OfflineLaboratory', + 'authLevel' => 'operate', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'PAIRecService', 'resourceType' => 'All Resource', 'arn' => '*'], + ], + ], + ], ], - 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"F7AC05FF-EDE7-5C2B-B9AE-33D6DF4178BA\\",\\n \\"ABMetricId\\": \\"1\\"\\n}","type":"json"}]', ], - 'ListABMetrics' => [ - 'summary' => '获取AB Test实验指标列表。', - 'path' => '/api/v1/abmetrics', - 'methods' => [ - 'get', - ], - 'schemes' => [ - 'http', - 'https', - ], + 'OfflineRecallManagementService' => [ + 'path' => '/api/v1/recallmanagementservices/{RecallManagementServiceId}/action/offline', + 'methods' => ['post'], + 'schemes' => ['https'], 'security' => [ [ 'AK' => [], ], ], - 'consumes' => [ - 'application/json', - ], - 'produces' => [ - 'application/json', - ], - 'operationType' => 'read', + 'consumes' => ['application/json'], + 'produces' => ['application/json'], + 'operationType' => 'write', 'deprecated' => false, 'systemTags' => [ - 'operationType' => 'list', + 'operationType' => 'none', 'riskType' => 'none', 'chargeType' => 'free', - 'abilityTreeNodes' => [ - 'FEATURElearnN0NAWV', - ], + 'abilityTreeNodes' => ['FEATURElearnN0NAWV'], ], 'parameters' => [ [ - 'name' => 'Type', - 'in' => 'query', - 'schema' => [ - 'description' => '', - 'type' => 'string', - 'required' => false, - 'example' => 'Single', - ], - ], - [ - 'name' => 'Realtime', - 'in' => 'query', - 'schema' => [ - 'description' => '', - 'type' => 'boolean', - 'required' => false, - 'example' => 'false', - ], + 'name' => 'RecallManagementServiceId', + 'in' => 'path', + 'schema' => ['description' => 'The ID of the recall management service.', 'type' => 'string', 'required' => false, 'example' => '3', 'title' => ''], ], [ - 'name' => 'PageNumber', - 'in' => 'query', + 'name' => 'body', + 'in' => 'body', + 'style' => 'json', 'schema' => [ - 'description' => '', - 'type' => 'integer', - 'format' => 'int32', + 'description' => 'The request body.', + 'type' => 'object', + 'properties' => [ + 'InstanceId' => ['description' => 'The instance ID.', 'type' => 'string', 'required' => false, 'example' => 'pairec-cn-test123', 'title' => ''], + ], 'required' => false, - 'example' => '1', + 'title' => '', + 'example' => '', ], ], - [ - 'name' => 'PageSize', - 'in' => 'query', + ], + 'responses' => [ + 200 => [ 'schema' => [ - 'description' => '', - 'type' => 'integer', - 'format' => 'int32', - 'required' => false, - 'example' => '10', + 'description' => 'The data returned.', + 'title' => 'Schema of Response', + 'type' => 'object', + 'properties' => [ + 'RequestId' => ['title' => 'ID of the request', 'description' => 'The request ID.', 'type' => 'string', 'example' => '728C5E01-ABF6-5AA8-B9FC-B3BA05DECC77'], + ], + 'example' => '', ], ], - [ - 'name' => 'Name', - 'in' => 'query', - 'schema' => [ - 'description' => '', - 'type' => 'string', - 'required' => false, - 'example' => 'home', + ], + 'staticInfo' => ['returnType' => 'synchronous'], + 'title' => 'Unpublish Retrieval Management Service', + 'summary' => 'Takes a specified recall management service offline.', + 'description' => '## Description'."\n" + ."\n" + .'Use this API to take a specific recall management service offline. Ensure that the provided `RecallManagementServiceId` and `InstanceId` are accurate to prevent unintended operations.'."\n" + ."\n" + .'- **Important**: Once a recall management service is taken offline, it stops processing new requests until you reactivate it.'."\n" + ."\n" + .'- Back up any required data or configurations before you perform this operation in case you need to restore the current state.', + 'changeSet' => [], + 'flowControl' => [ + 'flowControlList' => [], + ], + 'ramActions' => [ + [ + 'operationType' => 'none', + 'ramAction' => [ + 'action' => 'pairec:OfflineRecallManagementService', + 'authLevel' => 'operate', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'PAIRecService', 'resourceType' => 'All Resource', 'arn' => '*'], + ], ], ], + ], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"728C5E01-ABF6-5AA8-B9FC-B3BA05DECC77\\"\\n}","type":"json"}]', + ], + 'OnlineExperiment' => [ + 'summary' => 'Brings a specified experiment online.', + 'path' => '/api/v1/experiments/{ExperimentId}/action/online', + 'methods' => ['post'], + 'schemes' => ['http', 'https'], + 'security' => [ [ - 'name' => 'TableMetaId', - 'in' => 'query', - 'schema' => [ - 'description' => '', - 'type' => 'string', - 'required' => false, - 'example' => '1', - ], + 'AK' => [], ], + ], + 'consumes' => ['application/json'], + 'produces' => ['application/json'], + 'operationType' => 'readAndWrite', + 'deprecated' => false, + 'systemTags' => [ + 'operationType' => 'none', + 'riskType' => 'none', + 'chargeType' => 'free', + 'abilityTreeNodes' => ['FEATURElearnN0NAWV'], + ], + 'parameters' => [ [ - 'name' => 'InstanceId', - 'in' => 'query', - 'schema' => [ - 'description' => '', - 'type' => 'string', - 'required' => true, - 'example' => 'pairec-cn-test1', - ], + 'name' => 'ExperimentId', + 'in' => 'path', + 'schema' => ['description' => 'The ID of the experiment, which you can obtain by calling the ListExperiments API.', 'type' => 'string', 'required' => true, 'example' => '3', 'title' => ''], ], [ - 'name' => 'SceneId', - 'in' => 'query', + 'name' => 'body', + 'in' => 'body', + 'style' => 'json', 'schema' => [ - 'description' => '', - 'type' => 'string', + 'description' => 'The request body.', + 'type' => 'object', + 'properties' => [ + 'InstanceId' => ['description' => 'The ID of the instance, which you can obtain by calling the ListInstances API.', 'type' => 'string', 'example' => 'pairec-cn-abcdefg1234', 'title' => '', 'required' => false], + ], 'required' => false, - 'example' => '1', + 'title' => '', + 'example' => '', ], ], ], @@ -12346,166 +13697,75 @@ 200 => [ 'schema' => [ 'title' => 'Schema of Response', - 'description' => 'Schema of Response', + 'description' => 'The response schema.', 'type' => 'object', 'properties' => [ - 'RequestId' => [ - 'title' => 'Id of the request', - 'description' => '', - 'type' => 'string', - 'example' => 'F7AC05FF-EDE7-5C2B-B9AE-33D6DF4178BA', - ], - 'TotalCount' => [ - 'description' => '', - 'type' => 'integer', - 'format' => 'int64', - 'example' => '10', - ], - 'ABMetrics' => [ - 'description' => '', - 'type' => 'array', - 'items' => [ - 'description' => '', - 'type' => 'object', - 'properties' => [ - 'ABMetricId' => [ - 'description' => '', - 'type' => 'string', - 'example' => '1', - ], - 'Name' => [ - 'description' => '', - 'type' => 'string', - 'example' => 'pv', - ], - 'Description' => [ - 'description' => '', - 'type' => 'string', - 'example' => '', - ], - 'SceneId' => [ - 'description' => '', - 'type' => 'string', - 'example' => '1', - ], - 'SceneName' => [ - 'description' => '', - 'type' => 'string', - 'example' => 'home_feed', - ], - 'Type' => [ - 'description' => '', - 'type' => 'string', - 'example' => 'Single', - ], - 'Realtime' => [ - 'description' => '', - 'type' => 'string', - 'example' => 'false', - ], - 'TableMetaId' => [ - 'description' => '', - 'type' => 'string', - 'example' => '1', - ], - 'ResultTableMetaId' => [ - 'description' => '', - 'type' => 'string', - 'example' => '2', - ], - 'ResultResourceId' => [ - 'description' => '', - 'type' => 'string', - 'example' => '3', - ], - 'Definition' => [ - 'description' => '', - 'type' => 'string', - 'example' => 'sum(click_cnt)', - ], - 'StatisticsCycle' => [ - 'description' => '', - 'type' => 'integer', - 'format' => 'int32', - 'example' => '1', - ], - 'LeftMetricId' => [ - 'description' => '', - 'type' => 'string', - 'example' => '3', - ], - 'RightMetricId' => [ - 'description' => '', - 'type' => 'string', - 'example' => '2', - ], - 'Operator' => [ - 'description' => '', - 'type' => 'string', - 'example' => 'Division', - ], - ], - ], - ], + 'RequestId' => ['title' => 'Id of the request', 'description' => 'The ID of the request.', 'type' => 'string', 'example' => '6CF1E160-3F36-5E73-A170-C75504F05BBC'], ], + 'example' => '', ], ], ], - 'staticInfo' => [ - 'returnType' => 'synchronous', + 'staticInfo' => ['returnType' => 'synchronous'], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"6CF1E160-3F36-5E73-A170-C75504F05BBC\\"\\n}","type":"json"}]', + 'title' => 'Publish Experiment', + 'changeSet' => [], + 'flowControl' => [ + 'flowControlList' => [], + ], + 'ramActions' => [ + [ + 'operationType' => 'none', + 'ramAction' => [ + 'action' => 'pairec:OnlineExperiment', + 'authLevel' => 'operate', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'PAIRecService', 'resourceType' => 'All Resource', 'arn' => '*'], + ], + ], + ], ], - 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"F7AC05FF-EDE7-5C2B-B9AE-33D6DF4178BA\\",\\n \\"TotalCount\\": 10,\\n \\"ABMetrics\\": [\\n {\\n \\"ABMetricId\\": \\"1\\",\\n \\"Name\\": \\"pv\\",\\n \\"Description\\": \\"pv指标\\",\\n \\"SceneId\\": \\"1\\",\\n \\"SceneName\\": \\"home_feed\\",\\n \\"Type\\": \\"Single\\",\\n \\"Realtime\\": \\"false\\",\\n \\"TableMetaId\\": \\"1\\",\\n \\"ResultTableMetaId\\": \\"2\\",\\n \\"ResultResourceId\\": \\"3\\",\\n \\"Definition\\": \\"sum(click_cnt)\\",\\n \\"StatisticsCycle\\": 1,\\n \\"LeftMetricId\\": \\"3\\",\\n \\"RightMetricId\\": \\"2\\",\\n \\"Operator\\": \\"Division\\"\\n }\\n ]\\n}","type":"json"}]', ], - 'GetABMetric' => [ - 'summary' => '获取AB Test实验指标详细信息。', - 'path' => '/api/v1/abmetrics/{ABMetricId}', - 'methods' => [ - 'get', - ], - 'schemes' => [ - 'http', - 'https', - ], + 'OnlineExperimentGroup' => [ + 'summary' => 'Brings a specified experiment group online.', + 'path' => '/api/v1/experimentgroups/{ExperimentGroupId}/action/online', + 'methods' => ['post'], + 'schemes' => ['http', 'https'], 'security' => [ [ 'AK' => [], ], ], - 'consumes' => [ - 'application/json', - ], - 'produces' => [ - 'application/json', - ], - 'operationType' => 'read', + 'consumes' => ['application/json'], + 'produces' => ['application/json'], + 'operationType' => 'readAndWrite', 'deprecated' => false, 'systemTags' => [ - 'operationType' => 'get', + 'operationType' => 'none', 'riskType' => 'none', 'chargeType' => 'free', - 'abilityTreeNodes' => [ - 'FEATURElearnN0NAWV', - ], + 'abilityTreeNodes' => ['FEATURElearnN0NAWV'], ], 'parameters' => [ [ - 'name' => 'ABMetricId', + 'name' => 'ExperimentGroupId', 'in' => 'path', - 'schema' => [ - 'description' => '', - 'type' => 'string', - 'required' => true, - 'example' => '1', - ], + 'schema' => ['description' => 'The experiment group ID. Call the ListExperimentGroups API to get this ID.', 'type' => 'string', 'required' => true, 'example' => '3', 'title' => ''], ], [ - 'name' => 'InstanceId', - 'in' => 'query', + 'name' => 'body', + 'in' => 'body', + 'style' => 'json', 'schema' => [ - 'description' => '', - 'type' => 'string', - 'required' => true, - 'example' => 'pairec-cn-test1', + 'description' => 'The request body.', + 'type' => 'object', + 'properties' => [ + 'InstanceId' => ['description' => 'The instance ID. Call the ListInstances API to get this ID.', 'type' => 'string', 'required' => true, 'example' => 'pairec-cn-abcdefg1234'."\n", 'title' => ''], + ], + 'required' => false, + 'title' => '', + 'example' => '', ], ], ], @@ -12513,145 +13773,75 @@ 200 => [ 'schema' => [ 'title' => 'Schema of Response', - 'description' => 'Schema of Response', + 'description' => 'The response schema.', 'type' => 'object', 'properties' => [ - 'RequestId' => [ - 'title' => 'Id of the request', - 'description' => '', - 'type' => 'string', - 'example' => '728C5E01-ABF6-5AA8-B9FC-B3BA05DECC77', - ], - 'Name' => [ - 'description' => '', - 'type' => 'string', - 'example' => 'pv', - ], - 'Description' => [ - 'description' => '', - 'type' => 'string', - 'example' => '', - ], - 'SceneId' => [ - 'description' => '', - 'type' => 'string', - 'example' => '1', - ], - 'SceneName' => [ - 'description' => '', - 'type' => 'string', - 'example' => 'home_feed', - ], - 'Type' => [ - 'description' => '', - 'type' => 'string', - 'example' => 'Single', - ], - 'Realtime' => [ - 'description' => '', - 'type' => 'string', - 'example' => 'false', - ], - 'TableMetaId' => [ - 'description' => '', - 'type' => 'string', - 'example' => '2', - ], - 'ResultTableMetaId' => [ - 'description' => '', - 'type' => 'string', - 'example' => '3', - ], - 'ResultResourceId' => [ - 'description' => '', - 'type' => 'string', - 'example' => '5', - ], - 'Definition' => [ - 'description' => '', - 'type' => 'string', - 'example' => 'sum(click_cnt)', - ], - 'StatisticsCycle' => [ - 'description' => '', - 'type' => 'integer', - 'format' => 'int32', - 'example' => '1', - ], - 'LeftMetricId' => [ - 'description' => '', - 'type' => 'string', - 'example' => '3', - ], - 'RightMetricId' => [ - 'description' => '', - 'type' => 'string', - 'example' => '2', - ], - 'Operator' => [ - 'description' => '', - 'type' => 'string', - 'example' => 'Division', - ], + 'RequestId' => ['title' => 'Id of the request', 'description' => 'The request ID.', 'type' => 'string', 'example' => '47F761ED-BE4E-51A6-B678-78E1490DF313'], ], + 'example' => '', ], ], ], - 'staticInfo' => [ - 'returnType' => 'synchronous', + 'staticInfo' => ['returnType' => 'synchronous'], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"47F761ED-BE4E-51A6-B678-78E1490DF313\\"\\n}","type":"json"}]', + 'title' => 'Publish Experiment Group', + 'changeSet' => [], + 'flowControl' => [ + 'flowControlList' => [], + ], + 'ramActions' => [ + [ + 'operationType' => 'none', + 'ramAction' => [ + 'action' => 'pairec:OnlineExperimentGroup', + 'authLevel' => 'operate', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'PAIRecService', 'resourceType' => 'All Resource', 'arn' => '*'], + ], + ], + ], ], - 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"728C5E01-ABF6-5AA8-B9FC-B3BA05DECC77\\",\\n \\"Name\\": \\"pv\\",\\n \\"Description\\": \\"页面访问次数\\",\\n \\"SceneId\\": \\"1\\",\\n \\"SceneName\\": \\"home_feed\\",\\n \\"Type\\": \\"Single\\",\\n \\"Realtime\\": \\"false\\",\\n \\"TableMetaId\\": \\"2\\",\\n \\"ResultTableMetaId\\": \\"3\\",\\n \\"ResultResourceId\\": \\"5\\",\\n \\"Definition\\": \\"sum(click_cnt)\\",\\n \\"StatisticsCycle\\": 1,\\n \\"LeftMetricId\\": \\"3\\",\\n \\"RightMetricId\\": \\"2\\",\\n \\"Operator\\": \\"Division\\"\\n}","type":"json"}]', ], - 'DeleteABMetric' => [ - 'summary' => '删除指定AB实验指标。', - 'path' => '/api/v1/abmetrics/{ABMetricId}', - 'methods' => [ - 'delete', - ], - 'schemes' => [ - 'http', - 'https', - ], + 'OnlineLaboratory' => [ + 'summary' => 'Publishes a specified laboratory for experimental analysis.', + 'path' => '/api/v1/laboratories/{LaboratoryId}/action/online', + 'methods' => ['post'], + 'schemes' => ['http', 'https'], 'security' => [ [ 'AK' => [], ], ], - 'consumes' => [ - 'application/json', - ], - 'produces' => [ - 'application/json', - ], + 'consumes' => ['application/json'], + 'produces' => ['application/json'], 'operationType' => 'readAndWrite', 'deprecated' => false, 'systemTags' => [ - 'operationType' => 'delete', + 'operationType' => 'none', 'riskType' => 'none', 'chargeType' => 'free', - 'abilityTreeNodes' => [ - 'FEATURElearnN0NAWV', - ], + 'abilityTreeNodes' => ['FEATURElearnN0NAWV'], ], 'parameters' => [ [ - 'name' => 'ABMetricId', + 'name' => 'LaboratoryId', 'in' => 'path', - 'schema' => [ - 'description' => '', - 'type' => 'string', - 'required' => true, - 'example' => '1', - ], + 'schema' => ['description' => 'The laboratory ID. This ID is returned by the ListLaboratories API.', 'type' => 'string', 'required' => true, 'example' => '3', 'title' => ''], ], [ - 'name' => 'InstanceId', - 'in' => 'query', + 'name' => 'body', + 'in' => 'body', + 'style' => 'json', 'schema' => [ - 'description' => '', - 'type' => 'string', - 'required' => true, - 'example' => 'pairec-cn-test1', + 'description' => 'The request body.', + 'type' => 'object', + 'properties' => [ + 'InstanceId' => ['description' => 'The instance ID. This ID is returned by the ListInstances API.', 'type' => 'string', 'required' => true, 'example' => 'pairec-test1', 'title' => ''], + ], + 'required' => false, + 'title' => '', + 'example' => '', ], ], ], @@ -12659,269 +13849,134 @@ 200 => [ 'schema' => [ 'title' => 'Schema of Response', - 'description' => 'Schema of Response', + 'description' => 'The response object.', 'type' => 'object', 'properties' => [ - 'RequestId' => [ - 'title' => 'Id of the request', - 'description' => '', - 'type' => 'string', - 'example' => '728C5E01-ABF6-5AA8-B9FC-B3BA05DECC77', - ], + 'RequestId' => ['title' => 'Id of the request', 'description' => 'The ID of the request.', 'type' => 'string', 'example' => '8C27790E-CCA5-56BB-BA17-646295DEC0A2'], ], + 'example' => '', ], ], ], - 'staticInfo' => [ - 'returnType' => 'synchronous', + 'staticInfo' => ['returnType' => 'synchronous'], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"8C27790E-CCA5-56BB-BA17-646295DEC0A2\\"\\n}","type":"json"}]', + 'title' => 'Publish Lab', + 'changeSet' => [], + 'flowControl' => [ + 'flowControlList' => [], + ], + 'ramActions' => [ + [ + 'operationType' => 'none', + 'ramAction' => [ + 'action' => 'pairec:OnlineLaboratory', + 'authLevel' => 'operate', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'PAIRecService', 'resourceType' => 'All Resource', 'arn' => '*'], + ], + ], + ], ], - 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"728C5E01-ABF6-5AA8-B9FC-B3BA05DECC77\\"\\n}","type":"json"}]', ], - 'ReportABMetricGroup' => [ - 'summary' => '对指标组进行报表。', - 'path' => '/api/v1/abmetricgroups/{ABMetricGroupId}/action/report', - 'methods' => [ - 'post', - ], - 'schemes' => [ - 'http', - 'https', - ], + 'OnlineRecallManagementService' => [ + 'path' => '/api/v1/recallmanagementservices/{RecallManagementServiceId}/action/online', + 'methods' => ['post'], + 'schemes' => ['https'], 'security' => [ [ 'AK' => [], ], ], - 'consumes' => [ - 'application/json', - ], - 'produces' => [ - 'application/json', - ], - 'operationType' => 'read', + 'consumes' => ['application/json'], + 'produces' => ['application/json'], + 'operationType' => 'write', 'deprecated' => false, 'systemTags' => [ 'operationType' => 'none', 'riskType' => 'none', 'chargeType' => 'free', - 'abilityTreeNodes' => [ - 'FEATURElearnN0NAWV', - ], + 'abilityTreeNodes' => ['FEATURElearnN0NAWV'], ], 'parameters' => [ [ - 'name' => 'ABMetricGroupId', + 'name' => 'RecallManagementServiceId', 'in' => 'path', - 'schema' => [ - 'description' => '', - 'type' => 'string', - 'required' => true, - 'example' => '1', - ], + 'schema' => ['description' => 'The Recall Management Service ID.', 'type' => 'string', 'required' => false, 'example' => '3', 'title' => ''], ], [ 'name' => 'body', 'in' => 'body', 'style' => 'json', 'schema' => [ - 'description' => '', 'type' => 'object', 'properties' => [ - 'InstanceId' => [ - 'description' => '', - 'type' => 'string', - 'required' => true, - 'example' => 'pairec-cn-test1', - ], - 'ReportType' => [ - 'description' => '', - 'type' => 'string', - 'required' => true, - 'example' => 'Offline', - ], - 'SceneId' => [ - 'description' => '', - 'type' => 'string', - 'required' => false, - 'example' => '1', - ], - 'ExperimentGroupId' => [ - 'description' => '', - 'type' => 'string', - 'required' => false, - 'example' => '3', - ], - 'ExperimentIds' => [ - 'description' => '', - 'type' => 'string', - 'required' => true, - 'example' => '3,4,5', - ], - 'BaseExperimentId' => [ - 'description' => '', - 'type' => 'string', - 'required' => true, - 'example' => '3', - ], - 'TimeStatisticsMethod' => [ - 'description' => '', - 'type' => 'string', - 'required' => false, - 'example' => 'Hour', - ], - 'DimensionFields' => [ - 'description' => '', - 'type' => 'string', - 'required' => false, - 'example' => '{"gender":"man"}', - ], - 'StartDate' => [ - 'description' => '', - 'type' => 'string', - 'required' => false, - 'example' => '2021-07-01', - ], - 'EndDate' => [ - 'description' => '', - 'type' => 'string', - 'required' => false, - 'example' => '2021-07-01', - ], + 'InstanceId' => ['description' => 'The ID of the instance.', 'type' => 'string', 'required' => false, 'example' => 'pairec-cn-test123', 'title' => ''], ], + 'description' => 'The request body.', 'required' => false, + 'title' => '', + 'example' => '', ], ], ], 'responses' => [ 200 => [ 'schema' => [ - 'title' => 'Schema of Response', - 'description' => 'Schema of Response', 'type' => 'object', 'properties' => [ - 'RequestId' => [ - 'title' => 'Id of the request', - 'description' => '', - 'type' => 'string', - 'example' => '59CE7EC6-F268-5D71-9215-32922CC50D72', - ], - 'ExperimentReport' => [ - 'description' => '', - 'type' => 'object', - 'additionalProperties' => [ - 'type' => 'object', - 'properties' => [ - 'Baseline' => [ - 'type' => 'boolean', - 'description' => '', - 'example' => 'true', - ], - 'MetricResults' => [ - 'type' => 'object', - 'additionalProperties' => [ - 'type' => 'object', - 'additionalProperties' => [ - 'type' => 'object', - 'properties' => [ - 'ExpId' => [ - 'type' => 'string', - 'description' => '', - 'example' => '2', - ], - 'ExpName' => [ - 'type' => 'string', - 'example' => '', - 'description' => '', - ], - 'MetricName' => [ - 'type' => 'string', - 'example' => 'pv', - 'description' => '', - ], - 'MetricValue' => [ - 'type' => 'string', - 'example' => '100', - 'description' => '', - ], - 'DimensionValue' => [ - 'type' => 'string', - 'example' => 'ALL', - 'description' => '', - ], - 'Date' => [ - 'type' => 'string', - 'example' => '20230206', - 'description' => '', - ], - 'PercentDiff' => [ - 'type' => 'string', - 'description' => '', - 'example' => '0.1', - ], - 'PercentDiffStr' => [ - 'type' => 'string', - 'description' => '', - 'example' => '"0.1"', - ], - ], - 'description' => '', - ], - 'description' => '', - ], - 'description' => '', - ], - ], - 'description' => '', - ], - ], - 'GroupDimension' => [ - 'description' => '', - 'type' => 'array', - 'items' => [ - 'description' => '', - 'type' => 'string', - 'example' => '["all"]', - ], - ], + 'RequestId' => ['description' => 'The request ID.', 'type' => 'string', 'title' => '', 'example' => '728C5E01-ABF6-5AA8-B9FC-B3BA05DECC77'], ], + 'title' => '', + 'description' => 'The data returned in the response.', + 'example' => '', ], ], ], - 'staticInfo' => [ - 'returnType' => 'synchronous', + 'staticInfo' => ['returnType' => 'synchronous'], + 'title' => 'OnlineRecallManagementService', + 'summary' => 'This operation brings a specified Recall Management Service online.', + 'description' => '## Request'."\n" + ."\n" + .'You can use this operation to bring a Recall Management Service online by specifying the Recall Management Service ID and the instance ID. Ensure that the `RecallManagementServiceId` and `InstanceId` are correct and that you have the required permissions.', + 'changeSet' => [], + 'flowControl' => [ + 'flowControlList' => [], ], - 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"59CE7EC6-F268-5D71-9215-32922CC50D72\\",\\n \\"ExperimentReport\\": {\\n \\"key\\": {\\n \\"Baseline\\": true,\\n \\"MetricResults\\": {\\n \\"key\\": {\\n \\"key\\": {\\n \\"ExpId\\": \\"2\\",\\n \\"ExpName\\": \\"test实验\\",\\n \\"MetricName\\": \\"pv\\",\\n \\"MetricValue\\": \\"100\\",\\n \\"DimensionValue\\": \\"ALL\\",\\n \\"Date\\": \\"20230206\\",\\n \\"PercentDiff\\": \\"0.1\\",\\n \\"PercentDiffStr\\": \\"\\\\\\"0.1\\\\\\"\\"\\n }\\n }\\n }\\n }\\n },\\n \\"GroupDimension\\": [\\n \\"[\\\\\\"all\\\\\\"]\\"\\n ]\\n}","type":"json"}]', - ], - 'UpdateABMetricGroup' => [ - 'summary' => '更新AB test实验指标组。', - 'path' => '/api/v1/abmetricgroups/{ABMetricGroupId}', - 'methods' => [ - 'put', - ], - 'schemes' => [ - 'http', - 'https', + 'ramActions' => [ + [ + 'operationType' => 'none', + 'ramAction' => [ + 'action' => 'pairec:OnlineRecallManagementService', + 'authLevel' => 'operate', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'PAIRecService', 'resourceType' => 'All Resource', 'arn' => '*'], + ], + ], + ], ], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"728C5E01-ABF6-5AA8-B9FC-B3BA05DECC77\\"\\n}","type":"json"}]', + ], + 'PublishRecallManagementTable' => [ + 'summary' => 'Synchronizes a MaxCompute table with the recall engine. This operation allows you to publish specific partitions and select a synchronization mode.', + 'path' => '/api/v1/recallmanagementtables/{RecallManagementTableId}/action/publish', + 'methods' => ['post'], + 'schemes' => ['https'], 'security' => [ [ 'AK' => [], ], ], - 'consumes' => [ - 'application/json', - ], - 'produces' => [ - 'application/json', - ], + 'consumes' => ['application/json'], + 'produces' => ['application/json'], 'operationType' => 'readAndWrite', 'deprecated' => false, 'systemTags' => [ - 'operationType' => 'update', + 'operationType' => 'none', 'riskType' => 'none', 'chargeType' => 'free', - 'abilityTreeNodes' => [ - 'FEATURElearnN0NAWV', - ], + 'abilityTreeNodes' => ['FEATURElearnN0NAWV'], ], 'parameters' => [ [ @@ -12929,160 +13984,119 @@ 'in' => 'body', 'style' => 'json', 'schema' => [ - 'description' => '', + 'description' => 'The request body.', 'type' => 'object', 'properties' => [ - 'Name' => [ - 'description' => '', - 'type' => 'string', - 'required' => true, - 'example' => 'visits', - ], - 'SceneId' => [ - 'description' => '', - 'type' => 'string', - 'required' => true, - 'example' => '1', - ], - 'Description' => [ - 'description' => '', - 'type' => 'string', - 'required' => true, + 'InstanceId' => ['description' => '**The instance ID.**', 'type' => 'string', 'required' => true, 'example' => 'pairec-test1', 'title' => ''], + 'Partition' => [ + 'description' => 'The table partitions to publish.', + 'additionalProperties' => ['description' => 'The value for a partition key.', 'type' => 'string', 'example' => '{"ds":"20250711"}', 'title' => ''], + 'type' => 'object', + 'required' => false, + 'title' => '', 'example' => '', ], - 'ABMetricIds' => [ - 'description' => '', - 'type' => 'string', - 'required' => true, - 'example' => '1,2', - ], - 'InstanceId' => [ - 'description' => '', - 'type' => 'string', - 'required' => true, - 'example' => 'pairec-cn-test1', - ], - 'Realtime' => [ - 'description' => '', - 'type' => 'boolean', - 'required' => true, - 'example' => 'false', + 'SkipThresholdCheck' => ['description' => '**Specifies whether to skip the threshold check during table synchronization.**', 'type' => 'boolean', 'required' => false, 'example' => 'false', 'title' => ''], + 'Mode' => ['description' => '**The synchronization mode.** Valid values:'."\n" + ."\n" + .'- `Merge`: Adds new data and updates existing data.', 'type' => 'string', 'required' => false, 'example' => 'Merge', 'title' => ''], + 'Partitions' => [ + 'description' => 'The table partitions to publish.', + 'additionalProperties' => ['title' => 'Partition value.', 'description' => 'The value for a partition key.', 'type' => 'string', 'example' => '{"ds":"20250711"}'], + 'title' => 'Partition Info.', + 'type' => 'object', + 'required' => false, + 'example' => '', ], ], 'required' => false, + 'title' => '', + 'example' => '', ], ], [ - 'name' => 'ABMetricGroupId', + 'name' => 'RecallManagementTableId', 'in' => 'path', - 'schema' => [ - 'description' => '', - 'type' => 'string', - 'required' => true, - 'example' => '1', - ], + 'schema' => ['description' => 'The table ID.', 'type' => 'string', 'required' => false, 'example' => '3', 'title' => ''], ], ], 'responses' => [ 200 => [ 'schema' => [ + 'description' => 'The data returned.', 'title' => 'Schema of Response', - 'description' => 'Schema of Response', 'type' => 'object', 'properties' => [ - 'RequestId' => [ - 'title' => 'Id of the request', - 'description' => '', - 'type' => 'string', - 'example' => '74D958EF-3598-56FA-8296-FF1575CE43DF', - ], + 'RequestId' => ['title' => 'Id of the request', 'description' => 'The request ID.', 'type' => 'string', 'example' => '728C5E01-ABF6-5AA8-B9FC-B3BA05DECC77'], + 'RecallManagementJobId' => ['description' => 'The recall management job ID.', 'type' => 'string', 'example' => '1', 'title' => ''], ], + 'example' => '', ], ], ], - 'staticInfo' => [ - 'returnType' => 'synchronous', + 'staticInfo' => ['returnType' => 'synchronous'], + 'title' => 'Synchronize Recall Management Table', + 'description' => '## Request details'."\n" + ."\n" + .'This API synchronizes a specified MaxCompute table with the recall engine. You must provide the correct `RecallManagementTableId` in the path parameter and the instance ID in the request body. You can also specify the table partitions to publish, whether to skip the threshold check, and the synchronization mode. To publish specific partitions, provide them as key-value pairs in the `Partitions` field.', + 'changeSet' => [], + 'flowControl' => [ + 'flowControlList' => [], ], - 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"74D958EF-3598-56FA-8296-FF1575CE43DF\\"\\n}","type":"json"}]', - ], - 'CreateABMetricGroup' => [ - 'summary' => '创建指标组', - 'path' => '/api/v1/abmetricgroups', - 'methods' => [ - 'post', - ], - 'schemes' => [ - 'http', - 'https', + 'ramActions' => [ + [ + 'operationType' => 'none', + 'ramAction' => [ + 'action' => 'pairec:PublishRecallManagementTable', + 'authLevel' => 'operate', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'PAIRecService', 'resourceType' => 'All Resource', 'arn' => '*'], + ], + ], + ], ], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"728C5E01-ABF6-5AA8-B9FC-B3BA05DECC77\\",\\n \\"RecallManagementJobId\\": \\"1\\"\\n}","type":"json"}]', + ], + 'PushAllExperiment' => [ + 'summary' => 'If an experiment is stable and performs well, you can push all traffic to it. This action retires the original experiment group and creates a new one that contains only this experiment. The new group receives 100% of the traffic.', + 'path' => '/api/v1/experiments/{ExperimentId}/action/pushall', + 'methods' => ['post'], + 'schemes' => ['http', 'https'], 'security' => [ [ 'AK' => [], ], ], - 'consumes' => [ - 'application/json', - ], - 'produces' => [ - 'application/json', - ], + 'consumes' => ['application/json'], + 'produces' => ['application/json'], 'operationType' => 'readAndWrite', 'deprecated' => false, 'systemTags' => [ - 'operationType' => 'create', + 'operationType' => 'none', 'riskType' => 'none', 'chargeType' => 'free', - 'abilityTreeNodes' => [ - 'FEATURElearnN0NAWV', - ], + 'abilityTreeNodes' => ['FEATURElearnN0NAWV'], ], 'parameters' => [ [ + 'name' => 'ExperimentId', + 'in' => 'path', + 'schema' => ['description' => 'The experiment ID. Call the ListExperiments API to obtain this ID.', 'type' => 'string', 'required' => true, 'example' => '3', 'title' => ''], + ], + [ 'name' => 'body', 'in' => 'body', 'style' => 'json', 'schema' => [ - 'description' => '', + 'description' => 'The request body.', 'type' => 'object', 'properties' => [ - 'Name' => [ - 'description' => '', - 'type' => 'string', - 'required' => true, - 'example' => 'visits', - ], - 'SceneId' => [ - 'description' => '', - 'type' => 'string', - 'required' => true, - 'example' => '1', - ], - 'Description' => [ - 'description' => '', - 'type' => 'string', - 'required' => true, - 'example' => '', - ], - 'ABMetricIds' => [ - 'description' => '', - 'type' => 'string', - 'required' => true, - 'example' => '1,2', - ], - 'InstanceId' => [ - 'description' => '', - 'type' => 'string', - 'required' => true, - 'example' => 'pairec-cn-test1', - ], - 'Realtime' => [ - 'description' => '', - 'type' => 'boolean', - 'required' => true, - 'example' => 'false', - ], + 'InstanceId' => ['description' => 'The instance ID. Call the ListInstances API to obtain this ID.', 'type' => 'string', 'example' => 'pairec-cn-abcdefg1234', 'title' => '', 'required' => false], ], 'required' => false, + 'title' => '', + 'example' => '', ], ], ], @@ -13090,743 +14104,745 @@ 200 => [ 'schema' => [ 'title' => 'Schema of Response', - 'description' => 'Schema of Response', + 'description' => 'The response schema.', 'type' => 'object', 'properties' => [ - 'RequestId' => [ - 'title' => 'Id of the request', - 'description' => '', - 'type' => 'string', - 'example' => 'E15A1443-7917-5BE0-AE70-25538ECF398D', - ], - 'ABMetricGroupId' => [ - 'description' => '', - 'type' => 'string', - 'example' => '1', - ], + 'RequestId' => ['title' => 'Id of the request', 'description' => 'The request ID.', 'type' => 'string', 'example' => '74D958EF-3598-56FA-8296-FF1575CE43DF'], ], + 'example' => '', ], ], ], - 'staticInfo' => [ - 'returnType' => 'synchronous', + 'staticInfo' => ['returnType' => 'synchronous'], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"74D958EF-3598-56FA-8296-FF1575CE43DF\\"\\n}","type":"json"}]', + 'title' => 'Roll Out Experiment to Full Traffic '."\n", + 'changeSet' => [], + 'flowControl' => [ + 'flowControlList' => [], + ], + 'ramActions' => [ + [ + 'operationType' => 'none', + 'ramAction' => [ + 'action' => 'pairec:PushAllExperiment', + 'authLevel' => 'operate', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'PAIRecService', 'resourceType' => 'All Resource', 'arn' => '*'], + ], + ], + ], ], - 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"E15A1443-7917-5BE0-AE70-25538ECF398D\\",\\n \\"ABMetricGroupId\\": \\"1\\"\\n}","type":"json"}]', ], - 'ListABMetricGroups' => [ - 'summary' => '获取AB Test实验指标组列表。', - 'path' => '/api/v1/abmetricgroups', - 'methods' => [ - 'get', - ], - 'schemes' => [ - 'http', - 'https', - ], + 'QueryDataDiagnosisStatistics' => [ + 'summary' => 'Retrieves statistics for a specified data diagnosis task within a time range.', + 'path' => '/api/v1/datadiagnoses/{DataDiagnosisId}/statistics/action/query', + 'methods' => ['post'], + 'schemes' => ['http', 'https'], 'security' => [ [ 'AK' => [], ], ], - 'consumes' => [ - 'application/json', - ], - 'produces' => [ - 'application/json', - ], - 'operationType' => 'read', + 'consumes' => ['application/json'], + 'produces' => ['application/json'], + 'operationType' => 'readAndWrite', 'deprecated' => false, 'systemTags' => [ - 'operationType' => 'list', + 'operationType' => 'get', 'riskType' => 'none', 'chargeType' => 'free', - 'abilityTreeNodes' => [ - 'FEATURElearnN0NAWV', - ], + 'abilityTreeNodes' => ['FEATURElearnN0NAWV'], ], 'parameters' => [ [ - 'name' => 'SceneId', - 'in' => 'query', - 'schema' => [ - 'description' => '', - 'type' => 'string', - 'required' => false, - 'example' => '1', - ], + 'name' => 'DataDiagnosisId', + 'in' => 'path', + 'schema' => ['description' => 'The ID of the data diagnosis task.', 'type' => 'string', 'required' => true, 'example' => '1', 'title' => ''], ], [ 'name' => 'InstanceId', 'in' => 'query', - 'schema' => [ - 'description' => '', - 'type' => 'string', - 'required' => true, - 'example' => 'pairec-cn-test1', - ], + 'schema' => ['description' => 'The instance ID.', 'type' => 'string', 'required' => false, 'example' => 'learn-pairec-xxx', 'title' => ''], ], [ - 'name' => 'PageNumber', + 'name' => 'StartDate', 'in' => 'query', - 'schema' => [ - 'description' => '', - 'type' => 'integer', - 'format' => 'int32', - 'required' => false, - 'example' => '1', - ], + 'schema' => ['description' => 'The start date.', 'type' => 'string', 'required' => false, 'example' => '2023-08-01', 'title' => ''], ], [ - 'name' => 'PageSize', + 'name' => 'EndDate', 'in' => 'query', - 'schema' => [ - 'description' => '', - 'type' => 'integer', - 'format' => 'int32', - 'required' => false, - 'example' => '10', - ], + 'schema' => ['description' => 'The end date.', 'type' => 'string', 'required' => false, 'example' => '2023-08-08', 'title' => ''], ], [ - 'name' => 'Realtime', + 'name' => 'RemainRateType', 'in' => 'query', + 'schema' => ['description' => 'The retention rate report type.'."\n" + ."\n" + .'- Period: A periodic report.', 'type' => 'string', 'required' => false, 'example' => 'Period', 'title' => ''], + ], + ], + 'responses' => [ + 200 => [ 'schema' => [ - 'description' => '', - 'type' => 'boolean', - 'required' => false, - 'example' => 'false', + 'description' => 'The response object.', + 'title' => 'Schema of Response', + 'type' => 'object', + 'properties' => [ + 'RequestId' => ['title' => 'Id of the request', 'description' => 'The request ID.', 'type' => 'string', 'example' => '728C5E01-ABF6-5AA8-B9FC-B3BA05DECC77'], + 'Statistics' => [ + 'description' => 'The statistics for the data diagnosis task.', + 'type' => 'object', + 'properties' => [ + 'FailedDates' => [ + 'description' => 'The dates of task failures.', + 'type' => 'array', + 'items' => ['description' => 'The date of a task failure.', 'type' => 'string', 'example' => '20230802', 'title' => ''], + 'title' => '', + 'example' => '', + ], + 'NoDataDates' => [ + 'description' => 'The dates with missing task data.', + 'type' => 'array', + 'items' => ['description' => 'A date for which task data is missing.', 'type' => 'string', 'example' => '20230802', 'title' => ''], + 'title' => '', + 'example' => '', + ], + ], + 'title' => '', + 'example' => '', + ], + ], + 'example' => '', ], ], + ], + 'staticInfo' => ['returnType' => 'synchronous'], + 'title' => 'Data Diagnosis Statistics Query', + 'description' => '## Request description'."\n" + ."\n" + .'- The `DataDiagnosisId` parameter is required and specifies the data diagnosis task.'."\n" + ."\n" + .'- The `InstanceId` parameter is also required and specifies the instance.'."\n" + ."\n" + .'- The `StartDate` and `EndDate` parameters specify the start and end dates of the time range. The format is YYYY-MM-DD.'."\n" + ."\n" + .'- The `RemainRateType` parameter is optional. It specifies the retention rate report type. The default value is \'Period\', which indicates a periodic report.'."\n" + ."\n" + .'- The response includes the request ID (`RequestId`) and a `Statistics` object. This object contains the dates of task failures (`FailedDates`) and dates with missing task data (`NoDataDates`).', + 'changeSet' => [], + 'flowControl' => [ + 'flowControlList' => [], + ], + 'ramActions' => [ + [ + 'operationType' => 'get', + 'ramAction' => [ + 'action' => 'pairec:QueryDataDiagnosisStatistics', + 'authLevel' => 'operate', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'PAIRecService', 'resourceType' => 'All Resource', 'arn' => '*'], + ], + ], + ], + ], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"728C5E01-ABF6-5AA8-B9FC-B3BA05DECC77\\",\\n \\"Statistics\\": {\\n \\"FailedDates\\": [\\n \\"20230802\\"\\n ],\\n \\"NoDataDates\\": [\\n \\"20230802\\"\\n ]\\n }\\n}","type":"json"}]', + ], + 'QueryRecallManagementTableRecords' => [ + 'path' => '/api/v1/recallmanagementtables/{RecallManagementTableId}/queryrecords', + 'methods' => ['get'], + 'schemes' => ['https'], + 'security' => [ [ - 'name' => 'SortBy', + 'AK' => [], + ], + ], + 'consumes' => ['application/json'], + 'produces' => ['application/json'], + 'operationType' => 'read', + 'deprecated' => false, + 'systemTags' => [ + 'operationType' => 'none', + 'riskType' => 'none', + 'chargeType' => 'free', + 'abilityTreeNodes' => ['FEATURElearnN0NAWV'], + ], + 'parameters' => [ + [ + 'name' => 'RecallManagementTableId', + 'in' => 'path', + 'schema' => ['description' => 'The recall management table ID.', 'type' => 'string', 'required' => false, 'example' => '3', 'title' => ''], + ], + [ + 'name' => 'InstanceId', 'in' => 'query', - 'schema' => [ - 'type' => 'string', - ], + 'schema' => ['description' => 'The instance ID.', 'type' => 'string', 'required' => false, 'example' => 'pairec-cn-test123', 'title' => ''], ], [ - 'name' => 'Order', + 'name' => 'PrimaryKeys', 'in' => 'query', - 'schema' => [ - 'type' => 'string', - ], + 'schema' => ['description' => 'The primary keys of the records to retrieve.', 'type' => 'string', 'format' => 'byte', 'required' => false, 'example' => '["1001","1002"]', 'title' => ''], + ], + [ + 'name' => 'RecallManagementTableVersionId', + 'in' => 'query', + 'schema' => ['description' => 'The recall management table version ID. If you omit this parameter, the API uses the currently published version.', 'type' => 'string', 'required' => false, 'example' => '1', 'title' => ''], ], ], 'responses' => [ 200 => [ 'schema' => [ - 'title' => 'Schema of Response', - 'description' => 'Schema of Response', 'type' => 'object', 'properties' => [ - 'RequestId' => [ - 'title' => 'Id of the request', - 'description' => '', - 'type' => 'string', - 'example' => 'E15A1443-7917-5BE0-AE70-25538ECF398D', - ], - 'TotalCount' => [ - 'description' => '', - 'type' => 'integer', - 'format' => 'int64', - 'example' => '10', - ], - 'ABMetricGroups' => [ - 'description' => '', + 'RequestId' => ['description' => 'The request ID.', 'type' => 'string', 'title' => '', 'example' => '7D59453C-48AA-5FC5-8848-2D373BD1A17F'], + 'Records' => [ 'type' => 'array', 'items' => [ - 'description' => '', 'type' => 'object', - 'properties' => [ - 'ABMetricGroupId' => [ - 'description' => '', - 'type' => 'string', - 'example' => '1', - ], - 'Name' => [ - 'description' => '', - 'type' => 'string', - 'example' => 'visits', - ], - 'SceneId' => [ - 'description' => '', - 'type' => 'string', - 'example' => '1', - ], - 'Description' => [ - 'description' => '', - 'type' => 'string', - 'example' => '', - ], - 'Owner' => [ - 'description' => '', - 'type' => 'string', - 'example' => '2799614***', - ], - 'ABMetricIds' => [ - 'description' => '', - 'type' => 'string', - 'example' => '1,2', - ], - 'ABMetricNames' => [ - 'description' => '', - 'type' => 'string', - 'example' => 'pv,uv', - ], - 'Realtime' => [ - 'description' => '', - 'type' => 'boolean', - 'example' => 'false', - ], - ], + 'additionalProperties' => ['description' => 'The value of a data table field.', 'type' => 'any', 'example' => '""', 'title' => ''], + 'description' => 'A single record.', + 'title' => '', + 'example' => '', ], + 'description' => 'A list of the retrieved records.', + 'title' => '', + 'example' => '', ], ], + 'title' => '', + 'description' => 'The response schema.', + 'example' => '', ], ], ], - 'staticInfo' => [ - 'returnType' => 'synchronous', + 'staticInfo' => ['returnType' => 'synchronous'], + 'title' => 'QueryRecallManagementTableRecords', + 'summary' => 'Retrieves records from a specified recall management table.', + 'description' => '## Request'."\n" + ."\n" + .'This API retrieves records from a specific recall management table using the provided primary keys. You must provide a valid `InstanceId` and `RecallManagementTableId`, and a non-empty `PrimaryKeys` list. If you specify `RecallManagementTableVersionId`, the API returns records from that version; otherwise, it uses the currently published version.', + 'changeSet' => [], + 'flowControl' => [ + 'flowControlList' => [], ], - 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"E15A1443-7917-5BE0-AE70-25538ECF398D\\",\\n \\"TotalCount\\": 10,\\n \\"ABMetricGroups\\": [\\n {\\n \\"ABMetricGroupId\\": \\"1\\",\\n \\"Name\\": \\"visits\\",\\n \\"SceneId\\": \\"1\\",\\n \\"Description\\": \\"访问量相关指标\\",\\n \\"Owner\\": \\"2799614***\\",\\n \\"ABMetricIds\\": \\"1,2\\",\\n \\"ABMetricNames\\": \\"pv,uv\\",\\n \\"Realtime\\": false\\n }\\n ]\\n}","type":"json"}]', - ], - 'GetABMetricGroup' => [ - 'summary' => '获取AB实验指标组详细信息。', - 'path' => '/api/v1/abmetricgroups/{ABMetricGroupId}', - 'methods' => [ - 'get', - ], - 'schemes' => [ - 'http', - 'https', + 'ramActions' => [ + [ + 'operationType' => 'none', + 'ramAction' => [ + 'action' => 'pairec:QueryRecallManagementTableRecords', + 'authLevel' => 'operate', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'PAIRecService', 'resourceType' => 'All Resource', 'arn' => '*'], + ], + ], + ], ], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"7D59453C-48AA-5FC5-8848-2D373BD1A17F\\",\\n \\"Records\\": [\\n {\\n \\"key\\": \\"\\\\\\"\\\\\\"\\"\\n }\\n ]\\n}","type":"json"}]', + ], + 'QueryTrafficControlTargetItemReportDetail' => [ + 'path' => '/api/v1/trafficcontroltargets/{TrafficControlTargetId}/itemcontrolreportdetail', + 'methods' => ['get'], + 'schemes' => ['https'], 'security' => [ [ 'AK' => [], ], ], - 'consumes' => [ - 'application/json', - ], - 'produces' => [ - 'application/json', - ], + 'consumes' => ['application/json'], + 'produces' => ['application/json'], 'operationType' => 'read', 'deprecated' => false, 'systemTags' => [ - 'operationType' => 'get', + 'operationType' => 'none', 'riskType' => 'none', 'chargeType' => 'free', - 'abilityTreeNodes' => [ - 'FEATURElearnN0NAWV', - ], + 'abilityTreeCode' => '254723', + 'abilityTreeNodes' => ['FEATURElearnVYA4L9'], ], 'parameters' => [ [ - 'name' => 'ABMetricGroupId', + 'name' => 'TrafficControlTargetId', 'in' => 'path', - 'schema' => [ - 'description' => '', - 'type' => 'string', - 'required' => true, - 'example' => '1', - ], + 'schema' => ['description' => 'The ID of the traffic control target.', 'type' => 'string', 'required' => true, 'example' => '1', 'title' => ''], ], [ 'name' => 'InstanceId', 'in' => 'query', - 'schema' => [ - 'description' => '', - 'type' => 'string', - 'required' => true, - 'example' => 'pairec-cn-test1', - ], + 'schema' => ['description' => 'The instance ID.', 'type' => 'string', 'required' => true, 'example' => 'pairec_123****', 'title' => ''], + ], + [ + 'name' => 'Environment', + 'in' => 'query', + 'schema' => ['description' => 'The deployment environment. Valid values are Daily (daily environment), Pre (staging environment), and Prod (production environment).', 'type' => 'string', 'required' => true, 'example' => 'Pre', 'title' => ''], + ], + [ + 'name' => 'Date', + 'in' => 'query', + 'schema' => ['description' => 'The report date.', 'type' => 'string', 'required' => false, 'example' => '2024-01-01', 'title' => ''], ], ], 'responses' => [ 200 => [ 'schema' => [ - 'title' => 'Schema of Response', - 'description' => 'Schema of Response', + 'description' => 'Response schema', + 'title' => 'Schema of Response ', 'type' => 'object', 'properties' => [ - 'RequestId' => [ - 'title' => 'Id of the request', - 'description' => '', - 'type' => 'string', - 'example' => '01D22D08-BA20-5F35-8302-99115F288220', - ], - 'Name' => [ - 'description' => '', - 'type' => 'string', - 'example' => 'visits', - ], - 'SceneId' => [ - 'description' => '', - 'type' => 'string', - 'example' => '1', - ], - 'Description' => [ - 'description' => '', - 'type' => 'string', + 'RequestId' => ['title' => 'Id of the request ', 'description' => 'The unique identifier for the request.', 'type' => 'string', 'example' => '728C5E01-ABF6-5AA8-B9FC-B3BA05DECC77'], + 'TrafficControlTargetItemReportDetail' => [ + 'description' => 'Traffic control details for an item.', + 'type' => 'object', + 'properties' => [ + 'ItemControlTopReportDetails' => [ + 'description' => 'Report details for the top 100 controlled items.', + 'type' => 'array', + 'items' => [ + 'description' => 'Report details for a single controlled item.', + 'type' => 'object', + 'properties' => [ + 'ItemId' => ['description' => 'The item ID.', 'type' => 'string', 'example' => '398734', 'title' => ''], + 'TargetTraffic' => ['description' => 'The target traffic.', 'type' => 'integer', 'format' => 'int64', 'example' => '20', 'title' => ''], + 'TargetProgress' => ['description' => 'The progress toward the target.', 'type' => 'string', 'example' => '49%', 'title' => ''], + 'Features' => [ + 'description' => 'Key-value pairs for the traffic control target.', + 'additionalProperties' => ['description' => 'The feature value.', 'type' => 'any', 'example' => 'age', 'title' => ''], + 'type' => 'object', + 'title' => '', + 'example' => '', + ], + ], + 'title' => '', + 'example' => '', + ], + 'title' => '', + 'example' => '', + ], + 'ItemControlTailReportDetails' => [ + 'description' => 'Report details for the tail 100 controlled items.', + 'type' => 'array', + 'items' => [ + 'description' => 'Report details for a single controlled item.', + 'type' => 'object', + 'properties' => [ + 'ItemId' => ['description' => 'The item ID.', 'type' => 'string', 'example' => '794872809896', 'title' => ''], + 'TargetTraffic' => ['description' => 'The target traffic.', 'type' => 'integer', 'format' => 'int64', 'example' => '20', 'title' => ''], + 'TargetProgress' => ['description' => 'The progress toward the target.', 'type' => 'string', 'example' => '49%', 'title' => ''], + 'Features' => [ + 'description' => 'Key-value pairs for the traffic control target.', + 'additionalProperties' => ['description' => 'The feature value.', 'type' => 'any', 'example' => 'age', 'title' => ''], + 'type' => 'object', + 'title' => '', + 'example' => '', + ], + ], + 'title' => '', + 'example' => '', + ], + 'title' => '', + 'example' => '', + ], + ], + 'title' => '', 'example' => '', ], - 'Owner' => [ - 'description' => '', - 'type' => 'string', - 'example' => '2799614***'."\n", - ], - 'ABMetricIds' => [ - 'description' => '', - 'type' => 'string', - 'example' => '1,2', - ], - 'ABMetricNames' => [ - 'description' => '', - 'type' => 'string', - 'example' => 'pv,uv', - ], - 'Realtime' => [ - 'description' => '', - 'type' => 'boolean', - 'example' => 'false', - ], ], + 'example' => '', ], ], ], - 'staticInfo' => [ - 'returnType' => 'synchronous', + 'staticInfo' => ['returnType' => 'synchronous'], + 'title' => 'Query details of a single item in the traffic control target report ', + 'summary' => 'Retrieves the traffic control details of a target item for a given environment and date range.', + 'description' => '## Request'."\n" + ."\n" + .'Use this API to query the details of single-item control for a given traffic control target on a specified date and for a specific instance ID and environment. The details include traffic data and feature information for the top 100 items before and after the control is applied. Ensure that the `TrafficControlTargetId`, `InstanceId`, and `Environment` parameters are accurate, and that the `Date` is in YYYY-MM-DD format. Although the `Date` parameter is optional, we recommend specifying a date for meaningful results.', + 'changeSet' => [], + 'flowControl' => [ + 'flowControlList' => [], ], - 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"01D22D08-BA20-5F35-8302-99115F288220\\",\\n \\"Name\\": \\"visits\\",\\n \\"SceneId\\": \\"1\\",\\n \\"Description\\": \\"访问量相关指标\\",\\n \\"Owner\\": \\"2799614***\\\\n\\",\\n \\"ABMetricIds\\": \\"1,2\\",\\n \\"ABMetricNames\\": \\"pv,uv\\",\\n \\"Realtime\\": false\\n}","type":"json"}]', - ], - 'DeleteABMetricGroup' => [ - 'summary' => '删除AB实验指标组。', - 'path' => '/api/v1/abmetricgroups/{ABMetricGroupId}', - 'methods' => [ - 'delete', - ], - 'schemes' => [ - 'http', - 'https', + 'ramActions' => [ + [ + 'operationType' => 'none', + 'ramAction' => [ + 'action' => 'pairec:QueryTrafficControlTargetItemReportDetail', + 'authLevel' => 'operate', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'PAIRecService', 'resourceType' => 'All Resource', 'arn' => '*'], + ], + ], + ], ], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"728C5E01-ABF6-5AA8-B9FC-B3BA05DECC77\\",\\n \\"TrafficControlTargetItemReportDetail\\": {\\n \\"ItemControlTopReportDetails\\": [\\n {\\n \\"ItemId\\": \\"398734\\",\\n \\"TargetTraffic\\": 20,\\n \\"TargetProgress\\": \\"49%\\",\\n \\"Features\\": {\\n \\"key\\": \\"age\\"\\n }\\n }\\n ],\\n \\"ItemControlTailReportDetails\\": [\\n {\\n \\"ItemId\\": \\"794872809896\\",\\n \\"TargetTraffic\\": 20,\\n \\"TargetProgress\\": \\"49%\\",\\n \\"Features\\": {\\n \\"key\\": \\"age\\"\\n }\\n }\\n ]\\n }\\n}","type":"json"}]', + ], + 'QueryTrafficControlTaskDeployResult' => [ + 'summary' => 'Retrieves the deployment status and related information of a specified traffic control task in a specific environment.', + 'path' => '/api/v1/trafficcontroltasks/{TrafficControlTaskId}/action/queryresult', + 'methods' => ['get'], + 'schemes' => ['https'], 'security' => [ [ 'AK' => [], ], ], - 'consumes' => [ - 'application/json', - ], - 'produces' => [ - 'application/json', - ], - 'operationType' => 'write', + 'consumes' => ['application/json'], + 'produces' => ['application/json'], + 'operationType' => 'readAndWrite', 'deprecated' => false, 'systemTags' => [ - 'operationType' => 'delete', + 'operationType' => 'none', 'riskType' => 'none', 'chargeType' => 'free', - 'abilityTreeNodes' => [ - 'FEATURElearnN0NAWV', - ], + 'abilityTreeNodes' => ['FEATURElearnN0NAWV'], ], 'parameters' => [ [ - 'name' => 'ABMetricGroupId', + 'name' => 'TrafficControlTaskId', 'in' => 'path', - 'schema' => [ - 'description' => '', - 'type' => 'string', - 'required' => true, - 'example' => '1', - ], + 'schema' => ['description' => 'The traffic control task ID.', 'type' => 'string', 'required' => false, 'example' => '1', 'title' => ''], ], [ 'name' => 'InstanceId', 'in' => 'query', - 'schema' => [ - 'description' => '', - 'type' => 'string', - 'required' => true, - 'example' => 'pairec-cn-test1', - ], + 'schema' => ['description' => 'The instance ID.', 'type' => 'string', 'required' => false, 'example' => 'pairec_123****', 'title' => ''], + ], + [ + 'name' => 'Environment', + 'in' => 'query', + 'schema' => ['description' => 'The environment. Valid values:'."\n" + .'- Daily: daily environment.'."\n" + .'- Pre: staging environment.'."\n" + .'- Prod: production environment.', 'type' => 'string', 'required' => false, 'example' => 'Daily', 'title' => ''], ], ], 'responses' => [ 200 => [ 'schema' => [ - 'title' => 'Schema of Response', + 'title' => '', 'description' => 'Schema of Response', 'type' => 'object', 'properties' => [ - 'RequestId' => [ - 'title' => 'Id of the request', - 'description' => '', - 'type' => 'string', - 'example' => 'BDB621CB-A81E-5D39-8793-39A365CBCC74', - ], + 'RequestId' => ['title' => '', 'description' => 'The request ID.', 'type' => 'string', 'example' => '728C5E01-ABF6-5AA8-B9FC-B3BA05DECC77'], + 'TrafficControlTaskId' => ['description' => 'The traffic control task ID.', 'type' => 'string', 'example' => '3', 'title' => ''], + 'DraftStatus' => ['description' => 'The status of pushing the draft to Flink. Valid values:'."\n" + .'- Failed: failed.'."\n" + .'- Running: running.'."\n" + .'- Success: succeeded.', 'type' => 'string', 'example' => 'Success', 'title' => ''], + 'DraftMessage' => ['description' => 'The message returned for pushing the draft to Flink.', 'type' => 'string', 'example' => 'push draft success', 'title' => ''], + 'DeployStatus' => ['description' => 'The status of deploying the draft. Valid values:'."\n" + .'- Failed: failed.'."\n" + .'- Running: running.'."\n" + .'- Success: succeeded.', 'type' => 'string', 'example' => 'Success', 'title' => ''], + 'DeployMessage' => ['description' => 'The message returned for the Flink platform deployment operation.', 'type' => 'string', 'example' => 'deploy job draft success', 'title' => ''], + 'StartStatus' => ['description' => 'The status of starting the Flink task. Valid values:'."\n" + .'- Failed: failed.'."\n" + .'- Running: running.'."\n" + .'- Success: succeeded.', 'type' => 'string', 'example' => 'Success', 'title' => ''], + 'StartMessage' => ['description' => 'The message returned for starting the Flink task.', 'type' => 'string', 'example' => 'start job success', 'title' => ''], + 'PrepareStatus' => ['description' => 'The status of the preparation phase. Valid values:'."\n" + .'- Failed: failed.'."\n" + .'- Running: running.'."\n" + .'- Success: succeeded.', 'type' => 'string', 'example' => 'Success', 'title' => ''], + 'PrepareMessage' => ['description' => 'The message returned for the preparation phase.', 'type' => 'string', 'example' => 'success', 'title' => ''], + 'StopStatus' => ['title' => '', 'description' => 'The stop status.', 'type' => 'string', 'example' => 'Success'], + 'StopMessage' => ['title' => '', 'description' => 'The stop details.', 'type' => 'string', 'example' => '""'], ], + 'example' => '', ], ], ], - 'staticInfo' => [ - 'returnType' => 'synchronous', - ], - 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"BDB621CB-A81E-5D39-8793-39A365CBCC74\\"\\n}","type":"json"}]', - ], - 'ListCalculationJobs' => [ - 'summary' => '获取计算任务列表。', - 'path' => '/api/v1/calculationjobs', - 'methods' => [ - 'get', + 'staticInfo' => ['returnType' => 'synchronous'], + 'title' => 'Query traffic control task deployment result', + 'description' => '## Operation description'."\n" + .'You can call this operation to query the deployment result of a traffic control task specified by TrafficControlTaskId for a given instance ID and environment. Make sure that the specified InstanceId is associated with your account and that the Environment parameter value is valid (Daily for daily environment, Pre for staging environment, Prod for production environment). All request parameters are required.', + 'changeSet' => [], + 'flowControl' => [ + 'flowControlList' => [], ], - 'schemes' => [ - 'http', - 'https', + 'ramActions' => [ + [ + 'operationType' => 'none', + 'ramAction' => [ + 'action' => 'pairec:QueryTrafficControlTaskDeployResult', + 'authLevel' => 'operate', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'PAIRecService', 'resourceType' => 'All Resource', 'arn' => '*'], + ], + ], + ], ], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"728C5E01-ABF6-5AA8-B9FC-B3BA05DECC77\\",\\n \\"TrafficControlTaskId\\": \\"3\\",\\n \\"DraftStatus\\": \\"Success\\",\\n \\"DraftMessage\\": \\"push draft success\\",\\n \\"DeployStatus\\": \\"Success\\",\\n \\"DeployMessage\\": \\"deploy job draft success\\",\\n \\"StartStatus\\": \\"Success\\",\\n \\"StartMessage\\": \\"start job success\\",\\n \\"PrepareStatus\\": \\"Success\\",\\n \\"PrepareMessage\\": \\"success\\",\\n \\"StopStatus\\": \\"Success\\",\\n \\"StopMessage\\": \\"\\\\\\"\\\\\\"\\"\\n}","type":"json"}]', + ], + 'QueryTrafficControlTaskItemReport' => [ + 'path' => '/api/v1/trafficcontroltasks/{TrafficControlTaskId}/action/queryitemreport', + 'methods' => ['get'], + 'schemes' => ['https'], 'security' => [ [ 'AK' => [], ], ], - 'consumes' => [ - 'application/json', - ], - 'produces' => [ - 'application/json', - ], + 'consumes' => ['application/json'], + 'produces' => ['application/json'], 'operationType' => 'read', 'deprecated' => false, 'systemTags' => [ - 'operationType' => 'list', + 'operationType' => 'none', 'riskType' => 'none', 'chargeType' => 'free', - 'abilityTreeNodes' => [ - 'FEATURElearnN0NAWV', - ], + 'abilityTreeCode' => '254719', + 'abilityTreeNodes' => ['FEATURElearnVYA4L9'], ], 'parameters' => [ [ - 'name' => 'PageNumber', - 'in' => 'query', - 'schema' => [ - 'description' => '', - 'type' => 'integer', - 'format' => 'int32', - 'required' => false, - 'example' => '1', - ], + 'name' => 'TrafficControlTaskId', + 'in' => 'path', + 'schema' => ['description' => 'The ID of the traffic control task.', 'type' => 'string', 'required' => true, 'example' => '1', 'title' => ''], ], [ - 'name' => 'PageSize', + 'name' => 'InstanceId', 'in' => 'query', - 'schema' => [ - 'description' => '', - 'type' => 'integer', - 'format' => 'int32', - 'required' => false, - 'example' => '10', - ], + 'schema' => ['description' => 'The instance ID.', 'type' => 'string', 'required' => true, 'example' => 'pairec_123****', 'title' => ''], ], [ - 'name' => 'InstanceId', + 'name' => 'Environment', 'in' => 'query', - 'schema' => [ - 'description' => '', - 'type' => 'string', - 'required' => true, - 'example' => 'pairec-cn-test1', - ], + 'schema' => ['description' => 'The execution environment for the task. Valid values: Daily (development environment), Pre (staging environment), Prod (production environment).', 'type' => 'string', 'required' => true, 'example' => 'Pre', 'title' => ''], ], [ - 'name' => 'SceneId', + 'name' => 'StartTime', 'in' => 'query', - 'schema' => [ - 'description' => '', - 'type' => 'string', - 'required' => true, - 'example' => '1', - ], + 'schema' => ['description' => 'The start time.', 'type' => 'string', 'required' => true, 'example' => '2024-01-01 10:30:00', 'title' => ''], ], [ - 'name' => 'Status', + 'name' => 'EndTime', 'in' => 'query', - 'schema' => [ - 'description' => '', - 'type' => 'string', - 'required' => false, - 'example' => 'Success', - ], + 'schema' => ['description' => 'The end time.', 'type' => 'string', 'required' => true, 'example' => '2024-01-02 10:30:00', 'title' => ''], ], ], 'responses' => [ 200 => [ 'schema' => [ + 'description' => 'The data returned.', 'title' => 'Schema of Response', - 'description' => 'Schema of Response', 'type' => 'object', 'properties' => [ - 'RequestId' => [ - 'title' => 'Id of the request', - 'description' => '', - 'type' => 'string', - 'example' => 'F7AC05FF-EDE7-5C2B-B9AE-33D6DF4178BA', - ], - 'TotalCount' => [ - 'description' => '', - 'type' => 'integer', - 'format' => 'int64', - 'example' => '10', - ], - 'CalculationJobs' => [ - 'description' => '', + 'RequestId' => ['title' => 'Id of the request', 'description' => 'The request ID.', 'type' => 'string', 'example' => '728C5E01-ABF6-5AA8-B9FC-B3BA05DECC77'], + 'TrafficControlTaskItemReports' => [ + 'description' => 'An array of item control reports.', 'type' => 'array', 'items' => [ - 'description' => '', + 'description' => 'A single item control report.', 'type' => 'object', 'properties' => [ - 'CalculationJobId' => [ - 'description' => '', - 'type' => 'string', - 'example' => '2', - ], - 'ABMetricName' => [ - 'description' => '', - 'type' => 'string', - 'example' => 'pv', - ], - 'Status' => [ - 'description' => '', - 'type' => 'string', - 'example' => 'Success', - ], - 'JobMessage' => [ - 'description' => '', - 'type' => 'array', - 'items' => [ - 'description' => '', - 'type' => 'string', - 'example' => 'success', - ], - ], - 'Config' => [ - 'description' => '', - 'type' => 'string', - 'example' => '{}', - ], - 'GmtRanTime' => [ - 'description' => '', - 'type' => 'string', - 'example' => '2021-12-15T23:24:33.132+08:00', - ], - 'BizDate' => [ - 'description' => '', - 'type' => 'string', - 'example' => '2021-12-15', - ], - 'JobSource' => [ - 'description' => '', - 'type' => 'string', - 'example' => 'CronOffline', - ], + 'TrafficControlTargetId' => ['description' => 'The ID of the traffic control target.', 'type' => 'string', 'example' => '3', 'title' => ''], + 'TrafficControlTargetName' => ['description' => 'The name of the traffic control target.', 'type' => 'string', 'example' => 'item-1', 'title' => ''], + 'OughtItemControlNum' => ['description' => 'The expected number of controlled items.', 'type' => 'integer', 'format' => 'int64', 'example' => '10', 'title' => ''], + 'OughtItemControlTraffic' => ['description' => 'The expected traffic of controlled items.', 'type' => 'integer', 'format' => 'int64', 'example' => '1000', 'title' => ''], + 'ActualItemControlNum' => ['description' => 'The actual number of controlled items.', 'type' => 'integer', 'format' => 'int64', 'example' => '4', 'title' => ''], + 'ActualItemControlTraffic' => ['description' => 'The actual traffic of controlled items.', 'type' => 'integer', 'format' => 'int64', 'example' => '500', 'title' => ''], + 'DoneItemControlNum' => ['description' => 'The number of items that reached the control target.', 'type' => 'integer', 'format' => 'int64', 'example' => '6', 'title' => ''], + 'ItemControlNumPercentage' => ['description' => 'The actual number of controlled items as a percentage of the expected number.', 'type' => 'string', 'example' => '10%', 'title' => ''], + 'ItemControlTrafficPercentage' => ['description' => 'The actual traffic from controlled items as a percentage of the expected traffic.', 'type' => 'string', 'example' => '20%', 'title' => ''], + 'DoneItemControlPercentage' => ['description' => 'The number of items that reached the control target, as a percentage of the expected number of controlled items.', 'type' => 'string', 'example' => '20%', 'title' => ''], ], + 'title' => '', + 'example' => '', ], + 'title' => '', + 'example' => '', ], ], + 'example' => '', ], ], ], - 'staticInfo' => [ - 'returnType' => 'synchronous', + 'staticInfo' => ['returnType' => 'synchronous'], + 'title' => 'Query item-level report for traffic control job', + 'summary' => 'Retrieves a detailed report on item control for a specified traffic control task.', + 'description' => '## Description'."\n" + ."\n" + .'- This API retrieves the item control results for a specific traffic control task within a given time range.'."\n" + ."\n" + .'- `TrafficControlTaskId` is the unique identifier for a traffic control task.'."\n" + ."\n" + .'- `InstanceId` specifies the instance that runs the task.'."\n" + ."\n" + .'- The `Environment` parameter specifies the task\'s execution environment. Valid values are Daily (development environment), Pre (staging environment), and Prod (production environment).'."\n" + ."\n" + .'- `StartTime` and `EndTime` specify the start and end of the time range for the report, respectively. The format is "YYYY-MM-DD HH:MM:SS".'."\n" + ."\n" + .'- The specified start and end times must be valid and span no more than two consecutive calendar days.', + 'changeSet' => [], + 'flowControl' => [ + 'flowControlList' => [], + ], + 'ramActions' => [ + [ + 'operationType' => 'none', + 'ramAction' => [ + 'action' => 'pairec:QueryTrafficControlTaskItemReport', + 'authLevel' => 'operate', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'PAIRecService', 'resourceType' => 'All Resource', 'arn' => '*'], + ], + ], + ], ], - 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"F7AC05FF-EDE7-5C2B-B9AE-33D6DF4178BA\\",\\n \\"TotalCount\\": 10,\\n \\"CalculationJobs\\": [\\n {\\n \\"CalculationJobId\\": \\"2\\",\\n \\"ABMetricName\\": \\"pv\\",\\n \\"Status\\": \\"Success\\",\\n \\"JobMessage\\": [\\n \\"success\\"\\n ],\\n \\"Config\\": \\"{}\\",\\n \\"GmtRanTime\\": \\"2021-12-15T23:24:33.132+08:00\\",\\n \\"BizDate\\": \\"2021-12-15\\",\\n \\"JobSource\\": \\"CronOffline\\"\\n }\\n ]\\n}","type":"json"}]', + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"728C5E01-ABF6-5AA8-B9FC-B3BA05DECC77\\",\\n \\"TrafficControlTaskItemReports\\": [\\n {\\n \\"TrafficControlTargetId\\": \\"3\\",\\n \\"TrafficControlTargetName\\": \\"item-1\\",\\n \\"OughtItemControlNum\\": 10,\\n \\"OughtItemControlTraffic\\": 1000,\\n \\"ActualItemControlNum\\": 4,\\n \\"ActualItemControlTraffic\\": 500,\\n \\"DoneItemControlNum\\": 6,\\n \\"ItemControlNumPercentage\\": \\"10%\\",\\n \\"ItemControlTrafficPercentage\\": \\"20%\\",\\n \\"DoneItemControlPercentage\\": \\"20%\\"\\n }\\n ]\\n}","type":"json"}]', ], - 'GetCalculationJob' => [ - 'summary' => '获取指定计算任务详细信息。', - 'path' => '/api/v1/calculationjobs/{CalculationJobId}', - 'methods' => [ - 'get', - ], - 'schemes' => [ - 'http', - 'https', - ], + 'ReleaseTrafficControlTask' => [ + 'summary' => 'Releases a traffic control task for the specified instance and environment.', + 'path' => '/api/v1/trafficcontroltasks/{TrafficControlTaskId}/action/release', + 'methods' => ['post'], + 'schemes' => ['http', 'https'], 'security' => [ [ 'AK' => [], ], ], - 'consumes' => [ - 'application/json', - ], - 'produces' => [ - 'application/json', - ], - 'operationType' => 'read', + 'consumes' => ['application/json'], + 'produces' => ['application/json'], + 'operationType' => 'write', 'deprecated' => false, 'systemTags' => [ - 'operationType' => 'get', + 'operationType' => 'none', 'riskType' => 'none', 'chargeType' => 'free', - 'abilityTreeNodes' => [ - 'FEATURElearnN0NAWV', - ], + 'abilityTreeCode' => '220413', + 'abilityTreeNodes' => ['FEATURElearnN0NAWV'], ], 'parameters' => [ [ - 'name' => 'CalculationJobId', + 'name' => 'TrafficControlTaskId', 'in' => 'path', - 'schema' => [ - 'description' => '', - 'type' => 'string', - 'required' => true, - 'example' => '1', - ], + 'schema' => ['description' => 'The traffic control task ID.', 'type' => 'string', 'required' => false, 'example' => '1', 'title' => ''], ], [ - 'name' => 'InstanceId', - 'in' => 'query', + 'name' => 'body', + 'in' => 'body', + 'style' => 'json', 'schema' => [ - 'description' => '', - 'type' => 'string', - 'required' => true, - 'example' => 'pairec-cn-test1', + 'description' => 'The request body.', + 'type' => 'object', + 'properties' => [ + 'InstanceId' => ['description' => 'The instance ID.', 'type' => 'string', 'required' => false, 'example' => 'pairec_123****', 'title' => ''], + 'Environment' => ['description' => 'The execution environment for the traffic control task. Valid values: `Daily`, `Pre`, and `Prod`.', 'type' => 'string', 'required' => false, 'example' => 'Daily', 'title' => ''], + ], + 'required' => false, + 'title' => '', + 'example' => '', ], ], ], 'responses' => [ 200 => [ 'schema' => [ + 'description' => 'The response body.', 'title' => 'Schema of Response', - 'description' => 'Schema of Response', 'type' => 'object', 'properties' => [ - 'RequestId' => [ - 'title' => 'Id of the request', - 'description' => '', - 'type' => 'string', - 'example' => '7D59453C-48AA-5FC5-8848-2D373BD1A17F', - ], - 'ABMetricId' => [ - 'description' => '', - 'type' => 'string', - 'example' => '1', - ], - 'ABMetricName' => [ - 'description' => '', - 'type' => 'string', - 'example' => 'pv', - ], - 'Status' => [ - 'description' => '', - 'type' => 'string', - 'example' => 'Success', - ], - 'JobMessage' => [ - 'description' => '', - 'type' => 'array', - 'items' => [ - 'description' => '', - 'type' => 'string', - 'example' => 'success', - ], - ], - 'Config' => [ - 'description' => '', - 'type' => 'string', - 'example' => '{}', - ], - 'GmtRanTime' => [ - 'description' => '', - 'type' => 'string', - 'example' => '2021-12-15T23:24:33.132+08:00', - ], - 'BizDate' => [ - 'description' => '', - 'type' => 'string', - 'example' => '2021-12-15', - ], - 'JobSource' => [ - 'description' => '', - 'type' => 'string', - 'example' => 'CronOffline', - ], + 'RequestId' => ['title' => 'Id of the request', 'description' => 'The request ID.', 'type' => 'string', 'example' => '728C5E01-ABF6-5AA8-B9FC-B3BA05DECC77'], ], + 'example' => '', ], ], ], - 'staticInfo' => [ - 'returnType' => 'synchronous', + 'staticInfo' => ['returnType' => 'synchronous'], + 'title' => 'Publish traffic control job', + 'description' => '## Request'."\n" + ."\n" + .'Use this API to release a traffic control task for a specific instance and environment (Daily, Pre, or Prod). Your request must include the `TrafficControlTaskId`, `InstanceId`, and `Environment` parameters.'."\n" + ."\n" + .'- `TrafficControlTaskId`: The unique ID of the traffic control task.'."\n" + ."\n" + .'- `InstanceId`: The ID of the target instance.'."\n" + ."\n" + .'- `Environment`: The execution environment for the traffic control task. Valid values: `Daily`, `Pre`, and `Prod`.'."\n" + ."\n" + .'The request succeeds only if all required parameters are provided correctly. A successful response includes a `RequestId`.', + 'changeSet' => [], + 'flowControl' => [ + 'flowControlList' => [], + ], + 'ramActions' => [ + [ + 'operationType' => 'none', + 'ramAction' => [ + 'action' => 'pairec:ReleaseTrafficControlTask', + 'authLevel' => 'operate', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'PAIRecService', 'resourceType' => 'All Resource', 'arn' => '*'], + ], + ], + ], ], - 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"7D59453C-48AA-5FC5-8848-2D373BD1A17F\\",\\n \\"ABMetricId\\": \\"1\\",\\n \\"ABMetricName\\": \\"pv\\",\\n \\"Status\\": \\"Success\\",\\n \\"JobMessage\\": [\\n \\"success\\"\\n ],\\n \\"Config\\": \\"{}\\",\\n \\"GmtRanTime\\": \\"2021-12-15T23:24:33.132+08:00\\",\\n \\"BizDate\\": \\"2021-12-15\\",\\n \\"JobSource\\": \\"CronOffline\\"\\n}","type":"json"}]', + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"728C5E01-ABF6-5AA8-B9FC-B3BA05DECC77\\"\\n}","type":"json"}]', ], - 'CreateCalculationJobs' => [ - 'summary' => '创建AB指标的计算任务。', - 'path' => '/api/v1/batch/calculationjobs/create', - 'methods' => [ - 'post', - ], - 'schemes' => [ - 'http', - 'https', - ], + 'ReportABMetricGroup' => [ + 'summary' => 'Retrieve a metric group\'s report.', + 'path' => '/api/v1/abmetricgroups/{ABMetricGroupId}/action/report', + 'methods' => ['post'], + 'schemes' => ['http', 'https'], 'security' => [ [ 'AK' => [], ], ], - 'consumes' => [ - 'application/json', - ], - 'produces' => [ - 'application/json', - ], - 'operationType' => 'write', + 'consumes' => ['application/json'], + 'produces' => ['application/json'], + 'operationType' => 'read', 'deprecated' => false, 'systemTags' => [ - 'operationType' => 'create', + 'operationType' => 'none', 'riskType' => 'none', 'chargeType' => 'free', - 'abilityTreeNodes' => [ - 'FEATURElearnN0NAWV', - ], + 'abilityTreeNodes' => ['FEATURElearnN0NAWV'], ], 'parameters' => [ [ + 'name' => 'ABMetricGroupId', + 'in' => 'path', + 'schema' => ['description' => 'The ID of the AB metric group.', 'type' => 'string', 'required' => true, 'example' => '1', 'title' => ''], + ], + [ 'name' => 'body', 'in' => 'body', 'style' => 'json', 'schema' => [ - 'description' => '', + 'description' => 'The request body.', 'type' => 'object', 'properties' => [ - 'ABMetricIds' => [ - 'description' => '', - 'type' => 'string', - 'required' => true, - 'example' => '2,3,4', - ], - 'StartDate' => [ - 'description' => '', - 'type' => 'string', - 'required' => true, - 'example' => '2023-01-01', - ], - 'EndDate' => [ - 'description' => '', - 'type' => 'string', - 'required' => true, - 'example' => '2023-01-03', - ], - 'InstanceId' => [ - 'description' => '', - 'type' => 'string', - 'required' => true, - 'example' => 'pairec-cn-test1', - ], + 'InstanceId' => ['description' => 'The instance ID. You can call the [ListInstances](~~2411819~~) operation to obtain the instance ID.', 'type' => 'string', 'required' => true, 'example' => 'pairec-cn-test1', 'title' => ''], + 'ReportType' => ['description' => 'The type of the report.'."\n" + ."\n" + .'- Realtime: real-time report.'."\n" + ."\n" + .'- Offline: offline report.'."\n" + ."\n" + .'- Market: dashboard report.', 'type' => 'string', 'required' => true, 'example' => 'Offline', 'title' => ''], + 'SceneId' => ['description' => 'The ID of the scene. You can call the [ListScenes](~~2402581~~) operation to obtain the scene ID.', 'type' => 'string', 'required' => false, 'example' => '1', 'title' => ''], + 'ExperimentGroupId' => ['description' => 'The ID of the experiment group. You can call the [ListExperimentGroups](~~2402573~~) operation to obtain the ID of the experiment group. This parameter is required for offline and real-time reports.', 'type' => 'string', 'required' => false, 'example' => '3', 'title' => ''], + 'ExperimentIds' => ['description' => 'The IDs of the experiments. You can call the [ListExperiments](~~2402582~~) operation to obtain the IDs of the experiments.', 'type' => 'string', 'required' => true, 'example' => '3,4,5', 'title' => ''], + 'BaseExperimentId' => ['description' => 'The ID of the base experiment.', 'type' => 'string', 'required' => true, 'example' => '3', 'title' => ''], + 'TimeStatisticsMethod' => ['description' => 'The time statistics method. This parameter is required for real-time reports.'."\n" + ."\n" + .'- Hour: The statistics are collected by hour.'."\n" + ."\n" + .'- Day: The statistics are accumulated from 00:00 on the current day.', 'type' => 'string', 'required' => false, 'example' => 'Hour', 'title' => ''], + 'DimensionFields' => ['description' => 'The dimension fields.', 'type' => 'string', 'required' => false, 'example' => '{"gender":"man"}', 'title' => ''], + 'StartDate' => ['description' => 'The start date.', 'type' => 'string', 'required' => false, 'example' => '2021-07-01', 'title' => ''], + 'EndDate' => ['description' => 'The end date.', 'type' => 'string', 'required' => false, 'example' => '2021-07-01', 'title' => ''], ], 'required' => false, + 'title' => '', + 'example' => '', ], ], ], @@ -13834,324 +14850,155 @@ 200 => [ 'schema' => [ 'title' => 'Schema of Response', - 'description' => 'Schema of Response', + 'description' => 'The response data.', 'type' => 'object', 'properties' => [ - 'RequestId' => [ - 'title' => 'Id of the request', - 'description' => '', - 'type' => 'string', - 'example' => '8C27790E-CCA5-56BB-BA17-646295DEC0A2', + 'RequestId' => ['title' => 'Id of the request', 'description' => 'The request ID.', 'type' => 'string', 'example' => '59CE7EC6-F268-5D71-9215-32922CC50D72'], + 'ExperimentReport' => [ + 'description' => 'The experiment report.', + 'type' => 'object', + 'additionalProperties' => [ + 'type' => 'object', + 'properties' => [ + 'Baseline' => ['description' => 'Indicates whether the data is from the baseline experiment.', 'type' => 'boolean', 'example' => 'true', 'title' => ''], + 'MetricResults' => [ + 'type' => 'object', + 'additionalProperties' => [ + 'type' => 'object', + 'additionalProperties' => [ + 'type' => 'object', + 'properties' => [ + 'ExpId' => ['description' => 'The experiment ID.', 'type' => 'string', 'example' => '2', 'title' => ''], + 'ExpName' => ['description' => 'The experiment name.', 'type' => 'string', 'example' => 'test实验', 'title' => ''], + 'MetricName' => ['description' => 'The metric name.', 'type' => 'string', 'example' => 'pv', 'title' => ''], + 'MetricValue' => ['description' => 'The metric value.', 'type' => 'string', 'example' => '100', 'title' => ''], + 'DimensionValue' => ['description' => 'The dimension value.', 'type' => 'string', 'example' => 'ALL', 'title' => ''], + 'Date' => ['description' => 'The date.', 'type' => 'string', 'example' => '20230206', 'title' => ''], + 'PercentDiff' => ['description' => 'The growth rate compared to the baseline.', 'type' => 'string', 'example' => '0.1', 'title' => ''], + 'PercentDiffStr' => ['description' => 'The growth rate compared to the baseline, as a string.', 'type' => 'string', 'example' => '"0.1"', 'title' => ''], + ], + 'description' => 'The results for a specific dimension.', + 'title' => '', + 'example' => '', + ], + 'description' => 'The results for a specific metric.', + 'title' => '', + 'example' => '', + ], + 'description' => 'The metric results.', + 'title' => '', + 'example' => '', + ], + ], + 'description' => 'The report information.', + 'title' => '', + 'example' => '', + ], + 'title' => '', + 'example' => '', ], - 'CalculationJobIds' => [ - 'description' => '', + 'GroupDimension' => [ + 'description' => 'The dimensions used for grouping the report data.', 'type' => 'array', - 'items' => [ - 'description' => '', - 'type' => 'string', - 'example' => '["12","13","14"]', - ], + 'items' => ['description' => 'A dimension name.', 'type' => 'string', 'example' => '["all"]', 'title' => ''], + 'title' => '', + 'example' => '', ], ], + 'example' => '', ], ], ], - 'staticInfo' => [ - 'returnType' => 'synchronous', + 'staticInfo' => ['returnType' => 'synchronous'], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"59CE7EC6-F268-5D71-9215-32922CC50D72\\",\\n \\"ExperimentReport\\": {\\n \\"key\\": {\\n \\"Baseline\\": true,\\n \\"MetricResults\\": {\\n \\"key\\": {\\n \\"key\\": {\\n \\"ExpId\\": \\"2\\",\\n \\"ExpName\\": \\"test实验\\",\\n \\"MetricName\\": \\"pv\\",\\n \\"MetricValue\\": \\"100\\",\\n \\"DimensionValue\\": \\"ALL\\",\\n \\"Date\\": \\"20230206\\",\\n \\"PercentDiff\\": \\"0.1\\",\\n \\"PercentDiffStr\\": \\"\\\\\\"0.1\\\\\\"\\"\\n }\\n }\\n }\\n }\\n },\\n \\"GroupDimension\\": [\\n \\"[\\\\\\"all\\\\\\"]\\"\\n ]\\n}","type":"json"}]', + 'title' => 'Query metric group report', + 'changeSet' => [], + 'flowControl' => [ + 'flowControlList' => [], + ], + 'ramActions' => [ + [ + 'operationType' => 'none', + 'ramAction' => [ + 'action' => 'pairec:ReportABMetricGroup', + 'authLevel' => 'operate', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'PAIRecService', 'resourceType' => 'All Resource', 'arn' => '*'], + ], + ], + ], ], - 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"8C27790E-CCA5-56BB-BA17-646295DEC0A2\\",\\n \\"CalculationJobIds\\": [\\n \\"[\\\\\\"12\\\\\\",\\\\\\"13\\\\\\",\\\\\\"14\\\\\\"]\\"\\n ]\\n}","type":"json"}]', ], - 'CreateFeatureConsistencyCheckJobConfig' => [ - 'summary' => '创建特征一致性检查配置。', - 'path' => '/api/v1/featureconsistencycheck/jobconfigs', - 'methods' => [ - 'post', - ], - 'schemes' => [ - 'http', - 'https', - ], + 'SplitTrafficControlTarget' => [ + 'summary' => 'Splits the target values for a traffic control target into time intervals.', + 'path' => '/api/v1/trafficcontroltargets/{TrafficControlTargetId}/action/split', + 'methods' => ['post'], + 'schemes' => ['http', 'https'], 'security' => [ [ 'AK' => [], ], ], - 'consumes' => [ - 'application/json', - ], - 'produces' => [ - 'application/json', - ], + 'consumes' => ['application/json'], + 'produces' => ['application/json'], 'operationType' => 'readAndWrite', 'deprecated' => false, 'systemTags' => [ - 'operationType' => 'create', + 'operationType' => 'none', 'riskType' => 'none', 'chargeType' => 'free', - 'abilityTreeCode' => '193262', - 'abilityTreeNodes' => [ - 'FEATURElearnN0NAWV', - ], + 'abilityTreeCode' => '220603', + 'abilityTreeNodes' => ['FEATURElearnN0NAWV'], ], 'parameters' => [ [ + 'name' => 'TrafficControlTargetId', + 'in' => 'path', + 'schema' => ['description' => 'The ID of the traffic control target.', 'type' => 'string', 'required' => false, 'example' => '1', 'title' => ''], + ], + [ 'name' => 'body', 'in' => 'body', 'style' => 'json', 'schema' => [ - 'description' => '', + 'description' => 'The request body.', 'type' => 'object', 'properties' => [ - 'InstanceId' => [ - 'title' => '实例ID。', - 'description' => '', - 'type' => 'string', - 'required' => true, - 'example' => 'pairec-cn-********', - ], - 'Name' => [ - 'title' => '特征一致性检查名称。', - 'description' => '', - 'type' => 'string', - 'required' => true, - 'example' => 'feature_consistency_check1', - ], - 'SceneId' => [ - 'title' => '场景ID。', - 'description' => '', - 'type' => 'string', - 'required' => true, - 'example' => '3', - ], - 'SampleRate' => [ - 'title' => '采样比例（0-1）。', - 'description' => '', - 'type' => 'number', - 'format' => 'double', - 'required' => true, - 'example' => '0.89', - ], - 'FeatureLandingResourceId' => [ - 'title' => '数据回落数据源ID。', - 'description' => '', - 'type' => 'string', - 'required' => true, - 'example' => 'reso-********', - ], - 'EasServiceName' => [ - 'title' => 'PAI-EAS服务名称。', - 'description' => '', - 'type' => 'string', - 'required' => true, - 'example' => 'service_123', - ], - 'FgJsonFileName' => [ - 'title' => 'fg_json文件名称。', - 'description' => '', - 'type' => 'string', - 'required' => true, - 'example' => 'file.json', - ], - 'UserTable' => [ - 'title' => 'user表名。', - 'description' => '', - 'type' => 'string', - 'required' => false, - 'example' => 'user_table', - ], - 'UserIdField' => [ - 'title' => 'user_id字段名。', - 'description' => '', - 'type' => 'string', - 'required' => false, - 'example' => 'user_id', - ], - 'UserTablePartitionField' => [ - 'title' => 'user表分区字段。', - 'description' => '', - 'type' => 'string', - 'required' => false, - 'example' => 'ds', - ], - 'UserTablePartitionFieldFormat' => [ - 'title' => 'user表分区字段格式。'."\n" - .'● yyyymmdd'."\n" - .'● yyyy-mm-dd', - 'description' => '', - 'type' => 'string', - 'required' => false, - 'example' => 'yyyymmdd', - ], - 'ItemTable' => [ - 'title' => 'item表名。', - 'description' => '', - 'type' => 'string', - 'required' => false, - 'example' => 'item_table', - ], - 'ItemIdField' => [ - 'title' => 'item_id字段名。', - 'description' => '', - 'type' => 'string', - 'required' => false, - 'example' => 'item_id', - ], - 'ItemTablePartitionField' => [ - 'title' => 'item表分区字段。', - 'description' => '', - 'type' => 'string', - 'required' => false, - 'example' => 'ds', - ], - 'ItemTablePartitionFieldFormat' => [ - 'title' => 'item表分区字段格式。'."\n" - .'● yyyymmdd'."\n" - .'● yyyy-mm-dd', - 'description' => '', - 'type' => 'string', - 'required' => false, - 'example' => 'yyyymmdd', - ], - 'CompareFeature' => [ - 'title' => '是否需要特征比对。', - 'description' => '', - 'type' => 'boolean', - 'required' => true, - 'example' => 'true', - ], - 'GenerateZip' => [ - 'title' => '是否需要生成zip包。', - 'description' => '', - 'type' => 'boolean', - 'required' => true, - 'example' => 'true', - ], - 'ServiceId' => [ - 'title' => '服务ID。', - 'description' => '', - 'type' => 'string', - 'required' => true, - 'example' => '4', - ], - 'WorkflowName' => [ - 'title' => '工作流名称。', - 'description' => '', - 'type' => 'string', - 'required' => false, - 'example' => 'work_flow_1', - ], - 'OssResourceId' => [ - 'title' => 'OSS数据源ID。', - 'description' => '', - 'type' => 'string', - 'required' => false, - 'example' => 'reso-********', - ], - 'EasyRecVersion' => [ - 'title' => 'EasyRec版本。', - 'description' => '', - 'type' => 'string', - 'required' => false, - 'example' => '1.3.60', - ], - 'EasyRecPackagePath' => [ - 'title' => 'EasyRec包路径。', - 'description' => '', - 'type' => 'string', - 'required' => false, - 'example' => 'oss://*******', - ], - 'FgJarVersion' => [ - 'title' => 'fg_jar版本。', - 'description' => '', - 'type' => 'string', + 'Environment' => ['description' => 'The environment. Valid values:'."\n" + ."\n" + .'- `Pre`: pre-production environment.'."\n" + ."\n" + .'- `Prod`: production environment.', 'type' => 'string', 'required' => false, 'example' => 'Prod', 'title' => ''], + 'InstanceId' => ['description' => 'The instance ID. For information about how to obtain the instance ID, see [ListInstances](~~2411819~~).', 'type' => 'string', 'required' => false, 'example' => 'learn-pairec-xxx', 'title' => ''], + 'TimePoints' => [ + 'description' => 'The time points that define the traffic-splitting intervals.', + 'type' => 'array', + 'items' => ['description' => 'A time point, in minutes.', 'type' => 'integer', 'format' => 'int64', 'required' => false, 'example' => '30', 'title' => ''], 'required' => false, - 'example' => '1.0.0', + 'title' => '', + 'example' => '', ], - 'FeaturePriority' => [ - 'title' => '特征优先级，多个特征通过逗号分开。', - 'description' => '', - 'type' => 'string', + 'SetValues' => [ + 'description' => 'The target values that correspond to the time intervals defined by the `TimePoints` parameter.', + 'type' => 'array', + 'items' => ['description' => 'A target value for a specific time interval.', 'type' => 'integer', 'format' => 'int64', 'required' => false, 'example' => '3', 'title' => ''], 'required' => false, - 'example' => 'feature1,feature2,feature3', + 'title' => '', + 'example' => '', ], - 'FeatureDisplayExclude' => [ - 'title' => '特征展示过滤，多个特征通过逗号分开。', - 'description' => '', - 'type' => 'string', + 'SetPoints' => [ + 'description' => 'This parameter is deprecated.', + 'type' => 'array', + 'items' => ['description' => 'This parameter is deprecated.', 'type' => 'integer', 'format' => 'int64', 'required' => false, 'example' => '0', 'title' => ''], 'required' => false, - 'example' => 'feature1,feature2', - ], - 'UseFeatureStore' => [ - 'type' => 'boolean', - 'required' => true, - 'default' => 'false', - ], - 'FeatureStoreProjectName' => [ - 'type' => 'string', - ], - 'FeatureStoreModelId' => [ - 'type' => 'string', - ], - 'FeatureStoreUserId' => [ - 'type' => 'string', - ], - 'FeatureStoreItemId' => [ - 'type' => 'string', - ], - 'FeatureStoreSeqFeatureView' => [ - 'type' => 'string', - ], - 'FeatureStoreProjectId' => [ - 'type' => 'string', - ], - 'WorkspaceId' => [ - 'type' => 'string', - ], - 'VpcId' => [ - 'type' => 'string', - ], - 'SwitchId' => [ - 'type' => 'string', - ], - 'SecurityGroupId' => [ - 'type' => 'string', - ], - 'DefaultRoute' => [ - 'type' => 'string', - ], - 'DatasetId' => [ - 'type' => 'string', - ], - 'DatasetType' => [ - 'type' => 'string', - ], - 'DatasetUri' => [ - 'type' => 'string', - ], - 'DatasetMountPath' => [ - 'type' => 'string', - ], - 'DatasetName' => [ - 'type' => 'string', - ], - 'PredictWorkerCount' => [ - 'type' => 'integer', - 'format' => 'int32', - ], - 'PredictWorkerCpu' => [ - 'type' => 'integer', - 'format' => 'int32', - ], - 'PredictWorkerMemory' => [ - 'type' => 'integer', - 'format' => 'int32', - ], - 'ResourceConfig' => [ - 'type' => 'string', + 'title' => '', + 'example' => '', ], ], 'required' => false, + 'title' => '', + 'example' => '', ], ], ], @@ -14159,1332 +15006,575 @@ 200 => [ 'schema' => [ 'title' => 'Schema of Response', - 'description' => 'Schema of Response', + 'description' => 'The response schema.', 'type' => 'object', 'properties' => [ - 'RequestId' => [ - 'title' => 'Id of the request', - 'description' => '', - 'type' => 'string', - 'example' => 'E15A1443-7917-5BE0-AE70-25538ECF398D', - ], - 'FeatureConsistencyCheckJobConfigId' => [ - 'title' => '特征一致性检查配置ID。', - 'description' => '', - 'type' => 'string', - 'example' => '4', - ], + 'RequestId' => ['title' => 'Id of the request', 'description' => 'The request ID.', 'type' => 'string', 'example' => 'F8F613A9-DF1C-551A-88E1-397A3981A785'], ], + 'example' => '', ], ], ], - 'staticInfo' => [ - 'returnType' => 'synchronous', + 'staticInfo' => ['returnType' => 'synchronous'], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"F8F613A9-DF1C-551A-88E1-397A3981A785\\"\\n}","type":"json"}]', + 'title' => 'Split the target values of traffic control', + 'description' => 'Splits the target values for a traffic control target into time intervals.', + 'changeSet' => [], + 'flowControl' => [ + 'flowControlList' => [], + ], + 'ramActions' => [ + [ + 'operationType' => 'none', + 'ramAction' => [ + 'action' => 'pairec:SplitTrafficControlTarget', + 'authLevel' => 'operate', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'PAIRecService', 'resourceType' => 'All Resource', 'arn' => '*'], + ], + ], + ], ], - 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"E15A1443-7917-5BE0-AE70-25538ECF398D\\",\\n \\"FeatureConsistencyCheckJobConfigId\\": \\"4\\"\\n}","type":"json"}]', ], - 'CreateFeatureConsistencyCheckJob' => [ - 'summary' => '创建特征一致性检查任务。', - 'path' => '/api/v1/featureconsistencycheck/jobs', - 'methods' => [ - 'post', - ], - 'schemes' => [ - 'http', - 'https', - ], + 'StartTrafficControlTarget' => [ + 'path' => '/api/v1/trafficcontroltargets/{TrafficControlTargetId}/action/start', + 'methods' => ['post'], + 'schemes' => ['http', 'https'], 'security' => [ [ 'AK' => [], ], ], - 'consumes' => [ - 'application/json', - ], - 'produces' => [ - 'application/json', - ], + 'consumes' => ['application/json'], + 'produces' => ['application/json'], 'operationType' => 'readAndWrite', 'deprecated' => false, 'systemTags' => [ - 'operationType' => 'create', + 'operationType' => 'none', 'riskType' => 'none', 'chargeType' => 'free', - 'abilityTreeNodes' => [ - 'FEATURElearnN0NAWV', - ], + 'abilityTreeCode' => '220598', + 'abilityTreeNodes' => ['FEATURElearnN0NAWV'], ], 'parameters' => [ [ + 'name' => 'TrafficControlTargetId', + 'in' => 'path', + 'schema' => ['description' => 'The ID of the traffic control target.', 'type' => 'string', 'required' => false, 'example' => '1', 'title' => ''], + ], + [ 'name' => 'body', 'in' => 'body', 'style' => 'json', 'schema' => [ - 'description' => '', + 'description' => 'The request body.', 'type' => 'object', 'properties' => [ - 'InstanceId' => [ - 'title' => '实例ID。', - 'description' => '', - 'type' => 'string', - 'required' => true, - 'example' => 'pairec-cn-********', - ], - 'FeatureConsistencyCheckJobConfigId' => [ - 'title' => '特征一致性检查任务配置ID。', - 'description' => '', - 'type' => 'string', - 'required' => true, - 'example' => '3', - ], - 'Environment' => [ - 'title' => '运行环境。'."\n" - .'● Daily-日常环境'."\n" - .'● Pre-预发环境'."\n" - .'● Prod-生产环境', - 'description' => '', - 'type' => 'string', - 'required' => true, - 'example' => 'Pre', - ], - 'SamplingDuration' => [ - 'description' => '', - 'type' => 'integer', - 'format' => 'int32', - 'required' => true, - 'example' => '10', - ], + 'InstanceId' => ['description' => 'The ID of the instance.', 'type' => 'string', 'required' => false, 'example' => 'pairec-1324***', 'title' => ''], ], 'required' => false, + 'title' => '', + 'example' => '', ], ], ], 'responses' => [ 200 => [ 'schema' => [ + 'description' => 'The response object.', 'title' => 'Schema of Response', - 'description' => 'Schema of Response', 'type' => 'object', 'properties' => [ - 'RequestId' => [ - 'title' => 'Id of the request', - 'description' => '', - 'type' => 'string', - 'example' => '7D59453C-48AA-5FC5-8848-2D373BD1A17F', - ], - 'FeatureConsistencyCheckJobId' => [ - 'title' => '特征一致性检查任务ID。', - 'description' => '', - 'type' => 'string', - 'example' => '4', - ], + 'RequestId' => ['title' => 'Id of the request', 'description' => 'The request ID.', 'type' => 'string', 'example' => '728C5E01-ABF6-5AA8-B9FC-B3BA05DECC77'], ], + 'example' => '', ], ], ], - 'staticInfo' => [ - 'returnType' => 'synchronous', + 'staticInfo' => ['returnType' => 'synchronous'], + 'title' => 'Enable Traffic Control Job', + 'summary' => 'Starts a traffic control task for a specific traffic control target.', + 'description' => '## Request'."\n" + ."\n" + .'Call this operation to start a traffic control task by providing the `TrafficControlTargetId` and `InstanceId`.', + 'changeSet' => [], + 'flowControl' => [ + 'flowControlList' => [], ], - 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"7D59453C-48AA-5FC5-8848-2D373BD1A17F\\",\\n \\"FeatureConsistencyCheckJobId\\": \\"4\\"\\n}","type":"json"}]', - ], - 'UpdateFeatureConsistencyCheckJobConfig' => [ - 'summary' => '更新特征一致性检查配置信息。', - 'path' => '/api/v1/featureconsistencycheck/jobconfigs/{FeatureConsistencyCheckJobConfigId}', - 'methods' => [ - 'put', - ], - 'schemes' => [ - 'http', - 'https', + 'ramActions' => [ + [ + 'operationType' => 'none', + 'ramAction' => [ + 'action' => 'pairec:StartTrafficControlTarget', + 'authLevel' => 'operate', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'PAIRecService', 'resourceType' => 'All Resource', 'arn' => '*'], + ], + ], + ], ], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"728C5E01-ABF6-5AA8-B9FC-B3BA05DECC77\\"\\n}","type":"json"}]', + ], + 'StartTrafficControlTask' => [ + 'path' => '/api/v1/trafficcontroltasks/{TrafficControlTaskId}/action/start', + 'methods' => ['post'], + 'schemes' => ['http', 'https'], 'security' => [ [ 'AK' => [], ], ], - 'consumes' => [ - 'application/json', - ], - 'produces' => [ - 'application/json', - ], - 'operationType' => 'readAndWrite', + 'consumes' => ['application/json'], + 'produces' => ['application/json'], + 'operationType' => 'write', 'deprecated' => false, 'systemTags' => [ - 'operationType' => 'update', + 'operationType' => 'none', 'riskType' => 'none', 'chargeType' => 'free', - 'abilityTreeCode' => '193282', - 'abilityTreeNodes' => [ - 'FEATURElearnN0NAWV', - ], + 'abilityTreeCode' => '220409', + 'abilityTreeNodes' => ['FEATURElearnN0NAWV'], ], 'parameters' => [ [ - 'name' => 'FeatureConsistencyCheckJobConfigId', + 'name' => 'TrafficControlTaskId', 'in' => 'path', - 'schema' => [ - 'title' => '特征一致性检查配置ID。', - 'description' => '', - 'type' => 'string', - 'required' => true, - 'example' => '3', - ], + 'schema' => ['description' => 'The traffic control task ID.', 'type' => 'string', 'required' => true, 'example' => '1', 'title' => ''], ], [ 'name' => 'body', 'in' => 'body', 'style' => 'json', 'schema' => [ - 'description' => '', + 'description' => 'The request body.', 'type' => 'object', 'properties' => [ - 'InstanceId' => [ - 'title' => '实例ID，可从接口ListInstances获取。', - 'description' => '', - 'type' => 'string', - 'required' => true, - 'example' => 'pairec-cn-********', - ], - 'Name' => [ - 'title' => '特征一致性检查名称。', - 'description' => '', - 'type' => 'string', - 'required' => true, - 'example' => 'feature_consistency_check1', - ], - 'SceneId' => [ - 'title' => '场景ID。', - 'description' => '', - 'type' => 'string', - 'required' => true, - 'example' => '3', - ], - 'SampleRate' => [ - 'title' => '采样比例（0-1）。', - 'description' => '', - 'type' => 'number', - 'format' => 'double', - 'required' => true, - 'example' => '0.89', - ], - 'FeatureLandingResourceId' => [ - 'title' => '数据回落数据源ID。', - 'description' => '', - 'type' => 'string', - 'required' => true, - 'example' => 'reso-********', - ], - 'EasServiceName' => [ - 'title' => 'PAI-EAS服务名称。', - 'description' => '', - 'type' => 'string', - 'required' => true, - 'example' => 'service_123', - ], - 'FgJsonFileName' => [ - 'title' => 'fg_json文件名称。', - 'description' => '', - 'type' => 'string', - 'required' => true, - 'example' => 'file.json', - ], - 'UserTable' => [ - 'title' => 'user表名。', - 'description' => '', - 'type' => 'string', - 'required' => true, - 'example' => 'user_table', - ], - 'UserIdField' => [ - 'title' => 'user_id字段名。', - 'description' => '', - 'type' => 'string', - 'required' => true, - 'example' => 'user_id', - ], - 'UserTablePartitionField' => [ - 'title' => 'user表分区字段。', - 'description' => '', - 'type' => 'string', - 'required' => true, - 'example' => 'ds', - ], - 'UserTablePartitionFieldFormat' => [ - 'title' => 'user表分区字段格式。'."\n" - .'● yyyymmdd'."\n" - .'● yyyy-mm-dd', - 'description' => '', - 'type' => 'string', - 'required' => true, - 'example' => 'yyyymmdd', - ], - 'ItemTable' => [ - 'title' => 'item表名。', - 'description' => '', - 'type' => 'string', - 'required' => true, - 'example' => 'item_table', - ], - 'ItemIdField' => [ - 'title' => 'item_id字段名。', - 'description' => '', - 'type' => 'string', - 'required' => true, - 'example' => 'item_id', - ], - 'ItemTablePartitionField' => [ - 'title' => 'item表分区字段。', - 'description' => '', - 'type' => 'string', - 'required' => true, - 'example' => 'ds', - ], - 'ItemTablePartitionFieldFormat' => [ - 'title' => 'item表分区字段格式。'."\n" - .'● yyyymmdd'."\n" - .'● yyyy-mm-dd', - 'description' => '', - 'type' => 'string', - 'required' => true, - 'example' => 'yyyymmdd', - ], - 'CompareFeature' => [ - 'title' => '是否需要特征比对。', - 'description' => '', - 'type' => 'boolean', - 'required' => true, - 'example' => 'true', - ], - 'GenerateZip' => [ - 'title' => '是否需要生成zip包。', - 'description' => '', - 'type' => 'boolean', - 'required' => true, - 'example' => 'true', - ], - 'ServiceId' => [ - 'title' => '服务ID。', - 'description' => '', - 'type' => 'string', - 'required' => false, - 'example' => '4', - ], - 'WorkflowName' => [ - 'title' => '工作流名称。', - 'description' => '', - 'type' => 'string', - 'required' => false, - 'example' => 'work_flow_1', - ], - 'OssResourceId' => [ - 'title' => 'OSS数据源ID。', - 'description' => '', - 'type' => 'string', - 'required' => false, - 'example' => 'reso-********', - ], - 'EasyRecVersion' => [ - 'title' => 'EasyRec版本。', - 'description' => '', - 'type' => 'string', - 'required' => false, - 'example' => '1.3.60', - ], - 'EasyRecPackagePath' => [ - 'title' => 'EasyRec包路径。', - 'description' => '', - 'type' => 'string', - 'required' => false, - 'example' => 'oss://********', - ], - 'FgJarVersion' => [ - 'title' => 'fg_jar版本。', - 'description' => '', - 'type' => 'string', - 'required' => false, - 'example' => '1.0.0', - ], - 'FeaturePriority' => [ - 'title' => '特征优先级，多个特征通过逗号分开。', - 'description' => '', - 'type' => 'string', - 'required' => false, - 'example' => 'feature1,feature2,feature3', - ], - 'FeatureDisplayExclude' => [ - 'title' => '特征展示过滤，多个特征通过逗号分开。', - 'description' => '', - 'type' => 'string', - 'required' => false, - 'example' => 'feature1,feature2', - ], - 'IsUseFeatureStore' => [ - 'type' => 'boolean', - ], - 'FeatureStoreProjectName' => [ - 'type' => 'string', - ], - 'FeatureStoreModelId' => [ - 'type' => 'string', - ], - 'FeatureStoreUserId' => [ - 'type' => 'string', - ], - 'FeatureStoreItemId' => [ - 'type' => 'string', - ], - 'FeatureStoreSeqFeatureView' => [ - 'type' => 'string', - ], - 'FeatureStoreProjectId' => [ - 'type' => 'string', - ], - 'WorkspaceId' => [ - 'type' => 'string', - ], - 'VpcId' => [ - 'type' => 'string', - ], - 'SwitchId' => [ - 'type' => 'string', - ], - 'SecurityGroupId' => [ - 'type' => 'string', - ], - 'DefaultRoute' => [ - 'type' => 'string', - ], - 'DatasetId' => [ - 'type' => 'string', - ], - 'DatasetType' => [ - 'type' => 'string', - ], - 'DatasetUri' => [ - 'type' => 'string', - ], - 'DatasetMountPath' => [ - 'type' => 'string', - ], - 'DatasetName' => [ - 'type' => 'string', - ], - 'PredictWorkerCount' => [ - 'type' => 'integer', - 'format' => 'int32', - ], - 'PredictWorkerCpu' => [ - 'type' => 'integer', - 'format' => 'int32', - ], - 'PredictWorkerMemory' => [ - 'type' => 'integer', - 'format' => 'int32', - ], - 'ResourceConfig' => [ - 'type' => 'string', - ], + 'InstanceId' => ['description' => 'The instance ID.', 'type' => 'string', 'required' => false, 'example' => 'pairec-123***', 'title' => ''], + 'Environment' => ['description' => 'The target environment. Valid values:', 'type' => 'string', 'required' => false, 'example' => 'Pre', 'title' => ''], ], 'required' => false, + 'title' => '', + 'example' => '', ], ], ], 'responses' => [ 200 => [ 'schema' => [ - 'title' => 'Schema of Response', - 'description' => 'Schema of Response', + 'description' => 'The response object.', + 'title' => 'Schema of Response ', 'type' => 'object', 'properties' => [ - 'RequestId' => [ - 'title' => 'Id of the request', - 'description' => '', - 'type' => 'string', - 'example' => 'A04CB8C0-E74A-5E83-BC61-64D153574EC7', - ], + 'RequestId' => ['title' => 'Id of the request ', 'description' => 'The request ID.', 'type' => 'string', 'example' => '728C5E01-ABF6-5AA8-B9FC-B3BA05DECC77'], ], + 'example' => '', ], ], ], - 'staticInfo' => [ - 'returnType' => 'synchronous', + 'staticInfo' => ['returnType' => 'synchronous'], + 'title' => 'Enable traffic control job ', + 'summary' => 'Starts a traffic control task with a specified ID for instances in different environments.', + 'description' => '## Request details'."\n" + ."\n" + .'- This operation starts the traffic control task identified by `TrafficControlTaskId`.'."\n" + ."\n" + .'- `InstanceId` specifies the target instance.'."\n" + ."\n" + .'- `Environment` specifies the target environment. Valid values: Daily, Pre, and Prod.'."\n" + ."\n" + .'- Ensure that all required parameters are set correctly before you call this operation. The specified `TrafficControlTaskId` must exist in the system.', + 'changeSet' => [], + 'flowControl' => [ + 'flowControlList' => [], + ], + 'ramActions' => [ + [ + 'operationType' => 'none', + 'ramAction' => [ + 'action' => 'pairec:StartTrafficControlTask', + 'authLevel' => 'operate', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'PAIRecService', 'resourceType' => 'All Resource', 'arn' => '*'], + ], + ], + ], ], - 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"A04CB8C0-E74A-5E83-BC61-64D153574EC7\\"\\n}","type":"json"}]', + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"728C5E01-ABF6-5AA8-B9FC-B3BA05DECC77\\"\\n}","type":"json"}]', ], - 'ListFeatureConsistencyCheckJobConfigs' => [ - 'summary' => '获取特征一致性检查配置列表。', - 'path' => '/api/v1/featureconsistencycheck/jobconfigs', - 'methods' => [ - 'get', - ], - 'schemes' => [ - 'http', - 'https', - ], + 'StopTrafficControlFlinkTask' => [ + 'path' => '/api/v1/trafficcontroltasks/{TrafficControlTaskId}/action/stopflink', + 'methods' => ['post'], + 'schemes' => ['https'], 'security' => [ [ 'AK' => [], ], ], - 'consumes' => [ - 'application/json', - ], - 'produces' => [ - 'application/json', - ], - 'operationType' => 'read', + 'consumes' => ['application/json'], + 'produces' => ['application/json'], + 'operationType' => 'write', 'deprecated' => false, 'systemTags' => [ - 'operationType' => 'list', + 'operationType' => 'none', 'riskType' => 'none', 'chargeType' => 'free', - 'abilityTreeCode' => '193273', - 'abilityTreeNodes' => [ - 'FEATURElearnN0NAWV', - ], + 'abilityTreeNodes' => ['FEATURElearnN0NAWV'], ], 'parameters' => [ [ - 'name' => 'InstanceId', - 'in' => 'query', - 'schema' => [ - 'title' => '实例ID。', - 'description' => '', - 'type' => 'string', - 'required' => true, - 'example' => 'pairec-cn-********', - ], + 'name' => 'TrafficControlTaskId', + 'in' => 'path', + 'schema' => ['description' => 'The traffic control ID.', 'type' => 'string', 'required' => false, 'example' => '1', 'title' => ''], ], [ - 'name' => 'PageNumber', - 'in' => 'query', + 'name' => 'body', + 'in' => 'body', + 'style' => 'json', 'schema' => [ - 'title' => '页码。', - 'description' => '', - 'type' => 'string', + 'description' => 'The request body.', + 'type' => 'object', + 'properties' => [ + 'InstanceId' => ['description' => 'The instance ID.', 'type' => 'string', 'required' => false, 'example' => 'pairec_123****', 'title' => ''], + 'Environment' => [ + 'description' => 'The environment to which the instance belongs. Valid values: '."\n" + ."\n" + .'- Daily: daily environment.'."\n" + ."\n" + .'- Pre: staging environment.'."\n" + ."\n" + .'- Prod: production environment.', + 'enumValueTitles' => ['Prod' => 'Production.', 'Daily' => 'Daily.', 'Pre' => 'Staging.'], + 'type' => 'string', + 'required' => false, + 'example' => 'Daily', + 'title' => '', + ], + ], 'required' => false, - 'example' => '1', + 'example' => '{}', + 'title' => '', ], ], - [ - 'name' => 'PageSize', - 'in' => 'query', + ], + 'responses' => [ + 200 => [ 'schema' => [ - 'title' => '页大小。', - 'description' => '', - 'type' => 'string', - 'required' => false, - 'example' => '10', + 'title' => '', + 'description' => 'Schema of Response', + 'type' => 'object', + 'properties' => [ + 'RequestId' => ['title' => '', 'description' => 'The request ID.', 'type' => 'string', 'example' => '728C5E01-ABF6-5AA8-B9FC-B3BA05DECC77'], + ], + 'example' => '', ], ], + ], + 'staticInfo' => ['returnType' => 'synchronous'], + 'title' => 'Stop a traffic control flink task', + 'summary' => 'Stops a traffic control Flink task with the specified ID.', + 'description' => '## Request description'."\n" + .'You can call this operation to stop a specific traffic control Flink task based on the specified TrafficControlTaskId. Make sure that you have prepared the correct InstanceId and the environment to which the instance belongs (Daily for daily environment, Pre for staging environment, Prod for production environment). Include this information in the request body to ensure that the operation is correctly performed.', + 'changeSet' => [], + 'flowControl' => [ + 'flowControlList' => [], + ], + 'ramActions' => [], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"728C5E01-ABF6-5AA8-B9FC-B3BA05DECC77\\"\\n}","type":"json"}]', + ], + 'StopTrafficControlTarget' => [ + 'summary' => 'Stops a specific traffic control target.', + 'path' => '/api/v1/trafficcontroltargets/{TrafficControlTargetId}/action/stop', + 'methods' => ['post'], + 'schemes' => ['http', 'https'], + 'security' => [ [ - 'name' => 'SortBy', - 'in' => 'query', - 'schema' => [ - 'title' => '排序依据。'."\n" - .'GmtCreateTime-创建时间。'."\n" - .'GmtModifiedTime-更新时间。', - 'description' => '', - 'type' => 'string', - 'required' => false, - 'example' => 'GmtCreateTime', - ], + 'AK' => [], ], + ], + 'consumes' => ['application/json'], + 'produces' => ['application/json'], + 'operationType' => 'readAndWrite', + 'deprecated' => false, + 'systemTags' => [ + 'operationType' => 'none', + 'riskType' => 'none', + 'chargeType' => 'free', + 'abilityTreeCode' => '220602', + 'abilityTreeNodes' => ['FEATURElearnN0NAWV'], + ], + 'parameters' => [ [ - 'name' => 'Order', - 'in' => 'query', + 'name' => 'TrafficControlTargetId', + 'in' => 'path', + 'schema' => ['description' => 'The traffic control target ID.', 'type' => 'string', 'required' => false, 'example' => '1', 'title' => ''], + ], + [ + 'name' => 'body', + 'in' => 'body', + 'style' => 'json', 'schema' => [ - 'title' => '排序方式。'."\n" - .'● ASC-升序。'."\n" - .'● DESC-降序。', - 'description' => '', - 'type' => 'string', + 'description' => 'The request body.', + 'type' => 'object', + 'properties' => [ + 'InstanceId' => ['description' => 'The instance ID.', 'type' => 'string', 'required' => false, 'example' => 'pairec-1324***', 'title' => ''], + ], 'required' => false, - 'example' => 'ASC', + 'title' => '', + 'example' => '', ], ], ], 'responses' => [ 200 => [ 'schema' => [ - 'title' => 'Schema of Response', - 'description' => 'Schema of Response', + 'description' => 'The response object.', + 'title' => 'Schema of Response ', 'type' => 'object', 'properties' => [ - 'RequestId' => [ - 'title' => 'Id of the request', - 'description' => '', - 'type' => 'string', - 'example' => 'FCF741D8-9C30-578E-807F-B935487DB34A', - ], - 'TotalCount' => [ - 'title' => '总个数。', - 'description' => '', - 'type' => 'integer', - 'format' => 'int64', - 'example' => '10', - ], - 'FeatureConsistencyCheckConfigs' => [ - 'title' => '特征一致性检查列表。', - 'description' => '', - 'type' => 'array', - 'items' => [ - 'type' => 'object', - 'properties' => [ - 'FeatureConsistencyCheckJobConfigId' => [ - 'title' => '特征一致性检查配置ID。', - 'description' => '', - 'type' => 'string', - 'example' => '3', - ], - 'Name' => [ - 'title' => '特征一致性检查配置名称。', - 'description' => '', - 'type' => 'string', - 'example' => 'feature_consistency_check1', - ], - 'SceneId' => [ - 'title' => '场景ID。', - 'description' => '', - 'type' => 'string', - 'example' => '3', - ], - 'SceneName' => [ - 'title' => '场景名称。', - 'description' => '', - 'type' => 'string', - 'example' => 'scene1', - ], - 'Status' => [ - 'title' => '状态。'."\n" - .'● Editable-可编辑的。'."\n" - .'● Uneditable-不可编辑的。', - 'description' => '', - 'type' => 'string', - 'example' => 'Editable', - ], - 'CompareFeature' => [ - 'title' => '是否开启特征比对。', - 'description' => '', - 'type' => 'boolean', - 'example' => 'true', - ], - 'LatestJobId' => [ - 'title' => '基于该配置最近一次创建的任务ID。', - 'description' => '', - 'type' => 'string', - 'example' => '3', - ], - 'LatestJobGmtSamplingStartTime' => [ - 'title' => '最近一次创建的任务的开始时间。', - 'description' => '', - 'type' => 'string', - 'example' => '2021-12-15T23:24:33.132+08:00', - ], - 'LatestJobGmtSamplingEndTime' => [ - 'title' => '最近一次创建的任务的结束时间。', - 'description' => '', - 'type' => 'string', - 'example' => '2021-12-15T23:24:33.132+08:00', - ], - 'SampleRate' => [ - 'title' => '采样比例（0-1）。', - 'description' => '', - 'type' => 'string', - 'example' => '0.89', - ], - 'FeatureLandingResourceId' => [ - 'title' => '数据回落数据源ID。', - 'description' => '', - 'type' => 'string', - 'example' => 'reso-********', - ], - 'FeatureLandingResourceUri' => [ - 'title' => '数据回落数据源地址。', - 'description' => '', - 'type' => 'string', - 'example' => 'mc_project_1', - ], - 'EasServiceName' => [ - 'title' => 'EAS服务名称。', - 'description' => '', - 'type' => 'string', - 'example' => 'eas_service_1', - ], - 'FgJsonFileName' => [ - 'title' => 'fg_json文件名称。', - 'description' => '', - 'type' => 'string', - 'example' => 'file.json', - ], - 'UserTable' => [ - 'title' => 'user表名。', - 'description' => '', - 'type' => 'string', - 'example' => 'user_table', - ], - 'UserIdField' => [ - 'title' => 'user_id字段名。', - 'description' => '', - 'type' => 'string', - 'example' => 'user_id', - ], - 'UserTablePartitionField' => [ - 'title' => 'user表分区字段。', - 'description' => '', - 'type' => 'string', - 'example' => 'ds', - ], - 'UserTablePartitionFieldFormat' => [ - 'title' => 'user表分区字段格式。'."\n" - .'● yyyymmdd'."\n" - .'● yyyy-mm-dd', - 'description' => '', - 'type' => 'string', - 'example' => 'yyyymmdd', - ], - 'ItemTable' => [ - 'title' => 'item表名。', - 'description' => '', - 'type' => 'string', - 'example' => 'item_table', - ], - 'ItemIdField' => [ - 'title' => 'item_id字段名。', - 'description' => '', - 'type' => 'string', - 'example' => 'item_id', - ], - 'ItemTablePartitionField' => [ - 'title' => 'item表分区字段。', - 'description' => '', - 'type' => 'string', - 'example' => 'ds', - ], - 'ItemTablePartitionFieldFormat' => [ - 'title' => 'item表分区字段格式。'."\n" - .'● yyyymmdd'."\n" - .'● yyyy-mm-dd', - 'description' => '', - 'type' => 'string', - 'example' => 'yyyymmdd', - ], - 'GenerateZip' => [ - 'title' => '是否需要生成zip包。', - 'description' => '', - 'type' => 'boolean', - 'example' => 'true', - ], - 'ServiceId' => [ - 'title' => '服务ID。', - 'description' => '', - 'type' => 'string', - 'example' => '4', - ], - 'ServiceName' => [ - 'title' => '服务名称。', - 'description' => '', - 'type' => 'string', - 'example' => 'service1', - ], - 'WorkflowName' => [ - 'title' => '工作流名称。', - 'description' => '', - 'type' => 'string', - 'example' => 'work_flow_1', - ], - 'OssResourceId' => [ - 'title' => 'OSS数据源ID。', - 'description' => '', - 'type' => 'string', - 'example' => 'reso-********', - ], - 'OssBucket' => [ - 'title' => 'OSS bucket名称。', - 'description' => '', - 'type' => 'string', - 'example' => 'oss_bucket_1', - ], - 'EasyRecVersion' => [ - 'title' => 'EasyRec版本。', - 'description' => '', - 'type' => 'string', - 'example' => '1.3.60', - ], - 'EasyRecPackagePath' => [ - 'title' => 'EasyRec包路径。', - 'description' => '', - 'type' => 'string', - 'example' => 'oss://*******', - ], - 'FgJarVersion' => [ - 'title' => 'fg_jar版本。', - 'description' => '', - 'type' => 'string', - 'example' => '1.0.0', - ], - 'FeaturePriority' => [ - 'title' => '特征优先级，多个特征通过逗号分开。', - 'description' => '', - 'type' => 'string', - 'example' => 'feature1,feature2,feature3', - ], - 'FeatureDisplayExclude' => [ - 'title' => '特征展示过滤，多个特征通过逗号分开。', - 'description' => '', - 'type' => 'string', - 'example' => 'feature1,feature2', - ], - 'GmtCreateTime' => [ - 'title' => '创建时间。', - 'description' => '', - 'type' => 'string', - 'example' => '2021-12-15T23:24:33.132+08:00', - ], - 'GmtModifiedTime' => [ - 'title' => '更新时间。', - 'description' => '', - 'type' => 'string', - 'example' => '2021-12-15T23:24:33.132+08:00', - ], - 'UseFeatureStore' => [ - 'type' => 'string', - ], - 'FeatureStoreProjectName' => [ - 'type' => 'string', - ], - 'FeatureStoreModelId' => [ - 'type' => 'string', - ], - 'FeatureStoreUserId' => [ - 'type' => 'string', - ], - 'FeatureStoreItemId' => [ - 'type' => 'string', - ], - 'FeatureStoreSeqFeatureView' => [ - 'type' => 'string', - ], - 'FeatureStoreProjectId' => [ - 'type' => 'string', - ], - 'WorkspaceId' => [ - 'type' => 'string', - ], - 'VpcId' => [ - 'type' => 'string', - ], - 'SwitchId' => [ - 'type' => 'string', - ], - 'SecurityGroupId' => [ - 'type' => 'string', - ], - 'DefaultRoute' => [ - 'type' => 'string', - ], - 'DatasetId' => [ - 'type' => 'string', - ], - 'DatasetType' => [ - 'type' => 'string', - ], - 'DatasetUri' => [ - 'type' => 'string', - ], - 'DatasetMountPath' => [ - 'type' => 'string', - ], - 'DatasetName' => [ - 'type' => 'string', - ], - 'PredictWorkerCount' => [ - 'type' => 'integer', - 'format' => 'int32', - ], - 'PredictWorkerCpu' => [ - 'type' => 'integer', - 'format' => 'int32', - ], - 'PredictWorkerMemory' => [ - 'type' => 'integer', - 'format' => 'int32', - ], - 'ResourceConfig' => [ - 'type' => 'string', - ], - ], - ], - ], + 'RequestId' => ['title' => 'Id of the request ', 'description' => 'The request ID.', 'type' => 'string', 'example' => '728C5E01-ABF6-5AA8-B9FC-B3BA05DECC77'], ], + 'example' => '', ], ], ], - 'staticInfo' => [ - 'returnType' => 'synchronous', + 'staticInfo' => ['returnType' => 'synchronous'], + 'title' => 'Stop a traffic control target ', + 'description' => '## Request'."\n" + ."\n" + .'This operation stops a traffic control task using the provided `TrafficControlTargetId` and `InstanceId`. Ensure that the parameter values are accurate to avoid stopping the wrong target or instance.', + 'changeSet' => [], + 'flowControl' => [ + 'flowControlList' => [], ], - 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"FCF741D8-9C30-578E-807F-B935487DB34A\\",\\n \\"TotalCount\\": 10,\\n \\"FeatureConsistencyCheckConfigs\\": [\\n {\\n \\"FeatureConsistencyCheckJobConfigId\\": \\"3\\",\\n \\"Name\\": \\"feature_consistency_check1\\",\\n \\"SceneId\\": \\"3\\",\\n \\"SceneName\\": \\"scene1\\",\\n \\"Status\\": \\"Editable\\",\\n \\"CompareFeature\\": true,\\n \\"LatestJobId\\": \\"3\\",\\n \\"LatestJobGmtSamplingStartTime\\": \\"2021-12-15T23:24:33.132+08:00\\",\\n \\"LatestJobGmtSamplingEndTime\\": \\"2021-12-15T23:24:33.132+08:00\\",\\n \\"SampleRate\\": \\"0.89\\",\\n \\"FeatureLandingResourceId\\": \\"reso-********\\",\\n \\"FeatureLandingResourceUri\\": \\"mc_project_1\\",\\n \\"EasServiceName\\": \\"eas_service_1\\",\\n \\"FgJsonFileName\\": \\"file.json\\",\\n \\"UserTable\\": \\"user_table\\",\\n \\"UserIdField\\": \\"user_id\\",\\n \\"UserTablePartitionField\\": \\"ds\\",\\n \\"UserTablePartitionFieldFormat\\": \\"yyyymmdd\\",\\n \\"ItemTable\\": \\"item_table\\",\\n \\"ItemIdField\\": \\"item_id\\",\\n \\"ItemTablePartitionField\\": \\"ds\\",\\n \\"ItemTablePartitionFieldFormat\\": \\"yyyymmdd\\",\\n \\"GenerateZip\\": true,\\n \\"ServiceId\\": \\"4\\",\\n \\"ServiceName\\": \\"service1\\",\\n \\"WorkflowName\\": \\"work_flow_1\\",\\n \\"OssResourceId\\": \\"reso-********\\",\\n \\"OssBucket\\": \\"oss_bucket_1\\",\\n \\"EasyRecVersion\\": \\"1.3.60\\",\\n \\"EasyRecPackagePath\\": \\"oss://*******\\",\\n \\"FgJarVersion\\": \\"1.0.0\\",\\n \\"FeaturePriority\\": \\"feature1,feature2,feature3\\",\\n \\"FeatureDisplayExclude\\": \\"feature1,feature2\\",\\n \\"GmtCreateTime\\": \\"2021-12-15T23:24:33.132+08:00\\",\\n \\"GmtModifiedTime\\": \\"2021-12-15T23:24:33.132+08:00\\",\\n \\"UseFeatureStore\\": \\"true\\",\\n \\"FeatureStoreProjectName\\": \\"project-1\\",\\n \\"FeatureStoreModelId\\": \\"2\\\\n\\",\\n \\"FeatureStoreUserId\\": \\"user\\",\\n \\"FeatureStoreItemId\\": \\"item\\",\\n \\"FeatureStoreSeqFeatureView\\": \\"item-1\\",\\n \\"FeatureStoreProjectId\\": \\"prj-01\\",\\n \\"WorkspaceId\\": \\"\\",\\n \\"VpcId\\": \\"\\",\\n \\"SwitchId\\": \\"\\",\\n \\"SecurityGroupId\\": \\"\\",\\n \\"DefaultRoute\\": \\"\\",\\n \\"DatasetId\\": \\"\\",\\n \\"DatasetType\\": \\"\\",\\n \\"DatasetUri\\": \\"\\",\\n \\"DatasetMountPath\\": \\"\\",\\n \\"DatasetName\\": \\"\\",\\n \\"PredictWorkerCount\\": 0,\\n \\"PredictWorkerCpu\\": 0,\\n \\"PredictWorkerMemory\\": 0,\\n \\"ResourceConfig\\": \\"\\"\\n }\\n ]\\n}","type":"json"}]', - ], - 'GetFeatureConsistencyCheckJobConfig' => [ - 'summary' => '获取特征一致性检测配置详情。', - 'path' => '/api/v1/featureconsistencycheck/jobconfigs/{FeatureConsistencyCheckJobConfigId}', - 'methods' => [ - 'get', - ], - 'schemes' => [ - 'http', - 'https', + 'ramActions' => [ + [ + 'operationType' => 'none', + 'ramAction' => [ + 'action' => 'pairec:StopTrafficControlTarget', + 'authLevel' => 'operate', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'PAIRecService', 'resourceType' => 'All Resource', 'arn' => '*'], + ], + ], + ], ], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"728C5E01-ABF6-5AA8-B9FC-B3BA05DECC77\\"\\n}","type":"json"}]', + ], + 'StopTrafficControlTask' => [ + 'summary' => 'Stops a traffic control task for a specific instance and environment.', + 'path' => '/api/v1/trafficcontroltasks/{TrafficControlTaskId}/action/stop', + 'methods' => ['post'], + 'schemes' => ['http', 'https'], 'security' => [ [ 'AK' => [], ], ], - 'consumes' => [ - 'application/json', - ], - 'produces' => [ - 'application/json', - ], - 'operationType' => 'read', + 'consumes' => ['application/json'], + 'produces' => ['application/json'], + 'operationType' => 'write', 'deprecated' => false, 'systemTags' => [ - 'operationType' => 'get', + 'operationType' => 'none', 'riskType' => 'none', 'chargeType' => 'free', - 'abilityTreeCode' => '193280', - 'abilityTreeNodes' => [ - 'FEATURElearnN0NAWV', - ], + 'abilityTreeCode' => '220411', + 'abilityTreeNodes' => ['FEATURElearnN0NAWV'], ], 'parameters' => [ [ - 'name' => 'FeatureConsistencyCheckJobConfigId', + 'name' => 'TrafficControlTaskId', 'in' => 'path', + 'schema' => ['description' => 'The traffic control task ID.', 'type' => 'string', 'required' => false, 'example' => '1', 'title' => ''], + ], + [ + 'name' => 'body', + 'in' => 'body', + 'style' => 'json', 'schema' => [ - 'title' => '特征一致性检查配置ID。', - 'description' => '', - 'type' => 'string', - 'required' => true, - 'example' => '3', + 'description' => 'The request body.', + 'type' => 'object', + 'properties' => [ + 'InstanceId' => ['description' => 'The instance ID.', 'type' => 'string', 'required' => false, 'example' => 'pairec_123****', 'title' => ''], + 'Environment' => ['description' => 'The environment. Valid values: `Daily` (daily environment), `Pre` (pre-production environment), and `Prod` (production environment).', 'type' => 'string', 'required' => false, 'example' => 'Daily', 'title' => ''], + ], + 'required' => false, + 'title' => '', + 'example' => '', ], ], [ - 'name' => 'InstanceId', + 'name' => 'RegionId', 'in' => 'query', - 'schema' => [ - 'title' => '实例ID，可从接口ListInstances获取。', - 'description' => '', - 'type' => 'string', - 'required' => true, - 'example' => 'pairec-cn-********', - ], + 'schema' => ['description' => 'The region ID.', 'type' => 'string', 'required' => false, 'example' => 'cn-hangzhou', 'title' => ''], ], ], 'responses' => [ 200 => [ 'schema' => [ + 'description' => 'The returned data.', 'title' => 'Schema of Response', - 'description' => 'Schema of Response', 'type' => 'object', 'properties' => [ - 'RequestId' => [ - 'title' => 'Id of the request', - 'description' => '', - 'type' => 'string', - 'example' => '728C5E01-ABF6-5AA8-B9FC-B3BA05DECC77', - ], - 'Name' => [ - 'title' => '特征一致性检查配置名称。', - 'description' => '', - 'type' => 'string', - 'example' => 'feature_consistency_check1', - ], - 'SceneId' => [ - 'title' => '场景ID。', - 'description' => '', - 'type' => 'string', - 'example' => '3', - ], - 'SceneName' => [ - 'title' => '场景名称。', - 'description' => '', - 'type' => 'string', - 'example' => 'scene1', - ], - 'Status' => [ - 'title' => '状态。'."\n" - .'● Editable-可编辑的。'."\n" - .'● Uneditable-不可编辑的。', - 'description' => '', - 'type' => 'string', - 'example' => 'Editable', - ], - 'CompareFeature' => [ - 'title' => '是否开启特征比对。', - 'description' => '', - 'type' => 'boolean', - 'example' => 'true', - ], - 'LatestJobId' => [ - 'title' => '基于该配置最近一次创建的任务ID。', - 'description' => '', - 'type' => 'string', - 'example' => '3', - ], - 'LatestJobGmtSamplingStartTime' => [ - 'title' => '最近一次创建的任务的开始时间。', - 'description' => '', - 'type' => 'string', - 'example' => '2021-12-15T23:24:33.132+08:00', - ], - 'LatestJobGmtSamplingEndTime' => [ - 'title' => '最近一次创建的任务的结束时间。', - 'description' => '', - 'type' => 'string', - 'example' => '2021-12-15T23:24:33.132+08:00', - ], - 'SampleRate' => [ - 'title' => '采样比例（0-1）。', - 'description' => '', - 'type' => 'string', - 'example' => '0.89', - ], - 'FeatureLandingResourceId' => [ - 'title' => '数据回落数据源ID。', - 'description' => '', - 'type' => 'string', - 'example' => 'reso-********', - ], - 'FeatureLandingResourceUri' => [ - 'title' => '数据回落数据源地址。', - 'description' => '', - 'type' => 'string', - 'example' => 'mc_project_1', - ], - 'EasServiceName' => [ - 'title' => 'EAS服务名称。', - 'description' => '', - 'type' => 'string', - 'example' => 'eas_service_1', - ], - 'FgJsonFileName' => [ - 'title' => 'fg_json文件名称。', - 'description' => '', - 'type' => 'string', - 'example' => 'file.json', - ], - 'UserTable' => [ - 'title' => 'user表名。', - 'description' => '', - 'type' => 'string', - 'example' => 'user_table', - ], - 'UserIdField' => [ - 'title' => 'user_id字段名。', - 'description' => '', - 'type' => 'string', - 'example' => 'user_id', - ], - 'UserTablePartitionField' => [ - 'title' => 'user表分区字段。', - 'description' => '', - 'type' => 'string', - 'example' => 'ds', - ], - 'UserTablePartitionFieldFormat' => [ - 'title' => 'user表分区字段格式。'."\n" - .'● yyyymmdd'."\n" - .'● yyyy-mm-dd', - 'description' => '', - 'type' => 'string', - 'example' => 'yyyymmdd', - ], - 'ItemTable' => [ - 'title' => 'item表名。', - 'description' => '', - 'type' => 'string', - 'example' => 'item_table', - ], - 'ItemIdField' => [ - 'title' => 'item_id字段名。', - 'description' => '', - 'type' => 'string', - 'example' => 'item_id', - ], - 'ItemTablePartitionField' => [ - 'title' => 'item表分区字段。', - 'description' => '', - 'type' => 'string', - 'example' => 'ds', - ], - 'ItemTablePartitionFieldFormat' => [ - 'title' => 'item表分区字段格式。'."\n" - .'● yyyymmdd'."\n" - .'● yyyy-mm-dd', - 'description' => '', - 'type' => 'string', - 'example' => 'yyyymmdd', - ], - 'GenerateZip' => [ - 'title' => '是否需要生成zip包。', - 'description' => '', - 'type' => 'boolean', - 'example' => 'true', - ], - 'ServiceId' => [ - 'title' => '服务ID。', - 'description' => '', - 'type' => 'string', - 'example' => '4', - ], - 'ServiceName' => [ - 'title' => '服务名称。', - 'description' => '', - 'type' => 'string', - 'example' => 'service1', - ], - 'WorkflowName' => [ - 'title' => '工作流名称。', - 'description' => '', - 'type' => 'string', - 'example' => 'work_flow_1', - ], - 'OssResourceId' => [ - 'title' => 'OSS数据源ID。', - 'description' => '', - 'type' => 'string', - 'example' => 'reso-********', - ], - 'OssBucket' => [ - 'title' => 'OSS bucket名称。', - 'description' => '', - 'type' => 'string', - 'example' => 'oss_bucket_1', - ], - 'EasyRecVersion' => [ - 'title' => 'EasyRec版本。', - 'description' => '', - 'type' => 'string', - 'example' => '1.3.60', - ], - 'EasyRecPackagePath' => [ - 'title' => 'EasyRec包路径。', - 'description' => '', - 'type' => 'string', - 'example' => 'oss://*******', - ], - 'FgJarVersion' => [ - 'title' => 'fg_jar版本。', - 'description' => '', - 'type' => 'string', - 'example' => '1.0.0', - ], - 'FeaturePriority' => [ - 'title' => '特征优先级，多个特征通过逗号分开。', - 'description' => '', - 'type' => 'string', - 'example' => 'feature1,feature2,feature3', - ], - 'FeatureDisplayExclude' => [ - 'title' => '特征展示过滤，多个特征通过逗号分开。', - 'description' => '', - 'type' => 'string', - 'example' => 'feature1,feature2', - ], - 'GmtCreateTime' => [ - 'title' => '创建时间。', - 'description' => '', - 'type' => 'string', - 'example' => '2021-12-15T23:24:33.132+08:00', - ], - 'GmtModifiedTime' => [ - 'title' => '更新时间。', - 'description' => '', - 'type' => 'string', - 'example' => '2021-12-15T23:24:33.132+08:00', - ], - 'UseFeatureStore' => [ - 'type' => 'boolean', - ], - 'FeatureStoreProjectName' => [ - 'type' => 'string', - ], - 'FeatureStoreModelId' => [ - 'type' => 'string', - ], - 'FeatureStoreUserId' => [ - 'type' => 'string', - ], - 'FeatureStoreItemId' => [ - 'type' => 'string', - ], - 'FeatureStoreSeqFeatureView' => [ - 'type' => 'string', - ], - 'FeatureStoreProjectId' => [ - 'type' => 'string', - ], - 'WorkspaceId' => [ - 'type' => 'string', - ], - 'VpcId' => [ - 'type' => 'string', - ], - 'SwitchId' => [ - 'type' => 'string', - ], - 'SecurityGroupId' => [ - 'type' => 'string', - ], - 'DefaultRoute' => [ - 'type' => 'string', - ], - 'DatasetId' => [ - 'type' => 'string', - ], - 'DatasetType' => [ - 'type' => 'string', - ], - 'DatasetUri' => [ - 'type' => 'string', - ], - 'DatasetMountPath' => [ - 'type' => 'string', - ], - 'DatasetName' => [ - 'type' => 'string', - ], - 'PredictWorkerCount' => [ - 'type' => 'integer', - 'format' => 'int32', - ], - 'PredictWorkerCpu' => [ - 'type' => 'integer', - 'format' => 'int32', - ], - 'PredictWorkerMemory' => [ - 'type' => 'integer', - 'format' => 'int32', - ], - 'ResourceConfig' => [ - 'type' => 'string', - ], + 'RequestId' => ['title' => 'Id of the request', 'description' => 'The request ID.', 'type' => 'string', 'example' => '728C5E01-ABF6-5AA8-B9FC-B3BA05DECC77'], ], + 'example' => '', ], ], ], - 'staticInfo' => [ - 'returnType' => 'synchronous', + 'staticInfo' => ['returnType' => 'synchronous'], + 'title' => 'Stop a traffic control job', + 'description' => '## Usage notes'."\n" + ."\n" + .'- This API stops a traffic control task identified by a specific `TrafficControlTaskId`.'."\n" + ."\n" + .'- The `InstanceId` and `Environment` parameters are required to identify the target instance and its environment.'."\n" + ."\n" + .'- Ensure that you provide the correct `TrafficControlTaskId` to prevent the request from failing.', + 'changeSet' => [], + 'flowControl' => [ + 'flowControlList' => [], + ], + 'ramActions' => [ + [ + 'operationType' => 'none', + 'ramAction' => [ + 'action' => 'pairec:StopTrafficControlTask', + 'authLevel' => 'operate', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'PAIRecService', 'resourceType' => 'All Resource', 'arn' => '*'], + ], + ], + ], ], - 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"728C5E01-ABF6-5AA8-B9FC-B3BA05DECC77\\",\\n \\"Name\\": \\"feature_consistency_check1\\",\\n \\"SceneId\\": \\"3\\",\\n \\"SceneName\\": \\"scene1\\",\\n \\"Status\\": \\"Editable\\",\\n \\"CompareFeature\\": true,\\n \\"LatestJobId\\": \\"3\\",\\n \\"LatestJobGmtSamplingStartTime\\": \\"2021-12-15T23:24:33.132+08:00\\",\\n \\"LatestJobGmtSamplingEndTime\\": \\"2021-12-15T23:24:33.132+08:00\\",\\n \\"SampleRate\\": \\"0.89\\",\\n \\"FeatureLandingResourceId\\": \\"reso-********\\",\\n \\"FeatureLandingResourceUri\\": \\"mc_project_1\\",\\n \\"EasServiceName\\": \\"eas_service_1\\",\\n \\"FgJsonFileName\\": \\"file.json\\",\\n \\"UserTable\\": \\"user_table\\",\\n \\"UserIdField\\": \\"user_id\\",\\n \\"UserTablePartitionField\\": \\"ds\\",\\n \\"UserTablePartitionFieldFormat\\": \\"yyyymmdd\\",\\n \\"ItemTable\\": \\"item_table\\",\\n \\"ItemIdField\\": \\"item_id\\",\\n \\"ItemTablePartitionField\\": \\"ds\\",\\n \\"ItemTablePartitionFieldFormat\\": \\"yyyymmdd\\",\\n \\"GenerateZip\\": true,\\n \\"ServiceId\\": \\"4\\",\\n \\"ServiceName\\": \\"service1\\",\\n \\"WorkflowName\\": \\"work_flow_1\\",\\n \\"OssResourceId\\": \\"reso-********\\",\\n \\"OssBucket\\": \\"oss_bucket_1\\",\\n \\"EasyRecVersion\\": \\"1.3.60\\",\\n \\"EasyRecPackagePath\\": \\"oss://*******\\",\\n \\"FgJarVersion\\": \\"1.0.0\\",\\n \\"FeaturePriority\\": \\"feature1,feature2,feature3\\",\\n \\"FeatureDisplayExclude\\": \\"feature1,feature2\\",\\n \\"GmtCreateTime\\": \\"2021-12-15T23:24:33.132+08:00\\",\\n \\"GmtModifiedTime\\": \\"2021-12-15T23:24:33.132+08:00\\",\\n \\"UseFeatureStore\\": true,\\n \\"FeatureStoreProjectName\\": \\"project-1\\",\\n \\"FeatureStoreModelId\\": \\"2\\",\\n \\"FeatureStoreUserId\\": \\"user\\",\\n \\"FeatureStoreItemId\\": \\"item\\",\\n \\"FeatureStoreSeqFeatureView\\": \\"item-1\\",\\n \\"FeatureStoreProjectId\\": \\"prj-01\\",\\n \\"WorkspaceId\\": \\"\\",\\n \\"VpcId\\": \\"\\",\\n \\"SwitchId\\": \\"\\",\\n \\"SecurityGroupId\\": \\"\\",\\n \\"DefaultRoute\\": \\"\\",\\n \\"DatasetId\\": \\"\\",\\n \\"DatasetType\\": \\"\\",\\n \\"DatasetUri\\": \\"\\",\\n \\"DatasetMountPath\\": \\"\\",\\n \\"DatasetName\\": \\"\\",\\n \\"PredictWorkerCount\\": 0,\\n \\"PredictWorkerCpu\\": 0,\\n \\"PredictWorkerMemory\\": 0,\\n \\"ResourceConfig\\": \\"\\"\\n}","type":"json"}]', + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"728C5E01-ABF6-5AA8-B9FC-B3BA05DECC77\\"\\n}","type":"json"}]', ], - 'ListFeatureConsistencyCheckJobs' => [ - 'summary' => '获取特征一致性检查任务列表。', - 'path' => '/api/v1/featureconsistencycheck/jobs', - 'methods' => [ - 'get', - ], - 'schemes' => [ - 'http', - 'https', - ], + 'SyncFeatureConsistencyCheckJobReplayLog' => [ + 'path' => '/api/v1/featureconsistencycheck/jobs/action/syncreplaylog', + 'methods' => ['post'], + 'schemes' => ['http', 'https'], 'security' => [ [ 'AK' => [], ], ], - 'consumes' => [ - 'application/json', - ], - 'produces' => [ - 'application/json', - ], - 'operationType' => 'read', + 'consumes' => ['application/json'], + 'produces' => ['application/json'], + 'operationType' => 'readAndWrite', 'deprecated' => false, 'systemTags' => [ - 'operationType' => 'get', + 'operationType' => 'none', 'riskType' => 'none', 'chargeType' => 'free', - 'abilityTreeNodes' => [ - 'FEATURElearnN0NAWV', - ], + 'abilityTreeNodes' => ['FEATURElearnN0NAWV'], ], 'parameters' => [ [ - 'name' => 'InstanceId', - 'in' => 'query', + 'name' => 'body', + 'in' => 'body', + 'style' => 'json', 'schema' => [ - 'title' => '实例ID。', - 'description' => '', - 'type' => 'string', - 'required' => true, - 'example' => 'pairec-cn-********', + 'description' => 'The request body.', + 'type' => 'object', + 'properties' => [ + 'FeatureConsistencyCheckJobConfigId' => ['description' => 'The feature consistency check job configuration ID. To obtain this ID, see [ListFeatureConsistencyCheckJobConfigs](~~2557567~~).', 'type' => 'string', 'required' => true, 'example' => '3', 'title' => ''], + 'InstanceId' => ['description' => 'The instance ID. To obtain this ID, see [ListInstances](~~2411819~~).', 'type' => 'string', 'required' => true, 'example' => 'pairec-cn-********', 'title' => ''], + 'LogUserId' => ['description' => 'The user ID from the log.', 'type' => 'string', 'required' => true, 'example' => '1010', 'title' => ''], + 'LogItemId' => ['description' => 'The item ID from the log.', 'type' => 'string', 'required' => true, 'example' => '9010', 'title' => ''], + 'LogRequestId' => ['description' => 'The request ID from the log.', 'type' => 'string', 'required' => true, 'example' => '728C5E01-ABF6-5AA8-B9FC-B3BA05DECC77', 'title' => ''], + 'SceneName' => ['description' => 'The scene name.', 'type' => 'string', 'required' => true, 'example' => 'video-feed', 'title' => ''], + 'LogRequestTime' => ['description' => 'The request time from the log, provided as a UNIX epoch timestamp.', 'type' => 'integer', 'format' => 'int64', 'required' => true, 'example' => '1693900981465', 'title' => ''], + 'GeneratedFeatures' => ['description' => 'The generated features.', 'type' => 'string', 'required' => true, 'example' => 'week_day:1 | userid:3 | itemid:9001 | cate:cat1 | click_5_seq__cate:cat1', 'title' => ''], + 'ContextFeatures' => ['description' => 'The context features.', 'type' => 'string', 'required' => true, 'title' => '', 'example' => '[{\\"Value\\":{\\"FloatFeature\\":0.1}}]'], + 'RawFeatures' => ['description' => 'The raw features.', 'type' => 'string', 'required' => true, 'title' => '', 'example' => 'author__kv_city_expr_cnt_15d：北京市 | tem__min_age_15d:28'], + ], + 'required' => false, + 'title' => '', + 'example' => '', ], ], - [ - 'name' => 'PageNumber', - 'in' => 'query', + ], + 'responses' => [ + 200 => [ 'schema' => [ - 'title' => '页码。', - 'description' => '', - 'type' => 'string', - 'required' => false, - 'example' => '1', + 'title' => 'Schema of Response', + 'description' => 'The response object.', + 'type' => 'object', + 'properties' => [ + 'RequestId' => ['title' => 'Id of the request', 'description' => 'The ID of the request.', 'type' => 'string', 'example' => 'C7D0B48F-0105-52B9-B60A-FA7606E2234D'], + ], + 'example' => '', ], ], + ], + 'staticInfo' => ['returnType' => 'synchronous'], + 'title' => 'Replay logs for the synchronous feature consistency check job.', + 'summary' => 'Syncs the replay log for a feature consistency check job.', + 'changeSet' => [], + 'flowControl' => [ + 'flowControlList' => [ + ['threshold' => '50', 'countWindow' => 1, 'regionId' => '*', 'api' => 'SyncFeatureConsistencyCheckJobReplayLog'], + ], + ], + 'ramActions' => [ [ - 'name' => 'PageSize', - 'in' => 'query', - 'schema' => [ - 'title' => '页大小。', - 'description' => '', - 'type' => 'string', - 'required' => false, - 'example' => '10', + 'operationType' => 'none', + 'ramAction' => [ + 'action' => 'pairec:SyncFeatureConsistencyCheckJobReplayLog', + 'authLevel' => 'operate', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'PAIRecService', 'resourceType' => 'All Resource', 'arn' => '*'], + ], ], ], + ], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"C7D0B48F-0105-52B9-B60A-FA7606E2234D\\"\\n}","type":"json"}]', + ], + 'TerminateFeatureConsistencyCheckJob' => [ + 'summary' => 'Terminates a feature consistency check job.', + 'path' => '/api/v1/featureconsistencycheck/jobs/{FeatureConsistencyCheckJobId}/action/terminate', + 'methods' => ['post'], + 'schemes' => ['http', 'https'], + 'security' => [ [ - 'name' => 'SortBy', - 'in' => 'query', - 'schema' => [ - 'title' => '排序依据。'."\n" - .'● GmtCreateTime-创建时间。'."\n" - .'● GmtModifiedTime-更新时间。', - 'description' => '', - 'type' => 'string', - 'required' => false, - 'example' => 'GmtCreateTime', - ], + 'AK' => [], ], + ], + 'consumes' => ['application/json'], + 'produces' => ['application/json'], + 'operationType' => 'readAndWrite', + 'deprecated' => false, + 'systemTags' => [ + 'operationType' => 'none', + 'riskType' => 'none', + 'chargeType' => 'free', + 'abilityTreeNodes' => ['FEATURElearnN0NAWV'], + ], + 'parameters' => [ [ - 'name' => 'Order', - 'in' => 'query', - 'schema' => [ - 'title' => '排序方式。'."\n" - .'● ASC-升序。'."\n" - .'● DESC-降序。', - 'description' => '', - 'type' => 'string', - 'required' => false, - 'example' => 'ASC', - ], + 'name' => 'FeatureConsistencyCheckJobId', + 'in' => 'path', + 'schema' => ['description' => 'The ID of the feature consistency check job. You can get this ID by calling the [ListFeatureConsistencyCheckJobs](~~2557571~~) operation.', 'type' => 'string', 'required' => true, 'example' => '3', 'title' => ''], ], [ - 'name' => 'Status', - 'in' => 'query', + 'name' => 'body', + 'in' => 'body', + 'style' => 'json', 'schema' => [ - 'title' => '任务状态。'."\n" - .'● ToRun-待运行。'."\n" - .'● Running-运行中。'."\n" - .'● Success-成功。'."\n" - .'● Failure-失败。'."\n" - .'● Stopped-停止/已取消。', - 'description' => '', - 'type' => 'string', + 'description' => 'The request body.', + 'type' => 'object', + 'properties' => [ + 'InstanceId' => ['description' => 'The instance ID. You can get this ID by calling the [ListInstances](~~2411819~~) operation.', 'type' => 'string', 'required' => true, 'example' => 'pairec-cn-********', 'title' => ''], + ], 'required' => false, - 'example' => 'Running', + 'title' => '', + 'example' => '', ], ], ], @@ -15492,599 +15582,484 @@ 200 => [ 'schema' => [ 'title' => 'Schema of Response', - 'description' => 'Schema of Response', + 'description' => 'The response object.', 'type' => 'object', 'properties' => [ - 'RequestId' => [ - 'title' => 'Id of the request', - 'description' => '', - 'type' => 'string', - 'example' => 'A04CB8C0-E74A-5E83-BC61-64D153574EC7', - ], - 'TotalCount' => [ - 'title' => '总个数。', - 'description' => '', - 'type' => 'string', - 'example' => '10', - ], - 'FeatureConsistencyCheckJobs' => [ - 'title' => '特征一致性检查任务列表。', - 'description' => '', - 'type' => 'array', - 'items' => [ - 'type' => 'object', - 'properties' => [ - 'FeatureConsistencyCheckJobId' => [ - 'title' => '特征一致性检查任务ID。', - 'description' => '', - 'type' => 'string', - 'example' => '4', - ], - 'FeatureConsistencyCheckJobConfigId' => [ - 'title' => '特征一致性检查配置ID。', - 'description' => '', - 'type' => 'string', - 'example' => '5', - ], - 'FeatureConsistencyCheckJobConfigName' => [ - 'title' => '特征一致性检查任务配置名称。', - 'description' => '', - 'type' => 'string', - 'example' => 'feature_consistency_check_1', - ], - 'GmtStartTime' => [ - 'title' => '开始时间。', - 'description' => '', - 'type' => 'string', - 'example' => '2021-12-15T23:24:33.132+08:00', - ], - 'GmtEndTime' => [ - 'title' => '结束时间。', - 'description' => '', - 'type' => 'string', - 'example' => '2021-12-15T23:24:33.132+08:00', - ], - 'Status' => [ - 'title' => '任务状态。'."\n" - .'● ToRun-待运行。'."\n" - .'● Running-运行中。'."\n" - .'● Success-成功。'."\n" - .'● Failure-失败。'."\n" - .'● Terminated-停止/已取消。', - 'description' => '', - 'type' => 'string', - 'example' => 'Running', - ], - 'Config' => [ - 'title' => '配置信息。', - 'description' => '', - 'type' => 'string', - 'example' => '{}', - ], - 'Logs' => [ - 'title' => '日志信息。', - 'description' => '', - 'type' => 'array', - 'items' => [ - 'description' => '', - 'type' => 'string', - 'example' => '2022/09/26 02:16:24 INFO: job status: Created', - ], - ], - ], - ], - ], + 'RequestId' => ['title' => 'Id of the request', 'description' => 'The unique ID generated for the request.', 'type' => 'string', 'example' => 'A6C01890-54CA-5C49-BC91-AD85A98E4A98'], ], + 'example' => '', ], ], ], - 'staticInfo' => [ - 'returnType' => 'synchronous', + 'staticInfo' => ['returnType' => 'synchronous'], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"A6C01890-54CA-5C49-BC91-AD85A98E4A98\\"\\n}","type":"json"}]', + 'title' => 'Cancel the running job for the specified feature consistency check', + 'changeSet' => [], + 'flowControl' => [ + 'flowControlList' => [], + ], + 'ramActions' => [ + [ + 'operationType' => 'none', + 'ramAction' => [ + 'action' => 'pairec:TerminateFeatureConsistencyCheckJob', + 'authLevel' => 'operate', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'PAIRecService', 'resourceType' => 'All Resource', 'arn' => '*'], + ], + ], + ], ], - 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"A04CB8C0-E74A-5E83-BC61-64D153574EC7\\",\\n \\"TotalCount\\": \\"10\\",\\n \\"FeatureConsistencyCheckJobs\\": [\\n {\\n \\"FeatureConsistencyCheckJobId\\": \\"4\\",\\n \\"FeatureConsistencyCheckJobConfigId\\": \\"5\\",\\n \\"FeatureConsistencyCheckJobConfigName\\": \\"feature_consistency_check_1\\",\\n \\"GmtStartTime\\": \\"2021-12-15T23:24:33.132+08:00\\",\\n \\"GmtEndTime\\": \\"2021-12-15T23:24:33.132+08:00\\",\\n \\"Status\\": \\"Running\\",\\n \\"Config\\": \\"{}\\",\\n \\"Logs\\": [\\n \\"2022/09/26 02:16:24 INFO: job status: Created\\"\\n ]\\n }\\n ]\\n}","type":"json"}]', ], - 'GetFeatureConsistencyCheckJob' => [ - 'summary' => '获取特征一致性检查任务详细信息。', - 'path' => '/api/v1/featureconsistencycheck/jobs/{FeatureConsistencyCheckJobId}', - 'methods' => [ - 'get', - ], - 'schemes' => [ - 'http', - 'https', - ], + 'UpdateABMetric' => [ + 'summary' => 'Modifies the metric configuration of an existing ABTest experiment.', + 'path' => '/api/v1/abmetrics/{ABMetricId}', + 'methods' => ['put'], + 'schemes' => ['http', 'https'], 'security' => [ [ 'AK' => [], ], ], - 'consumes' => [ - 'application/json', - ], - 'produces' => [ - 'application/json', - ], - 'operationType' => 'read', + 'consumes' => ['application/json'], + 'produces' => ['application/json'], + 'operationType' => 'readAndWrite', 'deprecated' => false, 'systemTags' => [ - 'operationType' => 'get', + 'operationType' => 'update', 'riskType' => 'none', 'chargeType' => 'free', - 'abilityTreeNodes' => [ - 'FEATURElearnN0NAWV', - ], + 'abilityTreeNodes' => ['FEATURElearnN0NAWV'], ], 'parameters' => [ [ - 'name' => 'FeatureConsistencyCheckJobId', + 'name' => 'ABMetricId', 'in' => 'path', - 'schema' => [ - 'title' => '特征一致性检查任务ID。', - 'description' => '', - 'type' => 'string', - 'required' => false, - 'example' => '4', - ], + 'schema' => ['description' => 'The ABTest metric ID.', 'type' => 'string', 'required' => true, 'example' => '1', 'title' => ''], ], [ - 'name' => 'InstanceId', - 'in' => 'query', + 'name' => 'body', + 'in' => 'body', + 'style' => 'json', 'schema' => [ - 'title' => '实例ID。', - 'description' => '', - 'type' => 'string', + 'description' => 'The request body parameters.', + 'type' => 'object', + 'properties' => [ + 'Name' => ['description' => 'The metric name.', 'type' => 'string', 'required' => true, 'example' => 'pv', 'title' => ''], + 'Description' => ['description' => 'The metric description.', 'type' => 'string', 'required' => true, 'example' => 'pv 指标', 'title' => ''], + 'SceneId' => ['description' => 'The scene ID. You can obtain it by calling the [ListScenes](~~2402581~~) operation.', 'type' => 'string', 'required' => true, 'example' => '1', 'title' => ''], + 'Type' => ['description' => 'The metric type. Valid values:'."\n" + ."\n" + .'- Single: single metric.'."\n" + ."\n" + .'- Derived: derived metric.', 'type' => 'string', 'required' => true, 'example' => 'Single', 'title' => ''], + 'Realtime' => ['description' => 'Specifies whether the metric is a real-time metric. Valid values:'."\n" + ."\n" + .'- true'."\n" + ."\n" + .'- false', 'type' => 'boolean', 'required' => true, 'example' => 'false', 'title' => ''], + 'TableMetaId' => ['description' => 'The data table ID. You can obtain it by calling the ListTableMetas operation.', 'type' => 'string', 'required' => true, 'example' => '2', 'title' => ''], + 'ResultResourceId' => ['description' => 'The ID of the data source for the write-back data table. You can obtain it by calling the ListInstanceResources operation.', 'type' => 'string', 'required' => false, 'example' => '3', 'title' => ''], + 'Definition' => ['description' => 'The metric definition.', 'type' => 'string', 'required' => true, 'example' => 'sum(click_cnt)', 'title' => ''], + 'StatisticsCycle' => ['description' => 'The statistical period.', 'type' => 'integer', 'format' => 'int32', 'required' => false, 'example' => '1', 'title' => ''], + 'LeftMetricId' => ['description' => 'The left metric ID of the derived metric.', 'type' => 'string', 'required' => false, 'example' => '2', 'title' => ''], + 'RightMetricId' => ['description' => 'The right metric ID of the derived metric.', 'type' => 'string', 'required' => false, 'example' => '3', 'title' => ''], + 'Operator' => ['description' => 'The operator for derived metric calculation. Valid values:'."\n" + ."\n" + .'- Plus: addition'."\n" + ."\n" + .'- Minus: subtraction'."\n" + ."\n" + .'- Multiplication: multiplication'."\n" + ."\n" + .'- Division: division', 'type' => 'string', 'required' => false, 'example' => 'Division', 'title' => ''], + 'InstanceId' => ['description' => 'The instance ID. You can obtain it by calling the [ListInstances](~~2411819~~) operation.', 'type' => 'string', 'required' => true, 'example' => 'pairec-cn-test123', 'title' => ''], + 'NeedSignificance' => ['title' => '', 'description' => 'Specifies whether to calculate significance.', 'type' => 'boolean', 'required' => false, 'example' => 'True'], + 'AggregationByUser' => ['title' => '', 'description' => 'Specifies whether to aggregate by user dimension when calculating significance. Two aggregation methods are supported: by user and by sample.', 'type' => 'boolean', 'required' => false, 'example' => 'True'], + 'Numerator' => ['title' => '', 'description' => 'The numerator used in significance calculation.', 'type' => 'string', 'example' => 'click', 'required' => false], + 'Denominator' => ['title' => '', 'description' => 'The denominator used in significance calculation.', 'type' => 'string', 'example' => 'pv', 'required' => false], + 'IsBinomialDistribution' => ['title' => '', 'description' => 'Specifies whether the current metric follows a binomial distribution when the metric type is a derived metric. If set to true, the mean and variance of the metric are calculated based on the binomial distribution.', 'type' => 'boolean', 'required' => false, 'example' => 'False'], + ], 'required' => false, - 'example' => 'pairec-cn-********', + 'title' => '', + 'example' => '', ], ], ], 'responses' => [ 200 => [ 'schema' => [ - 'title' => 'Schema of Response', + 'title' => '', 'description' => 'Schema of Response', 'type' => 'object', 'properties' => [ - 'RequestId' => [ - 'title' => 'Id of the request', - 'description' => '', - 'type' => 'string', - 'example' => 'A04CB8C0-E74A-5E83-BC61-64D153574EC7', - ], - 'FeatureConsistencyCheckJobConfigId' => [ - 'title' => '特征一致性检查配置ID。', - 'description' => '', - 'type' => 'string', - 'example' => '5', - ], - 'FeatureConsistencyCheckJobConfigName' => [ - 'title' => '特征一致性检查任务配置名称。', - 'description' => '', - 'type' => 'string', - 'example' => 'feature_consistency_check_1', - ], - 'GmtStartTime' => [ - 'title' => '开始时间。', - 'description' => '', - 'type' => 'string', - 'example' => '2021-12-15T23:24:33.132+08:00', - ], - 'GmtEndTime' => [ - 'title' => '结束时间。', - 'description' => '', - 'type' => 'string', - 'example' => '2021-12-15T23:24:33.132+08:00', - ], - 'Status' => [ - 'title' => '任务状态。'."\n" - .'● ToRun-待运行。'."\n" - .'● Running-运行中。'."\n" - .'● Success-成功。'."\n" - .'● Failure-失败。'."\n" - .'● Terminated-停止/已取消。', - 'description' => '', - 'type' => 'string', - 'example' => 'Running', - ], - 'Config' => [ - 'title' => '配置信息。', - 'description' => '', - 'type' => 'string', - 'example' => '{}', - ], - 'Logs' => [ - 'title' => '日志信息。', - 'description' => '', - 'type' => 'array', - 'items' => [ - 'description' => '', - 'type' => 'string', - 'example' => '2023-02-21 14:28:04 INFO: epoch [1][745/127291]tlr: 2.925e-05, eta: 2 days, 2:11:04, iter_time: 1.682, data_load_time: 0.997, memory: 12898, loss: 1.3768', - ], - ], + 'RequestId' => ['title' => '', 'description' => 'The request ID.', 'type' => 'string', 'example' => '6CF1E160-3F36-5E73-A170-C75504F05BBC'], ], + 'example' => '', ], ], ], - 'staticInfo' => [ - 'returnType' => 'synchronous', + 'staticInfo' => ['returnType' => 'synchronous'], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"6CF1E160-3F36-5E73-A170-C75504F05BBC\\"\\n}","type":"json"}]', + 'title' => 'Update aBTest metric', + 'description' => '## Operation description'."\n" + .'This API operation allows you to update the attributes of a specified ABTest metric, including whether to calculate significance and the aggregation method. Make sure that you have obtained the correct `ABMetricId` before calling this operation.'."\n" + ."\n" + .'- `NeedSignificance`: Specifies whether to perform significance analysis on the current metric. Default value: `false`.'."\n" + .'- `AggregationByUser`: When significance calculation is enabled, specifies whether to aggregate data by user or by sample. Default value: `false` (by sample).'."\n" + .'- `Numerator` and `Denominator`: The specific definitions of the numerator and denominator used in significance calculation.'."\n" + .'- `IsBinomialDistribution`: Valid only for derived metrics. Specifies whether the metric follows a binomial distribution, which affects subsequent data processing logic.'."\n" + ."\n" + .'Note: You do not need to provide all fields at the same time. Include only the parameters whose values you want to change in the request body.', + 'changeSet' => [ + ['createdAt' => '2024-02-22T03:35:42.000Z', 'description' => 'Request parameters changed'], + ], + 'flowControl' => [ + 'flowControlList' => [], + ], + 'ramActions' => [ + [ + 'operationType' => 'update', + 'ramAction' => [ + 'action' => 'pairec:UpdateABMetric', + 'authLevel' => 'operate', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'PAIRecService', 'resourceType' => 'All Resource', 'arn' => '*'], + ], + ], + ], ], - 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"A04CB8C0-E74A-5E83-BC61-64D153574EC7\\",\\n \\"FeatureConsistencyCheckJobConfigId\\": \\"5\\",\\n \\"FeatureConsistencyCheckJobConfigName\\": \\"feature_consistency_check_1\\",\\n \\"GmtStartTime\\": \\"2021-12-15T23:24:33.132+08:00\\",\\n \\"GmtEndTime\\": \\"2021-12-15T23:24:33.132+08:00\\",\\n \\"Status\\": \\"Running\\",\\n \\"Config\\": \\"{}\\",\\n \\"Logs\\": [\\n \\"2023-02-21 14:28:04 INFO: epoch [1][745/127291]tlr: 2.925e-05, eta: 2 days, 2:11:04, iter_time: 1.682, data_load_time: 0.997, memory: 12898, loss: 1.3768\\"\\n ]\\n}","type":"json"}]', ], - 'ListFeatureConsistencyCheckJobFeatureReports' => [ - 'summary' => '获取特征一致性检查任务的特征报表/比对结果。', - 'path' => '/api/v1/featureconsistencycheck/jobs/{FeatureConsistencyCheckJobId}/featurereports', - 'methods' => [ - 'get', - ], - 'schemes' => [ - 'http', - 'https', - ], + 'UpdateABMetricGroup' => [ + 'summary' => 'Updates an A/B test metric group.', + 'path' => '/api/v1/abmetricgroups/{ABMetricGroupId}', + 'methods' => ['put'], + 'schemes' => ['http', 'https'], 'security' => [ [ 'AK' => [], ], ], - 'consumes' => [ - 'application/json', - ], - 'produces' => [ - 'application/json', - ], - 'operationType' => 'read', + 'consumes' => ['application/json'], + 'produces' => ['application/json'], + 'operationType' => 'readAndWrite', 'deprecated' => false, 'systemTags' => [ - 'operationType' => 'list', + 'operationType' => 'update', 'riskType' => 'none', 'chargeType' => 'free', - 'abilityTreeNodes' => [ - 'FEATURElearnN0NAWV', - ], + 'abilityTreeNodes' => ['FEATURElearnN0NAWV'], ], 'parameters' => [ [ - 'name' => 'FeatureConsistencyCheckJobId', - 'in' => 'path', + 'name' => 'body', + 'in' => 'body', + 'style' => 'json', 'schema' => [ - 'title' => '特征一致性检查任务ID。', - 'description' => '', - 'type' => 'string', - 'required' => true, - 'example' => '3', + 'description' => 'The request body.', + 'type' => 'object', + 'properties' => [ + 'Name' => ['description' => 'The metric group name.', 'type' => 'string', 'required' => true, 'example' => 'visits', 'title' => ''], + 'SceneId' => ['description' => 'The scene ID. You can obtain this ID by calling the [ListScenes](~~2402581~~) operation.', 'type' => 'string', 'required' => true, 'example' => '1', 'title' => ''], + 'Description' => ['description' => 'The metric group description.', 'type' => 'string', 'required' => true, 'example' => '访问量相关指标', 'title' => ''], + 'ABMetricIds' => ['description' => 'A comma-separated list of A/B test metric IDs.', 'type' => 'string', 'required' => true, 'example' => '1,2', 'title' => ''], + 'InstanceId' => ['description' => 'The instance ID. You can obtain this ID by calling the [ListInstances](~~2411819~~) operation.', 'type' => 'string', 'required' => true, 'example' => 'pairec-cn-test1', 'title' => ''], + 'Realtime' => ['description' => 'Whether the metric group is a real-time metric group.', 'type' => 'boolean', 'required' => true, 'example' => 'false', 'title' => ''], + ], + 'required' => false, + 'title' => '', + 'example' => '', ], ], [ - 'name' => 'InstanceId', - 'in' => 'query', + 'name' => 'ABMetricGroupId', + 'in' => 'path', + 'schema' => ['description' => 'The A/B test metric group ID.', 'type' => 'string', 'required' => true, 'example' => '1', 'title' => ''], + ], + ], + 'responses' => [ + 200 => [ 'schema' => [ - 'title' => '实例ID。', - 'description' => '', - 'type' => 'string', - 'required' => true, - 'example' => 'pairec-cn-********', + 'title' => 'Schema of Response', + 'description' => 'The response object.', + 'type' => 'object', + 'properties' => [ + 'RequestId' => ['title' => 'Id of the request', 'description' => 'The request ID.', 'type' => 'string', 'example' => '74D958EF-3598-56FA-8296-FF1575CE43DF'], + ], + 'example' => '', ], ], - [ - 'name' => 'LogUserId', - 'in' => 'query', - 'schema' => [ - 'title' => '特征比对时的UserId。', - 'description' => '', - 'type' => 'string', - 'required' => true, - 'example' => '1010', + ], + 'staticInfo' => ['returnType' => 'synchronous'], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"74D958EF-3598-56FA-8296-FF1575CE43DF\\"\\n}","type":"json"}]', + 'title' => 'Update Metric Group', + 'changeSet' => [ + ['createdAt' => '2024-02-22T03:35:41.000Z', 'description' => 'Request parameters changed'], + ], + 'flowControl' => [ + 'flowControlList' => [], + ], + 'ramActions' => [ + [ + 'operationType' => 'update', + 'ramAction' => [ + 'action' => 'pairec:UpdateABMetricGroup', + 'authLevel' => 'operate', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'PAIRecService', 'resourceType' => 'All Resource', 'arn' => '*'], + ], ], ], + ], + ], + 'UpdateCrowd' => [ + 'summary' => 'Updates a crowd\'s information, such as its name and description.', + 'path' => '/api/v1/crowds/{CrowdId}', + 'methods' => ['put'], + 'schemes' => ['http', 'https'], + 'security' => [ [ - 'name' => 'LogItemId', - 'in' => 'query', - 'schema' => [ - 'title' => '特征比对时的ItemId。', - 'description' => '', - 'type' => 'string', - 'required' => true, - 'example' => '9010', - ], + 'AK' => [], ], + ], + 'consumes' => ['application/json'], + 'produces' => ['application/json'], + 'operationType' => 'readAndWrite', + 'deprecated' => false, + 'systemTags' => [ + 'operationType' => 'update', + 'riskType' => 'none', + 'chargeType' => 'free', + 'abilityTreeNodes' => ['FEATURElearnN0NAWV'], + ], + 'parameters' => [ [ - 'name' => 'LogRequestId', - 'in' => 'query', + 'name' => 'body', + 'in' => 'body', + 'style' => 'json', 'schema' => [ - 'title' => '特征比对时的RequestId。', - 'description' => '', - 'type' => 'string', - 'required' => true, - 'example' => 'F7AC05FF-EDE7-5C2B-B9AE-33D6DF4178BA', + 'description' => 'The request body.', + 'type' => 'object', + 'properties' => [ + 'Name' => ['description' => 'The crowd name.', 'type' => 'string', 'required' => true, 'example' => 'xx人群', 'title' => ''], + 'Description' => ['description' => 'The crowd description.', 'type' => 'string', 'required' => true, 'example' => 'This is a test.', 'title' => ''], + 'InstanceId' => ['description' => 'The instance ID. To obtain this ID, call the ListInstances operation.', 'type' => 'string', 'required' => true, 'example' => 'pairec-test1', 'title' => ''], + ], + 'required' => false, + 'title' => '', + 'example' => '', ], ], + [ + 'name' => 'CrowdId', + 'in' => 'path', + 'schema' => ['description' => 'The crowd ID. To obtain this ID, call the ListCrowds operation.', 'type' => 'string', 'required' => true, 'example' => '3', 'title' => ''], + ], ], 'responses' => [ 200 => [ 'schema' => [ 'title' => 'Schema of Response', - 'description' => 'Schema of Response', + 'description' => 'The response object.', 'type' => 'object', 'properties' => [ - 'RequestId' => [ - 'title' => 'Id of the request', - 'description' => '', - 'type' => 'string', - 'example' => 'BBD41FBF-E75C-551A-92FA-CAD654AA006F', - ], - 'ReportsOfFeatureDiff' => [ - 'title' => '特征比对报表。', - 'description' => '', - 'type' => 'array', - 'items' => [ - 'title' => '', - 'description' => '', - 'type' => 'object', - 'properties' => [ - 'LogUserId' => [ - 'title' => '用户ID。', - 'description' => '', - 'type' => 'string', - 'example' => '1010', - ], - 'LogItemId' => [ - 'title' => '物品ID。', - 'description' => '', - 'type' => 'string', - 'example' => '9010', - ], - 'LogRequestId' => [ - 'title' => '请求ID。', - 'description' => '', - 'type' => 'string', - 'example' => 'F7AC05FF-EDE7-5C2B-B9AE-33D6DF4178BA', - ], - 'FeatureName' => [ - 'title' => '特征名称。', - 'description' => '', - 'type' => 'string', - 'example' => 'gender', - ], - 'OfflineValue' => [ - 'title' => '离线值。', - 'description' => '', - 'type' => 'string', - 'example' => 'male', - ], - 'OnlineValue' => [ - 'title' => '在线值。', - 'description' => '', - 'type' => 'string', - 'example' => 'male', - ], - ], - ], - ], - 'DataPath' => [ - 'description' => '', - 'type' => 'string', - 'example' => 'https://********', - ], - 'OssPath' => [ - 'description' => '', - 'type' => 'string', - 'example' => 'oss://********', - ], + 'RequestId' => ['title' => 'Id of the request', 'description' => 'The request ID.', 'type' => 'string', 'example' => '8C27790E-CCA5-56BB-BA17-646295DEC0A2'], ], + 'example' => '', ], ], ], - 'staticInfo' => [ - 'returnType' => 'synchronous', + 'staticInfo' => ['returnType' => 'synchronous'], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"8C27790E-CCA5-56BB-BA17-646295DEC0A2\\"\\n}","type":"json"}]', + 'title' => 'Update Audience', + 'changeSet' => [], + 'flowControl' => [ + 'flowControlList' => [], + ], + 'ramActions' => [ + [ + 'operationType' => 'update', + 'ramAction' => [ + 'action' => 'pairec:UpdateCrowd', + 'authLevel' => 'operate', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'PAIRecService', 'resourceType' => 'All Resource', 'arn' => '*'], + ], + ], + ], ], - 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"BBD41FBF-E75C-551A-92FA-CAD654AA006F\\",\\n \\"ReportsOfFeatureDiff\\": [\\n {\\n \\"LogUserId\\": \\"1010\\",\\n \\"LogItemId\\": \\"9010\\",\\n \\"LogRequestId\\": \\"F7AC05FF-EDE7-5C2B-B9AE-33D6DF4178BA\\",\\n \\"FeatureName\\": \\"gender\\",\\n \\"OfflineValue\\": \\"male\\",\\n \\"OnlineValue\\": \\"male\\"\\n }\\n ],\\n \\"DataPath\\": \\"https://********\\",\\n \\"OssPath\\": \\"oss://********\\"\\n}","type":"json"}]', ], - 'ListFeatureConsistencyCheckJobScoreReports' => [ - 'summary' => '获取特征一致性检查任务分数报表/比对结果。', - 'path' => '/api/v1/featureconsistencycheck/jobs/{FeatureConsistencyCheckJobId}/scorereports', - 'methods' => [ - 'get', - ], - 'schemes' => [ - 'http', - 'https', - ], + 'UpdateDataDiagnosis' => [ + 'path' => '/api/v1/datadiagnoses/{DataDiagnosisId}', + 'methods' => ['put'], + 'schemes' => ['http', 'https'], 'security' => [ [ 'AK' => [], ], ], - 'consumes' => [ - 'application/json', - ], - 'produces' => [ - 'application/json', - ], - 'operationType' => 'read', + 'consumes' => ['application/json'], + 'produces' => ['application/json'], + 'operationType' => 'readAndWrite', 'deprecated' => false, 'systemTags' => [ - 'operationType' => 'list', + 'operationType' => 'update', 'riskType' => 'none', 'chargeType' => 'free', - 'abilityTreeNodes' => [ - 'FEATURElearnN0NAWV', - ], + 'abilityTreeNodes' => ['FEATURElearnN0NAWV'], ], 'parameters' => [ [ - 'name' => 'FeatureConsistencyCheckJobId', + 'name' => 'DataDiagnosisId', 'in' => 'path', - 'schema' => [ - 'title' => '特征一致性检查任务报表ID。', - 'description' => '', - 'type' => 'string', - 'required' => true, - 'example' => '3', - ], + 'schema' => ['description' => 'The ID of the data diagnosis task.', 'type' => 'string', 'required' => true, 'example' => '3', 'title' => ''], ], [ - 'name' => 'InstanceId', - 'in' => 'query', - 'schema' => [ - 'title' => '实例ID。', - 'description' => '', - 'type' => 'string', - 'required' => false, - 'example' => 'pairec-cn-********', - ], - ], - [ - 'name' => 'ExcludeRequestIds', - 'in' => 'query', + 'name' => 'body', + 'in' => 'body', 'style' => 'json', 'schema' => [ - 'title' => '特征比对时排除的RequestId。', - 'description' => '', - 'type' => 'array', - 'items' => [ - 'description' => '', - 'type' => 'string', - 'required' => false, - 'example' => '728C5E01-ABF6-5AA8-B9FC-B3BA05DECC77', + 'description' => 'The request body.', + 'type' => 'object', + 'properties' => [ + 'InstanceId' => ['description' => 'The instance ID.', 'type' => 'string', 'required' => true, 'example' => 'learn-pairec-xxx', 'title' => ''], + 'Name' => ['description' => 'The name of the data diagnosis task.', 'type' => 'string', 'required' => true, 'example' => 'data_diagnosis_job1', 'title' => ''], + 'Type' => ['description' => 'The type of the data diagnosis task. Valid values:'."\n" + ."\n" + .'- `ChangeRate`: item/user change rate analysis.'."\n" + ."\n" + .'- `PreferenceStatisticsCycle`: user preference statistics cycle analysis.'."\n" + ."\n" + .'- `JoinTables`: two-table join analysis.'."\n" + ."\n" + .'- `BaseStatistics`: basic statistical analysis.'."\n" + ."\n" + .'- `AbnormalBehavior`: abnormal behavior analysis.', 'type' => 'string', 'required' => true, 'example' => 'ChangeRate', 'title' => ''], + 'TableMetaId' => ['description' => 'The ID of the data table.', 'type' => 'string', 'required' => false, 'example' => '3', 'title' => ''], + 'LeftTableMetaId' => ['description' => 'The ID of the left data table.', 'type' => 'string', 'required' => false, 'example' => '4', 'title' => ''], + 'RightTableMetaId' => ['description' => 'The ID of the right data table.', 'type' => 'string', 'required' => false, 'example' => '5', 'title' => ''], + 'PartitionField' => ['description' => 'The partition field.', 'type' => 'string', 'required' => false, 'example' => 'dt', 'title' => ''], + 'LeftTablePartitionField' => ['description' => 'The partition field of the left table.', 'type' => 'string', 'required' => false, 'example' => 'dt', 'title' => ''], + 'RightTablePartitionField' => ['description' => 'The partition field of the right table.', 'type' => 'string', 'required' => false, 'example' => 'dt', 'title' => ''], + 'Config' => ['description' => 'The configuration of the data diagnosis task, provided as a JSON string. The required fields vary based on the `Type` parameter. For `ChangeRate`, specify `AnalysisField` and `PartitionFieldFormat`. For `PreferenceStatisticsCycle`, specify `UserIdField`, `RemainDays`, `EverAppearedDays`, `RemainRatePeriods`, and `PartitionFieldFormat`. For `JoinTables`, specify `LeftTableAnalysisField`, `RightTableAnalysisField`, `LeftJoinField`, `RightJoinField`, `SampleQuantity`, `LeftTablePartitionFieldFormat`, and `RightTablePartitionFieldFormat`. For `BaseStatistics`, specify `TagField`, `TagFieldSeparator`, `KVField`, `KVFieldSeparator`, `KVPairSeparator`, `TextField`, `Quantiles`, `DefaultValueOfString`, `NullStringField`, and `PartitionFieldFormat`. For `AbnormalBehavior`, specify `UserId`, `ItemId`, `EventField`, `UpStreamBehavior`, `DownstreamBehavior`, `NumericHistogramBins`, and `PartitionFieldFormat`.', 'type' => 'string', 'required' => true, 'example' => '{"AnalysisField":"userid","PartitionFieldFormat":"yyyymmdd"}', 'title' => ''], + 'CycleTime' => ['description' => 'The execution time for periodic runs. If this field is omitted, the task does not run periodically.', 'type' => 'string', 'required' => false, 'example' => '08:00', 'title' => ''], + 'TopNQuantity' => ['description' => 'The number of top-ranked results to return.', 'type' => 'integer', 'format' => 'int64', 'required' => false, 'example' => '10', 'title' => ''], ], 'required' => false, + 'title' => '', + 'example' => '', ], ], ], 'responses' => [ 200 => [ 'schema' => [ - 'title' => 'Schema of Response', 'description' => 'Schema of Response', + 'title' => 'Schema of Response ', 'type' => 'object', 'properties' => [ - 'RequestId' => [ - 'title' => 'Id of the request', - 'description' => '', - 'type' => 'string', - 'example' => 'F0AB6527-093F-5C44-B3BD-42C8C210C619', - ], - 'ReportsOfScoreDiff' => [ - 'title' => '分数比对报表。', - 'description' => '', - 'type' => 'array', - 'items' => [ - 'type' => 'object', - 'properties' => [ - 'LogUserId' => [ - 'title' => '用户ID。', - 'description' => '', - 'type' => 'string', - 'example' => '3', - ], - 'LogItemId' => [ - 'title' => '物品ID。', - 'description' => '', - 'type' => 'string', - 'example' => '4', - ], - 'LogRequestId' => [ - 'title' => '请求ID。', - 'description' => '', - 'type' => 'string', - 'example' => '323', - ], - 'ScoreDiff' => [ - 'title' => '分数差值。', - 'description' => '', - 'type' => 'string', - 'example' => '0.00000234', - ], - 'ScoreDiffDetail' => [ - 'title' => '分数比对详细。', - 'description' => '', - 'type' => 'string', - 'example' => '{}', - ], - ], - ], - ], - 'DataPath' => [ - 'title' => '数据路径。', - 'description' => '', - 'type' => 'string', - 'example' => 'http://*******', - ], - 'OssPath' => [ - 'title' => 'oss路径。', - 'description' => '', - 'type' => 'string', - 'example' => 'oss://********', - ], + 'RequestId' => ['title' => 'Id of the request ', 'description' => 'The request ID.', 'type' => 'string', 'example' => '728C5E01-ABF6-5AA8-B9FC-B3BA05DECC77'], ], + 'example' => '', ], ], ], - 'staticInfo' => [ - 'returnType' => 'synchronous', + 'staticInfo' => ['returnType' => 'synchronous'], + 'title' => 'Update Data Diagnosis Information ', + 'summary' => 'Updates the configuration of a specified data diagnosis task.', + 'description' => '## Request'."\n" + ."\n" + .'This API updates the configuration of an existing data diagnosis task, including the instance ID, task name, task type, and specific configuration content. Provide the `DataDiagnosisId` in the request path to identify the task to update. You must also specify the `Config` parameter based on the task `Type`. For periodic runs, set the execution time in the `CycleTime` field. If a periodic run is not required, omit this field.'."\n" + ."\n" + .'## Usage notes'."\n" + ."\n" + .'- `DataDiagnosisId` is a required path parameter that uniquely identifies a data diagnosis task.'."\n" + ."\n" + .'- The structure of the `Config` field varies depending on the value of `Type`. Refer to the examples in this document for configuration details.'."\n" + ."\n" + .'- To disable periodic runs, omit the `CycleTime` field.'."\n" + ."\n" + .'- When updating a task for two-table join analysis (`JoinTables`), provide the information for the left and right tables, including `LeftTableMetaId` and `RightTableMetaId`.'."\n" + ."\n" + .'- The `InstanceId`, `Name`, and `Type` parameters are required for all types of data diagnosis tasks.', + 'changeSet' => [], + 'flowControl' => [ + 'flowControlList' => [], + ], + 'ramActions' => [ + [ + 'operationType' => 'update', + 'ramAction' => [ + 'action' => 'pairec:UpdateDataDiagnosis', + 'authLevel' => 'operate', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'PAIRecService', 'resourceType' => 'All Resource', 'arn' => '*'], + ], + ], + ], ], - 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"F0AB6527-093F-5C44-B3BD-42C8C210C619\\",\\n \\"ReportsOfScoreDiff\\": [\\n {\\n \\"LogUserId\\": \\"3\\",\\n \\"LogItemId\\": \\"4\\",\\n \\"LogRequestId\\": \\"323\\",\\n \\"ScoreDiff\\": \\"0.00000234\\",\\n \\"ScoreDiffDetail\\": \\"{}\\"\\n }\\n ],\\n \\"DataPath\\": \\"http://*******\\",\\n \\"OssPath\\": \\"oss://********\\"\\n}","type":"json"}]', + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"728C5E01-ABF6-5AA8-B9FC-B3BA05DECC77\\"\\n}","type":"json"}]', ], - 'CloneFeatureConsistencyCheckJobConfig' => [ - 'summary' => '克隆特征一致性检查配置。', - 'path' => '/api/v1/featureconsistencycheck/jobconfigs/{SourceFeatureConsistencyCheckJobConfigId}/action/clone', - 'methods' => [ - 'post', - ], - 'schemes' => [ - 'http', - 'https', - ], + 'UpdateEngineConfig' => [ + 'summary' => 'Updates an engine configuration.', + 'path' => '/api/v1/engineconfigs/{EngineConfigId}', + 'methods' => ['put'], + 'schemes' => ['http', 'https'], 'security' => [ [ 'AK' => [], ], ], - 'consumes' => [ - 'application/json', - ], - 'produces' => [ - 'application/json', - ], + 'consumes' => ['application/json'], + 'produces' => ['application/json'], 'operationType' => 'readAndWrite', 'deprecated' => false, 'systemTags' => [ - 'operationType' => 'none', + 'operationType' => 'update', 'riskType' => 'none', 'chargeType' => 'free', - 'abilityTreeNodes' => [ - 'FEATURElearnN0NAWV', - ], + 'abilityTreeCode' => '180246', + 'abilityTreeNodes' => ['FEATURElearnN0NAWV'], ], 'parameters' => [ [ - 'name' => 'SourceFeatureConsistencyCheckJobConfigId', + 'name' => 'EngineConfigId', 'in' => 'path', - 'schema' => [ - 'title' => '特征一致性检查配置ID。', - 'description' => '', - 'type' => 'string', - 'required' => true, - 'example' => '3', - ], + 'schema' => ['description' => 'The engine configuration ID.', 'type' => 'string', 'required' => false, 'example' => '3', 'title' => ''], ], [ 'name' => 'body', 'in' => 'body', 'style' => 'json', 'schema' => [ - 'description' => '', + 'description' => 'The request body.', 'type' => 'object', 'properties' => [ - 'InstanceId' => [ - 'title' => '实例ID。', - 'description' => '', - 'type' => 'string', - 'required' => true, - 'example' => 'pairec-cn-********', - ], + 'Name' => ['description' => 'The name of the engine configuration.', 'type' => 'string', 'required' => false, 'example' => 'engine_config_v1', 'title' => ''], + 'ConfigValue' => ['description' => 'The content of the engine configuration.', 'type' => 'string', 'required' => false, 'example' => '{'."\n" + .' "ListenConf": {'."\n" + .' "HttpAddr": "",'."\n" + .' "HttpPort": 8000'."\n" + .' }'."\n" + .'}', 'title' => ''], + 'Environment' => ['description' => 'The environment.'."\n" + ."\n" + .'- Daily: Daily environment.'."\n" + ."\n" + .'- Pre: Pre-production environment.'."\n" + ."\n" + .'- Prod: Production environment.', 'type' => 'string', 'required' => false, 'example' => 'Pre', 'title' => ''], + 'InstanceId' => ['description' => 'The instance ID. To get the instance ID, see [ListInstances](~~2411819~~).', 'type' => 'string', 'required' => false, 'example' => 'pairec-cn-***test', 'title' => ''], + 'Description' => ['type' => 'string', 'description' => '', 'required' => false, 'title' => '', 'example' => ''], ], 'required' => false, + 'title' => '', + 'example' => '', ], ], ], @@ -16092,231 +16067,183 @@ 200 => [ 'schema' => [ 'title' => 'Schema of Response', - 'description' => 'Schema of Response', + 'description' => 'The response schema.', 'type' => 'object', 'properties' => [ - 'RequestId' => [ - 'title' => 'Id of the request', - 'description' => '', - 'type' => 'string', - 'example' => '74D958EF-3598-56FA-8296-FF1575CE43DF', - ], - 'FeatureConsistencyCheckId' => [ - 'title' => '克隆后新的特征一致性检查配置ID。', - 'description' => '', - 'type' => 'string', - 'example' => '4', - ], + 'RequestId' => ['title' => 'Id of the request', 'description' => 'The request ID.', 'type' => 'string', 'example' => 'F8F613A9-DF1C-551A-88E1-397A3981A785'], ], + 'example' => '', ], ], ], - 'staticInfo' => [ - 'returnType' => 'synchronous', + 'staticInfo' => ['returnType' => 'synchronous'], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"F8F613A9-DF1C-551A-88E1-397A3981A785\\"\\n}","type":"json"}]', + 'title' => 'Update DPI engine configuration', + 'changeSet' => [ + ['createdAt' => '2024-12-27T08:56:39.000Z', 'description' => 'Request parameters changed'], + ], + 'flowControl' => [ + 'flowControlList' => [], + ], + 'ramActions' => [ + [ + 'operationType' => 'update', + 'ramAction' => [ + 'action' => 'pairec:UpdateEngineConfig', + 'authLevel' => 'operate', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'PAIRecService', 'resourceType' => 'All Resource', 'arn' => '*'], + ], + ], + ], ], - 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"74D958EF-3598-56FA-8296-FF1575CE43DF\\",\\n \\"FeatureConsistencyCheckId\\": \\"4\\"\\n}","type":"json"}]', ], - 'TerminateFeatureConsistencyCheckJob' => [ - 'summary' => '取消指定特征一致性检查正在运行中的任务。', - 'path' => '/api/v1/featureconsistencycheck/jobs/{FeatureConsistencyCheckJobId}/action/terminate', - 'methods' => [ - 'post', - ], - 'schemes' => [ - 'http', - 'https', - ], + 'UpdateExperiment' => [ + 'summary' => 'Updates the properties of a specified experiment, such as its name.', + 'path' => '/api/v1/experiments/{ExperimentId}', + 'methods' => ['put'], + 'schemes' => ['http', 'https'], 'security' => [ [ 'AK' => [], ], ], - 'consumes' => [ - 'application/json', - ], - 'produces' => [ - 'application/json', - ], + 'consumes' => ['application/json'], + 'produces' => ['application/json'], 'operationType' => 'readAndWrite', 'deprecated' => false, 'systemTags' => [ - 'operationType' => 'none', + 'operationType' => 'update', 'riskType' => 'none', 'chargeType' => 'free', - 'abilityTreeNodes' => [ - 'FEATURElearnN0NAWV', - ], + 'abilityTreeNodes' => ['FEATURElearnN0NAWV'], ], 'parameters' => [ [ - 'name' => 'FeatureConsistencyCheckJobId', - 'in' => 'path', - 'schema' => [ - 'title' => '特征一致性检查任务ID。', - 'description' => '', - 'type' => 'string', - 'required' => true, - 'example' => '3', - ], - ], - [ 'name' => 'body', 'in' => 'body', 'style' => 'json', 'schema' => [ - 'description' => '', + 'description' => 'The request body.', 'type' => 'object', 'properties' => [ - 'InstanceId' => [ - 'title' => '实例ID，可从接口ListInstances获取。', - 'description' => '', - 'type' => 'string', - 'required' => true, - 'example' => 'pairec-cn-********', - ], + 'InstanceId' => ['description' => 'The ID of the instance. To obtain this ID, call the ListInstances operation.', 'type' => 'string', 'required' => true, 'example' => 'pairec-cn-abcdefg1234', 'title' => ''], + 'Name' => ['description' => 'The name of the experiment.', 'type' => 'string', 'required' => true, 'example' => 'experiment_test', 'title' => ''], + 'Description' => ['description' => 'The description of the experiment.', 'type' => 'string', 'required' => true, 'example' => 'This is a test.', 'title' => ''], + 'Type' => ['description' => 'The type of the experiment. Valid values: ● Baseline: A baseline experiment. ● Normal: A normal experiment.', 'type' => 'string', 'required' => true, 'example' => 'Baseline', 'title' => ''], + 'FlowPercent' => ['description' => 'The percentage of traffic to allocate to the experiment.', 'type' => 'integer', 'format' => 'int32', 'example' => '100', 'title' => '', 'required' => false], + 'DebugUsers' => ['description' => 'The UIDs for debug users, specified as a comma-separated string. Each UID must belong to an Alibaba Cloud account or RAM user.', 'type' => 'string', 'example' => '1124512470******,1124512471******,1124512472******', 'title' => '', 'required' => false], + 'DebugCrowdId' => ['description' => 'The ID of the debug crowd. To obtain this ID, call the ListCrowds operation.', 'type' => 'string', 'example' => '3', 'title' => '', 'required' => false], + 'Config' => ['description' => 'The experiment configuration, specified as a JSON string.', 'type' => 'string', 'example' => '{"RankBy": "Score"}', 'title' => '', 'required' => false], ], 'required' => false, + 'title' => '', + 'example' => '', ], ], + [ + 'name' => 'ExperimentId', + 'in' => 'path', + 'schema' => ['description' => 'The ID of the experiment. To obtain this ID, call the ListExperiments operation.', 'type' => 'string', 'required' => true, 'example' => '3', 'title' => ''], + ], ], 'responses' => [ 200 => [ 'schema' => [ 'title' => 'Schema of Response', - 'description' => 'Schema of Response', + 'description' => 'The data returned for the request.', 'type' => 'object', 'properties' => [ - 'RequestId' => [ - 'title' => 'Id of the request', - 'description' => '', - 'type' => 'string', - 'example' => 'A6C01890-54CA-5C49-BC91-AD85A98E4A98', - ], + 'RequestId' => ['title' => 'Id of the request', 'description' => 'The request ID.', 'type' => 'string', 'example' => 'A760D972-1475-58C0-BBB3-92B5FB08904F'], ], + 'example' => '', ], ], ], - 'staticInfo' => [ - 'returnType' => 'synchronous', + 'staticInfo' => ['returnType' => 'synchronous'], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"A760D972-1475-58C0-BBB3-92B5FB08904F\\"\\n}","type":"json"}]', + 'title' => 'Update Experiment', + 'changeSet' => [], + 'flowControl' => [ + 'flowControlList' => [], + ], + 'ramActions' => [ + [ + 'operationType' => 'update', + 'ramAction' => [ + 'action' => 'pairec:UpdateExperiment', + 'authLevel' => 'operate', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'PAIRecService', 'resourceType' => 'All Resource', 'arn' => '*'], + ], + ], + ], ], - 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"A6C01890-54CA-5C49-BC91-AD85A98E4A98\\"\\n}","type":"json"}]', ], - 'BackflowFeatureConsistencyCheckJobData' => [ - 'summary' => '特征一致性检查数据回流。', - 'path' => '/api/v1/featureconsistencycheck/jobs/action/backflowdata', - 'methods' => [ - 'post', - ], - 'schemes' => [ - 'http', - 'https', - ], + 'UpdateExperimentGroup' => [ + 'summary' => 'Updates information for a specified experiment group, such as its name and description.', + 'path' => '/api/v1/experimentgroups/{ExperimentGroupId}', + 'methods' => ['put'], + 'schemes' => ['http', 'https'], 'security' => [ [ 'AK' => [], ], ], - 'consumes' => [ - 'application/json', - ], - 'produces' => [ - 'application/json', - ], - 'operationType' => 'readAndWrite', + 'consumes' => ['application/json'], + 'produces' => ['application/json'], + 'operationType' => 'read', 'deprecated' => false, 'systemTags' => [ - 'operationType' => 'none', + 'operationType' => 'get', 'riskType' => 'none', 'chargeType' => 'free', - 'abilityTreeNodes' => [ - 'FEATURElearnN0NAWV', - ], + 'abilityTreeCode' => '183398', + 'abilityTreeNodes' => ['FEATURElearnN0NAWV'], ], 'parameters' => [ [ + 'name' => 'ExperimentGroupId', + 'in' => 'path', + 'schema' => ['description' => 'The ID of the experiment group. You can obtain this ID by calling the ListExperimentGroups API.', 'type' => 'string', 'required' => true, 'example' => '3', 'title' => ''], + ], + [ 'name' => 'body', 'in' => 'body', 'style' => 'json', 'schema' => [ - 'description' => '', + 'title' => '', + 'description' => 'The request body.', 'type' => 'object', 'properties' => [ - 'FeatureConsistencyCheckJobConfigId' => [ - 'title' => '特征一致性检查任务配置ID，可从接口ListFeatureConsistencyCheckJobConfigs获取。', - 'description' => '', - 'type' => 'string', - 'required' => true, - 'example' => '4', - ], - 'InstanceId' => [ - 'title' => '实例ID，可从接口ListInstances获取。', - 'description' => '', - 'type' => 'string', - 'required' => true, - 'example' => 'pairec-cn-********', - ], - 'LogUserId' => [ - 'title' => '日志中用户ID。', - 'description' => '', - 'type' => 'string', - 'required' => true, - 'example' => '1010', - ], - 'LogItemId' => [ - 'title' => '日志中物品ID。', - 'description' => '', - 'type' => 'string', - 'required' => true, - 'example' => '9010', - ], - 'LogRequestId' => [ - 'title' => '日志请求ID。', - 'description' => '', - 'type' => 'string', - 'required' => true, - 'example' => '728C5E01-ABF6-5AA8-B9FC-B3BA05DECC77', - ], - 'SceneName' => [ - 'title' => '场景名称。', - 'description' => '', - 'type' => 'string', - 'required' => true, - 'example' => 'video-feed', - ], - 'Scores' => [ - 'title' => '分数。', - 'description' => '', - 'type' => 'string', - 'required' => true, - 'example' => '[\\"{\\\\\\"dbmtl_probs_is_valid_play\\\\\\":0.00032182207107543945,\\\\\\"dbmtl_y_play_time\\\\\\":0.0043269748210906982}\\"]', - ], - 'UserFeatures' => [ - 'title' => '用户特征。', - 'description' => '', - 'type' => 'string', - 'required' => true, - 'example' => '{\\"userid\\":{\\"value\\":1010,\\"type\\":\\"string\\"},\\"click_5_seq\\":{\\"value\\":\\"9001;9002;9003;9004;9005\\",\\"type\\":\\"string\\"}}', - ], - 'ItemFeatures' => [ - 'title' => '物品特征。', - 'description' => '', - 'type' => 'string', - 'required' => true, - 'example' => '[\\"{\\\\\\"itemid\\\\\\":{\\\\\\"value\\\\\\":1010,\\\\\\"type\\\\\\":\\\\\\"string\\\\\\"}}\\"]', - ], - 'LogRequestTime' => [ - 'title' => '日志请求时间。', - 'description' => '', - 'type' => 'integer', - 'format' => 'int64', - 'required' => true, - 'example' => '1693900981465', - ], - 'ServiceName' => [ - 'type' => 'string', - ], + 'LayerId' => ['description' => 'The ID of the layer. You can obtain this ID by calling the ListLayers API.', 'type' => 'string', 'required' => true, 'example' => '3', 'title' => ''], + 'Name' => ['description' => 'The name of the experiment group.', 'type' => 'string', 'required' => true, 'example' => 'experiment_group1', 'title' => ''], + 'Description' => ['description' => 'The description of the experiment group.', 'type' => 'string', 'required' => true, 'example' => 'This is a test.', 'title' => ''], + 'DebugUsers' => ['description' => 'A comma-separated list of UIDs for debug users. The UIDs can belong to Alibaba Cloud main accounts or sub-accounts.', 'type' => 'string', 'example' => 'user1,user2,user3', 'title' => '', 'required' => false], + 'DebugCrowdId' => ['description' => 'The ID of the debug crowd. You can obtain this ID by calling the ListCrowds API.', 'type' => 'string', 'example' => '3', 'title' => '', 'required' => false], + 'NeedAA' => ['description' => 'Specifies whether an AA experiment group is required.', 'type' => 'boolean', 'title' => '', 'required' => false, 'example' => 'true'], + 'Filter' => ['description' => 'The filter condition for crowd targeting.', 'type' => 'string', 'example' => 'gender=male', 'title' => '', 'required' => false], + 'CrowdId' => ['description' => 'The ID of the crowd for crowd targeting. You can obtain this ID by calling the ListCrowds API.', 'type' => 'string', 'example' => '3', 'title' => '', 'required' => false], + 'DistributionType' => ['description' => 'The distribution type. ● UserId: Distributes traffic by user ID. ● TimeDuration: Distributes traffic by time duration.', 'type' => 'string', 'example' => 'UserId', 'title' => '', 'required' => false], + 'DistributionTimeDuration' => ['description' => 'The time duration for traffic distribution.', 'type' => 'integer', 'format' => 'int32', 'example' => '3', 'title' => '', 'required' => false], + 'Config' => ['description' => 'The configuration of the experiment group.', 'type' => 'string', 'example' => '{"RankBy": "Score"}', 'title' => '', 'required' => false], + 'ReservcedBuckets' => ['description' => 'The reserved buckets.', 'type' => 'string', 'example' => '1,2,3', 'title' => '', 'required' => false], + 'InstanceId' => ['description' => 'The ID of the instance. You can obtain this ID by calling the ListInstances API.', 'type' => 'string', 'required' => true, 'example' => 'pairec-cn-abcdefg1234', 'title' => ''], + 'CrowdTargetType' => ['description' => 'The type of crowd targeting for the experiment group. Valid values:'."\n" + ."\n" + .'- All: all traffic'."\n" + ."\n" + .'- Filter: traffic that matches the filter condition'."\n" + ."\n" + .'- CrowdId: traffic from the specified crowd ID'."\n" + ."\n" + .'- Random: a random percentage of traffic', 'type' => 'string', 'required' => false, 'example' => 'All', 'title' => ''], + 'RandomFlow' => ['description' => 'If CrowdTargetType is set to Random, this parameter specifies the percentage of traffic (from 0 to 100) to route to the experiment group.', 'type' => 'integer', 'format' => 'int64', 'required' => false, 'example' => '20', 'title' => ''], ], 'required' => false, + 'example' => '', ], ], ], @@ -16324,213 +16251,226 @@ 200 => [ 'schema' => [ 'title' => 'Schema of Response', - 'description' => 'Schema of Response', + 'description' => 'The response schema.', 'type' => 'object', 'properties' => [ - 'RequestId' => [ - 'title' => 'Id of the request', - 'description' => '', - 'type' => 'string', - 'example' => 'BDB621CB-A81E-5D39-8793-39A365CBCC74', - ], + 'RequestId' => ['title' => 'Id of the request', 'description' => 'The request ID.', 'type' => 'string', 'example' => 'F7AC05FF-EDE7-5C2B-B9AE-33D6DF4178BA'], ], + 'example' => '', ], ], ], - 'staticInfo' => [ - 'returnType' => 'synchronous', + 'staticInfo' => ['returnType' => 'synchronous'], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"F7AC05FF-EDE7-5C2B-B9AE-33D6DF4178BA\\"\\n}","type":"json"}]', + 'title' => 'Update Experiment Group', + 'changeSet' => [ + ['createdAt' => '2024-03-20T06:05:19.000Z', 'description' => 'Request parameters changed'], + ], + 'flowControl' => [ + 'flowControlList' => [], + ], + 'ramActions' => [ + [ + 'operationType' => 'get', + 'ramAction' => [ + 'action' => 'pairec:UpdateExperimentGroup', + 'authLevel' => 'operate', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'PAIRecService', 'resourceType' => 'All Resource', 'arn' => '*'], + ], + ], + ], ], - 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"BDB621CB-A81E-5D39-8793-39A365CBCC74\\"\\n}","type":"json"}]', ], - 'SyncFeatureConsistencyCheckJobReplayLog' => [ - 'summary' => '同步特征一致性检测任务重放日志。', - 'path' => '/api/v1/featureconsistencycheck/jobs/action/syncreplaylog', - 'methods' => [ - 'post', - ], - 'schemes' => [ - 'http', - 'https', - ], + 'UpdateFeatureConsistencyCheckJobConfig' => [ + 'summary' => 'Updates the configuration details of a feature consistency check task, such as the name.', + 'path' => '/api/v1/featureconsistencycheck/jobconfigs/{FeatureConsistencyCheckJobConfigId}', + 'methods' => ['put'], + 'schemes' => ['http', 'https'], 'security' => [ [ 'AK' => [], ], ], - 'consumes' => [ - 'application/json', - ], - 'produces' => [ - 'application/json', - ], + 'consumes' => ['application/json'], + 'produces' => ['application/json'], 'operationType' => 'readAndWrite', 'deprecated' => false, 'systemTags' => [ - 'operationType' => 'none', + 'operationType' => 'update', 'riskType' => 'none', 'chargeType' => 'free', - 'abilityTreeNodes' => [ - 'FEATURElearnN0NAWV', - ], + 'abilityTreeCode' => '193282', + 'abilityTreeNodes' => ['FEATURElearnN0NAWV'], ], 'parameters' => [ [ + 'name' => 'FeatureConsistencyCheckJobConfigId', + 'in' => 'path', + 'schema' => ['title' => '', 'description' => 'The feature consistency check configuration ID. For information about how to obtain the configuration ID, see [ListFeatureConsistencyCheckJobConfigs](~~2557567~~).', 'type' => 'string', 'required' => true, 'example' => '3'], + ], + [ 'name' => 'body', 'in' => 'body', 'style' => 'json', 'schema' => [ - 'description' => '', + 'description' => 'The request body.', 'type' => 'object', 'properties' => [ - 'FeatureConsistencyCheckJobConfigId' => [ - 'title' => '特征一致性检查任务配置ID，可从接口ListFeatureConsistencyCheckJobConfigs获取。', - 'description' => '', - 'type' => 'string', - 'required' => true, - 'example' => '3', - ], - 'InstanceId' => [ - 'title' => '实例ID，可从接口ListInstances获取。', - 'description' => '', - 'type' => 'string', - 'required' => true, - 'example' => 'pairec-cn-********', - ], - 'LogUserId' => [ - 'title' => '日志中用户ID。', - 'description' => '', - 'type' => 'string', - 'required' => true, - 'example' => '1010', - ], - 'LogItemId' => [ - 'title' => '日志中物品ID。', - 'description' => '', - 'type' => 'string', - 'required' => true, - 'example' => '9010', - ], - 'LogRequestId' => [ - 'title' => '日志中请求ID。', - 'description' => '', - 'type' => 'string', - 'required' => true, - 'example' => '728C5E01-ABF6-5AA8-B9FC-B3BA05DECC77', - ], - 'SceneName' => [ - 'title' => '场景名称。', - 'description' => '', - 'type' => 'string', - 'required' => true, - 'example' => 'video-feed', - ], - 'LogRequestTime' => [ - 'title' => '日志请求时间。', - 'description' => '', - 'type' => 'integer', - 'format' => 'int64', - 'required' => true, - 'example' => '1693900981465', - ], - 'GeneratedFeatures' => [ - 'title' => '生成特征。', - 'description' => '', - 'type' => 'string', - 'required' => true, - 'example' => 'week_day:1 | userid:3 | itemid:9001 | cate:cat1 | click_5_seq__cate:cat1', - ], - 'ContextFeatures' => [ - 'title' => '上下文特征。', - 'description' => '', - 'type' => 'string', - 'required' => true, - 'example' => '[{\\"Value\\":{\\"FloatFeature\\":0.1}}]', - ], - 'RawFeatures' => [ - 'title' => '原始特征。', - 'description' => '', - 'type' => 'string', - 'required' => true, - 'example' => '', - ], + 'InstanceId' => ['title' => '', 'description' => 'The instance ID. For information about how to obtain the instance ID, see [ListInstances](~~2411819~~).', 'type' => 'string', 'required' => true, 'example' => 'pairec-cn-********'], + 'Name' => ['title' => '', 'description' => 'The feature consistency check name.', 'type' => 'string', 'required' => true, 'example' => 'feature_consistency_check1'], + 'SceneId' => ['title' => '', 'description' => 'The scene ID.', 'type' => 'string', 'required' => true, 'example' => '3'], + 'SampleRate' => ['title' => '', 'description' => 'The sampling ratio (0-1).', 'type' => 'number', 'format' => 'double', 'required' => true, 'example' => '0.89'], + 'FeatureLandingResourceId' => ['title' => '', 'description' => 'The data fallback data source ID.', 'type' => 'string', 'required' => true, 'example' => 'reso-********'], + 'MaxcomputeSchema' => ['title' => '', 'description' => 'maxcompute schema'."\n", 'type' => 'string', 'example' => 'default', 'required' => false], + 'EasServiceName' => ['title' => '', 'description' => 'The PAI-EAS service name.', 'type' => 'string', 'required' => true, 'example' => 'service_123'], + 'FgJsonFileName' => ['title' => '', 'description' => 'The fg_json file name.', 'type' => 'string', 'required' => true, 'example' => 'file.json'], + 'UserTable' => ['title' => '', 'description' => 'The user table name.', 'type' => 'string', 'required' => true, 'example' => 'user_table'], + 'UserIdField' => ['title' => '', 'description' => 'The user_id field name.', 'type' => 'string', 'required' => true, 'example' => 'user_id'], + 'UserTablePartitionField' => ['title' => '', 'description' => 'The user table partition field.', 'type' => 'string', 'required' => true, 'example' => 'ds'], + 'UserTablePartitionFieldFormat' => ['title' => '', 'description' => 'The user table partition field format. Valid values:'."\n" + .'- yyyymmdd'."\n" + .'- yyyy-mm-dd', 'type' => 'string', 'required' => true, 'example' => 'yyyymmdd'], + 'ItemTable' => ['title' => '', 'description' => 'The item table name.', 'type' => 'string', 'required' => true, 'example' => 'item_table'], + 'ItemIdField' => ['title' => '', 'description' => 'The item_id field name.', 'type' => 'string', 'required' => true, 'example' => 'item_id'], + 'ItemTablePartitionField' => ['title' => '', 'description' => 'The item table partition field.', 'type' => 'string', 'required' => true, 'example' => 'ds'], + 'ItemTablePartitionFieldFormat' => ['title' => '', 'description' => 'The item table partition field format. Valid values:'."\n" + .'- yyyymmdd'."\n" + .'- yyyy-mm-dd', 'type' => 'string', 'required' => true, 'example' => 'yyyymmdd'], + 'CompareFeature' => ['title' => '', 'description' => 'Specifies whether feature comparison is required.', 'type' => 'boolean', 'required' => true, 'example' => 'true'], + 'GenerateZip' => ['title' => '', 'description' => 'Specifies whether to generate a ZIP package.', 'type' => 'boolean', 'required' => true, 'example' => 'true'], + 'ServiceId' => ['title' => '', 'description' => 'The service ID.', 'type' => 'string', 'required' => false, 'example' => '4'], + 'WorkflowName' => ['title' => '', 'description' => 'The workflow name.', 'type' => 'string', 'example' => 'work_flow_1', 'required' => false], + 'OssResourceId' => ['title' => '', 'description' => 'The OSS data source ID.', 'type' => 'string', 'example' => 'reso-********', 'required' => false], + 'EasyRecVersion' => ['title' => '', 'description' => 'The EasyRec version.', 'type' => 'string', 'example' => '1.3.60', 'required' => false], + 'EasyRecPackagePath' => ['title' => '', 'description' => 'The EasyRec package path.', 'type' => 'string', 'required' => false, 'example' => 'oss://********'], + 'FgJarVersion' => ['title' => '', 'description' => 'The fg_jar version.', 'type' => 'string', 'example' => '1.0.0', 'required' => false], + 'FeaturePriority' => ['title' => '', 'description' => 'The feature priority. Separate multiple features with commas (,). This parameter specifies which features are preferentially read from the user table. If the user table is empty, the features are queried from the behavior table.', 'type' => 'string', 'example' => 'feature1,feature2,feature3', 'required' => false], + 'FeatureDisplayExclude' => ['title' => '', 'description' => 'The features to exclude from display. Separate multiple features with commas (,).', 'type' => 'string', 'example' => 'feature1,feature2', 'required' => false], + 'IsUseFeatureStore' => ['title' => '', 'description' => 'Specifies whether to use Feature Store.', 'type' => 'boolean', 'required' => false, 'example' => ''], + 'FeatureStoreProjectName' => ['title' => '', 'description' => 'The Feature Store project name.', 'type' => 'string', 'example' => 'project-1', 'required' => false], + 'FeatureStoreModelId' => ['title' => '', 'description' => 'feature store model id'."\n", 'type' => 'string', 'example' => '2', 'required' => false], + 'FeatureStoreUserId' => ['title' => '', 'description' => 'The Feature Store user-side primary key.', 'type' => 'string', 'example' => 'user', 'required' => false], + 'FeatureStoreItemId' => ['title' => '', 'description' => 'The Feature Store item-side primary key.', 'type' => 'string', 'example' => 'item', 'required' => false], + 'FeatureStoreSeqFeatureView' => ['title' => '', 'description' => 'The name of the feature view that contains the item features in the sequence feature.', 'type' => 'string', 'example' => 'seq_item_view', 'required' => false], + 'FeatureStoreProjectId' => ['title' => '', 'description' => 'The Feature Store project ID.', 'type' => 'string', 'example' => '1', 'required' => false], + 'WorkspaceId' => ['title' => '', 'description' => 'The PAI workspace ID.', 'type' => 'string', 'example' => '34597***', 'required' => false], + 'VpcId' => ['title' => '', 'description' => 'VpcID。'."\n", 'type' => 'string', 'example' => 'vpc-xxx', 'required' => false], + 'SwitchId' => ['title' => '', 'description' => 'The vSwitch ID.', 'type' => 'string', 'example' => 'vsw-xxx', 'required' => false], + 'SecurityGroupId' => ['title' => '', 'description' => 'The security group ID.', 'type' => 'string', 'example' => 'sg-xxx', 'required' => false], + 'DefaultRoute' => ['title' => '', 'description' => 'The default gateway. Valid values:'."\n" + .'- Eth0: public gateway.'."\n" + .'- Eth1: dedicated gateway.', 'type' => 'string', 'example' => 'Eth0', 'required' => false], + 'DatasetId' => ['title' => '', 'description' => 'The dataset ID.', 'type' => 'string', 'example' => 'd-xxx', 'required' => false], + 'DatasetType' => ['title' => '', 'description' => 'The dataset type.', 'type' => 'string', 'example' => 'OSS', 'required' => false], + 'DatasetUri' => ['title' => '', 'description' => 'The URI of the dataset.', 'type' => 'string', 'example' => 'oss://xxxx', 'required' => false], + 'DatasetMountPath' => ['title' => '', 'description' => 'The mount path of the dataset.', 'type' => 'string', 'example' => '/mnt/data/', 'required' => false], + 'DatasetName' => ['title' => '', 'description' => 'The dataset name.', 'type' => 'string', 'example' => 'dateset-test', 'required' => false], + 'PredictWorkerCount' => ['title' => '', 'description' => 'The number of workers for running the prediction script.', 'type' => 'integer', 'format' => 'int32', 'example' => '1', 'required' => false], + 'PredictWorkerCpu' => ['title' => '', 'description' => 'The CPU specification of workers for running the prediction script.', 'type' => 'integer', 'format' => 'int32', 'example' => '4', 'required' => false], + 'PredictWorkerMemory' => ['title' => '', 'description' => 'The memory specification of workers for running the prediction script.', 'type' => 'integer', 'format' => 'int32', 'example' => '32000(32G)', 'required' => false], + 'ResourceConfig' => ['title' => '', 'description' => 'The resource configuration.', 'type' => 'string', 'example' => '{}', 'required' => false], ], 'required' => false, + 'title' => '', + 'example' => '', ], ], ], 'responses' => [ 200 => [ 'schema' => [ - 'title' => 'Schema of Response', + 'title' => '', 'description' => 'Schema of Response', 'type' => 'object', 'properties' => [ - 'RequestId' => [ - 'title' => 'Id of the request', - 'description' => '', - 'type' => 'string', - 'example' => 'C7D0B48F-0105-52B9-B60A-FA7606E2234D', - ], + 'RequestId' => ['title' => '', 'description' => 'The request ID.', 'type' => 'string', 'example' => 'A04CB8C0-E74A-5E83-BC61-64D153574EC7'], ], + 'example' => '', ], ], ], - 'staticInfo' => [ - 'returnType' => 'synchronous', + 'staticInfo' => ['returnType' => 'synchronous'], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"A04CB8C0-E74A-5E83-BC61-64D153574EC7\\"\\n}","type":"json"}]', + 'title' => 'Update feature consistency check task configuration', + 'description' => '## Operation description'."\n" + ."\n" + .'This API operation allows you to update the configuration of an existing feature consistency check task. By providing new configuration parameters, you can modify multiple properties including the instance ID, name, and scene ID. Ensure that all required parameters are included in the request, and provide optional parameters as needed.'."\n" + ."\n" + .'- **FeatureConsistencyCheckJobConfigId** is a path parameter that specifies the feature consistency check task to update.'."\n" + .'- All other parameters are in the request body. Some are required (such as InstanceId and Name), and the rest are optional.'."\n" + .'- The SampleRate value must be a floating-point number between 0 and 1, which indicates the sampling ratio.'."\n" + .'- If you use FeatureStore-related features, make sure that you correctly set the IsUseFeatureStore flag and the related FeatureStore* fields.'."\n" + .'- For network configuration parameters (such as VpcId and SwitchId), make sure that the values match your Alibaba Cloud environment.', + 'changeSet' => [ + ['createdAt' => '2025-06-04T10:10:20.000Z', 'description' => 'Request parameters changed'], + ['createdAt' => '2024-12-10T06:00:28.000Z', 'description' => 'Request parameters changed'], + ['createdAt' => '2024-11-12T09:17:26.000Z', 'description' => 'Request parameters changed'], + ['createdAt' => '2024-02-22T03:35:43.000Z', 'description' => 'Request parameters changed'], + ], + 'flowControl' => [ + 'flowControlList' => [], + ], + 'ramActions' => [ + [ + 'operationType' => 'update', + 'ramAction' => [ + 'action' => 'pairec:UpdateFeatureConsistencyCheckJobConfig', + 'authLevel' => 'operate', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'PAIRecService', 'resourceType' => 'All Resource', 'arn' => '*'], + ], + ], + ], ], - 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"C7D0B48F-0105-52B9-B60A-FA7606E2234D\\"\\n}","type":"json"}]', ], - 'DeleteEngineConfig' => [ - 'summary' => '删除指定推荐引擎配置。', - 'path' => '/api/v1/engineconfigs/{EngineConfigId}', - 'methods' => [ - 'delete', - ], - 'schemes' => [ - 'http', - 'https', - ], + 'UpdateInstanceResource' => [ + 'summary' => 'Updates a specified resource for a specified instance.', + 'path' => '/api/v1/instances/{InstanceId}/resources/{ResourceId}', + 'methods' => ['put'], + 'schemes' => ['http', 'https'], 'security' => [ [ 'AK' => [], ], ], - 'consumes' => [ - 'application/json', - ], - 'produces' => [ - 'application/json', - ], + 'consumes' => ['application/json'], + 'produces' => ['application/json'], 'operationType' => 'readAndWrite', 'deprecated' => false, 'systemTags' => [ - 'operationType' => 'none', + 'operationType' => 'update', 'riskType' => 'none', 'chargeType' => 'free', - 'abilityTreeCode' => '180292', - 'abilityTreeNodes' => [ - 'FEATURElearnN0NAWV', - ], + 'abilityTreeNodes' => ['FEATURElearnN0NAWV'], ], 'parameters' => [ [ - 'name' => 'EngineConfigId', + 'name' => 'InstanceId', 'in' => 'path', - 'schema' => [ - 'description' => '', - 'type' => 'string', - 'required' => false, - 'example' => '21', - ], + 'schema' => ['description' => 'The instance ID. You can obtain this ID by calling the [ListInstances](~~2411819~~) operation.', 'type' => 'string', 'required' => true, 'example' => 'pairec-cn-test1', 'title' => ''], ], [ - 'name' => 'InstanceId', - 'in' => 'query', + 'name' => 'ResourceId', + 'in' => 'path', + 'schema' => ['description' => 'The resource ID.', 'type' => 'string', 'required' => true, 'example' => 'reso-2s416t***', 'title' => ''], + ], + [ + 'name' => 'body', + 'in' => 'body', + 'style' => 'json', 'schema' => [ - 'description' => '', - 'type' => 'string', + 'description' => 'The request body.', + 'type' => 'object', + 'properties' => [ + 'Uri' => ['description' => 'The resource address.', 'type' => 'string', 'required' => false, 'example' => 'bucket-test-123', 'title' => ''], + 'Config' => ['description' => 'The resource configuration.', 'type' => 'string', 'required' => false, 'example' => '{}', 'title' => ''], + ], 'required' => false, - 'example' => 'pairec-cn-***test1', + 'title' => '', + 'example' => '', ], ], ], @@ -16538,109 +16478,87 @@ 200 => [ 'schema' => [ 'title' => 'Schema of Response', - 'description' => 'Schema of Response', + 'description' => 'The response schema.', 'type' => 'object', 'properties' => [ - 'RequestId' => [ - 'title' => 'Id of the request', - 'description' => '', - 'type' => 'string', - 'example' => 'F7AC05FF-EDE7-5C2B-B9AE-33D6DF4178BA', - ], + 'RequestId' => ['title' => 'Id of the request', 'description' => 'The request ID.', 'type' => 'string', 'example' => '3AAA45F6-0798-5461-9360-81D133823CE7'], ], + 'example' => '', ], ], ], - 'staticInfo' => [ - 'returnType' => 'synchronous', + 'staticInfo' => ['returnType' => 'synchronous'], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"3AAA45F6-0798-5461-9360-81D133823CE7\\"\\n}","type":"json"}]', + 'title' => 'Update Resource Information', + 'changeSet' => [ + ['createdAt' => '2024-02-22T03:35:44.000Z', 'description' => 'Request parameters changed'], + ], + 'flowControl' => [ + 'flowControlList' => [], + ], + 'ramActions' => [ + [ + 'operationType' => 'update', + 'ramAction' => [ + 'action' => 'pairec:UpdateInstanceResource', + 'authLevel' => 'operate', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'PAIRecService', 'resourceType' => 'All Resource', 'arn' => '*'], + ], + ], + ], ], - 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"F7AC05FF-EDE7-5C2B-B9AE-33D6DF4178BA\\"\\n}","type":"json"}]', ], - 'UpdateEngineConfig' => [ - 'summary' => '更新引擎配置。', - 'path' => '/api/v1/engineconfigs/{EngineConfigId}', - 'methods' => [ - 'put', - ], - 'schemes' => [ - 'http', - 'https', - ], + 'UpdateLaboratory' => [ + 'summary' => 'Updates a laboratory\'s information, such as its name.', + 'path' => '/api/v1/laboratories/{LaboratoryId}', + 'methods' => ['put'], + 'schemes' => ['http', 'https'], 'security' => [ [ 'AK' => [], ], ], - 'consumes' => [ - 'application/json', - ], - 'produces' => [ - 'application/json', - ], + 'consumes' => ['application/json'], + 'produces' => ['application/json'], 'operationType' => 'readAndWrite', 'deprecated' => false, 'systemTags' => [ 'operationType' => 'update', 'riskType' => 'none', 'chargeType' => 'free', - 'abilityTreeCode' => '180246', - 'abilityTreeNodes' => [ - 'FEATURElearnN0NAWV', - ], + 'abilityTreeNodes' => ['FEATURElearnN0NAWV'], ], 'parameters' => [ [ - 'name' => 'EngineConfigId', + 'name' => 'LaboratoryId', 'in' => 'path', - 'schema' => [ - 'description' => '', - 'type' => 'string', - 'required' => false, - 'example' => '3', - ], + 'schema' => ['description' => 'The ID of the laboratory to update. Call the ListLaboratories operation to obtain this ID.', 'type' => 'string', 'required' => true, 'example' => '3', 'title' => ''], ], [ 'name' => 'body', 'in' => 'body', 'style' => 'json', 'schema' => [ - 'description' => '', + 'title' => '', + 'description' => 'The request body.', 'type' => 'object', 'properties' => [ - 'Name' => [ - 'description' => '', - 'type' => 'string', - 'required' => false, - 'example' => 'engine_config_v1', - ], - 'ConfigValue' => [ - 'description' => '', - 'type' => 'string', - 'required' => false, - 'example' => '{'."\n" - .' "ListenConf": {'."\n" - .' "HttpAddr": "",'."\n" - .' "HttpPort": 8000'."\n" - .' }'."\n" - .'}', - ], - 'Environment' => [ - 'description' => '', - 'type' => 'string', - 'required' => false, - 'example' => 'Pre', - ], - 'InstanceId' => [ - 'description' => '', - 'type' => 'string', - 'required' => false, - 'example' => 'pairec-cn-***test', - ], - 'Description' => [ - 'type' => 'string', - ], + 'Name' => ['description' => 'The laboratory name.', 'type' => 'string', 'required' => true, 'example' => 'laboratory1', 'title' => ''], + 'Description' => ['description' => 'The laboratory description.', 'type' => 'string', 'example' => 'This is a test.', 'title' => '', 'required' => false], + 'DebugUsers' => ['description' => 'The UIDs of debugging users. These UIDs must belong to an Alibaba Cloud main account or a sub-account. Separate multiple UIDs with a comma (,).', 'type' => 'string', 'example' => '1124512470******,1124512471******,1124512472******', 'title' => '', 'required' => false], + 'DebugCrowdId' => ['description' => 'The debug crowd ID.', 'type' => 'string', 'example' => '3', 'title' => '', 'required' => false], + 'BucketCount' => ['description' => 'The number of buckets.', 'type' => 'integer', 'format' => 'int32', 'example' => '24', 'title' => '', 'required' => false], + 'Buckets' => ['description' => 'The assigned bucket numbers.', 'type' => 'string', 'example' => '1,2,3,10-20', 'title' => '', 'required' => false], + 'BucketType' => ['description' => 'The bucketing method. Valid values: ● Uid: Bucketing by UID (default). ● UidHash: Bucketing by UID hash. ● Filter: Bucketing by a filter condition.', 'type' => 'string', 'required' => true, 'example' => 'Filter', 'title' => ''], + 'Filter' => ['description' => 'The filter condition.', 'type' => 'string', 'example' => 'filter=xxx', 'title' => '', 'required' => false], + 'Type' => ['description' => 'The laboratory type. Valid values: ● Base ● NonBase', 'type' => 'string', 'required' => true, 'example' => 'Base', 'title' => ''], + 'InstanceId' => ['description' => 'The instance ID. Call the ListInstances operation to obtain the ID.', 'type' => 'string', 'required' => true, 'example' => 'pairec-test1', 'title' => ''], + 'Environment' => ['description' => 'The environment. Valid values: ● Daily: The daily environment. ● Pre: The staging environment. ● Prod: The production environment.', 'type' => 'string', 'example' => 'Daily', 'title' => '', 'required' => false], ], 'required' => false, + 'example' => '', ], ], ], @@ -16648,127 +16566,154 @@ 200 => [ 'schema' => [ 'title' => 'Schema of Response', - 'description' => 'Schema of Response', + 'description' => 'The returned data.', 'type' => 'object', 'properties' => [ - 'RequestId' => [ - 'title' => 'Id of the request', - 'description' => '', - 'type' => 'string', - 'example' => 'F8F613A9-DF1C-551A-88E1-397A3981A785', - ], + 'RequestId' => ['title' => 'Id of the request', 'description' => 'The request ID.', 'type' => 'string', 'example' => 'A04CB8C0-E74A-5E83-BC61-64D153574EC7'], ], + 'example' => '', ], ], ], - 'staticInfo' => [ - 'returnType' => 'synchronous', + 'staticInfo' => ['returnType' => 'synchronous'], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"A04CB8C0-E74A-5E83-BC61-64D153574EC7\\"\\n}","type":"json"}]', + 'title' => 'Update Laboratory', + 'changeSet' => [], + 'flowControl' => [ + 'flowControlList' => [], + ], + 'ramActions' => [ + [ + 'operationType' => 'update', + 'ramAction' => [ + 'action' => 'pairec:UpdateLaboratory', + 'authLevel' => 'operate', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'PAIRecService', 'resourceType' => 'All Resource', 'arn' => '*'], + ], + ], + ], ], - 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"F8F613A9-DF1C-551A-88E1-397A3981A785\\"\\n}","type":"json"}]', ], - 'ListEngineConfigs' => [ - 'summary' => '获取引擎配置列表。', - 'path' => '/api/v1/engineconfigs', - 'methods' => [ - 'get', - ], - 'schemes' => [ - 'http', - 'https', - ], + 'UpdateLayer' => [ + 'summary' => 'Updates the name and description of a specified layer.', + 'path' => '/api/v1/layers/{LayerId}', + 'methods' => ['put'], + 'schemes' => ['http', 'https'], 'security' => [ [ 'AK' => [], ], ], - 'consumes' => [ - 'application/json', - ], - 'produces' => [ - 'application/json', - ], - 'operationType' => 'read', + 'consumes' => ['application/json'], + 'produces' => ['application/json'], + 'operationType' => 'readAndWrite', 'deprecated' => false, 'systemTags' => [ - 'operationType' => 'list', + 'operationType' => 'update', 'riskType' => 'none', 'chargeType' => 'free', - 'abilityTreeCode' => '180248', - 'abilityTreeNodes' => [ - 'FEATURElearnN0NAWV', - ], + 'abilityTreeNodes' => ['FEATURElearnN0NAWV'], ], 'parameters' => [ [ - 'name' => 'Environment', - 'in' => 'query', - 'schema' => [ - 'description' => '', - 'type' => 'string', - 'required' => false, - 'example' => 'Pre', - ], + 'name' => 'LayerId', + 'in' => 'path', + 'schema' => ['description' => 'The layer ID. You can call the ListLayers operation to obtain this ID.', 'type' => 'string', 'required' => true, 'example' => '3', 'title' => ''], ], [ - 'name' => 'Status', - 'in' => 'query', + 'name' => 'body', + 'in' => 'body', + 'style' => 'json', 'schema' => [ - 'description' => '', - 'type' => 'string', + 'title' => '', + 'description' => 'The request body.', + 'type' => 'object', + 'properties' => [ + 'InstanceId' => ['description' => 'The instance ID. You can obtain this ID by calling the ListInstances operation.', 'type' => 'string', 'required' => true, 'example' => 'pairec-test1', 'title' => ''], + 'Name' => ['description' => 'The layer name.', 'type' => 'string', 'required' => true, 'example' => 'layer1', 'title' => ''], + 'Description' => ['description' => 'The layer description.', 'type' => 'string', 'required' => true, 'example' => 'This is a test.', 'title' => ''], + ], 'required' => false, - 'example' => 'Released', + 'example' => '', ], ], - [ - 'name' => 'Name', - 'in' => 'query', + ], + 'responses' => [ + 200 => [ 'schema' => [ - 'description' => '', - 'type' => 'string', - 'required' => false, - 'example' => 'engine_config_v1', + 'title' => 'Schema of Response', + 'description' => 'The response data.', + 'type' => 'object', + 'properties' => [ + 'RequestId' => ['title' => 'Id of the request', 'description' => 'The request ID.', 'type' => 'string', 'example' => '0EA9215E-EC21-53AB-B8D9-D3DEA90D040A'], + ], + 'example' => '', ], ], - [ - 'name' => 'PageNumber', - 'in' => 'query', - 'schema' => [ - 'description' => '', - 'type' => 'integer', - 'format' => 'int32', - 'required' => false, - 'example' => '1', + ], + 'staticInfo' => ['returnType' => 'synchronous'], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"0EA9215E-EC21-53AB-B8D9-D3DEA90D040A\\"\\n}","type":"json"}]', + 'title' => 'Update Layer', + 'changeSet' => [], + 'flowControl' => [ + 'flowControlList' => [], + ], + 'ramActions' => [ + [ + 'operationType' => 'update', + 'ramAction' => [ + 'action' => 'pairec:UpdateLayer', + 'authLevel' => 'operate', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'PAIRecService', 'resourceType' => 'All Resource', 'arn' => '*'], + ], ], ], + ], + ], + 'UpdateParam' => [ + 'summary' => 'Updates information for a specified parameter, such as its value.', + 'path' => '/api/v1/params/{ParamId}', + 'methods' => ['put'], + 'schemes' => ['http', 'https'], + 'security' => [ [ - 'name' => 'PageSize', - 'in' => 'query', - 'schema' => [ - 'description' => '', - 'type' => 'integer', - 'format' => 'int32', - 'required' => false, - 'example' => '10', - ], + 'AK' => [], ], + ], + 'consumes' => ['application/json'], + 'produces' => ['application/json'], + 'operationType' => 'readAndWrite', + 'deprecated' => false, + 'systemTags' => [ + 'operationType' => 'update', + 'riskType' => 'none', + 'chargeType' => 'free', + 'abilityTreeNodes' => ['FEATURElearnN0NAWV'], + ], + 'parameters' => [ [ - 'name' => 'Version', - 'in' => 'query', - 'schema' => [ - 'description' => '', - 'type' => 'string', - 'required' => false, - 'example' => 'latest', - ], + 'name' => 'ParamId', + 'in' => 'path', + 'schema' => ['description' => 'The ID of the parameter. You can retrieve this ID by calling the ListParams API.', 'type' => 'string', 'example' => '3', 'title' => '', 'required' => false], ], [ - 'name' => 'InstanceId', - 'in' => 'query', + 'name' => 'body', + 'in' => 'body', + 'style' => 'json', 'schema' => [ - 'description' => '', - 'type' => 'string', - 'required' => true, - 'example' => 'pairec-cn-***test', + 'title' => '', + 'description' => 'The request body.', + 'type' => 'object', + 'properties' => [ + 'Value' => ['description' => 'The parameter\'s value.', 'type' => 'string', 'example' => 'house', 'title' => '', 'required' => false], + 'InstanceId' => ['description' => 'The instance ID. You can retrieve this ID by calling the ListInstances API.', 'type' => 'string', 'example' => 'pairec-cn-abcdefg1234', 'title' => '', 'required' => false], + ], + 'required' => false, + 'example' => '', ], ], ], @@ -16776,456 +16721,629 @@ 200 => [ 'schema' => [ 'title' => 'Schema of Response', - 'description' => 'Schema of Response', + 'description' => 'The response schema.', 'type' => 'object', 'properties' => [ - 'RequestId' => [ - 'title' => 'Id of the request', - 'description' => '', - 'type' => 'string', - 'example' => '74D958EF-3598-56FA-8296-FF1575CE43DF', - ], - 'TotalCount' => [ - 'description' => '', - 'type' => 'integer', - 'format' => 'int64', - 'example' => '10', - ], - 'EngineConfigs' => [ - 'description' => '', + 'RequestId' => ['title' => 'Id of the request', 'description' => 'The request ID.', 'type' => 'string', 'example' => 'BBD41FBF-E75C-551A-92FA-CAD654AA006F'], + ], + 'example' => '', + ], + ], + ], + 'staticInfo' => ['returnType' => 'synchronous'], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"BBD41FBF-E75C-551A-92FA-CAD654AA006F\\"\\n}","type":"json"}]', + 'title' => 'Update Parameter', + 'changeSet' => [], + 'flowControl' => [ + 'flowControlList' => [], + ], + 'ramActions' => [ + [ + 'operationType' => 'update', + 'ramAction' => [ + 'action' => 'pairec:UpdateParam', + 'authLevel' => 'operate', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'PAIRecService', 'resourceType' => 'All Resource', 'arn' => '*'], + ], + ], + ], + ], + ], + 'UpdateRecallManagementConfig' => [ + 'path' => '/api/v1/recallmanagementconfigs', + 'methods' => ['put'], + 'schemes' => ['https'], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'consumes' => ['application/json'], + 'produces' => ['application/json'], + 'operationType' => 'readAndWrite', + 'deprecated' => false, + 'systemTags' => [ + 'operationType' => 'none', + 'riskType' => 'none', + 'chargeType' => 'free', + 'abilityTreeNodes' => ['FEATURElearnN0NAWV'], + ], + 'parameters' => [ + [ + 'name' => 'body', + 'in' => 'body', + 'style' => 'json', + 'schema' => [ + 'description' => 'The request body.', + 'type' => 'object', + 'properties' => [ + 'InstanceId' => ['description' => 'The ID of the instance.', 'type' => 'string', 'required' => false, 'example' => '1', 'title' => ''], + 'Password' => ['description' => 'The password.', 'type' => 'string', 'required' => false, 'example' => '12345', 'title' => ''], + 'NetworkConfigs' => [ + 'description' => 'The network configuration.', 'type' => 'array', 'items' => [ + 'description' => 'The settings for a network, including its VPC ID and VSwitches.', 'type' => 'object', 'properties' => [ - 'EngineConfigId' => [ - 'description' => '', - 'type' => 'string', - 'example' => '2', - ], - 'Name' => [ - 'description' => '', - 'type' => 'string', - 'example' => 'engine_config_v1', - ], - 'ConfigValue' => [ - 'description' => '', - 'type' => 'string', - 'example' => '{}', - ], - 'Environment' => [ - 'description' => '', - 'type' => 'string', - 'example' => 'Pre', - ], - 'Version' => [ - 'description' => '', - 'type' => 'string', - 'example' => '20230509161300', - ], - 'Status' => [ - 'description' => '', - 'type' => 'string', - 'example' => 'Released', - ], - 'GmtCreateTime' => [ - 'description' => '', - 'type' => 'string', - 'example' => '2023-08-07T01:43:42Z', - ], - 'GmtModifiedTime' => [ - 'description' => '', - 'type' => 'string', - 'example' => '2023-08-27T12:00:00Z', - ], - 'GmtReleasedTime' => [ - 'description' => '', - 'type' => 'string', - 'example' => '2023-08-29 12:00:00', - ], - 'Description' => [ - 'type' => 'string', + 'VpcId' => ['description' => 'The ID of the VPC.', 'type' => 'string', 'required' => false, 'example' => 'vpc-xxx', 'title' => ''], + 'VswitchIds' => [ + 'description' => 'A map of availability zones to VSwitch IDs.', + 'additionalProperties' => ['description' => 'The ID of the VSwitch.', 'type' => 'string', 'example' => 'vsw-xxx', 'title' => ''], + 'type' => 'object', + 'required' => false, + 'example' => 'cn-hangzhou', + 'title' => '', ], ], + 'required' => false, + 'title' => '', + 'example' => '', ], + 'required' => false, + 'title' => '', + 'example' => '', ], ], + 'required' => false, + 'title' => '', + 'example' => '', ], ], ], - 'staticInfo' => [ - 'returnType' => 'synchronous', - ], - 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"74D958EF-3598-56FA-8296-FF1575CE43DF\\",\\n \\"TotalCount\\": 10,\\n \\"EngineConfigs\\": [\\n {\\n \\"EngineConfigId\\": \\"2\\",\\n \\"Name\\": \\"engine_config_v1\\",\\n \\"ConfigValue\\": \\"{}\\",\\n \\"Environment\\": \\"Pre\\",\\n \\"Version\\": \\"20230509161300\\",\\n \\"Status\\": \\"Released\\",\\n \\"GmtCreateTime\\": \\"2023-08-07T01:43:42Z\\",\\n \\"GmtModifiedTime\\": \\"2023-08-27T12:00:00Z\\",\\n \\"GmtReleasedTime\\": \\"2023-08-29 12:00:00\\",\\n \\"Description\\": \\"\\"\\n }\\n ]\\n}","type":"json"}]', - ], - 'GetEngineConfig' => [ - 'summary' => '获取引擎配置详细信息。', - 'path' => '/api/v1/engineconfigs/{EngineConfigId}', - 'methods' => [ - 'get', + 'responses' => [ + 200 => [ + 'schema' => [ + 'description' => 'The response body.', + 'title' => 'Schema of Response', + 'type' => 'object', + 'properties' => [ + 'RequestId' => ['title' => 'Id of the request', 'description' => 'The request ID.', 'type' => 'string', 'example' => '728C5E01-ABF6-5AA8-B9FC-B3BA05DECC77'], + ], + 'example' => '', + ], + ], ], - 'schemes' => [ - 'http', - 'https', + 'staticInfo' => ['returnType' => 'synchronous'], + 'title' => 'Update Retrieval Management Configuration', + 'summary' => 'Updates the recall management configuration, including the instance ID, password, and network configuration.', + 'description' => '## Request'."\n" + ."\n" + .'- `InstanceId` is required. It specifies the instance to update.'."\n" + ."\n" + .'- `Password` and `NetworkConfigs` are optional.'."\n" + ."\n" + .'- Use `NetworkConfigs` to define the network by specifying the Virtual Private Cloud (VPC) ID (`VpcId`) and mapping availability zones to VSwitch IDs (`VswitchIds`).'."\n" + ."\n" + .'- Note: Ensure that sensitive information, such as the password, is transmitted securely.', + 'changeSet' => [], + 'flowControl' => [ + 'flowControlList' => [], + ], + 'ramActions' => [ + [ + 'operationType' => 'none', + 'ramAction' => [ + 'action' => 'pairec:UpdateRecallManagementConfig', + 'authLevel' => 'operate', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'PAIRecService', 'resourceType' => 'All Resource', 'arn' => '*'], + ], + ], + ], ], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"728C5E01-ABF6-5AA8-B9FC-B3BA05DECC77\\"\\n}","type":"json"}]', + ], + 'UpdateRecallManagementService' => [ + 'summary' => 'Updates the instance ID and description of a specified recall management service.', + 'path' => '/api/v1/recallmanagementservices/{RecallManagementServiceId}', + 'methods' => ['put'], + 'schemes' => ['https'], 'security' => [ [ 'AK' => [], ], ], - 'consumes' => [ - 'application/json', - ], - 'produces' => [ - 'application/json', - ], - 'operationType' => 'read', + 'consumes' => ['application/json'], + 'produces' => ['application/json'], + 'operationType' => 'readAndWrite', 'deprecated' => false, 'systemTags' => [ - 'operationType' => 'get', + 'operationType' => 'update', 'riskType' => 'none', 'chargeType' => 'free', - 'abilityTreeCode' => '180249', - 'abilityTreeNodes' => [ - 'FEATURElearnN0NAWV', - ], + 'abilityTreeNodes' => ['FEATURElearnN0NAWV'], ], 'parameters' => [ [ - 'name' => 'EngineConfigId', + 'name' => 'RecallManagementServiceId', 'in' => 'path', - 'schema' => [ - 'description' => '', - 'type' => 'string', - 'required' => false, - 'example' => '9', - ], + 'schema' => ['description' => 'The ID of the recall management service.', 'type' => 'string', 'required' => false, 'example' => '3', 'title' => ''], ], [ - 'name' => 'InstanceId', - 'in' => 'query', + 'name' => 'body', + 'in' => 'body', + 'style' => 'json', 'schema' => [ - 'description' => '', - 'type' => 'string', + 'type' => 'object', + 'properties' => [ + 'InstanceId' => ['description' => 'The instance ID.', 'type' => 'string', 'required' => false, 'example' => 'pairec-cn-test123', 'title' => ''], + 'Description' => ['description' => 'The description of the recall management service.', 'type' => 'string', 'required' => false, 'example' => 'reso-2s416t146ffjc3yefx', 'title' => ''], + ], + 'description' => 'The request body.', 'required' => false, - 'example' => 'pairec-cn-***test', + 'title' => '', + 'example' => '', ], ], ], 'responses' => [ 200 => [ 'schema' => [ - 'title' => 'Schema of Response', - 'description' => 'Schema of Response', 'type' => 'object', 'properties' => [ - 'RequestId' => [ - 'title' => 'Id of the request', - 'description' => '', - 'type' => 'string', - 'example' => '59CE7EC6-F268-5D71-9215-32922CC50D72', - ], - 'Name' => [ - 'description' => '', - 'type' => 'string', - 'example' => 'engine_config_v1', - ], - 'ConfigValue' => [ - 'description' => '', - 'type' => 'string', - 'example' => '{}', - ], - 'Environment' => [ - 'description' => '', - 'type' => 'string', - 'example' => 'Pre', - ], - 'Status' => [ - 'description' => '', - 'type' => 'string', - 'example' => 'Released', - ], - 'GmtCreateTime' => [ - 'description' => '', - 'type' => 'string', - 'example' => '2024-01-03T02:28:00.000Z', - ], - 'GmtModifiedTime' => [ - 'description' => '', - 'type' => 'string', - 'example' => '2024-08-27T12:00:00Z', - ], - 'GmtReleasedTime' => [ - 'description' => '', - 'type' => 'string', - 'example' => '2024-01-03 02:28:00', - ], - 'Description' => [ - 'type' => 'string', - ], + 'RequestId' => ['description' => 'The request ID.', 'type' => 'string', 'title' => '', 'example' => '728C5E01-ABF6-5AA8-B9FC-B3BA05DECC77'], ], + 'title' => '', + 'description' => 'The response object.', + 'example' => '', ], ], ], - 'staticInfo' => [ - 'returnType' => 'synchronous', + 'staticInfo' => ['returnType' => 'synchronous'], + 'title' => 'UpdateRecallManagementService', + 'description' => '## Request description'."\n" + ."\n" + .'This operation updates the instance ID and description of a specific recall management service. Make sure to specify the `InstanceId` and `Description` fields in the request body.'."\n" + ."\n" + .'- **RecallManagementServiceId**: The unique identifier of the recall management service.'."\n" + ."\n" + .'- **InstanceId**: The instance ID to associate with this recall management service.'."\n" + ."\n" + .'- **Description**: A new description for the recall management service.'."\n" + ."\n" + .'Note: You must provide all required parameters, or the update may fail.', + 'changeSet' => [], + 'flowControl' => [ + 'flowControlList' => [], + ], + 'ramActions' => [ + [ + 'operationType' => 'update', + 'ramAction' => [ + 'action' => 'pairec:UpdateRecallManagementService', + 'authLevel' => 'operate', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'PAIRecService', 'resourceType' => 'All Resource', 'arn' => '*'], + ], + ], + ], ], - 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"59CE7EC6-F268-5D71-9215-32922CC50D72\\",\\n \\"Name\\": \\"engine_config_v1\\",\\n \\"ConfigValue\\": \\"{}\\",\\n \\"Environment\\": \\"Pre\\",\\n \\"Status\\": \\"Released\\",\\n \\"GmtCreateTime\\": \\"2024-01-03T02:28:00.000Z\\",\\n \\"GmtModifiedTime\\": \\"2024-08-27T12:00:00Z\\",\\n \\"GmtReleasedTime\\": \\"2024-01-03 02:28:00\\",\\n \\"Description\\": \\"\\"\\n}","type":"json"}]', + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"728C5E01-ABF6-5AA8-B9FC-B3BA05DECC77\\"\\n}","type":"json"}]', ], - 'CreateEngineConfig' => [ - 'summary' => '创建引擎配置', - 'path' => '/api/v1/engineconfigs', - 'methods' => [ - 'post', - ], - 'schemes' => [ - 'http', - 'https', - ], + 'UpdateRecallManagementServiceVersionConfig' => [ + 'path' => '/api/v1/recallmanagementservices/{RecallManagementServiceId}/versions/{RecallManagementServiceVersionId}/configs/{RecallManagementServiceVersionConfigId}', + 'methods' => ['put'], + 'schemes' => ['https'], 'security' => [ [ 'AK' => [], ], ], - 'consumes' => [ - 'application/json', - ], - 'produces' => [ - 'application/json', - ], + 'consumes' => ['application/json'], + 'produces' => ['application/json'], 'operationType' => 'readAndWrite', 'deprecated' => false, 'systemTags' => [ - 'operationType' => 'create', + 'operationType' => 'none', 'riskType' => 'none', 'chargeType' => 'free', - 'abilityTreeCode' => '180238', - 'abilityTreeNodes' => [ - 'FEATURElearnN0NAWV', - ], + 'abilityTreeNodes' => ['FEATURElearnN0NAWV'], ], 'parameters' => [ [ + 'name' => 'RecallManagementServiceId', + 'in' => 'path', + 'schema' => ['description' => 'The ID of the Recall Management Service.', 'type' => 'string', 'required' => false, 'example' => '3', 'title' => ''], + ], + [ + 'name' => 'RecallManagementServiceVersionId', + 'in' => 'path', + 'schema' => ['description' => 'The ID of the Recall Management Service version.', 'type' => 'string', 'required' => false, 'example' => '2', 'title' => ''], + ], + [ + 'name' => 'RecallManagementServiceVersionConfigId', + 'in' => 'path', + 'schema' => ['description' => 'The ID of the Recall Management Service version configuration.', 'type' => 'string', 'required' => false, 'example' => '3', 'title' => ''], + ], + [ 'name' => 'body', 'in' => 'body', 'style' => 'json', 'schema' => [ - 'description' => '', 'type' => 'object', 'properties' => [ - 'Name' => [ - 'description' => '', - 'type' => 'string', - 'required' => false, - 'example' => 'engine_config_v1', - ], - 'ConfigValue' => [ - 'description' => '', - 'type' => 'string', - 'required' => false, - 'example' => '{}', - ], - 'Environment' => [ - 'description' => '', - 'type' => 'string', + 'InstanceId' => ['description' => 'The instance ID.', 'type' => 'string', 'required' => false, 'example' => 'pairec-cn-test123', 'title' => ''], + 'ConfigType' => ['description' => 'The type of the recall management version configuration. Valid values are `Recall` for the recall configuration and `Merge` for the merge configuration.', 'type' => 'string', 'required' => false, 'example' => 'Recall', 'title' => ''], + 'RecallConfig' => [ + 'type' => 'object', + 'properties' => [ + 'Name' => ['description' => 'The recall name.', 'type' => 'string', 'required' => false, 'example' => 'etrec', 'title' => ''], + 'Description' => ['description' => 'The recall description.', 'type' => 'string', 'required' => false, 'example' => 'this is etrec recall', 'title' => ''], + 'Priority' => ['description' => 'The priority. A smaller value indicates a higher priority.', 'type' => 'integer', 'format' => 'int64', 'required' => false, 'example' => '2', 'title' => ''], + 'RecallType' => ['description' => 'The recall type.', 'type' => 'string', 'required' => false, 'example' => 'X2I', 'title' => ''], + 'RecallManagementTableId' => ['description' => 'The ID of the recall management table.', 'type' => 'string', 'required' => false, 'example' => '1', 'title' => ''], + 'UserVectorRecallManagementTableId' => ['description' => 'The ID of the user vector recall management table.', 'type' => 'string', 'required' => false, 'example' => '3', 'title' => ''], + 'UserVectorField' => ['description' => 'The user vector field.', 'type' => 'string', 'required' => false, 'example' => 'user_embedding', 'title' => ''], + 'ItemVectorRecallManagementTableId' => ['description' => 'The ID of the item vector recall management table.', 'type' => 'string', 'required' => false, 'example' => '2', 'title' => ''], + 'ItemVectorField' => ['description' => 'The item vector field.', 'type' => 'string', 'required' => false, 'example' => 'item_embedding', 'title' => ''], + 'ItemConditionArray' => ['description' => 'The data format of the item condition.', 'type' => 'string', 'example' => '["type":"equal"]', 'title' => '', 'required' => false], + 'ItemConditionExpression' => ['description' => 'The item condition expression.', 'type' => 'string', 'example' => 'age>20', 'title' => '', 'required' => false], + 'SortFields' => ['description' => 'The sort fields.', 'type' => 'string', 'required' => false, 'example' => 'name', 'title' => ''], + 'Operators' => [ + 'type' => 'array', + 'items' => [ + 'type' => 'object', + 'properties' => [ + 'OperatorType' => ['description' => 'The operator type.', 'type' => 'string', 'example' => 'Filter', 'title' => '', 'required' => false], + 'TriggerConfig' => [ + 'type' => 'object', + 'properties' => [ + 'Field' => ['description' => 'The field name.', 'type' => 'string', 'required' => false, 'example' => 'user_id', 'title' => ''], + 'IsRandSort' => ['description' => 'Specifies whether to perform a random sort.', 'type' => 'boolean', 'title' => '', 'required' => false, 'example' => 'false'], + 'SortField' => ['description' => 'The sort field.', 'type' => 'string', 'required' => false, 'example' => 'create_time', 'title' => ''], + 'FieldQuantityLimit' => ['description' => 'The maximum number of fields.', 'type' => 'integer', 'format' => 'int32', 'required' => false, 'example' => '20', 'title' => ''], + ], + 'description' => 'The configuration for the `Trigger` operator.', + 'required' => false, + 'title' => '', + 'example' => '', + ], + 'FilterConfig' => [ + 'type' => 'object', + 'properties' => [ + 'Experession' => ['description' => 'The filter expression.', 'type' => 'string', 'required' => false, 'example' => 'age>20', 'title' => ''], + ], + 'description' => 'The configuration for the `Filter` operator.', + 'required' => false, + 'title' => '', + 'example' => '', + ], + 'FeatureConfig' => [ + 'type' => 'object', + 'properties' => [ + 'Name' => ['description' => 'The feature name.', 'type' => 'string', 'required' => false, 'example' => 'city', 'title' => ''], + 'Type' => ['description' => 'The feature type.', 'type' => 'string', 'required' => false, 'example' => 'string', 'title' => ''], + 'Expression' => ['description' => 'The feature expression.', 'type' => 'string', 'required' => false, 'example' => 'category=3', 'title' => ''], + ], + 'description' => 'The configuration for the `Feature` operator.', + 'required' => false, + 'title' => '', + 'example' => '', + ], + 'JoinConfig' => [ + 'type' => 'object', + 'properties' => [ + 'Field' => ['description' => 'The join field.', 'type' => 'string', 'required' => false, 'example' => 'item_id', 'title' => ''], + 'RecallManagementTableId' => ['description' => 'The ID of the table to join.', 'type' => 'string', 'required' => false, 'example' => '3', 'title' => ''], + 'OutputFields' => [ + 'type' => 'array', + 'items' => ['description' => 'An output field.', 'type' => 'string', 'example' => 'age', 'title' => '', 'required' => false], + 'title' => '', + 'description' => 'The fields to return from the join.', + 'required' => false, + 'example' => '', + ], + ], + 'description' => 'The configuration for the `Join` operator.', + 'required' => false, + 'title' => '', + 'example' => '', + ], + ], + 'description' => 'The operator details.', + 'required' => false, + 'title' => '', + 'example' => '', + ], + 'description' => 'A list of operators.', + 'required' => false, + 'title' => '', + 'example' => '', + ], + 'ExtendedConfig' => ['description' => 'The extended configuration. Reserved for future use.', 'type' => 'string', 'required' => false, 'example' => '{"":""}', 'title' => ''], + ], + 'description' => 'The recall configuration.', 'required' => false, - 'example' => 'Pre', + 'title' => '', + 'example' => '', ], - 'InstanceId' => [ - 'description' => '', - 'type' => 'string', + 'MergeConfig' => [ + 'type' => 'object', + 'properties' => [ + 'RecallManagementServiceVersionConfigId' => ['description' => 'The ID of the recall management service version configuration.', 'type' => 'string', 'example' => '4', 'title' => '', 'required' => false], + 'MergeType' => ['description' => 'The merge type. Valid values: `Weight` and `Alternate`.', 'type' => 'string', 'required' => false, 'example' => 'Weight', 'title' => ''], + 'FilterRecallManagementTableIds' => [ + 'type' => 'array', + 'items' => ['description' => 'A recall management table ID to use for filtering.', 'type' => 'string', 'required' => false, 'example' => '3', 'title' => ''], + 'description' => 'A list of recall management table IDs to use for filtering.', + 'required' => false, + 'title' => '', + 'example' => '', + ], + 'ItemRecallManagementTableId' => ['description' => 'The ID of the item recall management table.', 'type' => 'string', 'required' => false, 'example' => '2', 'title' => ''], + 'ItemTableFields' => [ + 'type' => 'array', + 'items' => ['description' => 'An output field from the item table.', 'type' => 'string', 'required' => false, 'example' => 'item_id', 'title' => ''], + 'description' => 'The output fields from the item table.', + 'required' => false, + 'title' => '', + 'example' => '', + ], + 'FilterExpression' => ['description' => 'The filter expression.', 'type' => 'string', 'required' => false, 'example' => 'age>20', 'title' => ''], + 'ExtendedConfig' => ['description' => 'Additional configurations for the merge. Reserved for future use.', 'type' => 'string', 'required' => false, 'example' => '{"":""}', 'title' => ''], + ], + 'description' => 'The merge configuration.', 'required' => false, - 'example' => 'pairec-cn-***test', - ], - 'Description' => [ - 'type' => 'string', + 'title' => '', + 'example' => '', ], ], + 'description' => 'The request body.', 'required' => false, + 'title' => '', + 'example' => '', ], ], ], 'responses' => [ 200 => [ 'schema' => [ - 'title' => 'Schema of Response', - 'description' => 'Schema of Response', 'type' => 'object', 'properties' => [ - 'RequestId' => [ - 'title' => 'Id of the request', - 'description' => '', - 'type' => 'string', - 'example' => 'E15A1443-7917-5BE0-AE70-25538ECF398D', - ], - 'EngineConfigId' => [ - 'description' => '', - 'type' => 'string', - 'example' => '1', - ], + 'RequestId' => ['description' => 'The request ID.', 'type' => 'string', 'title' => '', 'example' => '728C5E01-ABF6-5AA8-B9FC-B3BA05DECC77'], ], + 'title' => '', + 'description' => 'The response object.', + 'example' => '', ], ], ], - 'staticInfo' => [ - 'returnType' => 'synchronous', + 'staticInfo' => ['returnType' => 'synchronous'], + 'title' => 'UpdateRecallManagementServiceVersionConfig', + 'summary' => 'Updates the configuration of a specific Recall Management Service version.', + 'description' => '## Request'."\n" + ."\n" + .'This API updates the recall and merge configurations for a specific recall management service version. Your request must include the correct `InstanceId` and the configurations to update. Refer to the parameter descriptions for details on required parameters.', + 'changeSet' => [], + 'flowControl' => [ + 'flowControlList' => [], ], - 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"E15A1443-7917-5BE0-AE70-25538ECF398D\\",\\n \\"EngineConfigId\\": \\"1\\"\\n}","type":"json"}]', - ], - 'CloneEngineConfig' => [ - 'summary' => '克隆指定的推荐引擎配置', - 'path' => '/api/v1/engineconfigs/{EngineConfigId}/action/clone', - 'methods' => [ - 'post', - ], - 'schemes' => [ - 'http', - 'https', + 'ramActions' => [ + [ + 'operationType' => 'none', + 'ramAction' => [ + 'action' => 'pairec:UpdateRecallManagementServiceVersionConfig', + 'authLevel' => 'operate', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'PAIRecService', 'resourceType' => 'All Resource', 'arn' => '*'], + ], + ], + ], ], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"728C5E01-ABF6-5AA8-B9FC-B3BA05DECC77\\"\\n}","type":"json"}]', + ], + 'UpdateRecallManagementTable' => [ + 'summary' => 'Updates the configuration of a recall management table specified by its ID.', + 'path' => '/api/v1/recallmanagementtables/{RecallManagementTableId}', + 'methods' => ['put'], + 'schemes' => ['https'], 'security' => [ [ 'AK' => [], ], ], - 'consumes' => [ - 'application/json', - ], - 'produces' => [ - 'application/json', - ], + 'consumes' => ['application/json'], + 'produces' => ['application/json'], 'operationType' => 'readAndWrite', 'deprecated' => false, 'systemTags' => [ - 'operationType' => 'none', + 'operationType' => 'update', 'riskType' => 'none', 'chargeType' => 'free', - 'abilityTreeCode' => '180296', - 'abilityTreeNodes' => [ - 'FEATURElearnN0NAWV', - ], + 'abilityTreeNodes' => ['FEATURElearnN0NAWV'], ], 'parameters' => [ [ - 'name' => 'EngineConfigId', + 'name' => 'RecallManagementTableId', 'in' => 'path', - 'schema' => [ - 'description' => '', - 'type' => 'string', - 'required' => false, - 'example' => '1', - ], + 'schema' => ['description' => 'The ID of the recall management table.', 'type' => 'string', 'required' => true, 'example' => '3', 'title' => ''], ], [ 'name' => 'body', 'in' => 'body', 'style' => 'json', 'schema' => [ - 'description' => '', 'type' => 'object', 'properties' => [ - 'ConfigValue' => [ - 'description' => '', - 'type' => 'string', - 'required' => false, - 'example' => '{}', - ], - 'InstanceId' => [ - 'description' => '', - 'type' => 'string', - 'required' => false, - 'example' => 'pairec-cn-********', - ], - 'Environment' => [ - 'description' => '', - 'type' => 'string', + 'InstanceId' => ['description' => 'The instance ID.', 'type' => 'string', 'required' => true, 'example' => 'pairec-cn-test123', 'title' => ''], + 'EnableRowCountFluctuationThreshold' => ['description' => 'Specifies whether to enable the row count fluctuation threshold.', 'type' => 'boolean', 'required' => false, 'example' => 'true', 'title' => ''], + 'MinRowCountFluctuationThreshold' => ['description' => 'The minimum value for the row count fluctuation threshold.', 'type' => 'integer', 'format' => 'int32', 'required' => false, 'example' => '10', 'title' => ''], + 'MaxRowCountFluctuationThreshold' => ['description' => 'The maximum value for the row count fluctuation threshold.', 'type' => 'integer', 'format' => 'int32', 'required' => false, 'example' => '100', 'title' => ''], + 'EnableDataSizeFluctuationThreshold' => ['description' => 'Specifies whether to enable the data size fluctuation threshold.', 'type' => 'boolean', 'required' => false, 'example' => 'true', 'title' => ''], + 'MinDataSizeFluctuationThreshold' => ['description' => 'The minimum value for the data size fluctuation threshold.', 'type' => 'integer', 'format' => 'int32', 'required' => false, 'example' => '10', 'title' => ''], + 'MaxDataSizeFluctuationThreshold' => ['description' => 'The maximum value for the data size fluctuation threshold.', 'type' => 'integer', 'format' => 'int32', 'required' => false, 'example' => '100', 'title' => ''], + 'IndexVersionId' => ['description' => 'The version ID of the table.', 'type' => 'string', 'required' => false, 'example' => '20250701', 'title' => ''], + 'Fields' => [ + 'type' => 'object', + 'properties' => [ + 'Name' => ['description' => 'The field name.', 'type' => 'string', 'required' => false, 'example' => 'age', 'title' => ''], + 'Type' => ['description' => 'The data type of the field.', 'type' => 'string', 'required' => false, 'example' => 'STRING(全大写)', 'title' => ''], + 'Attributes' => [ + 'type' => 'array', + 'items' => ['description' => 'A field attribute.', 'type' => 'string', 'required' => false, 'example' => 'Primary', 'title' => ''], + 'description' => 'Specifies the role of the field. Valid values:'."\n" + ."\n" + .'- `Primary`: The primary key field.'."\n" + ."\n" + .'- `Item`: The item field.'."\n" + ."\n" + .'- `Score`: The recall score field.'."\n" + ."\n" + .'- `Vector`: The vector field.'."\n" + ."\n" + .'- `Index`: The index field.', + 'required' => false, + 'title' => '', + 'example' => '', + ], + 'VectorDimension' => ['description' => 'The vector dimension.', 'type' => 'integer', 'format' => 'int32', 'required' => false, 'example' => '32', 'title' => ''], + 'VectorMetricType' => ['description' => 'The vector metric type.', 'type' => 'string', 'required' => false, 'example' => 'L2', 'title' => ''], + ], + 'description' => 'A list of fields.', 'required' => false, - 'example' => 'Pre', - ], - 'Description' => [ - 'type' => 'string', + 'title' => '', + 'example' => '', ], ], + 'description' => 'The request body.', 'required' => false, + 'title' => '', + 'example' => '', ], ], ], 'responses' => [ 200 => [ 'schema' => [ - 'title' => 'Schema of Response', - 'description' => 'Schema of Response', 'type' => 'object', 'properties' => [ - 'RequestId' => [ - 'title' => 'Id of the request', - 'description' => '', - 'type' => 'string', - 'example' => 'A04CB8C0-E74A-5E83-BC61-64D153574EC7', - ], - 'EngineConfigId' => [ - 'description' => '', - 'type' => 'string', - 'example' => '2', - ], + 'RequestId' => ['description' => 'The request ID.', 'type' => 'string', 'title' => '', 'example' => '728C5E01-ABF6-5AA8-B9FC-B3BA05DECC77'], ], + 'title' => '', + 'description' => 'The response object.', + 'example' => '', ], ], ], - 'staticInfo' => [ - 'returnType' => 'synchronous', + 'staticInfo' => ['returnType' => 'synchronous'], + 'title' => 'UpdateRecallManagementTable', + 'description' => '## Request details'."\n" + ."\n" + .'- Updates the recall management table specified by `RecallManagementTableId`.'."\n" + ."\n" + .'- You can enable fluctuation thresholds for the row count or data size and define the specific ranges for these thresholds.'."\n" + ."\n" + .'- You can add or modify fields in the table, including their names, types, and attributes.'."\n" + ."\n" + .'- The `InstanceId` parameter is required and identifies the specific instance.'."\n" + ."\n" + .'- For vector-related fields, you can also specify the vector dimension and metric type.'."\n" + ."\n" + .'- Note: Optional parameters in the request body selectively update the target table.', + 'changeSet' => [], + 'flowControl' => [ + 'flowControlList' => [], + ], + 'ramActions' => [ + [ + 'operationType' => 'update', + 'ramAction' => [ + 'action' => 'pairec:UpdateRecallManagementTable', + 'authLevel' => 'operate', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'PAIRecService', 'resourceType' => 'All Resource', 'arn' => '*'], + ], + ], + ], ], - 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"A04CB8C0-E74A-5E83-BC61-64D153574EC7\\",\\n \\"EngineConfigId\\": \\"2\\"\\n}","type":"json"}]', + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"728C5E01-ABF6-5AA8-B9FC-B3BA05DECC77\\"\\n}","type":"json"}]', ], - 'ApplyEngineConfig' => [ - 'summary' => '应用/发布指定的推荐引擎配置', - 'path' => '/api/v1/engineconfigs/{EngineConfigId}/action/apply', - 'methods' => [ - 'post', - ], - 'schemes' => [ - 'http', - 'https', - ], + 'UpdateScene' => [ + 'summary' => 'Updates information for a scene, such as its name and description.', + 'path' => '/api/v1/scenes/{SceneId}', + 'methods' => ['put'], + 'schemes' => ['http', 'https'], 'security' => [ [ 'AK' => [], ], ], - 'consumes' => [ - 'application/json', - ], - 'produces' => [ - 'application/json', - ], + 'consumes' => ['application/json'], + 'produces' => ['application/json'], 'operationType' => 'readAndWrite', 'deprecated' => false, 'systemTags' => [ - 'operationType' => 'none', + 'operationType' => 'update', 'riskType' => 'none', 'chargeType' => 'free', - 'abilityTreeCode' => '180295', - 'abilityTreeNodes' => [ - 'FEATURElearnN0NAWV', - ], + 'abilityTreeNodes' => ['FEATURElearnN0NAWV'], ], 'parameters' => [ [ - 'name' => 'EngineConfigId', + 'name' => 'SceneId', 'in' => 'path', - 'schema' => [ - 'description' => '', - 'type' => 'string', - 'required' => false, - 'example' => '2', - ], + 'schema' => ['description' => 'The scene ID. To obtain the ID, call the `ListScenes` API.', 'type' => 'string', 'required' => false, 'example' => '3', 'title' => ''], ], [ - 'name' => 'InstanceId', - 'in' => 'query', + 'name' => 'body', + 'in' => 'body', + 'style' => 'json', 'schema' => [ - 'description' => '', - 'type' => 'string', + 'description' => 'The request body.', + 'type' => 'object', + 'properties' => [ + 'Name' => ['description' => 'The scene name.', 'type' => 'string', 'example' => 'scene1', 'title' => '', 'required' => false], + 'Description' => ['description' => 'The scene description.', 'type' => 'string', 'example' => 'This is a test.', 'title' => '', 'required' => false], + 'InstanceId' => ['description' => 'The instance ID. To obtain the ID, call the `ListInstances` API.', 'type' => 'string', 'required' => false, 'example' => 'pairec-cn-abcdefg1234', 'title' => ''], + 'Flows' => [ + 'title' => '', + 'description' => 'The flows.', + 'type' => 'array', + 'items' => [ + 'type' => 'object', + 'properties' => [ + 'FlowName' => ['description' => 'The flow name.', 'type' => 'string', 'example' => '流量1', 'title' => '', 'required' => false], + 'FlowCode' => ['description' => 'The flow code.', 'type' => 'string', 'example' => 'liuliang1', 'title' => '', 'required' => false], + ], + 'required' => false, + 'description' => '', + 'title' => '', + 'example' => '', + ], + 'required' => false, + 'example' => '', + ], + ], 'required' => false, - 'example' => 'pairec-cn-***test', + 'title' => '', + 'example' => '', ], ], ], @@ -17233,74 +17351,115 @@ 200 => [ 'schema' => [ 'title' => 'Schema of Response', - 'description' => 'Schema of Response', + 'description' => 'The response object.', 'type' => 'object', 'properties' => [ - 'RequestId' => [ - 'title' => 'Id of the request', - 'description' => '', - 'type' => 'string', - 'example' => 'F8F613A9-DF1C-551A-88E1-397A3981A785', - ], + 'RequestId' => ['title' => 'Id of the request', 'description' => 'The request ID.', 'type' => 'string', 'example' => 'FC17887E-3C82-5096-8AA6-F4C2E7417245'], ], + 'example' => '', ], ], ], - 'staticInfo' => [ - 'returnType' => 'synchronous', + 'staticInfo' => ['returnType' => 'synchronous'], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"FC17887E-3C82-5096-8AA6-F4C2E7417245\\"\\n}","type":"json"}]', + 'title' => 'Update Scenario', + 'changeSet' => [], + 'flowControl' => [ + 'flowControlList' => [], + ], + 'ramActions' => [ + [ + 'operationType' => 'update', + 'ramAction' => [ + 'action' => 'pairec:UpdateScene', + 'authLevel' => 'operate', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'PAIRecService', 'resourceType' => 'All Resource', 'arn' => '*'], + ], + ], + ], ], - 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"F8F613A9-DF1C-551A-88E1-397A3981A785\\"\\n}","type":"json"}]', ], - 'GetService' => [ - 'summary' => '获取服务详细信息。', - 'path' => '/api/v1/services/{ServiceId}', - 'methods' => [ - 'get', - ], - 'schemes' => [ - 'http', - 'https', - ], + 'UpdateTableMeta' => [ + 'summary' => 'Updates a data table.', + 'path' => '/api/v1/tablemetas/{TableMetaId}', + 'methods' => ['put'], + 'schemes' => ['http', 'https'], 'security' => [ [ 'AK' => [], ], ], - 'consumes' => [ - 'application/json', - ], - 'produces' => [ - 'application/json', - ], - 'operationType' => 'read', + 'consumes' => ['application/json'], + 'produces' => ['application/json'], + 'operationType' => 'readAndWrite', 'deprecated' => false, 'systemTags' => [ - 'operationType' => 'get', + 'operationType' => 'update', 'riskType' => 'none', 'chargeType' => 'free', - 'abilityTreeNodes' => [ - 'FEATURElearnN0NAWV', - ], + 'abilityTreeNodes' => ['FEATURElearnN0NAWV'], ], 'parameters' => [ [ - 'name' => 'ServiceId', + 'name' => 'TableMetaId', 'in' => 'path', - 'schema' => [ - 'description' => '', - 'type' => 'string', - 'required' => false, - 'example' => '1', - ], + 'schema' => ['description' => 'The table meta ID.', 'type' => 'string', 'required' => true, 'example' => '1', 'title' => ''], ], [ - 'name' => 'InstanceId', - 'in' => 'query', + 'name' => 'body', + 'in' => 'body', + 'style' => 'json', 'schema' => [ - 'description' => '', - 'type' => 'string', + 'description' => 'The request body.', + 'type' => 'object', + 'properties' => [ + 'Name' => ['description' => 'The name of the data table.', 'type' => 'string', 'required' => true, 'example' => 'table_test', 'title' => ''], + 'ResourceId' => ['description' => 'The resource ID. You can call the [ListInstanceResource](~~2672886~~) operation to obtain the resource ID.', 'type' => 'string', 'required' => true, 'example' => 'reso-2s416t***', 'title' => ''], + 'TableName' => ['description' => 'The name of the table in the database.', 'type' => 'string', 'required' => true, 'example' => 'table_mysql', 'title' => ''], + 'Module' => ['description' => 'The module to which the data table belongs.'."\n" + ."\n" + .'- ABTest: a data table for A/B testing.'."\n" + ."\n" + .'- ExperimentTool: a data table for experiment tools.'."\n" + ."\n" + .'- DataDiagnosis: a data table for data diagnosis.', 'type' => 'string', 'required' => true, 'example' => 'ABTest', 'title' => ''], + 'InstanceId' => ['description' => 'The instance ID. You can call the [ListInstances](~~2411819~~) operation to obtain the instance ID.', 'type' => 'string', 'required' => true, 'example' => 'pairec-cn-test1', 'title' => ''], + 'Fields' => [ + 'description' => 'The fields of the data table.', + 'type' => 'array', + 'items' => [ + 'description' => 'The information about the field.', + 'type' => 'object', + 'properties' => [ + 'Name' => ['description' => 'The field name.', 'type' => 'string', 'required' => true, 'example' => 'name', 'title' => ''], + 'Meaning' => ['description' => 'The business meaning of the field.', 'type' => 'string', 'required' => true, 'example' => '名称字段', 'title' => ''], + 'Type' => ['description' => 'The data type of the field.', 'type' => 'string', 'required' => true, 'example' => 'BIGINT', 'title' => ''], + 'IsDimensionField' => ['description' => 'Indicates whether the field is a dimension field.', 'type' => 'boolean', 'required' => true, 'example' => 'false', 'title' => ''], + 'DataType' => [ + 'description' => 'The data type of the field.', + 'enumValueTitles' => ['number' => 'a number.', 'image' => 'an image.', 'text' => 'text.', 'video' => 'a video.', 'primary_key' => 'a primary key.', 'url' => 'a URL.'], + 'type' => 'string', + 'required' => false, + 'example' => 'primary_key', + 'title' => '', + ], + 'IsPartitionField' => ['description' => 'Indicates whether the field is a partition field.', 'type' => 'string', 'required' => true, 'example' => 'true', 'title' => ''], + ], + 'required' => false, + 'title' => '', + 'example' => '', + ], + 'required' => true, + 'title' => '', + 'example' => '', + ], + 'Description' => ['description' => 'The description of the data table.', 'type' => 'string', 'required' => false, 'example' => 'this is a test table', 'title' => ''], + ], 'required' => false, - 'example' => 'pairec-test-xxx', + 'title' => '', + 'example' => '', ], ], ], @@ -17308,426 +17467,2667 @@ 200 => [ 'schema' => [ 'title' => 'Schema of Response', - 'description' => 'Schema of Response', + 'description' => 'The response schema.', 'type' => 'object', 'properties' => [ - 'RequestId' => [ - 'title' => 'Id of the request', - 'description' => '', - 'type' => 'string', - 'example' => 'D75C43DC-3D3A-5CC8-9AAC-8C77306C433B', - ], - 'Name' => [ - 'description' => '', - 'type' => 'string', - 'example' => 'test_rec', - ], - 'Description' => [ - 'description' => '', - 'type' => 'string', - 'example' => 'this is a test rec engine', - ], - 'Region' => [ - 'description' => '', - 'type' => 'string', - 'example' => 'cn-beijing', - ], - 'EngineConfigId' => [ - 'description' => '', - 'type' => 'string', - 'example' => '3', - ], - 'ImageName' => [ - 'description' => '', - 'type' => 'string', - 'example' => 'registry-vpc.cn-beijing.aliyuncs.com/***/***', - ], - 'ImageAuth' => [ - 'description' => '', - 'type' => 'string', - 'example' => '********', - ], - 'ServiceResourceUri' => [ - 'description' => '', - 'type' => 'string', - 'example' => 'eas-resource-xxx', - ], - 'ServiceConfig' => [ - 'description' => '', - 'type' => 'string', - 'example' => '{"Port":8080}', - ], - 'GmtReleasedTime' => [ - 'description' => '', - 'type' => 'string', - 'example' => '2021-12-15T23:24:33.132+08:00', - ], - 'LatestProdReleaseOrder' => [ - 'description' => '', - 'type' => 'object', - 'properties' => [ - 'ReleaseOrderId' => [ - 'description' => '', - 'type' => 'string', - 'example' => '3', - ], - 'Topic' => [ - 'description' => '', - 'type' => 'string', - 'example' => 'update version', - ], - 'Content' => [ - 'description' => '', - 'type' => 'string', - 'example' => 'update golang version to 1.22', - ], - 'ImageVersion' => [ - 'description' => '', - 'type' => 'string', - 'example' => '2.0.0', - ], - 'Releaser' => [ - 'description' => '', - 'type' => 'string', - 'example' => 'E-xxx.xxx-@xxx.onaliyun.com', - ], - 'ReleaseInfo' => [ - 'description' => '', - 'type' => 'string', - 'example' => '{'."\n" - .' "Pre": {'."\n" - .' "Status": "Released",'."\n" - .' "GmtReleasedTime" : "2021-12-15T23:24:33.132+08:00",'."\n" - .' },'."\n" - .' "Prod": {'."\n" - .' "Status": "Released",'."\n" - .' "GmtReleasedTime" : "2021-12-15T23:24:33.132+08:00",'."\n" - .' }'."\n" - .'}', - ], - ], - ], + 'RequestId' => ['title' => 'Id of the request', 'description' => 'The request ID.', 'type' => 'string', 'example' => '728C5E01-ABF6-5AA8-B9FC-B3BA05DECC77'], ], + 'example' => '', ], ], ], - 'staticInfo' => [ - 'returnType' => 'synchronous', + 'staticInfo' => ['returnType' => 'synchronous'], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"728C5E01-ABF6-5AA8-B9FC-B3BA05DECC77\\"\\n}","type":"json"}]', + 'title' => 'Update Data Table', + 'changeSet' => [ + ['createdAt' => '2024-02-22T03:35:43.000Z', 'description' => 'Request parameters changed'], + ], + 'flowControl' => [ + 'flowControlList' => [], + ], + 'ramActions' => [ + [ + 'operationType' => 'update', + 'ramAction' => [ + 'action' => 'pairec:UpdateTableMeta', + 'authLevel' => 'operate', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'PAIRecService', 'resourceType' => 'All Resource', 'arn' => '*'], + ], + ], + ], ], - 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"D75C43DC-3D3A-5CC8-9AAC-8C77306C433B\\",\\n \\"Name\\": \\"test_rec\\",\\n \\"Description\\": \\"this is a test rec engine\\",\\n \\"Region\\": \\"cn-beijing\\",\\n \\"EngineConfigId\\": \\"3\\",\\n \\"ImageName\\": \\"registry-vpc.cn-beijing.aliyuncs.com/***/***\\",\\n \\"ImageAuth\\": \\"********\\",\\n \\"ServiceResourceUri\\": \\"eas-resource-xxx\\",\\n \\"ServiceConfig\\": \\"{\\\\\\"Port\\\\\\":8080}\\",\\n \\"GmtReleasedTime\\": \\"2021-12-15T23:24:33.132+08:00\\",\\n \\"LatestProdReleaseOrder\\": {\\n \\"ReleaseOrderId\\": \\"3\\",\\n \\"Topic\\": \\"update version\\",\\n \\"Content\\": \\"update golang version to 1.22\\",\\n \\"ImageVersion\\": \\"2.0.0\\",\\n \\"Releaser\\": \\"E-xxx.xxx-@xxx.onaliyun.com\\",\\n \\"ReleaseInfo\\": \\"{\\\\n\\\\t\\\\\\"Pre\\\\\\": {\\\\n \\\\\\"Status\\\\\\": \\\\\\"Released\\\\\\",\\\\n \\\\\\"GmtReleasedTime\\\\\\" : \\\\\\"2021-12-15T23:24:33.132+08:00\\\\\\",\\\\n },\\\\n \\\\\\"Prod\\\\\\": {\\\\n \\\\\\"Status\\\\\\": \\\\\\"Released\\\\\\",\\\\n \\\\\\"GmtReleasedTime\\\\\\" : \\\\\\"2021-12-15T23:24:33.132+08:00\\\\\\",\\\\n }\\\\n}\\"\\n }\\n}","type":"json"}]', ], - 'GetTrafficControlTaskTraffic' => [ - 'summary' => '获取流量调控任务的流量详情', - 'path' => '/api/v1/trafficcontroltasks/{TrafficControlTaskId}/trafficinfo', - 'methods' => [ - 'get', - ], - 'schemes' => [ - 'http', - 'https', - ], + 'UpdateTrafficControlTarget' => [ + 'path' => '/api/v1/trafficcontroltargets/{TrafficControlTargetId}', + 'methods' => ['put'], + 'schemes' => ['http', 'https'], 'security' => [ [ 'AK' => [], ], ], - 'consumes' => [ - 'application/json', - ], - 'produces' => [ - 'application/json', - ], - 'operationType' => 'read', + 'consumes' => ['application/json'], + 'produces' => ['application/json'], + 'operationType' => 'readAndWrite', 'deprecated' => false, 'systemTags' => [ - 'operationType' => 'none', + 'operationType' => 'update', 'riskType' => 'none', 'chargeType' => 'free', - 'abilityTreeCode' => '220416', - 'abilityTreeNodes' => [ - 'FEATURElearnN0NAWV', - ], + 'abilityTreeCode' => '220595', + 'abilityTreeNodes' => ['FEATURElearnN0NAWV'], ], 'parameters' => [ [ - 'name' => 'TrafficControlTaskId', + 'name' => 'TrafficControlTargetId', 'in' => 'path', - 'schema' => [ - 'description' => '', - 'type' => 'string', - 'required' => false, - 'example' => '1', - ], + 'schema' => ['description' => 'The traffic control target ID.', 'type' => 'string', 'required' => false, 'example' => '1', 'title' => ''], ], [ - 'name' => 'InstanceId', - 'in' => 'query', + 'name' => 'body', + 'in' => 'body', + 'style' => 'json', 'schema' => [ - 'description' => '', - 'type' => 'string', + 'description' => 'The request body.', + 'type' => 'object', + 'properties' => [ + 'Name' => ['description' => 'The traffic control target name.', 'type' => 'string', 'required' => false, 'example' => 'target-1', 'title' => ''], + 'StartTime' => ['description' => 'The start time of the traffic control target.', 'type' => 'string', 'required' => false, 'example' => '2024-03-25', 'title' => ''], + 'EndTime' => ['description' => 'The end time of the traffic control target.', 'type' => 'string', 'required' => false, 'example' => '2024-04-25', 'title' => ''], + 'ItemConditionType' => ['description' => 'The item condition type.', 'type' => 'string', 'required' => false, 'example' => 'Array', 'title' => ''], + 'ItemConditionArray' => ['description' => 'The item condition in array format.', 'type' => 'string', 'required' => false, 'example' => '[{"field":"status","option":"=","value":"1"}]', 'title' => ''], + 'ItemConditionExpress' => ['description' => 'The item condition in expression format.', 'type' => 'string', 'required' => false, 'example' => 'status=1', 'title' => ''], + 'Event' => ['description' => 'The event for the traffic control target.', 'type' => 'string', 'required' => false, 'example' => 'click', 'title' => ''], + 'Value' => ['description' => 'The traffic control target value.', 'type' => 'number', 'format' => 'float', 'required' => false, 'example' => '30', 'title' => ''], + 'StatisPeriod' => ['description' => 'The statistics period.', 'type' => 'string', 'required' => false, 'example' => 'Daily', 'title' => ''], + 'ToleranceValue' => ['description' => 'The tolerance range for the traffic control target.', 'type' => 'integer', 'format' => 'int64', 'required' => false, 'example' => '10', 'title' => ''], + 'RecallName' => ['description' => 'The recall strategy name.', 'type' => 'string', 'required' => false, 'example' => 'recall-1', 'title' => ''], + 'Status' => ['description' => 'The traffic control target status.', 'type' => 'string', 'required' => false, 'example' => 'Opened', 'title' => ''], + 'NewProductRegulation' => ['description' => 'Specifies whether the control rule applies to a new product.', 'type' => 'boolean', 'required' => false, 'example' => 'false', 'title' => ''], + ], 'required' => false, - 'example' => 'pairec-test-xxx', + 'title' => '', + 'example' => '', ], ], [ - 'name' => 'Environment', + 'name' => 'new-param-3', 'in' => 'query', - 'schema' => [ - 'description' => '', - 'type' => 'string', - 'required' => false, - 'example' => 'Pre', - ], + 'schema' => ['description' => 'This parameter is invalid.', 'type' => 'string', 'required' => false, 'example' => 'null', 'title' => ''], ], ], 'responses' => [ 200 => [ 'schema' => [ + 'description' => 'The response body.', 'title' => 'Schema of Response', - 'description' => 'Schema of Response', 'type' => 'object', 'properties' => [ - 'RequestId' => [ - 'title' => 'Id of the request', - 'description' => '', - 'type' => 'string', - 'example' => '6CF1E160-3F36-5E73-A170-C75504F05BBC', - ], - 'TrafficControlTaskTrafficInfo' => [ - 'description' => '', - 'type' => 'object', - 'properties' => [ - 'TaskTraffics' => [ - 'description' => '', - 'type' => 'object', - 'additionalProperties' => [ - 'type' => 'object', - 'properties' => [ - 'Traffic' => [ - 'type' => 'number', - 'format' => 'double', - 'description' => '', - 'example' => '100', - ], - ], - 'description' => '', - ], - ], - 'TargetTraffics' => [ - 'description' => '', - 'type' => 'array', - 'items' => [ - 'description' => '', - 'type' => 'object', - 'properties' => [ - 'TrafficContorlTargetId' => [ - 'description' => '', - 'type' => 'string', - 'example' => '2', - ], - 'Data' => [ - 'description' => '', - 'type' => 'object', - 'additionalProperties' => [ - 'type' => 'object', - 'properties' => [ - 'Traffic' => [ - 'type' => 'number', - 'format' => 'double', - 'description' => '', - 'example' => '80', - ], - 'RecordTime' => [ - 'type' => 'integer', - 'format' => 'int64', - 'description' => '', - 'example' => '1760319273', - ], - ], - 'description' => '', - ], - ], - ], - ], - ], - ], - ], + 'RequestId' => ['title' => 'Id of the request', 'description' => 'The request ID.', 'type' => 'string', 'example' => '728C5E01-ABF6-5AA8-B9FC-B3BA05DECC77'], ], + 'example' => '', ], ], ], - 'staticInfo' => [ - 'returnType' => 'synchronous', + 'staticInfo' => ['returnType' => 'synchronous'], + 'title' => 'Update Traffic Control Target', + 'summary' => 'Updates the configuration of a traffic control target, including its control period, conditions, and value.', + 'description' => '## Description'."\n" + ."\n" + .'- Updates a traffic control target specified by its ID.'."\n" + ."\n" + .'- `TrafficControlTargetId` is a path parameter that specifies the ID of the traffic control target to update.'."\n" + ."\n" + .'- The `ItemConditionType` parameter specifies the format of the item condition, which can be either `Array` or `Expression`. Based on your selection, you must provide a value for either the `ItemConditionArray` or `ItemConditionExpress` parameter.'."\n" + ."\n" + .'- If `NewProductRegulation` is set to `true`, the control rule applies to a new product.'."\n" + ."\n" + .'- The `StatisPeriod` parameter specifies the statistics period. Valid values are `Daily` and `hourly`.'."\n" + ."\n" + .'- Ensure that the time interval between `StartTime` and `EndTime` is reasonable and meets your business requirements.', + 'changeSet' => [], + 'flowControl' => [ + 'flowControlList' => [], + ], + 'ramActions' => [ + [ + 'operationType' => 'update', + 'ramAction' => [ + 'action' => 'pairec:UpdateTrafficControlTarget', + 'authLevel' => 'operate', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'PAIRecService', 'resourceType' => 'All Resource', 'arn' => '*'], + ], + ], + ], ], - 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"6CF1E160-3F36-5E73-A170-C75504F05BBC\\",\\n \\"TrafficControlTaskTrafficInfo\\": {\\n \\"TaskTraffics\\": {\\n \\"key\\": {\\n \\"Traffic\\": 100\\n }\\n },\\n \\"TargetTraffics\\": [\\n {\\n \\"TrafficControlTargetId\\": \\"\\",\\n \\"Data\\": {\\n \\"key\\": {\\n \\"Traffic\\": 80,\\n \\"RecorfTime\\": 0\\n }\\n }\\n }\\n ]\\n }\\n}","type":"json"}]', + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"728C5E01-ABF6-5AA8-B9FC-B3BA05DECC77\\"\\n}","type":"json"}]', ], - 'SplitTrafficControlTarget' => [ - 'summary' => '拆分流量调控目标', - 'path' => '/api/v1/trafficcontroltargets/{TrafficControlTargetId}/action/split', - 'methods' => [ - 'post', - ], - 'schemes' => [ - 'http', - 'https', - ], + 'UpdateTrafficControlTask' => [ + 'summary' => 'Updates the configuration and target of a specified traffic control task.', + 'path' => '/api/v1/trafficcontroltasks/{TrafficControlTaskId}', + 'methods' => ['put'], + 'schemes' => ['http', 'https'], 'security' => [ [ 'AK' => [], ], ], - 'consumes' => [ - 'application/json', - ], - 'produces' => [ - 'application/json', - ], + 'consumes' => ['application/json'], + 'produces' => ['application/json'], 'operationType' => 'readAndWrite', 'deprecated' => false, 'systemTags' => [ - 'operationType' => 'none', + 'operationType' => 'update', 'riskType' => 'none', 'chargeType' => 'free', - 'abilityTreeCode' => '220603', - 'abilityTreeNodes' => [ - 'FEATURElearnN0NAWV', - ], + 'abilityTreeCode' => '220407', + 'abilityTreeNodes' => ['FEATURElearnN0NAWV'], ], 'parameters' => [ [ - 'name' => 'TrafficControlTargetId', + 'name' => 'TrafficControlTaskId', 'in' => 'path', - 'schema' => [ - 'description' => '', - 'type' => 'string', - 'required' => false, - 'example' => '1', - ], + 'schema' => ['description' => 'The ID of the traffic control task to update.', 'type' => 'string', 'required' => false, 'example' => '1', 'title' => ''], ], [ 'name' => 'body', 'in' => 'body', 'style' => 'json', 'schema' => [ - 'description' => '', + 'description' => 'The request body.', 'type' => 'object', 'properties' => [ - 'Environment' => [ - 'description' => '', - 'type' => 'string', - 'required' => false, - 'example' => 'Prod', - ], - 'InstanceId' => [ - 'description' => '', - 'type' => 'string', - 'required' => false, - 'example' => 'learn-pairec-xxx', - ], - 'TimePoints' => [ - 'description' => '', + 'Name' => ['description' => 'The name of the traffic control plan.', 'type' => 'string', 'required' => false, 'example' => 'plan-1', 'title' => ''], + 'Description' => ['description' => 'The description of the traffic control plan.', 'type' => 'string', 'required' => false, 'example' => 'this is a test', 'title' => ''], + 'SceneId' => ['description' => 'The scene ID.', 'type' => 'string', 'required' => false, 'example' => '1', 'title' => ''], + 'ExecutionTime' => ['description' => 'The execution time. Valid values: `Permanent` (runs indefinitely) and `TimeRange` (runs within a specified period). If you select `TimeRange`, you must also specify `StartTime` and `EndTime`.', 'type' => 'string', 'required' => false, 'example' => 'Permanent', 'title' => ''], + 'StartTime' => ['description' => 'The start time.', 'type' => 'string', 'required' => false, 'example' => '2024-03-25', 'title' => ''], + 'EndTime' => ['description' => 'The end time.', 'type' => 'string', 'required' => false, 'example' => '2024-04-25', 'title' => ''], + 'BehaviorTableMetaId' => ['description' => 'The behavior table ID.', 'type' => 'string', 'required' => false, 'example' => '1', 'title' => ''], + 'UserTableMetaId' => ['description' => 'The user table ID.', 'type' => 'string', 'required' => false, 'example' => '2', 'title' => ''], + 'ItemTableMetaId' => ['description' => 'The item table ID.', 'type' => 'string', 'required' => false, 'example' => '3', 'title' => ''], + 'UserConditionType' => ['description' => 'The condition type for the target user group.', 'type' => 'string', 'required' => false, 'example' => 'Array', 'title' => ''], + 'UserConditionArray' => ['description' => 'The conditions for the target user group, specified in an array format.', 'type' => 'string', 'required' => false, 'example' => '[{"field":"gender","option":"=","value":"male"}]', 'title' => ''], + 'UserConditionExpress' => ['description' => 'The conditions for the target user group, specified as an expression.', 'type' => 'string', 'required' => false, 'example' => 'age<=30&&(3<=level<=6)&&gender=male', 'title' => ''], + 'StatisBehaviorConditionType' => ['description' => 'The condition type for behavior statistics.', 'type' => 'string', 'required' => false, 'example' => 'Array', 'title' => ''], + 'StatisBaeaviorConditionArray' => ['description' => 'The conditions for behavior statistics, specified in an array format.', 'type' => 'string', 'required' => false, 'example' => 'click=exposure', 'title' => ''], + 'StatisBehaviorConditionExpress' => ['description' => 'The conditions for behavior statistics, specified as an expression.', 'type' => 'string', 'required' => false, 'example' => 'click=30', 'title' => ''], + 'ControlType' => ['description' => 'The control type.', 'type' => 'string', 'required' => false, 'example' => 'Percent', 'title' => ''], + 'ControlGranularity' => ['description' => 'The control granularity.', 'type' => 'string', 'required' => false, 'example' => 'Global', 'title' => ''], + 'ControlLogic' => ['description' => 'The control logic.', 'type' => 'string', 'required' => false, 'example' => 'Guaranteed', 'title' => ''], + 'ItemConditionType' => ['description' => 'The item condition type.', 'type' => 'string', 'required' => false, 'example' => 'Array', 'title' => ''], + 'ItemConditionArray' => ['description' => 'The item conditions, specified in an array format.', 'type' => 'string', 'required' => false, 'example' => '[{"field":"status","option":"=","value":"1"}]', 'title' => ''], + 'ItemConditionExpress' => ['description' => 'The item conditions, specified as an expression.', 'type' => 'string', 'required' => false, 'example' => 'status=1', 'title' => ''], + 'InstanceId' => ['description' => 'The instance ID.', 'type' => 'string', 'required' => false, 'example' => 'pairec-1324***', 'title' => ''], + 'TrafficControlTargets' => [ + 'description' => 'A list of traffic control targets.', 'type' => 'array', 'items' => [ - 'description' => '', - 'type' => 'integer', - 'format' => 'int64', + 'description' => 'The details of a traffic control target.', + 'type' => 'object', + 'properties' => [ + 'Name' => ['description' => 'The name of the traffic control target.', 'type' => 'string', 'required' => false, 'example' => 'target-1', 'title' => ''], + 'StartTime' => ['description' => 'The start time of the traffic control target.', 'type' => 'string', 'required' => false, 'example' => '2026-02-10T09:16:03.893+08:00', 'title' => ''], + 'EndTime' => ['description' => 'The end time of the traffic control target.', 'type' => 'string', 'required' => false, 'example' => '2026-02-06T18:02:57.487556956+08:00', 'title' => ''], + 'ItemConditionType' => ['description' => 'The item condition type.', 'type' => 'string', 'required' => false, 'example' => 'Array', 'title' => ''], + 'ItemConditionArray' => ['description' => 'The item conditions, specified in an array format.', 'type' => 'string', 'required' => false, 'example' => '[{"field":"status","option":"=","value":"1"}]', 'title' => ''], + 'ItemConditionExpress' => ['description' => 'The item conditions, specified as an expression.', 'type' => 'string', 'required' => false, 'example' => 'age>20', 'title' => ''], + 'Event' => ['description' => 'The event for the traffic control target.', 'type' => 'string', 'required' => false, 'example' => 'exposure', 'title' => ''], + 'Value' => ['description' => 'The value of the traffic control target.', 'type' => 'number', 'format' => 'float', 'required' => false, 'example' => '30', 'title' => ''], + 'StatisPeriod' => ['description' => 'The statistical period.', 'type' => 'string', 'required' => false, 'example' => '1', 'title' => ''], + 'ToleranceValue' => ['description' => 'The tolerance range for the traffic control target.', 'type' => 'integer', 'format' => 'int64', 'required' => false, 'example' => '10', 'title' => ''], + 'NewProductRegulation' => ['description' => 'Indicates whether this is a new item recall.', 'type' => 'boolean', 'required' => false, 'example' => 'false', 'title' => ''], + 'RecallName' => ['description' => 'The recall policy name.', 'type' => 'string', 'required' => false, 'example' => 'hot_recall', 'title' => ''], + 'Status' => ['description' => 'The status.', 'type' => 'string', 'required' => false, 'example' => 'Enable', 'title' => ''], + ], 'required' => false, - 'example' => '30', + 'title' => '', + 'example' => '', ], 'required' => false, + 'title' => '', + 'example' => '', ], - 'SetValues' => [ - 'description' => '', + 'ServiceId' => ['description' => 'The engine service ID.', 'type' => 'string', 'required' => false, 'example' => '4', 'title' => ''], + 'PreExperimentIds' => ['description' => 'A comma-separated list of pre-release experiment IDs.', 'type' => 'string', 'required' => false, 'example' => '3,4', 'title' => ''], + 'ProdExperimentIds' => ['description' => 'A comma-separated list of production experiment IDs.', 'type' => 'string', 'required' => false, 'example' => '1,2', 'title' => ''], + 'FlinkResourceId' => ['description' => 'The Flink resource ID.', 'type' => 'string', 'required' => false, 'example' => 'resource-xxx', 'title' => ''], + 'EffectiveSceneIds' => [ + 'description' => 'A list of effective scene IDs.', 'type' => 'array', - 'items' => [ - 'description' => '', - 'type' => 'integer', - 'format' => 'int64', - 'required' => false, - 'example' => '3', - ], + 'items' => ['description' => 'An effective scene ID.', 'type' => 'integer', 'format' => 'int32', 'required' => false, 'example' => '4', 'title' => ''], 'required' => false, + 'title' => '', + 'example' => '', ], - 'SetPoints' => [ - 'description' => '', + 'ServiceIds' => [ + 'description' => 'A list of associated engine service IDs.', + 'type' => 'array', + 'items' => ['description' => 'An associated engine service ID.', 'type' => 'integer', 'format' => 'int32', 'required' => false, 'example' => '3', 'title' => ''], + 'required' => false, + 'title' => '', + 'example' => '', + ], + 'StatisBehaviorConditionArray' => ['description' => 'The conditions for behavior statistics, specified in an array format.', 'type' => 'string', 'required' => false, 'example' => 'click=exposure', 'title' => ''], + ], + 'required' => false, + 'title' => '', + 'example' => '', + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'description' => 'The response object.', + 'title' => 'Schema of Response ', + 'type' => 'object', + 'properties' => [ + 'RequestId' => ['title' => 'ID of the request ', 'description' => 'The request ID.', 'type' => 'string', 'example' => '6CF1E160-3F36-5E73-A170-C75504F05BBC'], + ], + 'example' => '', + ], + ], + ], + 'staticInfo' => ['returnType' => 'synchronous'], + 'eventInfo' => [ + 'enable' => false, + 'eventNames' => [], + ], + 'title' => 'Update Traffic Control Job ', + 'description' => '## Usage notes'."\n" + ."\n" + .'- Use this API to update an existing traffic control task.'."\n" + ."\n" + .'- When `ExecutionTime` is set to `TimeRange`, you must also provide `StartTime` and `EndTime`.'."\n" + ."\n" + .'- Each element in the `TrafficControlTargets` array is a traffic control target. Ensure each target\'s time range, condition type, and other information are complete and valid.'."\n" + ."\n" + .'- If you set `UserConditionType` or `ItemConditionType` to `Expression`, you must specify the corresponding expression field (for example, `UserConditionExpress`).'."\n" + ."\n" + .'- `ServiceIds` and `EffectiveSceneIds` are optional parameters. If you include them, ensure the ID lists are correctly formatted.'."\n" + ."\n" + .'- Ensure you complete all required fields to avoid a failed request.', + 'changeSet' => [], + 'flowControl' => [ + 'flowControlList' => [], + ], + 'ramActions' => [ + [ + 'operationType' => 'update', + 'ramAction' => [ + 'action' => 'pairec:UpdateTrafficControlTask', + 'authLevel' => 'operate', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'PAIRecService', 'resourceType' => 'All Resource', 'arn' => '*'], + ], + ], + ], + ], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"6CF1E160-3F36-5E73-A170-C75504F05BBC\\"\\n}","type":"json"}]', + ], + 'UpdateTrafficControlTaskTraffic' => [ + 'path' => '/api/v1/trafficcontroltasks/{TrafficControlTaskId}/action/traffic', + 'methods' => ['post'], + 'schemes' => ['http', 'https'], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'consumes' => ['application/json'], + 'produces' => ['application/json'], + 'operationType' => 'write', + 'deprecated' => false, + 'systemTags' => [ + 'operationType' => 'none', + 'riskType' => 'none', + 'chargeType' => 'free', + 'abilityTreeCode' => '220415', + 'abilityTreeNodes' => ['FEATURElearnN0NAWV'], + ], + 'parameters' => [ + [ + 'name' => 'TrafficControlTaskId', + 'in' => 'path', + 'schema' => ['description' => 'The ID of the traffic control task.', 'type' => 'string', 'required' => false, 'example' => '1', 'title' => ''], + ], + [ + 'name' => 'body', + 'in' => 'body', + 'style' => 'json', + 'schema' => [ + 'description' => 'The request body.', + 'type' => 'object', + 'properties' => [ + 'InstanceId' => ['description' => 'The instance ID.', 'type' => 'string', 'required' => false, 'example' => 'learn-pairec-cn-xxx', 'title' => ''], + 'Environment' => ['description' => 'The environment. Valid values: `Daily` (daily environment), `Pre` (pre-release environment), and `Prod` (production environment).', 'type' => 'string', 'required' => false, 'example' => 'Daily', 'title' => ''], + 'Traffics' => [ + 'description' => 'A list of traffic objects to report.', 'type' => 'array', 'items' => [ - 'description' => '', - 'type' => 'integer', - 'format' => 'int64', + 'description' => 'An object containing traffic details for a single target.', + 'type' => 'object', + 'properties' => [ + 'TrafficControlTargetId' => ['description' => 'The traffic control target ID.', 'type' => 'string', 'required' => false, 'example' => '1', 'title' => ''], + 'RecordTime' => ['description' => 'The timestamp from the behavior log. This indicates that the log data is current as of this timestamp.', 'type' => 'string', 'required' => false, 'example' => '2024-01-01T02:05:06.111Z', 'title' => ''], + 'ItemOrExperimentId' => ['description' => 'The identifier for the traffic object. This can be an item ID, such as `item1`, an experiment ID, a global identifier (`ER_ALL`), or a value in `L1_EG1_E1` format.', 'type' => 'string', 'required' => false, 'example' => 'item1', 'title' => ''], + 'TrafficControlTargetTraffic' => ['description' => 'The actual traffic volume observed for the traffic control target.', 'type' => 'integer', 'format' => 'int64', 'required' => false, 'example' => '100000', 'title' => ''], + 'TrafficControlTargetAimTraffic' => ['description' => 'The configured target traffic for the traffic control target.', 'type' => 'number', 'format' => 'double', 'required' => false, 'example' => '10.0', 'title' => ''], + 'TrafficControlTaskTraffic' => ['description' => 'The total traffic for the traffic control task.', 'type' => 'integer', 'format' => 'int64', 'required' => false, 'example' => '1000000', 'title' => ''], + ], 'required' => false, - 'example' => '0', + 'title' => '', + 'example' => '', ], 'required' => false, + 'title' => '', + 'example' => '', ], ], 'required' => false, + 'title' => '', + 'example' => '', ], ], + [ + 'name' => 'new-param-3', + 'in' => 'query', + 'schema' => ['description' => 'This parameter is invalid and should be ignored.', 'type' => 'string', 'required' => false, 'example' => 'null', 'title' => ''], + ], ], 'responses' => [ 200 => [ 'schema' => [ + 'description' => 'The response payload.', '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' => 'F8F613A9-DF1C-551A-88E1-397A3981A785', - ], + 'RequestId' => ['title' => 'Id of the request', 'description' => 'The request ID.', 'type' => 'string', 'example' => '728C5E01-ABF6-5AA8-B9FC-B3BA05DECC77'], ], + 'example' => '', ], ], ], - 'staticInfo' => [ - 'returnType' => 'synchronous', + 'staticInfo' => ['returnType' => 'synchronous'], + 'title' => 'Update Traffic for a Traffic Control Job', + 'summary' => 'Updates the traffic parameters for a specified traffic control task, including target traffic and actual traffic.', + 'description' => '## Request'."\n" + ."\n" + .'This API updates the traffic configuration for a specific traffic control task. The configuration includes the traffic control target ID, record time, target traffic, and overall traffic. Ensure that the provided`TrafficControlTaskId` is valid and within your permission scope. Additionally, each object in the`Traffics` array must contain the required fields.', + 'changeSet' => [], + 'flowControl' => [ + 'flowControlList' => [], ], - 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"F8F613A9-DF1C-551A-88E1-397A3981A785\\"\\n}","type":"json"}]', + 'ramActions' => [ + [ + 'operationType' => 'none', + 'ramAction' => [ + 'action' => 'pairec:UpdateTrafficControlTaskTraffic', + 'authLevel' => 'operate', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'PAIRecService', 'resourceType' => 'All Resource', 'arn' => '*'], + ], + ], + ], + ], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"728C5E01-ABF6-5AA8-B9FC-B3BA05DECC77\\"\\n}","type":"json"}]', ], ], 'endpoints' => [ + ['regionId' => 'cn-beijing', 'regionName' => 'China (Beijing)', 'areaId' => 'asiaPacific', 'areaName' => 'Asia Pacific', 'public' => 'pairecservice.cn-beijing.aliyuncs.com', 'endpoint' => 'pairecservice.cn-beijing.aliyuncs.com', 'vpc' => 'pairecservice-vpc.cn-beijing.aliyuncs.com'], + ['regionId' => 'cn-hangzhou', 'regionName' => 'China (Hangzhou)', 'areaId' => 'asiaPacific', 'areaName' => 'Asia Pacific', 'public' => 'pairecservice.cn-hangzhou.aliyuncs.com', 'endpoint' => 'pairecservice.cn-hangzhou.aliyuncs.com', 'vpc' => 'pairecservice-vpc.cn-hangzhou.aliyuncs.com'], + ['regionId' => 'cn-shanghai', 'regionName' => 'China (Shanghai)', 'areaId' => 'asiaPacific', 'areaName' => 'Asia Pacific', 'public' => 'pairecservice.cn-shanghai.aliyuncs.com', 'endpoint' => 'pairecservice.cn-shanghai.aliyuncs.com', 'vpc' => 'pairecservice-vpc.cn-shanghai.aliyuncs.com'], + ['regionId' => 'cn-shenzhen', 'regionName' => 'China (Shenzhen)', 'areaId' => 'asiaPacific', 'areaName' => 'Asia Pacific', 'public' => 'pairecservice.cn-shenzhen.aliyuncs.com', 'endpoint' => 'pairecservice.cn-shenzhen.aliyuncs.com', 'vpc' => 'pairecservice-vpc.cn-shenzhen.aliyuncs.com'], + ], + 'errorCodes' => [], + 'changeSet' => [ [ - 'regionId' => 'cn-beijing', - 'endpoint' => 'pairecservice.cn-beijing.aliyuncs.com', + 'apis' => [ + ['description' => 'Request parameters changed', 'api' => 'CreateFeatureConsistencyCheckJobConfig'], + ['description' => 'Response parameters changed', 'api' => 'GetFeatureConsistencyCheckJobConfig'], + ['description' => 'Response parameters changed', 'api' => 'ListFeatureConsistencyCheckJobConfigs'], + ['description' => 'Request parameters changed', 'api' => 'UpdateFeatureConsistencyCheckJobConfig'], + ], + 'createdAt' => '2024-12-10T06:00:46.000Z', + 'description' => '', ], [ - 'regionId' => 'cn-hangzhou', - 'endpoint' => 'pairecservice.cn-hangzhou.aliyuncs.com', + 'apis' => [ + ['description' => 'Request parameters changed', 'api' => 'CreateFeatureConsistencyCheckJobConfig'], + ['description' => 'Response parameters changed', 'api' => 'GetFeatureConsistencyCheckJobConfig'], + ['description' => 'Response parameters changed', 'api' => 'ListFeatureConsistencyCheckJobConfigs'], + ['description' => 'Request parameters changed', 'api' => 'UpdateFeatureConsistencyCheckJobConfig'], + ], + 'createdAt' => '2024-11-12T09:17:53.000Z', + 'description' => '', ], [ - 'regionId' => 'cn-shanghai', - 'endpoint' => 'pairecservice.cn-shanghai.aliyuncs.com', + 'apis' => [ + ['description' => 'Response parameters changed', 'api' => 'GetInstance'], + ['description' => 'Response parameters changed', 'api' => 'ListInstances'], + ], + 'createdAt' => '2024-08-05T08:37:38.000Z', + 'description' => '', ], [ - 'regionId' => 'cn-shenzhen', - 'endpoint' => 'pairecservice.cn-shenzhen.aliyuncs.com', + 'apis' => [ + ['description' => 'Request parameters changed', 'api' => 'ListExperimentGroups'], + ], + 'createdAt' => '2024-06-25T02:53:02.000Z', + 'description' => '', ], [ - 'regionId' => 'cn-hongkong', - 'endpoint' => 'pairecservice.cn-hongkong.aliyuncs.com', + 'apis' => [ + ['description' => 'Request parameters changed', 'api' => 'CreateExperimentGroup'], + ['description' => 'Response parameters changed', 'api' => 'GetExperimentGroup'], + ['description' => 'Response parameters changed', 'api' => 'GetLayer'], + ['description' => 'Request parameters changed, Response parameters changed', 'api' => 'ListExperimentGroups'], + ['description' => 'Response parameters changed', 'api' => 'ListLayers'], + ['description' => 'Request parameters changed', 'api' => 'UpdateExperimentGroup'], + ], + 'createdAt' => '2024-03-20T06:05:34.000Z', + 'description' => '', ], [ - 'regionId' => 'ap-southeast-1', - 'endpoint' => 'pairecservice.ap-southeast-1.aliyuncs.com', + 'apis' => [ + ['description' => 'Response parameters changed', 'api' => 'GetTableMeta'], + ], + 'createdAt' => '2024-02-22T08:16:07.000Z', + 'description' => '', ], [ - 'regionId' => 'us-east-1', - 'endpoint' => 'pairecservice.us-east-1.aliyuncs.com', + 'apis' => [ + ['description' => 'Request parameters changed', 'api' => 'CheckInstanceResources'], + ['description' => 'Request parameters changed', 'api' => 'CreateABMetric'], + ['description' => 'Request parameters changed', 'api' => 'CreateABMetricGroup'], + ['description' => 'Request parameters changed', 'api' => 'CreateCalculationJobs'], + ['description' => 'Request parameters changed', 'api' => 'CreateFeatureConsistencyCheckJob'], + ['description' => 'Request parameters changed', 'api' => 'CreateFeatureConsistencyCheckJobConfig'], + ['description' => 'Request parameters changed', 'api' => 'CreateInstanceResource'], + ['description' => 'Request parameters changed', 'api' => 'CreateTableMeta'], + ['description' => 'Request parameters changed', 'api' => 'DeleteABMetric'], + ['description' => 'Request parameters changed', 'api' => 'DeleteABMetricGroup'], + ], + 'createdAt' => '2024-02-22T03:35:59.000Z', + 'description' => '', ], [ - 'regionId' => 'us-west-1', - 'endpoint' => 'pairecservice.us-west-1.aliyuncs.com', + 'apis' => [ + ['description' => 'Request parameters changed', 'api' => 'CloneExperiment'], + ], + 'createdAt' => '2023-09-14T01:51:03.000Z', + 'description' => '', ], - [ - 'regionId' => 'ap-southeast-5', - 'endpoint' => 'pairecservice.ap-southeast-5.aliyuncs.com', + ], + 'flowControl' => [ + 'flowControlList' => [ + ['threshold' => '-1', 'countWindow' => 1, 'regionId' => '*'], + ['threshold' => '100', 'countWindow' => 1, 'regionId' => '*', 'api' => 'ListInstances'], + ['threshold' => '100', 'countWindow' => 1, 'regionId' => '*', 'api' => 'GetInstance'], + ['threshold' => '100', 'countWindow' => 1, 'regionId' => '*', 'api' => 'BackflowFeatureConsistencyCheckJobData'], + ['threshold' => '50', 'countWindow' => 1, 'regionId' => '*', 'api' => 'SyncFeatureConsistencyCheckJobReplayLog'], ], - [ - 'regionId' => 'eu-central-1', - 'endpoint' => 'pairecservice.eu-central-1.aliyuncs.com', + ], + 'ram' => [ + 'productCode' => 'PAIRecService', + 'productName' => 'Platform for AI', + 'ramCodes' => ['pairec'], + 'ramLevel' => 'OPERATION', + 'ramConditions' => [], + 'ramActions' => [ + [ + 'apiName' => 'QueryDataDiagnosisStatistics', + 'description' => '', + 'operationType' => 'get', + 'ramAction' => [ + 'action' => 'pairec:QueryDataDiagnosisStatistics', + 'authLevel' => 'operate', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'PAIRecService', 'resourceType' => 'All Resource', 'arn' => '*'], + ], + ], + ], + [ + 'apiName' => 'UpdateExperimentGroup', + 'description' => '', + 'operationType' => 'get', + 'ramAction' => [ + 'action' => 'pairec:UpdateExperimentGroup', + 'authLevel' => 'operate', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'PAIRecService', 'resourceType' => 'All Resource', 'arn' => '*'], + ], + ], + ], + [ + 'apiName' => 'ListABMetricGroups', + 'description' => '', + 'operationType' => 'list', + 'ramAction' => [ + 'action' => 'pairec:ListABMetricGroups', + 'authLevel' => 'operate', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'PAIRecService', 'resourceType' => 'All Resource', 'arn' => '*'], + ], + ], + ], + [ + 'apiName' => 'CreateDataDiagnosisJobs', + 'description' => '', + 'operationType' => 'create', + 'ramAction' => [ + 'action' => 'pairec:CreateDataDiagnosisJobs', + 'authLevel' => 'operate', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'PAIRecService', 'resourceType' => 'All Resource', 'arn' => '*'], + ], + ], + ], + [ + 'apiName' => 'UpdateTrafficControlTask', + 'description' => '', + 'operationType' => 'update', + 'ramAction' => [ + 'action' => 'pairec:UpdateTrafficControlTask', + 'authLevel' => 'operate', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'PAIRecService', 'resourceType' => 'All Resource', 'arn' => '*'], + ], + ], + ], + [ + 'apiName' => 'StartTrafficControlTarget', + 'description' => '', + 'operationType' => 'none', + 'ramAction' => [ + 'action' => 'pairec:StartTrafficControlTarget', + 'authLevel' => 'operate', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'PAIRecService', 'resourceType' => 'All Resource', 'arn' => '*'], + ], + ], + ], + [ + 'apiName' => 'CreateRecallManagementConfig', + 'description' => '', + 'operationType' => 'create', + 'ramAction' => [ + 'action' => 'pairec:CreateRecallManagementConfig', + 'authLevel' => 'operate', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'PAIRecService', 'resourceType' => 'All Resource', 'arn' => '*'], + ], + ], + ], + [ + 'apiName' => 'CreateInstanceResource', + 'description' => '', + 'operationType' => 'create', + 'ramAction' => [ + 'action' => 'pairec:CreateInstanceResource', + 'authLevel' => 'operate', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'PAIRecService', 'resourceType' => 'All Resource', 'arn' => '*'], + ], + ], + ], + [ + 'apiName' => 'CreateCrowd', + 'description' => '', + 'operationType' => 'create', + 'ramAction' => [ + 'action' => 'pairec:CreateCrowd', + 'authLevel' => 'operate', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'PAIRecService', 'resourceType' => 'All Resource', 'arn' => '*'], + ], + ], + ], + [ + 'apiName' => 'ListTrafficControlTasks', + 'description' => '', + 'operationType' => 'list', + 'ramAction' => [ + 'action' => 'pairec:ListTrafficControlTasks', + 'authLevel' => 'operate', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'PAIRecService', 'resourceType' => 'All Resource', 'arn' => '*'], + ], + ], + ], + [ + 'apiName' => 'GetRecallManagementServiceVersion', + 'description' => '', + 'operationType' => 'none', + 'ramAction' => [ + 'action' => 'pairec:GetRecallManagementServiceVersion', + 'authLevel' => 'operate', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'PAIRecService', 'resourceType' => 'All Resource', 'arn' => '*'], + ], + ], + ], + [ + 'apiName' => 'OfflineRecallManagementService', + 'description' => '', + 'operationType' => 'none', + 'ramAction' => [ + 'action' => 'pairec:OfflineRecallManagementService', + 'authLevel' => 'operate', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'PAIRecService', 'resourceType' => 'All Resource', 'arn' => '*'], + ], + ], + ], + [ + 'apiName' => 'UpdateLayer', + 'description' => '', + 'operationType' => 'update', + 'ramAction' => [ + 'action' => 'pairec:UpdateLayer', + 'authLevel' => 'operate', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'PAIRecService', 'resourceType' => 'All Resource', 'arn' => '*'], + ], + ], + ], + [ + 'apiName' => 'GetABMetric', + 'description' => '', + 'operationType' => 'get', + 'ramAction' => [ + 'action' => 'pairec:GetABMetric', + 'authLevel' => 'operate', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'PAIRecService', 'resourceType' => 'All Resource', 'arn' => '*'], + ], + ], + ], + [ + 'apiName' => 'DeleteExperiment', + 'description' => '', + 'operationType' => 'delete', + 'ramAction' => [ + 'action' => 'pairec:DeleteExperiment', + 'authLevel' => 'operate', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'PAIRecService', 'resourceType' => 'All Resource', 'arn' => '*'], + ], + ], + ], + [ + 'apiName' => 'CreateScene', + 'description' => '', + 'operationType' => 'create', + 'ramAction' => [ + 'action' => 'pairec:CreateScene', + 'authLevel' => 'operate', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'PAIRecService', 'resourceType' => 'All Resource', 'arn' => '*'], + ], + ], + ], + [ + 'apiName' => 'OnlineExperimentGroup', + 'description' => '', + 'operationType' => 'none', + 'ramAction' => [ + 'action' => 'pairec:OnlineExperimentGroup', + 'authLevel' => 'operate', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'PAIRecService', 'resourceType' => 'All Resource', 'arn' => '*'], + ], + ], + ], + [ + 'apiName' => 'GetTableMeta', + 'description' => '', + 'operationType' => 'get', + 'ramAction' => [ + 'action' => 'pairec:GetTableMeta', + 'authLevel' => 'operate', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'PAIRecService', 'resourceType' => 'All Resource', 'arn' => '*'], + ], + ], + ], + [ + 'apiName' => 'CloneFeatureConsistencyCheckJobConfig', + 'description' => '', + 'operationType' => 'none', + 'ramAction' => [ + 'action' => 'pairec:CloneFeatureConsistencyCheckJobConfig', + 'authLevel' => 'operate', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'PAIRecService', 'resourceType' => 'All Resource', 'arn' => '*'], + ], + ], + ], + [ + 'apiName' => 'DeleteLaboratory', + 'description' => '', + 'operationType' => 'delete', + 'ramAction' => [ + 'action' => 'pairec:DeleteLaboratory', + 'authLevel' => 'operate', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'PAIRecService', 'resourceType' => 'All Resource', 'arn' => '*'], + ], + ], + ], + [ + 'apiName' => 'CreateDataDiagnosis', + 'description' => '', + 'operationType' => 'create', + 'ramAction' => [ + 'action' => 'pairec:CreateDataDiagnosis', + 'authLevel' => 'operate', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'PAIRecService', 'resourceType' => 'All Resource', 'arn' => '*'], + ], + ], + ], + [ + 'apiName' => 'GetInstanceResource', + 'description' => '', + 'operationType' => 'none', + 'ramAction' => [ + 'action' => 'pairec:GetInstanceResource', + 'authLevel' => 'operate', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'PAIRecService', 'resourceType' => 'All Resource', 'arn' => '*'], + ], + ], + ], + [ + 'apiName' => 'QueryRecallManagementTableRecords', + 'description' => '', + 'operationType' => 'none', + 'ramAction' => [ + 'action' => 'pairec:QueryRecallManagementTableRecords', + 'authLevel' => 'operate', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'PAIRecService', 'resourceType' => 'All Resource', 'arn' => '*'], + ], + ], + ], + [ + 'apiName' => 'ListInstanceResourceSchemas', + 'description' => '', + 'operationType' => 'none', + 'ramAction' => [ + 'action' => 'pairec:ListInstanceResourceSchemas', + 'authLevel' => 'operate', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'PAIRecService', 'resourceType' => 'All Resource', 'arn' => '*'], + ], + ], + ], + [ + 'apiName' => 'GetLaboratory', + 'description' => '', + 'operationType' => 'get', + 'ramAction' => [ + 'action' => 'pairec:GetLaboratory', + 'authLevel' => 'operate', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'PAIRecService', 'resourceType' => 'All Resource', 'arn' => '*'], + ], + ], + ], + [ + 'apiName' => 'SyncFeatureConsistencyCheckJobReplayLog', + 'description' => '', + 'operationType' => 'none', + 'ramAction' => [ + 'action' => 'pairec:SyncFeatureConsistencyCheckJobReplayLog', + 'authLevel' => 'operate', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'PAIRecService', 'resourceType' => 'All Resource', 'arn' => '*'], + ], + ], + ], + [ + 'apiName' => 'ListDataDiagnosisReports', + 'description' => '', + 'operationType' => 'get', + 'ramAction' => [ + 'action' => 'pairec:ListDataDiagnosisReports', + 'authLevel' => 'operate', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'PAIRecService', 'resourceType' => 'All Resource', 'arn' => '*'], + ], + ], + ], + [ + 'apiName' => 'CreateRecallManagementTable', + 'description' => '', + 'operationType' => 'create', + 'ramAction' => [ + 'action' => 'pairec:CreateRecallManagementTable', + 'authLevel' => 'operate', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'PAIRecService', 'resourceType' => 'All Resource', 'arn' => '*'], + ], + ], + ], + [ + 'apiName' => 'CreateExperiment', + 'description' => '', + 'operationType' => 'create', + 'ramAction' => [ + 'action' => 'pairec:CreateExperiment', + 'authLevel' => 'operate', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'PAIRecService', 'resourceType' => 'All Resource', 'arn' => '*'], + ], + ], + ], + [ + 'apiName' => 'DeleteDataDiagnosis', + 'description' => '', + 'operationType' => 'delete', + 'ramAction' => [ + 'action' => 'pairec:DeleteDataDiagnosis', + 'authLevel' => 'operate', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'PAIRecService', 'resourceType' => 'All Resource', 'arn' => '*'], + ], + ], + ], + [ + 'apiName' => 'DeleteRecallManagementService', + 'description' => '', + 'operationType' => 'delete', + 'ramAction' => [ + 'action' => 'pairec:DeleteRecallManagementService', + 'authLevel' => 'operate', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'PAIRecService', 'resourceType' => 'All Resource', 'arn' => '*'], + ], + ], + ], + [ + 'apiName' => 'DeleteInstanceResource', + 'description' => '', + 'operationType' => 'delete', + 'ramAction' => [ + 'action' => 'pairec:DeleteInstanceResource', + 'authLevel' => 'operate', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'PAIRecService', 'resourceType' => 'All Resource', 'arn' => '*'], + ], + ], + ], + [ + 'apiName' => 'CreateFeatureConsistencyCheckJobConfig', + 'description' => '', + 'operationType' => 'create', + 'ramAction' => [ + 'action' => 'pairec:CreateFeatureConsistencyCheckJobConfig', + 'authLevel' => 'operate', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'PAIRecService', 'resourceType' => 'All Resource', 'arn' => '*'], + ], + ], + ], + [ + 'apiName' => 'CloneEngineConfig', + 'description' => '', + 'operationType' => 'none', + 'ramAction' => [ + 'action' => 'pairec:CloneEngineConfig', + 'authLevel' => 'operate', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'PAIRecService', 'resourceType' => 'All Resource', 'arn' => '*'], + ], + ], + ], + [ + 'apiName' => 'CloneLaboratory', + 'description' => '', + 'operationType' => 'none', + 'ramAction' => [ + 'action' => 'pairec:CloneLaboratory', + 'authLevel' => 'operate', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'PAIRecService', 'resourceType' => 'All Resource', 'arn' => '*'], + ], + ], + ], + [ + 'apiName' => 'CreateExperimentGroup', + 'description' => '', + 'operationType' => 'create', + 'ramAction' => [ + 'action' => 'pairec:CreateExperimentGroup', + 'authLevel' => 'operate', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'PAIRecService', 'resourceType' => 'All Resource', 'arn' => '*'], + ], + ], + ], + [ + 'apiName' => 'UpdateFeatureConsistencyCheckJobConfig', + 'description' => '', + 'operationType' => 'update', + 'ramAction' => [ + 'action' => 'pairec:UpdateFeatureConsistencyCheckJobConfig', + 'authLevel' => 'operate', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'PAIRecService', 'resourceType' => 'All Resource', 'arn' => '*'], + ], + ], + ], + [ + 'apiName' => 'OfflineExperimentGroup', + 'description' => '', + 'operationType' => 'none', + 'ramAction' => [ + 'action' => 'pairec:OfflineExperimentGroup', + 'authLevel' => 'operate', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'PAIRecService', 'resourceType' => 'All Resource', 'arn' => '*'], + ], + ], + ], + [ + 'apiName' => 'UpdateRecallManagementService', + 'description' => '', + 'operationType' => 'update', + 'ramAction' => [ + 'action' => 'pairec:UpdateRecallManagementService', + 'authLevel' => 'operate', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'PAIRecService', 'resourceType' => 'All Resource', 'arn' => '*'], + ], + ], + ], + [ + 'apiName' => 'CloneTrafficControlTask', + 'description' => '', + 'operationType' => 'none', + 'ramAction' => [ + 'action' => 'pairec:CloneTrafficControlTask', + 'authLevel' => 'operate', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'PAIRecService', 'resourceType' => 'All Resource', 'arn' => '*'], + ], + ], + ], + [ + 'apiName' => 'ListRecallManagementTableVersions', + 'description' => '', + 'operationType' => 'none', + 'ramAction' => [ + 'action' => 'pairec:ListRecallManagementTableVersions', + 'authLevel' => 'operate', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'PAIRecService', 'resourceType' => 'All Resource', 'arn' => '*'], + ], + ], + ], + [ + 'apiName' => 'PublishRecallManagementTable', + 'description' => '', + 'operationType' => 'none', + 'ramAction' => [ + 'action' => 'pairec:PublishRecallManagementTable', + 'authLevel' => 'operate', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'PAIRecService', 'resourceType' => 'All Resource', 'arn' => '*'], + ], + ], + ], + [ + 'apiName' => 'DeleteTrafficControlTask', + 'description' => '', + 'operationType' => 'delete', + 'ramAction' => [ + 'action' => 'pairec:DeleteTrafficControlTask', + 'authLevel' => 'operate', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'PAIRecService', 'resourceType' => 'All Resource', 'arn' => '*'], + ], + ], + ], + [ + 'apiName' => 'CreateTrafficControlTarget', + 'description' => '', + 'operationType' => 'create', + 'ramAction' => [ + 'action' => 'pairec:CreateTrafficControlTarget', + 'authLevel' => 'operate', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'PAIRecService', 'resourceType' => 'All Resource', 'arn' => '*'], + ], + ], + ], + [ + 'apiName' => 'DeleteExperimentGroup', + 'description' => '', + 'operationType' => 'delete', + 'ramAction' => [ + 'action' => 'pairec:DeleteExperimentGroup', + 'authLevel' => 'operate', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'PAIRecService', 'resourceType' => 'All Resource', 'arn' => '*'], + ], + ], + ], + [ + 'apiName' => 'UpdateExperiment', + 'description' => '', + 'operationType' => 'update', + 'ramAction' => [ + 'action' => 'pairec:UpdateExperiment', + 'authLevel' => 'operate', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'PAIRecService', 'resourceType' => 'All Resource', 'arn' => '*'], + ], + ], + ], + [ + 'apiName' => 'CreateFeatureConsistencyCheckJob', + 'description' => '', + 'operationType' => 'create', + 'ramAction' => [ + 'action' => 'pairec:CreateFeatureConsistencyCheckJob', + 'authLevel' => 'operate', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'PAIRecService', 'resourceType' => 'All Resource', 'arn' => '*'], + ], + ], + ], + [ + 'apiName' => 'DeleteSubCrowd', + 'description' => '', + 'operationType' => 'delete', + 'ramAction' => [ + 'action' => 'pairec:DeleteSubCrowd', + 'authLevel' => 'operate', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'PAIRecService', 'resourceType' => 'All Resource', 'arn' => '*'], + ], + ], + ], + [ + 'apiName' => 'ListRecallManagementServices', + 'description' => '', + 'operationType' => 'list', + 'ramAction' => [ + 'action' => 'pairec:ListRecallManagementServices', + 'authLevel' => 'operate', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'PAIRecService', 'resourceType' => 'All Resource', 'arn' => '*'], + ], + ], + ], + [ + 'apiName' => 'UpdateDataDiagnosis', + 'description' => '', + 'operationType' => 'update', + 'ramAction' => [ + 'action' => 'pairec:UpdateDataDiagnosis', + 'authLevel' => 'operate', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'PAIRecService', 'resourceType' => 'All Resource', 'arn' => '*'], + ], + ], + ], + [ + 'apiName' => 'DeleteParam', + 'description' => '', + 'operationType' => 'delete', + 'ramAction' => [ + 'action' => 'pairec:DeleteParam', + 'authLevel' => 'operate', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'PAIRecService', 'resourceType' => 'All Resource', 'arn' => '*'], + ], + ], + ], + [ + 'apiName' => 'ChatConversation', + 'description' => '', + 'operationType' => 'none', + 'ramAction' => [ + 'action' => 'pairec:ChatConversation', + 'authLevel' => 'operate', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'PAIRecService', 'resourceType' => 'All Resource', 'arn' => '*'], + ], + ], + ], + [ + 'apiName' => 'ReportABMetricGroup', + 'description' => '', + 'operationType' => 'none', + 'ramAction' => [ + 'action' => 'pairec:ReportABMetricGroup', + 'authLevel' => 'operate', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'PAIRecService', 'resourceType' => 'All Resource', 'arn' => '*'], + ], + ], + ], + [ + 'apiName' => 'GetRecallManagementTable', + 'description' => '', + 'operationType' => 'get', + 'ramAction' => [ + 'action' => 'pairec:GetRecallManagementTable', + 'authLevel' => 'operate', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'PAIRecService', 'resourceType' => 'All Resource', 'arn' => '*'], + ], + ], + ], + [ + 'apiName' => 'DeleteRecallManagementServiceVersion', + 'description' => '', + 'operationType' => 'none', + 'ramAction' => [ + 'action' => 'pairec:DeleteRecallManagementServiceVersion', + 'authLevel' => 'operate', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'PAIRecService', 'resourceType' => 'All Resource', 'arn' => '*'], + ], + ], + ], + [ + 'apiName' => 'GetTrafficControlTask', + 'description' => '', + 'operationType' => 'get', + 'ramAction' => [ + 'action' => 'pairec:GetTrafficControlTask', + 'authLevel' => 'operate', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'PAIRecService', 'resourceType' => 'All Resource', 'arn' => '*'], + ], + ], + ], + [ + 'apiName' => 'ListExperimentGroups', + 'description' => '', + 'operationType' => 'list', + 'ramAction' => [ + 'action' => 'pairec:ListExperimentGroups', + 'authLevel' => 'operate', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'PAIRecService', 'resourceType' => 'All Resource', 'arn' => '*'], + ], + ], + ], + [ + 'apiName' => 'OnlineExperiment', + 'description' => '', + 'operationType' => 'none', + 'ramAction' => [ + 'action' => 'pairec:OnlineExperiment', + 'authLevel' => 'operate', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'PAIRecService', 'resourceType' => 'All Resource', 'arn' => '*'], + ], + ], + ], + [ + 'apiName' => 'ListSubCrowds', + 'description' => '', + 'operationType' => 'list', + 'ramAction' => [ + 'action' => 'pairec:ListSubCrowds', + 'authLevel' => 'operate', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'PAIRecService', 'resourceType' => 'All Resource', 'arn' => '*'], + ], + ], + ], + [ + 'apiName' => 'UpdateABMetricGroup', + 'description' => '', + 'operationType' => 'update', + 'ramAction' => [ + 'action' => 'pairec:UpdateABMetricGroup', + 'authLevel' => 'operate', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'PAIRecService', 'resourceType' => 'All Resource', 'arn' => '*'], + ], + ], + ], + [ + 'apiName' => 'CreateParam', + 'description' => '', + 'operationType' => 'create', + 'ramAction' => [ + 'action' => 'pairec:CreateParam', + 'authLevel' => 'operate', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'PAIRecService', 'resourceType' => 'All Resource', 'arn' => '*'], + ], + ], + ], + [ + 'apiName' => 'OnlineLaboratory', + 'description' => '', + 'operationType' => 'none', + 'ramAction' => [ + 'action' => 'pairec:OnlineLaboratory', + 'authLevel' => 'operate', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'PAIRecService', 'resourceType' => 'All Resource', 'arn' => '*'], + ], + ], + ], + [ + 'apiName' => 'UpdateEngineConfig', + 'description' => '', + 'operationType' => 'update', + 'ramAction' => [ + 'action' => 'pairec:UpdateEngineConfig', + 'authLevel' => 'operate', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'PAIRecService', 'resourceType' => 'All Resource', 'arn' => '*'], + ], + ], + ], + [ + 'apiName' => 'ListRecallManagementJobs', + 'description' => '', + 'operationType' => 'list', + 'ramAction' => [ + 'action' => 'pairec:ListRecallManagementJobs', + 'authLevel' => 'operate', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'PAIRecService', 'resourceType' => 'All Resource', 'arn' => '*'], + ], + ], + ], + [ + 'apiName' => 'ListInstances', + 'description' => '', + 'operationType' => 'none', + 'ramAction' => [ + 'action' => 'pairec:ListInstances', + 'authLevel' => 'operate', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'PAIRecService', 'resourceType' => 'All Resource', 'arn' => '*'], + ], + ], + ], + [ + 'apiName' => 'GetRecallManagementService', + 'description' => '', + 'operationType' => 'get', + 'ramAction' => [ + 'action' => 'pairec:GetRecallManagementService', + 'authLevel' => 'operate', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'PAIRecService', 'resourceType' => 'All Resource', 'arn' => '*'], + ], + ], + ], + [ + 'apiName' => 'OnlineRecallManagementService', + 'description' => '', + 'operationType' => 'none', + 'ramAction' => [ + 'action' => 'pairec:OnlineRecallManagementService', + 'authLevel' => 'operate', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'PAIRecService', 'resourceType' => 'All Resource', 'arn' => '*'], + ], + ], + ], + [ + 'apiName' => 'CreateABMetricGroup', + 'description' => '', + 'operationType' => 'create', + 'ramAction' => [ + 'action' => 'pairec:CreateABMetricGroup', + 'authLevel' => 'operate', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'PAIRecService', 'resourceType' => 'All Resource', 'arn' => '*'], + ], + ], + ], + [ + 'apiName' => 'CreateABMetric', + 'description' => '', + 'operationType' => 'create', + 'ramAction' => [ + 'action' => 'pairec:CreateABMetric', + 'authLevel' => 'operate', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'PAIRecService', 'resourceType' => 'All Resource', 'arn' => '*'], + ], + ], + ], + [ + 'apiName' => 'GetTrafficControlTarget', + 'description' => '', + 'operationType' => 'get', + 'ramAction' => [ + 'action' => 'pairec:GetTrafficControlTarget', + 'authLevel' => 'operate', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'PAIRecService', 'resourceType' => 'All Resource', 'arn' => '*'], + ], + ], + ], + [ + 'apiName' => 'DeleteABMetricGroup', + 'description' => '', + 'operationType' => 'delete', + 'ramAction' => [ + 'action' => 'pairec:DeleteABMetricGroup', + 'authLevel' => 'operate', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'PAIRecService', 'resourceType' => 'All Resource', 'arn' => '*'], + ], + ], + ], + [ + 'apiName' => 'DeleteTableMeta', + 'description' => '', + 'operationType' => 'delete', + 'ramAction' => [ + 'action' => 'pairec:DeleteTableMeta', + 'authLevel' => 'operate', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'PAIRecService', 'resourceType' => 'All Resource', 'arn' => '*'], + ], + ], + ], + [ + 'apiName' => 'StopTrafficControlTask', + 'description' => '', + 'operationType' => 'none', + 'ramAction' => [ + 'action' => 'pairec:StopTrafficControlTask', + 'authLevel' => 'operate', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'PAIRecService', 'resourceType' => 'All Resource', 'arn' => '*'], + ], + ], + ], + [ + 'apiName' => 'GetExperiment', + 'description' => '', + 'operationType' => 'get', + 'ramAction' => [ + 'action' => 'pairec:GetExperiment', + 'authLevel' => 'operate', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'PAIRecService', 'resourceType' => 'All Resource', 'arn' => '*'], + ], + ], + ], + [ + 'apiName' => 'ListEngineConfigs', + 'description' => '', + 'operationType' => 'list', + 'ramAction' => [ + 'action' => 'pairec:ListEngineConfigs', + 'authLevel' => 'operate', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'PAIRecService', 'resourceType' => 'All Resource', 'arn' => '*'], + ], + ], + ], + [ + 'apiName' => 'CreateLayer', + 'description' => '', + 'operationType' => 'create', + 'ramAction' => [ + 'action' => 'pairec:CreateLayer', + 'authLevel' => 'operate', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'PAIRecService', 'resourceType' => 'All Resource', 'arn' => '*'], + ], + ], + ], + [ + 'apiName' => 'DeleteABMetric', + 'description' => '', + 'operationType' => 'delete', + 'ramAction' => [ + 'action' => 'pairec:DeleteABMetric', + 'authLevel' => 'operate', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'PAIRecService', 'resourceType' => 'All Resource', 'arn' => '*'], + ], + ], + ], + [ + 'apiName' => 'UpdateLaboratory', + 'description' => '', + 'operationType' => 'update', + 'ramAction' => [ + 'action' => 'pairec:UpdateLaboratory', + 'authLevel' => 'operate', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'PAIRecService', 'resourceType' => 'All Resource', 'arn' => '*'], + ], + ], + ], + [ + 'apiName' => 'GetTrafficControlTaskTraffic', + 'description' => '', + 'operationType' => 'none', + 'ramAction' => [ + 'action' => 'pairec:GetTrafficControlTaskTraffic', + 'authLevel' => 'operate', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'PAIRecService', 'resourceType' => 'All Resource', 'arn' => '*'], + ], + ], + ], + [ + 'apiName' => 'QueryTrafficControlTargetItemReportDetail', + 'description' => '', + 'operationType' => 'none', + 'ramAction' => [ + 'action' => 'pairec:QueryTrafficControlTargetItemReportDetail', + 'authLevel' => 'operate', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'PAIRecService', 'resourceType' => 'All Resource', 'arn' => '*'], + ], + ], + ], + [ + 'apiName' => 'ReleaseTrafficControlTask', + 'description' => '', + 'operationType' => 'none', + 'ramAction' => [ + 'action' => 'pairec:ReleaseTrafficControlTask', + 'authLevel' => 'operate', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'PAIRecService', 'resourceType' => 'All Resource', 'arn' => '*'], + ], + ], + ], + [ + 'apiName' => 'UpdateInstanceResource', + 'description' => '', + 'operationType' => 'update', + 'ramAction' => [ + 'action' => 'pairec:UpdateInstanceResource', + 'authLevel' => 'operate', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'PAIRecService', 'resourceType' => 'All Resource', 'arn' => '*'], + ], + ], + ], + [ + 'apiName' => 'ChangeRecallManagementServiceVersion', + 'description' => '', + 'operationType' => 'none', + 'ramAction' => [ + 'action' => 'pairec:ChangeRecallManagementServiceVersion', + 'authLevel' => 'operate', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'PAIRecService', 'resourceType' => 'All Resource', 'arn' => '*'], + ], + ], + ], + [ + 'apiName' => 'UpdateABMetric', + 'description' => '', + 'operationType' => 'update', + 'ramAction' => [ + 'action' => 'pairec:UpdateABMetric', + 'authLevel' => 'operate', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'PAIRecService', 'resourceType' => 'All Resource', 'arn' => '*'], + ], + ], + ], + [ + 'apiName' => 'DeleteScene', + 'description' => '', + 'operationType' => 'delete', + 'ramAction' => [ + 'action' => 'pairec:DeleteScene', + 'authLevel' => 'operate', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'PAIRecService', 'resourceType' => 'All Resource', 'arn' => '*'], + ], + ], + ], + [ + 'apiName' => 'GetLayer', + 'description' => '', + 'operationType' => 'get', + 'ramAction' => [ + 'action' => 'pairec:GetLayer', + 'authLevel' => 'operate', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'PAIRecService', 'resourceType' => 'All Resource', 'arn' => '*'], + ], + ], + ], + [ + 'apiName' => 'GetInstance', + 'description' => '', + 'operationType' => 'get', + 'ramAction' => [ + 'action' => 'pairec:GetInstance', + 'authLevel' => 'operate', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'PAIRecService', 'resourceType' => 'All Resource', 'arn' => '*'], + ], + ], + ], + [ + 'apiName' => 'CreateRecallManagementServiceVersion', + 'description' => '', + 'operationType' => 'none', + 'ramAction' => [ + 'action' => 'pairec:CreateRecallManagementServiceVersion', + 'authLevel' => 'operate', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'PAIRecService', 'resourceType' => 'All Resource', 'arn' => '*'], + ], + ], + ], + [ + 'apiName' => 'GetRecallManagementServiceVersionConfig', + 'description' => '', + 'operationType' => 'none', + 'ramAction' => [ + 'action' => 'pairec:GetRecallManagementServiceVersionConfig', + 'authLevel' => 'operate', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'PAIRecService', 'resourceType' => 'All Resource', 'arn' => '*'], + ], + ], + ], + [ + 'apiName' => 'QueryTrafficControlTaskDeployResult', + 'description' => '', + 'operationType' => 'none', + 'ramAction' => [ + 'action' => 'pairec:QueryTrafficControlTaskDeployResult', + 'authLevel' => 'operate', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'PAIRecService', 'resourceType' => 'All Resource', 'arn' => '*'], + ], + ], + ], + [ + 'apiName' => 'UpdateTableMeta', + 'description' => '', + 'operationType' => 'update', + 'ramAction' => [ + 'action' => 'pairec:UpdateTableMeta', + 'authLevel' => 'operate', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'PAIRecService', 'resourceType' => 'All Resource', 'arn' => '*'], + ], + ], + ], + [ + 'apiName' => 'QueryTrafficControlTaskItemReport', + 'description' => '', + 'operationType' => 'none', + 'ramAction' => [ + 'action' => 'pairec:QueryTrafficControlTaskItemReport', + 'authLevel' => 'operate', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'PAIRecService', 'resourceType' => 'All Resource', 'arn' => '*'], + ], + ], + ], + [ + 'apiName' => 'ListInstanceResources', + 'description' => '', + 'operationType' => 'list', + 'ramAction' => [ + 'action' => 'pairec:ListInstanceResources', + 'authLevel' => 'operate', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'PAIRecService', 'resourceType' => 'All Resource', 'arn' => '*'], + ], + ], + ], + [ + 'apiName' => 'ListScenes', + 'description' => '', + 'operationType' => 'list', + 'ramAction' => [ + 'action' => 'pairec:ListScenes', + 'authLevel' => 'operate', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'PAIRecService', 'resourceType' => 'All Resource', 'arn' => '*'], + ], + ], + ], + [ + 'apiName' => 'DeleteLayer', + 'description' => '', + 'operationType' => 'delete', + 'ramAction' => [ + 'action' => 'pairec:DeleteLayer', + 'authLevel' => 'operate', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'PAIRecService', 'resourceType' => 'All Resource', 'arn' => '*'], + ], + ], + ], + [ + 'apiName' => 'DeleteTrafficControlTarget', + 'description' => '', + 'operationType' => 'delete', + 'ramAction' => [ + 'action' => 'pairec:DeleteTrafficControlTarget', + 'authLevel' => 'operate', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'PAIRecService', 'resourceType' => 'All Resource', 'arn' => '*'], + ], + ], + ], + [ + 'apiName' => 'UpdateRecallManagementConfig', + 'description' => '', + 'operationType' => 'none', + 'ramAction' => [ + 'action' => 'pairec:UpdateRecallManagementConfig', + 'authLevel' => 'operate', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'PAIRecService', 'resourceType' => 'All Resource', 'arn' => '*'], + ], + ], + ], + [ + 'apiName' => 'GetFeatureConsistencyCheckJob', + 'description' => '', + 'operationType' => 'get', + 'ramAction' => [ + 'action' => 'pairec:GetFeatureConsistencyCheckJob', + 'authLevel' => 'operate', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'PAIRecService', 'resourceType' => 'All Resource', 'arn' => '*'], + ], + ], + ], + [ + 'apiName' => 'ListFeatureConsistencyCheckJobs', + 'description' => '', + 'operationType' => 'get', + 'ramAction' => [ + 'action' => 'pairec:ListFeatureConsistencyCheckJobs', + 'authLevel' => 'operate', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'PAIRecService', 'resourceType' => 'All Resource', 'arn' => '*'], + ], + ], + ], + [ + 'apiName' => 'ListInstanceResourceTables', + 'description' => '', + 'operationType' => 'list', + 'ramAction' => [ + 'action' => 'pairec:ListInstanceResourceTables', + 'authLevel' => 'operate', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'PAIRecService', 'resourceType' => 'All Resource', 'arn' => '*'], + ], + ], + ], + [ + 'apiName' => 'GetDataDiagnosis', + 'description' => '', + 'operationType' => 'get', + 'ramAction' => [ + 'action' => 'pairec:GetDataDiagnosis', + 'authLevel' => 'operate', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'PAIRecService', 'resourceType' => 'All Resource', 'arn' => '*'], + ], + ], + ], + [ + 'apiName' => 'DeleteCrowd', + 'description' => '', + 'operationType' => 'delete', + 'ramAction' => [ + 'action' => 'pairec:DeleteCrowd', + 'authLevel' => 'operate', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'PAIRecService', 'resourceType' => 'All Resource', 'arn' => '*'], + ], + ], + ], + [ + 'apiName' => 'ListCrowdUsers', + 'description' => '', + 'operationType' => 'list', + 'ramAction' => [ + 'action' => 'pairec:ListCrowdUsers', + 'authLevel' => 'operate', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'PAIRecService', 'resourceType' => 'All Resource', 'arn' => '*'], + ], + ], + ], + [ + 'apiName' => 'CreateTableMeta', + 'description' => '', + 'operationType' => 'create', + 'ramAction' => [ + 'action' => 'pairec:CreateTableMeta', + 'authLevel' => 'operate', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'PAIRecService', 'resourceType' => 'All Resource', 'arn' => '*'], + ], + ], + ], + [ + 'apiName' => 'UpdateTrafficControlTarget', + 'description' => '', + 'operationType' => 'update', + 'ramAction' => [ + 'action' => 'pairec:UpdateTrafficControlTarget', + 'authLevel' => 'operate', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'PAIRecService', 'resourceType' => 'All Resource', 'arn' => '*'], + ], + ], + ], + [ + 'apiName' => 'ExportRecallManagementTable', + 'description' => '', + 'operationType' => 'none', + 'ramAction' => [ + 'action' => 'pairec:ExportRecallManagementTable', + 'authLevel' => 'operate', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'PAIRecService', 'resourceType' => 'All Resource', 'arn' => '*'], + ], + ], + ], + [ + 'apiName' => 'ListParams', + 'description' => '', + 'operationType' => 'list', + 'ramAction' => [ + 'action' => 'pairec:ListParams', + 'authLevel' => 'operate', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'PAIRecService', 'resourceType' => 'All Resource', 'arn' => '*'], + ], + ], + ], + [ + 'apiName' => 'OfflineLaboratory', + 'description' => '', + 'operationType' => 'none', + 'ramAction' => [ + 'action' => 'pairec:OfflineLaboratory', + 'authLevel' => 'operate', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'PAIRecService', 'resourceType' => 'All Resource', 'arn' => '*'], + ], + ], + ], + [ + 'apiName' => 'CheckTrafficControlTaskExpression', + 'description' => '', + 'operationType' => 'none', + 'ramAction' => [ + 'action' => 'pairec:CheckTrafficControlTaskExpression', + 'authLevel' => 'operate', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'PAIRecService', 'resourceType' => 'All Resource', 'arn' => '*'], + ], + ], + ], + [ + 'apiName' => 'BackflowFeatureConsistencyCheckJobData', + 'description' => '', + 'operationType' => 'none', + 'ramAction' => [ + 'action' => 'pairec:BackflowFeatureConsistencyCheckJobData', + 'authLevel' => 'operate', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'PAIRecService', 'resourceType' => 'All Resource', 'arn' => '*'], + ], + ], + ], + [ + 'apiName' => 'ListFeatureConsistencyCheckJobFeatureReports', + 'description' => '', + 'operationType' => 'list', + 'ramAction' => [ + 'action' => 'pairec:ListFeatureConsistencyCheckJobFeatureReports', + 'authLevel' => 'operate', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'PAIRecService', 'resourceType' => 'All Resource', 'arn' => '*'], + ], + ], + ], + [ + 'apiName' => 'ListLayers', + 'description' => '', + 'operationType' => 'list', + 'ramAction' => [ + 'action' => 'pairec:ListLayers', + 'authLevel' => 'operate', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'PAIRecService', 'resourceType' => 'All Resource', 'arn' => '*'], + ], + ], + ], + [ + 'apiName' => 'CreateTrafficControlTask', + 'description' => '', + 'operationType' => 'create', + 'ramAction' => [ + 'action' => 'pairec:CreateTrafficControlTask', + 'authLevel' => 'operate', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'PAIRecService', 'resourceType' => 'All Resource', 'arn' => '*'], + ], + ], + ], + [ + 'apiName' => 'UpdateParam', + 'description' => '', + 'operationType' => 'update', + 'ramAction' => [ + 'action' => 'pairec:UpdateParam', + 'authLevel' => 'operate', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'PAIRecService', 'resourceType' => 'All Resource', 'arn' => '*'], + ], + ], + ], + [ + 'apiName' => 'ListRecallManagementTables', + 'description' => '', + 'operationType' => 'list', + 'ramAction' => [ + 'action' => 'pairec:ListRecallManagementTables', + 'authLevel' => 'operate', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'PAIRecService', 'resourceType' => 'All Resource', 'arn' => '*'], + ], + ], + ], + [ + 'apiName' => 'UpdateCrowd', + 'description' => '', + 'operationType' => 'update', + 'ramAction' => [ + 'action' => 'pairec:UpdateCrowd', + 'authLevel' => 'operate', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'PAIRecService', 'resourceType' => 'All Resource', 'arn' => '*'], + ], + ], + ], + [ + 'apiName' => 'ListABMetrics', + 'description' => '', + 'operationType' => 'list', + 'ramAction' => [ + 'action' => 'pairec:ListABMetrics', + 'authLevel' => 'operate', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'PAIRecService', 'resourceType' => 'All Resource', 'arn' => '*'], + ], + ], + ], + [ + 'apiName' => 'ApplyEngineConfig', + 'description' => '', + 'operationType' => 'none', + 'ramAction' => [ + 'action' => 'pairec:ApplyEngineConfig', + 'authLevel' => 'operate', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'PAIRecService', 'resourceType' => 'All Resource', 'arn' => '*'], + ], + ], + ], + [ + 'apiName' => 'TerminateFeatureConsistencyCheckJob', + 'description' => '', + 'operationType' => 'none', + 'ramAction' => [ + 'action' => 'pairec:TerminateFeatureConsistencyCheckJob', + 'authLevel' => 'operate', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'PAIRecService', 'resourceType' => 'All Resource', 'arn' => '*'], + ], + ], + ], + [ + 'apiName' => 'GetSubCrowd', + 'description' => '', + 'operationType' => 'get', + 'ramAction' => [ + 'action' => 'pairec:GetSubCrowd', + 'authLevel' => 'operate', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'PAIRecService', 'resourceType' => 'All Resource', 'arn' => '*'], + ], + ], + ], + [ + 'apiName' => 'GetScene', + 'description' => '', + 'operationType' => 'get', + 'ramAction' => [ + 'action' => 'pairec:GetScene', + 'authLevel' => 'operate', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'PAIRecService', 'resourceType' => 'All Resource', 'arn' => '*'], + ], + ], + ], + [ + 'apiName' => 'ListTableMetas', + 'description' => '', + 'operationType' => 'list', + 'ramAction' => [ + 'action' => 'pairec:ListTableMetas', + 'authLevel' => 'operate', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'PAIRecService', 'resourceType' => 'All Resource', 'arn' => '*'], + ], + ], + ], + [ + 'apiName' => 'ListDataDiagnosisJobs', + 'description' => '', + 'operationType' => 'get', + 'ramAction' => [ + 'action' => 'pairec:ListDataDiagnosisJobs', + 'authLevel' => 'operate', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'PAIRecService', 'resourceType' => 'All Resource', 'arn' => '*'], + ], + ], + ], + [ + 'apiName' => 'GetService', + 'description' => '', + 'operationType' => 'get', + 'ramAction' => [ + 'action' => 'pairec:GetService', + 'authLevel' => 'operate', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'PAIRecService', 'resourceType' => 'All Resource', 'arn' => '*'], + ], + ], + ], + [ + 'apiName' => 'GetExperimentGroup', + 'description' => '', + 'operationType' => 'get', + 'ramAction' => [ + 'action' => 'pairec:GetExperimentGroup', + 'authLevel' => 'operate', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'PAIRecService', 'resourceType' => 'All Resource', 'arn' => '*'], + ], + ], + ], + [ + 'apiName' => 'CheckInstanceResources', + 'description' => '', + 'operationType' => 'none', + 'ramAction' => [ + 'action' => 'pairec:CheckInstanceResources', + 'authLevel' => 'operate', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'PAIRecService', 'resourceType' => 'All Resource', 'arn' => '*'], + ], + ], + ], + [ + 'apiName' => 'ListCalculationJobs', + 'description' => '', + 'operationType' => 'list', + 'ramAction' => [ + 'action' => 'pairec:ListCalculationJobs', + 'authLevel' => 'operate', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'PAIRecService', 'resourceType' => 'All Resource', 'arn' => '*'], + ], + ], + ], + [ + 'apiName' => 'CreateSubCrowd', + 'description' => '', + 'operationType' => 'create', + 'ramAction' => [ + 'action' => 'pairec:CreateSubCrowd', + 'authLevel' => 'operate', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'PAIRecService', 'resourceType' => 'All Resource', 'arn' => '*'], + ], + ], + ], + [ + 'apiName' => 'DeleteRecallManagementServiceVersionConfig', + 'description' => '', + 'operationType' => 'none', + 'ramAction' => [ + 'action' => 'pairec:DeleteRecallManagementServiceVersionConfig', + 'authLevel' => 'operate', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'PAIRecService', 'resourceType' => 'All Resource', 'arn' => '*'], + ], + ], + ], + [ + 'apiName' => 'PushAllExperiment', + 'description' => '', + 'operationType' => 'none', + 'ramAction' => [ + 'action' => 'pairec:PushAllExperiment', + 'authLevel' => 'operate', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'PAIRecService', 'resourceType' => 'All Resource', 'arn' => '*'], + ], + ], + ], + [ + 'apiName' => 'CreateRecallManagementService', + 'description' => '', + 'operationType' => 'create', + 'ramAction' => [ + 'action' => 'pairec:CreateRecallManagementService', + 'authLevel' => 'operate', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'PAIRecService', 'resourceType' => 'All Resource', 'arn' => '*'], + ], + ], + ], + [ + 'apiName' => 'OfflineExperiment', + 'description' => '', + 'operationType' => 'none', + 'ramAction' => [ + 'action' => 'pairec:OfflineExperiment', + 'authLevel' => 'operate', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'PAIRecService', 'resourceType' => 'All Resource', 'arn' => '*'], + ], + ], + ], + [ + 'apiName' => 'GetRecallManagementJob', + 'description' => '', + 'operationType' => 'get', + 'ramAction' => [ + 'action' => 'pairec:GetRecallManagementJob', + 'authLevel' => 'operate', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'PAIRecService', 'resourceType' => 'All Resource', 'arn' => '*'], + ], + ], + ], + [ + 'apiName' => 'CloneExperimentGroup', + 'description' => '', + 'operationType' => 'none', + 'ramAction' => [ + 'action' => 'pairec:CloneExperimentGroup', + 'authLevel' => 'operate', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'PAIRecService', 'resourceType' => 'All Resource', 'arn' => '*'], + ], + ], + ], + [ + 'apiName' => 'CreateRecallManagementServiceVersionConfig', + 'description' => '', + 'operationType' => 'none', + 'ramAction' => [ + 'action' => 'pairec:CreateRecallManagementServiceVersionConfig', + 'authLevel' => 'operate', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'PAIRecService', 'resourceType' => 'All Resource', 'arn' => '*'], + ], + ], + ], + [ + 'apiName' => 'GetRecallManagementConfig', + 'description' => '', + 'operationType' => 'get', + 'ramAction' => [ + 'action' => 'pairec:GetRecallManagementConfig', + 'authLevel' => 'operate', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'PAIRecService', 'resourceType' => 'All Resource', 'arn' => '*'], + ], + ], + ], + [ + 'apiName' => 'GenerateAlgorithmCustomizationScript', + 'description' => '', + 'operationType' => 'none', + 'ramAction' => [ + 'action' => 'pairec:GenerateAlgorithmCustomizationScript', + 'authLevel' => 'operate', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'PAIRecService', 'resourceType' => 'All Resource', 'arn' => '*'], + ], + ], + ], + [ + 'apiName' => 'ListFeatureConsistencyCheckJobConfigs', + 'description' => '', + 'operationType' => 'list', + 'ramAction' => [ + 'action' => 'pairec:ListFeatureConsistencyCheckJobConfigs', + 'authLevel' => 'operate', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'PAIRecService', 'resourceType' => 'All Resource', 'arn' => '*'], + ], + ], + ], + [ + 'apiName' => 'UpdateScene', + 'description' => '', + 'operationType' => 'update', + 'ramAction' => [ + 'action' => 'pairec:UpdateScene', + 'authLevel' => 'operate', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'PAIRecService', 'resourceType' => 'All Resource', 'arn' => '*'], + ], + ], + ], + [ + 'apiName' => 'DeleteEngineConfig', + 'description' => '', + 'operationType' => 'none', + 'ramAction' => [ + 'action' => 'pairec:DeleteEngineConfig', + 'authLevel' => 'operate', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'PAIRecService', 'resourceType' => 'All Resource', 'arn' => '*'], + ], + ], + ], + [ + 'apiName' => 'CreateLaboratory', + 'description' => '', + 'operationType' => 'create', + 'ramAction' => [ + 'action' => 'pairec:CreateLaboratory', + 'authLevel' => 'operate', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'PAIRecService', 'resourceType' => 'All Resource', 'arn' => '*'], + ], + ], + ], + [ + 'apiName' => 'CreateEngineConfig', + 'description' => '', + 'operationType' => 'create', + 'ramAction' => [ + 'action' => 'pairec:CreateEngineConfig', + 'authLevel' => 'operate', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'PAIRecService', 'resourceType' => 'All Resource', 'arn' => '*'], + ], + ], + ], + [ + 'apiName' => 'ListTrafficControlTargetTrafficHistory', + 'description' => '', + 'operationType' => 'none', + 'ramAction' => [ + 'action' => 'pairec:ListTrafficControlTargetTrafficHistory', + 'authLevel' => 'operate', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'PAIRecService', 'resourceType' => 'All Resource', 'arn' => '*'], + ], + ], + ], + [ + 'apiName' => 'GenerateTrafficControlTaskCode', + 'description' => '', + 'operationType' => 'none', + 'ramAction' => [ + 'action' => 'pairec:GenerateTrafficControlTaskCode', + 'authLevel' => 'operate', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'PAIRecService', 'resourceType' => 'All Resource', 'arn' => '*'], + ], + ], + ], + [ + 'apiName' => 'DeployTrafficControlTaskCode', + 'description' => '', + 'operationType' => 'none', + 'ramAction' => [ + 'action' => 'pairec:DeployTrafficControlTaskCode', + 'authLevel' => 'operate', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'PAIRecService', 'resourceType' => 'All Resource', 'arn' => '*'], + ], + ], + ], + [ + 'apiName' => 'UpdateRecallManagementServiceVersionConfig', + 'description' => '', + 'operationType' => 'none', + 'ramAction' => [ + 'action' => 'pairec:UpdateRecallManagementServiceVersionConfig', + 'authLevel' => 'operate', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'PAIRecService', 'resourceType' => 'All Resource', 'arn' => '*'], + ], + ], + ], + [ + 'apiName' => 'GetCalculationJob', + 'description' => '', + 'operationType' => 'get', + 'ramAction' => [ + 'action' => 'pairec:GetCalculationJob', + 'authLevel' => 'operate', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'PAIRecService', 'resourceType' => 'All Resource', 'arn' => '*'], + ], + ], + ], + [ + 'apiName' => 'StartTrafficControlTask', + 'description' => '', + 'operationType' => 'none', + 'ramAction' => [ + 'action' => 'pairec:StartTrafficControlTask', + 'authLevel' => 'operate', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'PAIRecService', 'resourceType' => 'All Resource', 'arn' => '*'], + ], + ], + ], + [ + 'apiName' => 'ListLaboratories', + 'description' => '', + 'operationType' => 'list', + 'ramAction' => [ + 'action' => 'pairec:ListLaboratories', + 'authLevel' => 'operate', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'PAIRecService', 'resourceType' => 'All Resource', 'arn' => '*'], + ], + ], + ], + [ + 'apiName' => 'ListFeatureConsistencyCheckJobScoreReports', + 'description' => '', + 'operationType' => 'list', + 'ramAction' => [ + 'action' => 'pairec:ListFeatureConsistencyCheckJobScoreReports', + 'authLevel' => 'operate', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'PAIRecService', 'resourceType' => 'All Resource', 'arn' => '*'], + ], + ], + ], + [ + 'apiName' => 'DeleteRecallManagementTable', + 'description' => '', + 'operationType' => 'delete', + 'ramAction' => [ + 'action' => 'pairec:DeleteRecallManagementTable', + 'authLevel' => 'operate', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'PAIRecService', 'resourceType' => 'All Resource', 'arn' => '*'], + ], + ], + ], + [ + 'apiName' => 'ListCrowds', + 'description' => '', + 'operationType' => 'list', + 'ramAction' => [ + 'action' => 'pairec:ListCrowds', + 'authLevel' => 'operate', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'PAIRecService', 'resourceType' => 'All Resource', 'arn' => '*'], + ], + ], + ], + [ + 'apiName' => 'GetInstanceResourceTable', + 'description' => '', + 'operationType' => 'none', + 'ramAction' => [ + 'action' => 'pairec:GetInstanceResourceTable', + 'authLevel' => 'operate', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'PAIRecService', 'resourceType' => 'All Resource', 'arn' => '*'], + ], + ], + ], + [ + 'apiName' => 'UpdateTrafficControlTaskTraffic', + 'description' => '', + 'operationType' => 'none', + 'ramAction' => [ + 'action' => 'pairec:UpdateTrafficControlTaskTraffic', + 'authLevel' => 'operate', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'PAIRecService', 'resourceType' => 'All Resource', 'arn' => '*'], + ], + ], + ], + [ + 'apiName' => 'UpdateRecallManagementTable', + 'description' => '', + 'operationType' => 'update', + 'ramAction' => [ + 'action' => 'pairec:UpdateRecallManagementTable', + 'authLevel' => 'operate', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'PAIRecService', 'resourceType' => 'All Resource', 'arn' => '*'], + ], + ], + ], + [ + 'apiName' => 'ListRecallManagementServiceVersions', + 'description' => '', + 'operationType' => 'none', + 'ramAction' => [ + 'action' => 'pairec:ListRecallManagementServiceVersions', + 'authLevel' => 'operate', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'PAIRecService', 'resourceType' => 'All Resource', 'arn' => '*'], + ], + ], + ], + [ + 'apiName' => 'GetFeatureConsistencyCheckJobConfig', + 'description' => '', + 'operationType' => 'get', + 'ramAction' => [ + 'action' => 'pairec:GetFeatureConsistencyCheckJobConfig', + 'authLevel' => 'operate', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'PAIRecService', 'resourceType' => 'All Resource', 'arn' => '*'], + ], + ], + ], + [ + 'apiName' => 'StopTrafficControlTarget', + 'description' => '', + 'operationType' => 'none', + 'ramAction' => [ + 'action' => 'pairec:StopTrafficControlTarget', + 'authLevel' => 'operate', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'PAIRecService', 'resourceType' => 'All Resource', 'arn' => '*'], + ], + ], + ], + [ + 'apiName' => 'SplitTrafficControlTarget', + 'description' => '', + 'operationType' => 'none', + 'ramAction' => [ + 'action' => 'pairec:SplitTrafficControlTarget', + 'authLevel' => 'operate', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'PAIRecService', 'resourceType' => 'All Resource', 'arn' => '*'], + ], + ], + ], + [ + 'apiName' => 'CloneExperiment', + 'description' => '', + 'operationType' => 'none', + 'ramAction' => [ + 'action' => 'pairec:CloneExperiment', + 'authLevel' => 'operate', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'PAIRecService', 'resourceType' => 'All Resource', 'arn' => '*'], + ], + ], + ], + [ + 'apiName' => 'GetABMetricGroup', + 'description' => '', + 'operationType' => 'get', + 'ramAction' => [ + 'action' => 'pairec:GetABMetricGroup', + 'authLevel' => 'operate', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'PAIRecService', 'resourceType' => 'All Resource', 'arn' => '*'], + ], + ], + ], + [ + 'apiName' => 'CreateCalculationJobs', + 'description' => '', + 'operationType' => 'create', + 'ramAction' => [ + 'action' => 'pairec:CreateCalculationJobs', + 'authLevel' => 'operate', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'PAIRecService', 'resourceType' => 'All Resource', 'arn' => '*'], + ], + ], + ], + [ + 'apiName' => 'ListDataDiagnoses', + 'description' => '', + 'operationType' => 'get', + 'ramAction' => [ + 'action' => 'pairec:ListDataDiagnoses', + 'authLevel' => 'operate', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'PAIRecService', 'resourceType' => 'All Resource', 'arn' => '*'], + ], + ], + ], + [ + 'apiName' => 'ListExperiments', + 'description' => '', + 'operationType' => 'list', + 'ramAction' => [ + 'action' => 'pairec:ListExperiments', + 'authLevel' => 'operate', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'PAIRecService', 'resourceType' => 'All Resource', 'arn' => '*'], + ], + ], + ], + [ + 'apiName' => 'GetEngineConfig', + 'description' => '', + 'operationType' => 'get', + 'ramAction' => [ + 'action' => 'pairec:GetEngineConfig', + 'authLevel' => 'operate', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'PAIRecService', 'resourceType' => 'All Resource', 'arn' => '*'], + ], + ], + ], ], + 'resourceTypes' => [], ], ]; |