'1.0', 'info' => [ 'style' => 'ROA', 'product' => 'OpenSearch', 'version' => '2017-12-25', ], 'directories' => [ [ 'id' => 170735, 'title' => '应用实例', 'type' => 'directory', 'children' => [ [ 'id' => 170736, 'title' => '应用管理', 'type' => 'directory', 'children' => [ 'RenewAppGroup', 'CreateAppGroup', 'ModifyAppGroup', 'ModifyAppGroupQuota', 'RemoveAppGroup', 'ListAppGroups', ], ], [ 'id' => 170744, 'title' => '应用版本', 'type' => 'directory', 'children' => [ 'CreateApp', 'RemoveApp', 'DescribeApps', 'DescribeApp', 'DescribeAppStatistics', ], ], ], ], [ 'id' => 170894, 'title' => '实例周边', 'type' => 'directory', 'children' => [ [ 'id' => 170895, 'title' => '自定义分析器', 'type' => 'directory', 'children' => [ 'ListUserAnalyzers', 'CreateUserAnalyzer', 'DescribeUserAnalyzer', 'RemoveUserAnalyzer', 'ListUserAnalyzerEntries', 'PushUserAnalyzerEntries', ], ], [ 'id' => 170905, 'title' => 'ABTest', 'type' => 'directory', 'children' => [ [ 'id' => 170906, 'title' => '实验场景', 'type' => 'directory', 'children' => [ 'ListABTestScenes', 'CreateABTestScene', 'DescribeABTestScene', 'UpdateABTestScene', 'DeleteABTestScene', ], ], [ 'id' => 170976, 'title' => '实验组', 'type' => 'directory', 'children' => [ 'ListABTestGroups', 'CreateABTestGroup', 'DeleteABTestGroup', 'DescribeABTestGroup', 'UpdateABTestGroup', ], ], [ 'id' => 170977, 'title' => '实验', 'type' => 'directory', 'children' => [ 'ListABTestExperiments', 'CreateABTestExperiment', 'DescribeABTestExperiment', 'UpdateABTestExperiment', 'DeleteABTestExperiment', ], ], [ 'id' => 170978, 'title' => '白名单', 'type' => 'directory', 'children' => [ 'ListABTestFixedFlowDividers', 'UpdateABTestFixedFlowDividers', ], ], ], ], [ 'id' => 170979, 'title' => '粗排表达式', 'type' => 'directory', 'children' => [ 'ListFirstRanks', 'CreateFirstRank', 'DescribeFirstRank', 'RemoveFirstRank', 'ModifyFirstRank', ], ], [ 'id' => 170980, 'title' => '精排表达式', 'type' => 'directory', 'children' => [ 'ListSecondRanks', 'CreateSecondRank', 'DescribeSecondRank', 'ModifySecondRank', 'RemoveSecondRank', ], ], [ 'id' => 170981, 'title' => '查询分析器', 'type' => 'directory', 'children' => [ 'ListQueryProcessors', 'CreateQueryProcessor', 'ModifyQueryProcessor', 'RemoveQueryProcessor', 'DescribeQueryProcessor', 'ListQueryProcessorNers', 'ListQueryProcessorAnalyzerResults', ], ], [ 'id' => 170982, 'title' => '干预词典', 'type' => 'directory', 'children' => [ 'ListInterventionDictionaries', 'CreateInterventionDictionary', 'DescribeInterventionDictionary', 'RemoveInterventionDictionary', 'ListInterventionDictionaryEntries', 'PushInterventionDictionaryEntries', 'ListInterventionDictionaryRelatedEntities', 'ListInterventionDictionaryNerResults', ], ], [ 'id' => 170983, 'title' => '优化大师', 'type' => 'directory', 'children' => [ 'EnableSlowQuery', 'DisableSlowQuery', 'DescribeSlowQueryStatus', 'StartSlowQueryAnalyzer', 'ListSlowQueryQueries', 'ListSlowQueryCategories', ], ], [ 'id' => 170984, 'title' => '配额审批', 'type' => 'directory', 'children' => [ 'ListQuotaReviewTasks', ], ], [ 'id' => 170985, 'title' => '定时任务', 'type' => 'directory', 'children' => [ 'ListScheduledTasks', 'CreateScheduledTask', 'DescribeScheduledTask', 'ModifyScheduledTask', 'RemoveScheduledTask', ], ], [ 'id' => 170986, 'title' => '搜索策略', 'type' => 'directory', 'children' => [ 'ListSortExpressions', ], ], [ 'id' => 170987, 'title' => 'ElasticSearch引擎实例', 'type' => 'directory', 'children' => [ 'UnbindEsInstance', 'BindEsInstance', 'BindESUserAnalyzer', 'UnbindESUserAnalyzer', ], ], [ 'id' => 170988, 'title' => '当前处理流', 'type' => 'directory', 'children' => [ 'ListProceedings', ], ], [ 'id' => 170989, 'title' => '统计', 'type' => 'directory', 'children' => [ 'ListStatisticLogs', 'ListStatisticReport', ], ], [ 'id' => 175840, 'title' => 'cava脚本', 'type' => 'directory', 'children' => [ 'UpdateSortScript', 'SaveSortScriptFile', 'ReleaseSortScript', 'GetSortScriptFile', 'GetSortScript', 'GetScriptFileNames', 'DeleteSortScriptFile', 'DeleteSortScript', 'CreateSortScript', 'CompileSortScript', ], ], [ 'id' => 175844, 'title' => '查询策略', 'type' => 'directory', 'children' => [ 'UpdateSearchStrategy', 'RemoveSearchStrategy', 'ListSearchStrategies', 'GetSearchStrategy', 'CreateSearchStrategy', ], ], ], ], [ 'id' => 170990, 'title' => '版本周边', 'type' => 'directory', 'children' => [ [ 'id' => 170991, 'title' => '默认展示字段', 'type' => 'directory', 'children' => [ 'UpdateFetchFields', ], ], [ 'id' => 170992, 'title' => '搜索结果摘要', 'type' => 'directory', 'children' => [ 'UpdateSummaries', ], ], ], ], [ 'id' => 170993, 'title' => '算法周边', 'type' => 'directory', 'children' => [ 'CreateFunctionResource', 'GetFunctionCurrentVersion', 'GetFunctionVersion', 'GetFunctionDefaultInstance', 'UpdateFunctionDefaultInstance', 'ListFunctionTasks', 'GetFunctionTask', 'DeleteFunctionTask', 'CreateFunctionTask', 'ListFunctionInstances', 'GetFunctionInstance', 'DeleteFunctionInstance', 'UpdateFunctionInstance', 'CreateFunctionInstance', ], ], [ 'id' => 170783, 'title' => '其它(未在目录中的文档)', 'type' => 'directory', 'children' => [ 'DescribeAppGroup', 'ValidateDataSources', 'ReplaceAppGroupCommodityCode', 'ListSortScripts', 'ListDataSourceTables', 'ListDataSourceTableFields', 'GetDomain', 'GenerateMergedTable', 'DescribeRegions', ], ], [ 'id' => 170995, 'title' => '其他', 'type' => 'directory', 'children' => [ 'DescribeDataCollction', 'ListDataCollections', 'RemoveDataCollection', 'UntagResources', 'ListTagResources', 'TagResources', 'GetFunctionResource', 'ListFunctionResources', 'DeleteFunctionResource', 'UpdateFunctionResource', 'CreateAppGroupCredentials', ], ], ], 'components' => [ 'schemas' => [ 'ABTestExperiment' => [ 'title' => 'ABTest实验', 'description' => 'ABTest实验', 'type' => 'object', 'properties' => [ 'name' => [ 'title' => '实验别名', 'description' => '实验别名', 'type' => 'string', 'example' => 'my_test', ], 'traffic' => [ 'title' => '实验分桶百分比', 'description' => '实验分桶百分比，取值范围：[0-100]', 'type' => 'integer', 'format' => 'int32', 'example' => '10', ], 'serialNumber' => [ 'title' => 'hyperspace自动生成的实验序列号', 'description' => 'hyperspace自动生成的实验序列号', 'type' => 'integer', 'format' => 'int32', 'example' => '85373', ], 'online' => [ 'title' => '实验是否在线', 'description' => '实验状态'."\n" .'- true 生效'."\n" .'- false 未生效', 'type' => 'boolean', 'example' => 'false', ], 'params' => [ 'title' => '实验参数', 'description' => '实验参数', 'type' => 'object', 'additionalProperties' => [ 'description' => '参数项'."\n" .'- firstFormulaName 基础排序名称'."\n" .'- formulaName 业务排序名称'."\n" .'- qpChainName 查询分析名称 '."\n" .'- catePredictModel 类目预测模型名称', 'type' => 'string', 'example' => '{'."\n" .' "firstFormulaName": "default"'."\n" .' }', ], ], ], ], 'ABTestGroup' => [ 'title' => 'ABTest实验组', 'description' => 'ABTest实验组', 'type' => 'object', 'properties' => [ 'name' => [ 'title' => '实验组别名', 'description' => '实验组别名', 'type' => 'string', 'example' => '“kevin_test”', ], 'status' => [ 'title' => '实验组状态', 'description' => '实验组状态'."\n" ."\n" .'- 0 未生效'."\n" .'- 1 生效', 'type' => 'integer', 'format' => 'int32', 'example' => '1', ], ], ], 'ABTestScene' => [ 'title' => 'ABTest实验场景', 'description' => 'ABTest实验场景', 'type' => 'object', 'properties' => [ 'name' => [ 'title' => '场景别名', 'description' => '场景别名', 'type' => 'string', 'example' => 'test', ], 'values' => [ 'title' => '场景标识', 'description' => '场景标识', 'type' => 'array', 'items' => [ 'description' => '场景标识', 'type' => 'string', 'example' => 'test', ], ], 'status' => [ 'title' => '场景状态', 'description' => '场景状态'."\n" .'- 0 停止实验'."\n" .'- 1 启动实验', 'type' => 'integer', 'format' => 'int32', 'example' => '0', ], ], ], 'App' => [ 'title' => 'A short description of struct', 'description' => '应用版本', 'type' => 'object', 'properties' => [ 'autoSwitch' => [ 'title' => '是否自动切换', 'type' => 'boolean', ], 'networkType' => [ 'title' => '可用区标识', 'type' => 'string', ], 'description' => [ 'title' => '版本描述', 'type' => 'string', ], 'schema' => [ 'title' => '应用结构', '$ref' => '#/components/schemas/Schema', ], 'schemas' => [ 'title' => '应用结构', 'type' => 'array', 'items' => [ '$ref' => '#/components/schemas/Schema', ], ], 'fetchFields' => [ 'title' => '默认展示字段', 'type' => 'array', 'items' => [ 'type' => 'string', ], ], 'firstRanks' => [ 'title' => '粗排表达式配置', 'type' => 'array', 'items' => [ '$ref' => '#/components/schemas/FirstRank', ], ], 'secondRanks' => [ 'title' => '精排表达式配置', 'type' => 'array', 'items' => [ '$ref' => '#/components/schemas/SecondRank', ], ], 'dataSources' => [ 'title' => '数据源配置', 'type' => 'array', 'items' => [ '$ref' => '#/components/schemas/DataSource', ], ], 'summaries' => [ 'title' => '搜索结果摘要设置', 'type' => 'array', 'items' => [ '$ref' => '#/components/schemas/Summary', ], ], 'queryProcessors' => [ 'title' => '查询意图理解规则配置', 'type' => 'array', 'items' => [ '$ref' => '#/components/schemas/QueryProcessor', ], ], 'realtimeShared' => [ 'title' => '是否共享实时流？', 'type' => 'boolean', ], 'cluster' => [ 'title' => '能力开放配置', 'type' => 'object', 'properties' => [ 'maxTimeoutMS' => [ 'title' => '超时时间', 'type' => 'integer', 'format' => 'int32', ], 'maxQueryClauseLength' => [ 'title' => '最大长度', 'type' => 'integer', 'format' => 'int32', ], ], ], 'domain' => [ 'title' => '行业模型', '$ref' => '#/components/schemas/Domain', ], 'type' => [ 'title' => '版本类型', 'type' => 'string', ], 'quota' => [ 'title' => '版本配额', '$ref' => '#/components/schemas/Quota', ], ], ], 'AppGroup' => [ 'title' => '应用', 'type' => 'object', 'properties' => [ 'name' => [ 'title' => '应用名称', 'type' => 'string', ], 'quota' => [ 'title' => '配额信息', '$ref' => '#/components/schemas/Quota', ], 'type' => [ 'title' => '应用类型', 'type' => 'string', ], 'chargeType' => [ 'title' => '付费类型', 'type' => 'string', ], 'description' => [ 'title' => '应用描述', 'type' => 'string', ], 'domain' => [ 'title' => '行业类型', 'type' => 'string', ], 'resourceGroupId' => [ 'title' => '资源组ID', 'type' => 'string', ], 'order' => [ 'title' => '订购周期信息', 'type' => 'object', 'properties' => [ 'duration' => [ 'title' => '订购周期', 'type' => 'integer', 'format' => 'int64', 'example' => '1', ], 'pricingCycle' => [ 'title' => '订购周期单位', 'type' => 'string', 'example' => 'Month', ], 'autoRenew' => [ 'title' => '是否要自动续费', 'type' => 'boolean', 'example' => 'false', ], ], ], ], ], 'DataSource' => [ 'title' => '数据源配置', 'type' => 'object', 'properties' => [ 'tableName' => [ 'title' => '数据源配置标识', 'type' => 'string', ], 'type' => [ 'title' => '数据源类型', 'type' => 'string', ], 'fields' => [ 'title' => '数据源表字段 => 应用表字段映射', 'type' => 'array', 'items' => [ 'type' => 'object', 'additionalProperties' => [ 'type' => 'string', ], ], ], 'plugins' => [ 'title' => '数据源插件', 'type' => 'object', 'additionalProperties' => [ 'type' => 'object', 'properties' => [ 'name' => [ 'title' => '插件名称', 'type' => 'string', ], 'fromFields' => [ 'title' => '数据来源字段', 'type' => 'string', ], 'parameters' => [ 'title' => '插件参数', 'type' => 'object', 'additionalProperties' => [ 'type' => 'string', ], ], ], ], ], 'keyField' => [ 'title' => '主键', 'type' => 'string', ], 'schemaName' => [ 'title' => '宽表名称', 'type' => 'string', ], 'parameters' => [ 'title' => '数据源信息', 'type' => 'object', ], ], ], 'Domain' => [ 'title' => '行业模型', 'description' => '行业模型', 'type' => 'object', 'properties' => [ 'name' => [ 'title' => '行业类型', 'type' => 'string', ], 'category' => [ 'title' => '行业垂类', 'type' => 'string', ], 'functions' => [ 'title' => '已选择功能', 'type' => 'object', 'additionalProperties' => [ 'type' => 'array', 'items' => [ 'type' => 'string', ], ], ], ], ], 'FirstRank' => [ 'title' => '粗排表达式配置', 'type' => 'object', 'properties' => [ 'type' => [ 'title' => '表达式类型 (STRUCT, STRING)', 'type' => 'string', ], 'name' => [ 'title' => '名称', 'type' => 'string', ], 'description' => [ 'title' => '描述', 'type' => 'string', ], 'active' => [ 'title' => '是否是默认表达式', 'type' => 'boolean', ], 'meta' => [ 'title' => '表达式信息', 'type' => 'any', ], ], ], 'PrepayOrderInfo' => [ 'title' => '预付费订购信息', 'description' => '预付费订购信息', 'type' => 'object', 'properties' => [ 'duration' => [ 'title' => '持续时间', 'description' => '持续时间', 'type' => 'integer', 'format' => 'int32', 'example' => '1', ], 'pricingCycle' => [ 'title' => '周期', 'description' => '周期:'."\n" ."\n" .'- Year'."\n" .'- Month', 'type' => 'string', 'example' => 'Year', ], 'autoRenew' => [ 'title' => '是否要自动续费', 'description' => '是否要自动续费', 'type' => 'boolean', 'example' => 'false', ], ], ], 'Proceeding' => [ 'type' => 'object', 'properties' => [ 'progress' => [ 'type' => 'number', 'format' => 'float', ], 'type' => [ 'type' => 'string', ], 'status' => [ 'type' => 'string', ], 'subTasks' => [ '$ref' => '#/components/schemas/Proceeding', ], 'detail' => [ 'type' => 'object', ], ], ], 'QueryProcessor' => [ 'title' => '查询意图理解规则配置', 'type' => 'object', 'properties' => [ 'name' => [ 'title' => '规则名称', 'type' => 'string', ], 'domain' => [ 'title' => '行业类型', 'type' => 'string', ], 'category' => [ 'title' => '垂类', 'type' => 'string', ], 'processors' => [ 'title' => '包含功能', 'type' => 'array', 'items' => [ 'type' => 'object', ], ], 'indexes' => [ 'title' => '应用的索引范围', 'type' => 'array', 'items' => [ 'type' => 'string', ], ], 'active' => [ 'title' => '是否默认规则', 'type' => 'boolean', ], ], ], 'Quota' => [ 'title' => '版本配额', 'type' => 'object', 'properties' => [ 'docSize' => [ 'title' => '存储容量 (单位:GB)', 'type' => 'integer', 'format' => 'int32', ], 'computeResource' => [ 'title' => '计算资源 (单位:LCU)', 'type' => 'integer', 'format' => 'int32', ], 'spec' => [ 'title' => '规格', 'type' => 'string', ], 'orderType' => [ 'title' => '变配类型', 'type' => 'string', ], ], ], 'ScheduledTask' => [ 'title' => '定时任务', 'description' => '定时任务', 'type' => 'object', 'properties' => [ 'type' => [ 'title' => '任务类型', 'type' => 'string', ], 'cron' => [ 'title' => '时间表达式', 'type' => 'string', ], 'enabled' => [ 'title' => '是否执行', 'type' => 'boolean', ], 'version' => [ 'title' => '待删除版本号', 'type' => 'string', ], 'forkedAppId' => [ 'title' => '上一个版本id', 'type' => 'string', ], 'autoSwitch' => [ 'title' => '是否自动切换上线', 'type' => 'boolean', ], 'permanent' => [ 'title' => '是否持久化', 'type' => 'boolean', ], 'runNow' => [ 'title' => '是否立即执行', 'type' => 'boolean', ], 'filter' => [ 'title' => '清理配置', 'type' => 'object', 'properties' => [ 'field' => [ 'title' => '过滤字段名称', 'type' => 'string', ], 'days' => [ 'title' => '保留天数', 'type' => 'integer', 'format' => 'int32', ], 'unit' => [ 'title' => '时间单位', 'type' => 'string', ], 'expression' => [ 'title' => '表达式', 'type' => 'string', ], ], ], ], ], 'Schema' => [ 'title' => '应用结构', 'type' => 'object', 'properties' => [ 'tables' => [ 'title' => '用户数据表', 'type' => 'object', 'additionalProperties' => [ 'type' => 'object', 'properties' => [ 'name' => [ 'title' => '表名称', 'type' => 'string', ], 'primaryTable' => [ 'title' => '是否是主表', 'type' => 'boolean', ], 'fields' => [ 'title' => '字段清单', 'type' => 'object', 'additionalProperties' => [ 'type' => 'object', 'properties' => [ 'name' => [ 'title' => '字段名称', 'type' => 'string', ], 'primaryKey' => [ 'title' => '是否是主键', 'type' => 'boolean', ], 'type' => [ 'title' => '字段类型 (INT, INT_ARRAY, FLOAT, FLOAT_ARRAY, DOUBLE, DOUBLE_ARRAY, TEXT, SHORT_TEXT, LITERAL, LITERAL_ARRAY, GEO_POINT, TIMESTAMP)', 'type' => 'string', ], 'joinWith' => [ 'title' => '外表链接的数据表集合', 'type' => 'array', 'items' => [ 'type' => 'string', ], ], 'label' => [ 'title' => '字段标签', 'type' => 'string', ], ], ], ], ], ], ], 'indexes' => [ 'title' => '索引配置', 'type' => 'object', 'properties' => [ 'searchFields' => [ 'title' => '索引字段', 'type' => 'object', 'additionalProperties' => [ 'type' => 'object', 'properties' => [ 'analyzer' => [ 'title' => '分析器名称', 'type' => 'string', ], 'analyzerType' => [ 'title' => '分析器类型 (AUTO, MODEL, SYSTEM, USER)', 'type' => 'string', ], 'analyzerGeneration' => [ 'title' => '模型定制分析器Generation', 'type' => 'string', ], 'fields' => [ 'title' => '索引字段集合', 'type' => 'array', 'items' => [ 'type' => 'string', ], ], 'label' => [ 'title' => '索引标签', 'type' => 'string', ], ], ], ], 'filterFields' => [ 'title' => '属性字段集合', 'type' => 'array', 'items' => [ 'type' => 'string', ], ], ], ], 'routeField' => [ 'title' => '一级分列字段名称', 'type' => 'string', ], 'routeFieldValues' => [ 'title' => '一级分列字段热点值清单（配置后启用“二级分列”）', 'type' => 'array', 'items' => [ 'type' => 'string', ], ], 'secondRouteField' => [ 'title' => '二级分列字段名称（当且仅当配置有`routeFieldValues`时生效，默认使用宽表主键）', 'type' => 'string', ], 'ttlField' => [ 'title' => '文档清理配置', 'type' => 'object', 'properties' => [ 'name' => [ 'title' => '文档时间字段', 'type' => 'string', ], 'ttl' => [ 'title' => '存活时间（毫秒）', 'type' => 'integer', 'format' => 'int64', ], ], ], 'indexSortConfig' => [ 'title' => '倒排索引配置', 'type' => 'array', 'items' => [ 'type' => 'object', 'properties' => [ 'field' => [ 'title' => '字段', 'type' => 'string', ], 'direction' => [ 'title' => '排序方式ASC, DESC', 'type' => 'string', ], ], ], ], 'name' => [ 'title' => '宽表表名', 'type' => 'string', ], ], ], 'SearchStrategy' => [ 'title' => '查询策略', 'description' => '查询策略', 'type' => 'object', 'properties' => [ 'name' => [ 'title' => '策略名称', 'type' => 'string', ], 'description' => [ 'title' => '策略描述', 'type' => 'string', ], 'searchConfigs' => [ 'title' => '查询策略', 'type' => 'array', 'items' => [ 'type' => 'object', 'properties' => [ 'queryType' => [ 'title' => '查询类型', 'type' => 'string', 'example' => 'keyword: 关键字查询 vector: 向量查询', ], 'firstRankName' => [ 'title' => '基础排序名称', 'type' => 'string', ], 'secondRankName' => [ 'title' => '业务排序名称', 'type' => 'string', ], 'mergeProportion' => [ 'title' => '参与综合排序的比例', 'type' => 'integer', 'format' => 'int32', ], ], ], ], 'mergeConfig' => [ 'title' => '归并排序配置', 'type' => 'object', 'properties' => [ 'rankName' => [ 'title' => '归并排序名称', 'type' => 'string', ], 'docCount' => [ 'title' => '归并排序文档数', 'type' => 'integer', 'format' => 'int32', ], ], ], 'isDefault' => [ 'title' => '是否设置默认', 'type' => 'boolean', ], ], ], 'SecondRank' => [ 'title' => '精排表达式配置', 'type' => 'object', 'properties' => [ 'meta' => [ 'title' => '表达式', 'type' => 'any', ], 'name' => [ 'title' => '名称', 'type' => 'string', ], 'description' => [ 'title' => '描述', 'type' => 'string', ], 'active' => [ 'title' => '是否是默认表达式', 'type' => 'boolean', ], ], ], 'Summary' => [ 'title' => '搜索结果摘要设置', 'type' => 'object', 'properties' => [ 'name' => [ 'title' => '名称', 'type' => 'string', ], 'meta' => [ 'title' => '结构化表达式', 'type' => 'object', 'properties' => [ 'field' => [ 'title' => '字段', 'type' => 'string', ], 'len' => [ 'title' => '片段长度', 'type' => 'integer', 'format' => 'int32', ], 'element' => [ 'title' => '飘红标签', 'type' => 'string', ], 'ellipsis' => [ 'title' => '片段连接符', 'type' => 'string', ], 'snippet' => [ 'title' => '片段数量', 'type' => 'string', ], ], ], 'active' => [ 'title' => '是否是默认搜索结果摘要', 'type' => 'boolean', ], ], ], ], ], 'apis' => [ 'RenewAppGroup' => [ 'summary' => '为应用续费（续费暂不支持API调用，请在控制台操作续费）。', 'path' => '/v4/openapi/app-groups/{appGroupIdentity}/actions/renew', 'methods' => [ 'post', ], 'schemes' => [ 'http', 'https', ], 'security' => [ [ 'AK' => [], ], ], 'operationType' => 'write', 'deprecated' => false, 'systemTags' => [ 'operationType' => 'update', 'riskType' => 'none', 'chargeType' => 'paid', 'abilityTreeNodes' => [ 'FEATUREopensearch447AAX', ], ], 'parameters' => [ [ 'name' => 'appGroupIdentity', 'in' => 'path', 'schema' => [ 'description' => '应用名称', 'type' => 'string', 'required' => true, 'docRequired' => true, 'example' => 'my_app', ], ], [ 'name' => 'clientToken', 'in' => 'query', 'schema' => [ 'description' => '保证请求幂等性', 'type' => 'string', 'required' => false, 'example' => '74db41d8cd3c784209093aa76afbe89e', ], ], [ 'name' => 'body', 'in' => 'body', 'schema' => [ 'description' => '续费请求体', 'required' => false, '$ref' => '#/components/schemas/PrepayOrderInfo', ], ], ], 'responses' => [ 200 => [ 'schema' => [ 'description' => '响应体', 'type' => 'object', 'properties' => [ 'requestId' => [ 'description' => '请求ID', 'type' => 'string', 'example' => 'D77D0DAF-790D-F5F5-A9C0-133738165014', ], 'result' => [ 'description' => '续费结果', 'type' => 'boolean', 'example' => 'true', ], ], 'example' => '{}', ], ], '5XX' => [ 'schema' => [ 'type' => 'object', 'properties' => [ 'code' => [ 'type' => 'string', ], 'message' => [ 'type' => 'string', ], 'requestId' => [ 'type' => 'string', ], 'httpCode' => [ 'type' => 'integer', 'format' => 'int32', ], ], ], ], ], 'responseDemo' => '[{"type":"json","example":"{\\n \\"requestId\\": \\"D77D0DAF-790D-F5F5-A9C0-133738165014\\",\\n \\"result\\": true\\n}","errorExample":""},{"type":"xml","example":"D77D0DAF-790D-F5F5-A9C0-133738165014\\n","errorExample":""}]', 'title' => '为应用续费（暂不支持）', 'requestParamsDescription' => '**可选参数**'."\n" .'| 名称 | 类型 | 描述 |'."\n" .'| --- | --- | --- |'."\n" .'| duration | Integer | 续费周期（默认：1）
（取值范围:
- [1,2] 单位：Year
- [1,9] 单位：Month）
|'."\n" .'| pricingCycle | String | 续费周期
（单位:
- Year
- Month）
|'."\n" .'| autoRenew | boolean | 是否要自动续费（默认：false）
（取值范围:
- false
- true）
|', 'responseParamsDescription' => ' ', 'extraInfo' => ' ', ], 'CreateAppGroup' => [ 'summary' => '创建一个OpenSearch应用。', 'path' => '/v4/openapi/app-groups', 'methods' => [ 'post', ], 'schemes' => [ 'http', 'https', ], 'security' => [ [ 'AK' => [], ], ], 'operationType' => 'write', 'deprecated' => false, 'systemTags' => [ 'operationType' => 'create', 'riskType' => 'none', 'chargeType' => 'paid', 'abilityTreeCode' => '55147', 'abilityTreeNodes' => [ 'FEATUREopensearch2ESE2N', 'FEATUREopensearchG9QGQK', 'FEATUREopensearchO36CPI', ], ], 'parameters' => [ [ 'name' => 'body', 'in' => 'body', 'style' => 'json', 'schema' => [ 'description' => '请求体', 'type' => 'object', 'properties' => [ 'name' => [ 'description' => '应用名称', 'type' => 'string', 'required' => false, 'example' => 'jmbon_analyzer', ], 'chargeType' => [ 'description' => '付费类型'."\n" .'- POSTPAY 后付费（按量付费）'."\n" .'- PREPAY 预付费（包年包月', 'type' => 'string', 'required' => false, 'enumValueTitles' => [], 'example' => 'POSTPAY', ], 'type' => [ 'description' => '应用类型'."\n" ."\n" .'- standard 标准版'."\n" .'- enhanced 高级版', 'type' => 'string', 'required' => false, 'example' => 'enhanced', ], 'resourceGroupId' => [ 'description' => '实例所属的资源组ID。', 'type' => 'string', 'required' => false, 'example' => 'rg-acfm2ij6pwxsvua', ], 'tags' => [ 'description' => '标签列表', 'type' => 'array', 'items' => [ 'description' => '标签键值', 'type' => 'object', 'properties' => [ 'key' => [ 'description' => '标签key', 'type' => 'string', 'required' => false, 'example' => 'a', ], 'value' => [ 'description' => '标签value', 'type' => 'string', 'required' => false, 'example' => '1', ], ], 'required' => false, ], 'required' => false, ], 'quota' => [ 'description' => '配额', 'type' => 'object', 'properties' => [ 'docSize' => [ 'description' => '存储容量（单位：GB）', 'type' => 'integer', 'format' => 'int32', 'required' => false, 'example' => '1', ], 'computeResource' => [ 'description' => '计算资源（单位：LCU）', 'type' => 'integer', 'format' => 'int32', 'required' => false, 'example' => '20', ], 'spec' => [ 'description' => '规格'."\n" .'- opensearch.share.junior 入门型'."\n" .'- opensearch.share.common 共享通用型'."\n" .'- opensearch.share.compute 共享计算型'."\n" .'- opensearch.share.storage 共享存储型'."\n" .'- opensearch.private.common 独享通用型'."\n" .'- opensearch.private.compute 独享计算型'."\n" .'- opensearch.private.storage 独享存储型', 'type' => 'string', 'required' => false, 'example' => 'opensearch.share.common', ], ], 'required' => false, ], ], 'required' => false, ], ], ], 'responses' => [ 200 => [ 'schema' => [ 'description' => '响应体', 'type' => 'object', 'properties' => [ 'requestId' => [ 'description' => '请求ID', 'type' => 'string', 'example' => '766CF6DB-CA02-3E12-7CBA-6AC21FC978FD', ], 'result' => [ 'description' => '空', 'type' => 'object', 'properties' => [ 'created' => [ 'description' => '创建时间戳', 'type' => 'integer', 'format' => 'int32', 'example' => '1590139542', ], 'currentVersion' => [ 'description' => '当前在线版本', 'type' => 'string', 'example' => '100302903', ], 'lockMode' => [ 'description' => '锁定状态'."\n" .'- Unlock 正常'."\n" .'- LockByExpiration 实例过期自动锁定'."\n" .'- ManualLock 手动触发锁定', 'type' => 'string', 'example' => 'Unlock', ], 'updated' => [ 'description' => '更新时间戳', 'type' => 'integer', 'format' => 'int32', 'example' => '1590978265', ], 'id' => [ 'description' => '应用ID', 'type' => 'string', 'example' => '100302881', ], 'chargeType' => [ 'description' => '付费类型'."\n" .'- POSTPAY 后付费（按量付费）'."\n" .'- PREPAY 预付费（包年包月）', 'type' => 'string', 'example' => 'POSTPAY', ], 'hasPendingQuotaReviewTask' => [ 'description' => '是否配额审批中'."\n" .'- 0：正常'."\n" .'- 1：配额审批中', 'type' => 'integer', 'format' => 'int32', 'example' => '0', ], 'name' => [ 'description' => '应用名称', 'type' => 'string', 'example' => 'lsh_test_1', ], 'instanceId' => [ 'description' => '实例ID', 'type' => 'string', 'example' => '-', ], 'chargingWay' => [ 'description' => '计费类型'."\n" .'- 1：计算资源'."\n" .'- 2：qps', 'type' => 'integer', 'format' => 'int32', 'example' => '1', ], 'type' => [ 'description' => '应用类型'."\n" .'- standard 标准版'."\n" .'- advance 老高级版（新应用不支持此类型）'."\n" .'- enhanced 新高级版', 'type' => 'string', 'example' => 'enhanced', ], 'status' => [ 'description' => '应用状态'."\n" .'- producing 生产中'."\n" .'- review_pending 生产审批中'."\n" .'- config_pending 待配置'."\n" .'- normal 正常'."\n" .'- frozen 已冻结', 'type' => 'string', 'example' => 'normal', ], 'projectId' => [ 'description' => 'abtest project 名称', 'type' => 'string', 'example' => '-', ], 'switchedTime' => [ 'description' => '在线版本切换时间戳', 'type' => 'integer', 'format' => 'int32', 'example' => '1590486386', ], 'commodityCode' => [ 'description' => '商品CODE', 'type' => 'string', 'example' => 'opensearch', ], 'expireOn' => [ 'description' => '过期时间', 'type' => 'string', 'example' => '-', ], 'domain' => [ 'description' => '行业类型'."\n" .'- GENERAL 通用'."\n" .'- ECOMMERCE 电商'."\n" .'- IT_CONTENT IT内容', 'type' => 'string', 'example' => 'GENERAL', ], 'description' => [ 'description' => '应用描述', 'type' => 'string', 'example' => '-', ], 'produced' => [ 'description' => '是否生产完成'."\n" .'- 0：生产中'."\n" .'- 1：生产完成', 'type' => 'integer', 'format' => 'int32', 'example' => '1', ], 'quota' => [ 'description' => '应用配额信息', 'type' => 'object', 'properties' => [ 'spec' => [ 'description' => '规格'."\n" .'- opensearch.share.junior 入门型'."\n" .'- opensearch.share.common 共享通用型'."\n" .'- opensearch.share.compute 共享计算型'."\n" .'- opensearch.share.storage 共享存储型'."\n" .'- opensearch.private.common 独享通用型'."\n" .'- opensearch.private.compute 独享计算型'."\n" .'- opensearch.private.storage 独享存储型', 'type' => 'string', 'example' => 'opensearch.share.common', ], 'docSize' => [ 'description' => '存储容量 （单位：GB）', 'type' => 'integer', 'format' => 'int32', 'example' => '1', ], 'computeResource' => [ 'description' => '计算资源 （单位：LCU）', 'type' => 'integer', 'format' => 'int32', 'example' => '20', ], ], ], 'engineType' => [ 'description' => '引擎类型', 'type' => 'string', 'example' => 'ha3', ], ], ], ], ], ], '5XX' => [ 'schema' => [ 'type' => 'object', 'properties' => [ 'code' => [ 'type' => 'string', ], 'message' => [ 'type' => 'string', ], 'requestId' => [ 'type' => 'string', ], 'httpCode' => [ 'type' => 'integer', 'format' => 'int32', ], ], ], ], ], 'responseDemo' => '[{"type":"json","example":"{\\n \\"requestId\\": \\"766CF6DB-CA02-3E12-7CBA-6AC21FC978FD\\",\\n \\"result\\": {\\n \\"created\\": 1590139542,\\n \\"currentVersion\\": \\"100302903\\",\\n \\"lockMode\\": \\"Unlock\\",\\n \\"updated\\": 1590978265,\\n \\"id\\": \\"100302881\\",\\n \\"chargeType\\": \\"POSTPAY\\",\\n \\"hasPendingQuotaReviewTask\\": 0,\\n \\"name\\": \\"lsh_test_1\\",\\n \\"instanceId\\": \\"-\\",\\n \\"chargingWay\\": 1,\\n \\"type\\": \\"enhanced\\",\\n \\"status\\": \\"normal\\",\\n \\"projectId\\": \\"-\\",\\n \\"switchedTime\\": 1590486386,\\n \\"commodityCode\\": \\"opensearch\\",\\n \\"expireOn\\": \\"-\\",\\n \\"domain\\": \\"GENERAL\\",\\n \\"description\\": \\"-\\",\\n \\"produced\\": 1,\\n \\"quota\\": {\\n \\"spec\\": \\"opensearch.share.common\\",\\n \\"docSize\\": 1,\\n \\"computeResource\\": 20\\n },\\n \\"engineType\\": \\"ha3\\"\\n }\\n}","errorExample":""},{"type":"xml","example":"766CF6DB-CA02-3E12-7CBA-6AC21FC978FD","errorExample":""}]', 'title' => '创建一个应用', 'requestParamsDescription' => '**请求体**'."\n" .'| 字段 | 类型 | 是否必要 | 示例值 | 描述 |'."\n" .'| --- | --- | --- | --- | --- |'."\n" .'| name | String | 是 | "my_app" | 应用名称 |'."\n" .'| type | String | 是 | "standard" | 应用类型
- standard 标准版
- enhanced 高级版
|'."\n" .'| quota | Object | 是 | | 应用配额信息
参考：[Quota](~~170001~~) |'."\n" .'| chargeType | String | 否 | "POSTPAY" | 付费类型
- POSTPAY 后付费（按量付费）（默认值）
- PREPAY 预付费（包年包月）
|'."\n" .'| order | Object | 否 | {"duration": 1,"pricingCycle": "Year"} | 订购周期信息 |'."\n" .'| order.duration | Integer | -- | 1 | 订购周期
最小值不小于0 |'."\n" .'| order.pricingCycle | String | -- | "Year" | 订购周期单位
- Year
- Month
|'."\n" .'| order.autoRenew | Boolean | 否 | true | 是否要自动续费。当参数chargeType取值PREPAY时才生效。取值范围：
- true：自动续费。
- false（默认）：不自动续费。
|', 'responseParamsDescription' => ' ', 'extraInfo' => ' ', ], 'ModifyAppGroup' => [ 'summary' => '修改 OpenSearch 应用属性或设置应用在线版本。', 'path' => '/v4/openapi/app-groups/{appGroupIdentity}', 'methods' => [ 'put', ], 'schemes' => [ 'http', 'https', ], 'security' => [ [ 'AK' => [], ], ], 'operationType' => 'write', 'deprecated' => false, 'systemTags' => [ 'operationType' => 'update', 'riskType' => 'none', 'chargeType' => 'free', 'abilityTreeCode' => '55236', 'abilityTreeNodes' => [ 'FEATUREopensearchGVH0IN', 'FEATUREopensearch447AAX', 'FEATUREopensearch5OZOSP', ], ], 'parameters' => [ [ 'name' => 'appGroupIdentity', 'in' => 'path', 'schema' => [ 'description' => '应用名称。', 'type' => 'string', 'required' => true, 'docRequired' => true, 'example' => 'my_app_group_name', ], ], [ 'name' => 'body', 'in' => 'body', 'style' => 'json', 'schema' => [ 'description' => '请求参数。', 'type' => 'object', 'properties' => [ 'description' => [ 'description' => '描述', 'type' => 'string', 'required' => false, 'example' => '"实例描述"', ], 'currentVersion' => [ 'description' => '在线版本。', 'type' => 'string', 'required' => false, 'example' => '1223232', ], 'domain' => [ 'description' => '行业类型：'."\n" ."\n" .'- general：通用行业。'."\n" .'- ecommerce：电商行业。'."\n" .'- education：教育行业。'."\n" .'- esports：游戏行业。'."\n" .'- community：内容社区。', 'type' => 'string', 'required' => false, 'example' => '"ecommerce"', ], 'resourceGroupId' => [ 'description' => '实例所属的资源组ID。', 'type' => 'string', 'required' => false, 'example' => 'rg-****', ], ], 'required' => false, ], ], [ 'name' => 'dryRun', 'in' => 'query', 'schema' => [ 'description' => '是否进行升级前校验。true表示校验，false表示不校验。', 'type' => 'boolean', 'required' => false, 'example' => 'true', ], ], ], 'responses' => [ 200 => [ 'schema' => [ 'description' => '响应体', 'type' => 'object', 'properties' => [ 'requestId' => [ 'description' => '请求ID', 'type' => 'string', 'example' => 'D77D0DAF-790D-F5F5-A9C0-133738165014', ], 'result' => [ 'description' => '返回数据', 'type' => 'object', 'properties' => [ 'created' => [ 'description' => '创建时间戳', 'type' => 'integer', 'format' => 'int32', 'example' => '159013954', ], 'currentVersion' => [ 'description' => '当前在线版本', 'type' => 'string', 'example' => '100302903', ], 'lockMode' => [ 'description' => '锁定状态'."\n" .'- Unlock 正常'."\n" .'- LockByExpiration 实例过期自动锁定'."\n" .'- ManualLock 手动触发锁定', 'type' => 'string', 'example' => 'Unlock', ], 'updated' => [ 'description' => '更新时间戳', 'type' => 'integer', 'format' => 'int32', 'example' => '1590978265', ], 'id' => [ 'description' => '应用ID', 'type' => 'string', 'example' => '100302881', ], 'chargeType' => [ 'description' => '付费类型'."\n" .'- POSTPAY 后付费（按量付费）'."\n" .'- PREPAY 预付费（包年包月）', 'type' => 'string', 'example' => 'POSTPAY', ], 'hasPendingQuotaReviewTask' => [ 'description' => '是否配额审批中'."\n" .'- 0：正常'."\n" .'- 1：配额审批中', 'type' => 'integer', 'format' => 'int32', 'example' => '0', ], 'name' => [ 'description' => '应用名称', 'type' => 'string', 'example' => 'lsh_test_1', ], 'instanceId' => [ 'description' => '实例ID', 'type' => 'string', 'example' => '10030288', ], 'chargingWay' => [ 'description' => '计费类型'."\n" .'- 1：计算资源'."\n" .'- 2：qps', 'type' => 'integer', 'format' => 'int32', 'example' => '1', ], 'type' => [ 'description' => '应用类型'."\n" .'- standard 标准版'."\n" .'- advance 老高级版（新应用不支持此类型）'."\n" .'- enhanced 新高级版', 'type' => 'string', 'example' => 'enhanced', ], 'status' => [ 'description' => '应用状态'."\n" .'- producing 生产中'."\n" .'- review_pending 生产审批中'."\n" .'- config_pending 待配置'."\n" .'- normal 正常'."\n" .'- frozen 已冻结', 'type' => 'string', 'example' => 'normal', ], 'projectId' => [ 'description' => 'abtest project 名称', 'type' => 'string', 'example' => '1', ], 'switchedTime' => [ 'description' => '在线版本切换时间戳', 'type' => 'integer', 'format' => 'int32', 'example' => '1590486386', ], 'commodityCode' => [ 'description' => '商品CODE', 'type' => 'string', 'example' => 'opensearch', ], 'expireOn' => [ 'description' => '过期时间', 'type' => 'string', 'example' => '1', ], 'domain' => [ 'description' => '行业类型'."\n" .'- GENERAL 通用'."\n" .'- ECOMMERCE 电商'."\n" .'- IT_CONTENT IT内容', 'type' => 'string', 'example' => 'GENERAL', ], 'description' => [ 'description' => '应用描述', 'type' => 'string', 'example' => '1', ], 'produced' => [ 'description' => '是否生产完成'."\n" .'- 0：生产中'."\n" .'- 1：生产完成', 'type' => 'integer', 'format' => 'int32', 'example' => '1', ], 'quota' => [ 'description' => '应用配额信息', 'type' => 'object', 'properties' => [ 'spec' => [ 'description' => '规格'."\n" .'- opensearch.share.junior 入门型'."\n" .'- opensearch.share.common 共享通用型'."\n" .'- opensearch.share.compute 共享计算型'."\n" .'- opensearch.share.storage 共享存储型'."\n" .'- opensearch.private.common 独享通用型'."\n" .'- opensearch.private.compute 独享计算型'."\n" .'- opensearch.private.storage 独享存储型', 'type' => 'string', 'example' => 'opensearch.share.common', ], 'docSize' => [ 'description' => '存储容量（单位：GB）', 'type' => 'integer', 'format' => 'int32', 'example' => '1', ], 'computeResource' => [ 'description' => '计算资源（单位：LCU）', 'type' => 'integer', 'format' => 'int32', 'example' => '20', ], ], 'example' => '{}', ], 'engineType' => [ 'description' => '引擎类型', 'type' => 'string', 'example' => 'ha3', ], 'resourceGroupId' => [ 'description' => '实例所属的资源组ID。', 'type' => 'string', 'example' => 'rg-acfmoiyerh6nzly', ], ], 'example' => '{}', ], ], 'example' => '{}', ], ], '5XX' => [ 'schema' => [ 'type' => 'object', 'properties' => [ 'code' => [ 'type' => 'string', ], 'message' => [ 'type' => 'string', ], 'requestId' => [ 'type' => 'string', ], 'httpCode' => [ 'type' => 'integer', 'format' => 'int32', ], ], ], ], ], 'responseDemo' => '[{"type":"json","example":"{\\n \\"requestId\\": \\"D77D0DAF-790D-F5F5-A9C0-133738165014\\",\\n \\"result\\": {\\n \\"created\\": 159013954,\\n \\"currentVersion\\": \\"100302903\\",\\n \\"lockMode\\": \\"Unlock\\",\\n \\"updated\\": 1590978265,\\n \\"id\\": \\"100302881\\",\\n \\"chargeType\\": \\"POSTPAY\\",\\n \\"hasPendingQuotaReviewTask\\": 0,\\n \\"name\\": \\"lsh_test_1\\",\\n \\"instanceId\\": \\"10030288\\",\\n \\"chargingWay\\": 1,\\n \\"type\\": \\"enhanced\\",\\n \\"status\\": \\"normal\\",\\n \\"projectId\\": \\"1\\",\\n \\"switchedTime\\": 1590486386,\\n \\"commodityCode\\": \\"opensearch\\",\\n \\"expireOn\\": \\"1\\",\\n \\"domain\\": \\"GENERAL\\",\\n \\"description\\": \\"1\\",\\n \\"produced\\": 1,\\n \\"quota\\": {\\n \\"spec\\": \\"opensearch.share.common\\",\\n \\"docSize\\": 1,\\n \\"computeResource\\": 20\\n },\\n \\"engineType\\": \\"ha3\\",\\n \\"resourceGroupId\\": \\"rg-acfmoiyerh6nzly\\"\\n }\\n}","errorExample":""},{"type":"xml","example":"0A6EB64B-B4C8-CF02-810F-E660812972FF\\n\\n 110116134\\n os_function_test_v1\\n 110116134\\n 0\\n \\n 1\\n 20\\n opensearch.share.common\\n \\n 1\\n enhanced\\n \\n POSTPAY\\n \\n \\n opensearch\\n \\n 0\\n 0\\n 0\\n opensearch-demo\\n 1\\n 0\\n 0\\n 1575442875\\n 1578916076\\n normal\\n Unlock\\n","errorExample":""}]', 'title' => '修改应用属性或设置应用在线版本', 'requestParamsDescription' => '**请求体**'."\n" .'| 字段 | 类型 | 是否必要 | 示例值 | 描述 |'."\n" .'| --- | --- | --- | --- | --- |'."\n" .'| chargingWay | Integer | 否 | 1 | 计费模型
- 1  计算资源
- 2  qps
|'."\n" .'| description | String | 否 | "my_first_app" | 应用描述 |'."\n" .'| currentVersion | Integer | 否 | 12345678 | 应用版本ID |'."\n" ."\n" .'注：优先执行“设置应用在线版本”，即若所有字段都存在，则默认currentVersion有效。
'."\n" ."\n\n", 'responseParamsDescription' => ' ', ], 'ModifyAppGroupQuota' => [ 'summary' => '修改 OpenSearch 应用配额。', 'path' => '/v4/openapi/app-groups/{appGroupIdentity}/quota', 'methods' => [ 'put', ], 'schemes' => [ 'http', 'https', ], 'security' => [ [ 'AK' => [], ], ], 'operationType' => 'write', 'deprecated' => false, 'systemTags' => [ 'operationType' => 'update', 'riskType' => 'none', 'chargeType' => 'free', 'abilityTreeCode' => '55237', 'abilityTreeNodes' => [ 'FEATUREopensearchGVH0IN', 'FEATUREopensearch447AAX', 'FEATUREopensearch5OZOSP', ], ], 'parameters' => [ [ 'name' => 'appGroupIdentity', 'in' => 'path', 'schema' => [ 'description' => '应用名称', 'type' => 'string', 'required' => true, 'docRequired' => true, 'example' => 'my_app_group_name', ], ], [ 'name' => 'clientToken', 'in' => 'query', 'schema' => [ 'title' => '用于保证请求的幂等性。由客户端生成该参数值，要保证在不同请求间唯一，最大不超过64个ASCII字符。', 'description' => '用于保证请求的幂等性。由客户端生成该参数值，要保证在不同请求间唯一，最大不超过64个ASCII字符。', 'type' => 'string', 'required' => false, 'example' => '74db41d8cd3c784209093aa76afbe89e', ], ], [ 'name' => 'dryRun', 'in' => 'query', 'schema' => [ 'description' => '是否校验入参数据合法性，默认false。'."\n" ."\n" .'取值：'."\n" ."\n" .'- **true**：只校验参数合法性。'."\n" ."\n" .'- **false**：校验参数合法性，创建归因配置。', 'type' => 'boolean', 'required' => false, 'example' => 'false', ], ], [ 'name' => 'body', 'in' => 'body', 'schema' => [ 'description' => '请求体。', 'required' => false, '$ref' => '#/components/schemas/Quota', ], ], ], 'responses' => [ 200 => [ 'schema' => [ 'description' => '响应体', 'type' => 'object', 'properties' => [ 'requestId' => [ 'description' => '请求ID', 'type' => 'string', 'example' => '0A6EB64B-B4C8-CF02-810F-E660812972FF', ], 'result' => [ 'description' => '应用信息', 'type' => 'object', 'properties' => [ 'created' => [ 'description' => '创建时间戳', 'type' => 'integer', 'format' => 'int32', 'example' => '1590139542', ], 'currentVersion' => [ 'description' => '当前在线版本', 'type' => 'string', 'example' => '100302903', ], 'type' => [ 'description' => '应用类型'."\n" .'- standard 标准版'."\n" .'- advance 老高级版（新应用不支持此类型）'."\n" .'- enhanced 新高级版', 'type' => 'string', 'example' => 'enhanced', ], 'chargingWay' => [ 'description' => '计费类型'."\n" .'- 1：计算资源'."\n" .'- 2：qps', 'type' => 'integer', 'format' => 'int32', 'example' => '1', ], 'lockMode' => [ 'description' => '锁定状态'."\n" .'- Unlock 正常'."\n" .'- LockByExpiration 实例过期自动锁定'."\n" .'- ManualLock 手动触发锁定', 'type' => 'string', 'example' => 'Unlock', ], 'status' => [ 'description' => '应用状态'."\n" .'- producing 生产中'."\n" .'- review_pending 生产审批中'."\n" .'- config_pending 待配置'."\n" .'- normal 正常'."\n" .'- frozen 已冻结', 'type' => 'string', 'example' => 'normal', ], 'updated' => [ 'description' => '更新时间戳', 'type' => 'integer', 'format' => 'int32', 'example' => '1590978265', ], 'chargeType' => [ 'description' => '付费类型'."\n" .'- POSTPAY 后付费（按量付费）'."\n" .'- PREPAY 预付费（包年包月）', 'type' => 'string', 'example' => 'POSTPAY', ], 'id' => [ 'description' => '应用ID', 'type' => 'string', 'example' => '100302881', ], 'hasPendingQuotaReviewTask' => [ 'description' => '是否配额审批中'."\n" .'- 0：正常'."\n" .'- 1：配额审批中', 'type' => 'integer', 'format' => 'int32', 'example' => '0', ], 'projectId' => [ 'description' => 'abtest project 名称', 'type' => 'string', 'example' => '1000', ], 'commodityCode' => [ 'description' => '商品CODE', 'type' => 'string', 'example' => 'opensearch', ], 'switchedTime' => [ 'description' => '在线版本切换时间戳', 'type' => 'integer', 'format' => 'int32', 'example' => '1590486386', ], 'expireOn' => [ 'description' => '过期时间', 'type' => 'string', 'example' => ' 1', ], 'description' => [ 'description' => '应用描述', 'type' => 'string', 'example' => ' 1', ], 'produced' => [ 'description' => '是否生产完成'."\n" .'- 0：生产中'."\n" .'- 1：生产完成', 'type' => 'integer', 'format' => 'int32', 'example' => '1', ], 'name' => [ 'description' => '应用名称', 'type' => 'string', 'example' => 'lsh_test_1', ], 'instanceId' => [ 'description' => '实例ID', 'type' => 'string', 'example' => '1', ], 'quota' => [ 'description' => '应用配额信息', 'type' => 'object', 'properties' => [ 'spec' => [ 'description' => '规格'."\n" .'- opensearch.share.junior 入门型'."\n" .'- opensearch.share.common 共享通用型'."\n" .'- opensearch.share.compute 共享计算型'."\n" .'- opensearch.share.storage 共享存储型'."\n" .'- opensearch.private.common 独享通用型'."\n" .'- opensearch.private.compute 独享计算型'."\n" .'- opensearch.private.storage 独享存储型', 'type' => 'string', 'example' => 'opensearch.share.common', ], 'docSize' => [ 'description' => '存储容量（单位：GB）', 'type' => 'integer', 'format' => 'int32', 'example' => '1', ], 'computeResource' => [ 'description' => '计算资源（单位：LCU）', 'type' => 'integer', 'format' => 'int32', 'example' => '20', ], ], ], 'engineType' => [ 'description' => '引擎类型', 'type' => 'string', 'enumValueTitles' => [ 'ha3' => 'ha3', ], 'example' => 'ha3', ], 'resourceGroupId' => [ 'description' => '实例所属的资源组ID。', 'type' => 'string', 'example' => 'rg-acfmoiyerh6nzly', ], ], ], ], ], ], '5XX' => [ 'schema' => [ 'type' => 'object', 'properties' => [ 'code' => [ 'type' => 'string', ], 'message' => [ 'type' => 'string', ], 'requestId' => [ 'type' => 'string', ], 'httpCode' => [ 'type' => 'integer', 'format' => 'int32', ], ], ], ], ], 'responseDemo' => '[{"type":"json","example":"{\\n \\"requestId\\": \\"0A6EB64B-B4C8-CF02-810F-E660812972FF\\",\\n \\"result\\": {\\n \\"created\\": 1590139542,\\n \\"currentVersion\\": \\"100302903\\",\\n \\"type\\": \\"enhanced\\",\\n \\"chargingWay\\": 1,\\n \\"lockMode\\": \\"Unlock\\",\\n \\"status\\": \\"normal\\",\\n \\"updated\\": 1590978265,\\n \\"chargeType\\": \\"POSTPAY\\",\\n \\"id\\": \\"100302881\\",\\n \\"hasPendingQuotaReviewTask\\": 0,\\n \\"projectId\\": \\"1000\\",\\n \\"commodityCode\\": \\"opensearch\\",\\n \\"switchedTime\\": 1590486386,\\n \\"expireOn\\": \\" 1\\",\\n \\"description\\": \\" 1\\",\\n \\"produced\\": 1,\\n \\"name\\": \\"lsh_test_1\\",\\n \\"instanceId\\": \\"1\\",\\n \\"quota\\": {\\n \\"spec\\": \\"opensearch.share.common\\",\\n \\"docSize\\": 1,\\n \\"computeResource\\": 20\\n },\\n \\"engineType\\": \\"ha3\\",\\n \\"resourceGroupId\\": \\"rg-acfmoiyerh6nzly\\"\\n }\\n}","errorExample":""},{"type":"xml","example":"0A6EB64B-B4C8-CF02-810F-E660812972FF\\n\\n 110116134\\n os_function_test_v1\\n 110116134\\n 0\\n \\n 1\\n 20\\n opensearch.share.common\\n \\n 1\\n enhanced\\n \\n POSTPAY\\n \\n \\n opensearch\\n \\n 0\\n 0\\n 0\\n \\n 1\\n 0\\n 0\\n 1575442875\\n 1578916076\\n normal\\n Unlock\\n","errorExample":""}]', 'title' => '修改应用配额', 'requestParamsDescription' => '**请求体**
'."\n" .'| 字段 | 类型 | 是否必要 | 示例值 | 描述 |'."\n" .'| --- | --- | --- | --- | --- |'."\n" .'| docSize | Integer | 是 | 1 | 存储容量（单位：GB） 共享通用型（1～300G）|'."\n" .'| computeResource | Integer | 是 | 20 | 计算资源（单位：LCU） 共享通用型（20～5000LCU） |'."\n" .'| spec | String | 是 | "opensearch.share.common" | 规格 |'."\n" .'| orderType | String | 否 | "UPGRADE" | 变配类型
- UPGRADE  升配
- DOWNGRADE  降配
|'."\n" ."\n" .'参考：[Quota](~~170001~~)
', 'responseParamsDescription' => ' ', ], 'RemoveAppGroup' => [ 'summary' => '删除一个OpenSearch应用。', 'path' => '/v4/openapi/app-groups/{appGroupIdentity}', 'methods' => [ 'delete', ], 'schemes' => [ 'http', 'https', ], 'security' => [ [ 'AK' => [], ], ], 'operationType' => 'write', 'deprecated' => false, 'systemTags' => [ 'operationType' => 'delete', 'riskType' => 'none', 'chargeType' => 'free', 'abilityTreeNodes' => [ 'FEATUREopensearch447AAX', 'FEATUREopensearch5OZOSP', ], ], 'parameters' => [ [ 'name' => 'appGroupIdentity', 'in' => 'path', 'schema' => [ 'description' => '应用名称', 'type' => 'string', 'required' => true, 'docRequired' => true, 'example' => '121001650', ], ], ], 'responses' => [ 200 => [ 'schema' => [ 'type' => 'object', 'properties' => [ 'requestId' => [ 'description' => '请求ID', 'type' => 'string', 'example' => '3AA29D02-54F3-8569-F71A-90E1B7BE4E7E', ], 'result' => [ 'description' => '返回结果', 'type' => 'array', 'items' => [ 'description' => '返回详情结果'."\n" ."\n", 'type' => 'integer', 'format' => 'int32', 'example' => '[]', ], ], ], ], ], '5XX' => [ 'schema' => [ 'type' => 'object', 'properties' => [ 'code' => [ 'type' => 'string', ], 'message' => [ 'type' => 'string', ], 'requestId' => [ 'type' => 'string', ], 'httpCode' => [ 'type' => 'integer', 'format' => 'int32', ], ], ], ], ], 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"requestId\\": \\"3AA29D02-54F3-8569-F71A-90E1B7BE4E7E\\",\\n \\"result\\": [\\n 0\\n ]\\n}","type":"json"}]', 'title' => '删除APP分组', 'description' => '仅支持删除按量付费的应用，不支持删除包年包月的应用。', ], 'ListAppGroups' => [ 'summary' => '获取OpenSearch应用列表。', 'path' => '/v4/openapi/app-groups', 'methods' => [ 'get', ], 'schemes' => [ 'http', 'https', ], 'security' => [ [ 'AK' => [], ], ], 'operationType' => 'read', 'deprecated' => false, 'systemTags' => [ 'operationType' => 'list', 'riskType' => 'none', 'chargeType' => 'free', 'abilityTreeCode' => '55205', 'abilityTreeNodes' => [ 'FEATUREopensearchGVH0IN', 'FEATUREopensearch447AAX', 'FEATUREopensearch5OZOSP', ], ], 'parameters' => [ [ 'name' => 'pageNumber', 'in' => 'query', 'schema' => [ 'description' => '页码，默认 pageNumber=1', 'type' => 'integer', 'format' => 'int32', 'required' => false, 'example' => '1', ], ], [ 'name' => 'pageSize', 'in' => 'query', 'schema' => [ 'description' => '每页返回数目，默认 pageSize=10', 'type' => 'integer', 'format' => 'int32', 'required' => false, 'example' => '10', ], ], [ 'name' => 'instanceId', 'in' => 'query', 'schema' => [ 'description' => '实例ID（精确匹配）', 'type' => 'string', 'required' => false, 'example' => 'ops-cn-xxxx', ], ], [ 'name' => 'name', 'in' => 'query', 'schema' => [ 'description' => '应用名称', 'type' => 'string', 'required' => false, 'example' => 'my_name', ], ], [ 'name' => 'type', 'in' => 'query', 'schema' => [ 'description' => '应用类型'."\n" ."\n" .'- standard 标准版'."\n" .'- enhanced 新高级版', 'type' => 'string', 'required' => false, 'example' => 'standard', ], ], [ 'name' => 'sortBy', 'in' => 'query', 'schema' => [ 'description' => '排列顺序'."\n" ."\n" .'- 0：按创建时间降序排列'."\n" .'- 1：按修改时间降序排列'."\n" ."\n" .'默认 sortBy=0', 'type' => 'integer', 'format' => 'int32', 'required' => false, 'example' => '0', ], ], [ 'name' => 'resourceGroupId', 'in' => 'query', 'schema' => [ 'description' => '资源id', 'type' => 'string', 'required' => false, 'example' => '"110123123"', ], ], [ 'name' => 'tags', 'in' => 'query', 'style' => 'json', 'schema' => [ 'description' => '标签列表', 'type' => 'array', 'items' => [ 'type' => 'object', 'properties' => [ 'key' => [ 'description' => '标签键', 'type' => 'string', 'required' => false, 'example' => 'foo', ], 'value' => [ 'description' => '标签值', 'type' => 'string', 'required' => false, 'example' => 'bar', ], ], 'required' => false, ], 'required' => false, ], ], ], 'responses' => [ 200 => [ 'schema' => [ 'description' => '响应体', 'type' => 'object', 'properties' => [ 'totalCount' => [ 'description' => '总条数', 'type' => 'integer', 'format' => 'int32', 'example' => '1', ], 'requestId' => [ 'description' => '请求ID', 'type' => 'string', 'example' => '0A6EB64B-B4C8-CF02-810F-E660812972FF', ], 'result' => [ 'description' => '应用信息'."\n" ."\n" .'参考：[AppGroup](~~170000~~)', 'type' => 'array', 'items' => [ 'description' => '结果体', 'type' => 'object', 'properties' => [ 'created' => [ 'description' => '创建时间戳', 'type' => 'integer', 'format' => 'int32', 'example' => '1575442875', ], 'currentVersion' => [ 'description' => '当前在线版本', 'type' => 'string', 'example' => '110116134', ], 'lockMode' => [ 'description' => '锁定状态'."\n" ."\n" .'- Unlock 正常'."\n" .'- LockByExpiration 实例过期自动锁定'."\n" .'- ManualLock 手动触发锁定', 'type' => 'string', 'example' => 'Unlock', ], 'updated' => [ 'description' => '更新时间戳', 'type' => 'integer', 'format' => 'int32', 'example' => '1578916076', ], 'id' => [ 'description' => '应用ID', 'type' => 'string', 'example' => '110116134', ], 'chargeType' => [ 'description' => '付费类型'."\n" ."\n" .'- POSTPAY 后付费（按量付费）'."\n" .'- PREPAY 预付费（包年包月）', 'type' => 'string', 'example' => 'POSTPAY', ], 'hasPendingQuotaReviewTask' => [ 'description' => '是否配额审批中'."\n" ."\n" .'- 0：正常'."\n" .'- 1：配额审批中', 'type' => 'integer', 'format' => 'int32', 'example' => '0', ], 'name' => [ 'description' => '应用名称', 'type' => 'string', 'example' => 'os_function_test_v1', ], 'instanceId' => [ 'description' => '实例ID', 'type' => 'string', 'example' => '"xxx"', ], 'chargingWay' => [ 'description' => '计费类型'."\n" ."\n" .'- 1：计算资源'."\n" .'- 2：qps', 'type' => 'integer', 'format' => 'int32', 'example' => '1', ], 'type' => [ 'description' => '应用类型'."\n" ."\n" .'- standard 标准版'."\n" .'- enhanced 新高级版', 'type' => 'string', 'example' => 'enhanced', ], 'status' => [ 'description' => '应用状态'."\n" ."\n" .'- producing 生产中'."\n" .'- review_pending 生产审批中'."\n" .'- config_pending 待配置'."\n" .'- normal 正常'."\n" .'- frozen 已冻结', 'type' => 'string', 'example' => 'normal', ], 'projectId' => [ 'description' => 'abtest project 名称', 'type' => 'string', 'example' => '"xxx"', ], 'switchedTime' => [ 'description' => '在线版本切换时间戳', 'type' => 'integer', 'format' => 'int32', 'example' => '0', ], 'commodityCode' => [ 'description' => '商品CODE', 'type' => 'string', 'example' => 'opensearch', ], 'expireOn' => [ 'description' => '过期时间', 'type' => 'string', 'example' => '"xxx"', ], 'domain' => [ 'description' => 'domain', 'type' => 'string', 'example' => '""', ], 'description' => [ 'description' => '应用描述', 'type' => 'string', 'example' => '"xxx"', ], 'produced' => [ 'description' => '是否生产完成'."\n" ."\n" .'- 0：生产中'."\n" .'- 1：生产完成', 'type' => 'integer', 'format' => 'int32', 'example' => '1', ], 'lockedByExpiration' => [ 'description' => '实例过期自动锁定', 'type' => 'integer', 'format' => 'int32', 'example' => '0', ], 'quota' => [ 'description' => '应用配额信息'."\n" .'参考：[Quota](~~170001~~)', 'type' => 'object', 'properties' => [ 'spec' => [ 'description' => '规格'."\n" ."\n" .'- opensearch.share.junior 入门型'."\n" .'- opensearch.share.common 共享通用型'."\n" .'- opensearch.share.compute 共享计算型'."\n" .'- opensearch.share.storage 共享存储型'."\n" .'- opensearch.private.common 独享通用型'."\n" .'- opensearch.private.compute 独享计算型'."\n" .'- opensearch.private.storage 独享存储型', 'type' => 'string', 'example' => 'opensearch.share.common', ], 'docSize' => [ 'description' => '存储容量（单位：GB）', 'type' => 'integer', 'format' => 'int32', 'example' => '1', ], 'computeResource' => [ 'description' => '计算资源（单位：LCU）', 'type' => 'integer', 'format' => 'int32', 'example' => '20', ], ], 'example' => '{}', ], 'tags' => [ 'description' => '应用标签', 'type' => 'array', 'items' => [ 'description' => '标签。', 'type' => 'object', 'properties' => [ 'key' => [ 'description' => '标签键', 'type' => 'string', 'example' => 'foo', ], 'value' => [ 'description' => '标签值', 'type' => 'string', 'example' => 'bar', ], ], ], ], 'engineType' => [ 'description' => '引擎类型', 'type' => 'string', 'example' => 'ha3', ], ], 'example' => '{}', ], 'example' => '[]', ], ], 'example' => '{}', ], ], '5XX' => [ 'schema' => [ 'type' => 'object', 'properties' => [ 'code' => [ 'type' => 'string', ], 'message' => [ 'type' => 'string', ], 'requestId' => [ 'type' => 'string', ], 'httpCode' => [ 'type' => 'integer', 'format' => 'int32', ], ], ], ], ], 'responseDemo' => '[{"type":"json","example":"{\\n \\"totalCount\\": 1,\\n \\"requestId\\": \\"0A6EB64B-B4C8-CF02-810F-E660812972FF\\",\\n \\"result\\": [\\n {\\n \\"created\\": 1575442875,\\n \\"currentVersion\\": \\"110116134\\",\\n \\"lockMode\\": \\"Unlock\\",\\n \\"updated\\": 1578916076,\\n \\"id\\": \\"110116134\\",\\n \\"chargeType\\": \\"POSTPAY\\",\\n \\"hasPendingQuotaReviewTask\\": 0,\\n \\"name\\": \\"os_function_test_v1\\",\\n \\"instanceId\\": \\"\\\\\\"xxx\\\\\\"\\",\\n \\"chargingWay\\": 1,\\n \\"type\\": \\"enhanced\\",\\n \\"status\\": \\"normal\\",\\n \\"projectId\\": \\"\\\\\\"xxx\\\\\\"\\",\\n \\"switchedTime\\": 0,\\n \\"commodityCode\\": \\"opensearch\\",\\n \\"expireOn\\": \\"\\\\\\"xxx\\\\\\"\\",\\n \\"domain\\": \\"\\\\\\"\\\\\\"\\",\\n \\"description\\": \\"\\\\\\"xxx\\\\\\"\\",\\n \\"produced\\": 1,\\n \\"lockedByExpiration\\": 0,\\n \\"quota\\": {\\n \\"spec\\": \\"opensearch.share.common\\",\\n \\"docSize\\": 1,\\n \\"computeResource\\": 20\\n },\\n \\"tags\\": [\\n {\\n \\"key\\": \\"foo\\",\\n \\"value\\": \\"bar\\"\\n }\\n ],\\n \\"engineType\\": \\"ha3\\"\\n }\\n ]\\n}","errorExample":""},{"type":"xml","example":"0A6EB64B-B4C8-CF02-810F-E660812972FF\\n1\\n\\n 110116134\\n os_function_test_v1\\n 110116134\\n 0\\n \\n 1\\n 20\\n opensearch.share.common\\n \\n 1\\n enhanced\\n \\n POSTPAY\\n \\n \\n opensearch\\n \\n 0\\n 0\\n 0\\n \\n 1\\n 0\\n 0\\n 1575442875\\n 1578916076\\n normal\\n Unlock\\n","errorExample":""}]', 'title' => '获取应用列表', 'description' => '- 支持按照 name、instanceId、type 进行过滤'."\n" .'- 支持按照应用的创建时间排序'."\n" .'- 支持分页参数', 'requestParamsDescription' => ' ', 'responseParamsDescription' => ' ', 'extraInfo' => ' ', ], 'CreateApp' => [ 'summary' => '创建一个OpenSearch应用版本。', 'path' => '/v4/openapi/app-groups/{appGroupIdentity}/apps', 'methods' => [ 'post', ], 'schemes' => [ 'http', 'https', ], 'security' => [ [ 'AK' => [], ], ], 'operationType' => 'write', 'deprecated' => false, 'systemTags' => [ 'operationType' => 'create', 'riskType' => 'none', 'chargeType' => 'free', 'abilityTreeCode' => '55146', 'abilityTreeNodes' => [ 'FEATUREopensearch2ESE2N', 'FEATUREopensearchG9QGQK', 'FEATUREopensearchO36CPI', ], ], 'parameters' => [ [ 'name' => 'appGroupIdentity', 'in' => 'path', 'schema' => [ 'description' => '应用名称', 'type' => 'string', 'required' => true, 'docRequired' => true, 'example' => 'my_app_group_name', ], ], [ 'name' => 'dryRun', 'in' => 'query', 'schema' => [ 'description' => '是否dryRun创建（仅校验数据源是否合法）。取值：-true 是 -false 否', 'type' => 'boolean', 'required' => false, 'example' => 'true', ], ], [ 'name' => 'body', 'in' => 'body', 'style' => 'json', 'schema' => [ 'description' => '请求Body。', 'type' => 'object', 'properties' => [ 'autoSwitch' => [ 'description' => '版本创建后是否自动切为在线版本'."\n" ."\n" .'- true'."\n" .'- false', 'type' => 'boolean', 'required' => false, 'example' => 'false', ], 'networkType' => [ 'description' => '可用区标识。可选值：'."\n" ."\n" .'- vpc'."\n" .'- oxs', 'type' => 'string', 'required' => false, 'example' => 'vpc', ], 'description' => [ 'description' => '版本描述', 'type' => 'string', 'required' => false, 'example' => '"版本描述"', ], 'schema' => [ 'description' => '单表应用结构', 'type' => 'object', 'properties' => [ 'tables' => [ 'description' => '表结构', 'type' => 'object', 'required' => false, 'example' => '{'."\n" .' "primaryTable": true,'."\n" .' "name": "main",'."\n" .' "fields": {'."\n" .' "id": {'."\n" .' "name": "id",'."\n" .' "type": "LITERAL",'."\n" .' "primaryKey": true'."\n" .' },'."\n" .' "title": {'."\n" .' "name": "title",'."\n" .' "type": "TEXT",'."\n" .' "primaryKey": false'."\n" .' },'."\n" .' "buy": {'."\n" .' "name": "buy",'."\n" .' "type": "INT",'."\n" .' "primaryKey": false'."\n" .' },'."\n" .' "cate_id": {'."\n" .' "name": "cate_id",'."\n" .' "type": "INT",'."\n" .' "primaryKey": false'."\n" .' },'."\n" .' "cate_name": {'."\n" .' "name": "cate_name",'."\n" .' "type": "LITERAL",'."\n" .' "primaryKey": false'."\n" .' }'."\n" .' }'."\n" .'}', ], 'indexes' => [ 'description' => '索引结构', 'type' => 'object', 'properties' => [ 'filterFields' => [ 'description' => '属性字段集合', 'type' => 'array', 'items' => [ 'description' => '属性字段', 'type' => 'string', 'required' => false, 'example' => 'id', ], 'required' => false, ], 'searchFields' => [ 'description' => '索引字段', 'type' => 'object', 'required' => false, 'example' => '{'."\n" .' "fields": ["title"],'."\n" .' "analyzer": "chn_standard"'."\n" .'}', ], ], 'required' => false, ], 'routeField' => [ 'description' => '一级分列字段名称', 'type' => 'string', 'required' => false, 'example' => 'field1', ], 'routeFieldValues' => [ 'description' => '一级分列字段热点值清单（配置后启用“二级分列”）', 'type' => 'array', 'items' => [ 'description' => '一级分列字段热点值', 'type' => 'string', 'required' => false, 'example' => 'routeFieldValues', ], 'required' => false, ], 'secondRouteField' => [ 'description' => '二级分列字段名称（当且仅当配置有`routeFieldValues`时生效，默认使用宽表主键）', 'type' => 'string', 'required' => false, 'example' => 'field2', ], 'ttlField' => [ 'description' => '文档清理配置', 'type' => 'object', 'properties' => [ 'name' => [ 'description' => '文档时间字段', 'type' => 'string', 'required' => false, 'example' => 'text1', ], 'ttl' => [ 'description' => '存活时间（毫秒）', 'type' => 'integer', 'format' => 'int64', 'required' => false, 'example' => '1000', ], ], 'required' => false, ], 'indexSortConfig' => [ 'description' => '倒排索引配置', 'type' => 'array', 'items' => [ 'title' => '倒排索引配置', 'description' => '倒排索引配置', 'type' => 'object', 'properties' => [ 'field' => [ 'description' => '排序字段', 'type' => 'string', 'required' => false, 'example' => 'field1', ], 'direction' => [ 'description' => '排序方式', 'type' => 'string', 'required' => false, 'example' => 'ASC;'."\n" .'DESC;', ], ], 'required' => false, ], 'required' => false, ], 'name' => [ 'description' => '宽表表名', 'type' => 'string', 'required' => false, 'example' => 'table_name', ], ], 'required' => false, ], 'schemas' => [ 'description' => '多表应用结构', 'type' => 'array', 'items' => [ 'description' => '单表应用结构', 'type' => 'object', 'properties' => [ 'tables' => [ 'description' => '表结构', 'type' => 'object', 'required' => false, 'example' => '{'."\n" .' "primaryTable": true,'."\n" .' "name": "main",'."\n" .' "fields": {'."\n" .' "id": {'."\n" .' "name": "id",'."\n" .' "type": "LITERAL",'."\n" .' "primaryKey": true'."\n" .' },'."\n" .' "title": {'."\n" .' "name": "title",'."\n" .' "type": "TEXT",'."\n" .' "primaryKey": false'."\n" .' },'."\n" .' "buy": {'."\n" .' "name": "buy",'."\n" .' "type": "INT",'."\n" .' "primaryKey": false'."\n" .' },'."\n" .' "cate_id": {'."\n" .' "name": "cate_id",'."\n" .' "type": "INT",'."\n" .' "primaryKey": false'."\n" .' },'."\n" .' "cate_name": {'."\n" .' "name": "cate_name",'."\n" .' "type": "LITERAL",'."\n" .' "primaryKey": false'."\n" .' }'."\n" .' }'."\n" .'}', ], 'indexes' => [ 'description' => '索引结构', 'type' => 'object', 'properties' => [ 'filterFields' => [ 'description' => '属性字段集合', 'type' => 'array', 'items' => [ 'description' => '属性字段', 'type' => 'string', 'required' => false, 'example' => 'id', ], 'required' => false, ], 'searchFields' => [ 'description' => '索引字段', 'type' => 'object', 'required' => false, 'example' => '{'."\n" .' "fields": ["title"],'."\n" .' "analyzer": "chn_standard"'."\n" .'}', ], ], 'required' => false, ], 'routeField' => [ 'description' => '一级分列字段名称', 'type' => 'string', 'required' => false, 'example' => 'field1', ], 'routeFieldValues' => [ 'description' => '一级分列字段热点值清单（配置后启用“二级分列”）', 'type' => 'array', 'items' => [ 'description' => '一级分列字段热点值', 'type' => 'string', 'required' => false, 'example' => 'routeFieldValues'."\n", ], 'required' => false, ], 'secondRouteField' => [ 'description' => '二级分列字段名称（当且仅当配置有routeFieldValues时生效，默认使用宽表主键）', 'type' => 'string', 'required' => false, 'example' => 'field2', ], 'ttlField' => [ 'description' => '文档清理配置', 'type' => 'object', 'properties' => [ 'name' => [ 'description' => '文档时间字段', 'type' => 'string', 'required' => false, 'example' => 'text1', ], 'ttl' => [ 'description' => '存活时间（毫秒）', 'type' => 'integer', 'format' => 'int64', 'required' => false, 'example' => '1000', ], ], 'required' => false, ], 'indexSortConfig' => [ 'title' => '', 'description' => '倒排索引配置', 'type' => 'array', 'items' => [ 'title' => '倒排索引配置', 'description' => '倒排索引配置', 'type' => 'object', 'properties' => [ 'field' => [ 'description' => '排序字段', 'type' => 'string', 'required' => false, 'example' => 'field1', ], 'direction' => [ 'description' => '排序方式'."\n" ."\n" .'- ASC'."\n" .'- DESC', 'type' => 'string', 'required' => false, 'example' => 'DESC', ], ], 'required' => false, ], 'required' => false, ], 'name' => [ 'description' => '宽表表名', 'type' => 'string', 'required' => false, 'example' => 'table_name', ], ], 'required' => false, ], 'required' => false, ], 'firstRanks' => [ 'description' => '粗排配置', 'type' => 'array', 'items' => [ 'description' => '粗排配置', 'type' => 'object', 'properties' => [ 'type' => [ 'description' => '表达式类型'."\n" ."\n" .'- STRUCT 结构化，'."\n" .'- 默认值- STRING 自定义公式', 'type' => 'string', 'required' => false, 'example' => 'STRING', ], 'name' => [ 'description' => '粗排名称', 'type' => 'string', 'required' => false, 'example' => 'test', ], 'description' => [ 'description' => '描述', 'type' => 'string', 'required' => false, 'example' => '描述'."\n", ], 'active' => [ 'description' => '是否是默认表达式', 'type' => 'boolean', 'required' => false, 'example' => 'False', ], 'meta' => [ 'description' => '表达式信息（Array 或 String）', 'type' => 'any', 'required' => false, 'example' => 'String :"random()*100+now()"；'."\n" .'Array: ['."\n" .' {'."\n" .' "attribute": "static_bm25()",'."\n" .' "arg": "",'."\n" .' "weight": 10'."\n" .' }'."\n" .' ]', ], ], 'required' => false, ], 'required' => false, ], 'secondRanks' => [ 'description' => '精排配置', 'type' => 'array', 'items' => [ 'description' => '精排配置', 'type' => 'object', 'properties' => [ 'meta' => [ 'description' => '精排表达式（可以编写包含字段、算分特征和数学函数的表达式，实现复杂的排序逻辑）', 'type' => 'any', 'required' => false, 'example' => '"cate_id > 0 and cate_id < 1000"', ], 'name' => [ 'description' => '精排名称', 'type' => 'string', 'required' => false, 'example' => 'default', ], 'description' => [ 'description' => '描述', 'type' => 'string', 'required' => false, 'example' => '描述', ], 'active' => [ 'description' => '是否是默认表达式', 'type' => 'boolean', 'required' => false, 'example' => 'False', ], ], 'required' => false, ], 'required' => false, ], 'dataSources' => [ 'description' => '数据源配置', 'type' => 'array', 'items' => [ 'description' => '数据源配置', 'type' => 'object', 'properties' => [ 'tableName' => [ 'description' => '应用表名', 'type' => 'string', 'required' => false, 'example' => 'main', ], 'type' => [ 'description' => '数据源类型'."\n" ."\n" .'- rds'."\n" .'- odps'."\n" .'- opensearch'."\n" .'- polardb', 'type' => 'string', 'required' => false, 'example' => 'rds', ], 'fields' => [ 'description' => '表字段映射信息', 'type' => 'array', 'items' => [ 'description' => '表字段映射信息', 'type' => 'object', 'required' => false, 'example' => '{'."\n" .' "id": "id"'."\n" .' }', ], 'required' => false, ], 'plugins' => [ 'description' => '字段数据处理插件'."\n" ."\n" .'插件名称（name）'."\n" ."\n" .'- JsonKeyValueExtractor'."\n" .'- MultiValueSpliter'."\n" .'- KeyValueExtractor'."\n" .'- StringCatenateExtractor'."\n" .'- HTMLTagRemover'."\n" ."\n" .'插件参数（parameters）：'."\n" ."\n" .'- JsonKeyValueExtractor'."\n" .'- MultiValueSpliter'."\n" .'- KeyValueExtractor'."\n" .'- StringCatenateExtractor'."\n" .'- HTMLTagRemover', 'type' => 'object', 'required' => false, 'example' => '{'."\n" .' "name": "JsonKeyValueExtractor",'."\n" .' "parameters": {'."\n" .' "key": "my_field"'."\n" .'}'."\n" .'}', ], 'keyField' => [ 'description' => '主键', 'type' => 'string', 'required' => false, 'example' => 'id', ], 'schemaName' => [ 'description' => '宽表名称', 'type' => 'string', 'required' => false, 'example' => 'table_name', ], 'parameters' => [ 'description' => '数据源信息', 'type' => 'object', 'required' => false, 'example' => '{'."\n" .' "instanceId": "rds-instance-id",'."\n" .' "dbName": "my_db",'."\n" .' "dbTableName": "my_table",'."\n" .' "dbUser": "my",'."\n" .' "dbPassword": "my_passwd",'."\n" .' "filter":"",'."\n" .' "autoSync": true'."\n" .'}', ], ], 'required' => false, ], 'required' => false, ], 'summaries' => [ 'description' => '搜索结果摘要配置', 'type' => 'array', 'items' => [ 'description' => '搜索结果摘要配置', 'type' => 'object', 'properties' => [ 'name' => [ 'description' => '分组名', 'type' => 'string', 'required' => false, 'example' => 'default', ], 'meta' => [ 'description' => '摘要配置集合', 'type' => 'array', 'items' => [ 'description' => '摘要配置', 'type' => 'object', 'properties' => [ 'field' => [ 'description' => '字段', 'type' => 'string', 'required' => false, 'example' => 'field1', ], 'len' => [ 'description' => '片段长度。取值区间：[1-300]', 'type' => 'integer', 'format' => 'int32', 'required' => false, 'example' => '50', ], 'element' => [ 'description' => '飘红标签', 'type' => 'string', 'required' => false, 'example' => 'em', ], 'ellipsis' => [ 'description' => '片段链接符', 'type' => 'string', 'required' => false, 'example' => '...', ], 'snippet' => [ 'description' => '片段数量。取值区间：[1-5]', 'type' => 'string', 'required' => false, 'example' => '1', ], ], 'required' => false, ], 'required' => false, ], ], 'required' => false, ], 'required' => false, ], 'fetchFields' => [ 'description' => '默认展示字段', 'type' => 'array', 'items' => [ 'description' => '字段', 'type' => 'string', 'required' => false, 'example' => 'field1', ], 'required' => false, ], 'queryProcessors' => [ 'description' => '查询意图理解配置', 'type' => 'array', 'items' => [ 'description' => '查询意图理解配置', 'type' => 'object', 'properties' => [ 'name' => [ 'description' => '规则名称', 'type' => 'string', 'required' => false, 'example' => 'name', ], 'domain' => [ 'description' => '行业类型'."\n" .'- GENERAL 通用'."\n" .'- ECOMMERCE 电商'."\n" .'- IT_CONTENT IT内容', 'type' => 'string', 'required' => false, 'example' => 'ECOMMERCE', ], 'category' => [ 'description' => '行业垂类', 'type' => 'string', 'required' => false, 'example' => '""', ], 'processors' => [ 'description' => '包含功能', 'type' => 'array', 'items' => [ 'description' => '包含功能', 'type' => 'object', 'required' => false, 'example' => '{'."\n" .'"name": "stop_word", "useSystemDictionary": true,'."\n" .'"interventionDictionary": "my_dict",'."\n" .' "ignoreSpace": true'."\n" .'}', ], 'required' => false, ], 'indexes' => [ 'description' => '应用的索引范围', 'type' => 'array', 'items' => [ 'description' => '应用索引', 'type' => 'string', 'required' => false, 'example' => 'default', ], 'required' => false, ], 'active' => [ 'description' => '是否默认规则', 'type' => 'boolean', 'required' => false, 'example' => 'True', ], ], 'required' => false, ], 'required' => false, ], 'cluster' => [ 'description' => '能力开放配置', 'type' => 'object', 'properties' => [ 'maxTimeoutMS' => [ 'description' => '集群的超时时间，单位是ms', 'type' => 'integer', 'format' => 'int32', 'required' => false, 'example' => '750', ], 'maxQueryClauseLength' => [ 'description' => 'query字句最大长度', 'type' => 'integer', 'format' => 'int32', 'required' => false, 'example' => '1024', ], 'textSparseEmbeddingModel' => [ 'title' => '用于指定LLM应用版本使用的稀疏向量模型', 'type' => 'string', 'required' => false, 'example' => 'ops-text-sparse-embedding-001', ], 'textEmbeddingModel' => [ 'title' => '用于指定LLM应用版本使用的文本向量化模型', 'type' => 'string', 'required' => false, 'example' => 'ops-text-embedding-002', ], 'chunkModels' => [ 'title' => '切片方式', 'type' => 'array', 'items' => [ 'title' => '切片方式配置项', 'type' => 'object', 'required' => false, ], 'required' => false, ], 'imageContentRecognizerModels' => [ 'title' => '图片内容识别的模型', 'type' => 'array', 'items' => [ 'title' => '图片内容识别的模型配置项', 'type' => 'object', 'required' => false, ], 'required' => false, ], 'graphRag' => [ 'title' => 'GraphRAG集成配置', 'type' => 'object', 'required' => false, ], 'vectorIndexConfigs' => [ 'title' => '独享型向量索引高级配置', 'type' => 'array', 'items' => [ 'title' => '独享型向量索引高级配置配置项', 'type' => 'object', 'required' => false, ], 'required' => false, ], ], 'required' => false, ], 'domain' => [ 'description' => '行业模型', 'type' => 'object', 'properties' => [ 'name' => [ 'description' => '行业类型', 'type' => 'string', 'required' => false, 'example' => 'ecommerce', ], 'category' => [ 'description' => '行业垂类', 'type' => 'string', 'required' => false, 'example' => 'general', ], 'functions' => [ 'description' => '已选择功能'."\n" ."\n" .'- qp 查询分析类'."\n" .'- algo 排序策略类'."\n" .'- service 周边服务类', 'type' => 'object', 'required' => false, 'example' => '{"qp":["spellcheck"],"algo":["pop"],"service":["suggest"]}', ], ], 'required' => false, ], 'realtimeShared' => [ 'title' => '是否共享实时流', 'type' => 'boolean', 'required' => false, ], 'interpretations' => [ 'title' => 'LLM表字段描述', 'type' => 'array', 'items' => [ 'title' => 'LLM表字段描述', 'type' => 'object', 'required' => false, ], 'required' => false, ], 'prompts' => [ 'title' => 'prompt配置', 'type' => 'array', 'items' => [ 'title' => '请求体中第一个提示内容', 'type' => 'object', 'required' => false, ], 'required' => false, ], 'configItems' => [ 'title' => '请求体中的配置项列表', 'type' => 'array', 'items' => [ 'title' => '配置项列表中的第一个元素', 'type' => 'object', 'required' => false, ], 'required' => false, ], ], 'required' => false, ], ], ], 'responses' => [ 200 => [ 'schema' => [ 'title' => '根节点或根目录', 'description' => '根节点或根目录', 'type' => 'object', 'properties' => [ 'requestId' => [ 'description' => '请求ID', 'type' => 'string', 'example' => 'ABCDEFG', ], 'result' => [ 'description' => '返回结果', 'type' => 'object', 'properties' => [ 'id' => [ 'description' => '应用ID', 'type' => 'string', 'example' => '12888', ], 'isCurrent' => [ 'description' => '是否是在线版本。', 'type' => 'boolean', 'example' => '12333', ], 'clusterName' => [ 'description' => '集群名称', 'type' => 'string', 'deprecated' => true, 'example' => 'vpc_sh_domain_1', ], 'type' => [ 'description' => '应用类型'."\n" .'- standard 标准版'."\n" .'- enhanced 新高级版', 'type' => 'string', 'example' => 'standard', ], 'description' => [ 'description' => '应用描述', 'type' => 'string', 'example' => '我的应用', ], 'status' => [ 'description' => '应用状态'."\n" ."\n" .'- OK'."\n" .'- STOPPED 暂停'."\n" .'- FROZEN 已冻结'."\n" .'- INITIALIZING 版本初始化中'."\n" .'- UNAVAILABLE 版本已失效'."\n" .'- DATA_WAITING 等待数据初始化'."\n" .'- DATA_PREPARING 数据初始化中', 'type' => 'string', 'example' => 'OK', ], 'schema' => [ 'description' => '单表应用结构', 'type' => 'object', 'properties' => [ 'tables' => [ 'description' => '表结构。', 'type' => 'object', 'example' => '{'."\n" .' "primaryTable": true,'."\n" .' "name": "main",'."\n" .' "fields": {'."\n" .' "id": {'."\n" .' "name": "id",'."\n" .' "type": "LITERAL",'."\n" .' "primaryKey": true'."\n" .' },'."\n" .' "title": {'."\n" .' "name": "title",'."\n" .' "type": "TEXT",'."\n" .' "primaryKey": false'."\n" .' },'."\n" .' "buy": {'."\n" .' "name": "buy",'."\n" .' "type": "INT",'."\n" .' "primaryKey": false'."\n" .' },'."\n" .' "cate_id": {'."\n" .' "name": "cate_id",'."\n" .' "type": "INT",'."\n" .' "primaryKey": false'."\n" .' },'."\n" .' "cate_name": {'."\n" .' "name": "cate_name",'."\n" .' "type": "LITERAL",'."\n" .' "primaryKey": false'."\n" .' }'."\n" .' }'."\n" .'}', ], 'indexes' => [ 'description' => '索引结构', 'type' => 'object', 'properties' => [ 'filterFields' => [ 'description' => '属性字段集合', 'type' => 'array', 'items' => [ 'description' => '属性字段', 'type' => 'string', 'example' => 'id', ], ], 'searchFields' => [ 'description' => '索引字段', 'type' => 'object', 'example' => '{'."\n" .' "fields": ["title"],'."\n" .' "analyzer": "chn_standard"'."\n" .'}', ], ], ], 'routeField' => [ 'description' => '一级分列字段名称', 'type' => 'string', 'example' => 'field1', ], 'routeFieldValues' => [ 'description' => '二级分列字段名称（当且仅当配置有routeFieldValues时生效，默认使用宽表主键）', 'type' => 'array', 'items' => [ 'description' => '一级分列字段热点值', 'type' => 'string', 'example' => 'routeFieldValues', ], ], 'secondRouteField' => [ 'description' => '二级分列字段名称（当且仅当配置有routeFieldValues时生效，默认使用宽表主键）', 'type' => 'string', 'example' => 'field2'."\n", ], 'ttlField' => [ 'description' => '文档清理配置', 'type' => 'object', 'properties' => [ 'name' => [ 'description' => '文档时间字段', 'type' => 'string', 'example' => 'text1'."\n", ], 'ttl' => [ 'description' => '存活时间（毫秒）', 'type' => 'integer', 'format' => 'int64', 'example' => '1000', ], ], ], 'indexSortConfig' => [ 'description' => '倒排索引配置', 'type' => 'array', 'items' => [ 'description' => '倒排索引配置', 'type' => 'object', 'properties' => [ 'field' => [ 'description' => '排序字段', 'type' => 'string', 'example' => 'field1', ], 'direction' => [ 'description' => '排序方式'."\n" ."\n" .'- ASC'."\n" .'- DESC', 'type' => 'string', 'example' => 'DESC', ], ], ], ], 'name' => [ 'description' => '宽表表名', 'type' => 'string', 'example' => 'test', ], ], ], 'progressPercent' => [ 'description' => '数据导入进度百分比', 'type' => 'integer', 'format' => 'int32', 'example' => '100', ], 'fetchFields' => [ 'description' => '默认展示字段集合', 'type' => 'array', 'items' => [ 'description' => '默认展示字段', 'type' => 'string', 'example' => 'field1', ], ], 'domain' => [ 'description' => '行业模型', 'type' => 'object', 'properties' => [ 'category' => [ 'description' => '行业垂类', 'type' => 'string', 'example' => '-', ], 'name' => [ 'description' => '行业类型'."\n" .'- GENERAL 通用'."\n" .'- ECOMMERCE 电商'."\n" .'- IT_CONTENT IT内容', 'type' => 'string', 'example' => 'GENERAL', ], 'functions' => [ 'description' => '已选择功能', 'type' => 'object', 'properties' => [ 'service' => [ 'description' => '周边服务类', 'type' => 'array', 'items' => [ 'description' => '周边服务类', 'type' => 'string', 'example' => 'suggest'."\n" ."\n", ], ], 'qp' => [ 'description' => '查询分析类', 'type' => 'array', 'items' => [ 'description' => '查询分析类', 'type' => 'string', 'example' => 'spellcheck', ], ], 'algo' => [ 'description' => '排序策略类', 'type' => 'array', 'items' => [ 'description' => '排序策略类', 'type' => 'string', 'example' => 'pop', ], ], ], ], ], ], 'schemas' => [ 'description' => '多表应用结构', 'type' => 'array', 'items' => [ 'description' => '应用结构', 'type' => 'object', 'properties' => [ 'tables' => [ 'description' => '表结构', 'type' => 'object', 'example' => '{'."\n" .' "primaryTable": true,'."\n" .' "name": "main",'."\n" .' "fields": {'."\n" .' "id": {'."\n" .' "name": "id",'."\n" .' "type": "LITERAL",'."\n" .' "primaryKey": true'."\n" .' },'."\n" .' "title": {'."\n" .' "name": "title",'."\n" .' "type": "TEXT",'."\n" .' "primaryKey": false'."\n" .' },'."\n" .' "buy": {'."\n" .' "name": "buy",'."\n" .' "type": "INT",'."\n" .' "primaryKey": false'."\n" .' },'."\n" .' "cate_id": {'."\n" .' "name": "cate_id",'."\n" .' "type": "INT",'."\n" .' "primaryKey": false'."\n" .' },'."\n" .' "cate_name": {'."\n" .' "name": "cate_name",'."\n" .' "type": "LITERAL",'."\n" .' "primaryKey": false'."\n" .' }'."\n" .' }'."\n" .'}', ], 'indexes' => [ 'description' => '索引结构', 'type' => 'object', 'properties' => [ 'filterFields' => [ 'description' => '属性字段集合', 'type' => 'array', 'items' => [ 'description' => '属性字段', 'type' => 'string', 'example' => 'field1', ], ], 'searchFields' => [ 'description' => '索引字段', 'type' => 'object', 'example' => '{'."\n" .' "fields": ["title"],'."\n" .' "analyzer": "chn_standard"'."\n" .'}'."\n", ], ], ], 'routeField' => [ 'description' => '一级分列字段名称', 'type' => 'string', 'example' => 'field1'."\n", ], 'routeFieldValues' => [ 'description' => '一级分列字段热点值清单（配置后启用“二级分列”）', 'type' => 'array', 'items' => [ 'description' => '一级分列字段热点值', 'type' => 'string', 'example' => 'routeFieldValues', ], ], 'secondRouteField' => [ 'description' => '二级分列字段名称（当且仅当配置有routeFieldValues时生效，默认使用宽表主键）', 'type' => 'string', 'example' => 'field2', ], 'ttlField' => [ 'description' => '文档清理配置', 'type' => 'object', 'properties' => [ 'name' => [ 'description' => '文档时间字段', 'type' => 'string', 'example' => 'fIeld1', ], 'ttl' => [ 'description' => '存活时间（毫秒）', 'type' => 'integer', 'format' => 'int64', 'example' => '1000', ], ], ], 'indexSortConfig' => [ 'description' => '倒排索引配置', 'type' => 'array', 'items' => [ 'description' => '倒排索引配置', 'type' => 'object', 'properties' => [ 'field' => [ 'description' => '排序字段', 'type' => 'string', 'example' => 'fIeld1', ], 'direction' => [ 'description' => '排序方式'."\n" ."\n" .'- ASC'."\n" .'- DESC', 'type' => 'string', 'example' => 'DESC', ], ], ], ], 'name' => [ 'description' => '宽表表名', 'type' => 'string', 'example' => 'main', ], ], ], ], 'firstRanks' => [ 'description' => '粗排配置', 'type' => 'array', 'items' => [ 'description' => '粗排配置', 'type' => 'object', 'properties' => [ 'type' => [ 'description' => '表达式类型'."\n" ."\n" .'STRUCT 结构化，'."\n" .'默认值- STRING 自定义公式', 'type' => 'string', 'example' => 'STRING', ], 'name' => [ 'description' => '粗排名称', 'type' => 'string', 'example' => 'test', ], 'description' => [ 'description' => '描述', 'type' => 'string', 'example' => '描述', ], 'active' => [ 'description' => '是否是默认表达式', 'type' => 'boolean', 'example' => 'False', ], 'meta' => [ 'description' => '表达式信息（Array 或 String）', 'type' => 'any', 'example' => 'String :"random()*100+now()"；'."\n" .'Array: ['."\n" .' {'."\n" .' "attribute": "static_bm25()",'."\n" .' "arg": "",'."\n" .' "weight": 10'."\n" .' }'."\n" .' ]', ], ], ], ], 'secondRanks' => [ 'description' => '精排配置', 'type' => 'array', 'items' => [ 'description' => '精排配置', 'type' => 'object', 'properties' => [ 'meta' => [ 'description' => '精排表达式（可以编写包含字段、算分特征和数学函数的表达式，实现复杂的排序逻辑）', 'type' => 'any', 'example' => '"cate_id > 0 and cate_id < 1000"'."\n", ], 'name' => [ 'description' => '精排名称', 'type' => 'string', 'example' => 'default'."\n", ], 'description' => [ 'description' => '描述', 'type' => 'string', 'example' => 'default'."\n", ], 'active' => [ 'description' => '是否是默认表达式', 'type' => 'boolean', 'example' => 'False', ], ], ], ], 'dataSources' => [ 'description' => '数据源配置', 'type' => 'array', 'items' => [ 'description' => '数据源配置', 'type' => 'object', 'properties' => [ 'tableName' => [ 'description' => '应用表名', 'type' => 'string', 'example' => 'main', ], 'type' => [ 'description' => '数据源类型'."\n" ."\n" .'- rds'."\n" .'- odps'."\n" .'- opensearch'."\n" .'- polardb', 'type' => 'string', 'example' => 'rds', ], 'fields' => [ 'description' => '表字段映射信息', 'type' => 'array', 'items' => [ 'description' => '表字段映射信息', 'type' => 'object', 'example' => '{'."\n" .' "id": "id"'."\n" .' }'."\n", ], ], 'plugins' => [ 'description' => '字段数据处理插件'."\n" ."\n" .'插件名称（name）'."\n" ."\n" .'- JsonKeyValueExtractor'."\n" .'- MultiValueSpliter'."\n" .'- KeyValueExtractor'."\n" .'- StringCatenateExtractor'."\n" .'- HTMLTagRemover'."\n" ."\n" .'插件参数（parameters）：'."\n" ."\n" .'- JsonKeyValueExtractor'."\n" .'- MultiValueSpliter'."\n" .'- KeyValueExtractor'."\n" .'- StringCatenateExtractor'."\n" .'- HTMLTagRemover', 'type' => 'object', 'example' => '{'."\n" .' "name": "JsonKeyValueExtractor",'."\n" .' "parameters": {'."\n" .' "key": "my_field"'."\n" .'}'."\n" .'}', ], 'keyField' => [ 'description' => '主键', 'type' => 'string', 'example' => 'id', ], 'schemaName' => [ 'description' => '宽表名称', 'type' => 'string', 'example' => 'table_name', ], 'parameters' => [ 'description' => '数据源信息', 'type' => 'object', 'example' => '{'."\n" .' "instanceId": "rds-instance-id",'."\n" .' "dbName": "my_db",'."\n" .' "dbTableName": "my_table",'."\n" .' "dbUser": "my",'."\n" .' "dbPassword": "my_passwd",'."\n" .' "filter":"",'."\n" .' "autoSync": true'."\n" .'}'."\n", ], ], ], ], 'summaries' => [ 'description' => '搜索结果摘要配置', 'type' => 'array', 'items' => [ 'description' => '搜索结果摘要配置', 'type' => 'object', 'properties' => [ 'name' => [ 'description' => '分组名', 'type' => 'string', 'example' => 'fefault', ], 'meta' => [ 'description' => '摘要配置集合', 'type' => 'array', 'items' => [ 'description' => '摘要配置', 'type' => 'object', 'properties' => [ 'field' => [ 'description' => '字段', 'type' => 'string', 'example' => 'field1', ], 'len' => [ 'description' => '片段长度。取值区间：[1-300]', 'type' => 'integer', 'format' => 'int32', 'example' => '50', ], 'element' => [ 'description' => '飘红标签', 'type' => 'string', 'example' => 'em', ], 'ellipsis' => [ 'description' => '片段链接符', 'type' => 'string', 'example' => '...', ], 'snippet' => [ 'description' => '片段数量。取值区间：[1-5]', 'type' => 'string', 'example' => '5', ], ], ], ], ], ], ], 'queryProcessors' => [ 'description' => '查询意图理解配置', 'type' => 'array', 'items' => [ 'description' => '查询意图理解配置', 'type' => 'object', 'properties' => [ 'name' => [ 'description' => '规则名称', 'type' => 'string', 'example' => 'test', ], 'domain' => [ 'description' => '行业类型'."\n" ."\n" .'- GENERAL 通用'."\n" .'- ECOMMERCE 电商'."\n" .'- IT_CONTENT IT内容', 'type' => 'string', 'example' => 'GENERAL', ], 'category' => [ 'description' => '行业垂类', 'type' => 'string', 'example' => '""', ], 'processors' => [ 'description' => '包含功能', 'type' => 'array', 'items' => [ 'description' => '包含功能', 'type' => 'object', 'example' => '{'."\n" .'"name": "stop_word", "useSystemDictionary": true,'."\n" .'"interventionDictionary": "my_dict",'."\n" .' "ignoreSpace": true'."\n" .'}', ], ], 'indexes' => [ 'description' => '应用的索引范围', 'type' => 'array', 'items' => [ 'description' => '应用索引', 'type' => 'string', 'example' => 'id', ], ], 'active' => [ 'description' => '是否默认规则', 'type' => 'boolean', 'example' => 'False', ], ], ], ], 'cluster' => [ 'description' => '能力开放配置', 'type' => 'object', 'properties' => [ 'maxTimeoutMS' => [ 'description' => '集群的超时时间，单位是ms', 'type' => 'integer', 'format' => 'int32', 'example' => '750', ], 'maxQueryClauseLength' => [ 'description' => 'query字句最大长度', 'type' => 'integer', 'format' => 'int32', 'example' => '1024', ], 'textEmbeddingModel' => [ 'title' => '用于指定LLM应用版本使用的文本向量化模型', 'description' => '用于指定LLM应用版本使用的文本向量化模型', 'type' => 'string', ], 'textSparseEmbeddingModel' => [ 'title' => '用于指定LLM应用版本使用的稀疏向量模型', 'description' => '用于指定LLM应用版本使用的稀疏向量模型', 'type' => 'string', ], 'chunkModels' => [ 'title' => '用于指定LLM应用版本使用的切片方式', 'description' => '用于指定LLM应用版本使用的切片方式', 'type' => 'array', 'items' => [ 'title' => '切片方式配置项', 'description' => '切片方式配置项', 'type' => 'object', ], ], 'imageContentRecognizerModels' => [ 'title' => '用于指定LLM应用版本使用的图片内容识别的模型', 'description' => '用于指定LLM应用版本使用的图片内容识别的模型', 'type' => 'array', 'items' => [ 'title' => '图片内容识别的模型配置项', 'description' => '图片内容识别的模型配置项', 'type' => 'object', ], ], 'graphRag' => [ 'title' => '用于指定LLM应用版本使用的GraphRAG集成配置', 'description' => '用于指定LLM应用版本使用的GraphRAG集成配置', 'type' => 'object', ], 'vectorIndexConfigs' => [ 'title' => '独享型向量索引高级配置', 'description' => '独享型向量索引高级配置', 'type' => 'array', 'items' => [ 'title' => '独享型向量索引高级配置配置项', 'description' => '独享型向量索引高级配置配置项', 'type' => 'object', ], ], ], ], 'prompts' => [ 'description' => 'prompt配置', 'type' => 'array', 'items' => [ 'description' => 'prompt配置', 'type' => 'object', 'example' => '{'."\n" .' "name" : "prompt_name",'."\n" .' "isDefault" : false,'."\n" .' "description":"描述",'."\n" .' "prompt" : {'."\n" .' "parameters" : ['."\n" .' {'."\n" .' "name" : "docs",'."\n" .' "value" : "doc内容的拼接方式，比如现在的 qwen的 \'
\\n${doc}\\n
\\n"'."\n" .' }'."\n" .' ],'."\n" .' "messages":['."\n" .' {'."\n" .' "role" : "role_name，这里是否需要限定只能是 system, user, assistant，还是可以让用户随意填写",'."\n" .' "content" : "用户设置的prompt内容，里面可以使用 ${parameter_key} 来表示期望动态替换的内容，具体替换规则参考下面说明"'."\n" .' }'."\n" .' ]'."\n" .' }'."\n" .' }', ], ], 'quota' => [ 'description' => '版本配额', 'type' => 'object', 'properties' => [ 'qps' => [ 'description' => '搜索请求', 'type' => 'integer', 'format' => 'int32', 'example' => '5', ], 'computeResource' => [ 'description' => '计算资源', 'type' => 'integer', 'format' => 'int32', 'example' => '20', ], 'docSize' => [ 'description' => '存储容量', 'type' => 'integer', 'format' => 'int32', 'example' => '1', ], 'spec' => [ 'description' => '规格'."\n" .'- opensearch.share.junior 入门型'."\n" .'- opensearch.share.common 共享通用型'."\n" .'- opensearch.share.compute 共享计算型'."\n" .'- opensearch.share.storage 共享存储型'."\n" .'- opensearch.private.common 独享通用型'."\n" .'- opensearch.private.compute 独享计算型'."\n" .'- opensearch.private.storage 独享存储型', 'type' => 'string', 'example' => 'opensearch.share.common', ], 'usedQps' => [ 'title' => '已使用的QPS', 'description' => '已使用的QPS', 'type' => 'integer', 'format' => 'int32', 'example' => '100', ], 'usedDocSize' => [ 'title' => '已使用的文档存储空间', 'description' => '已使用的文档存储空间', 'type' => 'number', 'format' => 'double', 'example' => '1024', ], 'usedComputeResource' => [ 'title' => '已使用的计算资源配额', 'description' => '已使用的计算资源配额', 'type' => 'integer', 'format' => 'int32', 'example' => '100', ], ], ], 'interpretations' => [ 'title' => 'LLM表字段描述', 'description' => 'LLM表字段描述', 'type' => 'array', 'items' => [ 'title' => 'LLM表字段描述', 'description' => 'LLM表字段描述', 'type' => 'object', ], 'example' => '{'."\n" .' "name": "longyu_llm_1",'."\n" .' "schemas": [],'."\n" .' "interpretations": ['."\n" .' {'."\n" .' "table": "table1",'."\n" .' "fields": ['."\n" .' {'."\n" .' "name": "field1",'."\n" .' "interpretation": "标题"'."\n" .' },'."\n" .' {'."\n" .' "name": "field2",'."\n" .' "interpretation": "编号"'."\n" .' }'."\n" .' ]'."\n" .' }'."\n" .' ]'."\n" .'}', ], 'configItems' => [ 'title' => '配置项列表', 'description' => '配置项列表', 'type' => 'array', 'items' => [ 'title' => '配置项列表中的第一个元素', 'description' => '配置项列表中的第一个元素', 'type' => 'object', ], ], 'updated' => [ 'title' => '变更时间', 'description' => '变更时间', 'type' => 'integer', 'format' => 'int64', ], 'created' => [ 'title' => '创建时间', 'description' => '创建时间', 'type' => 'integer', 'format' => 'int64', ], 'switchTime' => [ 'title' => '切换上线时间', 'description' => '切换上线时间', 'type' => 'integer', 'format' => 'int64', ], ], 'example' => '{}', ], ], ], ], '5XX' => [ 'schema' => [ 'type' => 'object', 'properties' => [ 'code' => [ 'type' => 'string', ], 'message' => [ 'type' => 'string', ], 'requestId' => [ 'type' => 'string', ], 'httpCode' => [ 'type' => 'integer', 'format' => 'int32', ], ], ], ], ], 'responseDemo' => '[{"type":"json","example":"{\\n \\"requestId\\": \\"ABCDEFG\\",\\n \\"result\\": {\\n \\"id\\": \\"12888\\",\\n \\"isCurrent\\": true,\\n \\"clusterName\\": \\"vpc_sh_domain_1\\",\\n \\"type\\": \\"standard\\",\\n \\"description\\": \\"我的应用\\",\\n \\"status\\": \\"OK\\",\\n \\"schema\\": {\\n \\"tables\\": {\\n \\"primaryTable\\": true,\\n \\"name\\": \\"main\\",\\n \\"fields\\": {\\n \\"id\\": {\\n \\"name\\": \\"id\\",\\n \\"type\\": \\"LITERAL\\",\\n \\"primaryKey\\": true\\n },\\n \\"title\\": {\\n \\"name\\": \\"title\\",\\n \\"type\\": \\"TEXT\\",\\n \\"primaryKey\\": false\\n },\\n \\"buy\\": {\\n \\"name\\": \\"buy\\",\\n \\"type\\": \\"INT\\",\\n \\"primaryKey\\": false\\n },\\n \\"cate_id\\": {\\n \\"name\\": \\"cate_id\\",\\n \\"type\\": \\"INT\\",\\n \\"primaryKey\\": false\\n },\\n \\"cate_name\\": {\\n \\"name\\": \\"cate_name\\",\\n \\"type\\": \\"LITERAL\\",\\n \\"primaryKey\\": false\\n }\\n }\\n },\\n \\"indexes\\": {\\n \\"filterFields\\": [\\n \\"id\\"\\n ],\\n \\"searchFields\\": {\\n \\"fields\\": [\\n \\"title\\"\\n ],\\n \\"analyzer\\": \\"chn_standard\\"\\n }\\n },\\n \\"routeField\\": \\"field1\\",\\n \\"routeFieldValues\\": [\\n \\"routeFieldValues\\"\\n ],\\n \\"secondRouteField\\": \\"field2\\\\n\\",\\n \\"ttlField\\": {\\n \\"name\\": \\"text1\\\\n\\",\\n \\"ttl\\": 1000\\n },\\n \\"indexSortConfig\\": [\\n {\\n \\"field\\": \\"field1\\",\\n \\"direction\\": \\"DESC\\"\\n }\\n ],\\n \\"name\\": \\"test\\"\\n },\\n \\"progressPercent\\": 100,\\n \\"fetchFields\\": [\\n \\"field1\\"\\n ],\\n \\"domain\\": {\\n \\"category\\": \\"-\\",\\n \\"name\\": \\"GENERAL\\",\\n \\"functions\\": {\\n \\"service\\": [\\n \\"suggest\\\\n\\\\n\\"\\n ],\\n \\"qp\\": [\\n \\"spellcheck\\"\\n ],\\n \\"algo\\": [\\n \\"pop\\"\\n ]\\n }\\n },\\n \\"schemas\\": [\\n {\\n \\"tables\\": {\\n \\"primaryTable\\": true,\\n \\"name\\": \\"main\\",\\n \\"fields\\": {\\n \\"id\\": {\\n \\"name\\": \\"id\\",\\n \\"type\\": \\"LITERAL\\",\\n \\"primaryKey\\": true\\n },\\n \\"title\\": {\\n \\"name\\": \\"title\\",\\n \\"type\\": \\"TEXT\\",\\n \\"primaryKey\\": false\\n },\\n \\"buy\\": {\\n \\"name\\": \\"buy\\",\\n \\"type\\": \\"INT\\",\\n \\"primaryKey\\": false\\n },\\n \\"cate_id\\": {\\n \\"name\\": \\"cate_id\\",\\n \\"type\\": \\"INT\\",\\n \\"primaryKey\\": false\\n },\\n \\"cate_name\\": {\\n \\"name\\": \\"cate_name\\",\\n \\"type\\": \\"LITERAL\\",\\n \\"primaryKey\\": false\\n }\\n }\\n },\\n \\"indexes\\": {\\n \\"filterFields\\": [\\n \\"field1\\"\\n ],\\n \\"searchFields\\": {\\n \\"fields\\": [\\n \\"title\\"\\n ],\\n \\"analyzer\\": \\"chn_standard\\"\\n }\\n },\\n \\"routeField\\": \\"field1\\\\n\\",\\n \\"routeFieldValues\\": [\\n \\"routeFieldValues\\"\\n ],\\n \\"secondRouteField\\": \\"field2\\",\\n \\"ttlField\\": {\\n \\"name\\": \\"fIeld1\\",\\n \\"ttl\\": 1000\\n },\\n \\"indexSortConfig\\": [\\n {\\n \\"field\\": \\"fIeld1\\",\\n \\"direction\\": \\"DESC\\"\\n }\\n ],\\n \\"name\\": \\"main\\"\\n }\\n ],\\n \\"firstRanks\\": [\\n {\\n \\"type\\": \\"STRING\\",\\n \\"name\\": \\"test\\",\\n \\"description\\": \\"描述\\",\\n \\"active\\": true,\\n \\"meta\\": \\"String :\\\\\\"random()*100+now()\\\\\\"；\\\\nArray: [\\\\n {\\\\n \\\\\\"attribute\\\\\\": \\\\\\"static_bm25()\\\\\\",\\\\n \\\\\\"arg\\\\\\": \\\\\\"\\\\\\",\\\\n \\\\\\"weight\\\\\\": 10\\\\n }\\\\n ]\\"\\n }\\n ],\\n \\"secondRanks\\": [\\n {\\n \\"meta\\": \\"\\\\\\"cate_id > 0 and cate_id < 1000\\\\\\"\\\\n\\",\\n \\"name\\": \\"default\\\\n\\",\\n \\"description\\": \\"default\\\\n\\",\\n \\"active\\": true\\n }\\n ],\\n \\"dataSources\\": [\\n {\\n \\"tableName\\": \\"main\\",\\n \\"type\\": \\"rds\\",\\n \\"fields\\": [\\n {\\n \\"id\\": \\"id\\"\\n }\\n ],\\n \\"plugins\\": {\\n \\"name\\": \\"JsonKeyValueExtractor\\",\\n \\"parameters\\": {\\n \\"key\\": \\"my_field\\"\\n }\\n },\\n \\"keyField\\": \\"id\\",\\n \\"schemaName\\": \\"table_name\\",\\n \\"parameters\\": {\\n \\"instanceId\\": \\"rds-instance-id\\",\\n \\"dbName\\": \\"my_db\\",\\n \\"dbTableName\\": \\"my_table\\",\\n \\"dbUser\\": \\"my\\",\\n \\"dbPassword\\": \\"my_passwd\\",\\n \\"filter\\": \\"\\",\\n \\"autoSync\\": true\\n }\\n }\\n ],\\n \\"summaries\\": [\\n {\\n \\"name\\": \\"fefault\\",\\n \\"meta\\": [\\n {\\n \\"field\\": \\"field1\\",\\n \\"len\\": 50,\\n \\"element\\": \\"em\\",\\n \\"ellipsis\\": \\"...\\",\\n \\"snippet\\": \\"5\\"\\n }\\n ]\\n }\\n ],\\n \\"queryProcessors\\": [\\n {\\n \\"name\\": \\"test\\",\\n \\"domain\\": \\"GENERAL\\",\\n \\"category\\": \\"\\\\\\"\\\\\\"\\",\\n \\"processors\\": [\\n {\\n \\"name\\": \\"stop_word\\",\\n \\"useSystemDictionary\\": true,\\n \\"interventionDictionary\\": \\"my_dict\\",\\n \\"ignoreSpace\\": true\\n }\\n ],\\n \\"indexes\\": [\\n \\"id\\"\\n ],\\n \\"active\\": true\\n }\\n ],\\n \\"cluster\\": {\\n \\"maxTimeoutMS\\": 750,\\n \\"maxQueryClauseLength\\": 1024,\\n \\"textEmbeddingModel\\": \\"\\",\\n \\"textSparseEmbeddingModel\\": \\"\\",\\n \\"chunkModels\\": [\\n {\\n \\"test\\": \\"test\\",\\n \\"test2\\": 1\\n }\\n ],\\n \\"imageContentRecognizerModels\\": [\\n {\\n \\"test\\": \\"test\\",\\n \\"test2\\": 1\\n }\\n ],\\n \\"graphRag\\": {\\n \\"test\\": \\"test\\",\\n \\"test2\\": 1\\n },\\n \\"vectorIndexConfigs\\": [\\n {\\n \\"test\\": \\"test\\",\\n \\"test2\\": 1\\n }\\n ]\\n },\\n \\"prompts\\": [\\n {\\n \\"name\\": \\"prompt_name\\",\\n \\"isDefault\\": false,\\n \\"description\\": \\"描述\\",\\n \\"prompt\\": {\\n \\"parameters\\": [\\n {\\n \\"name\\": \\"docs\\",\\n \\"value\\": \\"doc内容的拼接方式，比如现在的 qwen的 \'
\\\\n${doc}\\\\n
\\\\n\\"\\n }\\n ],\\n \\"messages\\": [\\n {\\n \\"role\\": \\"role_name，这里是否需要限定只能是 system, user, assistant，还是可以让用户随意填写\\",\\n \\"content\\": \\"用户设置的prompt内容，里面可以使用 ${parameter_key} 来表示期望动态替换的内容，具体替换规则参考下面说明\\"\\n }\\n ]\\n }\\n }\\n ],\\n \\"quota\\": {\\n \\"qps\\": 5,\\n \\"computeResource\\": 20,\\n \\"docSize\\": 1,\\n \\"spec\\": \\"opensearch.share.common\\",\\n \\"usedQps\\": 100,\\n \\"usedDocSize\\": 1024,\\n \\"usedComputeResource\\": 100\\n },\\n \\"interpretations\\": [\\n {\\n \\"test\\": \\"test\\",\\n \\"test2\\": 1\\n }\\n ],\\n \\"configItems\\": [\\n {\\n \\"test\\": \\"test\\",\\n \\"test2\\": 1\\n }\\n ],\\n \\"updated\\": 0,\\n \\"created\\": 0,\\n \\"switchTime\\": 0\\n }\\n}","errorExample":""},{"type":"xml","example":"8664F6B7-9DD8-096A-FA3E-EBEE199EB94C\\n\\n 123456\\n \\n initializing\\n id\\n title\\n buy\\n cate_id\\n cate_name\\n enhanced\\n \\n \\n
\\n main\\n true\\n \\n \\n id\\n LITERAL\\n true\\n \\n \\n <name>title</name>\\n <type>TEXT</type>\\n <primaryKey>false</primaryKey>\\n \\n \\n buy\\n INT\\n false\\n \\n \\n cate_id\\n INT\\n false\\n \\n \\n cate_name\\n LITERAL\\n false\\n \\n \\n
\\n \\n \\n \\n \\n id\\n \\n \\n title\\n chn_standard\\n \\n \\n cate_name\\n \\n \\n id\\n buy\\n cate_id\\n cate_name\\n \\n \\n 0\\n 0\\n 0\\n","errorExample":""}]', 'title' => '创建一个应用版本', 'description' => '- 若已存在同名标准版应用，则创建新版本；'."\n" .'- 在新建版本情况下，autoSwitch 和 realtimeShared 也是必填的；'."\n" .'- 在新建版本情况下，quota 是自动从上一个版本继承的；'."\n" .'- 在新建版本情况下，修改 quota 是无效的。', 'requestParamsDescription' => '**请求体**'."\n" .'| 字段 | 类型 | 是否必要 | 示例值 | 描述 |'."\n" .'| --- | --- | --- | --- | --- |'."\n" .'| type | String | 是 | "standard" | 应用类型
- standard 标准版
- enhanced 高级版 |'."\n" .'| schema | Object | 是 | | 应用版本结构
参考：[Schema](~~170003~~) |'."\n" .'| fetchFields | Array | 是 | ["id", "name"] | 默认展示字段 |'."\n" .'| realtimeShared | Boolean | 是 | false | 是否共享实时流 |'."\n" .'| autoSwitch | Boolean | 是 | false | 是否自动切上线 |'."\n" .'| description | String | 否 | "demo" | 备注 |'."\n" .'| quota | Object | 否 | | 版本配额信息
参考：[Quota](~~170001~~) |'."\n" .'| dataSources[] | Object | 否 | | 数据源详情
参考：[DataSource](~~170005~~) |'."\n" .'| firstRanks[] | Object | 否 | | 粗排表达式配置详情
参考：[FirstRank](~~170007~~) |'."\n" .'| secondRanks[] | Object | 否 | | 精排表达式配置详情
参考：[SecondRank](~~170008~~) |'."\n" .'| queryProcessors[] | Object | 否 | | 查询意图理解规则配置详情
参考：[QueryProcessor](~~170014~~) |'."\n" .'| summaries[] | Object | 否 | | 搜索结果摘要设置
参考：[Summary](~~170016~~) |'."\n" ."\n", 'responseParamsDescription' => ' ', 'extraInfo' => ' ', ], 'RemoveApp' => [ 'summary' => '删除一个 OpenSearch应用版本。', 'path' => '/v4/openapi/app-groups/{appGroupIdentity}/apps/{appId}', 'methods' => [ 'delete', ], 'schemes' => [ 'http', 'https', ], 'security' => [ [ 'AK' => [], ], ], 'operationType' => 'write', 'deprecated' => false, 'systemTags' => [ 'operationType' => 'delete', 'riskType' => 'none', 'chargeType' => 'free', 'abilityTreeCode' => '55248', 'abilityTreeNodes' => [ 'FEATUREopensearchGVH0IN', 'FEATUREopensearch447AAX', 'FEATUREopensearch5OZOSP', ], ], 'parameters' => [ [ 'name' => 'appGroupIdentity', 'in' => 'path', 'schema' => [ 'description' => '应用的名称或者是应用id', 'type' => 'string', 'required' => true, 'docRequired' => true, 'example' => '“my_app_group_name”', ], ], [ 'name' => 'appId', 'in' => 'path', 'schema' => [ 'description' => '版本ID', 'type' => 'integer', 'format' => 'int32', 'required' => true, 'docRequired' => true, 'example' => '110116134', ], ], ], 'responses' => [ 200 => [ 'schema' => [ 'type' => 'object', 'properties' => [ 'requestId' => [ 'description' => '请求ID', 'type' => 'string', 'example' => '33477D76-C380-2D84-A4AD-043F52876CB1', ], 'result' => [ 'description' => '—', 'type' => 'array', 'items' => [ 'description' => '—', 'type' => 'integer', 'format' => 'int32', 'example' => '[]', ], ], ], ], ], '5XX' => [ 'schema' => [ 'type' => 'object', 'properties' => [ 'code' => [ 'type' => 'string', ], 'message' => [ 'type' => 'string', ], 'requestId' => [ 'type' => 'string', ], 'httpCode' => [ 'type' => 'integer', 'format' => 'int32', ], ], ], ], ], 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"requestId\\": \\"33477D76-C380-2D84-A4AD-043F52876CB1\\",\\n \\"result\\": [\\n 0\\n ]\\n}","type":"json"}]', 'title' => '删除一个应用版本', ], 'DescribeApps' => [ 'summary' => '获取一个 OpenSearch 应用的版本列表。', 'path' => '/v4/openapi/app-groups/{appGroupIdentity}/apps', 'methods' => [ 'get', ], 'schemes' => [ 'http', 'https', ], 'security' => [ [ 'AK' => [], ], ], 'operationType' => 'read', 'deprecated' => false, 'systemTags' => [ 'operationType' => 'list', 'riskType' => 'none', 'chargeType' => 'free', 'abilityTreeCode' => '55172', 'abilityTreeNodes' => [ 'FEATUREopensearchGVH0IN', 'FEATUREopensearch447AAX', 'FEATUREopensearch5OZOSP', ], ], 'parameters' => [ [ 'name' => 'appGroupIdentity', 'in' => 'path', 'schema' => [ 'description' => '应用名称', 'type' => 'string', 'required' => true, 'docRequired' => true, 'example' => 'my_app_group_name', ], ], ], 'responses' => [ 200 => [ 'schema' => [ 'type' => 'object', 'properties' => [ 'requestId' => [ 'description' => '请求ID', 'type' => 'string', 'example' => '77CAA411-0010-4DB9-82E2-1C384E590AFF', ], 'result' => [ 'description' => '返回结果', 'type' => 'array', 'items' => [ 'description' => '版本信息，参考：[App](~~170002~~)', 'type' => 'object', 'properties' => [ 'id' => [ 'description' => '组ID', 'type' => 'string', 'example' => '100302881', ], 'isCurrent' => [ 'description' => '是否是在线版本。', 'type' => 'boolean', 'example' => '12333', ], 'clusterName' => [ 'description' => '集群名称', 'type' => 'string', 'example' => 'vpc_sh_domain_1', ], 'autoSwitch' => [ 'description' => '是否自动切换', 'type' => 'boolean', 'example' => 'true', ], 'type' => [ 'description' => '应用类型'."\n" .'- standard 标准版'."\n" .'- advance 老高级版（新应用不支持此类型）'."\n" .'- enhanced 新高级版', 'type' => 'string', 'example' => 'enhanced', ], 'description' => [ 'description' => '描述', 'type' => 'string', 'example' => '""', ], 'status' => [ 'description' => '版本状态'."\n" .'- ok 正常'."\n" .'- stopped 暂停'."\n" .'- frozen 已冻结'."\n" .'- initializing 版本初始化中'."\n" .'- unavailable 版本已失效'."\n" .'- data_waiting 等待数据初始化'."\n" .'- data_preparing 数据初始化中', 'type' => 'string', 'example' => 'normal', ], 'schema' => [ 'description' => '应用结构', 'type' => 'object', 'properties' => [ 'tables' => [ 'description' => '表结构。', 'type' => 'object', ], 'indexes' => [ 'description' => '索引结构', 'type' => 'object', 'properties' => [ 'filterFields' => [ 'description' => '属性字段', 'type' => 'array', 'items' => [ 'description' => '属性字段', 'type' => 'string', 'example' => 'id', ], ], 'searchFields' => [ 'description' => '索引字段', 'type' => 'object', ], ], ], 'routeField' => [ 'description' => '一级分列字段名称', 'type' => 'string', 'example' => 'field1', ], 'routeFieldValues' => [ 'description' => '一级分列字段热点值', 'type' => 'array', 'items' => [ 'description' => '一级分列字段热点值', 'type' => 'string', 'example' => 'routeFieldValues', ], ], 'secondRouteField' => [ 'description' => '二级分列字段名称（当且仅当配置有routeFieldValues时生效，默认使用宽表主键）', 'type' => 'string', 'example' => 'field2'."\n", ], 'ttlField' => [ 'description' => '文档清理配置', 'type' => 'object', 'properties' => [ 'name' => [ 'description' => '文档清理字段', 'type' => 'string', 'example' => 'text1'."\n", ], 'ttl' => [ 'description' => '存活时间（毫秒）', 'type' => 'integer', 'format' => 'int64', 'example' => '1000', ], ], ], 'indexSortConfig' => [ 'description' => '倒排索引配置', 'type' => 'array', 'items' => [ 'description' => '倒排索引配置', 'type' => 'object', 'properties' => [ 'field' => [ 'description' => '排序字段', 'type' => 'string', 'example' => 'field1', ], 'direction' => [ 'description' => '排序方式'."\n" ."\n" .'- ASC'."\n" .'- DESC', 'type' => 'string', 'example' => 'DESC', ], ], ], ], 'name' => [ 'description' => '宽表表名', 'type' => 'string', 'example' => 'test', ], ], ], 'progressPercent' => [ 'description' => '数据导入进度百分比（如83代表83%）', 'type' => 'integer', 'format' => 'int32', 'example' => '100', ], 'fetchFields' => [ 'description' => '默认展示字段', 'type' => 'array', 'items' => [ 'description' => '默认展示字段', 'type' => 'string', 'example' => '{}', ], ], 'quota' => [ 'description' => '配额信息', 'type' => 'object', 'properties' => [ 'spec' => [ 'description' => '规格'."\n" .'- opensearch.share.junior 入门型'."\n" .'- opensearch.share.common 共享通用型'."\n" .'- opensearch.share.compute 共享计算型'."\n" .'- opensearch.share.storage 共享存储型'."\n" .'- opensearch.private.common 独享通用型'."\n" .'- opensearch.private.compute 独享计算型'."\n" .'- opensearch.private.storage 独享存储型', 'type' => 'string', 'example' => 'opensearch.share.common', ], 'qps' => [ 'description' => '搜索请求（单位：次/秒）（老计费模型使用）', 'type' => 'integer', 'format' => 'int32', 'example' => '5', ], 'docSize' => [ 'description' => '存储容量（单位：GB）', 'type' => 'integer', 'format' => 'int32', 'example' => '1', ], 'computeResource' => [ 'description' => '计算资源（单位：LCU）', 'type' => 'integer', 'format' => 'int32', 'example' => '20', ], ], ], 'domain' => [ 'description' => '行业类型'."\n" .'- GENERAL 通用'."\n" .'- ECOMMERCE 电商'."\n" .'- IT_CONTENT IT内容', 'type' => 'object', 'properties' => [ 'category' => [ 'description' => '类型-standard标准版-advance老高级版（新应用不支持此类型）-enhanced新高级版', 'type' => 'string', 'example' => '-', ], 'name' => [ 'description' => '英文名称', 'type' => 'string', 'example' => 'test', ], 'functions' => [ 'description' => '搜索结果', 'type' => 'object', 'properties' => [ 'service' => [ 'description' => '功能1', 'type' => 'array', 'items' => [ 'description' => '功能1', 'type' => 'string', 'example' => '-', ], ], 'qp' => [ 'description' => '信息1', 'type' => 'array', 'items' => [ 'description' => '信息1', 'type' => 'string', 'example' => 'spellcheck', ], ], 'algo' => [ 'description' => '结构1', 'type' => 'array', 'items' => [ 'description' => '结构1', 'type' => 'string', 'example' => 'pop', ], ], ], ], ], ], 'schemas' => [ 'description' => '单表应用结构', 'type' => 'array', 'items' => [ 'description' => '单表应用结构', 'type' => 'object', 'properties' => [ 'tables' => [ 'description' => '表结构', 'type' => 'object', ], 'indexes' => [ 'description' => '索引结构', 'type' => 'object', 'properties' => [ 'filterFields' => [ 'description' => '属性字段', 'type' => 'array', 'items' => [ 'description' => '属性字段', 'type' => 'string', 'example' => 'field1', ], ], 'searchFields' => [ 'description' => '索引字段', 'type' => 'object', ], ], ], 'routeField' => [ 'description' => '一级分列字段名称', 'type' => 'string', 'example' => 'field1'."\n", ], 'routeFieldValues' => [ 'description' => '一级分列字段热点值', 'type' => 'array', 'items' => [ 'description' => '一级分列字段热点值', 'type' => 'string', 'example' => 'routeFieldValues', ], ], 'secondRouteField' => [ 'description' => '二级分列字段名称（当且仅当配置有routeFieldValues时生效，默认使用宽表主键）', 'type' => 'string', 'example' => 'field2', ], 'ttlField' => [ 'description' => '文档清理配置', 'type' => 'object', 'properties' => [ 'name' => [ 'description' => '文档时间字段', 'type' => 'string', 'example' => 'fIeld1', ], 'ttl' => [ 'description' => '存活时间（毫秒）', 'type' => 'integer', 'format' => 'int64', 'example' => '1000', ], ], ], 'indexSortConfig' => [ 'description' => '倒排索引配置', 'type' => 'array', 'items' => [ 'description' => '倒排索引配置', 'type' => 'object', 'properties' => [ 'field' => [ 'description' => '排序字段', 'type' => 'string', 'example' => 'fIeld1', ], 'direction' => [ 'description' => '排序方式'."\n" ."\n" .'- ASC'."\n" .'- DESC', 'type' => 'string', 'example' => 'DESC', ], ], ], ], 'name' => [ 'description' => '宽表表名', 'type' => 'string', 'example' => 'main', ], ], ], ], 'firstRanks' => [ 'description' => '粗排配置', 'type' => 'array', 'items' => [ 'description' => '粗排配置', 'type' => 'object', 'properties' => [ 'type' => [ 'description' => '表达式类型'."\n" ."\n" .'STRUCT 结构化，'."\n" .'默认值- STRING 自定义公式', 'type' => 'string', 'example' => 'STRING', ], 'name' => [ 'description' => '粗排名称', 'type' => 'string', 'example' => 'test', ], 'description' => [ 'description' => '描述', 'type' => 'string', 'example' => '描述', ], 'active' => [ 'description' => '是否是默认表达式', 'type' => 'boolean', 'example' => 'False', ], 'meta' => [ 'description' => '表达式信息（Array 或 String）', 'type' => 'any', 'example' => 'String :"random()*100+now()"；'."\n" .'Array: ['."\n" .' {'."\n" .' "attribute": "static_bm25()",'."\n" .' "arg": "",'."\n" .' "weight": 10'."\n" .' }'."\n" .' ]', ], ], ], ], 'secondRanks' => [ 'description' => '精排配置', 'type' => 'array', 'items' => [ 'description' => '精排配置', 'type' => 'object', 'properties' => [ 'meta' => [ 'description' => '精排表达式（可以编写包含字段、算分特征和数学函数的表达式，实现复杂的排序逻辑）', 'type' => 'any', 'example' => '"cate_id > 0 and cate_id < 1000"'."\n", ], 'name' => [ 'description' => '精排名称', 'type' => 'string', 'example' => 'default'."\n", ], 'description' => [ 'description' => '描述', 'type' => 'string', 'example' => '描述', ], 'active' => [ 'description' => '是否是默认表达式', 'type' => 'boolean', 'example' => 'False', ], ], ], ], 'dataSources' => [ 'description' => '数据源配置', 'type' => 'array', 'items' => [ 'description' => '数据源配置', 'type' => 'object', 'properties' => [ 'tableName' => [ 'description' => '应用表名', 'type' => 'string', 'example' => 'main', ], 'type' => [ 'description' => '数据源类型'."\n" ."\n" .'- rds'."\n" .'- odps'."\n" .'- opensearch'."\n" .'- polardb', 'type' => 'string', 'example' => 'rds', ], 'fields' => [ 'description' => '表字段映射信息', 'type' => 'array', 'items' => [ 'description' => '表字段映射信息', 'type' => 'object', ], ], 'plugins' => [ 'description' => '字段数据处理插件'."\n" ."\n" .'插件名称（name）'."\n" ."\n" .'- JsonKeyValueExtractor'."\n" .'- MultiValueSpliter'."\n" .'- KeyValueExtractor'."\n" .'- StringCatenateExtractor'."\n" .'- HTMLTagRemover'."\n" ."\n" .'插件参数（parameters）：'."\n" ."\n" .'- JsonKeyValueExtractor'."\n" .'- MultiValueSpliter'."\n" .'- KeyValueExtractor'."\n" .'- StringCatenateExtractor'."\n" .'- HTMLTagRemover', 'type' => 'object', ], 'keyField' => [ 'description' => '主键', 'type' => 'string', 'example' => 'id', ], 'schemaName' => [ 'description' => '宽表名称', 'type' => 'string', 'example' => 'name', ], 'parameters' => [ 'description' => '数据源信息', 'type' => 'object', ], ], ], ], 'summaries' => [ 'description' => '搜索结果摘要配置', 'type' => 'array', 'items' => [ 'description' => '搜索结果摘要配置', 'type' => 'object', 'properties' => [ 'name' => [ 'description' => '分组名', 'type' => 'string', 'example' => 'fefault', ], 'meta' => [ 'description' => '摘要配置', 'type' => 'array', 'items' => [ 'description' => '摘要配置', 'type' => 'object', 'properties' => [ 'field' => [ 'description' => '字段', 'type' => 'string', 'example' => 'field1', ], 'len' => [ 'description' => '片段长度，取值区间：[1-300]', 'type' => 'integer', 'format' => 'int32', 'example' => '50', ], 'element' => [ 'description' => '飘红标签', 'type' => 'string', 'example' => 'em', ], 'ellipsis' => [ 'description' => '片段链接符', 'type' => 'string', 'example' => '...', ], 'snippet' => [ 'description' => '片段数量，取值区间：[1-5]', 'type' => 'string', 'example' => '5', ], ], ], ], ], ], ], 'queryProcessors' => [ 'description' => '查询意图理解配置', 'type' => 'array', 'items' => [ 'description' => '查询意图理解配置', 'type' => 'object', 'properties' => [ 'name' => [ 'description' => '规则名称', 'type' => 'string', 'example' => 'test', ], 'domain' => [ 'description' => '行业类型'."\n" ."\n" .'- GENERAL 通用'."\n" .'- ECOMMERCE 电商'."\n" .'- IT_CONTENT IT内容', 'type' => 'string', 'example' => 'GENERAL', ], 'category' => [ 'description' => '行业垂类', 'type' => 'string', 'example' => '""', ], 'processors' => [ 'description' => '包含功能', 'type' => 'array', 'items' => [ 'description' => '包含功能', 'type' => 'object', ], ], 'indexes' => [ 'description' => '应用索引', 'type' => 'array', 'items' => [ 'description' => '应用索引', 'type' => 'string', 'example' => 'default', ], ], 'active' => [ 'description' => '是否默认规则', 'type' => 'boolean', 'example' => 'False', ], ], ], ], 'cluster' => [ 'description' => '能力开放配置', 'type' => 'object', 'properties' => [ 'maxTimeoutMS' => [ 'description' => '集群的超时时间，单位是ms', 'type' => 'integer', 'format' => 'int32', 'example' => '750', ], 'maxQueryClauseLength' => [ 'description' => 'query字句最大长度', 'type' => 'integer', 'format' => 'int32', 'example' => '1024', ], ], ], 'interpretations' => [ 'description' => 'LLM字段模型', 'type' => 'object', ], 'prompts' => [ 'description' => 'prompt配置', 'type' => 'array', 'items' => [ 'description' => 'prompt配置', 'type' => 'object', ], ], ], 'example' => '{}', ], ], ], ], ], '5XX' => [ 'schema' => [ 'type' => 'object', 'properties' => [ 'code' => [ 'type' => 'string', ], 'message' => [ 'type' => 'string', ], 'requestId' => [ 'type' => 'string', ], 'httpCode' => [ 'type' => 'integer', 'format' => 'int32', ], ], ], ], ], 'responseDemo' => '[{"type":"json","example":"{\\n \\"requestId\\": \\"77CAA411-0010-4DB9-82E2-1C384E590AFF\\",\\n \\"result\\": [\\n {\\n \\"id\\": \\"100302881\\",\\n \\"isCurrent\\": true,\\n \\"clusterName\\": \\"vpc_sh_domain_1\\",\\n \\"autoSwitch\\": true,\\n \\"type\\": \\"enhanced\\",\\n \\"description\\": \\"\\\\\\"\\\\\\"\\",\\n \\"status\\": \\"normal\\",\\n \\"schema\\": {\\n \\"tables\\": {\\n \\"test\\": \\"test\\",\\n \\"test2\\": 1\\n },\\n \\"indexes\\": {\\n \\"filterFields\\": [\\n \\"id\\"\\n ],\\n \\"searchFields\\": {\\n \\"test\\": \\"test\\",\\n \\"test2\\": 1\\n }\\n },\\n \\"routeField\\": \\"field1\\",\\n \\"routeFieldValues\\": [\\n \\"routeFieldValues\\"\\n ],\\n \\"secondRouteField\\": \\"field2\\\\n\\",\\n \\"ttlField\\": {\\n \\"name\\": \\"text1\\\\n\\",\\n \\"ttl\\": 1000\\n },\\n \\"indexSortConfig\\": [\\n {\\n \\"field\\": \\"field1\\",\\n \\"direction\\": \\"DESC\\"\\n }\\n ],\\n \\"name\\": \\"test\\"\\n },\\n \\"progressPercent\\": 100,\\n \\"fetchFields\\": [\\n \\"{}\\"\\n ],\\n \\"quota\\": {\\n \\"spec\\": \\"opensearch.share.common\\",\\n \\"qps\\": 5,\\n \\"docSize\\": 1,\\n \\"computeResource\\": 20\\n },\\n \\"domain\\": {\\n \\"category\\": \\"-\\",\\n \\"name\\": \\"test\\",\\n \\"functions\\": {\\n \\"service\\": [\\n \\"-\\"\\n ],\\n \\"qp\\": [\\n \\"spellcheck\\"\\n ],\\n \\"algo\\": [\\n \\"pop\\"\\n ]\\n }\\n },\\n \\"schemas\\": [\\n {\\n \\"tables\\": {\\n \\"test\\": \\"test\\",\\n \\"test2\\": 1\\n },\\n \\"indexes\\": {\\n \\"filterFields\\": [\\n \\"field1\\"\\n ],\\n \\"searchFields\\": {\\n \\"test\\": \\"test\\",\\n \\"test2\\": 1\\n }\\n },\\n \\"routeField\\": \\"field1\\\\n\\",\\n \\"routeFieldValues\\": [\\n \\"routeFieldValues\\"\\n ],\\n \\"secondRouteField\\": \\"field2\\",\\n \\"ttlField\\": {\\n \\"name\\": \\"fIeld1\\",\\n \\"ttl\\": 1000\\n },\\n \\"indexSortConfig\\": [\\n {\\n \\"field\\": \\"fIeld1\\",\\n \\"direction\\": \\"DESC\\"\\n }\\n ],\\n \\"name\\": \\"main\\"\\n }\\n ],\\n \\"firstRanks\\": [\\n {\\n \\"type\\": \\"STRING\\",\\n \\"name\\": \\"test\\",\\n \\"description\\": \\"描述\\",\\n \\"active\\": true,\\n \\"meta\\": \\"String :\\\\\\"random()*100+now()\\\\\\"；\\\\nArray: [\\\\n {\\\\n \\\\\\"attribute\\\\\\": \\\\\\"static_bm25()\\\\\\",\\\\n \\\\\\"arg\\\\\\": \\\\\\"\\\\\\",\\\\n \\\\\\"weight\\\\\\": 10\\\\n }\\\\n ]\\"\\n }\\n ],\\n \\"secondRanks\\": [\\n {\\n \\"meta\\": \\"\\\\\\"cate_id > 0 and cate_id < 1000\\\\\\"\\\\n\\",\\n \\"name\\": \\"default\\\\n\\",\\n \\"description\\": \\"描述\\",\\n \\"active\\": true\\n }\\n ],\\n \\"dataSources\\": [\\n {\\n \\"tableName\\": \\"main\\",\\n \\"type\\": \\"rds\\",\\n \\"fields\\": [\\n {\\n \\"test\\": \\"test\\",\\n \\"test2\\": 1\\n }\\n ],\\n \\"plugins\\": {\\n \\"test\\": \\"test\\",\\n \\"test2\\": 1\\n },\\n \\"keyField\\": \\"id\\",\\n \\"schemaName\\": \\"name\\",\\n \\"parameters\\": {\\n \\"test\\": \\"test\\",\\n \\"test2\\": 1\\n }\\n }\\n ],\\n \\"summaries\\": [\\n {\\n \\"name\\": \\"fefault\\",\\n \\"meta\\": [\\n {\\n \\"field\\": \\"field1\\",\\n \\"len\\": 50,\\n \\"element\\": \\"em\\",\\n \\"ellipsis\\": \\"...\\",\\n \\"snippet\\": \\"5\\"\\n }\\n ]\\n }\\n ],\\n \\"queryProcessors\\": [\\n {\\n \\"name\\": \\"test\\",\\n \\"domain\\": \\"GENERAL\\",\\n \\"category\\": \\"\\\\\\"\\\\\\"\\",\\n \\"processors\\": [\\n {\\n \\"test\\": \\"test\\",\\n \\"test2\\": 1\\n }\\n ],\\n \\"indexes\\": [\\n \\"default\\"\\n ],\\n \\"active\\": true\\n }\\n ],\\n \\"cluster\\": {\\n \\"maxTimeoutMS\\": 750,\\n \\"maxQueryClauseLength\\": 1024\\n },\\n \\"interpretations\\": {\\n \\"test\\": \\"test\\",\\n \\"test2\\": 1\\n },\\n \\"prompts\\": [\\n {\\n \\"test\\": \\"test\\",\\n \\"test2\\": 1\\n }\\n ]\\n }\\n ]\\n}","errorExample":""},{"type":"xml","example":"71AB199D-8F00-5E69-BDC6-2829553D9BBC\\n\\n 123123321\\n \\n \\n 1650264344\\n 1650264631\\n standard\\n ok\\n 100\\n \\n 1\\n 1\\n 0\\n opensearch.share.common\\n 0\\n 0\\n 0\\n \\n \\n \\n \\n test\\n true\\n \\n \\n description\\n false\\n LITERAL\\n \\n \\n id\\n true\\n INT\\n \\n \\n \\n \\n \\n \\n \\n description\\n \\n \\n id\\n \\n \\n id\\n description\\n \\n \\n id\\n description\\n \\n default\\n sys default\\n true\\n 1650264343\\n 1650264343\\n STRUCT\\n \\n static_bm25()\\n \\n 1\\n \\n \\n \\n default\\n sys default\\n true\\n 1650264343\\n 1650264343\\n \\n true\\n \\n 1645520103\\n false\\n\\n\\n 121305419\\n \\n \\n 1645519817\\n 1645520103\\n standard\\n ok\\n 100\\n \\n 1\\n 1\\n 0\\n opensearch.share.common\\n 0\\n 0\\n 0\\n \\n \\n \\n \\n test\\n true\\n \\n \\n description\\n false\\n LITERAL\\n \\n \\n id\\n true\\n INT\\n \\n \\n \\n \\n \\n \\n \\n description\\n \\n \\n id\\n \\n \\n id\\n description\\n \\n \\n id\\n description\\n \\n default\\n sys default\\n true\\n 1645519817\\n 1645519817\\n STRUCT\\n \\n static_bm25()\\n \\n 1\\n \\n \\n \\n default\\n sys default\\n true\\n 1645519817\\n 1645519817\\n \\n true\\n \\n 1645520103\\n true\\n","errorExample":""}]', 'title' => '获取一个应用的版本列表', 'description' => '- 若已存在同名标准版应用，则创建新版本；'."\n" .'- 在新建版本情况下，autoSwitch 和 realtimeShared 也是必填的；'."\n" .'- 在新建版本情况下，quota 是自动从上一个版本继承的；'."\n" .'- 在新建版本情况下，修改 quota 是无效的。', 'requestParamsDescription' => ' ', 'responseParamsDescription' => ' ', 'extraInfo' => ' ', ], 'DescribeApp' => [ 'summary' => '查看一个 OpenSearch 应用版本详情。', 'path' => '/v4/openapi/app-groups/{appGroupIdentity}/apps/{appId}', 'methods' => [ 'get', ], 'schemes' => [ 'http', 'https', ], 'security' => [ [ 'AK' => [], ], ], 'operationType' => 'read', 'deprecated' => false, 'systemTags' => [ 'operationType' => 'get', 'riskType' => 'none', 'chargeType' => 'free', 'abilityTreeCode' => '55168', 'abilityTreeNodes' => [ 'FEATUREopensearchGVH0IN', 'FEATUREopensearch447AAX', 'FEATUREopensearch5OZOSP', ], ], 'parameters' => [ [ 'name' => 'appGroupIdentity', 'in' => 'path', 'schema' => [ 'description' => '应用名称', 'type' => 'string', 'required' => true, 'docRequired' => true, 'example' => 'my_app_group_name', ], ], [ 'name' => 'appId', 'in' => 'path', 'schema' => [ 'description' => '版本ID', 'type' => 'integer', 'format' => 'int32', 'required' => true, 'docRequired' => true, 'example' => '110116134', ], ], ], 'responses' => [ 200 => [ 'schema' => [ 'description' => '响应体', 'type' => 'object', 'properties' => [ 'requestId' => [ 'description' => '请求ID', 'type' => 'string', 'example' => '33477D76-C380-1D84-A4AD-043F52876CB1', ], 'result' => [ 'description' => '版本信息', 'type' => 'object', 'properties' => [ 'id' => [ 'description' => '版本ID', 'type' => 'string', 'example' => '100303063', ], 'isCurrent' => [ 'description' => '是否是在线版本。', 'type' => 'boolean', 'example' => 'True', ], 'clusterName' => [ 'description' => '集群名称', 'type' => 'string', 'example' => '-', ], 'autoSwitch' => [ 'description' => '是否自动切换', 'type' => 'boolean', 'example' => 'true', ], 'type' => [ 'description' => '版本类型'."\n" .'- standard 标准版'."\n" .'- advance 老高级版（新应用不支持此类型）'."\n" .'- enhanced 新高级版', 'type' => 'string', 'example' => 'enhanced', ], 'description' => [ 'description' => '版本描述', 'type' => 'string', 'example' => '-', ], 'status' => [ 'description' => '版本状态'."\n" .'- ok 正常'."\n" .'- stopped 暂停'."\n" .'- frozen 已冻结'."\n" .'- initializing 版本初始化中'."\n" .'- unavailable 版本已失效'."\n" .'- data_waiting 等待数据初始化'."\n" .'- data_preparing 数据初始化中', 'type' => 'string', 'example' => 'ok', ], 'schema' => [ 'description' => '应用结构', 'type' => 'object', 'properties' => [ 'tables' => [ 'description' => '表结构。', 'type' => 'object', 'example' => '{'."\n" .' "primaryTable": true,'."\n" .' "name": "main",'."\n" .' "fields": {'."\n" .' "id": {'."\n" .' "name": "id",'."\n" .' "type": "LITERAL",'."\n" .' "primaryKey": true'."\n" .' },'."\n" .' "title": {'."\n" .' "name": "title",'."\n" .' "type": "TEXT",'."\n" .' "primaryKey": false'."\n" .' },'."\n" .' "buy": {'."\n" .' "name": "buy",'."\n" .' "type": "INT",'."\n" .' "primaryKey": false'."\n" .' },'."\n" .' "cate_id": {'."\n" .' "name": "cate_id",'."\n" .' "type": "INT",'."\n" .' "primaryKey": false'."\n" .' },'."\n" .' "cate_name": {'."\n" .' "name": "cate_name",'."\n" .' "type": "LITERAL",'."\n" .' "primaryKey": false'."\n" .' }'."\n" .' }'."\n" .'}', ], 'indexes' => [ 'description' => '索引结构', 'type' => 'object', 'properties' => [ 'filterFields' => [ 'description' => '属性字段集合', 'type' => 'array', 'items' => [ 'description' => '属性字段', 'type' => 'string', 'example' => 'id', ], ], 'searchFields' => [ 'description' => '索引字段', 'type' => 'object', 'example' => '{'."\n" .' "fields": ["title"],'."\n" .' "analyzer": "chn_standard"'."\n" .'}', ], ], ], 'routeField' => [ 'description' => '一级分列字段名称', 'type' => 'string', 'example' => 'field1', ], 'routeFieldValues' => [ 'description' => '一级分列字段热点值', 'type' => 'array', 'items' => [ 'description' => '一级分列字段热点值', 'type' => 'string', 'example' => 'routeFieldValues', ], ], 'secondRouteField' => [ 'description' => '二级分列字段名称（当且仅当配置有routeFieldValues时生效，默认使用宽表主键）', 'type' => 'string', 'example' => 'field2'."\n", ], 'ttlField' => [ 'description' => '文档清理配置', 'type' => 'object', 'properties' => [ 'name' => [ 'description' => '文档清理字段', 'type' => 'string', 'example' => 'text1'."\n", ], 'ttl' => [ 'description' => '存活时间（毫秒）', 'type' => 'integer', 'format' => 'int64', 'example' => '1000', ], ], ], 'indexSortConfig' => [ 'description' => '倒排索引配置', 'type' => 'array', 'items' => [ 'description' => '倒排索引配置', 'type' => 'object', 'properties' => [ 'field' => [ 'description' => '排序字段', 'type' => 'string', 'example' => 'field1', ], 'direction' => [ 'description' => '排序方式'."\n" ."\n" .'- ASC'."\n" .'- DESC', 'type' => 'string', 'example' => 'DESC', ], ], ], ], 'name' => [ 'description' => '宽表表名', 'type' => 'string', 'example' => 'test', ], ], 'example' => '{}', ], 'progressPercent' => [ 'description' => '数据导入进度百分比（如83代表83%）', 'type' => 'integer', 'format' => 'int32', 'example' => '100', ], 'fetchFields' => [ 'description' => '默认展示字段', 'type' => 'array', 'items' => [ 'description' => '默认展示字段', 'type' => 'string', 'example' => '{}', ], 'example' => '[]', ], 'quota' => [ 'description' => '配额信息', 'type' => 'object', 'properties' => [ 'spec' => [ 'description' => '规格'."\n" .'- opensearch.share.junior 入门型'."\n" .'- opensearch.share.common 共享通用型'."\n" .'- opensearch.share.compute 共享计算型'."\n" .'- opensearch.share.storage 共享存储型'."\n" .'- opensearch.private.common 独享通用型'."\n" .'- opensearch.private.compute 独享计算型'."\n" .'- opensearch.private.storage 独享存储型', 'type' => 'string', 'example' => 'opensearch.share.common', ], 'qps' => [ 'description' => '搜索请求（单位：次/秒）（老计费模型使用）', 'type' => 'integer', 'format' => 'int32', 'example' => '5', ], 'docSize' => [ 'description' => '存储容量（单位：GB）', 'type' => 'integer', 'format' => 'int32', 'example' => '1', ], 'computeResource' => [ 'description' => '计算资源（单位：LCU）', 'type' => 'integer', 'format' => 'int32', 'example' => '20', ], ], 'example' => '{}', ], 'domain' => [ 'description' => '行业类型'."\n" .'- GENERAL 通用'."\n" .'- ECOMMERCE 电商'."\n" .'- IT_CONTENT IT内容', 'type' => 'object', 'properties' => [ 'category' => [ 'description' => '类型-standard标准版-advance老高级版（新应用不支持此类型）-enhanced新高级版', 'type' => 'string', 'example' => '-', ], 'name' => [ 'description' => '英文名称', 'type' => 'string', 'example' => 'test', ], 'functions' => [ 'description' => '搜索结果', 'type' => 'object', 'properties' => [ 'service' => [ 'description' => '各个功能说明', 'type' => 'array', 'items' => [ 'description' => '功能1', 'type' => 'string', 'example' => '-', ], 'example' => '[]', ], 'qp' => [ 'description' => '布局信息', 'type' => 'array', 'items' => [ 'description' => '信息1', 'type' => 'string', 'example' => '-', ], 'example' => '[]', ], 'algo' => [ 'description' => '算法结构', 'type' => 'array', 'items' => [ 'description' => '结构1', 'type' => 'string', 'example' => '-', ], 'example' => '[]', ], ], 'example' => '{}', ], ], 'example' => 'GENERAL', ], 'schemas' => [ 'description' => '多表应用结构', 'type' => 'array', 'items' => [ 'description' => '单表应用结构', 'type' => 'object', 'properties' => [ 'tables' => [ 'description' => '表结构', 'type' => 'object', 'example' => '{'."\n" .' "primaryTable": true,'."\n" .' "name": "main",'."\n" .' "fields": {'."\n" .' "id": {'."\n" .' "name": "id",'."\n" .' "type": "LITERAL",'."\n" .' "primaryKey": true'."\n" .' },'."\n" .' "title": {'."\n" .' "name": "title",'."\n" .' "type": "TEXT",'."\n" .' "primaryKey": false'."\n" .' },'."\n" .' "buy": {'."\n" .' "name": "buy",'."\n" .' "type": "INT",'."\n" .' "primaryKey": false'."\n" .' },'."\n" .' "cate_id": {'."\n" .' "name": "cate_id",'."\n" .' "type": "INT",'."\n" .' "primaryKey": false'."\n" .' },'."\n" .' "cate_name": {'."\n" .' "name": "cate_name",'."\n" .' "type": "LITERAL",'."\n" .' "primaryKey": false'."\n" .' }'."\n" .' }'."\n" .'}', ], 'indexes' => [ 'description' => '索引结构', 'type' => 'object', 'properties' => [ 'filterFields' => [ 'description' => '属性字段集合', 'type' => 'array', 'items' => [ 'description' => '属性字段', 'type' => 'string', 'example' => 'field1', ], ], 'searchFields' => [ 'description' => '索引字段', 'type' => 'object', 'example' => '{'."\n" .' "fields": ["title"],'."\n" .' "analyzer": "chn_standard"'."\n" .'}'."\n", ], ], ], 'routeField' => [ 'description' => '一级分列字段名称', 'type' => 'string', 'example' => 'field1'."\n", ], 'routeFieldValues' => [ 'description' => '一级分列字段热点值', 'type' => 'array', 'items' => [ 'description' => '一级分列字段热点值', 'type' => 'string', 'example' => 'routeFieldValues', ], ], 'secondRouteField' => [ 'description' => '二级分列字段名称（当且仅当配置有routeFieldValues时生效，默认使用宽表主键）', 'type' => 'string', 'example' => 'field2', ], 'ttlField' => [ 'description' => '文档清理配置', 'type' => 'object', 'properties' => [ 'name' => [ 'description' => '文档时间字段', 'type' => 'string', 'example' => 'fIeld1', ], 'ttl' => [ 'description' => '存活时间（毫秒）', 'type' => 'integer', 'format' => 'int64', 'example' => '1000', ], ], ], 'indexSortConfig' => [ 'description' => '倒排索引配置', 'type' => 'array', 'items' => [ 'description' => '倒排索引配置', 'type' => 'object', 'properties' => [ 'field' => [ 'description' => '排序字段', 'type' => 'string', 'example' => 'fIeld1', ], 'direction' => [ 'description' => '排序方式'."\n" ."\n" .'- ASC'."\n" .'- DESC', 'type' => 'string', 'example' => 'DESC', ], ], ], ], 'name' => [ 'description' => '宽表表名', 'type' => 'string', 'example' => 'main', ], ], ], ], 'firstRanks' => [ 'description' => '粗排配置', 'type' => 'array', 'items' => [ 'description' => '粗排配置', 'type' => 'object', 'properties' => [ 'type' => [ 'description' => '表达式类型'."\n" ."\n" .'STRUCT 结构化，'."\n" .'默认值- STRING 自定义公式', 'type' => 'string', 'example' => 'STRING', ], 'name' => [ 'description' => '粗排名称', 'type' => 'string', 'example' => 'test', ], 'description' => [ 'description' => '描述', 'type' => 'string', 'example' => '描述', ], 'active' => [ 'description' => '是否是默认表达式', 'type' => 'boolean', 'example' => 'False', ], 'meta' => [ 'description' => '表达式信息（Array 或 String）', 'type' => 'any', 'example' => 'String :"random()*100+now()"；'."\n" .'Array: ['."\n" .' {'."\n" .' "attribute": "static_bm25()",'."\n" .' "arg": "",'."\n" .' "weight": 10'."\n" .' }'."\n" .' ]', ], ], ], ], 'secondRanks' => [ 'description' => '精排配置', 'type' => 'array', 'items' => [ 'description' => '精排配置', 'type' => 'object', 'properties' => [ 'meta' => [ 'description' => '精排表达式（可以编写包含字段、算分特征和数学函数的表达式，实现复杂的排序逻辑）', 'type' => 'any', 'example' => '"cate_id > 0 and cate_id < 1000"'."\n", ], 'name' => [ 'description' => '精排名称', 'type' => 'string', 'example' => 'default'."\n", ], 'description' => [ 'description' => '描述', 'type' => 'string', 'example' => '描述', ], 'active' => [ 'description' => '是否是默认表达式', 'type' => 'boolean', 'example' => 'False', ], ], ], ], 'dataSources' => [ 'description' => '数据源配置', 'type' => 'array', 'items' => [ 'description' => '数据源配置', 'type' => 'object', 'properties' => [ 'tableName' => [ 'description' => '应用表名', 'type' => 'string', 'example' => 'main', ], 'type' => [ 'description' => '数据源类型'."\n" ."\n" .'- rds'."\n" .'- odps'."\n" .'- opensearch'."\n" .'- polardb', 'type' => 'string', 'example' => 'rds', ], 'fields' => [ 'description' => '表字段映射信息', 'type' => 'array', 'items' => [ 'description' => '表字段映射信息', 'type' => 'object', 'example' => '{'."\n" .' "id": "id"'."\n" .' }'."\n", ], ], 'plugins' => [ 'description' => '字段数据处理插件'."\n" ."\n" .'插件名称（name）'."\n" ."\n" .'- JsonKeyValueExtractor'."\n" .'- MultiValueSpliter'."\n" .'- KeyValueExtractor'."\n" .'- StringCatenateExtractor'."\n" .'- HTMLTagRemover'."\n" ."\n" .'插件参数（parameters）：'."\n" ."\n" .'- JsonKeyValueExtractor'."\n" .'- MultiValueSpliter'."\n" .'- KeyValueExtractor'."\n" .'- StringCatenateExtractor'."\n" .'- HTMLTagRemover', 'type' => 'object', 'example' => '{'."\n" .' "name": "JsonKeyValueExtractor",'."\n" .' "parameters": {'."\n" .' "key": "my_field"'."\n" .'}'."\n" .'}', ], 'keyField' => [ 'description' => '主键', 'type' => 'string', 'example' => 'id', ], 'schemaName' => [ 'description' => '宽表名称', 'type' => 'string', 'example' => 'name', ], 'parameters' => [ 'description' => '数据源信息', 'type' => 'object', 'example' => '{'."\n" .' "instanceId": "rds-instance-id",'."\n" .' "dbName": "my_db",'."\n" .' "dbTableName": "my_table",'."\n" .' "dbUser": "my",'."\n" .' "dbPassword": "my_passwd",'."\n" .' "filter":"",'."\n" .' "autoSync": true'."\n" .'}'."\n", ], ], ], ], 'summaries' => [ 'description' => '搜索结果摘要配置', 'type' => 'array', 'items' => [ 'description' => '搜索结果摘要配置', 'type' => 'object', 'properties' => [ 'name' => [ 'description' => '分组名', 'type' => 'string', 'example' => 'default', ], 'meta' => [ 'description' => '摘要配置', 'type' => 'array', 'items' => [ 'description' => '摘要配置', 'type' => 'object', 'properties' => [ 'field' => [ 'description' => '字段', 'type' => 'string', 'example' => 'field1', ], 'len' => [ 'description' => '片段长度，取值区间：[1-300]', 'type' => 'integer', 'format' => 'int32', 'example' => '50', ], 'element' => [ 'description' => '飘红标签', 'type' => 'string', 'example' => 'em', ], 'ellipsis' => [ 'description' => '片段链接符', 'type' => 'string', 'example' => '...', ], 'snippet' => [ 'description' => '片段数量，取值区间：[1-5]', 'type' => 'string', 'example' => '5', ], ], ], ], ], ], ], 'queryProcessors' => [ 'description' => '查询意图理解配置', 'type' => 'array', 'items' => [ 'description' => '查询意图理解配置', 'type' => 'object', 'properties' => [ 'name' => [ 'description' => '规则名称', 'type' => 'string', 'example' => 'test', ], 'domain' => [ 'description' => '行业类型'."\n" ."\n" .'- GENERAL 通用'."\n" .'- ECOMMERCE 电商'."\n" .'- IT_CONTENT IT内容', 'type' => 'string', 'example' => 'GENERAL', ], 'category' => [ 'description' => '行业垂类', 'type' => 'string', 'example' => '""', ], 'processors' => [ 'description' => '包含功能', 'type' => 'array', 'items' => [ 'description' => '包含功能', 'type' => 'object', 'example' => '{'."\n" .'"name": "stop_word", "useSystemDictionary": true,'."\n" .'"interventionDictionary": "my_dict",'."\n" .' "ignoreSpace": true'."\n" .'}', ], ], 'indexes' => [ 'description' => '应用的索引范围', 'type' => 'array', 'items' => [ 'description' => '应用索引', 'type' => 'string', 'example' => 'default', ], ], 'active' => [ 'description' => '是否默认规则', 'type' => 'boolean', 'example' => 'False', ], ], ], ], 'cluster' => [ 'description' => '能力开放配置', 'type' => 'object', 'properties' => [ 'maxTimeoutMS' => [ 'description' => '集群的超时时间，单位是ms', 'type' => 'integer', 'format' => 'int32', 'example' => '750', ], 'maxQueryClauseLength' => [ 'description' => 'query字句最大长度', 'type' => 'integer', 'format' => 'int32', 'example' => '1024', ], ], ], 'interpretations' => [ 'description' => 'LLM字段模型', 'type' => 'object', 'example' => '['."\n" .' {'."\n" .' "table": "table1",'."\n" .' "fields": ['."\n" .' {'."\n" .' "name": "field1",'."\n" .' "interpretation": "标题"'."\n" .' },'."\n" .' {'."\n" .' "name": "field2",'."\n" .' "interpretation": "编号"'."\n" .' }'."\n" .' ]'."\n" .' }'."\n" .']', ], 'prompts' => [ 'description' => 'LLM prompt配置', 'type' => 'array', 'items' => [ 'description' => 'prompt配置', 'type' => 'object', 'example' => '{'."\n" .' "parameters" : ['."\n" .' {'."\n" .' "name" : "docs",'."\n" .' "value" : "doc内容的拼接方式，比如现在的 qwen的 \'
\\n${doc}\\n
\\n"'."\n" .' }'."\n" .' ],'."\n" .' "messages":['."\n" .' {'."\n" .' "role" : "role_name，这里是否需要限定只能是 system, user, assistant，还是可以让用户随意填写",'."\n" .' "content" : "用户设置的prompt内容，里面可以使用 ${parameter_key} 来表示期望动态替换的内容，具体替换规则参考下面说明"'."\n" .' }'."\n" .' ]'."\n" .' }', ], ], ], 'example' => '{}', ], ], 'example' => '{}', ], ], '5XX' => [ 'schema' => [ 'type' => 'object', 'properties' => [ 'code' => [ 'type' => 'string', ], 'message' => [ 'type' => 'string', ], 'requestId' => [ 'type' => 'string', ], 'httpCode' => [ 'type' => 'integer', 'format' => 'int32', ], ], ], ], ], 'responseDemo' => '[{"type":"json","example":"{\\n \\"requestId\\": \\"33477D76-C380-1D84-A4AD-043F52876CB1\\",\\n \\"result\\": {\\n \\"id\\": \\"100303063\\",\\n \\"isCurrent\\": true,\\n \\"clusterName\\": \\"-\\",\\n \\"autoSwitch\\": true,\\n \\"type\\": \\"enhanced\\",\\n \\"description\\": \\"-\\",\\n \\"status\\": \\"ok\\",\\n \\"schema\\": {\\n \\"tables\\": {\\n \\"primaryTable\\": true,\\n \\"name\\": \\"main\\",\\n \\"fields\\": {\\n \\"id\\": {\\n \\"name\\": \\"id\\",\\n \\"type\\": \\"LITERAL\\",\\n \\"primaryKey\\": true\\n },\\n \\"title\\": {\\n \\"name\\": \\"title\\",\\n \\"type\\": \\"TEXT\\",\\n \\"primaryKey\\": false\\n },\\n \\"buy\\": {\\n \\"name\\": \\"buy\\",\\n \\"type\\": \\"INT\\",\\n \\"primaryKey\\": false\\n },\\n \\"cate_id\\": {\\n \\"name\\": \\"cate_id\\",\\n \\"type\\": \\"INT\\",\\n \\"primaryKey\\": false\\n },\\n \\"cate_name\\": {\\n \\"name\\": \\"cate_name\\",\\n \\"type\\": \\"LITERAL\\",\\n \\"primaryKey\\": false\\n }\\n }\\n },\\n \\"indexes\\": {\\n \\"filterFields\\": [\\n \\"id\\"\\n ],\\n \\"searchFields\\": {\\n \\"fields\\": [\\n \\"title\\"\\n ],\\n \\"analyzer\\": \\"chn_standard\\"\\n }\\n },\\n \\"routeField\\": \\"field1\\",\\n \\"routeFieldValues\\": [\\n \\"routeFieldValues\\"\\n ],\\n \\"secondRouteField\\": \\"field2\\\\n\\",\\n \\"ttlField\\": {\\n \\"name\\": \\"text1\\\\n\\",\\n \\"ttl\\": 1000\\n },\\n \\"indexSortConfig\\": [\\n {\\n \\"field\\": \\"field1\\",\\n \\"direction\\": \\"DESC\\"\\n }\\n ],\\n \\"name\\": \\"test\\"\\n },\\n \\"progressPercent\\": 100,\\n \\"fetchFields\\": [\\n \\"{}\\"\\n ],\\n \\"quota\\": {\\n \\"spec\\": \\"opensearch.share.common\\",\\n \\"qps\\": 5,\\n \\"docSize\\": 1,\\n \\"computeResource\\": 20\\n },\\n \\"domain\\": {\\n \\"category\\": \\"-\\",\\n \\"name\\": \\"test\\",\\n \\"functions\\": {\\n \\"service\\": [\\n \\"-\\"\\n ],\\n \\"qp\\": [\\n \\"-\\"\\n ],\\n \\"algo\\": [\\n \\"-\\"\\n ]\\n }\\n },\\n \\"schemas\\": [\\n {\\n \\"tables\\": {\\n \\"primaryTable\\": true,\\n \\"name\\": \\"main\\",\\n \\"fields\\": {\\n \\"id\\": {\\n \\"name\\": \\"id\\",\\n \\"type\\": \\"LITERAL\\",\\n \\"primaryKey\\": true\\n },\\n \\"title\\": {\\n \\"name\\": \\"title\\",\\n \\"type\\": \\"TEXT\\",\\n \\"primaryKey\\": false\\n },\\n \\"buy\\": {\\n \\"name\\": \\"buy\\",\\n \\"type\\": \\"INT\\",\\n \\"primaryKey\\": false\\n },\\n \\"cate_id\\": {\\n \\"name\\": \\"cate_id\\",\\n \\"type\\": \\"INT\\",\\n \\"primaryKey\\": false\\n },\\n \\"cate_name\\": {\\n \\"name\\": \\"cate_name\\",\\n \\"type\\": \\"LITERAL\\",\\n \\"primaryKey\\": false\\n }\\n }\\n },\\n \\"indexes\\": {\\n \\"filterFields\\": [\\n \\"field1\\"\\n ],\\n \\"searchFields\\": {\\n \\"fields\\": [\\n \\"title\\"\\n ],\\n \\"analyzer\\": \\"chn_standard\\"\\n }\\n },\\n \\"routeField\\": \\"field1\\\\n\\",\\n \\"routeFieldValues\\": [\\n \\"routeFieldValues\\"\\n ],\\n \\"secondRouteField\\": \\"field2\\",\\n \\"ttlField\\": {\\n \\"name\\": \\"fIeld1\\",\\n \\"ttl\\": 1000\\n },\\n \\"indexSortConfig\\": [\\n {\\n \\"field\\": \\"fIeld1\\",\\n \\"direction\\": \\"DESC\\"\\n }\\n ],\\n \\"name\\": \\"main\\"\\n }\\n ],\\n \\"firstRanks\\": [\\n {\\n \\"type\\": \\"STRING\\",\\n \\"name\\": \\"test\\",\\n \\"description\\": \\"描述\\",\\n \\"active\\": true,\\n \\"meta\\": \\"String :\\\\\\"random()*100+now()\\\\\\"；\\\\nArray: [\\\\n {\\\\n \\\\\\"attribute\\\\\\": \\\\\\"static_bm25()\\\\\\",\\\\n \\\\\\"arg\\\\\\": \\\\\\"\\\\\\",\\\\n \\\\\\"weight\\\\\\": 10\\\\n }\\\\n ]\\"\\n }\\n ],\\n \\"secondRanks\\": [\\n {\\n \\"meta\\": \\"\\\\\\"cate_id > 0 and cate_id < 1000\\\\\\"\\\\n\\",\\n \\"name\\": \\"default\\\\n\\",\\n \\"description\\": \\"描述\\",\\n \\"active\\": true\\n }\\n ],\\n \\"dataSources\\": [\\n {\\n \\"tableName\\": \\"main\\",\\n \\"type\\": \\"rds\\",\\n \\"fields\\": [\\n {\\n \\"id\\": \\"id\\"\\n }\\n ],\\n \\"plugins\\": {\\n \\"name\\": \\"JsonKeyValueExtractor\\",\\n \\"parameters\\": {\\n \\"key\\": \\"my_field\\"\\n }\\n },\\n \\"keyField\\": \\"id\\",\\n \\"schemaName\\": \\"name\\",\\n \\"parameters\\": {\\n \\"instanceId\\": \\"rds-instance-id\\",\\n \\"dbName\\": \\"my_db\\",\\n \\"dbTableName\\": \\"my_table\\",\\n \\"dbUser\\": \\"my\\",\\n \\"dbPassword\\": \\"my_passwd\\",\\n \\"filter\\": \\"\\",\\n \\"autoSync\\": true\\n }\\n }\\n ],\\n \\"summaries\\": [\\n {\\n \\"name\\": \\"default\\",\\n \\"meta\\": [\\n {\\n \\"field\\": \\"field1\\",\\n \\"len\\": 50,\\n \\"element\\": \\"em\\",\\n \\"ellipsis\\": \\"...\\",\\n \\"snippet\\": \\"5\\"\\n }\\n ]\\n }\\n ],\\n \\"queryProcessors\\": [\\n {\\n \\"name\\": \\"test\\",\\n \\"domain\\": \\"GENERAL\\",\\n \\"category\\": \\"\\\\\\"\\\\\\"\\",\\n \\"processors\\": [\\n {\\n \\"name\\": \\"stop_word\\",\\n \\"useSystemDictionary\\": true,\\n \\"interventionDictionary\\": \\"my_dict\\",\\n \\"ignoreSpace\\": true\\n }\\n ],\\n \\"indexes\\": [\\n \\"default\\"\\n ],\\n \\"active\\": true\\n }\\n ],\\n \\"cluster\\": {\\n \\"maxTimeoutMS\\": 750,\\n \\"maxQueryClauseLength\\": 1024\\n },\\n \\"interpretations\\": [\\n {\\n \\"table\\": \\"table1\\",\\n \\"fields\\": [\\n {\\n \\"name\\": \\"field1\\",\\n \\"interpretation\\": \\"标题\\"\\n },\\n {\\n \\"name\\": \\"field2\\",\\n \\"interpretation\\": \\"编号\\"\\n }\\n ]\\n }\\n ],\\n \\"prompts\\": [\\n {\\n \\"parameters\\": [\\n {\\n \\"name\\": \\"docs\\",\\n \\"value\\": \\"doc内容的拼接方式，比如现在的 qwen的 \'
\\\\n${doc}\\\\n
\\\\n\\"\\n }\\n ],\\n \\"messages\\": [\\n {\\n \\"role\\": \\"role_name，这里是否需要限定只能是 system, user, assistant，还是可以让用户随意填写\\",\\n \\"content\\": \\"用户设置的prompt内容，里面可以使用 ${parameter_key} 来表示期望动态替换的内容，具体替换规则参考下面说明\\"\\n }\\n ]\\n }\\n ]\\n }\\n}","errorExample":""},{"type":"xml","example":"33477D76-C380-1D84-A4AD-043F52876CB1\\n\\n 100303063\\n \\n ok\\n id\\n title\\n buy\\n cate_id\\n cate_name\\n enhanced\\n \\n \\n
\\n true\\n main\\n \\n \\n id\\n LITERAL\\n true\\n \\n \\n <name>title</name>\\n <type>TEXT</type>\\n <primaryKey>false</primaryKey>\\n \\n \\n buy\\n INT\\n false\\n \\n \\n cate_id\\n INT\\n false\\n \\n \\n cate_name\\n LITERAL\\n false\\n \\n \\n
\\n \\n \\n \\n \\n id\\n \\n \\n title\\n chn_standard\\n \\n \\n buy\\n \\n \\n id\\n buy\\n cate_id\\n cate_name\\n \\n \\n 0\\n \\n \\n default\\n \\n false\\n STRUCT\\n \\n static_bm25()\\n \\n 1\\n \\n 0\\n 0\\n \\n \\n 887857\\n first_rank_lsh_1\\n \\n true\\n STRUCT\\n \\n static_bm25()\\n \\n 10\\n \\n \\n exact_match_boost()\\n \\n 20\\n \\n \\n buy\\n \\n 30\\n \\n 1590977140\\n 1590977140\\n \\n \\n -1\\n default\\n \\n true\\n \\n 0\\n 0\\n \\n \\n default\\n \\n title\\n 50\\n em\\n ...\\n 1\\n \\n \\n 1590977140\\n \\n sum_lsh_test_1\\n true\\n default\\n \\n true\\n \\n stop_word\\n \\n \\n true\\n \\n spell_check\\n \\n \\n true\\n \\n term_weighting\\n \\n \\n true\\n \\n synonym\\n \\n GENERAL\\n 1590977142\\n 1590977142\\n \\n 100\\n","errorExample":""}]', 'title' => '查看一个应用版本详情', 'requestParamsDescription' => ' ', 'responseParamsDescription' => ' ', 'extraInfo' => ' ', ], 'DescribeAppStatistics' => [ 'summary' => '获取 OpenSearch 应用版本的统计结果。', 'path' => '/v4/openapi/app-groups/{appGroupIdentity}/apps/{appId}/statistics', 'methods' => [ 'get', ], 'schemes' => [ 'http', 'https', ], 'security' => [ [ 'AK' => [], ], ], 'operationType' => 'read', 'deprecated' => false, 'systemTags' => [ 'operationType' => 'get', 'riskType' => 'none', 'chargeType' => 'free', 'abilityTreeNodes' => [ 'FEATUREopensearch447AAX', 'FEATUREopensearchXLGC1X', ], ], 'parameters' => [ [ 'name' => 'appGroupIdentity', 'in' => 'path', 'schema' => [ 'description' => '应用名称', 'type' => 'string', 'required' => true, 'docRequired' => true, 'example' => 'my_app_group_name', ], ], [ 'name' => 'appId', 'in' => 'path', 'schema' => [ 'description' => '版本号', 'type' => 'string', 'required' => true, 'docRequired' => true, 'example' => '110157886', ], ], ], 'responses' => [ 200 => [ 'schema' => [ 'type' => 'object', 'properties' => [ 'result' => [ 'description' => '统计结果', 'type' => 'object', 'example' => '{}', ], 'requestId' => [ 'description' => '请求ID', 'type' => 'string', 'example' => '76FC45F1-4167-D3CD-6737-4F97BA503FA0', ], ], ], ], '5XX' => [ 'schema' => [ 'type' => 'object', 'properties' => [ 'code' => [ 'type' => 'string', ], 'message' => [ 'type' => 'string', ], 'requestId' => [ 'type' => 'string', ], 'httpCode' => [ 'type' => 'integer', 'format' => 'int32', ], ], ], ], ], 'responseDemo' => '[{"type":"json","example":"{\\n \\"result\\": {},\\n \\"requestId\\": \\"76FC45F1-4167-D3CD-6737-4F97BA503FA0\\"\\n}","errorExample":""},{"type":"xml","example":"76FC45F1-4167-D3CD-6737-4F97BA503FA0\\n\\n 5002\\n 168\\n 1582522280\\n \\n \\n 0.000002\\n 1\\n false\\n \\n
2222
\\n \\n \\n \\n 0\\n 0\\n false\\n \\n \\n 0\\n 20\\n false\\n 1.0306227624786388\\n \\n opensearch.share.common\\n \\n
168
\\n \\n main\\n \\n","errorExample":""}]', 'title' => '获取应用版本的统计结果', 'requestParamsDescription' => ' ', 'responseParamsDescription' => '**统计结果**'."\n" .'| 字段 | 类型 | 描述 |'."\n" .'| --- | --- | --- |'."\n" .'| result.pv | Integer | 请求量 |'."\n" .'| result.docCount | Integer | 文档大小（单位：个） |'."\n" .'| result.docLastUpdated | String | 文档最近更新时间戳 |'."\n" .'| result.quota | Object | 配额统计结果 |'."\n" .'| result.quota.instance | Object | 实例统计结果 |'."\n" .'| result.quota.instance.used | Float | 已使用容量（单位：LCU） |'."\n" .'| result.quota.instance.quota | Integer | 配额容量（单位：GB） |'."\n" .'| result.quota.instance.outOfLimit | Boolean | 是否超出配额 |'."\n" .'| result.quota.instance.tables | Object | 各数据表使用统计结果
键名为表名，值为使用容量 |'."\n" .'| result.quota.qps | Object | QPS统计结果 |'."\n" .'| result.quota.qps.used | Float | 已使用次数 |'."\n" .'| result.quota.qps.quota | Integer | 配额次数 |'."\n" .'| result.quota.qps.outOfLimit | Boolean | 是否超出配额 |'."\n" .'| result.quota.qps.tables | Array | -- |'."\n" .'| result.quota.computeResource | Object | 计算资源统计结果 |'."\n" .'| result.quota.computeResource.used | Float | 已使用计算资源（单位：LCU） |'."\n" .'| result.quota.computeResource.quota | Integer | 配额计算资源（单位：GB） |'."\n" .'| result.quota.computeResource.outOfLimit | Boolean | 是否超出配额 |'."\n" .'| result.quota.computeResource.dailyPeak | Float | 最高峰值（单位：LCU） |'."\n" .'| result.quota.spec | String | 规格类型:
- opensearch.share.junior 入门型
- opensearch.share.common 共享通用型
- opensearch.share.compute 共享计算型
- opensearch.share.storage 共享存储型
- opensearch.private.common 独享通用型
- opensearch.private.compute 独享计算型
- opensearch.private.storage 独享存储型 |'."\n" .'| result.quota.docCount | Object | 文档大小统计结果
键名为表名，值为使用容量（单位：个） |'."\n" .'| result.quota.mainTable | String | 主表名称 |', 'extraInfo' => ' ', ], 'ListUserAnalyzers' => [ 'summary' => '获取用户的自定义分词器列表。', 'path' => '/v4/openapi/user-analyzers', 'methods' => [ 'get', ], 'schemes' => [ 'http', 'https', ], 'security' => [ [ 'AK' => [], ], ], 'operationType' => 'read', 'deprecated' => false, 'systemTags' => [ 'operationType' => 'list', 'riskType' => 'none', 'chargeType' => 'free', 'abilityTreeNodes' => [ 'FEATUREopensearchUIICM8', 'FEATUREopensearchNCXKUT', ], ], 'parameters' => [ [ 'name' => 'pageNumber', 'in' => 'query', 'schema' => [ 'description' => '页码，默认 pageNumber=1', 'type' => 'integer', 'format' => 'int32', 'required' => false, 'maximum' => '999999999', 'minimum' => '-1', 'example' => '1', ], ], [ 'name' => 'pageSize', 'in' => 'query', 'schema' => [ 'description' => '每页返回数目，默认 pageSize=10', 'type' => 'integer', 'format' => 'int32', 'required' => false, 'maximum' => '999999999', 'minimum' => '-1', 'example' => '10', ], ], ], 'responses' => [ 200 => [ 'schema' => [ 'type' => 'object', 'properties' => [ 'totalCount' => [ 'description' => '总数', 'type' => 'integer', 'format' => 'int32', 'example' => '1', ], 'requestId' => [ 'description' => '请求ID', 'type' => 'string', 'example' => '0A6EB64B-B4C8-CF02-810F-E660812972FF', ], 'result' => [ 'description' => '自定义分析器'."\n" ."\n" .'参考：[UserAnalyzer](~~178934~~)', 'type' => 'array', 'items' => [ 'type' => 'object', 'properties' => [ 'created' => [ 'description' => '创建时间戳', 'type' => 'integer', 'format' => 'int32', 'example' => '1588054131', ], 'available' => [ 'description' => '是否可用', 'type' => 'boolean', 'example' => 'false', ], 'name' => [ 'description' => '名称', 'type' => 'string', 'example' => 'kevin_test2', ], 'updated' => [ 'description' => '更新时间戳', 'type' => 'integer', 'format' => 'int32', 'example' => '1588054131', ], 'id' => [ 'description' => '自定义分析器ID', 'type' => 'string', 'example' => '1234', ], 'business' => [ 'description' => '基础分词器'."\n" ."\n" .'- chn_standard [中文-通用分析](~~179424~~)'."\n" .'- chn_scene_name 中文－人名分析'."\n" .'- chn_ecommerce [中文-电商分析](~~179424~~)'."\n" .'- chn_it_content[ IT-内容分析](~~179424~~)'."\n" .'- en_min 英文－小粒度分析'."\n" .'- th_standard 泰语－通用分析'."\n" .'- th_ecommerce 泰语－电商分析'."\n" .'- vn_standard 越南语－通用分析'."\n" .'- chn_community_it 行业－内容IT分析'."\n" .'- chn_ecommerce_general 行业－电商通用分析'."\n" .'- chn_esports_general 行业－游戏通用分析'."\n" .'- chn_edu_question 行业－教育搜题', 'type' => 'string', 'example' => 'chn_standard', ], 'dicts' => [ 'description' => '自定义分词词典'."\n" ."\n" .'参考：[UserDict](~~178933~~)', 'type' => 'array', 'items' => [ 'type' => 'object', 'properties' => [ 'created' => [ 'description' => '创建时间戳', 'type' => 'integer', 'format' => 'int32', 'example' => '1588054131', ], 'entriesCount' => [ 'description' => '词条数量', 'type' => 'integer', 'format' => 'int32', 'example' => '-1', ], 'type' => [ 'description' => '类型'."\n" ."\n" .'- segment 拆分', 'type' => 'string', 'example' => 'segment', ], 'entriesLimit' => [ 'description' => '词条数量限制', 'type' => 'integer', 'format' => 'int32', 'example' => '4', ], 'available' => [ 'description' => '是否可用', 'type' => 'boolean', 'example' => 'false', ], 'updated' => [ 'description' => '更新时间戳', 'type' => 'integer', 'format' => 'int32', 'example' => '1588054131', ], 'id' => [ 'description' => '词典ID', 'type' => 'string', 'example' => '123', ], ], ], ], ], ], ], ], ], ], '5XX' => [ 'schema' => [ 'type' => 'object', 'properties' => [ 'code' => [ 'type' => 'string', ], 'message' => [ 'type' => 'string', ], 'requestId' => [ 'type' => 'string', ], 'httpCode' => [ 'type' => 'integer', 'format' => 'int32', ], ], ], ], ], 'responseDemo' => '[{"type":"json","example":"{\\n \\"totalCount\\": 1,\\n \\"requestId\\": \\"0A6EB64B-B4C8-CF02-810F-E660812972FF\\",\\n \\"result\\": [\\n {\\n \\"created\\": 1588054131,\\n \\"available\\": false,\\n \\"name\\": \\"kevin_test2\\",\\n \\"updated\\": 1588054131,\\n \\"id\\": \\"1234\\",\\n \\"business\\": \\"chn_standard\\",\\n \\"dicts\\": [\\n {\\n \\"created\\": 1588054131,\\n \\"entriesCount\\": -1,\\n \\"type\\": \\"segment\\",\\n \\"entriesLimit\\": 4,\\n \\"available\\": false,\\n \\"updated\\": 1588054131,\\n \\"id\\": \\"123\\"\\n }\\n ]\\n }\\n ]\\n}","errorExample":""},{"type":"xml","example":"0A6EB64B-B4C8-CF02-810F-E660812972FF\\n1\\n\\n 1234\\n kevin_test2\\n chn_standard\\n \\n 123\\n segment\\n 4\\n -1\\n false\\n 1588054131\\n 1588054131\\n \\n true\\n 1588054131\\n 1588054131\\n","errorExample":""}]', 'title' => '获取用户的自定义分词器列表', 'requestParamsDescription' => ' ', 'responseParamsDescription' => ' ', 'extraInfo' => ' ', ], 'CreateUserAnalyzer' => [ 'summary' => '创建自定义分析器。', 'path' => '/v4/openapi/user-analyzers', 'methods' => [ 'post', ], 'schemes' => [ 'http', 'https', ], 'security' => [ [ 'AK' => [], ], ], 'operationType' => 'write', 'deprecated' => false, 'systemTags' => [ 'operationType' => 'create', 'riskType' => 'none', 'chargeType' => 'free', 'abilityTreeNodes' => [ 'FEATUREopensearchUIICM8', 'FEATUREopensearchNCXKUT', ], ], 'parameters' => [ [ 'name' => 'body', 'in' => 'body', 'style' => 'json', 'schema' => [ 'description' => '请求体', 'type' => 'object', 'properties' => [ 'name' => [ 'title' => '名称', 'description' => '名称', 'type' => 'string', 'required' => false, 'example' => 'jmbon_analyzer', ], 'business' => [ 'title' => '基础分词器', 'description' => '基础分词器', 'type' => 'string', 'required' => false, 'example' => '中文-通用分析', ], 'businessType' => [ 'title' => '基础分词器类型 (AUTO, MODEL, SYSTEM, USER)', 'description' => '基础分词器类型 (AUTO, MODEL, SYSTEM, USER)', 'type' => 'string', 'required' => false, 'example' => 'AUTO', ], 'type' => [ 'title' => '引擎类型 (HA3, ES)', 'description' => '引擎类型 (HA3, ES)', 'type' => 'string', 'required' => false, 'example' => 'HA3', ], 'businessAppGroupId' => [ 'description' => '用于指定模型定制分析器所属应用ID', 'type' => 'string', 'required' => false, 'example' => '110123123', ], ], 'required' => false, ], ], [ 'name' => 'dryRun', 'in' => 'query', 'schema' => [ 'description' => '是否只预检此次请求，取值含义如下：'."\n" ."\n" .'- true：发送检查请求，不会创建终端节点。检查项包括AccessKey是否有效、RAM用户的授权情况和是否填写了必需参数。'."\n" .'- false（默认值）：立即触发创建终端节点。', 'type' => 'boolean', 'required' => false, 'example' => 'false', ], ], ], 'responses' => [ 200 => [ 'schema' => [ 'type' => 'object', 'properties' => [ 'result' => [ 'description' => '返回结果', 'type' => 'object', 'example' => '{}', ], 'RequestId' => [ 'description' => '请求ID', 'type' => 'string', 'example' => '98724351-D6B2-5D8A-B089-7FFD1821A7E9', ], ], ], ], '5XX' => [ 'schema' => [ 'type' => 'object', 'properties' => [ 'code' => [ 'type' => 'string', ], 'message' => [ 'type' => 'string', ], 'requestId' => [ 'type' => 'string', ], 'httpCode' => [ 'type' => 'integer', 'format' => 'int32', ], ], ], ], ], 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"result\\": {},\\n \\"RequestId\\": \\"98724351-D6B2-5D8A-B089-7FFD1821A7E9\\"\\n}","type":"json"}]', 'title' => '创建自定义分析器', ], 'DescribeUserAnalyzer' => [ 'summary' => '获取自定义分析器详情。', 'path' => '/v4/openapi/user-analyzers/{name}', 'methods' => [ 'get', ], 'schemes' => [ 'http', 'https', ], 'security' => [ [ 'AK' => [], ], ], 'operationType' => 'read', 'deprecated' => false, 'systemTags' => [ 'operationType' => 'get', 'riskType' => 'none', 'chargeType' => 'free', 'abilityTreeNodes' => [ 'FEATUREopensearchUIICM8', ], ], 'parameters' => [ [ 'name' => 'name', 'in' => 'path', 'schema' => [ 'description' => '分析器名称', 'type' => 'string', 'required' => true, 'docRequired' => true, 'example' => 'kevin_test', ], ], [ 'name' => 'with', 'in' => 'query', 'schema' => [ 'description' => '关联信息，根据层级输出属性'."\n" .'- all 输出关联app信息', 'type' => 'string', 'required' => false, 'example' => 'all', ], ], ], 'responses' => [ 200 => [ 'schema' => [ 'type' => 'object', 'properties' => [ 'result' => [ 'description' => '自定义分析器，参考：[UserAnalyzer](~~178934~~)', 'type' => 'object', 'example' => '{}', ], 'requestId' => [ 'description' => '请求ID', 'type' => 'string', 'example' => 'FFAEF396-10EF-53C7-1F51-518853880729', ], ], ], ], '5XX' => [ 'schema' => [ 'type' => 'object', 'properties' => [ 'code' => [ 'type' => 'string', ], 'message' => [ 'type' => 'string', ], 'requestId' => [ 'type' => 'string', ], 'httpCode' => [ 'type' => 'integer', 'format' => 'int32', ], ], ], ], ], 'responseDemo' => '[{"type":"json","example":"{\\n \\"result\\": {},\\n \\"requestId\\": \\"FFAEF396-10EF-53C7-1F51-518853880729\\"\\n}","errorExample":""},{"type":"xml","example":"FFAEF396-10EF-53C7-1F51-518853880729\\n\\n 1234\\n kevin_test\\n chn_it_content\\n true\\n \\n 100298352\\n test_srn_mysql\\n \\n \\n 123\\n segment\\n \\n add\\n kevintest\\n kevin test\\n 1536690285\\n 1537348987\\n ACTIVE\\n true\\n \\n \\n add\\n abcd\\n abcd\\n 1536690285\\n 1537348987\\n ACTIVE\\n true\\n \\n 4\\n 2\\n true\\n 1584702214\\n 1584702214\\n \\n 1584702212\\n 1584702212\\n","errorExample":""}]', 'title' => '获取自定义分析器详情', ], 'RemoveUserAnalyzer' => [ 'summary' => '删除自定义分析器。', 'path' => '/v4/openapi/user-analyzers/{name}', 'methods' => [ 'delete', ], 'schemes' => [ 'http', 'https', ], 'security' => [ [ 'AK' => [], ], ], 'operationType' => 'write', 'deprecated' => false, 'systemTags' => [ 'operationType' => 'delete', 'riskType' => 'none', 'chargeType' => 'free', 'abilityTreeNodes' => [ 'FEATUREopensearchUIICM8', ], ], 'parameters' => [ [ 'name' => 'name', 'in' => 'path', 'schema' => [ 'description' => '分析器名称', 'type' => 'string', 'required' => true, 'docRequired' => true, 'example' => '“kevin_test”', ], ], ], 'responses' => [ 200 => [ 'schema' => [ 'type' => 'object', 'properties' => [ 'result' => [ 'description' => '结果集（请求成功不返回该参数）', 'type' => 'object', 'example' => '[]', ], 'requestId' => [ 'description' => '请求ID', 'type' => 'string', 'example' => 'D77D0DAF-790D-F5F5-A9C0-133738165014', ], ], ], ], '5XX' => [ 'schema' => [ 'type' => 'object', 'properties' => [ 'code' => [ 'type' => 'string', ], 'message' => [ 'type' => 'string', ], 'requestId' => [ 'type' => 'string', ], 'httpCode' => [ 'type' => 'integer', 'format' => 'int32', ], ], ], ], ], 'responseDemo' => '[{"type":"json","example":"{\\n \\"result\\": [],\\n \\"requestId\\": \\"D77D0DAF-790D-F5F5-A9C0-133738165014\\"\\n}","errorExample":""},{"type":"xml","example":"D77D0DAF-790D-F5F5-A9C0-133738165014","errorExample":""}]', 'title' => '删除自定义分析器', 'requestParamsDescription' => ' ', 'responseParamsDescription' => ' ', 'extraInfo' => ' ', ], 'ListUserAnalyzerEntries' => [ 'summary' => '获取自定义分析器词条清单。', 'path' => '/v4/openapi/user-analyzers/{name}/entries', 'methods' => [ 'get', ], 'schemes' => [ 'http', 'https', ], 'security' => [ [ 'AK' => [], ], ], 'operationType' => 'read', 'deprecated' => false, 'systemTags' => [ 'operationType' => 'list', 'riskType' => 'none', 'chargeType' => 'free', 'abilityTreeNodes' => [ 'FEATUREopensearchUIICM8', ], ], 'parameters' => [ [ 'name' => 'name', 'in' => 'path', 'schema' => [ 'description' => '分析器名称。', 'type' => 'string', 'required' => true, 'docRequired' => true, 'example' => '"kevin_test"', ], ], [ 'name' => 'word', 'in' => 'query', 'schema' => [ 'description' => '词条key。', 'type' => 'string', 'required' => false, 'example' => '"kevintest"', ], ], [ 'name' => 'pageNumber', 'in' => 'query', 'schema' => [ 'description' => '页码，默认 pageNumber=1。', 'type' => 'integer', 'format' => 'int32', 'required' => false, 'maximum' => '999999999', 'minimum' => '-1', 'example' => '1', ], ], [ 'name' => 'pageSize', 'in' => 'query', 'schema' => [ 'description' => '每页返回数目，默认 pageSize=10。', 'type' => 'integer', 'format' => 'int32', 'required' => false, 'maximum' => '999999999', 'minimum' => '-1', 'example' => '10', ], ], ], 'responses' => [ 200 => [ 'schema' => [ 'type' => 'object', 'properties' => [ 'result' => [ 'description' => 'Object 自定义分析器词条'."\n" .'参考：UserAnalyzerEntry', 'type' => 'object', 'example' => '['."\n" .'{'."\n" .' "cmd": "add",'."\n" .' "key": "kevintest",'."\n" .' "value": "kevin test",'."\n" .' "created": 1536690285,'."\n" .' "updated": 1537348987,'."\n" .' "status": "ACTIVE",'."\n" .' "splitEnabled": true'."\n" .'}'."\n" .']', ], 'RequestId' => [ 'description' => '请求ID', 'type' => 'string', 'example' => '516A02B7-2167-8D92-12D0-B639A2A0F3C5', ], ], ], ], '5XX' => [ 'schema' => [ 'type' => 'object', 'properties' => [ 'code' => [ 'type' => 'string', ], 'message' => [ 'type' => 'string', ], 'requestId' => [ 'type' => 'string', ], 'httpCode' => [ 'type' => 'integer', 'format' => 'int32', ], ], ], ], ], 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"result\\": [\\n {\\n \\"cmd\\": \\"add\\",\\n \\"key\\": \\"kevintest\\",\\n \\"value\\": \\"kevin test\\",\\n \\"created\\": 1536690285,\\n \\"updated\\": 1537348987,\\n \\"status\\": \\"ACTIVE\\",\\n \\"splitEnabled\\": true\\n }\\n ],\\n \\"RequestId\\": \\"516A02B7-2167-8D92-12D0-B639A2A0F3C5\\"\\n}","type":"json"}]', 'title' => '获取自定义分析器词条清单', ], 'PushUserAnalyzerEntries' => [ 'summary' => '接收自定义分析器词条变更。', 'path' => '/v4/openapi/user-analyzers/{name}/entries/actions/bulk', 'methods' => [ 'post', ], 'schemes' => [ 'http', 'https', ], 'security' => [ [ 'AK' => [], ], ], 'operationType' => 'write', 'deprecated' => false, 'systemTags' => [ 'operationType' => 'update', 'riskType' => 'none', 'chargeType' => 'free', 'abilityTreeNodes' => [ 'FEATUREopensearchUIICM8', ], ], 'parameters' => [ [ 'name' => 'name', 'in' => 'path', 'schema' => [ 'description' => '分析器名称。', 'type' => 'string', 'required' => true, 'docRequired' => true, 'example' => '“kevin_test”', ], ], [ 'name' => 'dryRun', 'in' => 'query', 'schema' => [ 'description' => '是否dryRun创建（仅校验数据源是否合法）。取值：-true 是 -false 否', 'type' => 'boolean', 'required' => false, 'example' => 'true', ], ], [ 'name' => 'body', 'in' => 'body', 'style' => 'json', 'schema' => [ 'description' => '请求体。', 'type' => 'object', 'properties' => [ 'entries' => [ 'description' => '词条。', 'type' => 'array', 'items' => [ 'type' => 'object', 'properties' => [ 'cmd' => [ 'description' => '词条操作。'."\n" ."\n" .'取值：'."\n" ."\n" .'- add：添加。'."\n" .'- delete：删除。', 'type' => 'string', 'required' => false, 'example' => '"add"', ], 'key' => [ 'description' => '词条key信息。', 'type' => 'string', 'required' => false, 'example' => '"testvalue"', ], 'value' => [ 'description' => '分词结果。', 'type' => 'string', 'required' => false, 'example' => '"test value"', ], 'splitEnabled' => [ 'description' => '是否进行更细粒度切分。'."\n" ."\n" .'默认true', 'type' => 'boolean', 'required' => false, 'example' => 'true', ], ], 'required' => false, ], 'required' => false, 'maxItems' => 100, ], ], 'required' => false, ], ], ], 'responses' => [ 200 => [ 'schema' => [ 'type' => 'object', 'properties' => [ 'result' => [ 'description' => '返回结果。', 'type' => 'object', 'example' => '[]', ], 'RequestId' => [ 'description' => '请求ID', 'type' => 'string', 'example' => 'D77D0DAF-790D-F5F5-A9C0-133738165014', ], ], ], ], '5XX' => [ 'schema' => [ 'type' => 'object', 'properties' => [ 'code' => [ 'type' => 'string', ], 'message' => [ 'type' => 'string', ], 'requestId' => [ 'type' => 'string', ], 'httpCode' => [ 'type' => 'integer', 'format' => 'int32', ], ], ], ], ], 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"result\\": [],\\n \\"RequestId\\": \\"D77D0DAF-790D-F5F5-A9C0-133738165014\\"\\n}","type":"json"}]', 'title' => '接收自定义分析器词条变更', 'requestParamsDescription' => '注：'."\n" .'添加英文干预词条请全部用小写字母', ], 'ListABTestScenes' => [ 'summary' => '列出场景清单。', 'path' => '/v4/openapi/app-groups/{appGroupIdentity}/scenes', 'methods' => [ 'get', ], 'schemes' => [ 'http', 'https', ], 'security' => [ [ 'AK' => [], ], ], 'operationType' => 'read', 'deprecated' => false, 'systemTags' => [ 'operationType' => 'list', 'riskType' => 'none', 'chargeType' => 'free', 'abilityTreeNodes' => [ 'FEATUREopensearchE07IML', ], ], 'parameters' => [ [ 'name' => 'appGroupIdentity', 'in' => 'path', 'schema' => [ 'description' => '应用名称', 'type' => 'string', 'required' => true, 'docRequired' => true, 'example' => 'my_app_group_name', ], ], ], 'responses' => [ 200 => [ 'schema' => [ 'type' => 'object', 'properties' => [ 'requestId' => [ 'description' => '请求ID', 'type' => 'string', 'example' => 'D77D0DAF-790D-F5F5-A9C0-133738165014', ], 'result' => [ 'description' => '实验场景'."\n" ."\n" .'参考：[ABTestScene](~~173618~~)', 'type' => 'array', 'items' => [ 'description' => '返回结果', 'type' => 'object', 'properties' => [ 'created' => [ 'description' => '创建时间', 'type' => 'integer', 'format' => 'int32', 'example' => '1588836130', ], 'status' => [ 'description' => '状态'."\n" ."\n" .'- 0 未生效'."\n" .'- 1 生效', 'type' => 'integer', 'format' => 'int32', 'example' => '1', ], 'updated' => [ 'description' => '最后修改时间', 'type' => 'integer', 'format' => 'int32', 'example' => '1588836129', ], 'name' => [ 'description' => '组别名', 'type' => 'string', 'example' => 'kevintest_2020-5-7_15:21:482', ], 'id' => [ 'description' => '组ID', 'type' => 'string', 'example' => '20404', ], 'values' => [ 'description' => '场景列表', 'type' => 'array', 'items' => [ 'description' => '场景列表', 'type' => 'string', 'example' => '["kevintest2"]', ], ], ], ], ], ], ], ], '5XX' => [ 'schema' => [ 'type' => 'object', 'properties' => [ 'code' => [ 'type' => 'string', ], 'message' => [ 'type' => 'string', ], 'requestId' => [ 'type' => 'string', ], 'httpCode' => [ 'type' => 'integer', 'format' => 'int32', ], ], ], ], ], 'responseDemo' => '[{"type":"json","example":"{\\n \\"requestId\\": \\"D77D0DAF-790D-F5F5-A9C0-133738165014\\",\\n \\"result\\": [\\n {\\n \\"created\\": 1588836130,\\n \\"status\\": 1,\\n \\"updated\\": 1588836129,\\n \\"name\\": \\"kevintest_2020-5-7_15:21:482\\",\\n \\"id\\": \\"20404\\",\\n \\"values\\": [\\n \\"[\\\\\\"kevintest2\\\\\\"]\\"\\n ]\\n }\\n ]\\n}","errorExample":""},{"type":"xml","example":"D77D0DAF-790D-F5F5-A9C0-133738165014\\n\\n 20404\\n kevintest_2020-5-7_15:21:482\\n 1\\n 1588836130\\n 1588836129\\n kevintest2\\n","errorExample":""}]', 'title' => '列出场景清单', 'requestParamsDescription' => ' ', 'responseParamsDescription' => ' ', 'extraInfo' => ' ', ], 'CreateABTestScene' => [ 'summary' => '创建实验场景。', 'path' => '/v4/openapi/app-groups/{appGroupIdentity}/scenes', 'methods' => [ 'post', ], 'schemes' => [ 'http', 'https', ], 'security' => [ [ 'AK' => [], ], ], 'operationType' => 'write', 'deprecated' => false, 'systemTags' => [ 'operationType' => 'create', 'riskType' => 'none', 'chargeType' => 'free', 'abilityTreeNodes' => [ 'FEATUREopensearchE07IML', ], ], 'parameters' => [ [ 'name' => 'appGroupIdentity', 'in' => 'path', 'schema' => [ 'description' => '应用名称', 'type' => 'string', 'required' => true, 'docRequired' => true, 'example' => 'my_app_group_name', ], ], [ 'name' => 'body', 'in' => 'body', 'schema' => [ 'description' => 'ABTest实验场景，参考[ABTestScene](~~173618~~)', 'required' => false, '$ref' => '#/components/schemas/ABTestScene', ], ], [ 'name' => 'dryRun', 'in' => 'query', 'schema' => [ 'description' => '是否校验入参数据合法性，默认false。'."\n" ."\n" .'取值：'."\n" ."\n" .'- **true**：只校验参数合法性。'."\n" ."\n" .'- **false**：校验参数合法性，创建归因配置。', 'type' => 'boolean', 'required' => false, 'example' => 'false', ], ], ], 'responses' => [ 200 => [ 'schema' => [ 'type' => 'object', 'properties' => [ 'requestId' => [ 'description' => '请求ID', 'type' => 'string', 'example' => 'D77D0DAF-790D-F5F5-A9C0-133738165014', ], 'result' => [ 'description' => '返回结果', 'type' => 'object', 'properties' => [ 'created' => [ 'description' => '创建时间', 'type' => 'integer', 'format' => 'int32', 'example' => '0', ], 'status' => [ 'description' => '状态'."\n" .'- 0 未生效'."\n" .'- 1 生效', 'type' => 'integer', 'format' => 'int32', 'example' => '1', ], 'updated' => [ 'description' => '最后修改时间', 'type' => 'integer', 'format' => 'int32', 'example' => '1589012351', ], 'name' => [ 'description' => '组别名', 'type' => 'string', 'example' => 'kevintest_2020-5-7_15:21:48', ], 'id' => [ 'description' => '组ID', 'type' => 'string', 'example' => '20405', ], 'values' => [ 'description' => '场景标识', 'type' => 'array', 'items' => [ 'description' => '场景标识', 'type' => 'string', 'example' => '[ "kevintest" ]', ], ], ], ], ], ], ], '5XX' => [ 'schema' => [ 'type' => 'object', 'properties' => [ 'code' => [ 'type' => 'string', ], 'message' => [ 'type' => 'string', ], 'requestId' => [ 'type' => 'string', ], 'httpCode' => [ 'type' => 'integer', 'format' => 'int32', ], ], ], ], ], 'responseDemo' => '[{"type":"json","example":"{\\n \\"requestId\\": \\"D77D0DAF-790D-F5F5-A9C0-133738165014\\",\\n \\"result\\": {\\n \\"created\\": 0,\\n \\"status\\": 1,\\n \\"updated\\": 1589012351,\\n \\"name\\": \\"kevintest_2020-5-7_15:21:48\\",\\n \\"id\\": \\"20405\\",\\n \\"values\\": [\\n \\"[ \\\\\\"kevintest\\\\\\" ]\\"\\n ]\\n }\\n}","errorExample":""},{"type":"xml","example":"D77D0DAF-790D-F5F5-A9C0-133738165014\\n\\n 20405\\n kevintest_2020-5-7_15:21:48\\n 1\\n 1589012351\\n 1589012351\\n kevintest\\n","errorExample":""}]', 'title' => '创建 ABTest 实验场景', 'requestParamsDescription' => '**请求体**'."\n" .'| 字段 | 类型 | 是否必要 | 示例值 | 描述 |'."\n" .'| --- | --- | --- | --- | --- |'."\n" .'| name | String | 是 | "kevintest22" | 场景别名 |'."\n" .'| status| Integer| 否 | 0 | 场景状态- 0 停止实验- 1 启动实验 |'."\n" .'| created| Integer| 否 | 1589012351 | 创建时间 |'."\n" .'| updated| Integer| 否 | 1589012351 | 最后修改时间 |'."\n" .'| values[] | String | 否 | "kevintest22" | 场景标识 |', 'responseParamsDescription' => ' ', 'extraInfo' => ' ', ], 'DescribeABTestScene' => [ 'summary' => '获取实验场景详情。', 'path' => '/v4/openapi/app-groups/{appGroupIdentity}/scenes/{sceneId}', 'methods' => [ 'get', ], 'schemes' => [ 'http', 'https', ], 'security' => [ [ 'AK' => [], ], ], 'operationType' => 'read', 'deprecated' => false, 'systemTags' => [ 'operationType' => 'get', 'riskType' => 'none', 'chargeType' => 'free', 'abilityTreeNodes' => [ 'FEATUREopensearchE07IML', ], ], 'parameters' => [ [ 'name' => 'appGroupIdentity', 'in' => 'path', 'schema' => [ 'description' => '应用的名称或者是应用id', 'type' => 'string', 'required' => true, 'docRequired' => true, 'example' => 'my_app_group_name', ], ], [ 'name' => 'sceneId', 'in' => 'path', 'schema' => [ 'description' => '实验场景ID。', 'type' => 'integer', 'format' => 'int32', 'required' => true, 'docRequired' => true, 'maximum' => '999999999', 'minimum' => '-1', 'example' => '20404', ], ], ], 'responses' => [ 200 => [ 'schema' => [ 'type' => 'object', 'properties' => [ 'requestId' => [ 'description' => '请求ID。', 'type' => 'string', 'example' => 'D77D0DAF-790D-F5F5-A9C0-133738165014', ], 'result' => [ 'description' => '实验场景。', 'type' => 'object', 'properties' => [ 'created' => [ 'description' => '创建时间。', 'type' => 'integer', 'format' => 'int32', 'example' => '1596527691', ], 'status' => [ 'description' => '场景状态'."\n" .'- 0 停止实验'."\n" .'- 1 启动实验', 'type' => 'integer', 'format' => 'int32', 'example' => '0', ], 'updated' => [ 'description' => '最后修改时间', 'type' => 'integer', 'format' => 'int32', 'example' => '1596527691', ], 'name' => [ 'description' => '场景别名', 'type' => 'string', 'example' => '"test"', ], 'id' => [ 'description' => '场景ID', 'type' => 'string', 'example' => '20614', ], 'values' => [ 'description' => '场景标识', 'type' => 'array', 'items' => [ 'description' => '场景标识', 'type' => 'string', 'example' => 'test', ], ], ], ], ], ], ], '5XX' => [ 'schema' => [ 'type' => 'object', 'properties' => [ 'code' => [ 'type' => 'string', ], 'message' => [ 'type' => 'string', ], 'requestId' => [ 'type' => 'string', ], 'httpCode' => [ 'type' => 'integer', 'format' => 'int32', ], ], ], ], ], 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"requestId\\": \\"D77D0DAF-790D-F5F5-A9C0-133738165014\\",\\n \\"result\\": {\\n \\"created\\": 1596527691,\\n \\"status\\": 0,\\n \\"updated\\": 1596527691,\\n \\"name\\": \\"\\\\\\"test\\\\\\"\\",\\n \\"id\\": \\"20614\\",\\n \\"values\\": [\\n \\"test\\"\\n ]\\n }\\n}","type":"json"}]', 'title' => '获取ABTest实验场景详情', ], 'UpdateABTestScene' => [ 'summary' => '修改实验场景。', 'path' => '/v4/openapi/app-groups/{appGroupIdentity}/scenes/{sceneId}', 'methods' => [ 'put', ], 'schemes' => [ 'http', 'https', ], 'security' => [ [ 'AK' => [], ], ], 'operationType' => 'write', 'deprecated' => false, 'systemTags' => [ 'operationType' => 'update', 'riskType' => 'none', 'chargeType' => 'free', 'abilityTreeNodes' => [ 'FEATUREopensearchE07IML', ], ], 'parameters' => [ [ 'name' => 'appGroupIdentity', 'in' => 'path', 'schema' => [ 'description' => '应用名称', 'type' => 'string', 'required' => true, 'docRequired' => true, 'example' => '“my_app_group_name”', ], ], [ 'name' => 'sceneId', 'in' => 'path', 'schema' => [ 'description' => '场景ID', 'type' => 'integer', 'format' => 'int32', 'required' => true, 'docRequired' => true, 'maximum' => '999999999', 'minimum' => '-1', 'example' => '20404', ], ], [ 'name' => 'body', 'in' => 'body', 'schema' => [ 'description' => 'ABTest实验场景', 'required' => false, '$ref' => '#/components/schemas/ABTestScene', ], ], [ 'name' => 'dryRun', 'in' => 'query', 'schema' => [ 'description' => '是否dryRun创建（仅校验数据源是否合法）。取值：-true 是 -false 否', 'type' => 'boolean', 'required' => false, 'example' => 'true', ], ], ], 'responses' => [ 200 => [ 'schema' => [ 'description' => '响应体', 'type' => 'object', 'properties' => [ 'requestId' => [ 'description' => '请求ID', 'type' => 'string', 'example' => 'D77D0DAF-790D-F5F5-A9C0-133738165014', ], 'result' => [ 'description' => '实验场景'."\n" .'参考：[ABTestScene](~~173618~~)'."\n", 'type' => 'object', 'properties' => [ 'created' => [ 'description' => '创建时间', 'type' => 'integer', 'format' => 'int32', 'example' => '1596527691', ], 'params' => [ 'description' => '试验参数', 'type' => 'object', 'example' => '{}', ], 'traffic' => [ 'description' => '实验分桶百分比取值范围：0-100', 'type' => 'integer', 'format' => 'int32', 'example' => '111', ], 'online' => [ 'description' => '实验状态'."\n" .'- true：开启'."\n" .'- false：停止', 'type' => 'boolean', 'example' => 'true', ], 'name' => [ 'description' => '场景别名', 'type' => 'string', 'example' => 'kevintest22', ], 'updated' => [ 'description' => '最后修改时间', 'type' => 'integer', 'format' => 'int32', 'example' => '1596527691', ], 'id' => [ 'description' => '场景ID', 'type' => 'string', 'example' => '20614', ], ], 'example' => '{}', ], ], 'example' => '{}', ], ], '5XX' => [ 'schema' => [ 'type' => 'object', 'properties' => [ 'code' => [ 'type' => 'string', ], 'message' => [ 'type' => 'string', ], 'requestId' => [ 'type' => 'string', ], 'httpCode' => [ 'type' => 'integer', 'format' => 'int32', ], ], ], ], ], 'responseDemo' => '[{"type":"json","example":"{\\n \\"requestId\\": \\"D77D0DAF-790D-F5F5-A9C0-133738165014\\",\\n \\"result\\": {\\n \\"created\\": 1596527691,\\n \\"params\\": {},\\n \\"traffic\\": 111,\\n \\"online\\": true,\\n \\"name\\": \\"kevintest22\\",\\n \\"updated\\": 1596527691,\\n \\"id\\": \\"20614\\"\\n }\\n}","errorExample":""},{"type":"xml","example":"D77D0DAF-790D-F5F5-A9C0-133738165014\\n\\n 20405\\n kevintest22\\n 1\\n 1589012351\\n 1589012351\\n kevintest22\\n","errorExample":""}]', 'title' => '修改实验场景', 'requestParamsDescription' => '**请求体**'."\n" .'| 字段 | 类型 | 是否必要 | 示例值 | 描述 |'."\n" .'| --- | --- | --- | --- | --- |'."\n" .'| name | String | 是 | "kevintest22" | 场景别名 |'."\n" .'| values[] | String | 是 | "kevintest22" | 场景标识 |', 'responseParamsDescription' => ' ', 'extraInfo' => ' ', ], 'DeleteABTestScene' => [ 'summary' => '删除实验场景。', 'path' => '/v4/openapi/app-groups/{appGroupIdentity}/scenes/{sceneId}', 'methods' => [ 'delete', ], 'schemes' => [ 'http', 'https', ], 'security' => [ [ 'AK' => [], ], ], 'operationType' => 'write', 'deprecated' => false, 'systemTags' => [ 'operationType' => 'delete', 'riskType' => 'none', 'chargeType' => 'free', 'abilityTreeNodes' => [ 'FEATUREopensearchE07IML', ], ], 'parameters' => [ [ 'name' => 'appGroupIdentity', 'in' => 'path', 'schema' => [ 'description' => '应用的名称、应用id', 'type' => 'string', 'required' => true, 'docRequired' => true, 'example' => 'my_app_group_name', ], ], [ 'name' => 'sceneId', 'in' => 'path', 'schema' => [ 'description' => '场景ID', 'type' => 'integer', 'format' => 'int32', 'required' => true, 'docRequired' => true, 'maximum' => '999999999', 'minimum' => '-1', 'example' => '20404', ], ], ], 'responses' => [ 200 => [ 'schema' => [ 'type' => 'object', 'properties' => [ 'result' => [ 'description' => '返回结果', 'type' => 'object', 'example' => '[]', ], 'requestId' => [ 'description' => '请求ID', 'type' => 'string', 'example' => '5C1C1C45-C64A-AD30-565F-140871D57E5E', ], ], ], ], '5XX' => [ 'schema' => [ 'type' => 'object', 'properties' => [ 'code' => [ 'type' => 'string', ], 'message' => [ 'type' => 'string', ], 'requestId' => [ 'type' => 'string', ], 'httpCode' => [ 'type' => 'integer', 'format' => 'int32', ], ], ], ], ], 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"result\\": [],\\n \\"requestId\\": \\"5C1C1C45-C64A-AD30-565F-140871D57E5E\\"\\n}","type":"json"}]', 'title' => '删除 ABTest 实验场景', ], 'ListABTestGroups' => [ 'summary' => '获取实验组清单。', 'path' => '/v4/openapi/app-groups/{appGroupIdentity}/scenes/{sceneId}/groups', 'methods' => [ 'get', ], 'schemes' => [ 'http', 'https', ], 'security' => [ [ 'AK' => [], ], ], 'operationType' => 'read', 'deprecated' => false, 'systemTags' => [ 'operationType' => 'list', 'riskType' => 'none', 'chargeType' => 'free', 'abilityTreeNodes' => [ 'FEATUREopensearchE07IML', ], ], 'parameters' => [ [ 'name' => 'appGroupIdentity', 'in' => 'path', 'schema' => [ 'description' => '应用名称', 'type' => 'string', 'required' => true, 'docRequired' => true, 'example' => ' “my_app_group_name”', ], ], [ 'name' => 'sceneId', 'in' => 'path', 'schema' => [ 'description' => '场景ID', 'type' => 'integer', 'format' => 'int32', 'required' => true, 'docRequired' => true, 'maximum' => '999999999', 'minimum' => '-1', 'example' => '20404', ], ], ], 'responses' => [ 200 => [ 'schema' => [ 'type' => 'object', 'properties' => [ 'requestId' => [ 'description' => '请求ID', 'type' => 'string', 'example' => 'D77D0DAF-790D-F5F5-A9C0-133738165014', ], 'result' => [ 'description' => '实验组'."\n" ."\n" .'参考：[ABTestGroup](~~178935~~)', 'type' => 'array', 'items' => [ 'type' => 'object', 'properties' => [ 'created' => [ 'description' => '创建时间', 'type' => 'integer', 'format' => 'int32', 'example' => '1588839490', ], 'status' => [ 'description' => '状态'."\n" .'- 0 未生效'."\n" .'- 1 生效', 'type' => 'integer', 'format' => 'int32', 'example' => '1', ], 'updated' => [ 'description' => '最后修改时间', 'type' => 'integer', 'format' => 'int32', 'example' => '1588839490', ], 'name' => [ 'description' => '组别名', 'type' => 'string', 'example' => 'Group_2020-5-7_15:23:3', ], 'id' => [ 'description' => '组ID', 'type' => 'string', 'example' => '13466', ], ], ], ], ], ], ], '5XX' => [ 'schema' => [ 'type' => 'object', 'properties' => [ 'code' => [ 'type' => 'string', ], 'message' => [ 'type' => 'string', ], 'requestId' => [ 'type' => 'string', ], 'httpCode' => [ 'type' => 'integer', 'format' => 'int32', ], ], ], ], ], 'responseDemo' => '[{"type":"json","example":"{\\n \\"requestId\\": \\"D77D0DAF-790D-F5F5-A9C0-133738165014\\",\\n \\"result\\": [\\n {\\n \\"created\\": 1588839490,\\n \\"status\\": 1,\\n \\"updated\\": 1588839490,\\n \\"name\\": \\"Group_2020-5-7_15:23:3\\",\\n \\"id\\": \\"13466\\"\\n }\\n ]\\n}","errorExample":""},{"type":"xml","example":"D77D0DAF-790D-F5F5-A9C0-133738165014\\n\\n 13466\\n Group_2020-5-7_15:23:3\\n 1\\n 1588839490\\n 1588839490\\n","errorExample":""}]', 'title' => '获取实验组清单', 'requestParamsDescription' => ' ', 'responseParamsDescription' => ' ', 'extraInfo' => ' ', ], 'CreateABTestGroup' => [ 'summary' => '创建实验组。', 'path' => '/v4/openapi/app-groups/{appGroupIdentity}/scenes/{sceneId}/groups', 'methods' => [ 'post', ], 'schemes' => [ 'http', 'https', ], 'security' => [ [ 'AK' => [], ], ], 'operationType' => 'read', 'deprecated' => false, 'systemTags' => [ 'operationType' => 'create', 'riskType' => 'none', 'chargeType' => 'free', 'abilityTreeNodes' => [ 'FEATUREopensearchE07IML', ], ], 'parameters' => [ [ 'name' => 'appGroupIdentity', 'in' => 'path', 'schema' => [ 'description' => '应用名称', 'type' => 'string', 'required' => true, 'docRequired' => true, 'example' => 'my_app_group_name', ], ], [ 'name' => 'sceneId', 'in' => 'path', 'schema' => [ 'description' => '场景ID', 'type' => 'integer', 'format' => 'int32', 'required' => false, 'maximum' => '999999999', 'minimum' => '-1', 'example' => '20404', ], ], [ 'name' => 'body', 'in' => 'body', 'schema' => [ 'description' => '请求体，参考：[ABTestGroup](~~178935~~)', 'required' => false, '$ref' => '#/components/schemas/ABTestGroup', ], ], [ 'name' => 'dryRun', 'in' => 'query', 'schema' => [ 'description' => '是否校验入参数据合法性，默认false。'."\n" ."\n" .'取值：'."\n" ."\n" .'- **true**：只校验参数合法性。'."\n" ."\n" .'- **false**：校验参数合法性，创建归因配置。', 'type' => 'boolean', 'required' => false, 'example' => 'true', ], ], ], 'responses' => [ 200 => [ 'schema' => [ 'type' => 'object', 'properties' => [ 'requestId' => [ 'description' => '请求ID', 'type' => 'string', 'example' => 'D77D0DAF-790D-F5F5-A9C0-133738165014', ], 'result' => [ 'description' => '返回结果', 'type' => 'object', 'properties' => [ 'created' => [ 'description' => '创建时间', 'type' => 'integer', 'format' => 'int32', 'example' => '1588839490', ], 'status' => [ 'description' => '状态'."\n" .'- 0 未生效'."\n" .'- 1 生效', 'type' => 'integer', 'format' => 'int32', 'example' => '1', ], 'updated' => [ 'description' => '最后修改时间', 'type' => 'integer', 'format' => 'int32', 'example' => '1588839490', ], 'name' => [ 'description' => '组别名', 'type' => 'string', 'example' => 'Group_2020-5-7_15:23:3', ], 'id' => [ 'description' => '组ID', 'type' => 'string', 'example' => '13466', ], ], ], ], ], ], '5XX' => [ 'schema' => [ 'type' => 'object', 'properties' => [ 'code' => [ 'type' => 'string', ], 'message' => [ 'type' => 'string', ], 'requestId' => [ 'type' => 'string', ], 'httpCode' => [ 'type' => 'integer', 'format' => 'int32', ], ], ], ], ], 'responseDemo' => '[{"type":"json","example":"{\\n \\"requestId\\": \\"D77D0DAF-790D-F5F5-A9C0-133738165014\\",\\n \\"result\\": {\\n \\"created\\": 1588839490,\\n \\"status\\": 1,\\n \\"updated\\": 1588839490,\\n \\"name\\": \\"Group_2020-5-7_15:23:3\\",\\n \\"id\\": \\"13466\\"\\n }\\n}","errorExample":""},{"type":"xml","example":"\\n 1588839490\\n Group_2020-5-7_15:23:3\\n 13466\\n 1588839490\\n 1\\n\\nD77D0DAF-790D-F5F5-A9C0-133738165014","errorExample":""}]', 'title' => '创建 ABTest 实验组', 'requestParamsDescription' => '**请求体**'."\n" .'| 字段 | 类型 | 是否必要 | 示例值 | 描述 |'."\n" .'| --- | --- | --- | --- | --- |'."\n" .'| name | String | 是 | "kevintest3" | 实验组名称 |', 'responseParamsDescription' => ' ', 'extraInfo' => ' ', ], 'DeleteABTestGroup' => [ 'summary' => '删除实验组。', 'path' => '/v4/openapi/app-groups/{appGroupIdentity}/scenes/{sceneId}/groups/{groupId}', 'methods' => [ 'delete', ], 'schemes' => [ 'http', 'https', ], 'security' => [ [ 'AK' => [], ], ], 'operationType' => 'write', 'deprecated' => false, 'systemTags' => [ 'operationType' => 'delete', 'riskType' => 'none', 'chargeType' => 'free', 'abilityTreeNodes' => [ 'FEATUREopensearchE07IML', ], ], 'parameters' => [ [ 'name' => 'appGroupIdentity', 'in' => 'path', 'schema' => [ 'description' => '应用名称', 'type' => 'string', 'required' => true, 'docRequired' => true, 'example' => 'my_app_group_name', ], ], [ 'name' => 'sceneId', 'in' => 'path', 'schema' => [ 'description' => '场景ID', 'type' => 'integer', 'format' => 'int32', 'required' => true, 'docRequired' => true, 'maximum' => '999999999', 'minimum' => '-1', 'example' => '20404', ], ], [ 'name' => 'groupId', 'in' => 'path', 'schema' => [ 'description' => '组ID', 'type' => 'integer', 'format' => 'int32', 'required' => true, 'docRequired' => true, 'maximum' => '999999999', 'minimum' => '-1', 'example' => '13467', ], ], ], 'responses' => [ 200 => [ 'schema' => [ 'type' => 'object', 'properties' => [ 'result' => [ 'description' => '返回结果', 'type' => 'object', 'example' => '{}', ], 'requestId' => [ 'description' => '请求ID', 'type' => 'string', 'example' => 'ABCDEFGH', ], ], ], ], '5XX' => [ 'schema' => [ 'type' => 'object', 'properties' => [ 'code' => [ 'type' => 'string', ], 'message' => [ 'type' => 'string', ], 'requestId' => [ 'type' => 'string', ], 'httpCode' => [ 'type' => 'integer', 'format' => 'int32', ], ], ], ], ], 'responseDemo' => '[{"type":"json","example":"{\\n \\"result\\": {},\\n \\"requestId\\": \\"ABCDEFGH\\"\\n}","errorExample":""},{"type":"xml","example":"D77D0DAF-790D-F5F5-A9C0-133738165014","errorExample":""}]', 'title' => '删除 ABTest 实验组', ], 'DescribeABTestGroup' => [ 'summary' => '获取实验组详情。', 'path' => '/v4/openapi/app-groups/{appGroupIdentity}/scenes/{sceneId}/groups/{groupId}', 'methods' => [ 'get', ], 'schemes' => [ 'http', 'https', ], 'security' => [ [ 'AK' => [], ], ], 'operationType' => 'read', 'deprecated' => false, 'systemTags' => [ 'operationType' => 'get', 'riskType' => 'none', 'chargeType' => 'free', 'abilityTreeNodes' => [ 'FEATUREopensearchE07IML', ], ], 'parameters' => [ [ 'name' => 'appGroupIdentity', 'in' => 'path', 'schema' => [ 'description' => '应用名称', 'type' => 'string', 'required' => true, 'docRequired' => true, 'example' => 'my_app_group_name', ], ], [ 'name' => 'sceneId', 'in' => 'path', 'schema' => [ 'description' => '场景ID', 'type' => 'integer', 'format' => 'int32', 'required' => true, 'docRequired' => true, 'maximum' => '999999999', 'minimum' => '-1', 'example' => '20404', ], ], [ 'name' => 'groupId', 'in' => 'path', 'schema' => [ 'description' => '组ID', 'type' => 'integer', 'format' => 'int32', 'required' => true, 'docRequired' => true, 'maximum' => '999999999', 'minimum' => '-1', 'example' => '13467', ], ], ], 'responses' => [ 200 => [ 'schema' => [ 'type' => 'object', 'properties' => [ 'requestId' => [ 'description' => '请求ID', 'type' => 'string', 'example' => 'D77D0DAF-790D-F5F5-A9C0-133738165014', ], 'result' => [ 'description' => '实验组', 'type' => 'object', 'properties' => [ 'created' => [ 'description' => '创建时间', 'type' => 'integer', 'format' => 'int32', 'example' => '1588839490', ], 'status' => [ 'description' => '状态'."\n" .'- 0 未生效'."\n" .'- 1 生效', 'type' => 'integer', 'format' => 'int32', 'example' => '1', ], 'updated' => [ 'description' => '最后修改时间', 'type' => 'integer', 'format' => 'int32', 'example' => '1588839490', ], 'name' => [ 'description' => '组别名', 'type' => 'string', 'example' => 'Group_2020-5-7_15:23:3', ], 'id' => [ 'description' => '组ID', 'type' => 'string', 'example' => '13466', ], ], ], ], ], ], '5XX' => [ 'schema' => [ 'type' => 'object', 'properties' => [ 'code' => [ 'type' => 'string', ], 'message' => [ 'type' => 'string', ], 'requestId' => [ 'type' => 'string', ], 'httpCode' => [ 'type' => 'integer', 'format' => 'int32', ], ], ], ], ], 'responseDemo' => '[{"type":"json","example":"{\\n \\"requestId\\": \\"D77D0DAF-790D-F5F5-A9C0-133738165014\\",\\n \\"result\\": {\\n \\"created\\": 1588839490,\\n \\"status\\": 1,\\n \\"updated\\": 1588839490,\\n \\"name\\": \\"Group_2020-5-7_15:23:3\\",\\n \\"id\\": \\"13466\\"\\n }\\n}","errorExample":""},{"type":"xml","example":"D77D0DAF-790D-F5F5-A9C0-133738165014\\n\\n 13466\\n Group_2020-5-7_15:23:3\\n 1\\n 1588839490\\n 1588839490\\n","errorExample":""}]', 'title' => '获取 ABTest 实验组详情', 'requestParamsDescription' => ' ', 'responseParamsDescription' => ' ', 'extraInfo' => ' ', ], 'UpdateABTestGroup' => [ 'summary' => '修改实验组。', 'path' => '/v4/openapi/app-groups/{appGroupIdentity}/scenes/{sceneId}/groups/{groupId}', 'methods' => [ 'put', ], 'schemes' => [ 'http', 'https', ], 'security' => [ [ 'AK' => [], ], ], 'operationType' => 'write', 'deprecated' => false, 'systemTags' => [ 'operationType' => 'update', 'riskType' => 'none', 'chargeType' => 'free', 'abilityTreeCode' => '55268', 'abilityTreeNodes' => [ 'FEATUREopensearchE07IML', ], ], 'parameters' => [ [ 'name' => 'appGroupIdentity', 'in' => 'path', 'schema' => [ 'description' => '应用名称', 'type' => 'string', 'required' => true, 'docRequired' => true, 'example' => '“my_app_group_name”', ], ], [ 'name' => 'sceneId', 'in' => 'path', 'schema' => [ 'description' => '场景ID', 'type' => 'integer', 'format' => 'int32', 'required' => true, 'docRequired' => true, 'maximum' => '999999999', 'minimum' => '-1', 'example' => '20404', ], ], [ 'name' => 'groupId', 'in' => 'path', 'schema' => [ 'description' => '组ID', 'type' => 'integer', 'format' => 'int32', 'required' => true, 'docRequired' => true, 'maximum' => '999999999', 'minimum' => '-1', 'example' => '13467', ], ], [ 'name' => 'body', 'in' => 'body', 'schema' => [ 'description' => '请求体，参考：[ABTestGroup](~~178935~~)', 'required' => false, '$ref' => '#/components/schemas/ABTestGroup', ], ], [ 'name' => 'dryRun', 'in' => 'query', 'schema' => [ 'description' => '是否只预检此次请求，取值含义如下：'."\n" ."\n" .'- true：发送检查请求，不会创建终端节点。检查项包括AccessKey是否有效、RAM用户的授权情况和是否填写了必需参数。'."\n" .'- false（默认值）：立即触发创建终端节点。', 'type' => 'boolean', 'required' => false, 'example' => 'true', ], ], ], 'responses' => [ 200 => [ 'schema' => [ 'type' => 'object', 'properties' => [ 'requestId' => [ 'description' => '请求ID', 'type' => 'string', 'example' => '\'\'1111\'\'', ], 'result' => [ 'description' => '实验组', 'type' => 'object', 'properties' => [ 'created' => [ 'description' => '创建时间', 'type' => 'integer', 'format' => 'int32', 'example' => '1588839490', ], 'status' => [ 'description' => '状态'."\n" .'- 0 未生效'."\n" .'- 1 生效', 'type' => 'integer', 'format' => 'int32', 'example' => '1', ], 'updated' => [ 'description' => '最后修改时间', 'type' => 'integer', 'format' => 'int32', 'example' => '1588839490', ], 'name' => [ 'description' => '组别名', 'type' => 'string', 'example' => 'Group_2020-5-7_15:23:3', ], 'id' => [ 'description' => '组ID', 'type' => 'string', 'example' => '13466', ], ], ], ], ], ], '5XX' => [ 'schema' => [ 'type' => 'object', 'properties' => [ 'code' => [ 'type' => 'string', ], 'message' => [ 'type' => 'string', ], 'requestId' => [ 'type' => 'string', ], 'httpCode' => [ 'type' => 'integer', 'format' => 'int32', ], ], ], ], ], 'responseDemo' => '[{"type":"json","example":"{\\n \\"requestId\\": \\"\'\'1111\'\'\\",\\n \\"result\\": {\\n \\"created\\": 1588839490,\\n \\"status\\": 1,\\n \\"updated\\": 1588839490,\\n \\"name\\": \\"Group_2020-5-7_15:23:3\\",\\n \\"id\\": \\"13466\\"\\n }\\n}","errorExample":""},{"type":"xml","example":"D77D0DAF-790D-F5F5-A9C0-133738165014\\n\\n 13467\\n kevintestgroup222\\n 1\\n 1589016325\\n 1589016544\\n","errorExample":""}]', 'title' => '修改 ABTest 实验组', 'requestParamsDescription' => '**请求体**'."\n" .'| 字段 | 类型 | 是否必要 | 示例值 | 描述 |'."\n" .'| --- | --- | --- | --- | --- |'."\n" .'| name | String | 是 | "kevintest3" | 实验组名称 |', 'responseParamsDescription' => ' ', 'extraInfo' => ' ', ], 'ListABTestExperiments' => [ 'summary' => '列出实验清单。', 'path' => '/v4/openapi/app-groups/{appGroupIdentity}/scenes/{sceneId}/groups/{groupId}/experiments', 'methods' => [ 'get', ], 'schemes' => [ 'http', 'https', ], 'security' => [ [ 'AK' => [], ], ], 'operationType' => 'read', 'deprecated' => false, 'systemTags' => [ 'operationType' => 'list', 'riskType' => 'none', 'chargeType' => 'free', 'abilityTreeNodes' => [ 'FEATUREopensearchE07IML', ], ], 'parameters' => [ [ 'name' => 'appGroupIdentity', 'in' => 'path', 'schema' => [ 'description' => '应用名称', 'type' => 'string', 'required' => true, 'docRequired' => true, 'example' => '“my_app_group_name”', ], ], [ 'name' => 'sceneId', 'in' => 'path', 'schema' => [ 'description' => '场景ID', 'type' => 'integer', 'format' => 'int32', 'required' => true, 'docRequired' => true, 'maximum' => '999999999', 'minimum' => '-1', 'example' => '13467', ], ], [ 'name' => 'groupId', 'in' => 'path', 'schema' => [ 'description' => '组ID', 'type' => 'integer', 'format' => 'int32', 'required' => true, 'docRequired' => true, 'maximum' => '999999999', 'minimum' => '-1', 'example' => '20404', ], ], ], 'responses' => [ 200 => [ 'schema' => [ 'type' => 'object', 'properties' => [ 'requestId' => [ 'description' => '请求ID', 'type' => 'string', 'example' => 'D77D0DAF-790D-F5F5-A9C0-133738165014', ], 'result' => [ 'description' => '实验详情 '."\n" .'参考：[ABTestExperiment](~~173617~~)', 'type' => 'array', 'items' => [ 'type' => 'object', 'properties' => [ 'created' => [ 'description' => '创建时间', 'type' => 'integer', 'format' => 'int32', 'example' => '1588842080', ], 'params' => [ 'description' => '试验参数', 'type' => 'object', 'example' => '1', ], 'traffic' => [ 'description' => '实验分桶百分比'."\n" ."\n" .'取值范围：\\[0-100\\]', 'type' => 'integer', 'format' => 'int32', 'example' => '30', ], 'online' => [ 'description' => '实验状态'."\n" ."\n" .'- true 生效'."\n" .'- false 未生效', 'type' => 'boolean', 'example' => 'true', ], 'name' => [ 'description' => '组别名', 'type' => 'string', 'example' => 'test1', ], 'updated' => [ 'description' => '最后修改时间', 'type' => 'integer', 'format' => 'int32', 'example' => '1588842080', ], 'id' => [ 'description' => '实验ID', 'type' => 'string', 'example' => '12888', ], ], ], ], ], ], ], '5XX' => [ 'schema' => [ 'type' => 'object', 'properties' => [ 'code' => [ 'type' => 'string', ], 'message' => [ 'type' => 'string', ], 'requestId' => [ 'type' => 'string', ], 'httpCode' => [ 'type' => 'integer', 'format' => 'int32', ], ], ], ], ], 'responseDemo' => '[{"type":"json","example":"{\\n \\"requestId\\": \\"D77D0DAF-790D-F5F5-A9C0-133738165014\\",\\n \\"result\\": [\\n {\\n \\"created\\": 1588842080,\\n \\"params\\": 1,\\n \\"traffic\\": 30,\\n \\"online\\": true,\\n \\"name\\": \\"test1\\",\\n \\"updated\\": 1588842080,\\n \\"id\\": \\"12888\\"\\n }\\n ]\\n}","errorExample":""},{"type":"xml","example":"D77D0DAF-790D-F5F5-A9C0-133738165014\\n\\n 12888\\n test1\\n \\n default\\n \\n 1588842080\\n 1588842080\\n true\\n 30\\n","errorExample":""}]', 'title' => '列出实验清单', 'requestParamsDescription' => ' ', 'responseParamsDescription' => ' ', 'extraInfo' => ' ', ], 'CreateABTestExperiment' => [ 'summary' => '创建实验。', 'path' => '/v4/openapi/app-groups/{appGroupIdentity}/scenes/{sceneId}/groups/{groupId}/experiments', 'methods' => [ 'post', ], 'schemes' => [ 'http', 'https', ], 'security' => [ [ 'AK' => [], ], ], 'operationType' => 'write', 'deprecated' => false, 'systemTags' => [ 'operationType' => 'create', 'riskType' => 'none', 'chargeType' => 'free', 'abilityTreeNodes' => [ 'FEATUREopensearchE07IML', ], ], 'parameters' => [ [ 'name' => 'appGroupIdentity', 'in' => 'path', 'schema' => [ 'description' => '应用名称', 'type' => 'string', 'required' => true, 'docRequired' => true, 'example' => 'my_app_group_name', ], ], [ 'name' => 'sceneId', 'in' => 'path', 'schema' => [ 'description' => '场景ID', 'type' => 'integer', 'format' => 'int32', 'required' => true, 'docRequired' => true, 'maximum' => '999999999', 'minimum' => '-1', 'example' => '20404', ], ], [ 'name' => 'groupId', 'in' => 'path', 'schema' => [ 'description' => '组ID', 'type' => 'integer', 'format' => 'int32', 'required' => true, 'docRequired' => true, 'maximum' => '999999999', 'minimum' => '-1', 'example' => '13467', ], ], [ 'name' => 'dryRun', 'in' => 'query', 'schema' => [ 'description' => '是否校验入参数据合法性，默认false。'."\n" ."\n" .'取值：'."\n" ."\n" .'- **true**：只校验参数合法性。'."\n" ."\n" .'- **false**：校验参数合法性，创建归因配置。', 'type' => 'boolean', 'required' => false, 'example' => 'false', ], ], [ 'name' => 'body', 'in' => 'body', 'schema' => [ 'description' => '请求体', 'required' => false, '$ref' => '#/components/schemas/ABTestExperiment', ], ], ], 'responses' => [ 200 => [ 'schema' => [ 'type' => 'object', 'properties' => [ 'requestId' => [ 'description' => '请求ID', 'type' => 'string', 'example' => 'D77D0DAF-790D-F5F5-A9C0-133738165014', ], 'result' => [ 'description' => '实验详情', 'type' => 'object', 'properties' => [ 'created' => [ 'description' => '创建时间', 'type' => 'integer', 'format' => 'int32', 'example' => '0', ], 'params' => [ 'description' => '实验参数', 'type' => 'object', 'example' => '{"firstFormulaName": "default"}', ], 'traffic' => [ 'description' => '实验分桶百分比', 'type' => 'integer', 'format' => 'int32', 'example' => '30', ], 'online' => [ 'description' => '实验状态'."\n" .'- true 生效'."\n" .'- false 未生效', 'type' => 'boolean', 'example' => 'true', ], 'name' => [ 'description' => '实验别名', 'type' => 'string', 'example' => 'test3', ], 'updated' => [ 'description' => '最后修改时间', 'type' => 'integer', 'format' => 'int32', 'example' => '1589017861', ], 'id' => [ 'description' => '实验ID', 'type' => 'string', 'example' => '12889', ], ], ], ], ], ], '5XX' => [ 'schema' => [ 'type' => 'object', 'properties' => [ 'code' => [ 'type' => 'string', ], 'message' => [ 'type' => 'string', ], 'requestId' => [ 'type' => 'string', ], 'httpCode' => [ 'type' => 'integer', 'format' => 'int32', ], ], ], ], ], 'responseDemo' => '[{"type":"json","example":"{\\n \\"requestId\\": \\"D77D0DAF-790D-F5F5-A9C0-133738165014\\",\\n \\"result\\": {\\n \\"created\\": 0,\\n \\"params\\": {\\n \\"firstFormulaName\\": \\"default\\"\\n },\\n \\"traffic\\": 30,\\n \\"online\\": true,\\n \\"name\\": \\"test3\\",\\n \\"updated\\": 1589017861,\\n \\"id\\": \\"12889\\"\\n }\\n}","errorExample":""},{"type":"xml","example":"\\n 0\\n test3\\n true\\n 12889\\n \\n default\\n \\n 1589017861\\n 30\\n\\nD77D0DAF-790D-F5F5-A9C0-133738165014","errorExample":""}]', 'title' => '创建 ABTest 测试实验', 'requestParamsDescription' => '**请求体**'."\n" .'| 字段 | 类型 | 是否必要 | 示例值 | 描述 |'."\n" .'| --- | --- | --- | --- | --- |'."\n" .'| name | String | 是 | "my_test" | 实验名称 |'."\n" .'| traffic | Integer | 是 | 30 | 实验流量 |'."\n" .'| online | Boolean | 是 | true | 是否生效 |'."\n" .'| params | Object | 是 | {"firstFormulaName": "default"} | 实验配置，参考：[ABTestExperiment ](~~173617~~)|', 'responseParamsDescription' => ' ', 'extraInfo' => ' ', ], 'DescribeABTestExperiment' => [ 'summary' => '获取实验详情。', 'path' => '/v4/openapi/app-groups/{appGroupIdentity}/scenes/{sceneId}/groups/{groupId}/experiments/{experimentId}', 'methods' => [ 'get', ], 'schemes' => [ 'http', 'https', ], 'security' => [ [ 'AK' => [], ], ], 'operationType' => 'read', 'deprecated' => false, 'systemTags' => [ 'operationType' => 'get', 'riskType' => 'none', 'chargeType' => 'free', 'abilityTreeNodes' => [ 'FEATUREopensearchE07IML', ], ], 'parameters' => [ [ 'name' => 'appGroupIdentity', 'in' => 'path', 'schema' => [ 'description' => '应用名称', 'type' => 'string', 'required' => true, 'docRequired' => true, 'example' => 'my_app_group_name', ], ], [ 'name' => 'sceneId', 'in' => 'path', 'schema' => [ 'description' => '场景ID', 'type' => 'integer', 'format' => 'int32', 'required' => true, 'docRequired' => true, 'maximum' => '999999999', 'minimum' => '-1', 'example' => '20404', ], ], [ 'name' => 'groupId', 'in' => 'path', 'schema' => [ 'description' => '组ID', 'type' => 'integer', 'format' => 'int32', 'required' => true, 'docRequired' => true, 'maximum' => '999999999', 'minimum' => '-1', 'example' => '13467', ], ], [ 'name' => 'experimentId', 'in' => 'path', 'schema' => [ 'description' => '实验ID', 'type' => 'integer', 'format' => 'int32', 'required' => true, 'docRequired' => true, 'maximum' => '999999999', 'minimum' => '-1', 'example' => '12889', ], ], ], 'responses' => [ 200 => [ 'schema' => [ 'type' => 'object', 'properties' => [ 'requestId' => [ 'description' => '请求ID', 'type' => 'string', 'example' => 'D77D0DAF-790D-F5F5-A9C0-133738165014', ], 'result' => [ 'description' => '实验详情', 'type' => 'object', 'properties' => [ 'created' => [ 'description' => '创建时间', 'type' => 'integer', 'format' => 'int32', 'example' => '1588842080', ], 'traffic' => [ 'description' => '实验分桶百分比', 'type' => 'integer', 'format' => 'int32', 'example' => '30', ], 'online' => [ 'description' => '实验状态'."\n" .'- true 生效'."\n" .'- false 未生效', 'type' => 'boolean', 'example' => 'true', ], 'name' => [ 'description' => '实验别名', 'type' => 'string', 'example' => 'test1', ], 'updated' => [ 'description' => '最后修改时间', 'type' => 'integer', 'format' => 'int32', 'example' => '1588842080', ], 'id' => [ 'description' => '实验ID', 'type' => 'string', 'example' => '12888', ], 'params' => [ 'description' => '试验参数', 'type' => 'object', 'properties' => [ 'first_formula_name' => [ 'description' => '粗排策略名', 'type' => 'string', 'example' => 'default', ], ], ], ], ], ], ], ], '5XX' => [ 'schema' => [ 'type' => 'object', 'properties' => [ 'code' => [ 'type' => 'string', ], 'message' => [ 'type' => 'string', ], 'requestId' => [ 'type' => 'string', ], 'httpCode' => [ 'type' => 'integer', 'format' => 'int32', ], ], ], ], ], 'responseDemo' => '[{"type":"json","example":"{\\n \\"requestId\\": \\"D77D0DAF-790D-F5F5-A9C0-133738165014\\",\\n \\"result\\": {\\n \\"created\\": 1588842080,\\n \\"traffic\\": 30,\\n \\"online\\": true,\\n \\"name\\": \\"test1\\",\\n \\"updated\\": 1588842080,\\n \\"id\\": \\"12888\\",\\n \\"params\\": {\\n \\"first_formula_name\\": \\"default\\"\\n }\\n }\\n}","errorExample":""},{"type":"xml","example":"D77D0DAF-790D-F5F5-A9C0-133738165014\\n\\n 12888\\n test1\\n \\n default\\n \\n 1588842080\\n 1588842080\\n true\\n 30\\n","errorExample":""}]', 'title' => '获取 ABTest 实验详情', 'requestParamsDescription' => ' ', 'responseParamsDescription' => ' ', 'extraInfo' => ' ', ], 'UpdateABTestExperiment' => [ 'summary' => '修改实验参数。', 'path' => '/v4/openapi/app-groups/{appGroupIdentity}/scenes/{sceneId}/groups/{groupId}/experiments/{experimentId}', 'methods' => [ 'put', ], 'schemes' => [ 'http', 'https', ], 'security' => [ [ 'AK' => [], ], ], 'operationType' => 'write', 'deprecated' => false, 'systemTags' => [ 'operationType' => 'update', 'riskType' => 'none', 'chargeType' => 'free', 'abilityTreeNodes' => [ 'FEATUREopensearchE07IML', ], ], 'parameters' => [ [ 'name' => 'appGroupIdentity', 'in' => 'path', 'schema' => [ 'description' => '应用名称', 'type' => 'string', 'required' => true, 'docRequired' => true, 'example' => '“my_app_group_name”', ], ], [ 'name' => 'sceneId', 'in' => 'path', 'schema' => [ 'description' => '场景ID', 'type' => 'integer', 'format' => 'int32', 'required' => true, 'docRequired' => true, 'maximum' => '999999999', 'minimum' => '-1', 'example' => '20404', ], ], [ 'name' => 'groupId', 'in' => 'path', 'schema' => [ 'description' => '组ID', 'type' => 'integer', 'format' => 'int32', 'required' => true, 'docRequired' => true, 'maximum' => '999999999', 'minimum' => '-1', 'example' => '13467', ], ], [ 'name' => 'experimentId', 'in' => 'path', 'schema' => [ 'description' => '实验ID', 'type' => 'integer', 'format' => 'int32', 'required' => true, 'docRequired' => true, 'maximum' => '999999999', 'minimum' => '-1', 'example' => '12889', ], ], [ 'name' => 'dryRun', 'in' => 'query', 'schema' => [ 'description' => '是否只预检此次请求，取值含义如下：'."\n" ."\n" .'- true：发送检查请求，不会创建终端节点。检查项包括AccessKey是否有效、RAM用户的授权情况和是否填写了必需参数。'."\n" .'- false（默认值）：立即触发创建终端节点。', 'type' => 'boolean', 'required' => false, 'example' => 'true', ], ], [ 'name' => 'body', 'in' => 'body', 'schema' => [ 'description' => '请求体，参考：[ABTestExperiment](~~173617~~)', 'required' => false, '$ref' => '#/components/schemas/ABTestExperiment', ], ], ], 'responses' => [ 200 => [ 'schema' => [ 'type' => 'object', 'properties' => [ 'requestId' => [ 'description' => '请求ID', 'type' => 'string', 'example' => 'D77D0DAF-790D-F5F5-A9C0-133738165014', ], 'result' => [ 'description' => '实验详情', 'type' => 'object', 'properties' => [ 'created' => [ 'description' => '创建时间', 'type' => 'integer', 'format' => 'int32', 'example' => '1588842080', ], 'params' => [ 'description' => '试验参数', 'type' => 'object', 'example' => '{}', ], 'traffic' => [ 'description' => '实验分桶百分比'."\n" .'取值范围：0-100', 'type' => 'integer', 'format' => 'int32', 'example' => '30', ], 'online' => [ 'description' => '实验状态'."\n" .'- true 生效'."\n" .'- false 未生效', 'type' => 'boolean', 'example' => 'true', ], 'name' => [ 'description' => '实验别名', 'type' => 'string', 'example' => 'test1', ], 'updated' => [ 'description' => '最后修改时间', 'type' => 'integer', 'format' => 'int32', 'example' => '1588842080', ], 'id' => [ 'description' => '实验ID', 'type' => 'string', 'example' => '12888', ], ], ], ], ], ], '5XX' => [ 'schema' => [ 'type' => 'object', 'properties' => [ 'code' => [ 'type' => 'string', ], 'message' => [ 'type' => 'string', ], 'requestId' => [ 'type' => 'string', ], 'httpCode' => [ 'type' => 'integer', 'format' => 'int32', ], ], ], ], ], 'responseDemo' => '[{"type":"json","example":"{\\n \\"requestId\\": \\"D77D0DAF-790D-F5F5-A9C0-133738165014\\",\\n \\"result\\": {\\n \\"created\\": 1588842080,\\n \\"params\\": {},\\n \\"traffic\\": 30,\\n \\"online\\": true,\\n \\"name\\": \\"test1\\",\\n \\"updated\\": 1588842080,\\n \\"id\\": \\"12888\\"\\n }\\n}","errorExample":""},{"type":"xml","example":"D77D0DAF-790D-F5F5-A9C0-133738165014\\n\\n 12889\\n test333\\n \\n default\\n \\n 1589017860\\n 1589018211\\n true\\n 40\\n","errorExample":""}]', 'title' => '修改实验参数', 'requestParamsDescription' => '**请求体**'."\n" .'| 字段 | 类型 | 是否必要 | 示例值 | 描述 |'."\n" .'| --- | --- | --- | --- | --- |'."\n" .'| name | String | 否 | "my_test" | 实验名称 |'."\n" .'| traffic | Integer | 否 | 30 | 实验流量 |'."\n" .'| online | Boolean | 否 | true | 是否生效 |'."\n" .'| params | Object | 否 | {"firstFormulaName": "default"} | 实验配置 |'."\n" ."\n", 'responseParamsDescription' => ' ', 'extraInfo' => ' ', ], 'DeleteABTestExperiment' => [ 'summary' => '删除实验。', 'path' => '/v4/openapi/app-groups/{appGroupIdentity}/scenes/{sceneId}/groups/{groupId}/experiments/{experimentId}', 'methods' => [ 'delete', ], 'schemes' => [ 'http', 'https', ], 'security' => [ [ 'AK' => [], ], ], 'operationType' => 'write', 'deprecated' => false, 'systemTags' => [ 'operationType' => 'delete', 'riskType' => 'none', 'chargeType' => 'free', 'abilityTreeNodes' => [ 'FEATUREopensearchE07IML', ], ], 'parameters' => [ [ 'name' => 'appGroupIdentity', 'in' => 'path', 'schema' => [ 'description' => '应用名称', 'type' => 'string', 'required' => true, 'docRequired' => true, 'example' => 'my_app_group_name', ], ], [ 'name' => 'sceneId', 'in' => 'path', 'schema' => [ 'description' => '场景ID', 'type' => 'integer', 'format' => 'int32', 'required' => true, 'docRequired' => true, 'maximum' => '999999999', 'minimum' => '-1', 'example' => '20404', ], ], [ 'name' => 'groupId', 'in' => 'path', 'schema' => [ 'description' => '组ID', 'type' => 'integer', 'format' => 'int32', 'required' => true, 'docRequired' => true, 'maximum' => '999999999', 'minimum' => '-1', 'example' => '13467', ], ], [ 'name' => 'experimentId', 'in' => 'path', 'schema' => [ 'description' => '实验ID', 'type' => 'integer', 'format' => 'int32', 'required' => true, 'docRequired' => true, 'maximum' => '999999999', 'minimum' => '-1', 'example' => '12889', ], ], ], 'responses' => [ 200 => [ 'schema' => [ 'type' => 'object', 'properties' => [ 'result' => [ 'description' => '返回结果', 'type' => 'object', 'example' => '{}', ], 'requestId' => [ 'description' => '请求ID', 'type' => 'string', 'example' => 'ABCDEFGH', ], ], ], ], '5XX' => [ 'schema' => [ 'type' => 'object', 'properties' => [ 'code' => [ 'type' => 'string', ], 'message' => [ 'type' => 'string', ], 'requestId' => [ 'type' => 'string', ], 'httpCode' => [ 'type' => 'integer', 'format' => 'int32', ], ], ], ], ], 'responseDemo' => '[{"type":"json","example":"{\\n \\"result\\": {},\\n \\"requestId\\": \\"ABCDEFGH\\"\\n}","errorExample":""},{"type":"xml","example":"D77D0DAF-790D-F5F5-A9C0-133738165014","errorExample":""}]', 'title' => '删除 ABTest 实验', 'requestParamsDescription' => ' ', 'responseParamsDescription' => ' ', 'extraInfo' => ' ', ], 'ListABTestFixedFlowDividers' => [ 'summary' => '获取白名单清单。', 'path' => '/v4/openapi/app-groups/{appGroupIdentity}/scenes/{sceneId}/groups/{groupId}/experiments/{experimentId}/fixed-flow-dividers', 'methods' => [ 'get', ], 'schemes' => [ 'http', 'https', ], 'security' => [ [ 'AK' => [], ], ], 'operationType' => 'read', 'deprecated' => false, 'systemTags' => [ 'operationType' => 'none', 'riskType' => 'none', 'chargeType' => 'free', 'abilityTreeNodes' => [ 'FEATUREopensearchE07IML', ], ], 'parameters' => [ [ 'name' => 'appGroupIdentity', 'in' => 'path', 'schema' => [ 'description' => '应用名称', 'type' => 'string', 'required' => true, 'docRequired' => true, 'example' => '“my_app_group_name”', ], ], [ 'name' => 'sceneId', 'in' => 'path', 'schema' => [ 'description' => '场景ID', 'type' => 'integer', 'format' => 'int32', 'required' => true, 'docRequired' => true, 'maximum' => '999999999', 'minimum' => '-1', 'example' => '12889', ], ], [ 'name' => 'groupId', 'in' => 'path', 'schema' => [ 'description' => '组ID', 'type' => 'integer', 'format' => 'int32', 'required' => true, 'docRequired' => true, 'maximum' => '999999999', 'minimum' => '-1', 'example' => '13467', ], ], [ 'name' => 'experimentId', 'in' => 'path', 'schema' => [ 'description' => '实验ID', 'type' => 'integer', 'format' => 'int32', 'required' => true, 'docRequired' => true, 'maximum' => '999999999', 'minimum' => '-1', 'example' => '20404', ], ], ], 'responses' => [ 200 => [ 'schema' => [ 'type' => 'object', 'properties' => [ 'requestId' => [ 'description' => '请求ID', 'type' => 'string', 'example' => 'D77D0DAF-790D-F5F5-A9C0-133738165014', ], 'result' => [ 'type' => 'array', 'items' => [ 'description' => '白名单', 'type' => 'string', 'example' => '[ "D77D0DAF", "133738165014" ]', ], ], ], ], ], '5XX' => [ 'schema' => [ 'type' => 'object', 'properties' => [ 'code' => [ 'type' => 'string', ], 'message' => [ 'type' => 'string', ], 'requestId' => [ 'type' => 'string', ], 'httpCode' => [ 'type' => 'integer', 'format' => 'int32', ], ], ], ], ], 'responseDemo' => '[{"type":"json","example":"{\\n \\"requestId\\": \\"D77D0DAF-790D-F5F5-A9C0-133738165014\\",\\n \\"result\\": [\\n \\"[ \\\\\\"D77D0DAF\\\\\\", \\\\\\"133738165014\\\\\\" ]\\"\\n ]\\n}","errorExample":""},{"type":"xml","example":"D77D0DAF-790D-F5F5-A9C0-133738165014\\nD77D0DAF\\n133738165014","errorExample":""}]', 'title' => '获取 ABTest 白名单清单', 'requestParamsDescription' => ' ', 'responseParamsDescription' => ' ', 'extraInfo' => ' ', ], 'UpdateABTestFixedFlowDividers' => [ 'summary' => '更新白名单数据。', 'path' => '/v4/openapi/app-groups/{appGroupIdentity}/scenes/{sceneId}/groups/{groupId}/experiments/{experimentId}/fixed-flow-dividers', 'methods' => [ 'put', ], 'schemes' => [ 'http', 'https', ], 'security' => [ [ 'AK' => [], ], ], 'operationType' => 'write', 'deprecated' => false, 'systemTags' => [ 'operationType' => 'update', 'riskType' => 'none', 'chargeType' => 'free', 'abilityTreeNodes' => [ 'FEATUREopensearchE07IML', ], ], 'parameters' => [ [ 'name' => 'appGroupIdentity', 'in' => 'path', 'schema' => [ 'description' => '应用名称', 'type' => 'string', 'required' => true, 'docRequired' => true, 'example' => '“my_app_group_name”', ], ], [ 'name' => 'sceneId', 'in' => 'path', 'schema' => [ 'description' => '场景ID', 'type' => 'integer', 'format' => 'int32', 'required' => true, 'docRequired' => true, 'maximum' => '999999999', 'minimum' => '-1', 'example' => '20404', ], ], [ 'name' => 'groupId', 'in' => 'path', 'schema' => [ 'description' => '组ID', 'type' => 'integer', 'format' => 'int32', 'required' => true, 'docRequired' => true, 'maximum' => '999999999', 'minimum' => '-1', 'example' => '13467', ], ], [ 'name' => 'experimentId', 'in' => 'path', 'schema' => [ 'description' => '实验ID', 'type' => 'integer', 'format' => 'int32', 'required' => true, 'docRequired' => true, 'maximum' => '999999999', 'minimum' => '-1', 'example' => '12889', ], ], [ 'name' => 'body', 'in' => 'body', 'style' => 'json', 'schema' => [ 'description' => '请求体', 'type' => 'array', 'items' => [ 'description' => '白名单数据', 'type' => 'string', 'required' => false, 'example' => '"D77D0DAF" ', ], 'required' => false, 'maxItems' => 100, ], ], ], 'responses' => [ 200 => [ 'schema' => [ 'type' => 'object', 'properties' => [ 'requestId' => [ 'description' => '请求ID', 'type' => 'string', 'example' => 'D77D0DAF-790D-F5F5-A9C0-133738165014', ], 'result' => [ 'description' => '返回结果', 'type' => 'array', 'items' => [ 'description' => '白名单', 'type' => 'string', 'example' => '[ "D77D0DAF", "133738165014" ]', ], ], ], ], ], '5XX' => [ 'schema' => [ 'type' => 'object', 'properties' => [ 'code' => [ 'type' => 'string', ], 'message' => [ 'type' => 'string', ], 'requestId' => [ 'type' => 'string', ], 'httpCode' => [ 'type' => 'integer', 'format' => 'int32', ], ], ], ], ], 'responseDemo' => '[{"type":"json","example":"{\\n \\"requestId\\": \\"D77D0DAF-790D-F5F5-A9C0-133738165014\\",\\n \\"result\\": [\\n \\"[ \\\\\\"D77D0DAF\\\\\\", \\\\\\"133738165014\\\\\\" ]\\"\\n ]\\n}","errorExample":""},{"type":"xml","example":"D77D0DAF-790D-F5F5-A9C0-133738165014\\nD77D0DAF\\n133738165014","errorExample":""}]', 'title' => '更新 ABTest 白名单数据', 'requestParamsDescription' => "\n" .'**路径参数**'."\n" .'| 字段 | 类型 | 是否必要 | 示例值 | 描述 |'."\n" .'| --- | --- | --- | --- | --- |'."\n" .'| [] | String | 是 | "D77D0DAF" | 白名单数据 |'."\n", 'responseParamsDescription' => ' ', 'extraInfo' => ' ', ], 'ListFirstRanks' => [ 'summary' => '获取指定OpenSearch应用版本的粗排配置列表。', 'path' => '/v4/openapi/app-groups/{appGroupIdentity}/apps/{appId}/first-ranks', 'methods' => [ 'get', ], 'schemes' => [ 'http', 'https', ], 'security' => [ [ 'AK' => [], ], ], 'operationType' => 'read', 'deprecated' => false, 'systemTags' => [ 'operationType' => 'list', 'riskType' => 'none', 'chargeType' => 'free', 'abilityTreeNodes' => [ 'FEATUREopensearchN8M8WS', 'FEATUREopensearchH8SRT8', ], ], 'parameters' => [ [ 'name' => 'appGroupIdentity', 'in' => 'path', 'schema' => [ 'description' => '应用名称', 'type' => 'string', 'required' => true, 'docRequired' => true, 'example' => 'my_app_group_name', ], ], [ 'name' => 'appId', 'in' => 'path', 'schema' => [ 'description' => '版本号', 'type' => 'integer', 'format' => 'int32', 'required' => true, 'docRequired' => true, 'example' => '110157886', ], ], ], 'responses' => [ 200 => [ 'schema' => [ 'description' => '响应体', 'type' => 'object', 'properties' => [ 'requestId' => [ 'description' => '请求ID', 'type' => 'string', 'example' => '0A6EB64B-B4C8-CF02-810F-E660812972FF', ], 'result' => [ 'description' => '粗排表达式信息'."\n" ."\n" .'参考：[FirstRank](~~170007~~)', 'type' => 'array', 'items' => [ 'description' => '结果体', 'type' => 'object', 'properties' => [ 'created' => [ 'description' => '创建时间', 'type' => 'integer', 'format' => 'int32', 'example' => '0', ], 'active' => [ 'description' => '是否是默认表达式', 'type' => 'boolean', 'example' => 'true', ], 'description' => [ 'description' => '描述', 'type' => 'string', 'example' => '""', ], 'updated' => [ 'description' => '更新时间', 'type' => 'integer', 'format' => 'int32', 'example' => '0', ], 'name' => [ 'description' => '名称', 'type' => 'string', 'example' => 'default', ], 'meta' => [ 'description' => '表达式信息', 'type' => 'array', 'items' => [ 'description' => '信息体', 'type' => 'object', 'properties' => [ 'arg' => [ 'description' => '表达式函数参数'."\n" ."\n" .'参考：[基础排序](~~180765~~)', 'type' => 'string', 'example' => '""', ], 'attribute' => [ 'description' => '属性，算分特征或搜索字段'."\n" ."\n" .'可用的算分特征，参考：[基础排序](~~180765~~)', 'type' => 'string', 'example' => 'static_bm25()', ], 'weight' => [ 'description' => '权重'."\n" .'取值范围：-100000～100000非0值', 'type' => 'integer', 'format' => 'int32', 'example' => '1', ], ], 'example' => '[]', ], 'example' => '[]', ], ], 'example' => '{}', ], 'example' => '[]', ], ], 'example' => '{}', ], ], '5XX' => [ 'schema' => [ 'type' => 'object', 'properties' => [ 'code' => [ 'type' => 'string', ], 'requestId' => [ 'type' => 'string', ], 'message' => [ 'type' => 'string', ], 'httpCode' => [ 'type' => 'integer', 'format' => 'int32', ], ], ], ], ], 'responseDemo' => '[{"type":"json","example":"{\\n \\"requestId\\": \\"0A6EB64B-B4C8-CF02-810F-E660812972FF\\",\\n \\"result\\": [\\n {\\n \\"created\\": 0,\\n \\"active\\": true,\\n \\"description\\": \\"\\\\\\"\\\\\\"\\",\\n \\"updated\\": 0,\\n \\"name\\": \\"default\\",\\n \\"meta\\": [\\n {\\n \\"arg\\": \\"\\\\\\"\\\\\\"\\",\\n \\"attribute\\": \\"static_bm25()\\",\\n \\"weight\\": 1\\n }\\n ]\\n }\\n ]\\n}","errorExample":""},{"type":"xml","example":"0A6EB64B-B4C8-CF02-810F-E660812972FF\\n\\n default\\n \\n true\\n STRUCT\\n \\n static_bm25()\\n \\n 1\\n \\n 0\\n 0\\n","errorExample":""}]', 'title' => '获取指定应用版本的粗排配置列表', ], 'CreateFirstRank' => [ 'summary' => '创建一个OpenSearch应用版本的粗排表达式配置。当 dryRun=true 时，表示进行粗排表达式校验，默认 dryRun不传为false。', 'path' => '/v4/openapi/app-groups/{appGroupIdentity}/apps/{appId}/first-ranks', 'methods' => [ 'post', ], 'schemes' => [ 'http', 'https', ], 'security' => [ [ 'AK' => [], ], ], 'operationType' => 'write', 'deprecated' => false, 'systemTags' => [ 'operationType' => 'create', 'riskType' => 'none', 'chargeType' => 'free', 'abilityTreeNodes' => [ 'FEATUREopensearchN8M8WS', 'FEATUREopensearchH8SRT8', ], ], 'parameters' => [ [ 'name' => 'dryRun', 'in' => 'query', 'schema' => [ 'description' => '是否为空运行请求', 'type' => 'boolean', 'required' => false, 'example' => 'true', ], ], [ 'name' => 'appGroupIdentity', 'in' => 'path', 'schema' => [ 'description' => '应用名称', 'type' => 'string', 'required' => true, 'docRequired' => true, 'example' => 'my_app_group_name', ], ], [ 'name' => 'appId', 'in' => 'path', 'schema' => [ 'description' => '版本号', 'type' => 'integer', 'format' => 'int32', 'required' => true, 'docRequired' => true, 'example' => '110157886', ], ], [ 'name' => 'body', 'in' => 'body', 'schema' => [ 'description' => '请求体，基础排序信息', 'required' => false, '$ref' => '#/components/schemas/FirstRank', ], ], ], 'responses' => [ 200 => [ 'schema' => [ 'type' => 'object', 'properties' => [ 'requestId' => [ 'description' => '请求ID', 'type' => 'string', 'example' => '0A6EB64B-B4C8-CF02-810F-E660812972FF', ], 'result' => [ 'description' => '粗排表达式信息', 'type' => 'object', 'properties' => [ 'active' => [ 'description' => '是否是默认表达式', 'type' => 'boolean', 'example' => 'true', ], 'name' => [ 'description' => '名称', 'type' => 'string', 'example' => 'default', ], 'meta' => [ 'description' => '表达式信息', 'type' => 'array', 'items' => [ 'type' => 'object', 'properties' => [ 'arg' => [ 'description' => '表达式函数参数', 'type' => 'string', 'example' => '1', ], 'attribute' => [ 'description' => '属性，算分特征或搜索字段', 'type' => 'string', 'example' => 'static_bm25()', ], 'weight' => [ 'description' => '权重'."\n" .'取值范围：-100000～100000非0值', 'type' => 'number', 'format' => 'float', 'example' => '10', ], ], ], ], ], ], ], ], ], '5XX' => [ 'schema' => [ 'type' => 'object', 'properties' => [ 'code' => [ 'type' => 'string', ], 'requestId' => [ 'type' => 'string', ], 'message' => [ 'type' => 'string', ], ], ], ], ], 'responseDemo' => '[{"type":"json","example":"{\\n \\"requestId\\": \\"0A6EB64B-B4C8-CF02-810F-E660812972FF\\",\\n \\"result\\": {\\n \\"active\\": true,\\n \\"name\\": \\"default\\",\\n \\"meta\\": [\\n {\\n \\"arg\\": \\"1\\",\\n \\"attribute\\": \\"static_bm25()\\",\\n \\"weight\\": 10\\n }\\n ]\\n }\\n}","errorExample":""},{"type":"xml","example":"0A6EB64B-B4C8-CF02-810F-E660812972FF\\n\\n general_default\\n \\n false\\n STRUCT\\n \\n static_bm25()\\n \\n 2\\n \\n \\n hot_score\\n \\n 0.000001\\n \\n 0\\n 0\\n","errorExample":""}]', 'title' => '创建一个应用版本的粗排表达式配置', 'requestParamsDescription' => '**请求体**'."\n" .'| 字段 | 类型 | 是否必要 | 示例值 | 描述 |'."\n" .'| --- | --- | --- | --- | --- |'."\n" .'| name | String | 是 | "test" | 表达式名称 |'."\n" .'| type | String | 是 | "STRUCT" | 表达式类型
- STRUCT 结构化，默认值
- STRING 自定义公式 |'."\n" .'| meta| Array 或 String| 是 | | 表达式信息 |'."\n" .'| description | String | 否 | "my_test" | 描述 |'."\n" .'| active | Boolean | 否 | true | 是否是默认表达式 |', 'responseParamsDescription' => ' ', 'extraInfo' => ' ', ], 'DescribeFirstRank' => [ 'summary' => '查看一个 OpenSearch 应用版本的粗排表达式配置。', 'path' => '/v4/openapi/app-groups/{appGroupIdentity}/apps/{appId}/first-ranks/{name}', 'methods' => [ 'get', ], 'schemes' => [ 'http', 'https', ], 'security' => [ [ 'AK' => [], ], ], 'operationType' => 'read', 'deprecated' => false, 'systemTags' => [ 'operationType' => 'get', 'riskType' => 'none', 'chargeType' => 'free', 'abilityTreeNodes' => [ 'FEATUREopensearchN8M8WS', 'FEATUREopensearchH8SRT8', ], ], 'parameters' => [ [ 'name' => 'appGroupIdentity', 'in' => 'path', 'schema' => [ 'description' => '应用名称', 'type' => 'string', 'required' => true, 'docRequired' => true, 'example' => 'my_app_group_name', ], ], [ 'name' => 'appId', 'in' => 'path', 'schema' => [ 'description' => '版本号', 'type' => 'integer', 'format' => 'int32', 'required' => true, 'docRequired' => true, 'example' => '110157886', ], ], [ 'name' => 'name', 'in' => 'path', 'schema' => [ 'description' => '粗排表达式名称', 'type' => 'string', 'required' => true, 'docRequired' => true, 'example' => 'test', ], ], ], 'responses' => [ 200 => [ 'schema' => [ 'type' => 'object', 'properties' => [ 'requestId' => [ 'description' => '请求ID', 'type' => 'string', 'example' => '0A6EB64B-B4C8-CF02-810F-E660812972FF', ], 'result' => [ 'description' => '粗排表达式信息', 'type' => 'object', 'properties' => [ 'description' => [ 'description' => '描述', 'type' => 'string', 'example' => '-', ], 'active' => [ 'description' => '是否是默认表达式', 'type' => 'boolean', 'example' => 'false', ], 'name' => [ 'description' => '名称', 'type' => 'string', 'example' => 'ar_wear_edit_time', ], 'meta' => [ 'description' => '表达式信息', 'type' => 'array', 'items' => [ 'type' => 'object', 'properties' => [ 'arg' => [ 'description' => '表达式函数参数', 'type' => 'string', 'example' => 'ar_edit_time', ], 'attribute' => [ 'description' => '属性，算分特征或搜索字段', 'type' => 'string', 'example' => 'timeliness_ms()', ], 'weight' => [ 'description' => '权重'."\n" .'取值范围：-100000～100000非0值', 'type' => 'number', 'format' => 'float', 'example' => '1', ], ], ], ], ], ], ], ], ], '5XX' => [ 'schema' => [ 'type' => 'object', 'properties' => [ 'code' => [ 'type' => 'string', ], 'requestId' => [ 'type' => 'string', ], 'message' => [ 'type' => 'string', ], ], ], ], ], 'responseDemo' => '[{"type":"json","example":"{\\n \\"requestId\\": \\"0A6EB64B-B4C8-CF02-810F-E660812972FF\\",\\n \\"result\\": {\\n \\"description\\": \\"-\\",\\n \\"active\\": false,\\n \\"name\\": \\"ar_wear_edit_time\\",\\n \\"meta\\": [\\n {\\n \\"arg\\": \\"ar_edit_time\\",\\n \\"attribute\\": \\"timeliness_ms()\\",\\n \\"weight\\": 1\\n }\\n ]\\n }\\n}","errorExample":""},{"type":"xml","example":"0A6EB64B-B4C8-CF02-810F-E660812972FF\\n\\n ar_wear_edit_time\\n STRUCT\\n \\n timeliness_ms()\\n ar_edit_time\\n 1\\n \\n \\n false\\n 0\\n 0\\n","errorExample":""}]', 'title' => '查看一个应用版本的粗排表达式配置', 'requestParamsDescription' => ' ', 'responseParamsDescription' => ' ', 'extraInfo' => ' ', ], 'RemoveFirstRank' => [ 'summary' => '删除指定 OpenSearch 应用版本的粗排配置。', 'path' => '/v4/openapi/app-groups/{appGroupIdentity}/apps/{appId}/first-ranks/{name}', 'methods' => [ 'delete', ], 'schemes' => [ 'http', 'https', ], 'security' => [ [ 'AK' => [], ], ], 'operationType' => 'readAndWrite', 'deprecated' => false, 'systemTags' => [ 'operationType' => 'delete', 'riskType' => 'none', 'chargeType' => 'free', 'abilityTreeNodes' => [ 'FEATUREopensearchN8M8WS', 'FEATUREopensearchH8SRT8', ], ], 'parameters' => [ [ 'name' => 'appGroupIdentity', 'in' => 'path', 'schema' => [ 'description' => '应用名称', 'type' => 'string', 'required' => true, 'docRequired' => true, 'example' => '“my_app_group_name”', ], ], [ 'name' => 'appId', 'in' => 'path', 'schema' => [ 'description' => '版本号', 'type' => 'integer', 'format' => 'int32', 'required' => true, 'docRequired' => true, 'example' => '110157886', ], ], [ 'name' => 'name', 'in' => 'path', 'schema' => [ 'description' => '粗排表达式名称', 'type' => 'string', 'required' => true, 'docRequired' => true, 'example' => '“test”', ], ], ], 'responses' => [ 200 => [ 'schema' => [ 'type' => 'object', 'properties' => [ 'requestId' => [ 'description' => '请求ID', 'type' => 'string', 'example' => 'E676FAB6-A0AC-64D9-F9D7-D0D33C930CFF', ], 'result' => [ 'description' => '粗排表达式信息', 'type' => 'object', 'properties' => [ 'description' => [ 'description' => '描述', 'type' => 'string', 'example' => '""', ], 'active' => [ 'description' => '是否是默认表达式', 'type' => 'boolean', 'example' => 'true', ], 'name' => [ 'description' => '名称', 'type' => 'string', 'example' => 'default', ], 'meta' => [ 'description' => '表达式信息', 'type' => 'array', 'items' => [ 'type' => 'object', 'properties' => [ 'arg' => [ 'description' => '表达式函数参数'."\n" .'参考：[基础排序](~~170007~~)', 'type' => 'string', 'example' => '""', ], 'attribute' => [ 'description' => '属性，指算分特征或搜索字段，'."\n" .'可用的算分特征，参考：[基础排序](~~170007~~)', 'type' => 'string', 'example' => 'static_bm25()', ], 'weight' => [ 'description' => '权重'."\n" .'取值范围：-100000～100000非0值', 'type' => 'number', 'format' => 'float', 'example' => '10', ], ], ], ], ], ], ], ], ], '5XX' => [ 'schema' => [ 'type' => 'object', 'properties' => [ 'code' => [ 'type' => 'string', ], 'requestId' => [ 'type' => 'string', ], 'message' => [ 'type' => 'string', ], 'httpCode' => [ 'type' => 'integer', 'format' => 'int32', ], ], ], ], ], 'responseDemo' => '[{"type":"json","example":"{\\n \\"requestId\\": \\"E676FAB6-A0AC-64D9-F9D7-D0D33C930CFF\\",\\n \\"result\\": {\\n \\"description\\": \\"\\\\\\"\\\\\\"\\",\\n \\"active\\": true,\\n \\"name\\": \\"default\\",\\n \\"meta\\": [\\n {\\n \\"arg\\": \\"\\\\\\"\\\\\\"\\",\\n \\"attribute\\": \\"static_bm25()\\",\\n \\"weight\\": 10\\n }\\n ]\\n }\\n}","errorExample":""},{"type":"xml","example":"E676FAB6-A0AC-64D9-F9D7-D0D33C930CFF\\n\\n test2\\n \\n false\\n STRUCT\\n \\n timeliness()\\n hid\\n 1\\n \\n 1587708467\\n 1587708467\\n","errorExample":""}]', 'title' => '删除粗排规则', 'requestParamsDescription' => ' ', 'responseParamsDescription' => ' ', ], 'ModifyFirstRank' => [ 'summary' => '修改一个 OpenSearch 应用版本的粗排表达式配置当 dryRun=true 时，表示修改后的粗排表达式进行校验，默认 dryRun 不传为 false。', 'path' => '/v4/openapi/app-groups/{appGroupIdentity}/apps/{appId}/first-ranks/{name}', 'methods' => [ 'put', ], 'schemes' => [ 'http', 'https', ], 'security' => [ [ 'AK' => [], ], ], 'operationType' => 'write', 'deprecated' => false, 'systemTags' => [ 'operationType' => 'update', 'riskType' => 'none', 'chargeType' => 'free', 'abilityTreeNodes' => [ 'FEATUREopensearchN8M8WS', 'FEATUREopensearchH8SRT8', ], ], 'parameters' => [ [ 'name' => 'dryRun', 'in' => 'query', 'schema' => [ 'description' => '是否为空运行请求', 'type' => 'boolean', 'required' => false, 'example' => 'true', ], ], [ 'name' => 'appGroupIdentity', 'in' => 'path', 'schema' => [ 'description' => '应用名称', 'type' => 'string', 'required' => true, 'docRequired' => true, 'example' => 'my_app_group_name', ], ], [ 'name' => 'appId', 'in' => 'path', 'schema' => [ 'description' => '版本号', 'type' => 'integer', 'format' => 'int32', 'required' => true, 'docRequired' => true, 'example' => '110157886', ], ], [ 'name' => 'name', 'in' => 'path', 'schema' => [ 'description' => '粗排表达式名称', 'type' => 'string', 'required' => true, 'docRequired' => true, 'example' => 'test', ], ], [ 'name' => 'body', 'in' => 'body', 'schema' => [ 'description' => '请求体', 'required' => false, '$ref' => '#/components/schemas/FirstRank', ], ], ], 'responses' => [ 200 => [ 'schema' => [ 'type' => 'object', 'properties' => [ 'requestId' => [ 'description' => '请求ID', 'type' => 'string', 'example' => '0A6EB64B-B4C8-CF02-810F-E660812972FF', ], 'result' => [ 'description' => '粗排表达式信息', 'type' => 'object', 'properties' => [ 'description' => [ 'description' => '描述', 'type' => 'string', 'example' => '1', ], 'active' => [ 'description' => '是否是默认表达式', 'type' => 'boolean', 'example' => 'true', ], 'name' => [ 'description' => '名称', 'type' => 'string', 'example' => 'default', ], 'meta' => [ 'description' => '表达式信息', 'type' => 'array', 'items' => [ 'type' => 'object', 'properties' => [ 'arg' => [ 'description' => '表达式函数参数', 'type' => 'string', 'example' => '“1 ”', ], 'attribute' => [ 'description' => '属性，算分特征或搜索字段'."\n" .'可用的算分特征', 'type' => 'string', 'example' => 'static_bm25()', ], 'weight' => [ 'description' => '权重'."\n" .'取值范围：-100000～100000非0值', 'type' => 'number', 'format' => 'float', 'example' => '10', ], ], ], ], ], ], ], ], ], '5XX' => [ 'schema' => [ 'type' => 'object', 'properties' => [ 'code' => [ 'type' => 'string', ], 'requestId' => [ 'type' => 'string', ], 'message' => [ 'type' => 'string', ], 'httpCode' => [ 'type' => 'integer', 'format' => 'int32', ], ], ], ], ], 'responseDemo' => '[{"type":"json","example":"{\\n \\"requestId\\": \\"0A6EB64B-B4C8-CF02-810F-E660812972FF\\",\\n \\"result\\": {\\n \\"description\\": \\"1\\",\\n \\"active\\": true,\\n \\"name\\": \\"default\\",\\n \\"meta\\": [\\n {\\n \\"arg\\": \\"“1 ”\\",\\n \\"attribute\\": \\"static_bm25()\\",\\n \\"weight\\": 10\\n }\\n ]\\n }\\n}","errorExample":""},{"type":"xml","example":"0A6EB64B-B4C8-CF02-810F-E660812972FF\\n\\n ar_wear_edit_time\\n STRUCT\\n \\n timeliness_ms()\\n ar_edit_time\\n 1\\n \\n \\n false\\n 0\\n 0\\n","errorExample":""}]', 'title' => '修改一个应用版本的粗排表达式配置', 'requestParamsDescription' => '**请求体**'."\n" .'| 字段 | 类型 | 是否必要 | 示例值 | 描述 |'."\n" .'| --- | --- | --- | --- | --- |'."\n" .'| type | String | 是 | "STRUCT" | 表达式类型
- STRUCT  结构化，默认值
- STRING  自定义公式|'."\n" .'| meta | Array 或 String | 是 | | 表达式信息 |'."\n" .'| description | String | 否 | "my_test" | 描述 |'."\n" .'| active | Boolean | 否 | true | 是否是默认表达式 |'."\n" ."\n" .'参考：[FirstRank](~~170007~~)', 'responseParamsDescription' => ' ', 'extraInfo' => ' ', ], 'ListSecondRanks' => [ 'summary' => '获取指定 OpenSearch 应用版本的精排排配置列表。', 'path' => '/v4/openapi/app-groups/{appGroupIdentity}/apps/{appId}/second-ranks', 'methods' => [ 'get', ], 'schemes' => [ 'http', 'https', ], 'security' => [ [ 'AK' => [], ], ], 'operationType' => 'read', 'deprecated' => false, 'systemTags' => [ 'operationType' => 'list', 'riskType' => 'none', 'chargeType' => 'free', 'abilityTreeNodes' => [ 'FEATUREopensearchN8M8WS', 'FEATUREopensearchJUWEG4', ], ], 'parameters' => [ [ 'name' => 'appGroupIdentity', 'in' => 'path', 'schema' => [ 'description' => '应用名称', 'type' => 'string', 'required' => true, 'docRequired' => true, 'example' => 'my_app_group_name', ], ], [ 'name' => 'appId', 'in' => 'path', 'schema' => [ 'description' => '版本号', 'type' => 'integer', 'format' => 'int32', 'required' => true, 'docRequired' => true, 'example' => '110157886', ], ], ], 'responses' => [ 200 => [ 'schema' => [ 'type' => 'object', 'properties' => [ 'totalCount' => [ 'description' => '总条数', 'type' => 'integer', 'format' => 'int32', 'example' => '1', ], 'requestId' => [ 'description' => '请求ID', 'type' => 'string', 'example' => '0A6EB64B-B4C8-CF02-810F-E660812972FF', ], 'result' => [ 'description' => '精排表达式信息'."\n" ."\n" .'参考：[SecondRank](~~170008~~)', 'type' => 'array', 'items' => [ 'type' => 'object', 'properties' => [ 'created' => [ 'description' => '创建时间', 'type' => 'integer', 'format' => 'int32', 'example' => '0', ], 'active' => [ 'description' => '是否是默认表达式', 'type' => 'boolean', 'example' => 'false', ], 'isDefault' => [ 'description' => '是否是默认表达式（返回时展示，不作传参）'."\n" ."\n" .'- true 是'."\n" .'- false 否', 'type' => 'string', 'example' => 'false', ], 'isSys' => [ 'description' => '是否是系统表达式（返回时展示，不作传参）'."\n" ."\n" .'- true 是'."\n" .'- false 否', 'type' => 'string', 'example' => 'true', ], 'description' => [ 'description' => '描述', 'type' => 'string', 'example' => '""', ], 'updated' => [ 'description' => '更新时间', 'type' => 'integer', 'format' => 'int32', 'example' => '1587052801', ], 'name' => [ 'description' => '名称', 'type' => 'string', 'example' => 'tests', ], 'meta' => [ 'description' => '精排表达式'."\n" .'可以编写包含字段、算分特征和数学函数的表达式，实现复杂的排序逻辑', 'type' => 'string', 'example' => 'random()+now()', ], 'id' => [ 'description' => 'ID（返回时展示，不作传参）', 'type' => 'string', 'example' => '890473', ], ], ], ], ], ], ], '5XX' => [ 'schema' => [ 'type' => 'object', 'properties' => [ 'code' => [ 'type' => 'string', ], 'message' => [ 'type' => 'string', ], 'requestId' => [ 'type' => 'string', ], 'httpCode' => [ 'type' => 'integer', 'format' => 'int32', ], ], ], ], ], 'responseDemo' => '[{"type":"json","example":"{\\n \\"totalCount\\": 1,\\n \\"requestId\\": \\"0A6EB64B-B4C8-CF02-810F-E660812972FF\\",\\n \\"result\\": [\\n {\\n \\"created\\": 0,\\n \\"active\\": false,\\n \\"isDefault\\": \\"false\\",\\n \\"isSys\\": \\"true\\",\\n \\"description\\": \\"\\\\\\"\\\\\\"\\",\\n \\"updated\\": 1587052801,\\n \\"name\\": \\"tests\\",\\n \\"meta\\": \\"random()+now()\\",\\n \\"id\\": \\"890473\\"\\n }\\n ]\\n}","errorExample":""},{"type":"xml","example":"0A6EB64B-B4C8-CF02-810F-E660812972FF\\n\\n default\\n \\n false\\n \\n 890473\\n 0\\n 0\\n false\\n true\\n\\n\\n tests\\n random()+now()\\n true\\n \\n 890474\\n 1587052801\\n 1587052801\\n true\\n false\\n\\n\\n test\\n query_term_count()\\n false\\n \\n 890475\\n 1587052801\\n 1587052801\\n false\\n false\\n\\n3","errorExample":""}]', 'title' => '获取某版本的精排排配置列表', 'requestParamsDescription' => ' ', 'responseParamsDescription' => ' ', 'extraInfo' => ' ', ], 'CreateSecondRank' => [ 'summary' => '当 dryRun=true 时，表示进行精排表达式校验，默认 dryRun 不传为 false。', 'path' => '/v4/openapi/app-groups/{appGroupIdentity}/apps/{appId}/second-ranks', 'methods' => [ 'post', ], 'schemes' => [ 'http', 'https', ], 'security' => [ [ 'AK' => [], ], ], 'operationType' => 'write', 'deprecated' => false, 'systemTags' => [ 'operationType' => 'create', 'riskType' => 'none', 'chargeType' => 'free', 'abilityTreeNodes' => [ 'FEATUREopensearchN8M8WS', 'FEATUREopensearchJUWEG4', ], ], 'parameters' => [ [ 'name' => 'appGroupIdentity', 'in' => 'path', 'schema' => [ 'description' => '应用名称', 'type' => 'string', 'required' => true, 'docRequired' => true, 'example' => 'my_app_group_name', ], ], [ 'name' => 'appId', 'in' => 'path', 'schema' => [ 'description' => '版本号', 'type' => 'integer', 'format' => 'int32', 'required' => true, 'docRequired' => true, 'example' => '110157886', ], ], [ 'name' => 'dryRun', 'in' => 'query', 'schema' => [ 'description' => '是否为空运行请求', 'type' => 'boolean', 'required' => false, 'example' => 'true', ], ], [ 'name' => 'body', 'in' => 'body', 'schema' => [ 'description' => '请求体，参考：[SecondRank](~~170008~~)', 'required' => false, '$ref' => '#/components/schemas/SecondRank', ], ], ], 'responses' => [ 200 => [ 'schema' => [ 'type' => 'object', 'properties' => [ 'result' => [ 'description' => '精排表达式信息', 'type' => 'object', 'example' => '{}', ], 'RequestId' => [ 'description' => '请求ID', 'type' => 'string', 'example' => 'ABCDEFGH', ], ], ], ], '5XX' => [ 'schema' => [ 'type' => 'object', 'properties' => [ 'code' => [ 'type' => 'string', ], 'message' => [ 'type' => 'string', ], 'requestId' => [ 'type' => 'string', ], 'httpCode' => [ 'type' => 'integer', 'format' => 'int32', ], ], ], ], ], 'responseDemo' => '[{"type":"json","example":"{\\n \\"result\\": {},\\n \\"RequestId\\": \\"ABCDEFGH\\"\\n}","errorExample":""},{"type":"xml","example":"C5E2F73C-8241-81F8-3A62-65478C5A3111\\n\\n 89047\\n test_1\\n text_relevance(title)\\n true\\n 123\\n 1593679894\\n 1593679894\\n true\\n false\\n","errorExample":""}]', 'title' => '创建一个应用版本的精排配置', 'requestParamsDescription' => '**请求体**'."\n" .'| 字段 | 类型 | 是否必要 | 示例值 | 描述 |'."\n" .'| --- | --- | --- | --- | --- |'."\n" .'| name | String | 否 | "test" | 表达式名称 |'."\n" .'| meta | String | 否 | "random()" | 表达式信息 |'."\n" .'| description | String | 否 | "my_test" | 描述 |'."\n" .'| active | Boolean | 否 | true | 是否是默认表达式 |'."\n" ."\n" .'参考：[SecondRank](~~170008~~)
', 'responseParamsDescription' => ' ', 'extraInfo' => ' ', ], 'DescribeSecondRank' => [ 'summary' => '查看一个 OpenSearch 应用版本的精排表达式配置。', 'path' => '/v4/openapi/app-groups/{appGroupIdentity}/apps/{appId}/second-ranks/{name}', 'methods' => [ 'get', ], 'schemes' => [ 'http', 'https', ], 'security' => [ [ 'AK' => [], ], ], 'operationType' => 'read', 'deprecated' => false, 'systemTags' => [ 'operationType' => 'get', 'riskType' => 'none', 'chargeType' => 'free', 'abilityTreeNodes' => [ 'FEATUREopensearchN8M8WS', 'FEATUREopensearchJUWEG4', ], ], 'parameters' => [ [ 'name' => 'appGroupIdentity', 'in' => 'path', 'schema' => [ 'description' => '应用名称', 'type' => 'string', 'required' => true, 'docRequired' => true, 'example' => 'my_app_group_name', ], ], [ 'name' => 'appId', 'in' => 'path', 'schema' => [ 'description' => '版本号', 'type' => 'integer', 'format' => 'int32', 'required' => true, 'docRequired' => true, 'example' => '110157886', ], ], [ 'name' => 'name', 'in' => 'path', 'schema' => [ 'description' => '精排表达式名称', 'type' => 'string', 'required' => true, 'docRequired' => true, 'example' => 'test', ], ], ], 'responses' => [ 200 => [ 'schema' => [ 'type' => 'object', 'properties' => [ 'requestId' => [ 'description' => '请求ID', 'type' => 'string', 'example' => '0A6EB64B-B4C8-CF02-810F-E660812972FF', ], 'result' => [ 'description' => '精排表达式信息', 'type' => 'object', 'properties' => [ 'created' => [ 'description' => '创建时间', 'type' => 'integer', 'format' => 'int32', 'example' => '1587052801', ], 'active' => [ 'description' => '是否是默认表达式', 'type' => 'boolean', 'example' => 'true', ], 'isDefault' => [ 'description' => '是否是默认表达式（返回时展示，不作传参）'."\n" .'- true 是'."\n" .'- false 否', 'type' => 'string', 'example' => 'true', ], 'isSys' => [ 'description' => '是否是系统表达式（返回时展示，不作传参）'."\n" .'- true 是'."\n" .'- false 否', 'type' => 'string', 'example' => 'false', ], 'description' => [ 'description' => '描述', 'type' => 'string', 'example' => '-', ], 'updated' => [ 'description' => '更新时间', 'type' => 'integer', 'format' => 'int32', 'example' => '1587052801', ], 'name' => [ 'description' => '名称', 'type' => 'string', 'example' => 'tests', ], 'meta' => [ 'description' => '精排表达式'."\n" .'可以编写包含字段、算分特征和数学函数的表达式，实现复杂的排序逻辑', 'type' => 'string', 'example' => 'random()+now()', ], 'id' => [ 'description' => 'ID（返回时展示，不作传参）', 'type' => 'string', 'example' => '89047', ], ], ], ], ], ], '5XX' => [ 'schema' => [ 'type' => 'object', 'properties' => [ 'code' => [ 'type' => 'string', ], 'message' => [ 'type' => 'string', ], 'requestId' => [ 'type' => 'string', ], 'httpCode' => [ 'type' => 'integer', 'format' => 'int32', ], ], ], ], ], 'responseDemo' => '[{"type":"json","example":"{\\n \\"requestId\\": \\"0A6EB64B-B4C8-CF02-810F-E660812972FF\\",\\n \\"result\\": {\\n \\"created\\": 1587052801,\\n \\"active\\": true,\\n \\"isDefault\\": \\"true\\",\\n \\"isSys\\": \\"false\\",\\n \\"description\\": \\"-\\",\\n \\"updated\\": 1587052801,\\n \\"name\\": \\"tests\\",\\n \\"meta\\": \\"random()+now()\\",\\n \\"id\\": \\"89047\\"\\n }\\n}","errorExample":""},{"type":"xml","example":"0A6EB64B-B4C8-CF02-810F-E660812972FF\\n\\n 89047\\n tests\\n random()+now()\\n true\\n \\n 1587052801\\n 1587052801\\n true\\n false\\n","errorExample":""}]', 'title' => '查看一个应用版本的精排表达式配置', 'requestParamsDescription' => ' ', 'responseParamsDescription' => ' ', 'extraInfo' => ' ', ], 'ModifySecondRank' => [ 'summary' => '修改一个OpenSearch 应用版本的精排配置。当 dryRun=true 时，表示修改后的精排表达式进行校验，默认 dryRun 不传为 false。', 'path' => '/v4/openapi/app-groups/{appGroupIdentity}/apps/{appId}/second-ranks/{name}', 'methods' => [ 'put', ], 'schemes' => [ 'http', 'https', ], 'security' => [ [ 'AK' => [], ], ], 'operationType' => 'write', 'deprecated' => false, 'systemTags' => [ 'operationType' => 'update', 'riskType' => 'none', 'chargeType' => 'free', 'abilityTreeNodes' => [ 'FEATUREopensearchN8M8WS', 'FEATUREopensearchJUWEG4', ], ], 'parameters' => [ [ 'name' => 'appGroupIdentity', 'in' => 'path', 'schema' => [ 'description' => '应用名称', 'type' => 'string', 'required' => true, 'docRequired' => true, 'example' => '“my_app_group_name”', ], ], [ 'name' => 'appId', 'in' => 'path', 'schema' => [ 'description' => '版本号', 'type' => 'integer', 'format' => 'int32', 'required' => true, 'docRequired' => true, 'example' => '110157886', ], ], [ 'name' => 'name', 'in' => 'path', 'schema' => [ 'description' => '精排表达式名称', 'type' => 'string', 'required' => true, 'docRequired' => true, 'example' => 'true', ], ], [ 'name' => 'dryRun', 'in' => 'query', 'schema' => [ 'description' => '是否为空运行请求', 'type' => 'boolean', 'required' => false, 'example' => 'true', ], ], [ 'name' => 'body', 'in' => 'body', 'schema' => [ 'description' => '请求体，精排信息', 'required' => false, '$ref' => '#/components/schemas/SecondRank', ], ], ], 'responses' => [ 200 => [ 'schema' => [ 'description' => '响应体', 'type' => 'object', 'properties' => [ 'requestId' => [ 'description' => '请求ID', 'type' => 'string', 'example' => 'C5E2F73C-8241-81F8-3A62-65478C5A3111', ], 'result' => [ 'description' => '精排表达式信息', 'type' => 'object', 'properties' => [ 'created' => [ 'description' => '创建时间', 'type' => 'integer', 'format' => 'int32', 'example' => '1', ], 'active' => [ 'description' => '是否是默认表达式', 'type' => 'boolean', 'example' => 'true', ], 'isDefault' => [ 'description' => '是否是默认表达式（返回时展示，不作传参）'."\n" .'- true 是'."\n" .'- false 否', 'type' => 'string', 'example' => 'true', ], 'isSys' => [ 'description' => '是否是系统表达式（返回时展示，不作传参）'."\n" .'- true 是'."\n" .'- false 否', 'type' => 'string', 'example' => 'false', ], 'description' => [ 'description' => '描述', 'type' => 'string', 'example' => '"11"', ], 'updated' => [ 'description' => '更新时间', 'type' => 'integer', 'format' => 'int32', 'example' => '1', ], 'name' => [ 'description' => '名称', 'type' => 'string', 'example' => 'lsh_second_1', ], 'meta' => [ 'description' => '精排表达式'."\n" .'可以编写包含字段、算分特征和数学函数的表达式，实现复杂的排序逻辑', 'type' => 'string', 'example' => 'cate_id > 0 and cate_id < 1000', ], 'id' => [ 'description' => 'ID（返回时展示，不作传参）', 'type' => 'string', 'example' => '890473', ], ], 'example' => '{}', ], ], 'example' => '{}', ], ], '5XX' => [ 'schema' => [ 'type' => 'object', 'properties' => [ 'code' => [ 'type' => 'string', ], 'message' => [ 'type' => 'string', ], 'requestId' => [ 'type' => 'string', ], 'httpCode' => [ 'type' => 'integer', 'format' => 'int32', ], ], ], ], ], 'responseDemo' => '[{"type":"json","example":"{\\n \\"requestId\\": \\"C5E2F73C-8241-81F8-3A62-65478C5A3111\\",\\n \\"result\\": {\\n \\"created\\": 1,\\n \\"active\\": true,\\n \\"isDefault\\": \\"true\\",\\n \\"isSys\\": \\"false\\",\\n \\"description\\": \\"\\\\\\"11\\\\\\"\\",\\n \\"updated\\": 1,\\n \\"name\\": \\"lsh_second_1\\",\\n \\"meta\\": \\"cate_id > 0 and cate_id < 1000\\",\\n \\"id\\": \\"890473\\"\\n }\\n}","errorExample":""},{"type":"xml","example":"C5E2F73C-8241-81F8-3A62-65478C5A3111\\n\\n 890473\\n name_relevance\\n text_relevance(name)\\n true\\n 123\\n 1593679894\\n 1593679894\\n true\\n false\\n","errorExample":""}]', 'title' => '修改一个应用版本的精排配置', 'requestParamsDescription' => '**请求体**'."\n" .'| 字段 | 类型 | 是否必要 | 示例值 | 描述 |'."\n" .'| --- | --- | --- | --- | --- |'."\n" .'| meta | String | 否 | "text_relevance(name)" | 表达式配置 |'."\n" .'| description | String | 否 | "my_test" | 描述 |'."\n" .'| active | Boolean | 否 | true | 是否是默认表达式 |'."\n", 'responseParamsDescription' => ' ', 'extraInfo' => ' ', ], 'RemoveSecondRank' => [ 'summary' => '删除一个 OpenSearch 应用版本的精排表达式配置。', 'path' => '/v4/openapi/app-groups/{appGroupIdentity}/apps/{appId}/second-ranks/{name}', 'methods' => [ 'delete', ], 'schemes' => [ 'http', 'https', ], 'security' => [ [ 'AK' => [], ], ], 'operationType' => 'write', 'deprecated' => false, 'systemTags' => [ 'operationType' => 'delete', 'riskType' => 'none', 'chargeType' => 'free', 'abilityTreeNodes' => [ 'FEATUREopensearchN8M8WS', 'FEATUREopensearchJUWEG4', ], ], 'parameters' => [ [ 'name' => 'appGroupIdentity', 'in' => 'path', 'schema' => [ 'description' => '应用名称', 'type' => 'string', 'required' => true, 'docRequired' => true, 'example' => '“my_app_group_name”', ], ], [ 'name' => 'appId', 'in' => 'path', 'schema' => [ 'description' => '版本号', 'type' => 'integer', 'format' => 'int32', 'required' => true, 'docRequired' => true, 'example' => '110157886', ], ], [ 'name' => 'name', 'in' => 'path', 'schema' => [ 'description' => '精排表达式名称', 'type' => 'string', 'required' => true, 'docRequired' => true, 'example' => '“tests”', ], ], ], 'responses' => [ 200 => [ 'schema' => [ 'type' => 'object', 'properties' => [ 'result' => [ 'description' => '—', 'type' => 'object', 'example' => '{}', ], 'requestId' => [ 'description' => '请求ID', 'type' => 'string', 'example' => '0A6EB64B-B4C8-CF02-810F-E660812972FF', ], ], ], ], '5XX' => [ 'schema' => [ 'type' => 'object', 'properties' => [ 'code' => [ 'type' => 'string', ], 'message' => [ 'type' => 'string', ], 'requestId' => [ 'type' => 'string', ], 'httpCode' => [ 'type' => 'integer', 'format' => 'int32', ], ], ], ], ], 'responseDemo' => '[{"type":"json","example":"{\\n \\"result\\": {},\\n \\"requestId\\": \\"0A6EB64B-B4C8-CF02-810F-E660812972FF\\"\\n}","errorExample":""},{"type":"xml","example":"0A6EB64B-B4C8-CF02-810F-E660812972FF","errorExample":""}]', 'title' => '删除精排规则', 'requestParamsDescription' => ' ', 'responseParamsDescription' => ' ', 'extraInfo' => ' ', ], 'ListQueryProcessors' => [ 'summary' => '获取指定OpenSearch应用版本的查询分析规则列表。', 'path' => '/v4/openapi/app-groups/{appGroupIdentity}/apps/{appId}/query-processors', 'methods' => [ 'get', ], 'schemes' => [ 'http', 'https', ], 'security' => [ [ 'AK' => [], ], ], 'operationType' => 'read', 'deprecated' => false, 'systemTags' => [ 'operationType' => 'list', 'riskType' => 'none', 'chargeType' => 'free', 'abilityTreeNodes' => [ 'FEATUREopensearchNCXKUT', 'FEATUREopensearchUIICM8', ], ], 'parameters' => [ [ 'name' => 'appGroupIdentity', 'in' => 'path', 'schema' => [ 'description' => '应用名称', 'type' => 'string', 'required' => true, 'docRequired' => true, 'example' => 'my_app_group_name', ], ], [ 'name' => 'appId', 'in' => 'path', 'schema' => [ 'description' => '版本号', 'type' => 'integer', 'format' => 'int32', 'required' => true, 'docRequired' => true, 'example' => '110157886', ], ], [ 'name' => 'isActive', 'in' => 'query', 'schema' => [ 'description' => '是否已设置为默认规则，默认值为0'."\n" ."\n" .'- 0 表示查询所有'."\n" .'- 1 表示查询已设置为默认的规则'."\n" .'- 2 表示查询未设置为默认的规则', 'type' => 'integer', 'format' => 'int32', 'required' => false, 'example' => '0', ], ], ], 'responses' => [ 200 => [ 'schema' => [ 'type' => 'object', 'properties' => [ 'requestId' => [ 'description' => '请求ID', 'type' => 'string', 'example' => '0A6EB64B-B4C8-CF02-810F-E660812972FF', ], 'result' => [ 'description' => '规则信息'."\n" ."\n" .'参考：[QueryProcessor](~~170014~~)', 'type' => 'array', 'items' => [ 'description' => '返回结果', 'type' => 'object', 'properties' => [ 'created' => [ 'description' => '创建时间', 'type' => 'integer', 'format' => 'int32', 'example' => '1587398402', ], 'active' => [ 'description' => '是否默认规则', 'type' => 'boolean', 'example' => 'true', ], 'updated' => [ 'description' => '更新时间', 'type' => 'integer', 'format' => 'int32', 'example' => '1587398402', ], 'name' => [ 'description' => '规则名称', 'type' => 'string', 'example' => 'ner', ], 'domain' => [ 'description' => '行业类型'."\n" ."\n" .'- GENERAL 通用'."\n" .'- ECOMMERCE 电商'."\n" .'- IT_CONTENT IT内容', 'type' => 'string', 'example' => 'GENERAL', ], 'indexes' => [ 'description' => '应用的索引范围', 'type' => 'array', 'items' => [ 'description' => '应用的索引范围', 'type' => 'string', 'example' => '[ "default" ]', ], ], 'processors' => [ 'description' => '包含功能', 'type' => 'array', 'items' => [ 'description' => '包含功能'."\n" ."\n" .'具体说明查看下文：[Processor](~~170014~~)', 'type' => 'object', 'example' => '[]', ], ], ], ], ], ], ], ], '5XX' => [ 'schema' => [ 'type' => 'object', 'properties' => [ 'code' => [ 'type' => 'string', ], 'message' => [ 'type' => 'string', ], 'requestId' => [ 'type' => 'string', ], 'httpCode' => [ 'type' => 'integer', 'format' => 'int32', ], ], ], ], ], 'responseDemo' => '[{"type":"json","example":"{\\n \\"requestId\\": \\"0A6EB64B-B4C8-CF02-810F-E660812972FF\\",\\n \\"result\\": [\\n {\\n \\"created\\": 1587398402,\\n \\"active\\": true,\\n \\"updated\\": 1587398402,\\n \\"name\\": \\"ner\\",\\n \\"domain\\": \\"GENERAL\\",\\n \\"indexes\\": [\\n \\"[ \\\\\\"default\\\\\\" ]\\"\\n ],\\n \\"processors\\": [\\n []\\n ]\\n }\\n ]\\n}","errorExample":""},{"type":"xml","example":"0A6EB64B-B4C8-CF02-810F-E660812972FF\\n\\n test\\n true\\n default\\n \\n true\\n ner\\n \\n \\n brand\\n HIGH\\n \\n \\n category\\n HIGH\\n \\n \\n material\\n MIDDLE\\n \\n \\n element\\n MIDDLE\\n \\n \\n style\\n MIDDLE\\n \\n \\n color\\n MIDDLE\\n \\n \\n function\\n MIDDLE\\n \\n \\n scenario\\n MIDDLE\\n \\n \\n people\\n MIDDLE\\n \\n \\n season\\n MIDDLE\\n \\n \\n model\\n MIDDLE\\n \\n \\n region\\n MIDDLE\\n \\n \\n name\\n MIDDLE\\n \\n \\n adjective\\n MIDDLE\\n \\n \\n category-modifier\\n MIDDLE\\n \\n \\n size\\n LOW\\n \\n \\n quality\\n LOW\\n \\n \\n suit\\n LOW\\n \\n \\n new-release\\n LOW\\n \\n \\n series\\n LOW\\n \\n \\n marketing\\n LOW\\n \\n \\n entertainment\\n LOW\\n \\n \\n organization\\n LOW\\n \\n \\n movie\\n LOW\\n \\n \\n game\\n LOW\\n \\n \\n number\\n LOW\\n \\n \\n unit\\n LOW\\n \\n \\n common\\n LOW\\n \\n \\n new-word\\n LOW\\n \\n \\n proper-noun\\n LOW\\n \\n \\n symbol\\n LOW\\n \\n \\n prefix\\n LOW\\n \\n \\n suffix\\n LOW\\n \\n \\n gift\\n LOW\\n \\n \\n negative\\n LOW\\n \\n \\n agent\\n LOW\\n \\n \\n \\n true\\n synonym\\n \\n \\n \\n true\\n term_weighting\\n \\n \\n \\n true\\n spell_check\\n \\n \\n \\n category_prediction\\n 60\\n 848\\n \\n GENERAL\\n 1587398402\\n 1587398402\\n","errorExample":""}]', 'title' => '取某版本的查询分析规则列表', 'requestParamsDescription' => ' ', 'responseParamsDescription' => ' ', 'extraInfo' => ' ', ], 'CreateQueryProcessor' => [ 'summary' => '创建一个查询分析规则。当 dryRun=true 时，表示进行查询分析规则校验，默认 dryRun 不传为 false。', 'path' => '/v4/openapi/app-groups/{appGroupIdentity}/apps/{appId}/query-processors', 'methods' => [ 'post', ], 'schemes' => [ 'http', 'https', ], 'security' => [ [ 'AK' => [], ], ], 'operationType' => 'write', 'deprecated' => false, 'systemTags' => [ 'operationType' => 'create', 'riskType' => 'none', 'chargeType' => 'free', 'abilityTreeNodes' => [ 'FEATUREopensearchNCXKUT', 'FEATUREopensearchUIICM8', ], ], 'parameters' => [ [ 'name' => 'appGroupIdentity', 'in' => 'path', 'schema' => [ 'description' => '应用名称', 'type' => 'string', 'required' => true, 'docRequired' => true, 'example' => 'my_app_group_name', ], ], [ 'name' => 'appId', 'in' => 'path', 'schema' => [ 'description' => '版本号', 'type' => 'integer', 'format' => 'int32', 'required' => true, 'docRequired' => true, 'example' => '110157886', ], ], [ 'name' => 'dryRun', 'in' => 'query', 'schema' => [ 'description' => '是否为空运行请求', 'type' => 'boolean', 'required' => false, 'example' => 'true', ], ], [ 'name' => 'body', 'in' => 'body', 'schema' => [ 'description' => '请求体', 'type' => 'any', 'required' => false, 'example' => '{}', ], ], ], 'responses' => [ 200 => [ 'schema' => [ 'type' => 'object', 'properties' => [ 'requestId' => [ 'description' => '请求ID', 'type' => 'string', 'example' => '0A6EB64B-B4C8-CF02-810F-E660812972FF', ], 'result' => [ 'description' => '规则信息', 'type' => 'object', 'properties' => [ 'created' => [ 'description' => '创建时间', 'type' => 'integer', 'format' => 'int32', 'example' => '1587398402', ], 'active' => [ 'description' => '是否默认规则', 'type' => 'boolean', 'example' => 'true', ], 'updated' => [ 'description' => '更新时间', 'type' => 'integer', 'format' => 'int32', 'example' => '1587398402', ], 'name' => [ 'description' => '规则名称', 'type' => 'string', 'example' => 'query_filter', ], 'domain' => [ 'description' => '行业类型'."\n" .'- GENERAL 通用'."\n" .'- ECOMMERCE 电商'."\n" .'- IT_CONTENT IT内容', 'type' => 'string', 'example' => 'GENERAL', ], 'indexes' => [ 'description' => '应用的索引范围', 'type' => 'array', 'items' => [ 'description' => '应用的索引范围', 'type' => 'string', 'example' => '"default"', ], ], 'processors' => [ 'description' => '包含功能'."\n" ."\n" .'具体说明查看下文：[Processor](~~170014~~)', 'type' => 'array', 'items' => [ 'description' => '包含功能', 'type' => 'object', 'example' => '{}', ], ], ], ], ], ], ], '5XX' => [ 'schema' => [ 'type' => 'object', 'properties' => [ 'code' => [ 'type' => 'string', ], 'message' => [ 'type' => 'string', ], 'requestId' => [ 'type' => 'string', ], 'httpCode' => [ 'type' => 'integer', 'format' => 'int32', ], ], ], ], ], 'responseDemo' => '[{"type":"json","example":"{\\n \\"requestId\\": \\"0A6EB64B-B4C8-CF02-810F-E660812972FF\\",\\n \\"result\\": {\\n \\"created\\": 1587398402,\\n \\"active\\": true,\\n \\"updated\\": 1587398402,\\n \\"name\\": \\"query_filter\\",\\n \\"domain\\": \\"GENERAL\\",\\n \\"indexes\\": [\\n \\"\\\\\\"default\\\\\\"\\"\\n ],\\n \\"processors\\": [\\n {}\\n ]\\n }\\n}","errorExample":""},{"type":"xml","example":"0A6EB64B-B4C8-CF02-810F-E660812972FF\\n\\n query_filter\\n true\\n default\\n \\n synonym\\n true\\n \\n \\n stop_word\\n true\\n 980\\n \\n GENERAL\\n 1587398402\\n 1587398402\\n","errorExample":""}]', 'title' => '创建查询分析规则', 'requestParamsDescription' => '**请求体**'."\n" .'| 字段 | 类型 | 是否必要 | 示例值 | 描述 |'."\n" .'| --- | --- | --- | --- | --- | '."\n" .'| name | String | 是 | "test" | 规则名称 |'."\n" .'| processors[] | Object | 是 | -- | 分析规则
参考：[Processor](~~170014~~) |'."\n" .'| domain | String | 否 | "GENERAL" | 行业类型
- GENERAL 通用行业
- ECOMMERCE 电商
- IT_CONTENT IT行业 |'."\n" .'| indexes | Array | 否 | ["default"] | 应用的索引范围 |'."\n" .'| active | Boolean | 否 | true | 是否设置为有效 |'."\n" ."\n" .'参考：[QueryProcessor](~~170014~~)
'."\n" .' ', 'responseParamsDescription' => ' ', 'extraInfo' => ' ', ], 'ModifyQueryProcessor' => [ 'summary' => '修改指定应用版本查询分析规则。当 dryRun=true 时，表示进行查询分析规则校验，默认 dryRun 不传为 false。', 'path' => '/v4/openapi/app-groups/{appGroupIdentity}/apps/{appId}/query-processors/{name}', 'methods' => [ 'put', ], 'schemes' => [ 'http', 'https', ], 'security' => [ [ 'AK' => [], ], ], 'operationType' => 'write', 'deprecated' => false, 'systemTags' => [ 'operationType' => 'update', 'riskType' => 'none', 'chargeType' => 'free', 'abilityTreeNodes' => [ 'FEATUREopensearchUIICM8', 'FEATUREopensearchNCXKUT', ], ], 'parameters' => [ [ 'name' => 'appGroupIdentity', 'in' => 'path', 'schema' => [ 'description' => '应用名称', 'type' => 'string', 'required' => true, 'docRequired' => true, 'example' => '“my_app_group_name”', ], ], [ 'name' => 'appId', 'in' => 'path', 'schema' => [ 'description' => '版本号', 'type' => 'integer', 'format' => 'int32', 'required' => true, 'docRequired' => true, 'example' => '110157886', ], ], [ 'name' => 'dryRun', 'in' => 'query', 'schema' => [ 'description' => '是否为空运行请求', 'type' => 'boolean', 'required' => false, 'example' => 'true', ], ], [ 'name' => 'name', 'in' => 'path', 'schema' => [ 'description' => '规则名称', 'type' => 'string', 'required' => true, 'docRequired' => true, 'example' => '“test”', ], ], [ 'name' => 'body', 'in' => 'body', 'schema' => [ 'description' => '请求体。', 'type' => 'any', 'required' => false, 'example' => '{'."\n" .' "domain": "GENERAL",'."\n" .' "category": "",'."\n" .' "processors": ['."\n" .' {'."\n" .' "name": "synonym",'."\n" .' "useSystemDictionary": true'."\n" .' },'."\n" .' {'."\n" .' "name": "stop_word",'."\n" .' "useSystemDictionary": true'."\n" .' }'."\n" .' ]'."\n" .'}', ], ], ], 'responses' => [ 200 => [ 'schema' => [ 'description' => '响应体', 'type' => 'object', 'properties' => [ 'requestId' => [ 'description' => '请求ID', 'type' => 'string', 'example' => 'D77D0DAF-790D-F5F5-A9C0-133738165014', ], 'result' => [ 'description' => '规则信息', 'type' => 'object', 'properties' => [ 'created' => [ 'description' => '创建时间', 'type' => 'integer', 'format' => 'int32', 'example' => '0', ], 'active' => [ 'description' => '是否默认规则', 'type' => 'boolean', 'example' => 'true', ], 'updated' => [ 'description' => '更新时间', 'type' => 'integer', 'format' => 'int32', 'example' => '1', ], 'name' => [ 'description' => '规则名称', 'type' => 'string', 'example' => 'synonym', ], 'domain' => [ 'description' => '行业类型'."\n" .'- GENERAL 通用'."\n" .'- ECOMMERCE 电商'."\n" .'- IT_CONTENT IT内容', 'type' => 'string', 'example' => 'GENERAL', ], 'indexes' => [ 'description' => '应用的索引范围', 'type' => 'array', 'items' => [ 'description' => '应用的索引范围', 'type' => 'string', 'example' => '[ "default" ]', ], 'example' => '["default"]', ], 'processors' => [ 'description' => '分析规则', 'type' => 'array', 'items' => [ 'description' => '响应体', 'type' => 'object', 'example' => '[ "default" ]', ], 'example' => '[]', ], ], 'example' => '{}', ], ], 'example' => '{}', ], ], '5XX' => [ 'schema' => [ 'type' => 'object', 'properties' => [ 'code' => [ 'type' => 'string', ], 'message' => [ 'type' => 'string', ], 'requestId' => [ 'type' => 'string', ], 'httpCode' => [ 'type' => 'integer', 'format' => 'int32', ], ], ], ], ], 'responseDemo' => '[{"type":"json","example":"{\\n \\"requestId\\": \\"D77D0DAF-790D-F5F5-A9C0-133738165014\\",\\n \\"result\\": {\\n \\"created\\": 0,\\n \\"active\\": true,\\n \\"updated\\": 1,\\n \\"name\\": \\"synonym\\",\\n \\"domain\\": \\"GENERAL\\",\\n \\"indexes\\": [\\n \\"[ \\\\\\"default\\\\\\" ]\\"\\n ],\\n \\"processors\\": [\\n [\\n \\"default\\"\\n ]\\n ]\\n }\\n}","errorExample":""},{"type":"xml","example":"0A6EB64B-B4C8-CF02-810F-E660812972FF\\n\\n query_filter\\n true\\n default\\n \\n synonym\\n true\\n \\n \\n stop_word\\n true\\n \\n GENERAL\\n 1587398402\\n 1587398402\\n","errorExample":""}]', 'title' => '修改指定应用版本查询分析规则', 'requestParamsDescription' => '**请求体**'."\n" .'| 字段 | 类型 | 是否必要 | 示例值 | 描述 |'."\n" .'| --- | --- | --- | --- | --- |'."\n" .'| domain | String | 否 | "GENERAL" | 行业类型
- GENERAL 通用行业
- ECOMMERCE 电商
- IT_CONTENT IT行业
|'."\n" .'| indexes | Array | 否 | ["default"] | 应用的索引范围 |'."\n" .'| processors[] | Object | 否 | | 分析规则
参考：[Processor](~~170014~~)'."\n" .'| active | Boolean | 否 | true | 是否设置为有效 |'."\n" ."\n" .'参考：[QueryProcessor](~~170014~~)
', 'responseParamsDescription' => '**返回参数**'."\n" .'| 字段 | 类型 | 描述 |'."\n" .'| --- | --- | --- |'."\n" .'| requestId | String | 请求ID |'."\n" .'| result | Object | 规则信息
参考：[QueryProcessor](~~170014~~) |', 'extraInfo' => "\n", ], 'RemoveQueryProcessor' => [ 'summary' => '删除指定 OpenSearch 应用版本的查询分析规则。', 'path' => '/v4/openapi/app-groups/{appGroupIdentity}/apps/{appId}/query-processors/{name}', 'methods' => [ 'delete', ], 'schemes' => [ 'http', 'https', ], 'security' => [ [ 'AK' => [], ], ], 'operationType' => 'write', 'deprecated' => false, 'systemTags' => [ 'operationType' => 'delete', 'riskType' => 'none', 'chargeType' => 'free', 'abilityTreeNodes' => [ 'FEATUREopensearchNCXKUT', 'FEATUREopensearchUIICM8', ], ], 'parameters' => [ [ 'name' => 'appGroupIdentity', 'in' => 'path', 'schema' => [ 'description' => '应用名称', 'type' => 'string', 'required' => true, 'docRequired' => true, 'example' => '“my_app_group_name”', ], ], [ 'name' => 'appId', 'in' => 'path', 'schema' => [ 'description' => '版本号', 'type' => 'integer', 'format' => 'int32', 'required' => true, 'docRequired' => true, 'example' => '110157886', ], ], [ 'name' => 'name', 'in' => 'path', 'schema' => [ 'description' => '规则名称', 'type' => 'string', 'required' => true, 'docRequired' => true, 'example' => '“test”', ], ], ], 'responses' => [ 200 => [ 'schema' => [ 'type' => 'object', 'properties' => [ 'result' => [ 'description' => '—', 'type' => 'string', 'example' => '[]', ], 'requestId' => [ 'description' => '请求ID', 'type' => 'string', 'example' => '0A6EB64B-B4C8-CF02-810F-E660812972FF', ], ], ], ], '5XX' => [ 'schema' => [ 'type' => 'object', 'properties' => [ 'code' => [ 'type' => 'string', ], 'message' => [ 'type' => 'string', ], 'requestId' => [ 'type' => 'string', ], 'httpCode' => [ 'type' => 'integer', 'format' => 'int32', ], ], ], ], ], 'responseDemo' => '[{"type":"json","example":"{\\n \\"result\\": \\"[]\\",\\n \\"requestId\\": \\"0A6EB64B-B4C8-CF02-810F-E660812972FF\\"\\n}","errorExample":""},{"type":"xml","example":"0A6EB64B-B4C8-CF02-810F-E660812972FF","errorExample":""}]', 'title' => '删除指定应用版本的查询分析规则', 'requestParamsDescription' => ' ', 'responseParamsDescription' => ' ', 'extraInfo' => ' ', ], 'DescribeQueryProcessor' => [ 'path' => '/v4/openapi/app-groups/{appGroupIdentity}/apps/{appId}/query-processors/{name}', 'methods' => [ 'get', ], 'schemes' => [ 'http', 'https', ], 'security' => [ [ 'AK' => [], ], ], 'operationType' => 'read', 'deprecated' => false, 'systemTags' => [], 'parameters' => [ [ 'name' => 'appGroupIdentity', 'in' => 'path', 'schema' => [ 'description' => '应用名称', 'type' => 'string', 'required' => true, 'docRequired' => true, 'example' => 'my_app_group_name', ], ], [ 'name' => 'appId', 'in' => 'path', 'schema' => [ 'description' => '版本号', 'type' => 'integer', 'format' => 'int32', 'required' => true, 'docRequired' => true, 'example' => '110157886', ], ], [ 'name' => 'name', 'in' => 'path', 'schema' => [ 'description' => '规则名称', 'type' => 'string', 'required' => true, 'docRequired' => true, 'example' => 'test', ], ], ], 'responses' => [ 200 => [ 'schema' => [ 'type' => 'object', 'properties' => [ 'requestId' => [ 'description' => '请求ID', 'type' => 'string', 'example' => '0A6EB64B-B4C8-CF02-810F-E660812972FF', ], 'result' => [ 'description' => '规则信息', 'type' => 'object', 'properties' => [ 'created' => [ 'description' => '创建时间', 'type' => 'integer', 'format' => 'int32', 'example' => '1587398402', ], 'active' => [ 'description' => '是否默认规则', 'type' => 'boolean', 'example' => 'true', ], 'updated' => [ 'description' => '更新时间', 'type' => 'integer', 'format' => 'int32', 'example' => '1587398402', ], 'name' => [ 'description' => '规则名称', 'type' => 'string', 'example' => 'test', ], 'domain' => [ 'description' => '行业类型'."\n" .'- GENERAL 通用'."\n" .'- ECOMMERCE 电商'."\n" .'- IT_CONTENT IT内容', 'type' => 'string', 'example' => 'GENERAL', ], 'indexes' => [ 'type' => 'array', 'items' => [ 'description' => '应用的索引范围', 'type' => 'string', 'example' => 'default', ], ], 'processors' => [ 'type' => 'array', 'items' => [ 'description' => '包含功能', 'type' => 'object', 'example' => '{}', ], ], ], ], ], ], ], '5XX' => [ 'schema' => [ 'type' => 'object', 'properties' => [ 'code' => [ 'type' => 'string', ], 'message' => [ 'type' => 'string', ], 'requestId' => [ 'type' => 'string', ], 'httpCode' => [ 'type' => 'integer', 'format' => 'int32', ], ], ], ], ], 'responseDemo' => '[{"type":"json","example":"{\\n \\"requestId\\": \\"0A6EB64B-B4C8-CF02-810F-E660812972FF\\",\\n \\"result\\": {\\n \\"created\\": 1587398402,\\n \\"active\\": true,\\n \\"updated\\": 1587398402,\\n \\"name\\": \\"test\\",\\n \\"domain\\": \\"GENERAL\\",\\n \\"indexes\\": [\\n \\"default\\"\\n ],\\n \\"processors\\": [\\n \\"{}\\"\\n ]\\n }\\n}","errorExample":""},{"type":"xml","example":"0A6EB64B-B4C8-CF02-810F-E660812972FF\\n\\n test\\n true\\n default\\n \\n true\\n ner\\n \\n \\n brand\\n HIGH\\n \\n \\n category\\n HIGH\\n \\n \\n material\\n MIDDLE\\n \\n \\n element\\n MIDDLE\\n \\n \\n style\\n MIDDLE\\n \\n \\n color\\n MIDDLE\\n \\n \\n function\\n MIDDLE\\n \\n \\n scenario\\n MIDDLE\\n \\n \\n people\\n MIDDLE\\n \\n \\n season\\n MIDDLE\\n \\n \\n model\\n MIDDLE\\n \\n \\n region\\n MIDDLE\\n \\n \\n name\\n MIDDLE\\n \\n \\n adjective\\n MIDDLE\\n \\n \\n category-modifier\\n MIDDLE\\n \\n \\n size\\n LOW\\n \\n \\n quality\\n LOW\\n \\n \\n suit\\n LOW\\n \\n \\n new-release\\n LOW\\n \\n \\n series\\n LOW\\n \\n \\n marketing\\n LOW\\n \\n \\n entertainment\\n LOW\\n \\n \\n organization\\n LOW\\n \\n \\n movie\\n LOW\\n \\n \\n game\\n LOW\\n \\n \\n number\\n LOW\\n \\n \\n unit\\n LOW\\n \\n \\n common\\n LOW\\n \\n \\n new-word\\n LOW\\n \\n \\n proper-noun\\n LOW\\n \\n \\n symbol\\n LOW\\n \\n \\n prefix\\n LOW\\n \\n \\n suffix\\n LOW\\n \\n \\n gift\\n LOW\\n \\n \\n negative\\n LOW\\n \\n \\n agent\\n LOW\\n \\n \\n \\n true\\n synonym\\n \\n \\n \\n true\\n term_weighting\\n \\n \\n \\n true\\n spell_check\\n \\n \\n \\n category_prediction\\n 60\\n 848\\n \\n GENERAL\\n 1587398402\\n 1587398402\\n","errorExample":""}]', 'title' => '获取指定应用版本的查询分析规则列表', 'summary' => '获取指定 OpenSearch 应用版本的查询分析规则列表。', 'requestParamsDescription' => ' ', 'responseParamsDescription' => ' ', 'extraInfo' => ' ', ], 'ListQueryProcessorNers' => [ 'summary' => '实体识别：获取推荐的实体类型重要性设置。', 'path' => '/v4/openapi/query-processor/ner/default-priorities', 'methods' => [ 'get', ], 'schemes' => [ 'http', 'https', ], 'security' => [ [ 'AK' => [], ], ], 'operationType' => 'read', 'deprecated' => false, 'systemTags' => [ 'operationType' => 'none', 'riskType' => 'none', 'chargeType' => 'free', 'abilityTreeNodes' => [ 'FEATUREopensearchUIICM8', 'FEATUREopensearchNCXKUT', ], ], 'parameters' => [ [ 'name' => 'domain', 'in' => 'query', 'schema' => [ 'description' => '行业类型'."\n" ."\n" .'- ECOMMERCE 电商行业', 'type' => 'string', 'required' => false, 'docRequired' => true, 'example' => 'ECOMMERCE', ], ], ], 'responses' => [ 200 => [ 'schema' => [ 'type' => 'object', 'properties' => [ 'requestId' => [ 'description' => '请求ID', 'type' => 'string', 'example' => '0A6EB64B-B4C8-CF02-810F-E660812972FF', ], 'result' => [ 'description' => '实体类型重要性设置'."\n" ."\n" .'参考：[实体类型重要性设置](~~173616~~)', 'type' => 'array', 'items' => [ 'type' => 'object', 'properties' => [ 'tag' => [ 'description' => '实体类型的内部英文表示', 'type' => 'string', 'example' => 'brand', ], 'order' => [ 'description' => '在同一个priority下的排序顺序'."\n" .'优先顺序按照数字从小到大，默认为0', 'type' => 'integer', 'format' => 'int32', 'example' => '1', ], 'priority' => [ 'description' => '重要性'."\n" ."\n" .'- HIGH'."\n" .'- MIDDLE'."\n" .'- LOW', 'type' => 'string', 'example' => 'HIGH', ], 'label' => [ 'description' => '实体类型名称', 'type' => 'string', 'example' => '品牌', ], ], ], ], ], ], ], '5XX' => [ 'schema' => [ 'type' => 'object', 'properties' => [ 'code' => [ 'type' => 'string', ], 'message' => [ 'type' => 'string', ], 'requestId' => [ 'type' => 'string', ], 'httpCode' => [ 'type' => 'integer', 'format' => 'int32', ], ], ], ], ], 'responseDemo' => '[{"type":"json","example":"{\\n \\"requestId\\": \\"0A6EB64B-B4C8-CF02-810F-E660812972FF\\",\\n \\"result\\": [\\n {\\n \\"tag\\": \\"brand\\",\\n \\"order\\": 1,\\n \\"priority\\": \\"HIGH\\",\\n \\"label\\": \\"品牌\\"\\n }\\n ]\\n}","errorExample":""},{"type":"xml","example":"0A6EB64B-B4C8-CF02-810F-E660812972FF\\n\\n brand\\n HIGH\\n 1\\n \\n\\n\\n category\\n HIGH\\n 2\\n \\n\\n\\n material\\n MIDDLE\\n 3\\n \\n\\n\\n element\\n MIDDLE\\n 4\\n \\n\\n\\n style\\n MIDDLE\\n 5\\n \\n\\n\\n color\\n MIDDLE\\n 6\\n \\n\\n\\n function\\n MIDDLE\\n 7\\n \\n\\n\\n scenario\\n MIDDLE\\n 8\\n \\n\\n\\n people\\n MIDDLE\\n 9\\n \\n\\n\\n season\\n MIDDLE\\n 10\\n \\n\\n\\n model\\n MIDDLE\\n 11\\n \\n\\n\\n region\\n MIDDLE\\n 12\\n \\n\\n\\n name\\n MIDDLE\\n 13\\n \\n\\n\\n adjective\\n MIDDLE\\n 14\\n \\n\\n\\n category-modifier\\n MIDDLE\\n 15\\n \\n\\n\\n size\\n LOW\\n 16\\n \\n\\n\\n quality\\n LOW\\n 17\\n \\n\\n\\n suit\\n LOW\\n 18\\n \\n\\n\\n new-release\\n LOW\\n 19\\n \\n\\n\\n series\\n LOW\\n 20\\n \\n\\n\\n marketing\\n LOW\\n 21\\n \\n\\n\\n entertainment\\n LOW\\n 22\\n \\n\\n\\n organization\\n LOW\\n 23\\n \\n\\n\\n movie\\n LOW\\n 24\\n \\n\\n\\n game\\n LOW\\n 25\\n \\n\\n\\n number\\n LOW\\n 26\\n \\n\\n\\n unit\\n LOW\\n 27\\n \\n\\n\\n common\\n LOW\\n 28\\n \\n\\n\\n new-word\\n LOW\\n 29\\n \\n\\n\\n proper-noun\\n LOW\\n 30\\n \\n\\n\\n symbol\\n LOW\\n 31\\n \\n\\n\\n prefix\\n LOW\\n 32\\n \\n\\n\\n suffix\\n LOW\\n 33\\n \\n\\n\\n gift\\n LOW\\n 34\\n \\n\\n\\n negative\\n LOW\\n 35\\n \\n\\n\\n agent\\n LOW\\n 36\\n \\n","errorExample":""}]', 'title' => '获取推荐的实体类型重要性设置', 'requestParamsDescription' => ' ', 'responseParamsDescription' => ' ', 'extraInfo' => ' ', ], 'ListQueryProcessorAnalyzerResults' => [ 'summary' => '查询分析效果测试。（仅限开源兼容版存量应用调用）', 'path' => '/v4/openapi/app-groups/{appGroupIdentity}/apps/{appId}/query-processors/{name}/analyze', 'methods' => [ 'get', ], 'schemes' => [ 'http', 'https', ], 'security' => [ [ 'AK' => [], ], ], 'operationType' => 'read', 'deprecated' => false, 'systemTags' => [ 'operationType' => 'none', 'riskType' => 'none', 'chargeType' => 'free', 'abilityTreeNodes' => [ 'FEATUREopensearchUIICM8', 'FEATUREopensearchNCXKUT', ], ], 'parameters' => [ [ 'name' => 'appGroupIdentity', 'in' => 'path', 'schema' => [ 'description' => '应用名称', 'type' => 'string', 'required' => true, 'docRequired' => true, 'example' => 'my_app_group_name', ], ], [ 'name' => 'appId', 'in' => 'path', 'schema' => [ 'description' => '版本号', 'type' => 'string', 'required' => true, 'docRequired' => true, 'example' => '"110157886"', ], ], [ 'name' => 'name', 'in' => 'path', 'schema' => [ 'description' => '规则名称', 'type' => 'string', 'required' => true, 'docRequired' => true, 'example' => '"test"', ], ], [ 'name' => 'text', 'in' => 'query', 'schema' => [ 'description' => '待测试内容', 'type' => 'string', 'required' => true, 'docRequired' => true, 'example' => '"abcde"', ], ], ], 'responses' => [ 200 => [ 'schema' => [ 'description' => '响应体', 'type' => 'object', 'properties' => [ 'result' => [ 'description' => '返回结果', 'type' => 'object', 'example' => '{}', ], 'RequestId' => [ 'description' => '请求id', 'type' => 'string', 'example' => '98724351-D6B2-5D8A-B089-7FFD1821A7E9', ], ], 'example' => '{}', ], ], '5XX' => [ 'schema' => [ 'type' => 'object', 'properties' => [ 'code' => [ 'type' => 'string', ], 'message' => [ 'type' => 'string', ], 'requestId' => [ 'type' => 'string', ], 'httpCode' => [ 'type' => 'integer', 'format' => 'int32', ], ], ], ], ], 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"result\\": {},\\n \\"RequestId\\": \\"98724351-D6B2-5D8A-B089-7FFD1821A7E9\\"\\n}","type":"json"}]', 'title' => '查询分析效果测试', ], 'ListInterventionDictionaries' => [ 'summary' => '获取用户的干预词典列表。', 'path' => '/v4/openapi/intervention-dictionaries', 'methods' => [ 'get', ], 'schemes' => [ 'http', 'https', ], 'security' => [ [ 'AK' => [], ], ], 'operationType' => 'read', 'deprecated' => false, 'systemTags' => [ 'operationType' => 'list', 'riskType' => 'none', 'chargeType' => 'free', 'abilityTreeNodes' => [ 'FEATUREopensearchUIICM8', 'FEATUREopensearchNCXKUT', ], ], 'parameters' => [ [ 'name' => 'pageSize', 'in' => 'query', 'schema' => [ 'description' => '每页返回数目，默认 pageSize=10', 'type' => 'integer', 'format' => 'int32', 'required' => false, 'example' => '10', ], ], [ 'name' => 'pageNumber', 'in' => 'query', 'schema' => [ 'description' => '页码，默认 pageNumber=1', 'type' => 'integer', 'format' => 'int32', 'required' => false, 'example' => '1', ], ], [ 'name' => 'types', 'in' => 'query', 'schema' => [ 'description' => '干预词典类型集合'."\n" .'格式：urlencode([“synonym”, “stopword”])'."\n" ."\n" .'- stopword 停用词'."\n" .'- synonym 同义词'."\n" .'- correction 拼写纠错'."\n" .'- category_prediction 类目预测'."\n" .'- ner 实体识别'."\n" .'- term_weighting 词权重', 'type' => 'string', 'required' => false, 'example' => '["synonym"]', ], ], ], 'responses' => [ 200 => [ 'schema' => [ 'type' => 'object', 'properties' => [ 'totalCount' => [ 'description' => '总条数', 'type' => 'integer', 'format' => 'int32', 'example' => '2', ], 'requestId' => [ 'description' => '请求ID', 'type' => 'string', 'example' => '0A6EB64B-B4C8-CF02-810F-E660812972FF', ], 'result' => [ 'description' => '干预词典详情'."\n" ."\n" .'参考：[InterventionDictionary](~~173608~~)', 'type' => 'array', 'items' => [ 'type' => 'object', 'properties' => [ 'created' => [ 'description' => '创建时间', 'type' => 'integer', 'format' => 'int32', 'example' => '1539158325', ], 'type' => [ 'description' => '类型'."\n" ."\n" .'- stopword 停用词'."\n" .'- synonym 同义词'."\n" .'- correction 拼写纠错'."\n" .'- category_prediction 类目预测'."\n" .'- ner 实体识别'."\n" .'- term_weighting 词权重', 'type' => 'string', 'example' => 'synonym', ], 'analyzer' => [ 'description' => '自定义分词', 'type' => 'string', 'example' => '""', ], 'name' => [ 'description' => '名称', 'type' => 'string', 'example' => 'tongyici', ], 'updated' => [ 'description' => '更新时间', 'type' => 'integer', 'format' => 'int32', 'example' => '1539158313', ], 'id' => [ 'description' => '词典ID', 'type' => 'integer', 'format' => 'int32', 'example' => '1', ], ], ], ], ], ], ], '5XX' => [ 'schema' => [ 'type' => 'object', 'properties' => [ 'code' => [ 'type' => 'string', ], 'requestId' => [ 'type' => 'string', ], 'message' => [ 'type' => 'string', ], 'httpCode' => [ 'type' => 'integer', 'format' => 'int32', ], ], ], ], ], 'responseDemo' => '[{"type":"json","example":"{\\n \\"totalCount\\": 2,\\n \\"requestId\\": \\"0A6EB64B-B4C8-CF02-810F-E660812972FF\\",\\n \\"result\\": [\\n {\\n \\"created\\": 1539158325,\\n \\"type\\": \\"synonym\\",\\n \\"analyzer\\": \\"\\\\\\"\\\\\\"\\",\\n \\"name\\": \\"tongyici\\",\\n \\"updated\\": 1539158313,\\n \\"id\\": 1\\n }\\n ]\\n}","errorExample":""},{"type":"xml","example":"0A6EB64B-B4C8-CF02-810F-E660812972FF\\n2\\n\\n 1\\n tongyici\\n synonym\\n \\n 1539158313\\n 1539158313\\n\\n\\n 2\\n tingyongci\\n stopword\\n \\n 1539158325\\n 1539158325\\n","errorExample":""}]', 'title' => '获取用户的干预词典列表', 'requestParamsDescription' => ' ', 'responseParamsDescription' => ' ', 'extraInfo' => ' ', ], 'CreateInterventionDictionary' => [ 'summary' => '创建干预词典。', 'path' => '/v4/openapi/intervention-dictionaries', 'methods' => [ 'post', ], 'schemes' => [ 'http', 'https', ], 'security' => [ [ 'AK' => [], ], ], 'operationType' => 'readAndWrite', 'deprecated' => false, 'systemTags' => [ 'operationType' => 'create', 'riskType' => 'none', 'chargeType' => 'free', 'abilityTreeNodes' => [ 'FEATUREopensearchNCXKUT', 'FEATUREopensearchUIICM8', ], ], 'parameters' => [ [ 'name' => 'dryRun', 'in' => 'query', 'schema' => [ 'description' => '是否校验入参数据合法性，默认false。'."\n" ."\n" .'取值：'."\n" ."\n" .'- **true**：只校验参数合法性。'."\n" ."\n" .'- **false**：校验参数合法性，创建归因配置。', 'type' => 'boolean', 'required' => false, 'example' => 'false', ], ], [ 'name' => 'body', 'in' => 'body', 'style' => 'json', 'schema' => [ 'description' => '请求体', 'type' => 'object', 'properties' => [ 'name' => [ 'description' => '干预词典名称', 'type' => 'string', 'required' => false, 'example' => 'ner_dict_ec', ], 'type' => [ 'description' => '类型'."\n" .'- stopword 停用词'."\n" .'- synonym 同义词'."\n" .'- correction 拼写纠错'."\n" .'- category_prediction 类目预测'."\n" .'- ner 实体识别'."\n" .'- term_weighting 词权重'."\n" .'- suggest_allowlist 下拉提示白名单'."\n" .'- suggest_denylist 下拉提示黑名单'."\n" .'- hot_allowlist 热搜白名单'."\n" .'- hot_denylist 热搜黑名单'."\n" .'- hint_allowlist 底纹白名单'."\n" .'- hint_denylist 底纹黑名单', 'type' => 'string', 'required' => false, 'example' => 'ner', ], 'analyzerType' => [ 'description' => '词典类型，支持：'."\n" ."\n" .'- MODEL：模型定制分析器。'."\n" ."\n" .'- SYSTEM：系统分析器。'."\n" ."\n" .'- USER：自定义分析器。', 'type' => 'string', 'required' => false, 'example' => 'SYSTEM', ], ], 'required' => false, ], ], ], 'responses' => [ 200 => [ 'schema' => [ 'type' => 'object', 'properties' => [ 'requestId' => [ 'description' => '请求ID', 'type' => 'string', 'example' => '80326EFE-485F-46E7-B291-5A1DD08D2198', ], 'result' => [ 'description' => '干预词典详情', 'type' => 'object', 'properties' => [ 'created' => [ 'description' => '创建时间', 'type' => 'string', 'example' => '1591086323', ], 'analyzer' => [ 'description' => '自定义分词', 'type' => 'string', 'example' => 'dianshang', ], 'updated' => [ 'description' => '更新时间', 'type' => 'string', 'example' => '1591086323', ], 'type' => [ 'description' => '类型'."\n" .'- stopword 停用词'."\n" .'- synonym 同义词'."\n" .'- correction 拼写纠错'."\n" .'- category_prediction 类目预测'."\n" .'- ner 实体识别'."\n" .'- term_weighting 词权重'."\n" .'- suggest_allowlist 下拉提示白名单'."\n" .'- suggest_denylist 下拉提示黑名单'."\n" .'- hot_allowlist 热搜白名单'."\n" .'- hot_denylist 热搜黑名单'."\n" .'- hint_allowlist 底纹白名单'."\n" .'- hint_denylist 底纹黑名单', 'type' => 'string', 'example' => 'ner', ], 'name' => [ 'description' => '名称', 'type' => 'string', 'example' => 'testb', ], ], ], ], ], ], '5XX' => [ 'schema' => [ 'type' => 'object', 'properties' => [ 'code' => [ 'type' => 'string', ], 'requestId' => [ 'type' => 'string', ], 'message' => [ 'type' => 'string', ], 'httpCode' => [ 'type' => 'integer', 'format' => 'int32', ], ], ], ], ], 'responseDemo' => '[{"type":"json","example":"{\\n \\"requestId\\": \\"80326EFE-485F-46E7-B291-5A1DD08D2198\\",\\n \\"result\\": {\\n \\"created\\": \\"1591086323\\",\\n \\"analyzer\\": \\"dianshang\\",\\n \\"updated\\": \\"1591086323\\",\\n \\"type\\": \\"ner\\",\\n \\"name\\": \\"testb\\"\\n }\\n}","errorExample":""},{"type":"xml","example":"80326EFE-485F-46E7-B291-5A1DD08D2198\\n\\n dianshang\\n 1591086323\\n 1001\\n testb\\n ner\\n 1591086323\\n","errorExample":""}]', 'title' => '创建干预词典', 'requestParamsDescription' => '**请求体**'."\n" .'| 字段 | 类型 | 是否必要 | 示例值 | 描述 |'."\n" .'| --- | --- | --- | --- | --- |'."\n" .'| name | String | 是 | "my_dict" | 干预词典名称 |'."\n" .'| type | String | 是 | "ner" | 干预词典类型 |'."\n" .'| analyzer | String | 否 | "my_analyzer" | 自定义分词
当type=ner时，此项必填 |'."\n" .'| analyzerType| String | 否 | "SYSTEM" | 分析器类型
|'."\n" ."\n" .'参考：[InterventionDictionary](~~173608~~)
', 'responseParamsDescription' => ' ', 'extraInfo' => ' ', ], 'DescribeInterventionDictionary' => [ 'summary' => '获取干预词典详情。', 'path' => '/v4/openapi/intervention-dictionaries/{name}', 'methods' => [ 'get', ], 'schemes' => [ 'http', 'https', ], 'security' => [ [ 'AK' => [], ], ], 'operationType' => 'read', 'deprecated' => false, 'systemTags' => [ 'operationType' => 'get', 'riskType' => 'none', 'chargeType' => 'free', 'abilityTreeNodes' => [ 'FEATUREopensearchNCXKUT', 'FEATUREopensearchUIICM8', ], ], 'parameters' => [ [ 'name' => 'name', 'in' => 'path', 'schema' => [ 'description' => '干预词典名称', 'type' => 'string', 'required' => true, 'docRequired' => true, 'example' => 'my_dict', ], ], ], 'responses' => [ 200 => [ 'schema' => [ 'type' => 'object', 'properties' => [ 'requestId' => [ 'description' => '请求ID', 'type' => 'string', 'example' => 'D7CCF454-472A-030E-F254-604520B028AA', ], 'result' => [ 'description' => '干预词典详情', 'type' => 'object', 'properties' => [ 'created' => [ 'description' => '创建时间', 'type' => 'string', 'example' => '1536233287', ], 'analyzer' => [ 'description' => '自定义分词', 'type' => 'string', 'example' => '-', ], 'updated' => [ 'description' => '更新时间', 'type' => 'string', 'example' => '1536233287', ], 'type' => [ 'description' => '类型'."\n" .'- stopword 停用词'."\n" .'- synonym 同义词'."\n" .'- correction 拼写纠错'."\n" .'- category_prediction 类目预测'."\n" .'- ner 实体识别'."\n" .'- term_weighting 词权重', 'type' => 'string', 'example' => 'category_prediction', ], 'name' => [ 'description' => '名称', 'type' => 'string', 'example' => 'test', ], ], ], ], ], ], '5XX' => [ 'schema' => [ 'type' => 'object', 'properties' => [ 'code' => [ 'type' => 'string', ], 'requestId' => [ 'type' => 'string', ], 'message' => [ 'type' => 'string', ], ], ], ], ], 'responseDemo' => '[{"type":"json","example":"{\\n \\"requestId\\": \\"D7CCF454-472A-030E-F254-604520B028AA\\",\\n \\"result\\": {\\n \\"created\\": \\"1536233287\\",\\n \\"analyzer\\": \\"-\\",\\n \\"updated\\": \\"1536233287\\",\\n \\"type\\": \\"category_prediction\\",\\n \\"name\\": \\"test\\"\\n }\\n}","errorExample":""},{"type":"xml","example":"D7CCF454-472A-030E-F254-604520B028AA\\n\\n test\\n category_prediction\\n \\n 1536233287\\n 1536233287\\n","errorExample":""}]', 'title' => '获取干预词典详情', ], 'RemoveInterventionDictionary' => [ 'summary' => '删除干预词典。', 'path' => '/v4/openapi/intervention-dictionaries/{name}', 'methods' => [ 'delete', ], 'schemes' => [ 'http', 'https', ], 'security' => [ [ 'AK' => [], ], ], 'operationType' => 'readAndWrite', 'systemTags' => [ 'operationType' => 'delete', 'riskType' => 'none', 'chargeType' => 'free', 'abilityTreeNodes' => [ 'FEATUREopensearchNCXKUT', 'FEATUREopensearchUIICM8', ], ], 'parameters' => [ [ 'name' => 'name', 'in' => 'path', 'schema' => [ 'description' => '干预词典名称', 'type' => 'string', 'required' => false, 'example' => '“my_dict”', ], ], ], 'responses' => [ 200 => [ 'schema' => [ 'type' => 'object', 'properties' => [ 'requestId' => [ 'description' => '请求ID', 'type' => 'string', 'example' => '06BBD41A-5F72-34E4-2DAF-E43B0526051D', ], 'result' => [ 'description' => '干预词典详情', 'type' => 'object', 'properties' => [ 'created' => [ 'description' => '创建时间', 'type' => 'string', 'example' => '1539158313', ], 'analyzer' => [ 'description' => '自定义分词', 'type' => 'string', 'example' => '""', ], 'updated' => [ 'description' => '更新时间', 'type' => 'string', 'example' => '1539158313', ], 'type' => [ 'description' => '类型'."\n" .'- stopword 停用词'."\n" .'- synonym 同义词'."\n" .'- correction 拼写纠错'."\n" .'- category_prediction 类目预测'."\n" .'- ner 实体识别'."\n" .'- term_weighting 词权重', 'type' => 'string', 'example' => 'synonym', ], 'name' => [ 'description' => '名称', 'type' => 'string', 'example' => 'tongyici', ], ], ], ], ], ], '5XX' => [ 'schema' => [ 'type' => 'object', 'properties' => [ 'code' => [ 'type' => 'string', ], 'requestId' => [ 'type' => 'string', ], 'message' => [ 'type' => 'string', ], 'httpCode' => [ 'type' => 'integer', 'format' => 'int32', ], ], ], ], ], 'responseDemo' => '[{"type":"json","example":"{\\n \\"requestId\\": \\"06BBD41A-5F72-34E4-2DAF-E43B0526051D\\",\\n \\"result\\": {\\n \\"created\\": \\"1539158313\\",\\n \\"analyzer\\": \\"\\\\\\"\\\\\\"\\",\\n \\"updated\\": \\"1539158313\\",\\n \\"type\\": \\"synonym\\",\\n \\"name\\": \\"tongyici\\"\\n }\\n}","errorExample":""},{"type":"xml","example":"06BBD41A-5F72-34E4-2DAF-E43B0526051D\\n\\n 123\\n testb\\n ner\\n abc\\n 1587957529\\n 1587957529\\n","errorExample":""}]', 'title' => '删除干预词典', 'requestParamsDescription' => ' ', 'responseParamsDescription' => ' ', ], 'ListInterventionDictionaryEntries' => [ 'summary' => '获取干预词条清单。', 'path' => '/v4/openapi/intervention-dictionaries/{name}/entries', 'methods' => [ 'get', ], 'schemes' => [ 'http', 'https', ], 'security' => [ [ 'AK' => [], ], ], 'operationType' => 'read', 'deprecated' => false, 'systemTags' => [ 'operationType' => 'list', 'riskType' => 'none', 'chargeType' => 'free', 'abilityTreeNodes' => [ 'FEATUREopensearch2ESE2N', ], ], 'parameters' => [ [ 'name' => 'name', 'in' => 'path', 'schema' => [ 'description' => '干预词典名称', 'type' => 'string', 'required' => true, 'docRequired' => true, 'example' => 'my_dict', ], ], [ 'name' => 'word', 'in' => 'query', 'schema' => [ 'description' => '词条', 'type' => 'string', 'required' => false, 'example' => '测试', ], ], [ 'name' => 'pageNumber', 'in' => 'query', 'schema' => [ 'description' => '页码，默认 pageNumber=1', 'type' => 'integer', 'format' => 'int32', 'required' => false, 'docRequired' => false, 'example' => '1', ], ], [ 'name' => 'pageSize', 'in' => 'query', 'schema' => [ 'description' => '每页返回数目，默认 pageSize=10', 'type' => 'integer', 'format' => 'int32', 'required' => false, 'example' => '10', ], ], ], 'responses' => [ 200 => [ 'schema' => [ 'type' => 'object', 'properties' => [ 'totalCount' => [ 'description' => '总条数', 'type' => 'integer', 'format' => 'int32', 'example' => '8', ], 'requestId' => [ 'description' => '请求ID', 'type' => 'string', 'example' => '516A02B7-2167-8D92-12D0-B639A2A0F3C5', ], 'result' => [ 'description' => '干预词条详情'."\n" ."\n" .'参考：[InterventionDictionaryEntry](~~173606~~)', 'type' => 'array', 'items' => [ 'type' => 'object', 'properties' => [ 'cmd' => [ 'description' => '操作命令'."\n" ."\n" .'- add 新增'."\n" .'- delete 删除', 'type' => 'string', 'example' => 'add', ], 'created' => [ 'description' => '创建时间戳', 'type' => 'integer', 'format' => 'int64', 'example' => '1536690285', ], 'word' => [ 'description' => '词条', 'type' => 'string', 'example' => '\\u8fc7\\u513f', ], 'relevance' => [ 'description' => '干预内容'."\n" .'键为类目预测ID，值为相关度（0：不相关；1：略相关；2：相关）'."\n" .'例：{“2”:1,”100”:0}', 'type' => 'object', 'example' => ' { "100": "0", "200": "2" }', ], 'status' => [ 'description' => '状态'."\n" ."\n" .'- ACTIVE 已生效', 'type' => 'string', 'example' => 'ACTIVE', ], 'updated' => [ 'description' => '更新时间戳', 'type' => 'integer', 'format' => 'int64', 'example' => '1537348987', ], 'tokens' => [ 'description' => '词权重内容', 'type' => 'array', 'items' => [ 'type' => 'object', 'properties' => [ 'tag' => [ 'description' => '识别结果的英文名'."\n" ."\n" .'- brand 品牌'."\n" .'- category 品类'."\n" .'- material 材质'."\n" .'- element 款式元素'."\n" .'- style 风格'."\n" .'- color 颜色'."\n" .'- function 功能功效'."\n" .'- scenario 场景'."\n" .'- people 人群'."\n" .'- season 时间季节'."\n" .'- model 型号'."\n" .'- region 地点地域'."\n" .'- name 人名'."\n" .'- adjective 修饰'."\n" .'- category-modifier 品类修饰词'."\n" .'- size 尺寸规格'."\n" .'- quality 品质成色'."\n" .'- suit 套装'."\n" .'- new-release 新品'."\n" .'- series 系列'."\n" .'- marketing 营销服务'."\n" .'- entertainment 文娱书文曲'."\n" .'- organization 机构实体'."\n" .'- movie 影视名称'."\n" .'- game 游戏名称'."\n" .'- number 数字'."\n" .'- unit 单位'."\n" .'- common 普通词'."\n" .'- new-word 新词'."\n" .'- proper-noun 专有名词'."\n" .'- symbol 符号'."\n" .'- prefix 前缀'."\n" .'- suffix 后缀'."\n" .'- gift 赠送'."\n" .'- negative 否定'."\n" .'- agent 代理', 'type' => 'string', 'example' => 'category', ], 'token' => [ 'description' => '实体词', 'type' => 'string', 'example' => '本', ], 'order' => [ 'description' => '序号', 'type' => 'integer', 'format' => 'int32', 'example' => '1', ], 'tagLabel' => [ 'description' => '识别结果的中文名，同上', 'type' => 'string', 'example' => '品类', ], ], ], ], ], ], ], ], ], ], '5XX' => [ 'schema' => [ 'type' => 'object', 'properties' => [ 'code' => [ 'type' => 'string', ], 'requestId' => [ 'type' => 'string', ], 'message' => [ 'type' => 'string', ], 'httpCode' => [ 'type' => 'integer', 'format' => 'int32', ], ], ], ], ], 'responseDemo' => '[{"type":"json","example":"{\\n \\"totalCount\\": 8,\\n \\"requestId\\": \\"516A02B7-2167-8D92-12D0-B639A2A0F3C5\\",\\n \\"result\\": [\\n {\\n \\"cmd\\": \\"add\\",\\n \\"created\\": 1536690285,\\n \\"word\\": \\"\\\\\\\\u8fc7\\\\\\\\u513f\\",\\n \\"relevance\\": {\\n \\"100\\": \\"0\\",\\n \\"200\\": \\"2\\"\\n },\\n \\"status\\": \\"ACTIVE\\",\\n \\"updated\\": 1537348987,\\n \\"tokens\\": [\\n {\\n \\"tag\\": \\"category\\",\\n \\"token\\": \\"本\\",\\n \\"order\\": 1,\\n \\"tagLabel\\": \\"品类\\"\\n }\\n ]\\n }\\n ]\\n}","errorExample":""},{"type":"xml","example":"516A02B7-2167-8D92-12D0-B639A2A0F3C5\\n\\n add\\n 过儿\\n 1536690285\\n 1537348987\\n ACTIVE\\n \\n <100>0\\n <200>2\\n \\n\\n\\n add\\n 过\\n 1536690308\\n 1537349055\\n ACTIVE\\n \\n <200>2\\n \\n\\n\\n add\\n 苹\\n 1536683292\\n 1537220498\\n ACTIVE\\n \\n <12>1\\n \\n\\n\\n add\\n 吧\\n 1536690347\\n 1537220498\\n ACTIVE\\n \\n <100>2\\n <200>0\\n \\n\\n\\n add\\n 果\\n 1536690184\\n 1537220498\\n ACTIVE\\n \\n <100>2\\n \\n\\n\\n add\\n 裤子\\n 1537353071\\n 1537353074\\n ACTIVE\\n \\n <100>1\\n <200>2\\n \\n\\n\\n add\\n adfads\\n 1536690258\\n 1537220498\\n ACTIVE\\n \\n <1>1\\n <2>1\\n <3>1\\n \\n\\n\\n add\\n zvzcxv\\n 1536690537\\n 1537220498\\n ACTIVE\\n \\n <100>1\\n \\n\\n8","errorExample":""}]', 'title' => '获取干预词条清单', 'requestParamsDescription' => ' ', 'responseParamsDescription' => ' ', 'extraInfo' => ' ', ], 'PushInterventionDictionaryEntries' => [ 'summary' => '接收干预词条变更。', 'path' => '/v4/openapi/intervention-dictionaries/{name}/entries/actions/bulk', 'methods' => [ 'post', ], 'schemes' => [ 'http', 'https', ], 'security' => [ [ 'AK' => [], ], [ 'APP' => [], ], ], 'operationType' => 'write', 'deprecated' => false, 'systemTags' => [ 'operationType' => 'update', 'riskType' => 'none', 'chargeType' => 'free', 'abilityTreeNodes' => [ 'FEATUREopensearchNCXKUT', 'FEATUREopensearchUIICM8', ], ], 'parameters' => [ [ 'name' => 'name', 'in' => 'path', 'schema' => [ 'description' => '干预词典名称', 'type' => 'string', 'required' => true, 'docRequired' => true, 'example' => 'my_dict', ], ], [ 'name' => 'dryRun', 'in' => 'query', 'schema' => [ 'description' => '是否校验入参数据合法性，默认false。'."\n" ."\n" .'取值：'."\n" ."\n" .'- **true**：只校验参数合法性。'."\n" ."\n" .'- **false**：校验参数合法性，创建归因配置。', 'type' => 'boolean', 'required' => false, 'example' => 'false', ], ], [ 'name' => 'body', 'in' => 'body', 'style' => 'json', 'schema' => [ 'description' => '请求体。', 'type' => 'array', 'items' => [ 'description' => '请求体', 'type' => 'object', 'required' => false, 'example' => '{'."\n" .' "cmd": "add",'."\n" .' "word": "搜索",'."\n" .' "created": 1536661485,'."\n" .' "updated": 1537320187,'."\n" .' "status": "ACTIVE",'."\n" .' "relevance": {'."\n" .' "100": "0",'."\n" .' "200": "2"'."\n" .' }'."\n" .'}', ], 'required' => false, 'maxItems' => 100, ], ], ], 'responses' => [ 200 => [ 'schema' => [ 'type' => 'object', 'properties' => [ 'requestId' => [ 'description' => '请求ID', 'type' => 'string', 'example' => 'D77D0DAF-790D-F5F5-A9C0-133738165014', ], 'result' => [ 'description' => '返回结果', 'type' => 'array', 'items' => [ 'description' => '返回结果', 'type' => 'string', 'example' => '[]', ], ], ], ], ], '5XX' => [ 'schema' => [ 'type' => 'object', 'properties' => [ 'code' => [ 'type' => 'string', ], 'requestId' => [ 'type' => 'string', ], 'message' => [ 'type' => 'string', ], 'httpCode' => [ 'type' => 'integer', 'format' => 'int32', ], ], ], ], ], 'responseDemo' => '[{"type":"json","example":"{\\n \\"requestId\\": \\"D77D0DAF-790D-F5F5-A9C0-133738165014\\",\\n \\"result\\": [\\n \\"[]\\"\\n ]\\n}","errorExample":""},{"type":"xml","example":"D77D0DAF-790D-F5F5-A9C0-133738165014","errorExample":""}]', 'title' => '接收干预词条变更', 'requestParamsDescription' => '**请求体**'."\n" .'通用参数'."\n" ."\n" .'| 字段 | 类型 | 是否必要 | 示例值 | 描述 |'."\n" .'| --- | --- | --- | --- | --- |'."\n" .'| [] | Object | 是 | | 词条信息 |'."\n" .'| [].cmd | String | 是 | "add" | 操作命令
- add  新增
- delete  删除
|'."\n" .'| [].word | String | 是 | "阿里云" | 词条 |'."\n" ."\n" .'特定参数'."\n" .'参考：'."\n" ."\n" .'- [stopword  停用词](~~173606~~)'."\n" .'- [synonym  同义词](~~173606~~)'."\n" .'- [correction  拼写纠错](~~173606~~)'."\n" .'- [term_weighting  词权重](~~173606~~)'."\n" .'- [category_prediction  类目预测](~~173606~~)'."\n" .'- [ner  实体识别](~~173606~~)'."\n" .'- [suggest_allowlist 下拉提示白名单](~~173606~~)'."\n" .'- [suggest_denylist 下拉提示黑名单](~~173606~~)'."\n" .'- [hot_allowlist 热搜白名单](~~173606~~)'."\n" .'- [hot_denylist 热搜黑名单](~~173606~~)'."\n" .'- [hint_allowlist 底纹白名单](~~173606~~)'."\n" .'- [hint_denylist 底纹黑名单](~~173606~~)'."\n" ."\n\n", 'responseParamsDescription' => ' ', 'extraInfo' => ' ', ], 'ListInterventionDictionaryRelatedEntities' => [ 'summary' => '获取与干预词典关联的资源清单。如果某个干预词典被qp引用，则列出来所有的应用及QP信息。', 'path' => '/v4/openapi/intervention-dictionaries/{name}/related', 'methods' => [ 'get', ], 'schemes' => [ 'http', 'https', ], 'security' => [ [ 'AK' => [], ], ], 'operationType' => 'read', 'deprecated' => false, 'systemTags' => [ 'operationType' => 'none', 'riskType' => 'none', 'chargeType' => 'free', 'abilityTreeNodes' => [ 'FEATUREopensearchUIICM8', ], ], 'parameters' => [ [ 'name' => 'name', 'in' => 'path', 'schema' => [ 'description' => '干预词典名称', 'type' => 'string', 'required' => true, 'docRequired' => true, 'example' => 'my_dict', ], ], ], 'responses' => [ 200 => [ 'schema' => [ 'type' => 'object', 'properties' => [ 'requestId' => [ 'description' => '请求ID', 'type' => 'string', 'example' => 'D77D0DAF-790D-F5F5-A9C0-133738165014', ], 'result' => [ 'type' => 'array', 'items' => [ 'description' => '应用及QP信息，无结果时为空', 'type' => 'object', 'example' => '[]', ], ], ], ], ], '5XX' => [ 'schema' => [ 'type' => 'object', 'properties' => [ 'code' => [ 'type' => 'string', ], 'requestId' => [ 'type' => 'string', ], 'message' => [ 'type' => 'string', ], 'httpCode' => [ 'type' => 'integer', 'format' => 'int32', ], ], ], ], ], 'responseDemo' => '[{"type":"json","example":"{\\n \\"requestId\\": \\"D77D0DAF-790D-F5F5-A9C0-133738165014\\",\\n \\"result\\": [\\n \\"[]\\"\\n ]\\n}","errorExample":""},{"type":"xml","example":"65956EC5-71B8-8A21-2F2E-FBE7E7292AD6\\n\\n test_srn_mysql\\n \\n it_content\\n true\\n short_text\\n text_pack\\n short_text_pack\\n \\n true\\n tst\\n stop_word\\n \\n \\n true\\n test_han_jiuduo_2\\n spell_check\\n \\n \\n true\\n test_han_tongyici\\n synonym\\n \\n \\n true\\n \\n term_weighting\\n \\n IT_CONTENT\\n 1585714793\\n 1591163738\\n \\n","errorExample":""}]', 'title' => '获取与干预词典关联的资源清单', 'requestParamsDescription' => ' ', 'responseParamsDescription' => ' | 字段 | 类型 | 描述 |'."\n" .'| --- | --- | --- |'."\n" .'| result[].appGroup | String | 应用名 |'."\n" .'| result[].queryProcessor | Object | QP信息
参考：[QueryProcessor](~~170014~~) |', 'extraInfo' => ' ', ], 'ListInterventionDictionaryNerResults' => [ 'summary' => '获取实体识别结果。', 'path' => '/v4/openapi/intervention-dictionaries/{name}/ner-results', 'methods' => [ 'get', ], 'schemes' => [ 'http', 'https', ], 'security' => [ [ 'AK' => [], ], ], 'operationType' => 'read', 'deprecated' => false, 'systemTags' => [ 'operationType' => 'none', 'riskType' => 'none', 'chargeType' => 'free', 'abilityTreeNodes' => [ 'FEATUREopensearchUIICM8', ], ], 'parameters' => [ [ 'name' => 'name', 'in' => 'path', 'schema' => [ 'description' => '干预词典名称', 'type' => 'string', 'required' => true, 'docRequired' => true, 'example' => 'my_dict', ], ], [ 'name' => 'query', 'in' => 'query', 'schema' => [ 'description' => '要搜索的关键词', 'type' => 'string', 'required' => true, 'docRequired' => true, 'example' => 'soy milk', ], ], ], 'responses' => [ 200 => [ 'schema' => [ 'type' => 'object', 'properties' => [ 'requestId' => [ 'description' => '请求ID', 'type' => 'string', 'example' => '8F780CA8-D4D4-2FFE-B8AC-42040822C554', ], 'result' => [ 'description' => '实体识别内容'."\n" ."\n" .'参考：[ner 实体识别](~~173606~~)', 'type' => 'array', 'items' => [ 'type' => 'object', 'properties' => [ 'tag' => [ 'description' => '识别结果的英文名'."\n" ."\n" .'- brand 品牌'."\n" .'- category 品类'."\n" .'- material 材质'."\n" .'- element 款式元素'."\n" .'- style 风格'."\n" .'- color 颜色'."\n" .'- function 功能功效'."\n" .'- scenario 场景'."\n" .'- people 人群'."\n" .'- season 时间季节'."\n" .'- model 型号'."\n" .'- region 地点地域'."\n" .'- name 人名'."\n" .'- adjective 修饰'."\n" .'- category-modifier 品类修饰词'."\n" .'- size 尺寸规格'."\n" .'- quality 品质成色'."\n" .'- suit 套装'."\n" .'- new-release 新品'."\n" .'- series 系列'."\n" .'- marketing 营销服务'."\n" .'- entertainment 文娱书文曲'."\n" .'- organization 机构实体'."\n" .'- movie 影视名称'."\n" .'- game 游戏名称'."\n" .'- number 数字'."\n" .'- unit 单位'."\n" .'- common 普通词'."\n" .'- new-word 新词'."\n" .'- proper-noun 专有名词'."\n" .'- symbol 符号'."\n" .'- prefix 前缀'."\n" .'- suffix 后缀'."\n" .'- gift 赠送'."\n" .'- negative 否定'."\n" .'- agent 代理', 'type' => 'string', 'example' => 'category', ], 'token' => [ 'description' => '实体词', 'type' => 'string', 'example' => 'milk', ], 'order' => [ 'description' => '序号', 'type' => 'integer', 'format' => 'int32', 'example' => '1', ], 'tagLabel' => [ 'description' => '识别结果的中文名，同上', 'type' => 'string', 'example' => '品类', ], ], ], ], ], ], ], '5XX' => [ 'schema' => [ 'type' => 'object', 'properties' => [ 'code' => [ 'type' => 'string', ], 'requestId' => [ 'type' => 'string', ], 'message' => [ 'type' => 'string', ], 'httpCode' => [ 'type' => 'integer', 'format' => 'int32', ], ], ], ], ], 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"requestId\\": \\"8F780CA8-D4D4-2FFE-B8AC-42040822C554\\",\\n \\"result\\": [\\n {\\n \\"tag\\": \\"category\\",\\n \\"token\\": \\"milk\\",\\n \\"order\\": 1,\\n \\"tagLabel\\": \\"品类\\"\\n }\\n ]\\n}","type":"json"}]', 'title' => '获取实体识别结果', ], 'EnableSlowQuery' => [ 'summary' => '启用优化大师慢查询服务。', 'path' => '/v4/openapi/app-groups/{appGroupIdentity}/optimizers/slow-query/actions/enable', 'methods' => [ 'post', ], 'schemes' => [ 'http', 'https', ], 'security' => [ [ 'AK' => [], ], ], 'operationType' => 'write', 'deprecated' => false, 'systemTags' => [ 'operationType' => 'none', 'riskType' => 'none', 'chargeType' => 'free', 'abilityTreeNodes' => [ 'FEATUREopensearchA0YLTY', 'FEATUREopensearch9TYTPZ', ], ], 'parameters' => [ [ 'name' => 'appGroupIdentity', 'in' => 'path', 'schema' => [ 'description' => '应用名称', 'type' => 'string', 'required' => true, 'docRequired' => true, 'example' => 'my_app_group_name', ], ], ], 'responses' => [ 200 => [ 'schema' => [ 'type' => 'object', 'properties' => [ 'result' => [ 'description' => '返回结果', 'type' => 'object', 'example' => '{}', ], 'requestId' => [ 'description' => '请求ID', 'type' => 'string', 'example' => '728E89C6-8673-D39B-39A1-5BA2B56D448F', ], ], ], ], '5XX' => [ 'schema' => [ 'type' => 'object', 'properties' => [ 'code' => [ 'type' => 'string', ], 'message' => [ 'type' => 'string', ], 'requestId' => [ 'type' => 'string', ], 'httpCode' => [ 'type' => 'integer', 'format' => 'int32', ], ], ], ], ], 'responseDemo' => '[{"type":"json","example":"{\\n \\"result\\": {},\\n \\"requestId\\": \\"728E89C6-8673-D39B-39A1-5BA2B56D448F\\"\\n}","errorExample":""},{"type":"xml","example":"728E89C6-8673-D39B-39A1-5BA2B56D448F\\n","errorExample":""}]', 'title' => '启用优化大师慢查询服务', ], 'DisableSlowQuery' => [ 'summary' => '禁用优化大师慢查询服务。', 'path' => '/v4/openapi/app-groups/{appGroupIdentity}/optimizers/slow-query/actions/disable', 'methods' => [ 'post', ], 'schemes' => [ 'http', 'https', ], 'security' => [ [ 'AK' => [], ], ], 'operationType' => 'write', 'deprecated' => false, 'systemTags' => [ 'operationType' => 'none', 'riskType' => 'none', 'chargeType' => 'free', 'abilityTreeNodes' => [ 'FEATUREopensearchA0YLTY', 'FEATUREopensearch9TYTPZ', ], ], 'parameters' => [ [ 'name' => 'appGroupIdentity', 'in' => 'path', 'schema' => [ 'description' => '应用名称', 'type' => 'string', 'required' => true, 'docRequired' => true, 'example' => 'my_app_group_name', ], ], ], 'responses' => [ 200 => [ 'schema' => [ 'type' => 'object', 'properties' => [ 'result' => [ 'description' => '返回结果', 'type' => 'object', 'example' => '{}', ], 'requestId' => [ 'description' => '请求ID', 'type' => 'string', 'example' => '728E89C6-8673-D39B-39A1-5BA2B56D448F', ], ], ], ], '5XX' => [ 'schema' => [ 'type' => 'object', 'properties' => [ 'code' => [ 'type' => 'string', ], 'message' => [ 'type' => 'string', ], 'requestId' => [ 'type' => 'string', ], 'httpCode' => [ 'type' => 'integer', 'format' => 'int32', ], ], ], ], ], 'responseDemo' => '[{"type":"json","example":"{\\n \\"result\\": {},\\n \\"requestId\\": \\"728E89C6-8673-D39B-39A1-5BA2B56D448F\\"\\n}","errorExample":""},{"type":"xml","example":"728E89C6-8673-D39B-39A1-5BA2B56D448F\\n","errorExample":""}]', 'title' => '禁用优化大师慢查询服务', ], 'DescribeSlowQueryStatus' => [ 'summary' => '获取优化大师慢查询开通状态。', 'path' => '/v4/openapi/app-groups/{appGroupIdentity}/optimizers/slow-query', 'methods' => [ 'get', ], 'schemes' => [ 'http', 'https', ], 'security' => [ [ 'AK' => [], ], ], 'operationType' => 'read', 'deprecated' => false, 'systemTags' => [ 'operationType' => 'none', 'riskType' => 'none', 'chargeType' => 'free', 'abilityTreeNodes' => [ 'FEATUREopensearchA0YLTY', 'FEATUREopensearch9TYTPZ', ], ], 'parameters' => [ [ 'name' => 'appGroupIdentity', 'in' => 'path', 'schema' => [ 'description' => '应用名称', 'type' => 'string', 'required' => true, 'docRequired' => true, 'example' => 'my_app_group_name', ], ], ], 'responses' => [ 200 => [ 'schema' => [ 'type' => 'object', 'properties' => [ 'requestId' => [ 'description' => '请求ID', 'type' => 'string', 'example' => '5C1C1C45-C64A-AD30-565F-140871D57E5E', ], 'result' => [ 'description' => '返回结果', 'type' => 'object', 'properties' => [ 'region' => [ 'description' => '区域'."\n" .'- outer 外网'."\n" .'- internal 内网', 'type' => 'string', 'example' => 'internal', ], 'status' => [ 'description' => '开通状态'."\n" .'- enabled 开通'."\n" .'- disabled 未开通'."\n" .'- n/a 未知', 'type' => 'string', 'example' => 'disabled', ], 'appGroupId' => [ 'description' => '应用ID', 'type' => 'string', 'example' => '100298370', ], ], ], ], ], ], '5XX' => [ 'schema' => [ 'type' => 'object', 'properties' => [ 'code' => [ 'type' => 'string', ], 'message' => [ 'type' => 'string', ], 'requestId' => [ 'type' => 'string', ], 'httpCode' => [ 'type' => 'integer', 'format' => 'int32', ], ], ], ], ], 'responseDemo' => '[{"type":"json","example":"{\\n \\"requestId\\": \\"5C1C1C45-C64A-AD30-565F-140871D57E5E\\",\\n \\"result\\": {\\n \\"region\\": \\"internal\\",\\n \\"status\\": \\"disabled\\",\\n \\"appGroupId\\": \\"100298370\\"\\n }\\n}","errorExample":""},{"type":"xml","example":"5C1C1C45-C64A-AD30-565F-140871D57E5E\\n\\n internal\\n 100298370\\n disabled\\n","errorExample":""}]', 'title' => '获取优化大师慢查询开通状态', ], 'StartSlowQueryAnalyzer' => [ 'summary' => '立即进行慢查询分析。', 'path' => '/v4/openapi/app-groups/{appGroupIdentity}/optimizers/slow-query/actions/run', 'methods' => [ 'post', ], 'schemes' => [ 'http', 'https', ], 'security' => [ [ 'AK' => [], ], ], 'operationType' => 'write', 'deprecated' => false, 'systemTags' => [ 'operationType' => 'none', 'riskType' => 'none', 'chargeType' => 'free', 'abilityTreeNodes' => [ 'FEATUREopensearchA0YLTY', 'FEATUREopensearch9TYTPZ', ], ], 'parameters' => [ [ 'name' => 'appGroupIdentity', 'in' => 'path', 'schema' => [ 'description' => '应用名称', 'type' => 'string', 'required' => true, 'docRequired' => true, 'example' => '“my_app_group_name”', ], ], ], 'responses' => [ 200 => [ 'schema' => [ 'type' => 'object', 'properties' => [ 'result' => [ 'description' => '—', 'type' => 'object', 'example' => '{}', ], 'requestId' => [ 'description' => '请求ID', 'type' => 'string', 'example' => 'D77D0DAF-790D-F5F5-A9C0-133738165014', ], ], ], ], '5XX' => [ 'schema' => [ 'type' => 'object', 'properties' => [ 'code' => [ 'type' => 'string', ], 'message' => [ 'type' => 'string', ], 'requestId' => [ 'type' => 'string', ], 'httpCode' => [ 'type' => 'integer', 'format' => 'int32', ], ], ], ], ], 'responseDemo' => '[{"type":"json","example":"{\\n \\"result\\": {},\\n \\"requestId\\": \\"D77D0DAF-790D-F5F5-A9C0-133738165014\\"\\n}","errorExample":""},{"type":"xml","example":"D77D0DAF-790D-F5F5-A9C0-133738165014\\n","errorExample":""}]', 'title' => '立即进行慢查询分析', 'requestParamsDescription' => ' ', 'responseParamsDescription' => ' ', ], 'ListSlowQueryQueries' => [ 'summary' => '列出优化大师慢查询Query清单。', 'path' => '/v4/openapi/app-groups/{appGroupIdentity}/optimizers/slow-query/categories/{categoryIndex}/queries', 'methods' => [ 'get', ], 'schemes' => [ 'http', 'https', ], 'security' => [ [ 'AK' => [], ], ], 'operationType' => 'read', 'deprecated' => false, 'systemTags' => [ 'operationType' => 'none', 'riskType' => 'none', 'chargeType' => 'free', 'abilityTreeNodes' => [ 'FEATUREopensearchA0YLTY', 'FEATUREopensearch9TYTPZ', ], ], 'parameters' => [ [ 'name' => 'appGroupIdentity', 'in' => 'path', 'schema' => [ 'description' => '应用名称', 'type' => 'string', 'required' => true, 'docRequired' => true, 'example' => 'my_app_group_name', ], ], [ 'name' => 'categoryIndex', 'in' => 'path', 'schema' => [ 'description' => '优化建议ID', 'type' => 'string', 'required' => true, 'docRequired' => true, 'example' => '0', ], ], ], 'responses' => [ 200 => [ 'schema' => [ 'type' => 'object', 'properties' => [ 'requestId' => [ 'description' => '请求ID', 'type' => 'string', 'example' => 'EB250CA0-ACFD-C5DE-17CD-01445BFE8AE5', ], 'result' => [ 'description' => '返回结果', 'type' => 'object', 'properties' => [ 'index' => [ 'description' => '优化建议ID', 'type' => 'integer', 'format' => 'int32', 'example' => '0', ], 'appQuery' => [ 'description' => '优化建议信息', 'type' => 'string', 'example' => 'no data', ], 'start' => [ 'description' => '开始时间戳', 'type' => 'integer', 'format' => 'int32', 'example' => '1589986800', ], 'end' => [ 'description' => '结束时间戳', 'type' => 'integer', 'format' => 'int32', 'example' => '1589990340', ], ], ], ], ], ], '5XX' => [ 'schema' => [ 'type' => 'object', 'properties' => [ 'code' => [ 'type' => 'string', ], 'message' => [ 'type' => 'string', ], 'requestId' => [ 'type' => 'string', ], 'httpCode' => [ 'type' => 'integer', 'format' => 'int32', ], ], ], ], ], 'responseDemo' => '[{"type":"json","example":"{\\n \\"requestId\\": \\"EB250CA0-ACFD-C5DE-17CD-01445BFE8AE5\\",\\n \\"result\\": {\\n \\"index\\": 0,\\n \\"appQuery\\": \\"no data\\",\\n \\"start\\": 1589986800,\\n \\"end\\": 1589990340\\n }\\n}","errorExample":""},{"type":"xml","example":"EB250CA0-ACFD-C5DE-17CD-01445BFE8AE5\\n\\n 1589986800\\n 1589990340\\n 0\\n no data\\n","errorExample":""}]', 'title' => '列出慢查询Query清单', 'requestParamsDescription' => '**查询参数**'."\n" .'| 字段 | 类型 | 是否必要 | 示例值 | 描述 |'."\n" .'| --- | --- | --- | --- | --- |'."\n" .'| start | Integer | 是 | 1589986800 | 开始时间戳（精确到秒） |'."\n" .'| end | Integer | 是 | 1589990340 | 结束时间戳（精确到秒） |'."\n" .'| size | Integer | 否 | 10 | 返回条数 |', 'responseParamsDescription' => ' ', 'extraInfo' => ' ', ], 'ListSlowQueryCategories' => [ 'summary' => '列出优化大师慢查询优化建议清单。', 'path' => '/v4/openapi/app-groups/{appGroupIdentity}/optimizers/slow-query/categories', 'methods' => [ 'get', ], 'schemes' => [ 'http', 'https', ], 'security' => [ [ 'AK' => [], ], ], 'operationType' => 'read', 'deprecated' => false, 'systemTags' => [ 'operationType' => 'none', 'riskType' => 'none', 'chargeType' => 'free', 'abilityTreeNodes' => [ 'FEATUREopensearchA0YLTY', 'FEATUREopensearch9TYTPZ', ], ], 'parameters' => [ [ 'name' => 'appGroupIdentity', 'in' => 'path', 'schema' => [ 'description' => '应用名称', 'type' => 'string', 'required' => true, 'docRequired' => true, 'example' => 'my_app_group_name', ], ], ], 'responses' => [ 200 => [ 'schema' => [ 'type' => 'object', 'properties' => [ 'requestId' => [ 'description' => '请求ID', 'type' => 'string', 'example' => '4406F40B-A0A2-9D5D-531F-3B6936567584', ], 'result' => [ 'description' => '返回结果', 'type' => 'object', 'properties' => [ 'start' => [ 'description' => '开始时间戳', 'type' => 'integer', 'format' => 'int32', 'example' => '1589986800', ], 'analyzeStatus' => [ 'description' => '分析状态'."\n" ."\n" .'- PENDING 准备中'."\n" .'- SUCCESS 成功'."\n" .'- RUNNING 运行中'."\n" .'- FAILED 失败'."\n" .'- N/A 未知', 'type' => 'string', 'example' => '"PENDING"', ], 'end' => [ 'description' => '结束时间戳', 'type' => 'integer', 'format' => 'int32', 'example' => '1589990340', ], ], ], ], ], ], '5XX' => [ 'schema' => [ 'type' => 'object', 'properties' => [ 'code' => [ 'type' => 'string', ], 'message' => [ 'type' => 'string', ], 'requestId' => [ 'type' => 'string', ], 'httpCode' => [ 'type' => 'integer', 'format' => 'int32', ], ], ], ], ], 'responseDemo' => '[{"type":"json","example":"{\\n \\"requestId\\": \\"4406F40B-A0A2-9D5D-531F-3B6936567584\\",\\n \\"result\\": {\\n \\"start\\": 1589986800,\\n \\"analyzeStatus\\": \\"\\\\\\"PENDING\\\\\\"\\",\\n \\"end\\": 1589990340\\n }\\n}","errorExample":""},{"type":"xml","example":"4406F40B-A0A2-9D5D-531F-3B6936567584\\n\\n PENDING\\n 1589986800\\n 1589990340\\n","errorExample":""}]', 'title' => '列出优化大师慢查询优化建议清单', 'requestParamsDescription' => '**请求示例**'."\n" ."\n" .'`GET /v4/openapi/app-groups/kevintest2/optimizers/slow-query/categories?end=1589990340&sort=max&start=1589986800'."\n" .'`'."\n" ."\n\n" .'**查询参数**'."\n" .'| 字段 | 类型 | 是否必要 | 示例值 | 描述 |'."\n" .'| --- | --- | --- | --- | --- |'."\n" .'| start | Integer | 是 | 1589986800 | 开始时间戳（精确到秒） |'."\n" .'| end | Integer | 是 | 1589990340 | 结束时间戳（精确到秒） |'."\n" .'| sort | String | 否 | "max" | 排序类型
- max  最大值
- avg  平均值
- sum  总值
- queryProportion  查询比例
|', ], 'ListQuotaReviewTasks' => [ 'summary' => '获取指定 opensearch 应用配额审批清单。', 'path' => '/v4/openapi/app-groups/{appGroupIdentity}/quota-review-tasks', 'methods' => [ 'get', ], 'schemes' => [ 'http', 'https', ], 'security' => [ [ 'AK' => [], ], ], 'operationType' => 'read', 'deprecated' => false, 'systemTags' => [ 'operationType' => 'none', 'riskType' => 'none', 'chargeType' => 'free', 'abilityTreeNodes' => [ 'FEATUREopensearch447AAX', 'FEATUREopensearch5OZOSP', ], ], 'parameters' => [ [ 'name' => 'appGroupIdentity', 'in' => 'path', 'schema' => [ 'description' => '应用名称', 'type' => 'string', 'required' => true, 'docRequired' => true, 'example' => '"my_app_name"', ], ], [ 'name' => 'pageNumber', 'in' => 'query', 'schema' => [ 'description' => '页码，默认 pageNumber=1', 'type' => 'integer', 'format' => 'int32', 'required' => false, 'example' => '1', ], ], [ 'name' => 'pageSize', 'in' => 'query', 'schema' => [ 'description' => '每页返回数目，默认 pageSize=10', 'type' => 'integer', 'format' => 'int32', 'required' => false, 'example' => '10', ], ], ], 'responses' => [ 200 => [ 'schema' => [ 'description' => '返回对象', 'type' => 'object', 'properties' => [ 'totalCount' => [ 'description' => '总条数', 'type' => 'integer', 'format' => 'int32', 'example' => '500', ], 'requestId' => [ 'description' => '请求id', 'type' => 'string', 'example' => '"3351A21F-705B-508C-9450-DA65A681547F"', ], 'result' => [ 'description' => '审批工单信息参考：[quotareviewtask](~~173609~~)', 'type' => 'array', 'items' => [ 'description' => '结果对象', 'type' => 'object', 'properties' => [ 'oldDocSize' => [ 'description' => '原存储容量', 'type' => 'integer', 'format' => 'int32', 'example' => '900', ], 'pending' => [ 'description' => '是否待处理', 'type' => 'boolean', 'example' => 'false', ], 'memo' => [ 'description' => '备注', 'type' => 'string', 'example' => 'null', ], 'approved' => [ 'description' => '是否通过审批', 'type' => 'boolean', 'example' => 'true', ], 'oldSpec' => [ 'description' => '原应用规格', 'type' => 'string', 'example' => '"opensearch.private.common"', ], 'oldComputeResource' => [ 'description' => '原计算资源', 'type' => 'integer', 'format' => 'int32', 'example' => '500', ], 'appGroupType' => [ 'description' => '应用类型', 'type' => 'string', 'example' => '"standard"', ], 'available' => [ 'description' => '是否可用', 'type' => 'boolean', 'example' => 'true', ], 'gmtCreate' => [ 'description' => '创建时间', 'type' => 'string', 'example' => '"2020-04-08T08:29:45+0000"', ], 'newSocSize' => [ 'description' => '目标存储容量', 'type' => 'integer', 'format' => 'int32', 'example' => '1100', ], 'id' => [ 'description' => '工单ID', 'type' => 'integer', 'format' => 'int32', 'example' => '142', ], 'appGroupId' => [ 'description' => '应用ID', 'type' => 'integer', 'format' => 'int32', 'example' => '120123456', ], 'newComputeResource' => [ 'description' => '目标计算资源', 'type' => 'integer', 'format' => 'int32', 'example' => '6000', ], 'appGroupName' => [ 'description' => '应用名称', 'type' => 'string', 'example' => '"td_test_os"', ], 'gmtModified' => [ 'description' => '更新时间', 'type' => 'string', 'example' => '"2020-04-08T08:36:36+0000"', ], 'newSpec' => [ 'description' => '目标应用规格', 'type' => 'string', 'example' => '"opensearch.private.common"', ], ], 'example' => '{}', ], 'example' => '[]', ], ], ], ], '5XX' => [ 'schema' => [ 'type' => 'object', 'properties' => [ 'code' => [ 'type' => 'string', ], 'httpCode' => [ 'type' => 'integer', 'format' => 'int32', ], 'requestId' => [ 'type' => 'string', ], 'message' => [ 'type' => 'string', ], ], ], ], ], 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"totalCount\\": 500,\\n \\"requestId\\": \\"\\\\\\"3351A21F-705B-508C-9450-DA65A681547F\\\\\\"\\",\\n \\"result\\": [\\n {\\n \\"oldDocSize\\": 900,\\n \\"pending\\": false,\\n \\"memo\\": \\"null\\",\\n \\"approved\\": true,\\n \\"oldSpec\\": \\"\\\\\\"opensearch.private.common\\\\\\"\\",\\n \\"oldComputeResource\\": 500,\\n \\"appGroupType\\": \\"\\\\\\"standard\\\\\\"\\",\\n \\"available\\": true,\\n \\"gmtCreate\\": \\"\\\\\\"2020-04-08T08:29:45+0000\\\\\\"\\",\\n \\"newSocSize\\": 1100,\\n \\"id\\": 142,\\n \\"appGroupId\\": 120123456,\\n \\"newComputeResource\\": 6000,\\n \\"appGroupName\\": \\"\\\\\\"td_test_os\\\\\\"\\",\\n \\"gmtModified\\": \\"\\\\\\"2020-04-08T08:36:36+0000\\\\\\"\\",\\n \\"newSpec\\": \\"\\\\\\"opensearch.private.common\\\\\\"\\"\\n }\\n ]\\n}","type":"json"}]', 'title' => '获取指定应用配额审批清单', 'requestParamsDescription' => '请求示例：'."\n" ."\n" .'```'."\n" .'GET /v4/openapi/app-groups/demo/quota-review-tasks'."\n" .'```', 'responseParamsDescription' => '返回结果示例：'."\n" .'```json'."\n" .'{'."\n" .' "id": 142,'."\n" .' "appGroupId": 120577535,'."\n" .' "appGroupName": "td_trade_order_os",'."\n" .' "appGroupType": "standard",'."\n" .' "oldSpec": "opensearch.private.common",'."\n" .' "oldComputeResource": 500,'."\n" .' "oldDocSize": 900,'."\n" .' "newSpec": "opensearch.private.common",'."\n" .' "newComputeResource": 6000,'."\n" .' "newSocSize": 1100,'."\n" .' "memo": null,'."\n" .' "available": true,'."\n" .' "pending": false,'."\n" .' "approved": true,'."\n" .' "gmtCreate": "2020-04-08T08:29:45+0000",'."\n" .' "gmtModified": "2020-04-08T08:36:36+0000"'."\n" .'}'."\n" .'```', ], 'ListScheduledTasks' => [ 'summary' => '获取OpenSearch应用定时任务列表。', 'path' => '/v4/openapi/app-groups/{appGroupIdentity}/scheduled-tasks', 'methods' => [ 'get', ], 'schemes' => [ 'http', 'https', ], 'security' => [ [ 'AK' => [], ], ], 'operationType' => 'read', 'deprecated' => false, 'systemTags' => [ 'operationType' => 'list', 'riskType' => 'none', 'chargeType' => 'free', 'abilityTreeNodes' => [ 'FEATUREopensearch447AAX', 'FEATUREopensearch5OZOSP', ], ], 'parameters' => [ [ 'name' => 'appGroupIdentity', 'in' => 'path', 'schema' => [ 'description' => '应用名称', 'type' => 'string', 'required' => true, 'docRequired' => true, 'example' => 'my_app_group_name', ], ], [ 'name' => 'type', 'in' => 'query', 'schema' => [ 'description' => '定时任务类型'."\n" ."\n" .'- wipe 数据清理'."\n" .'- fork 索引重建'."\n" .'- check-status 检查应用状态'."\n" .'- index 索引重建'."\n", 'type' => 'string', 'required' => false, 'example' => 'wipe', ], ], [ 'name' => 'pageNumber', 'in' => 'query', 'schema' => [ 'description' => '页码，默认 pageNumber = 1', 'type' => 'integer', 'format' => 'int32', 'required' => false, 'example' => '1', ], ], [ 'name' => 'pageSize', 'in' => 'query', 'schema' => [ 'description' => '每页返回数目，默认 pageSize = 10', 'type' => 'integer', 'format' => 'int32', 'required' => false, 'example' => '10', ], ], ], 'responses' => [ 200 => [ 'schema' => [ 'type' => 'object', 'properties' => [ 'totalCount' => [ 'description' => '总条数', 'type' => 'integer', 'format' => 'int64', 'example' => '1', ], 'requestId' => [ 'description' => '请求ID', 'type' => 'string', 'example' => '0A6EB64B-B4C8-CF02-810F-E660812972FF', ], 'result' => [ 'type' => 'array', 'items' => [ 'description' => '定时任务信息'."\n" ."\n" .'参考：[ScheduledTask](~~173610~~)', 'type' => 'object', 'example' => '[]', ], ], ], ], ], '5XX' => [ 'schema' => [ 'type' => 'object', 'properties' => [ 'code' => [ 'type' => 'string', ], 'message' => [ 'type' => 'string', ], 'requestId' => [ 'type' => 'string', ], 'httpCode' => [ 'type' => 'integer', 'format' => 'int32', ], ], ], ], ], 'responseDemo' => '[{"type":"json","example":"{\\n \\"totalCount\\": 1,\\n \\"requestId\\": \\"0A6EB64B-B4C8-CF02-810F-E660812972FF\\",\\n \\"result\\": [\\n []\\n ]\\n}","errorExample":""},{"type":"xml","example":"0A6EB64B-B4C8-CF02-810F-E660812972FF\\n1\\n\\n 2f12c585-5873-11ea-974a-7cd30ad3e268\\n 0\\n 3\\n \\n wipe\\n false\\n false\\n false\\n true\\n 1582706232\\n 1582706232\\n 0 0 * * 1,2,3,4,5,6,7\\n true\\n \\n 110091051\\n 2656\\n \\n \\n \\n 110091051\\n \\n \\n 2656\\n \\n \\n ctime\\n 30\\n s\\n \\n","errorExample":""}]', 'title' => '获取应用定时任务列表', 'requestParamsDescription' => '**查询参数**'."\n" .'| 字段 | 类型 | 是否必要 | 示例值 | 描述 |'."\n" .'| --- | --- | --- | --- | --- |'."\n" .'| id | String | 否 | "2f12c585-5873-11ea-974a-7cd30ad3e268" | 任务ID |'."\n" .'| enabled | Boolean | 否 | true | 是否已开启定时任务 |'."\n" .'| updated | Integer | 否 | 1582706232 | 定时任务的更新时间戳 |', 'responseParamsDescription' => ' ', 'extraInfo' => ' ', ], 'CreateScheduledTask' => [ 'summary' => '创建一个 OpenSearch 应用的定时任务。', 'path' => '/v4/openapi/app-groups/{appGroupIdentity}/scheduled-tasks', 'methods' => [ 'post', ], 'schemes' => [ 'http', 'https', ], 'security' => [ [ 'AK' => [], ], ], 'operationType' => 'write', 'deprecated' => false, 'systemTags' => [ 'operationType' => 'create', 'riskType' => 'none', 'chargeType' => 'free', 'abilityTreeNodes' => [ 'FEATUREopensearch447AAX', 'FEATUREopensearch5OZOSP', ], ], 'parameters' => [ [ 'name' => 'appGroupIdentity', 'in' => 'path', 'schema' => [ 'description' => '应用名称', 'type' => 'string', 'required' => true, 'docRequired' => true, 'example' => 'my_app_group_name', ], ], [ 'name' => 'body', 'in' => 'body', 'schema' => [ 'description' => '请求体', 'required' => false, '$ref' => '#/components/schemas/ScheduledTask', ], ], ], 'responses' => [ 200 => [ 'schema' => [ 'type' => 'object', 'properties' => [ 'result' => [ 'description' => '定时任务信息，参考：[ScheduledTask](~~173610~~)', 'type' => 'object', 'example' => '{}', ], 'requestId' => [ 'description' => '请求ID', 'type' => 'string', 'example' => 'ABCDEFGH', ], ], ], ], '5XX' => [ 'schema' => [ 'type' => 'object', 'properties' => [ 'code' => [ 'type' => 'string', ], 'message' => [ 'type' => 'string', ], 'requestId' => [ 'type' => 'string', ], 'httpCode' => [ 'type' => 'integer', 'format' => 'int32', ], ], ], ], ], 'responseDemo' => '[{"type":"json","example":"{\\n \\"result\\": {},\\n \\"requestId\\": \\"ABCDEFGH\\"\\n}","errorExample":""},{"type":"xml","example":"0BECF34E-125A-D35F-1E5D-ABB66B11FAB8\\n\\n cfd5ebe9-bcdd-11ea-a58d-98039b07e4ec\\n 0\\n 3\\n \\n wipe\\n false\\n false\\n false\\n true\\n 1593747144\\n 1593747144\\n 0 0 * * 1,2,3,4,5,6,7\\n true\\n \\n \\n \\n title\\n 30\\n s\\n \\n","errorExample":""}]', 'title' => '创建一个应用的定时任务', 'requestParamsDescription' => '**请求体**'."\n" .'| 字段 | 类型 | 是否必要 | 示例值 | 描述 |'."\n" .'| --- | --- | --- | --- | --- |'."\n" .'| type | String | 是 | "wipe" | 定时任务类型
- wipe 数据清理
- fork 导入数据加索引重建
- reindex 索引重建
- clear 清空数据 |'."\n" .'| cron | String | 是 | "10 20 * * 1,2,3,4,5" | 定时配置
参考：[ScheduledTask 定时规则](~~173611~~) |'."\n" .'| enabled | Boolean | 是 | true | 是否开启定时任务 |'."\n" .'| appStrategy | String | 否 | delete-idle | 创建新版本的策略
- delete-idle 已有两个版本，先删除非在线版本，再创建新版本
- need-slot 只有一个版本，直接创建新版本 |'."\n" .'| filter | Object | 否 | | 数据清理条件 |'."\n" .'| filter.days | Integer | 是 | 7 | 过期天数
获取范围：[7-180] |'."\n" .'| filter.unit | String | 是 | "s" | 过期时间单位
- s 秒
- ms 毫秒 |'."\n" .'| filter.field | String | 否 | "cate_id" | 过期字段 |'."\n" .'| runNow | Boolean | 否 | false | 是否立即执行（默认：false） |'."\n" .'| permanent | Boolean | 否 | true | 是否持久化（默认：true） |', 'responseParamsDescription' => ' ', 'extraInfo' => ' ', ], 'DescribeScheduledTask' => [ 'summary' => '查看 OpenSearch 应用定时任务详情。', 'path' => '/v4/openapi/app-groups/{appGroupIdentity}/scheduled-tasks/{taskId}', 'methods' => [ 'get', ], 'schemes' => [ 'http', 'https', ], 'security' => [ [ 'AK' => [], ], ], 'operationType' => 'read', 'deprecated' => false, 'systemTags' => [ 'operationType' => 'get', 'riskType' => 'none', 'chargeType' => 'free', 'abilityTreeNodes' => [ 'FEATUREopensearch447AAX', 'FEATUREopensearch5OZOSP', ], ], 'parameters' => [ [ 'name' => 'appGroupIdentity', 'in' => 'path', 'schema' => [ 'description' => '应用名称', 'type' => 'string', 'required' => true, 'docRequired' => true, 'example' => 'my_app_group_name', ], ], [ 'name' => 'taskId', 'in' => 'path', 'schema' => [ 'description' => '任务ID', 'type' => 'string', 'required' => true, 'docRequired' => true, 'example' => '2f12c585-5873-11ea-974a-7cd30ad3e268', ], ], ], 'responses' => [ 200 => [ 'schema' => [ 'type' => 'object', 'properties' => [ 'result' => [ 'description' => '定时任务信息', 'type' => 'object', 'example' => '{}', ], 'requestId' => [ 'description' => '请求ID', 'type' => 'string', 'example' => '922DC0D9-31B5-45F9-47B7-37DC678D61A8', ], ], ], ], '5XX' => [ 'schema' => [ 'type' => 'object', 'properties' => [ 'code' => [ 'type' => 'string', ], 'message' => [ 'type' => 'string', ], 'requestId' => [ 'type' => 'string', ], 'httpCode' => [ 'type' => 'integer', 'format' => 'int32', ], ], ], ], ], 'responseDemo' => '[{"type":"json","example":"{\\n \\"result\\": {},\\n \\"requestId\\": \\"922DC0D9-31B5-45F9-47B7-37DC678D61A8\\"\\n}","errorExample":""},{"type":"xml","example":"922DC0D9-31B5-45F9-47B7-37DC678D61A8\\n\\n 2f12c585-5873-11ea-974a-7cd30ad3e268\\n 60\\n 0\\n 1593755495\\n wipe\\n true\\n false\\n false\\n false\\n 1593747144\\n 1593755504\\n 0 0 * * 1,2,3,4,5,6,7\\n true\\n \\n 110091051\\n 84\\n \\n 100304004\\n \\n 110091051\\n \\n \\n 84\\n \\n \\n title\\n 30\\n s\\n \\n","errorExample":""}]', 'title' => '查看应用定时任务详情', ], 'ModifyScheduledTask' => [ 'summary' => '修改一个定时任务。', 'path' => '/v4/openapi/app-groups/{appGroupIdentity}/scheduled-tasks/{taskId}', 'methods' => [ 'put', ], 'schemes' => [ 'http', 'https', ], 'security' => [ [ 'AK' => [], ], ], 'operationType' => 'write', 'deprecated' => false, 'systemTags' => [ 'operationType' => 'update', 'riskType' => 'none', 'chargeType' => 'free', 'abilityTreeNodes' => [ 'FEATUREopensearch447AAX', 'FEATUREopensearch0AT3OG', ], ], 'parameters' => [ [ 'name' => 'appGroupIdentity', 'in' => 'path', 'schema' => [ 'description' => '应用的名称或者是应用id', 'type' => 'string', 'required' => true, 'docRequired' => true, 'example' => '121414148', ], ], [ 'name' => 'taskId', 'in' => 'path', 'schema' => [ 'description' => '任务id', 'type' => 'string', 'required' => true, 'docRequired' => true, 'example' => '56e9c2e7-5a4d-481a-9f1b-b07da6909450', ], ], [ 'name' => 'body', 'in' => 'body', 'schema' => [ 'description' => '请求参数。', 'type' => 'any', 'required' => false, 'example' => '{'."\n" .' "cron": "0 0 * * 1,2,3,4,5,6,7",'."\n" .' "enabled": true,'."\n" .' "filter": {'."\n" .' "field": "cat_id",'."\n" .' "days": 30,'."\n" .' "unit": "s"'."\n" .' }'."\n" .'}', ], ], ], 'responses' => [ 200 => [ 'schema' => [ 'type' => 'object', 'properties' => [ 'result' => [ 'description' => '定时任务信息', 'type' => 'object', 'example' => 'Array', ], 'requestId' => [ 'description' => '请求id', 'type' => 'string', 'example' => 'D77D0DAF-790D-F5F5-A9C0-133738165014', ], ], ], ], '5XX' => [ 'schema' => [ 'type' => 'object', 'properties' => [ 'code' => [ 'type' => 'string', ], 'message' => [ 'type' => 'string', ], 'requestId' => [ 'type' => 'string', ], 'httpCode' => [ 'type' => 'integer', 'format' => 'int32', ], ], ], ], ], 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"result\\": {\\n \\"test\\": \\"test\\",\\n \\"test2\\": 1\\n },\\n \\"requestId\\": \\"D77D0DAF-790D-F5F5-A9C0-133738165014\\"\\n}","type":"json"}]', 'title' => '修改一个定时任务', ], 'RemoveScheduledTask' => [ 'summary' => '删除 OpenSearch 应用定时任务。', 'path' => '/v4/openapi/app-groups/{appGroupIdentity}/scheduled-tasks/{taskId}', 'methods' => [ 'delete', ], 'schemes' => [ 'http', 'https', ], 'security' => [ [ 'AK' => [], ], ], 'operationType' => 'write', 'deprecated' => false, 'systemTags' => [ 'operationType' => 'delete', 'riskType' => 'none', 'chargeType' => 'free', 'abilityTreeNodes' => [ 'FEATUREopensearch447AAX', 'FEATUREopensearch5OZOSP', ], ], 'parameters' => [ [ 'name' => 'appGroupIdentity', 'in' => 'path', 'schema' => [ 'description' => '应用名称', 'type' => 'string', 'required' => true, 'docRequired' => true, 'example' => '“my_app_group_name”', ], ], [ 'name' => 'taskId', 'in' => 'path', 'schema' => [ 'description' => '任务ID', 'type' => 'string', 'required' => true, 'docRequired' => true, 'example' => '“2f12c585-5873-11ea-974a-7cd30ad3e268”', ], ], ], 'responses' => [ 200 => [ 'schema' => [ 'type' => 'object', 'properties' => [ 'requestId' => [ 'description' => '请求ID', 'type' => 'string', 'example' => '0A6EB64B-B4C8-CF02-810F-E660812972FF', ], 'result' => [ 'description' => '返回结果', 'type' => 'array', 'items' => [ 'description' => '返回结果列表（请求成功不会返回此参数）', 'type' => 'integer', 'format' => 'int32', 'example' => '1', ], ], ], ], ], '5XX' => [ 'schema' => [ 'type' => 'object', 'properties' => [ 'code' => [ 'type' => 'string', ], 'message' => [ 'type' => 'string', ], 'requestId' => [ 'type' => 'string', ], 'httpCode' => [ 'type' => 'integer', 'format' => 'int32', ], ], ], ], ], 'responseDemo' => '[{"type":"json","example":"{\\n \\"requestId\\": \\"0A6EB64B-B4C8-CF02-810F-E660812972FF\\",\\n \\"result\\": [\\n 1\\n ]\\n}","errorExample":""},{"type":"xml","example":"0A6EB64B-B4C8-CF02-810F-E660812972FF","errorExample":""}]', 'title' => '删除计划任务', 'requestParamsDescription' => ' ', 'responseParamsDescription' => ' ', 'extraInfo' => ' ', ], 'ListSortExpressions' => [ 'summary' => '获取应用版本上的排序表达式列表。', 'path' => '/v4/openapi/app-groups/{appGroupIdentity}/apps/{appId}/sort-expressions', 'methods' => [ 'get', ], 'schemes' => [ 'http', 'https', ], 'security' => [ [ 'AK' => [], ], ], 'operationType' => 'read', 'deprecated' => false, 'systemTags' => [ 'operationType' => 'list', 'riskType' => 'none', 'chargeType' => 'free', 'abilityTreeCode' => '55229', 'abilityTreeNodes' => [ 'FEATUREopensearchN8M8WS', ], ], 'parameters' => [ [ 'name' => 'appGroupIdentity', 'in' => 'path', 'schema' => [ 'description' => '应用名称', 'type' => 'string', 'required' => true, 'docRequired' => true, 'example' => 'my_app_group_name', ], ], [ 'name' => 'appId', 'in' => 'path', 'schema' => [ 'description' => '版本ID', 'type' => 'integer', 'format' => 'int32', 'required' => true, 'docRequired' => true, 'maximum' => '999999999', 'minimum' => '1', 'example' => '110116134', ], ], ], 'responses' => [ 200 => [ 'schema' => [ 'type' => 'object', 'properties' => [ 'requestId' => [ 'description' => '请求ID', 'type' => 'string', 'example' => 'D77D0DAF-790D-F5F5-A9C0-133738165014', ], 'result' => [ 'description' => '粗排或精排表达式信息'."\n" ."\n" .'参考：[FirstRank](~~170007~~)、[SecondRank](~~170008~~)', 'type' => 'array', 'items' => [ 'type' => 'object', 'properties' => [ 'created' => [ 'description' => '创建时间（时间戳）', 'type' => 'integer', 'format' => 'int32', 'example' => '1655793690', ], 'active' => [ 'description' => '是否是默认表达式', 'type' => 'boolean', 'example' => 'true', ], 'description' => [ 'description' => '描述', 'type' => 'string', 'example' => '""', ], 'updated' => [ 'description' => '更新时间（时间戳）', 'type' => 'integer', 'format' => 'int32', 'example' => '1655793690', ], 'name' => [ 'description' => '名称', 'type' => 'string', 'example' => 'default', ], ], ], ], ], ], ], '5XX' => [ 'schema' => [ 'type' => 'object', 'properties' => [ 'code' => [ 'type' => 'string', ], 'requestId' => [ 'type' => 'string', ], 'message' => [ 'type' => 'string', ], 'httpCode' => [ 'type' => 'integer', 'format' => 'int32', ], ], ], ], ], 'responseDemo' => '[{"type":"json","example":"{\\n \\"requestId\\": \\"D77D0DAF-790D-F5F5-A9C0-133738165014\\",\\n \\"result\\": [\\n {\\n \\"created\\": 1655793690,\\n \\"active\\": true,\\n \\"description\\": \\"\\\\\\"\\\\\\"\\",\\n \\"updated\\": 1655793690,\\n \\"name\\": \\"default\\"\\n }\\n ]\\n}","errorExample":""},{"type":"xml","example":"D77D0DAF-790D-F5F5-A9C0-133738165014\\n\\n default\\n \\n true\\n \\n static_bm25()\\n \\n 1\\n \\n 1655793690\\n 1655793690\\n\\n\\n default\\n \\n false\\n \\n 0\\n 0\\n false\\n true\\n\\n\\n tests\\n random()+now()\\n true\\n \\n 1587052801\\n 1587052801\\n true\\n false\\n\\n\\n test\\n query_term_count()\\n false\\n \\n 1587052801\\n 1587052801\\n false\\n false\\n\\n4","errorExample":""}]', 'title' => '获取应用版本上的排序表达式列表', 'requestParamsDescription' => '**查询参数**'."\n" .'| 字段 | 类型 | 是否必要 | 示例值 | 描述 |'."\n" .'| --- | --- | --- | --- | --- |'."\n" .'| pageNumber | Integer | 否 | 1 | 页码，默认 pageNumber=1 |'."\n" .'| pageSize | Integer | 否 | 10 | 每页返回数目，默认 pageSize=10 |', 'responseParamsDescription' => ' ', 'extraInfo' => ' ', ], 'UnbindEsInstance' => [ 'summary' => '为 opensearch 应用解绑es实例。', 'path' => '/v4/openapi/app-groups/{appGroupIdentity}/actions/unbind-es-instance', 'methods' => [ 'post', ], 'schemes' => [ 'http', 'https', ], 'security' => [ [ 'AK' => [], ], ], 'operationType' => 'write', 'deprecated' => false, 'systemTags' => [ 'operationType' => 'none', 'riskType' => 'none', 'chargeType' => 'free', 'abilityTreeCode' => '55264', 'abilityTreeNodes' => [ 'FEATUREopensearchQZGKV9', ], ], 'parameters' => [ [ 'name' => 'appGroupIdentity', 'in' => 'path', 'schema' => [ 'description' => '应用名称', 'type' => 'string', 'required' => true, 'docRequired' => true, 'example' => '"my_app_group_name"', ], ], ], 'responses' => [ 200 => [ 'schema' => [ 'type' => 'object', 'properties' => [ 'result' => [ 'description' => '返回结果', 'type' => 'object', 'example' => '{}', ], 'requestId' => [ 'description' => '请求id', 'type' => 'string', 'example' => '0A6EB64B-B4C8-CF02-810F-E660812972FF', ], ], ], ], '5XX' => [ 'schema' => [ 'type' => 'object', 'properties' => [ 'code' => [ 'type' => 'string', ], 'message' => [ 'type' => 'string', ], 'requestId' => [ 'type' => 'string', ], 'httpCode' => [ 'type' => 'integer', 'format' => 'int32', ], ], ], ], ], 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"result\\": {},\\n \\"requestId\\": \\"0A6EB64B-B4C8-CF02-810F-E660812972FF\\"\\n}","type":"json"}]', 'title' => '卸载依赖库实例', ], 'BindEsInstance' => [ 'summary' => '绑定依赖性 Elasticsearch 实例。', 'path' => '/v4/openapi/app-groups/{appGroupIdentity}/actions/bind-es-instance', 'methods' => [ 'post', ], 'schemes' => [ 'http', 'https', ], 'security' => [ [ 'AK' => [], ], ], 'operationType' => 'write', 'deprecated' => false, 'systemTags' => [ 'operationType' => 'none', 'riskType' => 'none', 'chargeType' => 'free', 'abilityTreeNodes' => [ 'FEATUREopensearchQZGKV9', ], ], 'parameters' => [ [ 'name' => 'appGroupIdentity', 'in' => 'path', 'schema' => [ 'description' => '应用名称', 'type' => 'string', 'required' => true, 'docRequired' => true, 'example' => 'my_app_group_name', ], ], [ 'name' => 'body', 'in' => 'body', 'style' => 'json', 'schema' => [ 'description' => '请求体', 'type' => 'object', 'required' => false, 'example' => '{'."\n" .' "esInstanceId": "es-cn-abcde"'."\n" .'}', ], ], ], 'responses' => [ 200 => [ 'schema' => [ 'description' => '响应体', 'type' => 'object', 'properties' => [ 'result' => [ 'description' => '返回结果', 'type' => 'object', 'example' => '{}', ], 'requestId' => [ 'description' => '请求ID', 'type' => 'string', 'example' => 'F5099063-6B86-F398-D843-905F9EFB683A', ], ], 'example' => '{}', ], ], '5XX' => [ 'schema' => [ 'type' => 'object', 'properties' => [ 'code' => [ 'type' => 'string', ], 'message' => [ 'type' => 'string', ], 'requestId' => [ 'type' => 'string', ], 'httpCode' => [ 'type' => 'integer', 'format' => 'int32', ], ], ], ], ], 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"result\\": {},\\n \\"requestId\\": \\"F5099063-6B86-F398-D843-905F9EFB683A\\"\\n}","type":"json"}]', 'title' => '绑定依赖性库实例', ], 'BindESUserAnalyzer' => [ 'summary' => '为es实例绑定自定义分析器。', 'path' => '/v4/openapi/app-groups/{appGroupIdentity}/es/{esInstanceId}/actions/bind-analyzer', 'methods' => [ 'post', ], 'schemes' => [ 'http', 'https', ], 'security' => [ [ 'AK' => [], ], ], 'operationType' => 'write', 'deprecated' => false, 'systemTags' => [ 'operationType' => 'none', 'riskType' => 'none', 'chargeType' => 'free', 'abilityTreeCode' => '55141', 'abilityTreeNodes' => [ 'FEATUREopensearch447AAX', ], ], 'parameters' => [ [ 'name' => 'appGroupIdentity', 'in' => 'path', 'schema' => [ 'description' => '应用名称', 'type' => 'string', 'required' => true, 'docRequired' => true, 'example' => '130187460', ], ], [ 'name' => 'esInstanceId', 'in' => 'path', 'schema' => [ 'description' => '实例id', 'type' => 'string', 'required' => true, 'docRequired' => true, 'example' => 'es-cn-zvp2g952l000v5uxp', ], ], [ 'name' => 'body', 'in' => 'body', 'schema' => [ 'description' => '请求体', 'type' => 'any', 'required' => false, 'example' => '{'."\n" .' "name": "kevintest-analyzer"'."\n" .'}', ], ], ], 'responses' => [ 200 => [ 'schema' => [ 'description' => '响应体', 'type' => 'object', 'properties' => [ 'result' => [ 'description' => '自定义分析器', 'type' => 'object', 'example' => '[]', ], 'requestId' => [ 'description' => '请求id', 'type' => 'string', 'example' => '3AD34CAD-9603-5251-AFF5-3916C848A1D3', ], ], 'example' => '{}', ], ], '5XX' => [ 'schema' => [ 'type' => 'object', 'properties' => [ 'code' => [ 'type' => 'string', ], 'message' => [ 'type' => 'string', ], 'requestId' => [ 'type' => 'string', ], 'httpCode' => [ 'type' => 'integer', 'format' => 'int32', ], ], ], ], ], 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"result\\": [],\\n \\"requestId\\": \\"3AD34CAD-9603-5251-AFF5-3916C848A1D3\\"\\n}","type":"json"}]', 'title' => '为es实例绑定自定义分析器', ], 'UnbindESUserAnalyzer' => [ 'summary' => '为Elasticsearch实例解绑自定义分析器。', 'path' => '/v4/openapi/app-groups/{appGroupIdentity}/es/{esInstanceId}/actions/unbind-analyzer', 'methods' => [ 'post', ], 'schemes' => [ 'http', 'https', ], 'security' => [ [ 'AK' => [], ], ], 'operationType' => 'write', 'deprecated' => false, 'systemTags' => [ 'operationType' => 'none', 'riskType' => 'none', 'chargeType' => 'free', 'abilityTreeNodes' => [ 'FEATUREopensearch447AAX', ], ], 'parameters' => [ [ 'name' => 'appGroupIdentity', 'in' => 'path', 'schema' => [ 'description' => '应用名称', 'type' => 'string', 'required' => true, 'docRequired' => true, 'example' => 'my_app_group_name', ], ], [ 'name' => 'esInstanceId', 'in' => 'path', 'schema' => [ 'description' => '实例id', 'type' => 'string', 'required' => true, 'docRequired' => true, 'example' => 'es-cn-zvp2ff3iq000myzv7', ], ], [ 'name' => 'body', 'in' => 'body', 'schema' => [ 'description' => '请求体', 'type' => 'any', 'required' => false, 'example' => '{'."\n" .' "name": "kevintest-analyzer"'."\n" .'}', ], ], ], 'responses' => [ 200 => [ 'schema' => [ 'description' => '响应体', 'type' => 'object', 'properties' => [ 'result' => [ 'description' => '自定义分析器', 'type' => 'object', 'example' => '[]', ], 'requestId' => [ 'description' => '请求id', 'type' => 'string', 'example' => '0A6EB64B-B4C8-CF02-810F-E660812972FF', ], ], 'example' => '{}', ], ], '5XX' => [ 'schema' => [ 'type' => 'object', 'properties' => [ 'code' => [ 'type' => 'string', ], 'message' => [ 'type' => 'string', ], 'requestId' => [ 'type' => 'string', ], 'httpCode' => [ 'type' => 'integer', 'format' => 'int32', ], ], ], ], ], 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"result\\": [],\\n \\"requestId\\": \\"0A6EB64B-B4C8-CF02-810F-E660812972FF\\"\\n}","type":"json"}]', 'title' => '为Elasticsearch实例解绑自定义分析器', 'description' => '为Elasticsearch实例解绑自定义分析器', ], 'ListProceedings' => [ 'summary' => '查看当前的处理流。', 'path' => '/v4/openapi/app-groups/{appGroupIdentity}/proceedings', 'methods' => [ 'get', ], 'schemes' => [ 'http', 'https', ], 'security' => [ [ 'AK' => [], ], ], 'operationType' => 'readAndWrite', 'deprecated' => false, 'systemTags' => [ 'operationType' => 'none', 'riskType' => 'none', 'chargeType' => 'free', 'abilityTreeNodes' => [ 'FEATUREopensearch447AAX', 'FEATUREopensearch5OZOSP', ], ], 'parameters' => [ [ 'name' => 'appGroupIdentity', 'in' => 'path', 'schema' => [ 'description' => '应用分组ID。', 'type' => 'string', 'required' => true, 'docRequired' => true, 'example' => '120677456', ], ], [ 'name' => 'filterFinished', 'in' => 'query', 'schema' => [ 'description' => '是否过滤已完成。', 'type' => 'boolean', 'required' => false, 'example' => 'true', ], ], ], 'responses' => [ 200 => [ 'schema' => [ 'title' => 'Schema of Response', 'description' => 'Schema of Response', 'type' => 'object', 'properties' => [ 'requestId' => [ 'title' => 'Id of the request', 'description' => 'Id of the request', 'type' => 'string', 'example' => 'F5099063-6B86-F398-D843-905F9EFB683A', ], ], 'example' => '{}', ], ], ], 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"requestId\\": \\"F5099063-6B86-F398-D843-905F9EFB683A\\"\\n}","type":"json"}]', 'title' => '显示AppGroup正在进行的离线导入的任务列表', ], 'ListStatisticLogs' => [ 'summary' => '查询日志类统计，例如：应用错误日志、热词榜单、慢日志。', 'path' => '/v4/openapi/app-groups/{appGroupIdentity}/statistic-logs/{moduleName}', 'methods' => [ 'get', ], 'schemes' => [ 'http', 'https', ], 'security' => [ [ 'AK' => [], ], ], 'operationType' => 'read', 'deprecated' => false, 'systemTags' => [ 'operationType' => 'none', 'riskType' => 'none', 'chargeType' => 'free', 'abilityTreeNodes' => [ 'FEATUREopensearch447AAX', 'FEATUREopensearch5OZOSP', ], ], 'parameters' => [ [ 'name' => 'appGroupIdentity', 'in' => 'path', 'schema' => [ 'description' => '应用名称', 'type' => 'string', 'required' => true, 'docRequired' => true, 'example' => 'app_group_name', ], ], [ 'name' => 'moduleName', 'in' => 'path', 'schema' => [ 'description' => '模块名称，为枚举值'."\n" ."\n" .'- hot 热词榜单'."\n" .'- error 应用日志'."\n" .'- slow-log 慢日志'."\n" ."\n" .'目前只支持 hot', 'type' => 'string', 'required' => true, 'docRequired' => true, 'example' => 'hot', ], ], [ 'name' => 'startTime', 'in' => 'query', 'schema' => [ 'description' => '开始时间'."\n" .'默认为当天0点0分0秒的时间戳', 'type' => 'integer', 'format' => 'int32', 'required' => false, 'maximum' => '9999999999', 'minimum' => '0', 'example' => '1582214400', ], ], [ 'name' => 'stopTime', 'in' => 'query', 'schema' => [ 'description' => '结束时间'."\n" .'默认为当天24点0分0秒的时间戳', 'type' => 'integer', 'format' => 'int32', 'required' => false, 'maximum' => '9999999999', 'minimum' => '0', 'example' => '1682222400', ], ], [ 'name' => 'pageNumber', 'in' => 'query', 'schema' => [ 'description' => '页码，默认 pageNumber = 1', 'type' => 'integer', 'format' => 'int32', 'required' => false, 'maximum' => '1000', 'minimum' => '1', 'example' => '1', ], ], [ 'name' => 'pageSize', 'in' => 'query', 'schema' => [ 'description' => '每页返回数目，默认 pageSize = 10', 'type' => 'integer', 'format' => 'int32', 'required' => false, 'maximum' => '10000', 'minimum' => '1', 'example' => '10', ], ], [ 'name' => 'query', 'in' => 'query', 'schema' => [ 'description' => 'query查询子句内容', 'type' => 'string', 'required' => false, 'example' => '"default:\'OpenSearch\'"', ], ], [ 'name' => 'sortBy', 'in' => 'query', 'schema' => [ 'description' => 'sort排序子句内容', 'type' => 'string', 'required' => false, 'example' => '"-id"', ], ], [ 'name' => 'distinct', 'in' => 'query', 'schema' => [ 'description' => '是否使用distinct子句', 'type' => 'boolean', 'required' => false, 'example' => 'true', ], ], [ 'name' => 'columns', 'in' => 'query', 'schema' => [ 'description' => '查询的字段'."\n" .'格式为 columns=wordsTopPv'."\n" ."\n" .'参考：[QUERY_ANALYSIS query分析类指标](~~187665~~)', 'type' => 'string', 'required' => false, 'example' => 'wordsTopPv', ], ], ], 'responses' => [ 200 => [ 'schema' => [ 'description' => '响应体', 'type' => 'object', 'properties' => [ 'totalCount' => [ 'description' => '数据总条数', 'type' => 'integer', 'format' => 'int64', 'example' => '1', ], 'requestId' => [ 'description' => '请求ID', 'type' => 'string', 'example' => 'F76ACE3D-E510-EE2C-B7B1-39B3136A61EE', ], 'result' => [ 'description' => '结果数据，参考：'."\n" ."\n" .'- [热词榜单](~~421248~~)', 'type' => 'array', 'items' => [ 'description' => '结果数据，参考：'."\n" ."\n" .'- [热词榜单](~~187660~~)', 'type' => 'object', 'example' => '[ { "rawQuery":"淘宝", "pv":100 } ]', ], 'example' => '[]', ], ], 'example' => '{}', ], ], '5XX' => [ 'schema' => [ 'type' => 'object', 'properties' => [ 'code' => [ 'type' => 'string', ], 'message' => [ 'type' => 'string', ], 'requestId' => [ 'type' => 'string', ], 'httpCode' => [ 'type' => 'integer', 'format' => 'int32', ], ], ], ], ], 'responseDemo' => '[{"type":"json","example":"{\\n \\"totalCount\\": 1,\\n \\"requestId\\": \\"F76ACE3D-E510-EE2C-B7B1-39B3136A61EE\\",\\n \\"result\\": [\\n [\\n {\\n \\"rawQuery\\": \\"淘宝\\",\\n \\"pv\\": 100\\n }\\n ]\\n ]\\n}","errorExample":""},{"type":"xml","example":"F76ACE3D-E510-EE2C-B7B1-39B3136A61EE\\n\\n 淘宝\\n 100\\n\\n1","errorExample":""}]', 'title' => '查询日志类统计', 'requestParamsDescription' => ' ', 'responseParamsDescription' => '**hot 热词榜单**'."\n" .'| 名称 | 类型 | 描述 |'."\n" .'| --- | --- | --- |'."\n" .'| rawQuery | String | 热词 |'."\n" .'| pv | Integer | PV |', 'extraInfo' => ' ', ], 'ListStatisticReport' => [ 'summary' => '应用场景有：应用报表、下拉提示报表、热词底纹报表、abtest报表、数据质量报告等。', 'path' => '/v4/openapi/app-groups/{appGroupIdentity}/statistic-report/{moduleName}', 'methods' => [ 'get', ], 'schemes' => [ 'http', 'https', ], 'security' => [ [ 'AK' => [], ], ], 'operationType' => 'read', 'deprecated' => false, 'systemTags' => [ 'operationType' => 'none', 'riskType' => 'none', 'chargeType' => 'free', 'abilityTreeNodes' => [ 'FEATUREopensearchA9FOU5', 'FEATUREopensearchAKNSFD', ], ], 'parameters' => [ [ 'name' => 'appGroupIdentity', 'in' => 'path', 'schema' => [ 'description' => '应用名称', 'type' => 'string', 'required' => true, 'docRequired' => true, 'example' => 'app_group_name', ], ], [ 'name' => 'moduleName', 'in' => 'path', 'schema' => [ 'description' => '模块名称，为枚举值'."\n" ."\n" .'- app （业务运营报表）'."\n" .'- app-query （业务运营报表>Query分析指标）'."\n" .'- abtest （A/B测试报表）'."\n" .'- suggest （下拉提示报表）'."\n" .'- hot （热搜报表）'."\n" .'- hint （底纹报表）'."\n" .'- data-quality (行为数据，不支持分页参数)'."\n" .'- es （开源兼容版实例报表）', 'type' => 'string', 'required' => true, 'docRequired' => true, 'example' => 'suggest', ], ], [ 'name' => 'startTime', 'in' => 'query', 'schema' => [ 'description' => '开始时间戳（单位：秒）', 'type' => 'integer', 'format' => 'int32', 'required' => false, 'maximum' => '9999999999', 'minimum' => '0', 'example' => '1582214400', ], ], [ 'name' => 'endTime', 'in' => 'query', 'schema' => [ 'description' => '结束时间默认为当前时间戳（单位：秒）', 'type' => 'integer', 'format' => 'int32', 'required' => false, 'maximum' => '9999999999', 'minimum' => '0', 'example' => '1582646399', ], ], [ 'name' => 'pageNumber', 'in' => 'query', 'schema' => [ 'description' => '页码。'."\n" ."\n" .'默认值：1。', 'type' => 'integer', 'format' => 'int32', 'required' => false, 'maximum' => '100', 'minimum' => '1', 'example' => '1', ], ], [ 'name' => 'pageSize', 'in' => 'query', 'schema' => [ 'description' => '每页返回数目，默认 pageSize = 10', 'type' => 'integer', 'format' => 'int32', 'required' => false, 'maximum' => '10000', 'minimum' => '1', 'example' => '10', ], ], [ 'name' => 'columns', 'in' => 'query', 'schema' => [ 'description' => '查询的字段'."\n" .'格式为 colums=”pv,uv,ipv”,参考：[统计报表指标释义'."\n" .'](~~187665~~)', 'type' => 'string', 'required' => false, 'example' => 'pv,uv', ], ], [ 'name' => 'query', 'in' => 'query', 'schema' => [ 'description' => '查询条件，格式 k1:v1,k2:v2'."\n" ."\n" .'- experimentSerialNumber 实验的全局唯一序列号'."\n" .'- sceneTag 场景标识'."\n" .'- bizType 业务标识'."\n" .'- modelId 算法模型ID', 'type' => 'string', 'required' => false, 'example' => 'bizType:test,sceneTag:myTag', ], ], ], 'responses' => [ 200 => [ 'schema' => [ 'description' => '响应体', 'type' => 'object', 'properties' => [ 'totalCount' => [ 'description' => '数据总条数', 'type' => 'integer', 'format' => 'int64', 'example' => '43', ], 'requestId' => [ 'description' => '请求id', 'type' => 'string', 'example' => 'F65C8BB2-C14F-5983-888B-41C4E082D3BC', ], 'result' => [ 'description' => '统计报告'."\n" ."\n" .'- data-quality 参考：[数据采集 - 行为数据上报](~~131547~~)'."\n" .'- app、abtest 参考：[CORE 核心类指标](~~187665~~)'."\n" .'- app-query 参考：[QUERY_ANALYSIS query分析类指标](~~187665~~)', 'type' => 'array', 'items' => [ 'description' => '结果体', 'type' => 'object', 'example' => '{}', ], 'example' => '[]', ], ], 'example' => '[]', ], ], '5XX' => [ 'schema' => [ 'type' => 'object', 'properties' => [ 'code' => [ 'type' => 'string', ], 'message' => [ 'type' => 'string', ], 'requestId' => [ 'type' => 'string', ], 'httpCode' => [ 'type' => 'integer', 'format' => 'int32', ], ], ], ], ], 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"totalCount\\": 43,\\n \\"requestId\\": \\"F65C8BB2-C14F-5983-888B-41C4E082D3BC\\",\\n \\"result\\": [\\n {}\\n ]\\n}","type":"json"}]', 'title' => '报告类统计查询', ], 'UpdateSortScript' => [ 'summary' => '修改排序脚本备注。', 'path' => '/v4/openapi/app-groups/{appGroupIdentity}/apps/{appVersionId}/sort-scripts/{scriptName}', 'methods' => [ 'put', ], 'schemes' => [ 'http', 'https', ], 'security' => [ [ 'AK' => [], ], ], 'operationType' => 'readAndWrite', 'deprecated' => false, 'systemTags' => [ 'operationType' => 'update', 'riskType' => 'none', 'chargeType' => 'free', 'abilityTreeNodes' => [ 'FEATUREopensearchN8M8WS', ], ], 'parameters' => [ [ 'name' => 'appGroupIdentity', 'in' => 'path', 'schema' => [ 'description' => '应用名称或应用id', 'type' => 'string', 'required' => true, 'docRequired' => true, 'example' => 'my_app', ], ], [ 'name' => 'appVersionId', 'in' => 'path', 'schema' => [ 'description' => '应用下的版本id', 'type' => 'string', 'required' => true, 'docRequired' => true, 'example' => '123456', ], ], [ 'name' => 'scriptName', 'in' => 'path', 'schema' => [ 'description' => '脚本名', 'type' => 'string', 'required' => true, 'docRequired' => true, 'example' => 'test_cava', ], ], [ 'name' => 'body', 'in' => 'body', 'style' => 'json', 'schema' => [ 'title' => '请求体内容', 'description' => '请求体内容', 'type' => 'object', 'properties' => [ 'description' => [ 'title' => '脚本备注', 'description' => '脚本备注', 'type' => 'string', 'required' => false, ], ], 'required' => false, ], ], ], 'responses' => [ 200 => [ 'schema' => [ 'description' => '响应体', 'type' => 'object', 'properties' => [ 'requestId' => [ 'description' => '请求ID', 'type' => 'string', 'example' => '9F165784-5507-5342-ABF3-545293F9808A', ], ], 'example' => '[]', ], ], '5XX' => [ 'schema' => [ 'type' => 'object', 'properties' => [ 'code' => [ 'type' => 'string', ], 'message' => [ 'type' => 'string', ], 'requestId' => [ 'type' => 'string', ], 'httpCode' => [ 'type' => 'integer', 'format' => 'int32', ], ], ], ], ], 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"requestId\\": \\"9F165784-5507-5342-ABF3-545293F9808A\\"\\n}","type":"json"}]', 'title' => '修改排序脚本备注', 'description' => '修改排序脚本备注', 'responseParamsDescription' => '**示例**'."\n" ."\n" .'请求示例'."\n" ."\n" .'```'."\n" .'PUT /v4/openapi/app-groups/my_app/apps/123456/sort-scripts/test_cava'."\n" .'{'."\n" .' "description" : "just for test"'."\n" .'}'."\n" .'```'."\n" ."\n" .'正常返回示例'."\n" ."\n" .'XML格式'."\n" ."\n" .'```'."\n" .'ABCDEFGH'."\n" .'```'."\n" ."\n" .'JSON格式'."\n" ."\n" .'```'."\n" .'{"requestId":"ABCDEFGH"}'."\n" .'```'."\n", ], 'SaveSortScriptFile' => [ 'summary' => '上传排序脚本内容。', 'path' => '/v4/openapi/app-groups/{appGroupIdentity}/apps/{appVersionId}/sort-scripts/{scriptName}/files/src/{fileName}', 'methods' => [ 'put', ], 'schemes' => [ 'http', 'https', ], 'security' => [ [ 'AK' => [], ], ], 'operationType' => 'write', 'deprecated' => false, 'systemTags' => [ 'operationType' => 'update', 'riskType' => 'none', 'chargeType' => 'free', 'abilityTreeNodes' => [ 'FEATUREopensearchN8M8WS', ], ], 'parameters' => [ [ 'name' => 'appGroupIdentity', 'in' => 'path', 'schema' => [ 'description' => '应用的名称或者是应用id', 'type' => 'string', 'required' => true, 'docRequired' => true, 'example' => '\'\'110123411\'\'', ], ], [ 'name' => 'scriptName', 'in' => 'path', 'schema' => [ 'description' => '需要更新内容的脚本名称', 'type' => 'string', 'required' => true, 'docRequired' => true, 'example' => '\'\'test1\'\'', ], ], [ 'name' => 'appVersionId', 'in' => 'path', 'schema' => [ 'description' => '应用下的版本id', 'type' => 'string', 'required' => true, 'docRequired' => true, 'example' => '\'\'110123111\'\'', ], ], [ 'name' => 'fileName', 'in' => 'path', 'schema' => [ 'description' => '文件名。', 'type' => 'string', 'required' => true, 'docRequired' => true, 'example' => '\'\'file01\'\'', ], ], [ 'name' => 'body', 'in' => 'body', 'style' => 'json', 'schema' => [ 'description' => 'scriptContent', 'type' => 'object', 'properties' => [ 'content' => [ 'description' => '脚本内容，base64编码', 'type' => 'string', 'required' => false, 'example' => '4769#0: *28194492991 a client request body is buffered to a temporary file /usr/local/webserver/openresty/nginx/client_body_temp/0000624474,', ], 'version' => [ 'description' => '脚本内容的版本', 'type' => 'integer', 'format' => 'int32', 'required' => false, 'example' => '2022-12-01', ], ], 'required' => false, ], ], ], 'responses' => [ 200 => [ 'schema' => [ 'description' => '响应体', 'type' => 'object', 'properties' => [ 'requestId' => [ 'description' => '唯一标识一次请求', 'type' => 'string', 'example' => 'ABCDEFGH', ], ], 'example' => '{}', ], ], '5XX' => [ 'schema' => [ 'type' => 'object', 'properties' => [ 'code' => [ 'type' => 'string', ], 'message' => [ 'type' => 'string', ], 'requestId' => [ 'type' => 'string', ], 'httpCode' => [ 'type' => 'integer', 'format' => 'int32', ], ], ], ], ], 'responseDemo' => '[{"type":"json","example":"{\\n \\"requestId\\": \\"ABCDEFGH\\"\\n}","errorExample":""},{"type":"xml","example":"ABCDEFGH","errorExample":""}]', 'title' => '保存排序脚本文件', 'requestParamsDescription' => '## scriptContent'."\n" .'| 名称 | 类型 | 是否必选 | 描述 |'."\n" .'| --- | --- | --- | --- |'."\n" .'| content | String | 是 | 脚本内容，需要使用base64编码 |'."\n" .'| version | integer | 否 | 脚本内容的版本，用于并发更新时保序，默认为当前时间 |', 'extraInfo' => ' ', ], 'ReleaseSortScript' => [ 'summary' => '发布排序脚本。', 'path' => '/v4/openapi/app-groups/{appGroupIdentity}/apps/{appVersionId}/sort-scripts/{scriptName}/actions/release', 'methods' => [ 'post', ], 'schemes' => [ 'http', 'https', ], 'security' => [ [ 'AK' => [], ], ], 'operationType' => 'write', 'deprecated' => false, 'systemTags' => [ 'operationType' => 'update', 'riskType' => 'none', 'chargeType' => 'free', 'abilityTreeNodes' => [ 'FEATUREopensearchN8M8WS', ], ], 'parameters' => [ [ 'name' => 'appGroupIdentity', 'in' => 'path', 'schema' => [ 'description' => '应用的名称或者是应用id', 'type' => 'string', 'required' => true, 'docRequired' => true, 'example' => '\'\'1234\'\'', ], ], [ 'name' => 'scriptName', 'in' => 'path', 'schema' => [ 'description' => '脚本名称', 'type' => 'string', 'required' => true, 'docRequired' => true, 'example' => '\'\'test\'\'', ], ], [ 'name' => 'appVersionId', 'in' => 'path', 'schema' => [ 'description' => '应用下的版本id', 'type' => 'string', 'required' => true, 'docRequired' => true, 'example' => '\'\'12345\'\'', ], ], ], 'responses' => [ 200 => [ 'schema' => [ 'type' => 'object', 'properties' => [ 'requestId' => [ 'description' => '唯一标识一次请求', 'type' => 'string', 'example' => 'ABCDEFGH', ], 'result' => [ 'type' => 'object', 'properties' => [ 'version' => [ 'type' => 'integer', 'format' => 'int64', ], ], ], ], ], ], '5XX' => [ 'schema' => [ 'type' => 'object', 'properties' => [ 'code' => [ 'type' => 'string', ], 'message' => [ 'type' => 'string', ], 'requestId' => [ 'type' => 'string', ], 'httpCode' => [ 'type' => 'integer', 'format' => 'int32', ], ], ], ], ], 'responseDemo' => '[{"type":"json","example":"{\\n \\"requestId\\": \\"ABCDEFGH\\"\\n}","errorExample":""},{"type":"xml","example":"ABCDEFGH","errorExample":""}]', 'title' => '发布排序脚本', 'requestParamsDescription' => ' ', 'responseParamsDescription' => ' ', 'extraInfo' => '**错误返回**'."\n" ."\n" .'{'."\n" .' "requestId" : "ABCDEFGH"'."\n" .' "code":"InvalidAppStatus",'."\n" .' "message":"invalid app status.",'."\n" .' "httpCode":400'."\n" .'}', ], 'GetSortScriptFile' => [ 'summary' => '获取排序脚本内容。', 'path' => '/v4/openapi/app-groups/{appGroupIdentity}/apps/{appVersionId}/sort-scripts/{scriptName}/files/src/{fileName}', 'methods' => [ 'get', ], 'schemes' => [ 'http', 'https', ], 'security' => [ [ 'AK' => [], ], ], 'operationType' => 'read', 'deprecated' => false, 'systemTags' => [ 'operationType' => 'get', 'riskType' => 'none', 'chargeType' => 'free', 'abilityTreeNodes' => [ 'FEATUREopensearchN8M8WS', ], ], 'parameters' => [ [ 'name' => 'appGroupIdentity', 'in' => 'path', 'schema' => [ 'description' => '应用的名称或者是应用id', 'type' => 'string', 'required' => true, 'docRequired' => true, 'example' => 'my_app', ], ], [ 'name' => 'scriptName', 'in' => 'path', 'schema' => [ 'description' => '脚本名称', 'type' => 'string', 'required' => true, 'docRequired' => true, 'example' => 'UserScorer.cava', ], ], [ 'name' => 'appVersionId', 'in' => 'path', 'schema' => [ 'description' => '应用下的版本id', 'type' => 'string', 'required' => true, 'docRequired' => true, 'example' => '123456', ], ], [ 'name' => 'fileName', 'in' => 'path', 'schema' => [ 'description' => '脚本文件名称', 'type' => 'string', 'required' => true, 'docRequired' => true, 'example' => 'script1', ], ], ], 'responses' => [ 200 => [ 'schema' => [ 'type' => 'object', 'properties' => [ 'requestId' => [ 'description' => '唯一标识一次请求', 'type' => 'string', 'example' => 'ABCDEFGH', ], 'result' => [ 'description' => '排序脚本内容', 'type' => 'object', 'properties' => [ 'content' => [ 'description' => '脚本内容，base64编码', 'type' => 'string', 'example' => 'YWJjZGVmZw==', ], 'createTime' => [ 'description' => '创建时间', 'type' => 'string', 'example' => '2020-04-02 20:21:14', ], 'modifyTime' => [ 'description' => '最后一次修改时间', 'type' => 'string', 'example' => '2020-04-02 21:21:14', ], 'version' => [ 'description' => '脚本内容的版本', 'type' => 'integer', 'format' => 'int64', 'example' => '123456', ], ], ], ], ], ], '5XX' => [ 'schema' => [ 'type' => 'object', 'properties' => [ 'code' => [ 'type' => 'string', ], 'message' => [ 'type' => 'string', ], 'requestId' => [ 'type' => 'string', ], 'httpCode' => [ 'type' => 'integer', 'format' => 'int32', ], ], ], ], ], 'responseDemo' => '[{"type":"json","example":"{\\n \\"requestId\\": \\"ABCDEFGH\\",\\n \\"result\\": {\\n \\"content\\": \\"YWJjZGVmZw==\\",\\n \\"createTime\\": \\"2020-04-02 20:21:14\\",\\n \\"modifyTime\\": \\"2020-04-02 21:21:14\\",\\n \\"version\\": 123456\\n }\\n}","errorExample":""},{"type":"xml","example":"ABCDEFGH\\n\\n YWJjZGVmZw==\\n 123456\\n","errorExample":""}]', 'title' => '获取排序脚本内容', 'requestParamsDescription' => ' ', 'responseParamsDescription' => ' ```'."\n" .'错误返回'."\n" .'{'."\n" .' "requestId" : "ABCDEFGH",'."\n" .' "code":"ResourceNotFound",'."\n" .' "message":"The specified script not found.",'."\n" .' "httpCode":404'."\n" .'}'."\n" .'```', 'extraInfo' => ' ', ], 'GetSortScript' => [ 'summary' => '获取排序脚本详情。', 'path' => '/v4/openapi/app-groups/{appGroupIdentity}/apps/{appVersionId}/sort-scripts/{scriptName}', 'methods' => [ 'get', ], 'schemes' => [ 'http', 'https', ], 'security' => [ [ 'AK' => [], ], ], 'operationType' => 'read', 'deprecated' => false, 'systemTags' => [ 'operationType' => 'get', 'riskType' => 'none', 'chargeType' => 'free', 'abilityTreeNodes' => [ 'FEATUREopensearchN8M8WS', ], ], 'parameters' => [ [ 'name' => 'appGroupIdentity', 'in' => 'path', 'schema' => [ 'description' => '应用的名称、应用id', 'type' => 'string', 'required' => true, 'docRequired' => true, 'enumValueTitles' => [], 'example' => 'my_app', ], ], [ 'name' => 'scriptName', 'in' => 'path', 'schema' => [ 'description' => '脚本名称', 'type' => 'string', 'required' => true, 'docRequired' => true, 'enumValueTitles' => [], 'example' => 'script1', ], ], [ 'name' => 'appVersionId', 'in' => 'path', 'schema' => [ 'description' => '应用下的版本id', 'type' => 'string', 'required' => true, 'docRequired' => true, 'enumValueTitles' => [], 'example' => '160051478', ], ], ], 'responses' => [ 200 => [ 'schema' => [ 'type' => 'object', 'properties' => [ 'requestId' => [ 'description' => '唯一标识一次请求', 'type' => 'string', 'enumValueTitles' => [], 'example' => 'ABCDEFGH', ], 'result' => [ 'description' => '脚本的详情', 'type' => 'object', 'properties' => [ 'scope' => [ 'description' => '脚本的作用范围', 'type' => 'string', 'example' => 'second_rank', ], 'createTime' => [ 'description' => '脚本创建时间', 'type' => 'string', 'example' => '2020-04-02 20:21:14', ], 'status' => [ 'description' => '脚本的状态，详情请参考下节脚本状态列表', 'type' => 'string', 'example' => 'released', ], 'modifyTime' => [ 'description' => '脚本最后一次修改时间', 'type' => 'string', 'example' => '2020-04-02 21:21:14', ], 'type' => [ 'description' => '脚本的类型', 'type' => 'string', 'enumValueTitles' => [], 'example' => 'cava_script', ], 'scriptName' => [ 'description' => '脚本名称', 'type' => 'string', 'example' => 'rank_cava_20230606_v7'."\n", ], 'description' => [ 'title' => '脚本备注', 'description' => '脚本备注', 'type' => 'string', ], ], ], ], 'enumValueTitles' => [], ], ], '5XX' => [ 'schema' => [ 'type' => 'object', 'properties' => [ 'code' => [ 'type' => 'string', ], 'message' => [ 'type' => 'string', ], 'requestId' => [ 'type' => 'string', ], 'httpCode' => [ 'type' => 'integer', 'format' => 'int32', ], ], ], ], ], 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"requestId\\": \\"ABCDEFGH\\",\\n \\"result\\": {\\n \\"scope\\": \\"second_rank\\",\\n \\"createTime\\": \\"2020-04-02 20:21:14\\",\\n \\"status\\": \\"released\\",\\n \\"modifyTime\\": \\"2020-04-02 21:21:14\\",\\n \\"type\\": \\"cava_script\\",\\n \\"scriptName\\": \\"rank_cava_20230606_v7\\\\n\\",\\n \\"description\\": \\"\\"\\n }\\n}","type":"json"}]', 'title' => '获取排序脚本详情', 'responseParamsDescription' => '```'."\n" .'错误返回'."\n" .'{'."\n" .' "requestId" : "ABCDEFGH",'."\n" .' "code":"ResourceNotFound",'."\n" .' "message":"The specified script not found.",'."\n" .' "httpCode":404'."\n" .'}'."\n" .'```', ], 'GetScriptFileNames' => [ 'path' => '/v4/openapi/app-groups/{appGroupIdentity}/apps/{appVersionId}/sort-scripts/{scriptName}/file-names', 'methods' => [ 'get', ], 'schemes' => [ 'http', 'https', ], 'security' => [ [ 'AK' => [], ], ], 'operationType' => 'read', 'deprecated' => false, 'systemTags' => [], 'parameters' => [ [ 'name' => 'appGroupIdentity', 'in' => 'path', 'schema' => [ 'description' => '应用的名称或者是应用id', 'type' => 'string', 'required' => true, 'docRequired' => true, 'example' => 'my_app', ], ], [ 'name' => 'appVersionId', 'in' => 'path', 'schema' => [ 'description' => '应用下的版本id', 'type' => 'string', 'required' => true, 'docRequired' => true, 'example' => '123456', ], ], [ 'name' => 'scriptName', 'in' => 'path', 'schema' => [ 'description' => '脚本名称', 'type' => 'string', 'required' => true, 'docRequired' => true, 'example' => 'file_names', ], ], ], 'responses' => [ 200 => [ 'schema' => [ 'type' => 'object', 'properties' => [ 'requestId' => [ 'description' => '唯一标识一次请求', 'type' => 'string', 'example' => 'ABCDEFGH', ], 'result' => [ 'description' => '脚本列表', 'type' => 'array', 'items' => [ 'type' => 'object', 'properties' => [ 'createTime' => [ 'description' => '脚本创建时间', 'type' => 'string', 'example' => '2020-04-02 20:21:14', ], 'fileName' => [ 'description' => '脚本文件名', 'type' => 'string', 'example' => 'my_cava_script.cava', ], 'modifyTime' => [ 'description' => '脚本最后一次修改时间', 'type' => 'string', 'example' => '2020-04-02 21:21:14', ], 'pathName' => [ 'description' => '脚本路径名', 'type' => 'string', 'example' => 'src', ], ], ], ], ], ], ], '5XX' => [ 'schema' => [ 'type' => 'object', 'properties' => [ 'code' => [ 'type' => 'string', ], 'message' => [ 'type' => 'string', ], 'requestId' => [ 'type' => 'string', ], 'httpCode' => [ 'type' => 'integer', 'format' => 'int32', ], ], ], ], ], 'responseDemo' => '[{"type":"json","example":"{\\n \\"requestId\\": \\"ABCDEFGH\\",\\n \\"result\\": [\\n {\\n \\"createTime\\": \\"2020-04-02 20:21:14\\",\\n \\"fileName\\": \\"my_cava_script.cava\\",\\n \\"modifyTime\\": \\"2020-04-02 21:21:14\\",\\n \\"pathName\\": \\"src\\"\\n }\\n ]\\n}","errorExample":""},{"type":"xml","example":"ABCDEFGH\\n\\n my_cava_script.cava\\n src\\n 2020-04-02 20:21:14\\n 2020-04-02 21:21:14\\n","errorExample":""}]', 'title' => '获取脚本文件名称列表', 'summary' => '获取指定版本指定脚本下所有的文件名。', 'requestParamsDescription' => ' ', 'responseParamsDescription' => ' ```'."\n" .'错误返回'."\n" .'{'."\n" .' "requestId" : "ABCDEFGH",'."\n" .' "code":"ResourceNotFound",'."\n" .' "message":"The specified script not found.",'."\n" .' "httpCode":404'."\n" .'}'."\n" .'```', 'extraInfo' => ' ', ], 'DeleteSortScriptFile' => [ 'summary' => '删除脚本文件。', 'path' => '/v4/openapi/app-groups/{appGroupIdentity}/apps/{appVersionId}/sort-scripts/{scriptName}/files/src/{fileName}', 'methods' => [ 'delete', ], 'schemes' => [ 'http', 'https', ], 'security' => [ [ 'AK' => [], ], ], 'operationType' => 'write', 'deprecated' => false, 'systemTags' => [ 'operationType' => 'update', 'riskType' => 'none', 'chargeType' => 'free', 'abilityTreeNodes' => [ 'FEATUREopensearchN8M8WS', ], ], 'parameters' => [ [ 'name' => 'appGroupIdentity', 'in' => 'path', 'schema' => [ 'description' => '应用名称', 'type' => 'string', 'required' => true, 'docRequired' => true, 'example' => 'search', ], ], [ 'name' => 'appVersionId', 'in' => 'path', 'schema' => [ 'description' => '版本ID', 'type' => 'string', 'required' => true, 'docRequired' => true, 'example' => '1234567', ], ], [ 'name' => 'scriptName', 'in' => 'path', 'schema' => [ 'description' => '脚本名称', 'type' => 'string', 'required' => true, 'docRequired' => true, 'example' => 'cava', ], ], [ 'name' => 'fileName', 'in' => 'path', 'schema' => [ 'description' => '需要删除的脚本文件名', 'type' => 'string', 'required' => true, 'docRequired' => true, 'example' => 'cavafile', ], ], ], 'responses' => [ 200 => [ 'schema' => [ 'type' => 'object', 'properties' => [ 'requestId' => [ 'description' => '请求ID', 'type' => 'string', 'example' => 'ABCDEFGH', ], ], ], ], '5XX' => [ 'schema' => [ 'type' => 'object', 'properties' => [ 'code' => [ 'type' => 'string', ], 'message' => [ 'type' => 'string', ], 'requestId' => [ 'type' => 'string', ], 'httpCode' => [ 'type' => 'integer', 'format' => 'int32', ], ], ], ], ], 'responseDemo' => '[{"type":"json","example":"{\\n \\"requestId\\": \\"ABCDEFGH\\"\\n}","errorExample":""},{"type":"xml","example":"ABCDEFGH","errorExample":""}]', 'title' => '删除排序脚本文件', 'requestParamsDescription' => ' ', 'responseParamsDescription' => ' ', 'extraInfo' => ' ', ], 'DeleteSortScript' => [ 'summary' => '删除排序脚本。', 'path' => '/v4/openapi/app-groups/{appGroupIdentity}/apps/{appVersionId}/sort-scripts/{scriptName}', 'methods' => [ 'delete', ], 'schemes' => [ 'http', 'https', ], 'security' => [ [ 'AK' => [], ], ], 'operationType' => 'write', 'deprecated' => false, 'systemTags' => [ 'operationType' => 'delete', 'riskType' => 'none', 'chargeType' => 'free', 'abilityTreeNodes' => [ 'FEATUREopensearchN8M8WS', ], ], 'parameters' => [ [ 'name' => 'appGroupIdentity', 'in' => 'path', 'schema' => [ 'description' => '应用的名称或者是应用id', 'type' => 'string', 'required' => true, 'docRequired' => true, 'example' => 'search', ], ], [ 'name' => 'scriptName', 'in' => 'path', 'schema' => [ 'description' => '脚本名称', 'type' => 'string', 'required' => true, 'docRequired' => true, 'example' => 'cava', ], ], [ 'name' => 'appVersionId', 'in' => 'path', 'schema' => [ 'description' => '应用下的版本id', 'type' => 'string', 'required' => true, 'docRequired' => true, 'example' => '1234567', ], ], ], 'responses' => [ 200 => [ 'schema' => [ 'type' => 'object', 'properties' => [ 'requestId' => [ 'description' => '请求ID', 'type' => 'string', 'example' => 'ABCDEFGH', ], ], ], ], '5XX' => [ 'schema' => [ 'type' => 'object', 'properties' => [ 'code' => [ 'type' => 'string', ], 'message' => [ 'type' => 'string', ], 'requestId' => [ 'type' => 'string', ], 'httpCode' => [ 'type' => 'integer', 'format' => 'int32', ], ], ], ], ], 'responseDemo' => '[{"type":"json","example":"{\\n \\"requestId\\": \\"ABCDEFGH\\"\\n}","errorExample":""},{"type":"xml","example":"ABCDEFGH","errorExample":""}]', 'title' => '删除排序脚本', 'responseParamsDescription' => '```'."\n" .'错误返回'."\n" .'{'."\n" .' "requestId" : "ABCDEFGH"'."\n" .' "code":"InvalidAppStatus",'."\n" .' "message":"invalid app status.",'."\n" .' "httpCode":400'."\n" .'}'."\n" .'```', ], 'CreateSortScript' => [ 'summary' => '创建排序脚本。', 'path' => '/v4/openapi/app-groups/{appGroupIdentity}/apps/{appVersionId}/sort-scripts', 'methods' => [ 'post', ], 'schemes' => [ 'http', 'https', ], 'security' => [ [ 'AK' => [], ], ], 'operationType' => 'write', 'deprecated' => false, 'systemTags' => [ 'operationType' => 'create', 'riskType' => 'none', 'chargeType' => 'free', 'abilityTreeNodes' => [ 'FEATUREopensearchN8M8WS', ], ], 'parameters' => [ [ 'name' => 'appGroupIdentity', 'in' => 'path', 'schema' => [ 'description' => '应用的名称或者是应用id', 'type' => 'string', 'required' => true, 'docRequired' => true, 'example' => 'search', ], ], [ 'name' => 'appVersionId', 'in' => 'path', 'schema' => [ 'description' => '应用下的报表id', 'type' => 'string', 'required' => true, 'docRequired' => true, 'example' => '1234567', ], ], [ 'name' => 'body', 'in' => 'body', 'style' => 'json', 'schema' => [ 'description' => '请求体', 'type' => 'object', 'properties' => [ 'scriptName' => [ 'description' => '脚本名称', 'type' => 'string', 'required' => false, 'example' => 'rank_cava_20230606_v7', ], 'type' => [ 'description' => '脚本的类型，目前只支持cava_script', 'type' => 'string', 'required' => false, 'example' => 'cava_script'."\n", ], 'scope' => [ 'description' => '脚本的作用范围', 'type' => 'string', 'required' => false, 'example' => 'second_rank', ], 'description' => [ 'title' => '脚本备注', 'type' => 'string', 'required' => false, ], ], 'required' => false, ], ], ], 'responses' => [ 200 => [ 'schema' => [ 'type' => 'object', 'properties' => [ 'requestId' => [ 'description' => '唯一标识一次请求', 'type' => 'string', 'example' => 'ABCDEFGH', ], 'result' => [ 'description' => '返回结果', 'type' => 'object', 'properties' => [ 'scriptName' => [ 'description' => '脚本名称', 'type' => 'string', 'example' => 'rank_cava_20230606_v7'."\n", ], 'type' => [ 'description' => '脚本的类型', 'type' => 'string', 'example' => 'cava_script', ], 'scope' => [ 'description' => '脚本的作用范围', 'type' => 'string', 'example' => 'second_rank', ], ], ], ], ], ], '5XX' => [ 'schema' => [ 'type' => 'object', 'properties' => [ 'code' => [ 'type' => 'string', ], 'message' => [ 'type' => 'string', ], 'requestId' => [ 'type' => 'string', ], 'httpCode' => [ 'type' => 'integer', 'format' => 'int32', ], ], ], ], ], 'responseDemo' => '[{"type":"json","example":"{\\n \\"requestId\\": \\"ABCDEFGH\\",\\n \\"result\\": {\\n \\"scriptName\\": \\"rank_cava_20230606_v7\\\\n\\",\\n \\"type\\": \\"cava_script\\",\\n \\"scope\\": \\"second_rank\\"\\n }\\n}","errorExample":""},{"type":"xml","example":"ABCDEFGH","errorExample":""}]', 'title' => '创建排序脚本', 'requestParamsDescription' => '**请求参数**'."\n" ."\n" .'| 名称 | 类型 | 是否必选 | 描述 |'."\n" .'| --- | --- | --- | --- |'."\n" .'| scriptParams | Map | 是 | 待注册的script参数 |'."\n" ."\n" .'**scriptParams**'."\n" ."\n" .'| 名称 | 类型 | 是否必选 | 描述 |'."\n" .'| --- | --- | --- | --- |'."\n" .'| scriptName | String | 是 | script名称 |'."\n" .'| type | String | 是 | 脚本的类型，目前只支持cava_script |'."\n" .'| scope | String | 是 | 脚本的作用范围，目前只支持second_rank |'."\n", 'responseParamsDescription' => ' ', 'extraInfo' => ' ', ], 'CompileSortScript' => [ 'summary' => '编译排序脚本。', 'path' => '/v4/openapi/app-groups/{appGroupIdentity}/apps/{appVersionId}/sort-scripts/{scriptName}/actions/compiling', 'methods' => [ 'post', ], 'schemes' => [ 'http', 'https', ], 'security' => [ [ 'AK' => [], ], ], 'operationType' => 'readAndWrite', 'deprecated' => false, 'systemTags' => [ 'operationType' => 'update', 'riskType' => 'none', 'chargeType' => 'free', 'abilityTreeNodes' => [ 'FEATUREopensearchN8M8WS', ], ], 'parameters' => [ [ 'name' => 'appGroupIdentity', 'in' => 'path', 'schema' => [ 'description' => '应用的名称、应用id', 'type' => 'string', 'required' => true, 'docRequired' => true, 'example' => 'search', ], ], [ 'name' => 'scriptName', 'in' => 'path', 'schema' => [ 'description' => '脚本名称', 'type' => 'string', 'required' => true, 'docRequired' => true, 'example' => 'script', ], ], [ 'name' => 'appVersionId', 'in' => 'path', 'schema' => [ 'description' => '应用下的版本id', 'type' => 'string', 'required' => false, 'example' => '130196473', ], ], ], 'responses' => [ 200 => [ 'schema' => [ 'type' => 'object', 'properties' => [ 'requestId' => [ 'description' => '唯一标识一次请求', 'type' => 'string', 'example' => 'ABCDEFGH', ], ], ], ], '5XX' => [ 'schema' => [ 'type' => 'object', 'properties' => [ 'code' => [ 'type' => 'string', ], 'message' => [ 'type' => 'string', ], 'requestId' => [ 'type' => 'string', ], 'httpCode' => [ 'type' => 'integer', 'format' => 'int32', ], ], ], ], ], 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"requestId\\": \\"ABCDEFGH\\"\\n}","type":"json"}]', 'title' => '编译排序脚本', 'responseParamsDescription' => '```'."\n" .'错误返回'."\n" .'{'."\n" .' "requestId" : "ABCDEFGH",'."\n" .' "code":"InvalidAppStatus",'."\n" .' "message":"invalid app status.",'."\n" .' "httpCode":400'."\n" .'}'."\n" .'```', ], 'UpdateSearchStrategy' => [ 'summary' => '支持dryrun。', 'path' => '/v4/openapi/app-groups/{appGroupIdentity}/apps/{appId}/search-strategies/{strategyName}', 'methods' => [ 'put', ], 'schemes' => [ 'http', 'https', ], 'security' => [ [ 'AK' => [], ], ], 'operationType' => 'write', 'deprecated' => false, 'systemTags' => [ 'operationType' => 'update', 'riskType' => 'none', 'chargeType' => 'free', 'abilityTreeNodes' => [ 'FEATUREopensearchBNTDZX', ], ], 'parameters' => [ [ 'name' => 'appGroupIdentity', 'in' => 'path', 'schema' => [ 'description' => '应用名称', 'type' => 'string', 'required' => true, 'docRequired' => true, 'example' => 'group_name', ], ], [ 'name' => 'appId', 'in' => 'path', 'schema' => [ 'description' => '版本号', 'type' => 'string', 'required' => true, 'docRequired' => true, 'example' => '"110157886"', ], ], [ 'name' => 'strategyName', 'in' => 'path', 'schema' => [ 'description' => '策略名称', 'type' => 'string', 'required' => true, 'docRequired' => true, 'example' => 'default', ], ], [ 'name' => 'body', 'in' => 'body', 'schema' => [ 'description' => '查询策略，参考[SearchStrategy](~~2400242~~)', 'required' => false, '$ref' => '#/components/schemas/SearchStrategy', ], ], ], 'responses' => [ 200 => [ 'schema' => [ 'description' => '响应体', 'type' => 'object', 'properties' => [ 'requestId' => [ 'description' => '请求id', 'type' => 'string', 'example' => 'ABCDEFGH', ], ], ], ], '5XX' => [ 'schema' => [ 'type' => 'object', 'properties' => [ 'code' => [ 'type' => 'string', ], 'message' => [ 'type' => 'string', ], 'requestId' => [ 'type' => 'string', ], 'httpCode' => [ 'type' => 'integer', 'format' => 'int32', ], ], ], ], ], 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"requestId\\": \\"ABCDEFGH\\"\\n}","type":"json"}]', 'title' => '更新搜索策略', ], 'RemoveSearchStrategy' => [ 'summary' => '删除查询策略。', 'path' => '/v4/openapi/app-groups/{appGroupIdentity}/apps/{appId}/search-strategies/{strategyName}', 'methods' => [ 'delete', ], 'schemes' => [ 'http', 'https', ], 'security' => [ [ 'AK' => [], ], ], 'operationType' => 'write', 'deprecated' => false, 'systemTags' => [ 'operationType' => 'delete', 'riskType' => 'none', 'chargeType' => 'free', 'abilityTreeNodes' => [ 'FEATUREopensearchBNTDZX', ], ], 'parameters' => [ [ 'name' => 'appGroupIdentity', 'in' => 'path', 'schema' => [ 'description' => '应用名称', 'type' => 'string', 'required' => true, 'docRequired' => true, 'example' => 'my_app_group_name', ], ], [ 'name' => 'appId', 'in' => 'path', 'schema' => [ 'description' => '版本号', 'type' => 'string', 'required' => true, 'docRequired' => true, 'example' => '110157886', ], ], [ 'name' => 'strategyName', 'in' => 'path', 'schema' => [ 'description' => '策略名称', 'type' => 'string', 'required' => true, 'docRequired' => true, 'example' => 'default', ], ], ], 'responses' => [ 200 => [ 'schema' => [ 'description' => '响应体', 'type' => 'object', 'properties' => [ 'requestId' => [ 'description' => '请求id', 'type' => 'string', 'example' => 'F5099063-6B86-F398-D843-905F9EFB683A', ], ], 'example' => '{}', ], ], '5XX' => [ 'schema' => [ 'type' => 'object', 'properties' => [ 'code' => [ 'type' => 'string', ], 'message' => [ 'type' => 'string', ], 'requestId' => [ 'type' => 'string', ], 'httpCode' => [ 'type' => 'integer', 'format' => 'int32', ], ], ], ], ], 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"requestId\\": \\"F5099063-6B86-F398-D843-905F9EFB683A\\"\\n}","type":"json"}]', 'title' => '删除查询策略', ], 'ListSearchStrategies' => [ 'summary' => '获取查询策略详情。', 'path' => '/v4/openapi/app-groups/{appGroupIdentity}/apps/{appId}/search-strategies', 'methods' => [ 'get', ], 'schemes' => [ 'http', 'https', ], 'security' => [ [ 'AK' => [], ], ], 'operationType' => 'read', 'deprecated' => false, 'systemTags' => [ 'operationType' => 'list', 'riskType' => 'none', 'chargeType' => 'free', 'abilityTreeNodes' => [ 'FEATUREopensearchBNTDZX', ], ], 'parameters' => [ [ 'name' => 'appGroupIdentity', 'in' => 'path', 'schema' => [ 'description' => '应用名称', 'type' => 'string', 'required' => true, 'docRequired' => true, 'example' => '"my_app"', ], ], [ 'name' => 'appId', 'in' => 'path', 'schema' => [ 'description' => '版本ID', 'type' => 'string', 'required' => true, 'docRequired' => true, 'example' => '"110123456"', ], ], ], 'responses' => [ 200 => [ 'schema' => [ 'description' => '返回对象', 'type' => 'object', 'properties' => [ 'requestId' => [ 'description' => '请求ID', 'type' => 'string', 'example' => '9C6351F5-2E2E-5249-888B-88A74E1B8A65', ], ], 'example' => '{}', ], ], '5XX' => [ 'schema' => [ 'type' => 'object', 'properties' => [ 'code' => [ 'type' => 'string', ], 'message' => [ 'type' => 'string', ], 'requestId' => [ 'type' => 'string', ], 'httpCode' => [ 'type' => 'integer', 'format' => 'int32', ], ], ], ], ], 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"requestId\\": \\"9C6351F5-2E2E-5249-888B-88A74E1B8A65\\"\\n}","type":"json"}]', 'title' => '获取查询策略详情', 'responseParamsDescription' => '返回结果示例：'."\n" .'```json'."\n" .'{'."\n" .' "name": "test",'."\n" .' "status": 1,'."\n" .' "description": "",'."\n" .' "updated": 12455,'."\n" .' "searchConfigs": ['."\n" .' {'."\n" .' "queryType": "vector",'."\n" .' "firstRankName": "",'."\n" .' "secondRankName": "",'."\n" .' "mergeProportion": 30'."\n" .' },'."\n" .' {'."\n" .' "queryType": "keyword",'."\n" .' "firstRankName": "",'."\n" .' "secondName": "",'."\n" .' "mergeProportion": 70'."\n" .' }'."\n" .' ],'."\n" .' "mergeConfig": {'."\n" .' "rankName": "",'."\n" .' "docCount": 5000'."\n" .' }'."\n" .'}'."\n" .'```', ], 'GetSearchStrategy' => [ 'summary' => '获取查询策略详情。', 'path' => '/v4/openapi/app-groups/{appGroupIdentity}/apps/{appId}/search-strategies/{strategyName}', 'methods' => [ 'get', ], 'schemes' => [ 'http', 'https', ], 'security' => [ [ 'AK' => [], ], ], 'operationType' => 'read', 'deprecated' => false, 'systemTags' => [ 'operationType' => 'get', 'riskType' => 'none', 'chargeType' => 'free', 'abilityTreeNodes' => [ 'FEATUREopensearchBNTDZX', ], ], 'parameters' => [ [ 'name' => 'appGroupIdentity', 'in' => 'path', 'schema' => [ 'description' => '应用分组ID。', 'type' => 'string', 'required' => true, 'docRequired' => true, 'example' => 'my_app_group_name', ], ], [ 'name' => 'appId', 'in' => 'path', 'schema' => [ 'description' => '应用版本', 'type' => 'string', 'required' => true, 'docRequired' => true, 'example' => '110157886', ], ], [ 'name' => 'strategyName', 'in' => 'path', 'schema' => [ 'description' => '策略名称', 'type' => 'string', 'required' => true, 'docRequired' => true, 'example' => 'default', ], ], ], 'responses' => [ 200 => [ 'schema' => [ 'type' => 'object', 'properties' => [ 'requestId' => [ 'description' => '请求ID。', 'type' => 'string', 'example' => '5C1C1C45-C64A-AD30-565F-140871D57E5E', ], ], ], ], '5XX' => [ 'schema' => [ 'type' => 'object', 'properties' => [ 'code' => [ 'type' => 'string', ], 'message' => [ 'type' => 'string', ], 'requestId' => [ 'type' => 'string', ], 'httpCode' => [ 'type' => 'integer', 'format' => 'int32', ], ], ], ], ], 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"requestId\\": \\"5C1C1C45-C64A-AD30-565F-140871D57E5E\\"\\n}","type":"json"}]', 'title' => '获取搜索策略', ], 'CreateSearchStrategy' => [ 'summary' => '创建查询策略。', 'path' => '/v4/openapi/app-groups/{appGroupIdentity}/apps/{appId}/search-strategies', 'methods' => [ 'post', ], 'schemes' => [ 'http', 'https', ], 'security' => [ [ 'AK' => [], ], ], 'operationType' => 'write', 'deprecated' => false, 'systemTags' => [ 'operationType' => 'create', 'riskType' => 'none', 'chargeType' => 'free', 'abilityTreeNodes' => [ 'FEATUREopensearchBNTDZX', ], ], 'parameters' => [ [ 'name' => 'appGroupIdentity', 'in' => 'path', 'schema' => [ 'description' => '应用名称', 'type' => 'string', 'required' => true, 'docRequired' => true, 'example' => '"my_app"', ], ], [ 'name' => 'appId', 'in' => 'path', 'schema' => [ 'description' => '版本号', 'type' => 'string', 'required' => true, 'docRequired' => true, 'example' => '1234', ], ], [ 'name' => 'body', 'in' => 'body', 'schema' => [ 'description' => '查询策略', 'required' => false, '$ref' => '#/components/schemas/SearchStrategy', ], ], ], 'responses' => [ 200 => [ 'schema' => [ 'description' => '响应体'."\n" ."\n", 'type' => 'object', 'properties' => [ 'requestId' => [ 'description' => '请求id', 'type' => 'string', 'example' => '"abc123"', ], ], ], ], '5XX' => [ 'schema' => [ 'type' => 'object', 'properties' => [ 'code' => [ 'type' => 'string', ], 'message' => [ 'type' => 'string', ], 'requestId' => [ 'type' => 'string', ], 'httpCode' => [ 'type' => 'integer', 'format' => 'int32', ], ], ], ], ], 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"requestId\\": \\"\\\\\\"abc123\\\\\\"\\"\\n}","type":"json"}]', 'title' => '创建查询策略', ], 'UpdateFetchFields' => [ 'summary' => '支持 dryRun。', 'path' => '/v4/openapi/app-groups/{appGroupIdentity}/apps/{appId}/fetch-fields', 'methods' => [ 'put', ], 'schemes' => [ 'http', 'https', ], 'security' => [ [ 'AK' => [], ], ], 'operationType' => 'write', 'deprecated' => false, 'systemTags' => [ 'operationType' => 'update', 'riskType' => 'none', 'chargeType' => 'free', 'abilityTreeNodes' => [ 'FEATUREopensearchYVAV9H', 'FEATUREopensearchBZ8NMO', ], ], 'parameters' => [ [ 'name' => 'dryRun', 'in' => 'query', 'schema' => [ 'description' => '是否为空运行请求', 'type' => 'boolean', 'required' => false, 'example' => 'true', ], ], [ 'name' => 'appGroupIdentity', 'in' => 'path', 'schema' => [ 'description' => '应用名称', 'type' => 'string', 'required' => true, 'docRequired' => true, 'example' => '“my_app_group_name”', ], ], [ 'name' => 'appId', 'in' => 'path', 'schema' => [ 'description' => '版本号', 'type' => 'integer', 'format' => 'int32', 'required' => true, 'docRequired' => true, 'example' => '110157886', ], ], [ 'name' => 'body', 'in' => 'body', 'style' => 'json', 'schema' => [ 'description' => '请求体', 'type' => 'array', 'items' => [ 'description' => '展示字段数组', 'type' => 'string', 'required' => false, 'example' => '\'["id", "name", "title"]\'', ], 'required' => false, 'maxItems' => 100, ], ], ], 'responses' => [ 200 => [ 'schema' => [ 'type' => 'object', 'properties' => [ 'result' => [ 'description' => '是否修改成功', 'type' => 'boolean', 'example' => 'true', ], 'requestId' => [ 'description' => '请求ID', 'type' => 'string', 'example' => 'D77D0DAF-790D-F5F5-A9C0-133738165014', ], ], ], ], '5XX' => [ 'schema' => [ 'type' => 'object', 'properties' => [ 'code' => [ 'type' => 'string', ], 'httpCode' => [ 'type' => 'integer', 'format' => 'int32', ], 'requestId' => [ 'type' => 'string', ], 'message' => [ 'type' => 'string', ], ], ], ], ], 'responseDemo' => '[{"type":"json","example":"{\\n \\"result\\": true,\\n \\"requestId\\": \\"D77D0DAF-790D-F5F5-A9C0-133738165014\\"\\n}","errorExample":""},{"type":"xml","example":"D77D0DAF-790D-F5F5-A9C0-133738165014\\ntrue","errorExample":""}]', 'title' => '更新应用版本的默认展示字段', 'responseParamsDescription' => ' ', 'extraInfo' => ' ', ], 'UpdateSummaries' => [ 'summary' => '支持 dryRun。', 'path' => '/v4/openapi/app-groups/{appGroupIdentity}/apps/{appId}/summaries', 'methods' => [ 'put', ], 'schemes' => [ 'http', 'https', ], 'security' => [ [ 'AK' => [], ], ], 'operationType' => 'write', 'deprecated' => false, 'systemTags' => [ 'operationType' => 'update', 'riskType' => 'none', 'chargeType' => 'free', 'abilityTreeCode' => '55273', 'abilityTreeNodes' => [ 'FEATUREopensearchYVAV9H', 'FEATUREopensearchBZ8NMO', ], ], 'parameters' => [ [ 'name' => 'dryRun', 'in' => 'query', 'schema' => [ 'description' => '是否为空运行请求', 'type' => 'boolean', 'required' => false, 'example' => 'true', ], ], [ 'name' => 'appGroupIdentity', 'in' => 'path', 'schema' => [ 'description' => '应用名称', 'type' => 'string', 'required' => true, 'docRequired' => true, 'example' => '“my_app_group_name”', ], ], [ 'name' => 'appId', 'in' => 'path', 'schema' => [ 'description' => '版本号', 'type' => 'integer', 'format' => 'int32', 'required' => true, 'docRequired' => true, 'example' => '10157886', ], ], [ 'name' => 'body', 'in' => 'body', 'style' => 'json', 'schema' => [ 'description' => '请求体', 'type' => 'array', 'items' => [ 'description' => '请求体', 'type' => 'object', 'properties' => [ 'field' => [ 'description' => '字段', 'type' => 'string', 'required' => false, 'example' => '"title"', ], 'len' => [ 'description' => '片段长度', 'type' => 'integer', 'format' => 'int32', 'required' => false, 'example' => '50', ], 'element' => [ 'description' => '飘红标签', 'type' => 'string', 'required' => false, 'example' => '"em" ', ], 'ellipsis' => [ 'description' => '片段链接符', 'type' => 'string', 'required' => false, 'example' => '"..."', ], 'snippet' => [ 'description' => '片段数量', 'type' => 'integer', 'format' => 'int32', 'required' => false, 'example' => '1', ], ], 'required' => false, ], 'required' => false, 'maxItems' => 100, ], ], ], 'responses' => [ 200 => [ 'schema' => [ 'type' => 'object', 'properties' => [ 'result' => [ 'description' => '是否成功', 'type' => 'boolean', 'example' => 'true', ], 'requestId' => [ 'description' => '请求ID', 'type' => 'string', 'example' => '7A389E09-7964-5A2B-FE9D-F6CFA7162852', ], ], ], ], '5XX' => [ 'schema' => [ 'type' => 'object', 'properties' => [ 'code' => [ 'type' => 'string', ], 'httpCode' => [ 'type' => 'integer', 'format' => 'int32', ], 'requestId' => [ 'type' => 'string', ], 'message' => [ 'type' => 'string', ], ], ], ], ], 'responseDemo' => '[{"type":"json","example":"{\\n \\"result\\": true,\\n \\"requestId\\": \\"7A389E09-7964-5A2B-FE9D-F6CFA7162852\\"\\n}","errorExample":""},{"type":"xml","example":"true\\n7A389E09-7964-5A2B-FE9D-F6CFA7162852","errorExample":""}]', 'title' => '设置指定应用版本摘要', 'requestParamsDescription' => '**请求体**'."\n" .'| 字段 | 类型 | 是否必要 | 示例值 | 描述 |'."\n" .'| --- | --- | --- | --- | --- |'."\n" .'| [] | Object | 是 | | 摘要设置
参考：[Summary](~~170016~~) 字段 |'."\n" .'| [].field | String | 是 | "title" | 字段 |'."\n" .'| [].len | Integer | 是 | 50 | 片段长度 |'."\n" .'| [].element | String | 是 | "em" | 飘红标签 |'."\n" .'| [].ellipsis | String | 是 | "..." | 片段链接符 |'."\n" .'| [].snippet | Integer | 是 | 1 | 片段数量 |', 'responseParamsDescription' => ' ', 'extraInfo' => ' ', ], 'CreateFunctionResource' => [ 'summary' => '创建指定功能下的算法资源。', 'path' => '/v4/openapi/app-groups/{appGroupIdentity}/functions/{functionName}/resources', 'methods' => [ 'post', ], 'schemes' => [ 'http', 'https', ], 'security' => [ [ 'AK' => [], ], ], 'consumes' => [ 'application/json', ], 'produces' => [ 'application/json', ], 'operationType' => 'write', 'deprecated' => false, 'systemTags' => [], 'parameters' => [ [ 'name' => 'appGroupIdentity', 'in' => 'path', 'schema' => [ 'title' => '应用ID', 'description' => '应用ID', 'type' => 'string', 'required' => true, 'example' => 'my_app_group_name', ], ], [ 'name' => 'functionName', 'in' => 'path', 'schema' => [ 'title' => '功能名称', 'description' => '功能名称', 'type' => 'string', 'required' => true, 'example' => 'rank', ], ], [ 'name' => 'body', 'in' => 'body', 'style' => 'json', 'schema' => [ 'description' => '请求体', 'type' => 'object', 'properties' => [ 'Data' => [ 'description' => '资源数据，不同resourceType对应的data结构不同', 'type' => 'object', 'properties' => [ 'Content' => [ 'description' => 'raw_file类型资源对应的文件内容', 'type' => 'string', 'required' => false, 'example' => '"abc"', ], 'Generators' => [ 'description' => 'feature_generator类型资源对应的特征生成列表', 'type' => 'array', 'items' => [ 'description' => '特征生成描述', 'type' => 'object', 'properties' => [ 'Generator' => [ 'description' => '特征生成的类型', 'type' => 'string', 'required' => false, 'enumValueTitles' => [ 'lookup' => 'lookup', 'sequence' => 'sequence', 'overlap' => 'overlap', 'raw' => 'raw', 'combo' => 'combo', 'id' => 'id', ], 'example' => 'id', ], 'Input' => [ 'description' => '输入', 'type' => 'object', 'properties' => [ 'Features' => [ 'description' => '输入特征列表', 'type' => 'array', 'items' => [ 'description' => '输入特征', 'type' => 'object', 'properties' => [ 'Name' => [ 'description' => '特征名', 'type' => 'string', 'required' => false, 'example' => 'system_item_id', ], 'Type' => [ 'description' => '特征类型', 'type' => 'string', 'required' => false, 'enumValueTitles' => [ 'item' => 'item', 'user' => 'user', ], 'example' => 'item', ], ], 'required' => false, ], 'required' => false, ], ], 'required' => false, ], 'Output' => [ 'description' => '输出的特征名', 'type' => 'string', 'required' => false, 'example' => 'item_id_feature', ], ], 'required' => false, ], 'required' => false, ], ], 'required' => false, ], 'Description' => [ 'description' => '资源描述', 'type' => 'string', 'required' => false, 'example' => '""', ], 'ResourceName' => [ 'description' => '资源名称', 'type' => 'string', 'required' => false, 'example' => 'fg_jsoon', ], 'ResourceType' => [ 'description' => '资源类型', 'type' => 'string', 'required' => false, 'enumValueTitles' => [ 'feature_generator' => 'feature_generator', 'raw_file' => 'raw_file', ], 'example' => 'feature_generator', ], ], 'required' => false, 'docRequired' => true, ], ], ], 'responses' => [ 200 => [ 'schema' => [ 'type' => 'object', 'properties' => [ 'Status' => [ 'description' => '状态码'."\n" ."\n" .'- OK 成功'."\n" .'- FAIL 失败', 'type' => 'string', 'example' => 'OK', ], 'HttpCode' => [ 'description' => 'HTTP状态码', 'type' => 'integer', 'format' => 'int64', 'example' => '200', ], 'RequestId' => [ 'description' => '请求ID', 'type' => 'string', 'example' => 'A4D487A9-A456-5AA5-A9C6-B7BF2889CF74', ], 'Message' => [ 'description' => '返回的错误信息', 'type' => 'string', 'example' => '""', ], 'Code' => [ 'description' => '返回的错误码（没有错误为空）', 'type' => 'string', 'example' => '""', ], 'Latency' => [ 'description' => 'api请求耗时 (单位毫秒)', 'type' => 'number', 'format' => 'double', 'example' => '123', ], ], ], ], ], 'staticInfo' => [ 'returnType' => 'synchronous', ], 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"Status\\": \\"OK\\",\\n \\"HttpCode\\": 200,\\n \\"RequestId\\": \\"A4D487A9-A456-5AA5-A9C6-B7BF2889CF74\\",\\n \\"Message\\": \\"\\\\\\"\\\\\\"\\",\\n \\"Code\\": \\"\\\\\\"\\\\\\"\\",\\n \\"Latency\\": 123\\n}","type":"json"}]', 'title' => '创建算法资源', ], 'GetFunctionCurrentVersion' => [ 'summary' => '获取当前功能新建实例时使用的版本信息。', 'path' => '/v4/openapi/functions/{functionName}/current-version', 'methods' => [ 'get', ], 'schemes' => [ 'http', 'https', ], 'security' => [ [ 'AK' => [], ], ], 'produces' => [ 'application/json', ], 'operationType' => 'read', 'deprecated' => false, 'systemTags' => [ 'operationType' => 'get', ], 'parameters' => [ [ 'name' => 'functionName', 'in' => 'path', 'schema' => [ 'description' => '功能名称，支持的模型有：'."\n" ."\n" .'- CTR模型：ctr'."\n" .'- 人气模型：pop'."\n" .'- 类目模型：category'."\n" .'- 热词模型：hot'."\n" .'- 底纹模型：hint'."\n" .'- 下拉提示模型：suggest'."\n" .'- 分词模型：analyzer'."\n" .'- 词权重模型：termweight', 'type' => 'string', 'required' => true, 'example' => 'ctr', ], ], [ 'name' => 'modelType', 'in' => 'query', 'schema' => [ 'description' => '模型类型，不同功能对应的模型类型如下：'."\n" ."\n" .'- CTR模型：tf_checkpoint'."\n" .'- 人气模型：pop'."\n" .'- 类目模型：offline_inference'."\n" .'- 热词模型：offline_inference'."\n" .'- 底纹模型：offline_inference'."\n" .'- 下拉提示模型：offline_inference'."\n" .'- 分词模型：text'."\n" .'- 词权重模型：tf_checkpoint', 'type' => 'string', 'required' => true, 'enumValueTitles' => [ 'pop' => '人气模型', 'offline_inference' => '热词底纹\\类目预测', 'tf_checkpoint' => 'ctr\\定制词权重等', 'text' => '定制分词', ], 'example' => 'tf_checkpoint', ], ], [ 'name' => 'functionType', 'in' => 'query', 'schema' => [ 'description' => '功能类型：'."\n" ."\n" .'- PAAS （默认）'."\n" .'- SAAS', 'type' => 'string', 'required' => false, 'example' => 'PAAS', ], ], [ 'name' => 'domain', 'in' => 'query', 'schema' => [ 'description' => '行业，默认为空，表示通用版', 'type' => 'string', 'required' => false, 'enumValueTitles' => [ 'education' => '教育行业', 'ecommerce' => '电商行业', 'community' => '内容社区', ], 'example' => 'ecommerce', ], ], [ 'name' => 'category', 'in' => 'query', 'schema' => [ 'description' => '垂类，默认为空', 'type' => 'string', 'required' => false, 'enumValueTitles' => [ 'general' => '通用', 'question' => '教育搜题', 'it' => 'IT内容', ], 'example' => 'general', ], ], ], 'responses' => [ 200 => [ 'schema' => [ 'description' => '响应体', 'type' => 'object', 'properties' => [ 'Status' => [ 'description' => '状态码', 'type' => 'string', 'example' => 'OK', ], 'HttpCode' => [ 'description' => 'HTTP状态码。', 'type' => 'integer', 'format' => 'int64', 'example' => '200', ], 'RequestId' => [ 'description' => '请求id', 'type' => 'string', 'example' => '1638157479281', ], 'Message' => [ 'description' => '错误信息', 'type' => 'string', 'example' => 'version not exist.', ], 'Code' => [ 'description' => '错误码', 'type' => 'string', 'example' => 'Version.NotExist', ], 'Result' => [ 'description' => '返回结果。', 'type' => 'object', 'properties' => [ 'FunctionName' => [ 'description' => '功能名称', 'type' => 'string', 'example' => 'ctr', ], 'FunctionType' => [ 'description' => '功能类型：'."\n" ."\n" .'- PAAS'."\n" .'- SAAS', 'type' => 'string', 'example' => 'PAAS', ], 'ModelType' => [ 'description' => '模型类型', 'type' => 'string', 'example' => 'tf_checkpoint', ], 'VersionConfig' => [ 'description' => '配置信息', 'type' => 'object', 'properties' => [ 'CreateParameters' => [ 'description' => '创建实例时使用的参数列表', 'type' => 'array', 'items' => [ 'description' => '参数体', 'type' => 'object', 'properties' => [ 'Name' => [ 'description' => 'name', 'type' => 'string', 'example' => 'params1', ], 'Required' => [ 'description' => 'required', 'type' => 'string', 'example' => 'true', ], ], 'example' => '{ "name": "params1", "required": "true", "formItemProps": "{\\"required\\": true, \\"pattern?\\": \\"/^[a-zA-Z][a-zA-Z0-9_]{0,29}$/\\"}", "componentProps": "{\\"component\\": \\"Input\\", \\"attributes\\": {\\"defaultValue\\": \\"value1\\"}}" }', ], 'example' => '[ { "name": "params1", "required": "true", "formItemProps": "{\\"required\\": true, \\"pattern?\\": \\"/^[a-zA-Z][a-zA-Z0-9_]{0,29}$/\\"}", "componentProps": "{\\"component\\": \\"Input\\", \\"attributes\\": {\\"defaultValue\\": \\"value1\\"}}" } ]', ], 'Depends' => [ 'description' => '实例的依赖项列表', 'type' => 'array', 'items' => [ 'description' => '参数体'."\n" ."\n", 'type' => 'object', 'properties' => [ 'Condition' => [ 'description' => '条件', 'type' => 'string', 'example' => '""', ], 'Dependency' => [ 'description' => '依赖项', 'type' => 'string', 'example' => '""', ], 'Description' => [ 'description' => '描述', 'type' => 'string', 'example' => '""', ], ], 'example' => '{ "dependency": "依赖项", "condition": "条件", "description": "" }', ], 'example' => '[ { "dependency": "依赖项", "condition": "条件", "description": "" } ]', ], 'UsageParameters' => [ 'description' => '实例在线使用过程中的参数列表', 'type' => 'array', 'items' => [ 'description' => '参数体', 'type' => 'object', 'properties' => [ 'Name' => [ 'description' => 'name', 'type' => 'string', 'example' => '""', ], 'Required' => [ 'description' => 'required', 'type' => 'string', 'example' => '""', ], ], 'example' => '{}', ], 'example' => '[]', ], ], 'example' => '{ "createParameters": [ { "name": "params1", "required": "true", "formItemProps": "{\\"required\\": true, \\"pattern?\\": \\"/^[a-zA-Z][a-zA-Z0-9_]{0,29}$/\\"}", "componentProps": "{\\"component\\": \\"Input\\", \\"attributes\\": {\\"defaultValue\\": \\"value1\\"}}" } ], "depends": [ { "dependency": "依赖项", "condition": "条件", "description": "" } ], "usageParameters": [] }', ], 'VersionId' => [ 'description' => '版本id', 'type' => 'integer', 'format' => 'int64', 'example' => '101', ], 'VersionName' => [ 'description' => '版本名称', 'type' => 'string', 'example' => 'v1', ], ], 'example' => '{ "versionName": "v1", "versionId": 101, "functionName": "ctr", "modelType": "tf_checkpoint", "functionType": "PAAS", "versionConfig": { "createParameters": [ { "name": "params1", "required": "true", "formItemProps": "{\\"required\\": true, \\"pattern?\\": \\"/^[a-zA-Z][a-zA-Z0-9_]{0,29}$/\\"}", "componentProps": "{\\"component\\": \\"Input\\", \\"attributes\\": {\\"defaultValue\\": \\"value1\\"}}" } ], "depends": [ { "dependency": "依赖项", "condition": "条件", "description": "" } ], "usageParameters": [] } }', ], 'Latency' => [ 'description' => '请求耗时（单位ms）', 'type' => 'integer', 'format' => 'int64', 'example' => '123', ], ], 'example' => '{ "status": "OK", "requestId": "", "httpCode": 200, "code": "", "message": "", "latency": 123, "result": { "versionName": "v1", "versionId": 101, "functionName": "ctr", "modelType": "tf_checkpoint", "functionType": "PAAS", "versionConfig": { "createParameters": [ { "name": "params1", "required": "true", "formItemProps": "{\\"required\\": true, \\"pattern?\\": \\"/^[a-zA-Z][a-zA-Z0-9_]{0,29}$/\\"}", "componentProps": "{\\"component\\": \\"Input\\", \\"attributes\\": {\\"defaultValue\\": \\"value1\\"}}" } ], "depends": [ { "dependency": "依赖项", "condition": "条件", "description": "" } ], "usageParameters": [] } } }', ], ], ], 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"Status\\": \\"OK\\",\\n \\"HttpCode\\": 200,\\n \\"RequestId\\": \\"1638157479281\\",\\n \\"Message\\": \\"version not exist.\\",\\n \\"Code\\": \\"Version.NotExist\\",\\n \\"Result\\": {\\n \\"FunctionName\\": \\"ctr\\",\\n \\"FunctionType\\": \\"PAAS\\",\\n \\"ModelType\\": \\"tf_checkpoint\\",\\n \\"VersionConfig\\": {\\n \\"CreateParameters\\": [\\n {\\n \\"Name\\": \\"params1\\",\\n \\"Required\\": \\"true\\"\\n }\\n ],\\n \\"Depends\\": [\\n {\\n \\"Condition\\": \\"\\\\\\"\\\\\\"\\",\\n \\"Dependency\\": \\"\\\\\\"\\\\\\"\\",\\n \\"Description\\": \\"\\\\\\"\\\\\\"\\"\\n }\\n ],\\n \\"UsageParameters\\": [\\n {\\n \\"Name\\": \\"\\\\\\"\\\\\\"\\",\\n \\"Required\\": \\"\\\\\\"\\\\\\"\\"\\n }\\n ]\\n },\\n \\"VersionId\\": 101,\\n \\"VersionName\\": \\"v1\\"\\n },\\n \\"Latency\\": 123\\n}","type":"json"}]', 'title' => '获取当前版本', 'requestParamsDescription' => '### 示例'."\n" .'`GET /v4/openapi/functions/ctr/current-version?modelType=_checkpoint&functionType=PAAS&domain=ecommerce&category=general`', 'responseParamsDescription' => '### 正常返回示例（热词模型）'."\n" .'```'."\n" .'{'."\n" .' "status": "OK",'."\n" .' "requestId": "165890826219877085621759",'."\n" .' "latency": 0.049,'."\n" .' "httpCode": 200,'."\n" .' "code": "",'."\n" .' "message": "",'."\n" .' "result": {'."\n" .' "versionId": 37,'."\n" .' "versionName": "v2",'."\n" .' "description": "",'."\n" .' "status": "available",'."\n" .' "functionName": "hot",'."\n" .' "modelType": "offline_inference",'."\n" .' "functionType": "PAAS",'."\n" .' "versionConfig": {'."\n" .' "createParameters": ['."\n" .' {'."\n" .' "name": "filter",'."\n" .' "required": "false",'."\n" .' "validations": "[{\\"preprocess\\": {\\"pattern\\": \\"(\\\\\\\\w+)\\\\\\\\s*(>=|<=|>|<|=|!=)\\\\\\\\s*(\\\\\\\\w+)\\", \\"type\\": \\"regex\\", \\"group\\": 1}, \\"params\\": {\\"data\\": [\\"user_id\\", \\"biz_type\\"], \\"type\\": \\"trival\\"}, \\"class\\": \\"EnumerateRule\\"}]",'."\n" .' "value": "{\\"component\\":\\"Input\\",\\"attributes\\":{\\"defaultValue\\":\\"\\",\\"dataSource\\":\\"\\"}}",'."\n" .' "valueSplit": ","'."\n" .' }'."\n" .' ],'."\n" .' "usageParameters": ['."\n" .' {'."\n" .' "name": "allow_dict_id",'."\n" .' "required": "false",'."\n" .' "validations": "[{\\"params\\": {\\"restrictions\\": \\"type=hot_allowlist\\", \\"type\\": \\"passthrough\\", \\"dataSource\\": \\"dicts\\"}, \\"class\\": \\"EnumerateRule\\"}]",'."\n" .' "value": "{\\"component\\":\\"Select\\",\\"attributes\\":{\\"defaultValue\\":\\"\\",\\"dataSource\\":\\"\\"}}"'."\n" .' },'."\n" .' {'."\n" .' "name": "deny_dict_id",'."\n" .' "required": "false",'."\n" .' "validations": "[{\\"params\\": {\\"restrictions\\": \\"type=hot_denylist\\", \\"type\\": \\"passthrough\\", \\"dataSource\\": \\"dicts\\"}, \\"class\\": \\"EnumerateRule\\"}]",'."\n" .' "value": "{\\"component\\":\\"Select\\",\\"attributes\\":{\\"defaultValue\\":\\"\\",\\"dataSource\\":\\"\\"}}"'."\n" .' }'."\n" .' ],'."\n" .' "depends": ['."\n" .' {'."\n" .' "condition": "integrity_level >= 1",'."\n" .' "dependency": "integrity_level",'."\n" .' "description": "数据完整度至少为L1级"'."\n" .' }'."\n" .' ],'."\n" .' "deployment": "",'."\n" .' "dagTemplate": "opensearch_hot_train"'."\n" .' }'."\n" .' }'."\n" .'}'."\n" .'```', ], 'GetFunctionVersion' => [ 'summary' => '根据版本ID获取版本信息。', 'path' => '/v4/openapi/functions/{functionName}/versions/{versionId}', 'methods' => [ 'get', ], 'schemes' => [ 'http', 'https', ], 'security' => [ [ 'AK' => [], ], ], 'produces' => [ 'application/json', ], 'operationType' => 'read', 'deprecated' => false, 'systemTags' => [ 'operationType' => 'get', ], 'parameters' => [ [ 'name' => 'functionName', 'in' => 'path', 'schema' => [ 'description' => '功能名称', 'type' => 'string', 'required' => true, 'example' => 'ctr', ], ], [ 'name' => 'versionId', 'in' => 'path', 'schema' => [ 'description' => '版本id', 'type' => 'integer', 'format' => 'int32', 'required' => true, 'example' => '100', ], ], ], 'responses' => [ 200 => [ 'schema' => [ 'description' => '响应体', 'type' => 'object', 'properties' => [ 'Status' => [ 'description' => '请求状态', 'type' => 'string', 'example' => 'OK', ], 'HttpCode' => [ 'description' => 'http状态码', 'type' => 'integer', 'format' => 'int64', 'example' => '200', ], 'RequestId' => [ 'description' => '请求id', 'type' => 'string', 'example' => '1638157479281', ], 'Message' => [ 'description' => '错误信息', 'type' => 'string', 'example' => 'version not exist.', ], 'Code' => [ 'description' => '错误码', 'type' => 'string', 'example' => 'Version.NotExist', ], 'Result' => [ 'description' => '结果体', 'type' => 'object', 'properties' => [ 'FunctionName' => [ 'description' => '功能名称', 'type' => 'string', 'example' => 'ctr', ], 'FunctionType' => [ 'description' => '功能类型'."\n" ."\n" .'- PAAS'."\n" .'- SAAS', 'type' => 'string', 'example' => 'PAAS', ], 'ModelType' => [ 'description' => '模型类型', 'type' => 'string', 'example' => 'tf_checkpoint', ], 'VersionConfig' => [ 'description' => '配置信息', 'type' => 'object', 'properties' => [ 'CreateParameters' => [ 'description' => '创建实例时使用的参数列表', 'type' => 'array', 'items' => [ 'description' => '参数体', 'type' => 'object', 'properties' => [ 'Name' => [ 'description' => 'Name', 'type' => 'string', 'example' => 'params1', ], 'Required' => [ 'description' => 'Required', 'type' => 'string', 'example' => 'true', ], ], 'example' => '{}', ], 'example' => '[ { "name": "params1", "required": "true", "formItemProps": "{\\"required\\": true, \\"pattern?\\": \\"/^[a-zA-Z][a-zA-Z0-9_]{0,29}$/\\"}", "componentProps": "{\\"component\\": \\"Input\\", \\"attributes\\": {\\"defaultValue\\": \\"value1\\"}}" } ]', ], 'Depends' => [ 'description' => '实例的依赖项列表', 'type' => 'array', 'items' => [ 'description' => '参数体', 'type' => 'object', 'properties' => [ 'Condition' => [ 'description' => '条件', 'type' => 'string', 'example' => '""', ], 'Dependency' => [ 'description' => '依赖项', 'type' => 'string', 'example' => '""', ], 'Description' => [ 'description' => '描述', 'type' => 'string', 'example' => '""', ], ], 'example' => '{}', ], 'example' => '[ { "dependency": "依赖项", "condition": "条件", "description": "" } ]', ], 'UsageParameters' => [ 'description' => '实例在线使用过程中的参数列表', 'type' => 'array', 'items' => [ 'description' => '参数体', 'type' => 'object', 'properties' => [ 'Name' => [ 'description' => 'Name', 'type' => 'string', 'example' => '""', ], 'Required' => [ 'description' => 'Required', 'type' => 'string', 'example' => '""', ], ], 'example' => '{}', ], 'example' => '[]', ], ], 'example' => '{ "createParameters": [ { "name": "params1", "required": "true", "formItemProps": "{\\"required\\": true, \\"pattern?\\": \\"/^[a-zA-Z][a-zA-Z0-9_]{0,29}$/\\"}", "componentProps": "{\\"component\\": \\"Input\\", \\"attributes\\": {\\"defaultValue\\": \\"value1\\"}}" } ], "depends": [ { "dependency": "依赖项", "condition": "条件", "description": "" } ], "usageParameters": [] }', ], 'VersionId' => [ 'description' => '版本ID', 'type' => 'integer', 'format' => 'int64', 'example' => '101', ], 'VersionName' => [ 'description' => '版本名称', 'type' => 'string', 'example' => 'v1', ], ], 'example' => '[]', ], 'Latency' => [ 'description' => '任务最大运行时间', 'type' => 'integer', 'format' => 'int64', 'example' => '123', ], ], 'example' => '{}', ], ], ], 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"Status\\": \\"OK\\",\\n \\"HttpCode\\": 200,\\n \\"RequestId\\": \\"1638157479281\\",\\n \\"Message\\": \\"version not exist.\\",\\n \\"Code\\": \\"Version.NotExist\\",\\n \\"Result\\": {\\n \\"FunctionName\\": \\"ctr\\",\\n \\"FunctionType\\": \\"PAAS\\",\\n \\"ModelType\\": \\"tf_checkpoint\\",\\n \\"VersionConfig\\": {\\n \\"CreateParameters\\": [\\n {\\n \\"Name\\": \\"params1\\",\\n \\"Required\\": \\"true\\"\\n }\\n ],\\n \\"Depends\\": [\\n {\\n \\"Condition\\": \\"\\\\\\"\\\\\\"\\",\\n \\"Dependency\\": \\"\\\\\\"\\\\\\"\\",\\n \\"Description\\": \\"\\\\\\"\\\\\\"\\"\\n }\\n ],\\n \\"UsageParameters\\": [\\n {\\n \\"Name\\": \\"\\\\\\"\\\\\\"\\",\\n \\"Required\\": \\"\\\\\\"\\\\\\"\\"\\n }\\n ]\\n },\\n \\"VersionId\\": 101,\\n \\"VersionName\\": \\"v1\\"\\n },\\n \\"Latency\\": 123\\n}","type":"json"}]', 'title' => '获取版本详情', 'requestParamsDescription' => '### 示例'."\n" .'`GET /v4/openapi/functions/ctr/version/101`', 'responseParamsDescription' => '### 正常返回示例'."\n" .'```'."\n" .'{'."\n" .' "status": "OK",'."\n" .' "requestId": "",'."\n" .' "httpCode": 200,'."\n" .' "code": "",'."\n" .' "message": "",'."\n" .' "latency": 123,'."\n" .' "result": {'."\n" .' "versionName": "v1",'."\n" .' "versionId": 101,'."\n" .' "functionName": "ctr",'."\n" .' "modelType": "tf_checkpoint",'."\n" .' "functionType": "PAAS",'."\n" .' "versionConfig": {'."\n" .' "createParameters": ['."\n" .' {'."\n" .' "name": "params1",'."\n" .' "required": "true",'."\n" .' "formItemProps": "{\\"required\\": true, \\"pattern?\\": \\"/^[a-zA-Z][a-zA-Z0-9_]{0,29}$/\\"}",'."\n" .' "componentProps": "{\\"component\\": \\"Input\\", \\"attributes\\": {\\"defaultValue\\": \\"value1\\"}}"'."\n" .' }'."\n" .' ],'."\n" .' "depends": ['."\n" .' {'."\n" .' "dependency": "依赖项",'."\n" .' "condition": "条件",'."\n" .' "description": ""'."\n" .' }'."\n" .' ],'."\n" .' "usageParameters": []'."\n" .' }'."\n" .' }'."\n" .'}'."\n" .'```', ], 'GetFunctionDefaultInstance' => [ 'summary' => '获取app默认使用的算法实例。', 'path' => '/v4/openapi/app-groups/{appGroupIdentity}/functions/{functionName}/default-instance', 'methods' => [ 'get', ], 'schemes' => [ 'http', 'https', ], 'security' => [ [ 'AK' => [], ], ], 'produces' => [ 'application/json', ], 'operationType' => 'read', 'deprecated' => false, 'systemTags' => [ 'operationType' => 'get', 'riskType' => 'none', 'chargeType' => 'free', 'abilityTreeNodes' => [ 'FEATUREopensearchZAE4HR', ], ], 'parameters' => [ [ 'name' => 'appGroupIdentity', 'in' => 'path', 'schema' => [ 'description' => '应用名称', 'type' => 'string', 'required' => true, 'example' => 'my_app_group_name', ], ], [ 'name' => 'functionName', 'in' => 'path', 'schema' => [ 'description' => '功能名称', 'type' => 'string', 'required' => true, 'example' => 'ctr', ], ], ], 'responses' => [ 200 => [ 'schema' => [ 'description' => '响应体', 'type' => 'object', 'properties' => [ 'Status' => [ 'description' => '请求状态', 'type' => 'string', 'example' => 'OK', ], 'HttpCode' => [ 'description' => 'http状态码', 'type' => 'integer', 'format' => 'int64', 'example' => '200', ], 'RequestId' => [ 'description' => '请求id', 'type' => 'string', 'example' => '062BA91F-A568-5779-8A5B-9E62C9BB3DC1', ], 'Message' => [ 'description' => '返回的错误信息', 'type' => 'string', 'example' => 'default instance not set.', ], 'Code' => [ 'description' => '返回的状态码', 'type' => 'string', 'example' => 'DefaultInstance.NotExist', ], 'Result' => [ 'description' => '结果', 'type' => 'object', 'properties' => [ 'InstanceName' => [ 'description' => '默认实例名称', 'type' => 'string', 'example' => 'model1', ], ], 'example' => '{\'Pagination\': {\'TotalCount\': 0, \'PageNumber\': 1, \'PageSize\': 10}, \'AntConsortiums\': []}', ], 'Latency' => [ 'description' => '默认运行时间', 'type' => 'integer', 'format' => 'int64', 'example' => '123', ], 'InstanceName' => [ 'title' => '实例名称', 'description' => '实例名称', 'type' => 'string', 'example' => 'sh-bp1oi31w1jn4ctdyv', 'readOnly' => false, ], 'FunctionName' => [ 'title' => '功能名称', 'description' => '功能名称', 'type' => 'string', 'example' => 'cdn_waf', 'readOnly' => true, ], ], ], ], ], 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"Status\\": \\"OK\\",\\n \\"HttpCode\\": 200,\\n \\"RequestId\\": \\"062BA91F-A568-5779-8A5B-9E62C9BB3DC1\\",\\n \\"Message\\": \\"default instance not set.\\",\\n \\"Code\\": \\"DefaultInstance.NotExist\\",\\n \\"Result\\": {\\n \\"InstanceName\\": \\"model1\\"\\n },\\n \\"Latency\\": 123,\\n \\"InstanceName\\": \\"sh-bp1oi31w1jn4ctdyv\\",\\n \\"FunctionName\\": \\"cdn_waf\\"\\n}","type":"json"}]', 'title' => '获取默认实例', 'requestParamsDescription' => '### 示例'."\n" .'`GET /v4/openapi/app-groups/my-app/functions/pop/default-instances`', 'responseParamsDescription' => '### 正常返回示例'."\n" .'```'."\n" .'{'."\n" .' "status": "OK",'."\n" .' "requestId": "",'."\n" .' "httpCode": 200,'."\n" .' "code": "",'."\n" .' "message": "",'."\n" .' "latency": 123,'."\n" .' "result": {'."\n" .' "instanceName": "pop_test"'."\n" .' }'."\n" .'}'."\n" .'```', ], 'UpdateFunctionDefaultInstance' => [ 'summary' => '为指定app设置默认使用的算法实例，自动覆盖上一次设置的默认实例'."\n" .'空表示取消默认实例。', 'path' => '/v4/openapi/app-groups/{appGroupIdentity}/functions/{functionName}/default-instance', 'methods' => [ 'put', ], 'schemes' => [ 'http', 'https', ], 'security' => [ [ 'AK' => [], ], ], 'consumes' => [ 'application/json', ], 'produces' => [ 'application/json', ], 'operationType' => 'write', 'deprecated' => false, 'systemTags' => [ 'operationType' => 'update', 'riskType' => 'none', 'chargeType' => 'free', 'abilityTreeNodes' => [ 'FEATUREopensearchZAE4HR', ], ], 'parameters' => [ [ 'name' => 'Body', 'in' => 'body', 'style' => 'json', 'schema' => [ 'title' => 'body参数', 'description' => 'body参数', 'type' => 'object', 'properties' => [ 'instanceName' => [ 'title' => '实例名称', 'description' => '实例名称', 'type' => 'string', 'required' => false, 'example' => '"pop_test"', ], ], 'required' => false, 'docRequired' => true, 'example' => '{}', ], ], [ 'name' => 'appGroupIdentity', 'in' => 'path', 'schema' => [ 'description' => '应用名称', 'type' => 'string', 'required' => true, 'example' => '"app_group_name"', ], ], [ 'name' => 'functionName', 'in' => 'path', 'schema' => [ 'description' => '功能名称', 'type' => 'string', 'required' => true, 'example' => 'pop', ], ], ], 'responses' => [ 200 => [ 'schema' => [ 'description' => 'response', 'type' => 'object', 'properties' => [ 'Status' => [ 'description' => '请求状态', 'type' => 'string', 'example' => 'OK', ], 'HttpCode' => [ 'description' => 'http状态码', 'type' => 'integer', 'format' => 'int64', 'example' => '200', ], 'RequestId' => [ 'description' => '请求id', 'type' => 'string', 'example' => 'A4D487A9-A456-5AA5-A9C6-B7BF2889CF74', ], 'Message' => [ 'description' => '错误信息', 'type' => 'string', 'example' => 'success', ], 'Code' => [ 'description' => '错误码', 'type' => 'string', 'example' => 'DefaultInstance.SetFail', ], 'Latency' => [ 'description' => '请求耗时（单位毫秒）', 'type' => 'integer', 'format' => 'int64', 'example' => '123', ], ], ], ], ], 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"Status\\": \\"OK\\",\\n \\"HttpCode\\": 200,\\n \\"RequestId\\": \\"A4D487A9-A456-5AA5-A9C6-B7BF2889CF74\\",\\n \\"Message\\": \\"success\\",\\n \\"Code\\": \\"DefaultInstance.SetFail\\",\\n \\"Latency\\": 123\\n}","type":"json"}]', 'title' => '设置默认实例', ], 'ListFunctionTasks' => [ 'summary' => '获取训练记录。返回结果按开始时间降序排序。', 'path' => '/v4/openapi/app-groups/{appGroupIdentity}/functions/{functionName}/instances/{instanceName}/tasks', 'methods' => [ 'get', ], 'schemes' => [ 'http', 'https', ], 'security' => [ [ 'AK' => [], ], ], 'produces' => [ 'application/json', ], 'operationType' => 'read', 'deprecated' => false, 'systemTags' => [ 'operationType' => 'get', ], 'parameters' => [ [ 'name' => 'appGroupIdentity', 'in' => 'path', 'schema' => [ 'description' => '应用名称', 'type' => 'string', 'required' => true, 'example' => 'app_group_name', ], ], [ 'name' => 'functionName', 'in' => 'path', 'schema' => [ 'description' => '功能名称', 'type' => 'string', 'required' => true, 'example' => 'ctr', ], ], [ 'name' => 'instanceName', 'in' => 'path', 'schema' => [ 'description' => '实例名称', 'type' => 'string', 'required' => true, 'example' => 'test_model_2', ], ], [ 'name' => 'status', 'in' => 'query', 'schema' => [ 'description' => '任务状态：'."\n" ."\n" .'- success'."\n" .'- failed'."\n" .'- running', 'type' => 'string', 'required' => false, 'example' => 'success', ], ], [ 'name' => 'startTime', 'in' => 'query', 'schema' => [ 'description' => '起始时间大于设定时间，单位毫秒', 'type' => 'integer', 'format' => 'int64', 'required' => false, 'example' => '1582214400', ], ], [ 'name' => 'endTime', 'in' => 'query', 'schema' => [ 'description' => '结束时间小于设定时间，单位毫秒', 'type' => 'integer', 'format' => 'int64', 'required' => false, 'example' => '1582646399', ], ], [ 'name' => 'pageNumber', 'in' => 'query', 'schema' => [ 'description' => '页码（默认为1）', 'type' => 'integer', 'format' => 'int32', 'required' => false, 'example' => '1', ], ], [ 'name' => 'pageSize', 'in' => 'query', 'schema' => [ 'description' => '每页大小（默认为1）', 'type' => 'integer', 'format' => 'int32', 'required' => false, 'example' => '10', ], ], ], 'responses' => [ 200 => [ 'schema' => [ 'description' => '响应体', 'type' => 'object', 'properties' => [ 'Status' => [ 'description' => '状态码', 'type' => 'string', 'example' => '200', ], 'HttpCode' => [ 'description' => 'HTTP状态码。', 'type' => 'integer', 'format' => 'int64', 'example' => '200', ], 'TotalCount' => [ 'description' => '符合要求的总记录数', 'type' => 'integer', 'format' => 'int64', 'example' => '2', ], 'RequestId' => [ 'description' => '请求id', 'type' => 'string', 'example' => '1638157479281', ], 'Message' => [ 'description' => '请求返回信息', 'type' => 'string', 'example' => 'fail', ], 'Code' => [ 'description' => 'HTTP状态码', 'type' => 'string', 'example' => '200', ], 'Result' => [ 'description' => '返回结果。', 'type' => 'array', 'items' => [ 'description' => '结果体', 'type' => 'object', 'properties' => [ 'EndTime' => [ 'description' => '结束时间，单位毫秒，0表示未结束', 'type' => 'integer', 'format' => 'int64', 'example' => '100010', ], 'ExtendInfo' => [ 'description' => 'json string，包含模型评价信息、训练错误信息等。', 'type' => 'string', 'example' => '{\\"recall\\":91,\\"errors\\":[]}', ], 'FunctionName' => [ 'description' => '功能名称', 'type' => 'string', 'example' => 'ctr', ], 'Progress' => [ 'description' => '进度，90表示90%', 'type' => 'integer', 'format' => 'int64', 'example' => '90', ], 'RunId' => [ 'description' => '任务ID', 'type' => 'string', 'example' => 'trigger__2021-03-05T12:18:41', ], 'StartTime' => [ 'description' => '起始时间，单位毫秒', 'type' => 'integer', 'format' => 'int64', 'example' => '100010', ], 'Status' => [ 'description' => '任务状态'."\n" ."\n" .'- success'."\n" .'- failed'."\n" .'- running', 'type' => 'string', 'example' => 'success', ], 'Generation' => [ 'description' => '第几次迭代', 'type' => 'string', 'example' => '2', ], ], 'example' => '{ "functionName": "ctr", "progress": 100, "status": "success", "startTime": 100010, "endTime": 200020, "extendInfo": "{\\"recall\\":91,\\"errors\\":[]}", "runId": "trigger__2021-03-05T12:18:41" }', ], 'example' => '[ { "functionName": "ctr", "progress": 100, "status": "success", "startTime": 100010, "endTime": 200020, "extendInfo": "{\\"recall\\":91,\\"errors\\":[]}", "runId": "trigger__2021-03-05T12:18:41" } ]', ], 'Latency' => [ 'description' => '请求耗时（单位毫秒）', 'type' => 'integer', 'format' => 'int64', 'example' => '123', ], ], 'example' => '{ "status": "OK", "requestId": "", "httpCode": 200, "code": "", "message": "", "latency": 123, "totalCount": 1, "result": [ { "functionName": "ctr", "progress": 100, "status": "success", "startTime": 100010, "endTime": 200020, "extendInfo": "{\\"recall\\":91,\\"errors\\":[]}", "runId": "trigger__2021-03-05T12:18:41" } ] }', ], ], ], 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"Status\\": \\"200\\",\\n \\"HttpCode\\": 200,\\n \\"TotalCount\\": 2,\\n \\"RequestId\\": \\"1638157479281\\",\\n \\"Message\\": \\"fail\\",\\n \\"Code\\": \\"200\\",\\n \\"Result\\": [\\n {\\n \\"EndTime\\": 100010,\\n \\"ExtendInfo\\": \\"{\\\\\\\\\\\\\\"recall\\\\\\\\\\\\\\":91,\\\\\\\\\\\\\\"errors\\\\\\\\\\\\\\":[]}\\",\\n \\"FunctionName\\": \\"ctr\\",\\n \\"Progress\\": 90,\\n \\"RunId\\": \\"trigger__2021-03-05T12:18:41\\",\\n \\"StartTime\\": 100010,\\n \\"Status\\": \\"success\\",\\n \\"Generation\\": \\"2\\"\\n }\\n ],\\n \\"Latency\\": 123\\n}","type":"json"}]', 'title' => '获取训练记录', 'requestParamsDescription' => '### 示例'."\n" .'`GET /v4/openapi/app-groups/my-app/functions/ctr/instances/ctr_test/tasks`', 'responseParamsDescription' => '### 正常返回示例'."\n" .'```'."\n" .'{'."\n" .' "status": "OK",'."\n" .' "requestId": "",'."\n" .' "httpCode": 200,'."\n" .' "code": "",'."\n" .' "message": "",'."\n" .' "latency": 123,'."\n" .' "totalCount": 1,'."\n" .' "result": ['."\n" .' {'."\n" .' "functionName": "ctr",'."\n" .' "progress": 100,'."\n" .' "status": "success",'."\n" .' "startTime": 100010,'."\n" .' "endTime": 200020,'."\n" .' "extendInfo": "{\\"recall\\":91,\\"errors\\":[]}",'."\n" .' "runId": "trigger__2021-03-05T12:18:41",'."\n" .' "generation": "3"'."\n" .' }'."\n" .' ]'."\n" .'}'."\n" .'```'."\n", ], 'GetFunctionTask' => [ 'summary' => '获取训练详情。', 'path' => '/v4/openapi/app-groups/{appGroupIdentity}/functions/{functionName}/instances/{instanceName}/tasks/{generation}', 'methods' => [ 'get', ], 'schemes' => [ 'http', 'https', ], 'security' => [ [ 'AK' => [], ], ], 'produces' => [ 'application/json', ], 'operationType' => 'read', 'deprecated' => false, 'systemTags' => [ 'operationType' => 'get', ], 'parameters' => [ [ 'name' => 'appGroupIdentity', 'in' => 'path', 'schema' => [ 'title' => '应用名称', 'description' => '应用名称', 'type' => 'string', 'required' => true, 'example' => 'my_app_group_name', ], ], [ 'name' => 'functionName', 'in' => 'path', 'schema' => [ 'title' => '功能名称', 'description' => '功能名称', 'type' => 'string', 'required' => true, 'example' => 'ctr', ], ], [ 'name' => 'instanceName', 'in' => 'path', 'schema' => [ 'title' => '实例名称', 'description' => '实例名称', 'type' => 'string', 'required' => true, 'example' => 'test_model_2', ], ], [ 'name' => 'generation', 'in' => 'path', 'schema' => [ 'title' => '迭代次数', 'description' => '迭代次数', 'type' => 'string', 'required' => true, 'example' => '1', ], ], ], 'responses' => [ 200 => [ 'schema' => [ 'description' => 'Schema of Response', 'type' => 'object', 'properties' => [ 'Status' => [ 'description' => '请求状态', 'type' => 'string', 'example' => 'OK', ], 'HttpCode' => [ 'description' => 'HTTP状态码', 'type' => 'integer', 'format' => 'int64', 'example' => '200', ], 'RequestId' => [ 'description' => '请求ID', 'type' => 'string', 'example' => 'A4D487A9-A456-5AA5-A9C6-B7BF2889CF74', ], 'Message' => [ 'description' => '返回的错误信息', 'type' => 'string', 'example' => 'operation success', ], 'Code' => [ 'description' => '返回的错误码', 'type' => 'string', 'example' => 'Task.NotExist', ], 'Result' => [ 'description' => '返回结果', 'type' => 'object', 'properties' => [ 'EndTime' => [ 'description' => '任务结束时间（单位ms）', 'type' => 'integer', 'format' => 'int64', 'example' => '1647213406267', ], 'ExtendInfo' => [ 'description' => '扩展信息（json string）', 'type' => 'string', 'example' => '{\\"recall\\":91,\\"errors\\":[]}', ], 'FunctionName' => [ 'description' => '功能名称', 'type' => 'string', 'example' => 'ctr', ], 'Generation' => [ 'description' => '迭代次数', 'type' => 'string', 'example' => '1', ], 'Progress' => [ 'description' => '进度，90表示90%', 'type' => 'integer', 'format' => 'int64', 'example' => '90', ], 'RunId' => [ 'description' => '任务ID', 'type' => 'string', 'example' => 'trigger__2021-03-05T12:18:41', ], 'StartTime' => [ 'description' => '任务开始时间（单位ms）', 'type' => 'integer', 'format' => 'int64', 'example' => '1647212220000', ], 'Status' => [ 'description' => '任务状态'."\n" ."\n" .'- success'."\n" .'- failed'."\n" .'- running', 'type' => 'string', 'example' => 'success', ], ], ], 'Latency' => [ 'description' => '请求耗时（单位ms）', 'type' => 'integer', 'format' => 'int64', 'example' => '123', ], ], ], ], ], 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"Status\\": \\"OK\\",\\n \\"HttpCode\\": 200,\\n \\"RequestId\\": \\"A4D487A9-A456-5AA5-A9C6-B7BF2889CF74\\",\\n \\"Message\\": \\"operation success\\",\\n \\"Code\\": \\"Task.NotExist\\",\\n \\"Result\\": {\\n \\"EndTime\\": 1647213406267,\\n \\"ExtendInfo\\": \\"{\\\\\\\\\\\\\\"recall\\\\\\\\\\\\\\":91,\\\\\\\\\\\\\\"errors\\\\\\\\\\\\\\":[]}\\",\\n \\"FunctionName\\": \\"ctr\\",\\n \\"Generation\\": \\"1\\",\\n \\"Progress\\": 90,\\n \\"RunId\\": \\"trigger__2021-03-05T12:18:41\\",\\n \\"StartTime\\": 1647212220000,\\n \\"Status\\": \\"success\\"\\n },\\n \\"Latency\\": 123\\n}","type":"json"}]', 'title' => '获取训练详情', 'requestParamsDescription' => '### 示例'."\n" .'`GET /v4/openapi/app-groups/my-app/functions/ctr/instances/ctr_test/tasks/3`', 'responseParamsDescription' => '### 正常返回示例'."\n" .'```'."\n" .'{'."\n" .' "status": "OK",'."\n" .' "requestId": "",'."\n" .' "httpCode": 200,'."\n" .' "code": "",'."\n" .' "message": "",'."\n" .' "latency": 123,'."\n" .' "result": {'."\n" .' "functionName": "ctr",'."\n" .' "progress": 100,'."\n" .' "status": "success",'."\n" .' "startTime": 100010,'."\n" .' "endTime": 200020,'."\n" .' "extendInfo": "{\\"recall\\":91,\\"errors\\":[]}",'."\n" .' "runId": "trigger__2021-03-05T12:18:41",'."\n" .' "generation": "3"'."\n" .' }'."\n" .'}'."\n" .'```', ], 'DeleteFunctionTask' => [ 'summary' => '删除训练记录。正在训练中的记录无法删除。', 'path' => '/v4/openapi/app-groups/{appGroupIdentity}/functions/{functionName}/instances/{instanceName}/tasks/{generation}', 'methods' => [ 'delete', ], 'schemes' => [ 'http', 'https', ], 'security' => [ [ 'AK' => [], ], ], 'operationType' => 'write', 'deprecated' => false, 'systemTags' => [ 'operationType' => 'delete', ], 'parameters' => [ [ 'name' => 'appGroupIdentity', 'in' => 'path', 'schema' => [ 'title' => '应用名称', 'description' => '应用名称', 'type' => 'string', 'required' => true, 'example' => 'my_app_group_name', ], ], [ 'name' => 'functionName', 'in' => 'path', 'schema' => [ 'title' => '功能名称', 'description' => '功能名称', 'type' => 'string', 'required' => true, 'example' => 'ctr', ], ], [ 'name' => 'instanceName', 'in' => 'path', 'schema' => [ 'title' => '实例名称', 'description' => '实例名称', 'type' => 'string', 'required' => true, 'example' => 'ctr_test', ], ], [ 'name' => 'generation', 'in' => 'path', 'schema' => [ 'title' => '迭代次数', 'description' => '迭代次数', 'type' => 'string', 'required' => true, 'example' => '1', ], ], ], 'responses' => [ 200 => [ 'schema' => [ 'description' => 'Schema of Response', 'type' => 'object', 'properties' => [ 'Status' => [ 'description' => '请求状态', 'type' => 'string', 'example' => 'OK', ], 'HttpCode' => [ 'description' => 'HTTP响应码', 'type' => 'integer', 'format' => 'int64', 'example' => '200', ], 'RequestId' => [ 'description' => '请求id', 'type' => 'string', 'example' => '"1081EB05-473C-5BF4-95BE-6D7CAD5E2213"', ], 'Message' => [ 'description' => '错误信息', 'type' => 'string', 'example' => 'operation success', ], 'Code' => [ 'description' => '返回的错误码（没有错误为空）', 'type' => 'string', 'example' => 'Task.UnableDelete', ], 'Latency' => [ 'description' => 'api请求耗时（单位：毫秒）', 'type' => 'integer', 'format' => 'int64', 'example' => '123', ], ], ], ], ], 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"Status\\": \\"OK\\",\\n \\"HttpCode\\": 200,\\n \\"RequestId\\": \\"\\\\\\"1081EB05-473C-5BF4-95BE-6D7CAD5E2213\\\\\\"\\",\\n \\"Message\\": \\"operation success\\",\\n \\"Code\\": \\"Task.UnableDelete\\",\\n \\"Latency\\": 123\\n}","type":"json"}]', 'title' => '删除训练记录', 'responseParamsDescription' => '### 正确返回示例'."\n" .'```'."\n" .'{'."\n" .' "status": "OK",'."\n" .' "requestId": "",'."\n" .' "httpCode": 200,'."\n" .' "code": "",'."\n" .' "message": "",'."\n" .' "latency": 123,'."\n" .' "result": {}'."\n" .'}'."\n" .'```', ], 'CreateFunctionTask' => [ 'summary' => '启动一个训练任务。', 'path' => '/v4/openapi/app-groups/{appGroupIdentity}/functions/{functionName}/instances/{instanceName}/tasks', 'methods' => [ 'post', ], 'schemes' => [ 'http', 'https', ], 'security' => [ [ 'AK' => [], ], ], 'produces' => [ 'application/json', ], 'operationType' => 'write', 'deprecated' => false, 'systemTags' => [ 'operationType' => 'create', ], 'parameters' => [ [ 'name' => 'appGroupIdentity', 'in' => 'path', 'schema' => [ 'description' => '应用名称', 'type' => 'string', 'required' => true, 'example' => 'app_group_name', ], ], [ 'name' => 'functionName', 'in' => 'path', 'schema' => [ 'description' => '功能名称', 'type' => 'string', 'required' => true, 'example' => 'ctr', ], ], [ 'name' => 'instanceName', 'in' => 'path', 'schema' => [ 'description' => '实例名称', 'type' => 'string', 'required' => true, 'example' => 'ctr_test', ], ], ], 'responses' => [ 200 => [ 'schema' => [ 'description' => '响应体', 'type' => 'object', 'properties' => [ 'Status' => [ 'description' => '请求状态', 'type' => 'string', 'example' => 'OK', ], 'HttpCode' => [ 'description' => 'http状态码', 'type' => 'integer', 'format' => 'int64', 'example' => '200', ], 'RequestId' => [ 'description' => '请求id', 'type' => 'string', 'example' => '1638157990724', ], 'Message' => [ 'description' => '错误信息', 'type' => 'string', 'example' => 'success', ], 'Code' => [ 'description' => '错误码', 'type' => 'string', 'example' => 'Task.IsRunning', ], 'Latency' => [ 'description' => '请求耗时（单位ms）', 'type' => 'integer', 'format' => 'int64', 'example' => '123', ], ], 'example' => '{ "status" : "OK", "requestId" : "", "httpCode": 200, "code": "", "message": "", "latency" : 123, "result" : {}, }', ], ], ], 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"Status\\": \\"OK\\",\\n \\"HttpCode\\": 200,\\n \\"RequestId\\": \\"1638157990724\\",\\n \\"Message\\": \\"success\\",\\n \\"Code\\": \\"Task.IsRunning\\",\\n \\"Latency\\": 123\\n}","type":"json"}]', 'title' => '启动算法训练', 'requestParamsDescription' => '### 示例'."\n" .'`POST /v4/openapi/app-groups/my-app/functions/ctr/instances/ctr_test/task`', 'responseParamsDescription' => '### 正常返回示例'."\n" .'```'."\n" .'{'."\n" .' "status" : "OK",'."\n" .' "requestId" : "",'."\n" .' "httpCode": 200,'."\n" .' "code": "",'."\n" .' "message": "",'."\n" .' "latency" : 123,'."\n" .' "result" : {},'."\n" .'}'."\n" .'```', ], 'ListFunctionInstances' => [ 'summary' => '获取用户下，符合条件的所有实例。', 'path' => '/v4/openapi/app-groups/{appGroupIdentity}/functions/{functionName}/instances', 'methods' => [ 'get', ], 'schemes' => [ 'http', 'https', ], 'security' => [ [ 'AK' => [], ], ], 'produces' => [ 'application/json', ], 'operationType' => 'read', 'deprecated' => false, 'systemTags' => [ 'operationType' => 'get', 'riskType' => 'none', 'chargeType' => 'free', 'abilityTreeNodes' => [ 'FEATUREopensearch3QPM0K', 'FEATUREopensearchN8M8WS', 'FEATUREopensearchZAE4HR', ], ], 'parameters' => [ [ 'name' => 'appGroupIdentity', 'in' => 'path', 'schema' => [ 'title' => '实例名称', 'description' => '应用名称', 'type' => 'string', 'required' => true, 'example' => 'app_group_name', ], ], [ 'name' => 'functionName', 'in' => 'path', 'schema' => [ 'title' => '功能名称', 'description' => '功能名称', 'type' => 'string', 'required' => true, 'example' => 'ctr', ], ], [ 'name' => 'modelType', 'in' => 'query', 'schema' => [ 'title' => '模型类型', 'description' => '模型类型', 'type' => 'string', 'required' => false, 'example' => 'tf_checkpoint', ], ], [ 'name' => 'functionType', 'in' => 'query', 'schema' => [ 'title' => '功能类型', 'description' => '功能类型', 'type' => 'string', 'required' => false, 'example' => '"PAAS"', ], ], [ 'name' => 'source', 'in' => 'query', 'schema' => [ 'title' => '实例来源', 'description' => '实例来源'."\n" ."\n" .'- builtin 系统实例'."\n" .'- user 用户实例 （默认）'."\n" .'- all 全部实例', 'type' => 'string', 'required' => false, 'example' => 'user', ], ], [ 'name' => 'pageNumber', 'in' => 'query', 'schema' => [ 'title' => '页码', 'description' => '页码，默认值为1', 'type' => 'integer', 'format' => 'int32', 'required' => false, 'example' => '1', ], ], [ 'name' => 'pageSize', 'in' => 'query', 'schema' => [ 'title' => '每页大小', 'description' => '每页大小，默认值为10', 'type' => 'integer', 'format' => 'int32', 'required' => false, 'example' => '10', ], ], [ 'name' => 'output', 'in' => 'query', 'schema' => [ 'title' => '返回信息的丰富度', 'description' => '返回信息的丰富度'."\n" .' - normal：显示createParameters, cron等信息（默认）'."\n" .'- simple：只显示基本信息'."\n" .'- detail：返回训练任务详细信息', 'type' => 'string', 'required' => false, 'enumValueTitles' => [], 'example' => 'normal', ], ], ], 'responses' => [ 200 => [ 'schema' => [ 'description' => '响应体', 'type' => 'object', 'properties' => [ 'Status' => [ 'description' => '请求状态'."\n", 'type' => 'string', 'example' => '"OK"', ], 'HttpCode' => [ 'description' => 'http状态码', 'type' => 'integer', 'format' => 'int64', 'example' => '200', ], 'TotalCount' => [ 'description' => '总条数', 'type' => 'integer', 'format' => 'int64', 'example' => '2', ], 'RequestId' => [ 'description' => '请求id', 'type' => 'string', 'example' => 'A4D487A9-A456-5AA5-A9C6-B7BF2889CF74', ], 'Message' => [ 'description' => '错误信息，正常为空', 'type' => 'string', 'example' => 'instance not exist.', ], 'Code' => [ 'description' => '错误码，正常为空', 'type' => 'string', 'example' => 'Instance.NotExist', ], 'Result' => [ 'description' => '结果列表', 'type' => 'array', 'items' => [ 'description' => '实例信息', 'type' => 'object', 'properties' => [ 'Belongs' => [ 'description' => ' 实例归属信息', 'type' => 'object', 'properties' => [ 'Category' => [ 'description' => '垂类', 'type' => 'string', 'example' => '"general"', ], 'Domain' => [ 'description' => '行业', 'type' => 'string', 'example' => '"ecommerce"', ], 'Language' => [ 'description' => '适用的语种缩写', 'type' => 'string', 'example' => '"zh" ', ], ], 'example' => '{}', ], 'CreateParameters' => [ 'description' => '实例的参数列表', 'type' => 'array', 'items' => [ 'description' => '参数体', 'type' => 'object', 'properties' => [ 'Name' => [ 'description' => '名字', 'type' => 'string', 'example' => '"param1"', ], 'Value' => [ 'description' => '值', 'type' => 'string', 'example' => '"value1"', ], ], 'example' => '{}', ], 'example' => '[]', ], 'UsageParameters' => [ 'description' => '使用参数列表', 'type' => 'array', 'items' => [ 'description' => '参数体', 'type' => 'object', 'properties' => [ 'Name' => [ 'description' => '参数名称', 'type' => 'string', 'example' => 'use_param1', ], 'Value' => [ 'description' => '参数值', 'type' => 'string', 'example' => 'value1', ], ], ], ], 'CreateTime' => [ 'description' => '创建时间', 'type' => 'integer', 'format' => 'int64', 'example' => '1234', ], 'Cron' => [ 'description' => '训练信息，cron语法（Minutes Hours DayofMonth Month DayofWeek），为空表示不进行周期训练', 'type' => 'string', 'example' => '0 3 ? * 0,1,3,5 (周日，周一，周三，周五凌晨3点)', ], 'Description' => [ 'description' => '描述', 'type' => 'string', 'example' => '" "', ], 'ExtendInfo' => [ 'description' => '扩展信息，json string，包含模型评价信息，错误信息等', 'type' => 'string', 'example' => '"{\\"dataReport\\":{},\\"errors\\":{}}"', ], 'FunctionName' => [ 'description' => '功能名称', 'type' => 'string', 'example' => '"ctr"', ], 'FunctionType' => [ 'description' => '功能类型', 'type' => 'string', 'example' => '"PAAS"', ], 'InstanceName' => [ 'description' => '实例名称', 'type' => 'string', 'example' => '"ctr_test"', ], 'ModelType' => [ 'description' => '模型类型', 'type' => 'string', 'example' => '"tf_checkpoint"', ], 'Source' => [ 'description' => '实例来源'."\n" .'- user 用户实例'."\n" .'- builtin 内置实例', 'type' => 'string', 'example' => '"user"', ], 'Status' => [ 'description' => '实例状态'."\n" ."\n" .'1. unavailable: 暂无可用模型（需要训练）'."\n" .'2. available： 可用', 'type' => 'string', 'example' => 'available', ], 'VersionId' => [ 'description' => '版本ID', 'type' => 'integer', 'format' => 'int64', 'example' => '123', ], ], 'example' => '{}', ], 'example' => '[]', ], 'Latency' => [ 'description' => 'api请求耗时 （单位毫秒）', 'type' => 'integer', 'format' => 'int64', 'example' => '123', ], ], ], ], ], 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"Status\\": \\"\\\\\\"OK\\\\\\"\\",\\n \\"HttpCode\\": 200,\\n \\"TotalCount\\": 2,\\n \\"RequestId\\": \\"A4D487A9-A456-5AA5-A9C6-B7BF2889CF74\\",\\n \\"Message\\": \\"instance not exist.\\",\\n \\"Code\\": \\"Instance.NotExist\\",\\n \\"Result\\": [\\n {\\n \\"Belongs\\": {\\n \\"Category\\": \\"\\\\\\"general\\\\\\"\\",\\n \\"Domain\\": \\"\\\\\\"ecommerce\\\\\\"\\",\\n \\"Language\\": \\"\\\\\\"zh\\\\\\"\\\\t\\"\\n },\\n \\"CreateParameters\\": [\\n {\\n \\"Name\\": \\"\\\\\\"param1\\\\\\"\\",\\n \\"Value\\": \\"\\\\\\"value1\\\\\\"\\"\\n }\\n ],\\n \\"UsageParameters\\": [\\n {\\n \\"Name\\": \\"use_param1\\",\\n \\"Value\\": \\"value1\\"\\n }\\n ],\\n \\"CreateTime\\": 1234,\\n \\"Cron\\": \\"0 3 ? * 0,1,3,5 (周日，周一，周三，周五凌晨3点)\\",\\n \\"Description\\": \\"\\\\\\" \\\\\\"\\",\\n \\"ExtendInfo\\": \\"\\\\\\"{\\\\\\\\\\\\\\"dataReport\\\\\\\\\\\\\\":{},\\\\\\\\\\\\\\"errors\\\\\\\\\\\\\\":{}}\\\\\\"\\",\\n \\"FunctionName\\": \\"\\\\\\"ctr\\\\\\"\\",\\n \\"FunctionType\\": \\"\\\\\\"PAAS\\\\\\"\\",\\n \\"InstanceName\\": \\"\\\\\\"ctr_test\\\\\\"\\",\\n \\"ModelType\\": \\"\\\\\\"tf_checkpoint\\\\\\"\\",\\n \\"Source\\": \\"\\\\\\"user\\\\\\"\\",\\n \\"Status\\": \\"available\\",\\n \\"VersionId\\": 123\\n }\\n ],\\n \\"Latency\\": 123\\n}","type":"json"}]', 'title' => '获取实例列表', 'requestParamsDescription' => '### 示例'."\n" .'`GET /v4/openapi/app-groups/my-app/functions/ctr/instances?source=all&output=simple`', 'responseParamsDescription' => '### 正常返回结果：'."\n" .'```'."\n" .'{'."\n" .' "status": "OK",'."\n" .' "requestId": "A4D487A9-A456-5AA5-A9C6-B7BF2889CF74",'."\n" .' "httpCode": 200,'."\n" .' "code": "",'."\n" .' "message": "",'."\n" .' "latency": 123,'."\n" .' "totalCount": 2,'."\n" .' "result": ['."\n" .' {'."\n" .' "versionId": 100,'."\n" .' "instanceName": "instance_1",'."\n" .' "functionName": "hot",'."\n" .' "functionType": "PAAS",'."\n" .' "modelType": "offline_inference",'."\n" .' "description": "",'."\n" .' "status": "available",'."\n" .' "belongs": {'."\n" .' "domain": "ecommerce",'."\n" .' "category": "general",'."\n" .' "language": "zh"'."\n" .' },'."\n" .' "createTime": 100010,'."\n" .' "source": "user"'."\n" .' },'."\n" .' {'."\n" .' "versionId": 100,'."\n" .' "instanceName": "instance_2",'."\n" .' "functionName": "hot",'."\n" .' "functionType": "PAAS",'."\n" .' "modelType": "offline_inference",'."\n" .' "description": "",'."\n" .' "status": "available",'."\n" .' "belongs": {'."\n" .' "domain": "ecommerce",'."\n" .' "category": "general",'."\n" .' "language": "zh"'."\n" .' },'."\n" .' "createTime": 200020,'."\n" .' "source": "user",'."\n" .' "default": true'."\n" .' }'."\n" .' ]'."\n" .'}'."\n" .'```', ], 'GetFunctionInstance' => [ 'summary' => '根据实例名称获取实例详情。', 'path' => '/v4/openapi/app-groups/{appGroupIdentity}/functions/{functionName}/instances/{instanceName}', 'methods' => [ 'get', ], 'schemes' => [ 'http', 'https', ], 'security' => [ [ 'AK' => [], ], ], 'consumes' => [], 'produces' => [ 'application/json', ], 'operationType' => 'read', 'deprecated' => false, 'systemTags' => [ 'operationType' => 'get', 'riskType' => 'none', 'chargeType' => 'free', 'abilityTreeNodes' => [ 'FEATUREopensearch3QPM0K', 'FEATUREopensearchN8M8WS', 'FEATUREopensearchZAE4HR', ], ], 'parameters' => [ [ 'name' => 'appGroupIdentity', 'in' => 'path', 'schema' => [ 'description' => '应用名称', 'type' => 'string', 'required' => true, 'example' => '150057101', ], ], [ 'name' => 'functionName', 'in' => 'path', 'schema' => [ 'description' => '功能名称', 'type' => 'string', 'required' => true, 'example' => 'ctr', ], ], [ 'name' => 'instanceName', 'in' => 'path', 'schema' => [ 'description' => '实例名称', 'type' => 'string', 'required' => true, 'example' => 'ctr_test', ], ], [ 'name' => 'output', 'in' => 'query', 'schema' => [ 'description' => '控制返回信息的丰富度：'."\n" ."\n" .'- simple：只显示基本信息'."\n" .'- normal：显示createParameters, cron等信息（默认）'."\n" .'- detail: 返回训练任务信息', 'type' => 'string', 'required' => false, 'example' => 'detail', ], ], ], 'responses' => [ 200 => [ 'schema' => [ 'description' => '响应体', 'type' => 'object', 'properties' => [ 'Status' => [ 'description' => '请求状态', 'type' => 'string', 'example' => 'OK', ], 'HttpCode' => [ 'description' => 'http状态码', 'type' => 'integer', 'format' => 'int64', 'example' => '200', ], 'RequestId' => [ 'description' => '请求id', 'type' => 'string', 'example' => '68ED4E1B-92B8-5821-A886-9C90686139EB', ], 'Message' => [ 'description' => '返回的错误信息', 'type' => 'string', 'example' => 'instance not exist.', ], 'Code' => [ 'description' => '返回的错误码（没有错误为空）', 'type' => 'string', 'example' => 'Instance.NotExist', ], 'Result' => [ 'description' => '实例详情', 'type' => 'object', 'properties' => [ 'Belongs' => [ 'description' => '所属信息', 'type' => 'object', 'properties' => [ 'Category' => [ 'description' => '垂类', 'type' => 'string', 'example' => 'general', ], 'Domain' => [ 'description' => '行业', 'type' => 'string', 'example' => 'ecommerce', ], 'Language' => [ 'description' => '适用的语种缩写', 'type' => 'string', 'example' => 'zh（默认）', ], ], ], 'CreateParameters' => [ 'description' => '创建参数列表', 'type' => 'array', 'items' => [ 'description' => '参数体', 'type' => 'object', 'properties' => [ 'Name' => [ 'description' => '参数名称', 'type' => 'string', 'example' => 'param1', ], 'Value' => [ 'description' => '参数值', 'type' => 'string', 'example' => 'value1', ], ], ], ], 'UsageParameters' => [ 'description' => '使用参数列表', 'type' => 'array', 'items' => [ 'description' => '参数体', 'type' => 'object', 'properties' => [ 'Name' => [ 'description' => '参数名称', 'type' => 'string', 'example' => 'use_param1', ], 'Value' => [ 'description' => '参数值', 'type' => 'string', 'example' => 'value1', ], ], ], ], 'CreateTime' => [ 'description' => '创建时间 （单位毫秒）', 'type' => 'integer', 'format' => 'int64', 'example' => '1234', ], 'Cron' => [ 'description' => '训练信息，cron语法（Minutes Hours DayofMonth Month DayofWeek），为空表示不进行周期训练', 'type' => 'string', 'example' => '0 3 ? * 0,1,3,5 (周日，周一，周三，周五凌晨3点)', ], 'Description' => [ 'description' => '实例描述', 'type' => 'string', 'example' => 'instance descriptions', ], 'ExtendInfo' => [ 'description' => '扩展信息（json string）', 'type' => 'string', 'example' => '{\\"dataReport\\":{},\\"errors\\":{}}', ], 'FunctionName' => [ 'description' => '功能名称', 'type' => 'string', 'example' => 'ctr', ], 'FunctionType' => [ 'description' => '功能类型', 'type' => 'string', 'example' => 'PAAS', ], 'InstanceName' => [ 'description' => '实例名称', 'type' => 'string', 'example' => 'ctr_test', ], 'ModelType' => [ 'description' => '模型类型', 'type' => 'string', 'example' => 'tf_checkpoint', ], 'Source' => [ 'description' => '实例来源'."\n" ."\n" .'- user 用户实例'."\n" .'- builtin 内置实例', 'type' => 'string', 'example' => 'user', ], 'Status' => [ 'description' => '实例状态'."\n" ."\n" .'1. unavailable: 暂无可用模型（需要训练）'."\n" .'2. available： 可用', 'type' => 'string', 'example' => 'available', ], 'Task' => [ 'description' => '训练任务信息（没有任务则不显示）', 'type' => 'object', 'properties' => [ 'DagStatus' => [ 'description' => '任务状态'."\n" ."\n" .'- "success"：成功'."\n" .'- "failed"：失败'."\n" .'- "untrained": 待训练'."\n" .'- "pending": 调度中'."\n" .'- "running"：训练中', 'type' => 'string', 'example' => 'success', ], 'LastRunTime' => [ 'description' => '上一次运行时间，单位：毫秒', 'type' => 'integer', 'format' => 'int64', 'example' => '1234', ], ], ], 'VersionId' => [ 'description' => '版本id', 'type' => 'integer', 'format' => 'int64', 'example' => '101', ], ], 'example' => '{}', ], 'Latency' => [ 'description' => 'api请求耗时（单位：毫秒）', 'type' => 'integer', 'format' => 'int64', 'example' => '123', ], ], 'example' => '{}', ], ], ], 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"Status\\": \\"OK\\",\\n \\"HttpCode\\": 200,\\n \\"RequestId\\": \\"68ED4E1B-92B8-5821-A886-9C90686139EB\\",\\n \\"Message\\": \\"instance not exist.\\",\\n \\"Code\\": \\"Instance.NotExist\\",\\n \\"Result\\": {\\n \\"Belongs\\": {\\n \\"Category\\": \\"general\\",\\n \\"Domain\\": \\"ecommerce\\",\\n \\"Language\\": \\"zh（默认）\\"\\n },\\n \\"CreateParameters\\": [\\n {\\n \\"Name\\": \\"param1\\",\\n \\"Value\\": \\"value1\\"\\n }\\n ],\\n \\"UsageParameters\\": [\\n {\\n \\"Name\\": \\"use_param1\\",\\n \\"Value\\": \\"value1\\"\\n }\\n ],\\n \\"CreateTime\\": 1234,\\n \\"Cron\\": \\"0 3 ? * 0,1,3,5 (周日，周一，周三，周五凌晨3点)\\",\\n \\"Description\\": \\"instance descriptions\\",\\n \\"ExtendInfo\\": \\"{\\\\\\\\\\\\\\"dataReport\\\\\\\\\\\\\\":{},\\\\\\\\\\\\\\"errors\\\\\\\\\\\\\\":{}}\\",\\n \\"FunctionName\\": \\"ctr\\",\\n \\"FunctionType\\": \\"PAAS\\",\\n \\"InstanceName\\": \\"ctr_test\\",\\n \\"ModelType\\": \\"tf_checkpoint\\",\\n \\"Source\\": \\"user\\",\\n \\"Status\\": \\"available\\",\\n \\"Task\\": {\\n \\"DagStatus\\": \\"success\\",\\n \\"LastRunTime\\": 1234\\n },\\n \\"VersionId\\": 101\\n },\\n \\"Latency\\": 123\\n}","type":"json"}]', 'title' => '获取实例详情', 'requestParamsDescription' => '### 示例'."\n" .'`GET /v4/openapi/app-groups/my-app/functions/ctr/instances/ctr_test?output=detail`', 'responseParamsDescription' => '### 正常返回示例：'."\n" .'```'."\n" .'{'."\n" .' "status": "OK",'."\n" .' "requestId": "",'."\n" .' "httpCode": 200,'."\n" .' "code": "",'."\n" .' "message": "",'."\n" .' "latency": 123,'."\n" .' "result": {'."\n" .' "versionId": 100,'."\n" .' "instanceName": "ctr_test",'."\n" .' "functionName": "ctr",'."\n" .' "functionType": "PAAS",'."\n" .' "modelType": "tf_checkpoint",'."\n" .' "description": "测试",'."\n" .' "status": "available",'."\n" .' "belongs": {'."\n" .' "domain": "ecommerce",'."\n" .' "category": "general",'."\n" .' "language": "zh"'."\n" .' },'."\n" .' "createTime": 100010,'."\n" .' "createParameters": ['."\n" .' {'."\n" .' "name": "param1",'."\n" .' "value": "val1"'."\n" .' }'."\n" .' ],'."\n" .' "usageParameters": ['."\n" .' {'."\n" .' "name": "use_param1",'."\n" .' "value": "val1"'."\n" .' }'."\n" .' ],'."\n" .' "extendInfo": "{\\"error\\":{},\\"dataReport\\":{}}",'."\n" .' "cron": "",'."\n" .' "task": {'."\n" .' "dagStatus": "running",'."\n" .' "progress": 30,'."\n" .' "lastRunTime": 200020'."\n" .' }'."\n" .' }'."\n" .'}'."\n" .'```', ], 'DeleteFunctionInstance' => [ 'summary' => '删除算法实例，删除前请确保该实例不在使用中，以免影响在线服务。', 'path' => '/v4/openapi/app-groups/{appGroupIdentity}/functions/{functionName}/instances/{instanceName}', 'methods' => [ 'delete', ], 'schemes' => [ 'http', 'https', ], 'security' => [ [ 'AK' => [], ], ], 'consumes' => [], 'produces' => [ 'application/json', ], 'operationType' => 'write', 'deprecated' => false, 'systemTags' => [ 'operationType' => 'delete', 'riskType' => 'none', 'chargeType' => 'free', 'abilityTreeNodes' => [ 'FEATUREopensearch3QPM0K', 'FEATUREopensearchN8M8WS', 'FEATUREopensearchZAE4HR', ], ], 'parameters' => [ [ 'name' => 'appGroupIdentity', 'in' => 'path', 'schema' => [ 'title' => 'opensearch应用名', 'description' => 'opensearch应用名', 'type' => 'string', 'required' => true, 'example' => '“my_app_group_name”', ], ], [ 'name' => 'functionName', 'in' => 'path', 'schema' => [ 'title' => '功能名称', 'description' => '功能名称', 'type' => 'string', 'required' => true, 'example' => '"ctr"', ], ], [ 'name' => 'instanceName', 'in' => 'path', 'schema' => [ 'title' => '实例名称', 'description' => '实例名称', 'type' => 'string', 'required' => true, 'example' => '"ctr_test"', ], ], ], 'responses' => [ 200 => [ 'schema' => [ 'description' => '返回对象', 'type' => 'object', 'properties' => [ 'Status' => [ 'description' => '状态码'."\n" ."\n" .'- OK 成功'."\n" .'- FAIL 失败', 'type' => 'string', 'example' => '"OK"', ], 'HttpCode' => [ 'description' => 'HTTP响应码', 'type' => 'integer', 'format' => 'int64', 'example' => '200', ], 'RequestId' => [ 'description' => '请求id', 'type' => 'string', 'example' => '"1081EB05-473C-5BF4-95BE-6D7CAD5E2213"', ], 'Message' => [ 'description' => '错误信息，正常情况为空', 'type' => 'string', 'example' => '"instance not exist."', ], 'Code' => [ 'description' => '错误码，正常情况为空', 'type' => 'string', 'example' => '"Instance.NotExist"', ], 'Latency' => [ 'description' => '请求耗时，单位ms', 'type' => 'integer', 'format' => 'int64', 'example' => '10', ], ], 'example' => '{}', ], ], ], 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"Status\\": \\"\\\\\\"OK\\\\\\"\\",\\n \\"HttpCode\\": 200,\\n \\"RequestId\\": \\"\\\\\\"1081EB05-473C-5BF4-95BE-6D7CAD5E2213\\\\\\"\\",\\n \\"Message\\": \\"\\\\\\"instance not exist.\\\\\\"\\",\\n \\"Code\\": \\"\\\\\\"Instance.NotExist\\\\\\"\\",\\n \\"Latency\\": 10\\n}","type":"json"}]', 'title' => '删除算法实例', 'requestParamsDescription' => '### 示例'."\n" .'`DELETE /v4/openapi/app-groups/my-app/functions/ctr/instances/ctr_test`', ], 'UpdateFunctionInstance' => [ 'summary' => '根据实例名称更新实例信息。', 'path' => '/v4/openapi/app-groups/{appGroupIdentity}/functions/{functionName}/instances/{instanceName}', 'methods' => [ 'put', ], 'schemes' => [ 'http', 'https', ], 'security' => [ [ 'AK' => [], ], ], 'consumes' => [ 'application/json', ], 'produces' => [ 'application/json', ], 'operationType' => 'write', 'deprecated' => false, 'systemTags' => [ 'operationType' => 'update', 'riskType' => 'none', 'chargeType' => 'free', 'abilityTreeNodes' => [ 'FEATUREopensearch3QPM0K', 'FEATUREopensearchN8M8WS', ], ], 'parameters' => [ [ 'name' => 'Body', 'in' => 'body', 'style' => 'json', 'schema' => [ 'title' => 'body参数', 'description' => 'body参数', 'type' => 'object', 'properties' => [ 'cron' => [ 'title' => '周期训练', 'description' => '周期训练信息，cron语法（Minutes Hours DayofMonth Month DayofWeek），为空表示不进行周期训练（默认），其中DayofWeek为0表示星期日', 'type' => 'string', 'required' => false, 'example' => '"0 3 ? * 0,1,3,5"', ], 'createParameters' => [ 'title' => '创建参数', 'description' => '创建参数列表', 'type' => 'array', 'items' => [ 'description' => '参数体', 'type' => 'object', 'properties' => [ 'name' => [ 'title' => '参数名称', 'description' => '参数名称', 'type' => 'string', 'required' => false, 'example' => 'title_field', ], 'value' => [ 'title' => '参数值', 'description' => '参数值', 'type' => 'string', 'required' => false, 'example' => 'title', ], ], 'required' => false, 'example' => '{}', ], 'required' => false, 'example' => '{ "name": "title_field", "value": "title" }', ], 'usageParameters' => [ 'title' => '使用参数', 'description' => '使用参数列表', 'type' => 'array', 'items' => [ 'description' => '参数体', 'type' => 'object', 'properties' => [ 'name' => [ 'description' => '参数名称', 'type' => 'string', 'required' => false, 'example' => 'allow_dict_id', ], 'value' => [ 'description' => '参数值', 'type' => 'string', 'required' => false, 'example' => '123', ], ], 'required' => false, ], 'required' => false, ], 'description' => [ 'title' => '实例描述', 'description' => '实例描述', 'type' => 'string', 'required' => false, 'example' => '测试实例', ], ], 'required' => false, 'example' => '{}', ], ], [ 'name' => 'appGroupIdentity', 'in' => 'path', 'schema' => [ 'title' => 'opensearch应用名', 'description' => 'opensearch应用名', 'type' => 'string', 'required' => true, 'example' => '"app_group_name"', ], ], [ 'name' => 'functionName', 'in' => 'path', 'schema' => [ 'title' => '功能名称', 'description' => '功能名称', 'type' => 'string', 'required' => true, 'example' => '"ctr"', ], ], [ 'name' => 'instanceName', 'in' => 'path', 'schema' => [ 'title' => '实例名称', 'description' => '实例名称', 'type' => 'string', 'required' => true, 'example' => '"ctr_test"', ], ], ], 'responses' => [ 200 => [ 'schema' => [ 'title' => 'Schema of Response', 'description' => 'Schema of Response', 'type' => 'object', 'properties' => [ 'Status' => [ 'description' => '请求状态'."\n" ."\n" .'- OK 成功'."\n" .'- FAIL 失败'."\n", 'type' => 'string', 'example' => 'OK', ], 'HttpCode' => [ 'description' => 'http状态码', 'type' => 'integer', 'format' => 'int64', 'example' => '200', ], 'RequestId' => [ 'description' => '请求id', 'type' => 'string', 'example' => '"3A809095-C554-5CF5-8FCE-BE19D4673790"', ], 'Message' => [ 'title' => '错误信息', 'description' => '错误信息', 'type' => 'string', 'example' => '"instance not exist."', ], 'Code' => [ 'title' => '错误码', 'description' => '错误码', 'type' => 'string', 'example' => '"Instance.NotExist"', ], 'Latency' => [ 'title' => '耗时', 'description' => '请求耗时（单位ms）', 'type' => 'integer', 'format' => 'int64', 'example' => '10', ], ], 'example' => '{}', ], ], ], 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"Status\\": \\"OK\\",\\n \\"HttpCode\\": 200,\\n \\"RequestId\\": \\"\\\\\\"3A809095-C554-5CF5-8FCE-BE19D4673790\\\\\\"\\",\\n \\"Message\\": \\"\\\\\\"instance not exist.\\\\\\"\\",\\n \\"Code\\": \\"\\\\\\"Instance.NotExist\\\\\\"\\",\\n \\"Latency\\": 10\\n}","type":"json"}]', 'title' => '更新算法实例', 'requestParamsDescription' => '### 示例（只更新createParameters和cron）'."\n" .'`PUT /v4/openapi/app-groups/my-app/functions/ctr/instances/ctr_test`'."\n" ."\n" .'```'."\n" .'{'."\n" .' "createParameters": ['."\n" .' {'."\n" .' "name": "param1",'."\n" .' "value": "new value"'."\n" .' }'."\n" .' ],'."\n" .' "cron": ""'."\n" .'}'."\n" .'```', ], 'CreateFunctionInstance' => [ 'summary' => '创建指定功能的一个算法实例。', 'path' => '/v4/openapi/app-groups/{appGroupIdentity}/functions/{functionName}/instances', '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' => '100229', 'abilityTreeNodes' => [ 'FEATUREopensearch3QPM0K', 'FEATUREopensearchUIICM8', 'FEATUREopensearchZAE4HR', ], ], 'parameters' => [ [ 'name' => 'Body', 'in' => 'body', 'style' => 'json', 'schema' => [ 'title' => 'body参数', 'description' => 'body参数', 'type' => 'object', 'properties' => [ 'instanceName' => [ 'title' => '实例名称', 'description' => '实例名称，度为1-30个字符，以字母开头，可以包含大小写字母、数字和下划线', 'type' => 'string', 'required' => true, 'example' => 'ctr_test', ], 'modelType' => [ 'title' => '模型类型', 'description' => '模型类型，不同功能对应的模型类型如下：'."\n" ."\n" .'- CTR模型：tf_checkpoint'."\n" .'- 人气模型：pop'."\n" .'- 类目模型：offline_inference'."\n" .'- 热词模型：offline_inference'."\n" .'- 底纹模型：offline_inference'."\n" .'- 热词模型（实时热搜）：near_realtime'."\n" .'- 底纹模型（个性化底纹）：near_realtime'."\n" .'- 下拉提示模型：offline_inference'."\n" .'- 分词模型：text'."\n" .'- 词权重模型：tf_checkpoint'."\n" .'- 同义词模型：offline_inference', 'type' => 'string', 'required' => true, 'example' => 'tf_checkpoint', ], 'functionType' => [ 'title' => '功能类型', 'description' => '功能类型：'."\n" ."\n" .'- PAAS：（默认）需要训练后才能使用', 'type' => 'string', 'required' => false, 'example' => 'PAAS', ], 'description' => [ 'title' => '实例描述', 'description' => '描述信息', 'type' => 'string', 'required' => false, 'example' => '测试实例', ], 'createParameters' => [ 'title' => '创建参数', 'description' => '创建参数列表', 'type' => 'array', 'items' => [ 'description' => '创建参数体', 'type' => 'object', 'properties' => [ 'name' => [ 'title' => '参数名称', 'description' => '参数名称', 'type' => 'string', 'required' => false, 'example' => 'title_field', ], 'value' => [ 'title' => '参数值', 'description' => '参数值', 'type' => 'string', 'required' => false, 'example' => 'title', ], ], 'required' => false, 'example' => '{ "name": "title_field", "value": "title" }', ], 'required' => false, 'example' => '[ { "name": "param1", "value": "val1" } ]', ], 'usageParameters' => [ 'title' => '使用参数', 'description' => '使用参数', 'type' => 'array', 'items' => [ 'description' => '在线使用的参数列表，如黑白名单', 'type' => 'object', 'properties' => [ 'name' => [ 'title' => '参数名称', 'description' => '参数名称', 'type' => 'string', 'required' => false, 'example' => 'allow_dict_id', ], 'value' => [ 'title' => '参数值', 'description' => '参数值', 'type' => 'string', 'required' => false, 'example' => '123', ], ], 'required' => false, ], 'required' => false, ], 'cron' => [ 'title' => '周期训练', 'description' => '周期训练信息，cron语法（Minutes Hours DayofMonth Month DayofWeek），为空表示不进行周期训练（默认），其中DayofWeek 0表示星期日', 'type' => 'string', 'required' => false, 'example' => '0 0 ? * 0,1,2,3,4,5,6', ], ], 'required' => false, 'docRequired' => true, 'example' => '{ "instanceName": "ctr_test", "modelType": "tf_checkpoint", "createParameters": [ { "name": "title_field", "value": "title" }, { "name": "description_field", "value": "" }, { "name": "tags_field", "value": "" }, { "name": "id_field", "value": "item_id" }, { "name": "category_field", "value": "cate" } ], "description": "测试实例", }', ], ], [ 'name' => 'appGroupIdentity', 'in' => 'path', 'schema' => [ 'description' => '应用名称', 'type' => 'string', 'required' => true, 'example' => 'my_app_group_name', ], ], [ 'name' => 'functionName', 'in' => 'path', 'schema' => [ 'description' => '功能名称，支持的模型有：'."\n" ."\n" .'- CTR模型：ctr'."\n" .'- 人气模型：pop'."\n" .'- 类目模型：category'."\n" .'- 热词模型：hot'."\n" .'- 底纹模型：hint'."\n" .'- 下拉提示模型：suggest'."\n" .'- 分词模型：analyzer'."\n" .'- 词权重模型：termweight'."\n" .'- 同义词模型：synonym', 'type' => 'string', 'required' => true, 'example' => 'ctr', ], ], ], 'responses' => [ 200 => [ 'schema' => [ 'description' => 'body参数'."\n" ."\n", 'type' => 'object', 'properties' => [ 'Status' => [ 'description' => '状态码', 'type' => 'string', 'example' => 'OK', ], 'HttpCode' => [ 'description' => 'http状态码', 'type' => 'integer', 'format' => 'int64', 'example' => '200', ], 'RequestId' => [ 'description' => '请求id', 'type' => 'string', 'example' => '98724351-D6B2-5D8A-B089-7FFD1821A7E9', ], 'Message' => [ 'description' => '错误信息，正常时为空', 'type' => 'string', 'example' => 'version not exist.', ], 'Code' => [ 'description' => '错误码', 'type' => 'string', 'example' => 'Version.NotExist', ], 'Latency' => [ 'description' => '请求耗时，单位ms', 'type' => 'integer', 'format' => 'int64', 'example' => '123', ], ], 'example' => '{ "status" : "OK", "requestId" : "", "httpCode": 200, "code": "", "message": "", "latency" : 123, "result" : { } }', ], ], ], 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"Status\\": \\"OK\\",\\n \\"HttpCode\\": 200,\\n \\"RequestId\\": \\"98724351-D6B2-5D8A-B089-7FFD1821A7E9\\",\\n \\"Message\\": \\"version not exist.\\",\\n \\"Code\\": \\"Version.NotExist\\",\\n \\"Latency\\": 123\\n}","type":"json"}]', 'title' => '创建算法实例', 'description' => '一般先通过[GetFunctionCurrentVersion](~~421377~~)接口获取当前功能使用的最新版本，版本中描述了创建实例所需的参数列表createParameters、usageParameters，以及参数填写要求。', 'requestParamsDescription' => '### 示例（ctr）'."\n" .'```'."\n" .'POST /v4/openapi/app-groups/my-app/functions/ctr/instances'."\n" .'{'."\n" .' "instanceName": "my_ctr",'."\n" .' "modelType": "tf_checkpoint",'."\n" .' "functionType": "PAAS",'."\n" .' "cron": "0 0 ? * 0,1,3,5",'."\n" .' "description": "",'."\n" .' "createParameters": ['."\n" .' {'."\n" .' "name": "id_field",'."\n" .' "value": "id"'."\n" .' },'."\n" .' {'."\n" .' "name": "title_field",'."\n" .' "value": "title"'."\n" .' }'."\n" .' ],'."\n" .' "usageParameters": []'."\n" .'}'."\n" .'```'."\n" .'### 示例（hot）'."\n" .'```'."\n" .'POST /v4/openapi/app-groups/my-app/functions/hot/instances'."\n" .'{'."\n" .' "instanceName":"my_hot",'."\n" .' "modelType":"offline_inference",'."\n" .' "functionType":"PAAS",'."\n" .' "createParameters":['."\n" .' {'."\n" .' "name":"filter",'."\n" .' "value":"biz_type != 1"'."\n" .' }'."\n" .' ],'."\n" .' "usageParameters": ['."\n" .' {'."\n" .' "name":"allow_dict_id",'."\n" .' "value":"123"'."\n" .' },'."\n" .' {'."\n" .' "name":"deny_dict_id",'."\n" .' "value":"456"'."\n" .' }'."\n" .' ],'."\n" .' "cron":"12 4 ? * 1,2,3,4,5,6,0"'."\n" .'}'."\n" .'```', 'responseParamsDescription' => '### 正常返回示例：'."\n" .'```'."\n" .'{'."\n" .' "status" : "OK",'."\n" .' "requestId" : "98724351-D6B2-5D8A-B089-7FFD1821A7E9",'."\n" .' "httpCode": 200,'."\n" .' "code": "",'."\n" .' "message": "",'."\n" .' "latency" : 123,'."\n" .' "result" : {}'."\n" .'}'."\n" .'```', ], 'DescribeAppGroup' => [ 'path' => '/v4/openapi/app-groups/{appGroupIdentity}', 'methods' => [ 'get', ], 'schemes' => [ 'http', 'https', ], 'security' => [ [ 'AK' => [], ], ], 'operationType' => 'read', 'deprecated' => false, 'systemTags' => [ 'operationType' => 'get', 'abilityTreeCode' => '55169', 'abilityTreeNodes' => [ 'FEATUREopensearchGVH0IN', 'FEATUREopensearch447AAX', 'FEATUREopensearch5OZOSP', ], ], 'parameters' => [ [ 'name' => 'appGroupIdentity', 'in' => 'path', 'schema' => [ 'description' => '应用名称', 'type' => 'string', 'required' => true, 'docRequired' => true, 'example' => 'my_app_group_name', ], ], ], 'responses' => [ 200 => [ 'schema' => [ 'type' => 'object', 'properties' => [ 'requestId' => [ 'description' => '请求ID', 'type' => 'string', 'example' => '0A6EB64B-B4C8-CF02-810F-E660812972FF', ], 'result' => [ 'description' => '应用信息', 'type' => 'object', 'properties' => [ 'created' => [ 'description' => '创建时间戳', 'type' => 'integer', 'format' => 'int32', 'example' => '1575442875', ], 'currentVersion' => [ 'description' => '当前在线版本', 'type' => 'string', 'example' => '110116134', ], 'pendingSecondRankAlgoDeploymentId' => [ 'description' => '部署中的精排部署ID', 'type' => 'integer', 'format' => 'int32', 'example' => '0', ], 'lockMode' => [ 'description' => '锁定状态'."\n" .'- Unlock 正常'."\n" .'- LockByExpiration 实例过期自动锁定'."\n" .'- ManualLock 手动触发锁定', 'type' => 'string', 'example' => 'Unlock', ], 'updated' => [ 'description' => '更新时间戳', 'type' => 'integer', 'format' => 'int32', 'example' => '1578916076', ], 'id' => [ 'description' => '应用ID', 'type' => 'string', 'example' => '110116134', ], 'chargeType' => [ 'description' => '付费类型'."\n" .'- POSTPAY 后付费（按量付费）'."\n" .'- PREPAY 预付费（包年包月', 'type' => 'string', 'example' => 'POSTPAY', ], 'hasPendingQuotaReviewTask' => [ 'description' => '是否配额审批中'."\n" .'- 0：正常'."\n" .'- 1：配额审批中', 'type' => 'integer', 'format' => 'int32', 'example' => '0', ], 'secondRankAlgoDeploymentId' => [ 'description' => '精排部署ID', 'type' => 'integer', 'format' => 'int32', 'example' => '0', ], 'name' => [ 'description' => '应用名称', 'type' => 'string', 'example' => 'os_function_test_v1', ], 'instanceId' => [ 'description' => '实例ID', 'type' => 'string', 'example' => '-', ], 'processingOrderId' => [ 'description' => '未结束订单号', 'type' => 'string', 'example' => '-', ], 'chargingWay' => [ 'description' => '计费类型'."\n" .'- 1：计算资源'."\n" .'- 2：qps', 'type' => 'integer', 'format' => 'int32', 'example' => '1', ], 'type' => [ 'description' => '应用类型'."\n" .'- standard 标准版'."\n" .'- enhanced 新高级版', 'type' => 'string', 'example' => 'enhanced', ], 'status' => [ 'description' => '应用状态'."\n" .'- producing 生产中'."\n" .'- review_pending 生产审批中'."\n" .'- config_pending 待配置'."\n" .'- normal 正常'."\n" .'- frozen 已冻结', 'type' => 'string', 'example' => 'normal', ], 'projectId' => [ 'description' => 'abtest project 名称', 'type' => 'string', 'example' => '-', ], 'switchedTime' => [ 'description' => '在线版本切换时间戳', 'type' => 'integer', 'format' => 'int32', 'example' => '0', ], 'commodityCode' => [ 'description' => '商品CODE', 'type' => 'string', 'example' => 'opensearch', ], 'expireOn' => [ 'description' => '过期时间', 'type' => 'string', 'example' => '-', ], 'domain' => [ 'description' => '应用所属行业', 'type' => 'string', 'example' => 'ecommerce', ], 'description' => [ 'description' => '应用描述', 'type' => 'string', 'example' => '-', ], 'firstRankAlgoDeploymentId' => [ 'description' => '粗排部署ID', 'type' => 'integer', 'format' => 'int32', 'example' => '0', ], 'produced' => [ 'description' => '是否生产完成'."\n" .'- 0：生产中'."\n" .'- 1：生产完成', 'type' => 'integer', 'format' => 'int32', 'example' => '1', ], 'lockedByExpiration' => [ 'description' => '实例过期自动锁定', 'type' => 'integer', 'format' => 'int32', 'example' => '0', ], 'quota' => [ 'description' => '应用配额信息', 'type' => 'object', 'properties' => [ 'spec' => [ 'description' => '规格'."\n" .'- opensearch.share.junior 入门型'."\n" .'- opensearch.share.common 共享通用型'."\n" .'- opensearch.share.compute 共享计算型'."\n" .'- opensearch.share.storage 共享存储型'."\n" .'- opensearch.private.common 独享通用型'."\n" .'- opensearch.private.compute 独享计算型'."\n" .'- opensearch.private.storage 独享存储型', 'type' => 'string', 'example' => 'opensearch.share.common', ], 'docSize' => [ 'description' => '存储容量（单位：GB）', 'type' => 'integer', 'format' => 'int32', 'example' => '1', ], 'computeResource' => [ 'description' => '计算资源（单位：LCU）', 'type' => 'integer', 'format' => 'int32', 'example' => '20', ], ], ], 'tags' => [ 'description' => '应用标签', 'type' => 'array', 'items' => [ 'description' => '数据源标签。', 'type' => 'object', 'properties' => [ 'key' => [ 'description' => '标签键', 'type' => 'string', 'example' => 'foo', ], 'value' => [ 'description' => '标签值', 'type' => 'string', 'example' => 'bar', ], ], ], ], 'resourceGroupId' => [ 'description' => '实例所属的资源组ID。', 'type' => 'string', 'example' => 'rg-acfmoiyerh6nzly', ], 'engineType' => [ 'description' => '引擎类型', 'type' => 'string', 'example' => 'ha3', ], ], ], ], ], ], '5XX' => [ 'schema' => [ 'type' => 'object', 'properties' => [ 'code' => [ 'type' => 'string', ], 'message' => [ 'type' => 'string', ], 'requestId' => [ 'type' => 'string', ], 'httpCode' => [ 'type' => 'integer', 'format' => 'int32', ], ], ], ], ], 'responseDemo' => '[{"type":"json","example":"{\\n \\"requestId\\": \\"0A6EB64B-B4C8-CF02-810F-E660812972FF\\",\\n \\"result\\": {\\n \\"created\\": 1575442875,\\n \\"currentVersion\\": \\"110116134\\",\\n \\"pendingSecondRankAlgoDeploymentId\\": 0,\\n \\"lockMode\\": \\"Unlock\\",\\n \\"updated\\": 1578916076,\\n \\"id\\": \\"110116134\\",\\n \\"chargeType\\": \\"POSTPAY\\",\\n \\"hasPendingQuotaReviewTask\\": 0,\\n \\"secondRankAlgoDeploymentId\\": 0,\\n \\"name\\": \\"os_function_test_v1\\",\\n \\"instanceId\\": \\"-\\",\\n \\"processingOrderId\\": \\"-\\",\\n \\"chargingWay\\": 1,\\n \\"type\\": \\"enhanced\\",\\n \\"status\\": \\"normal\\",\\n \\"projectId\\": \\"-\\",\\n \\"switchedTime\\": 0,\\n \\"commodityCode\\": \\"opensearch\\",\\n \\"expireOn\\": \\"-\\",\\n \\"domain\\": \\"ecommerce\\",\\n \\"description\\": \\"-\\",\\n \\"firstRankAlgoDeploymentId\\": 0,\\n \\"produced\\": 1,\\n \\"lockedByExpiration\\": 0,\\n \\"quota\\": {\\n \\"spec\\": \\"opensearch.share.common\\",\\n \\"docSize\\": 1,\\n \\"computeResource\\": 20\\n },\\n \\"tags\\": [\\n {\\n \\"key\\": \\"foo\\",\\n \\"value\\": \\"bar\\"\\n }\\n ],\\n \\"resourceGroupId\\": \\"rg-acfmoiyerh6nzly\\",\\n \\"engineType\\": \\"ha3\\"\\n }\\n}","errorExample":""},{"type":"xml","example":"0A6EB64B-B4C8-CF02-810F-E660812972FF\\n\\n 110116134\\n os_function_test_v1\\n 110116134\\n 0\\n \\n 1\\n 20\\n opensearch.share.common\\n \\n 1\\n enhanced\\n 100298792\\n \\n POSTPAY\\n \\n \\n opensearch\\n \\n 0\\n 0\\n 0\\n \\n 1\\n 0\\n 0\\n 1575442875\\n 1578916076\\n normal\\n Unlock\\n","errorExample":""}]', 'title' => '查看应用实例详情', 'summary' => '查看一个 OpenSearch 应用详情。', 'requestParamsDescription' => ' ', 'responseParamsDescription' => ' ', 'extraInfo' => ' ', ], 'ValidateDataSources' => [ 'summary' => '验证数据源。', 'path' => '/v4/openapi/assist/data-sources/validations', 'methods' => [ 'post', ], 'schemes' => [ 'http', 'https', ], 'security' => [ [ 'AK' => [], ], ], 'deprecated' => false, 'systemTags' => [ 'operationType' => 'get', ], 'parameters' => [ [ 'name' => 'body', 'in' => 'body', 'schema' => [ 'description' => '请求参数，参考：[DataSource](~~170005~~)', 'required' => false, '$ref' => '#/components/schemas/DataSource', ], ], ], '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' => '8FA2B338-AFDC-46B4-A132-B5487820C2BF', ], 'result' => [ 'description' => '请求结果', 'type' => 'array', 'items' => [ 'description' => '结果体', 'type' => 'object', 'properties' => [ 'code' => [ 'description' => '状态码', 'type' => 'string', 'example' => 'SUCCEED', ], 'message' => [ 'description' => '响应信息', 'type' => 'string', 'example' => '校验成功', ], 'dataSource' => [ 'description' => '数据源', 'type' => 'object', 'properties' => [ 'tableName' => [ 'description' => '表名', 'type' => 'string', 'example' => 'user_activity_decision', ], 'type' => [ 'description' => '数据源类型', 'type' => 'string', 'example' => 'rds', ], 'parameters' => [ 'description' => '参数体', 'type' => 'object', 'example' => '{}', ], ], 'example' => '{}', ], ], 'example' => '{}', ], 'example' => '[]', ], ], 'example' => '{}', ], ], ], 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"requestId\\": \\"8FA2B338-AFDC-46B4-A132-B5487820C2BF\\",\\n \\"result\\": [\\n {\\n \\"code\\": \\"SUCCEED\\",\\n \\"message\\": \\"校验成功\\",\\n \\"dataSource\\": {\\n \\"tableName\\": \\"user_activity_decision\\",\\n \\"type\\": \\"rds\\",\\n \\"parameters\\": {}\\n }\\n }\\n ]\\n}","type":"json"}]', 'title' => '验证数据源', ], 'ReplaceAppGroupCommodityCode' => [ 'path' => '/v4/openapi/app-groups/{appGroupIdentity}/actions/to-instance-typed', 'methods' => [ 'post', ], 'schemes' => [ 'http', 'https', ], 'security' => [ [ 'AK' => [], ], ], 'operationType' => 'write', 'deprecated' => false, 'systemTags' => [ 'operationType' => 'none', 'abilityTreeCode' => '55260', 'abilityTreeNodes' => [ 'FEATUREopensearch3UFA61', ], ], 'parameters' => [ [ 'name' => 'appGroupIdentity', 'in' => 'path', 'schema' => [ 'description' => '应用名称', 'type' => 'string', 'required' => true, 'docRequired' => true, 'example' => 'my_app', ], ], ], 'responses' => [ 200 => [ 'schema' => [ 'description' => '响应体', 'type' => 'object', 'properties' => [ 'requestId' => [ 'description' => '请求id', 'type' => 'string', 'example' => 'AC5F78BA-66B9-545B-9CF1-8F542E682E1F', ], 'result' => [ 'description' => '返回详情结果'."\n" ."\n", 'type' => 'object', 'properties' => [ 'created' => [ 'description' => '创建时间戳', 'type' => 'integer', 'format' => 'int32', 'example' => '1588054131', ], 'currentVersion' => [ 'description' => '当前在线版本', 'type' => 'string', 'example' => '100302903', ], 'pendingSecondRankAlgoDeploymentId' => [ 'description' => '部署中的精排部署ID', 'type' => 'integer', 'format' => 'int32', 'example' => '0', ], 'type' => [ 'description' => '类型', 'type' => 'string', 'example' => '-', ], 'chargingWay' => [ 'description' => '计费类型'."\n" .' - 1: 计算资源'."\n" .' - 2：qps', 'type' => 'integer', 'format' => 'int32', 'example' => '1', ], 'lockMode' => [ 'description' => '锁定状态'."\n" ."\n" .'- Unlock 正常'."\n" .'- LockByExpiration 实例过期自动锁定'."\n" .'- ManualLock 手动触发锁定', 'type' => 'string', 'example' => 'Unlock', ], 'status' => [ 'description' => '状态', 'type' => 'string', 'example' => 'normal', ], 'updated' => [ 'description' => '更新时间戳', 'type' => 'integer', 'format' => 'int32', 'example' => '1581065904', ], 'chargeType' => [ 'description' => '付费类型'."\n" .'- POSTPAY 后付费（按量付费）'."\n" .'- PREPAY 预付费（包年包月）', 'type' => 'string', 'example' => 'POSTPAY', ], 'id' => [ 'description' => '应用ID', 'type' => 'string', 'example' => '-', ], 'hasPendingQuotaReviewTask' => [ 'description' => '是否配额审批中'."\n" .'- 0：正常'."\n" .'- 1：配额审批中', 'type' => 'integer', 'format' => 'int32', 'example' => '0', ], 'projectId' => [ 'description' => 'abtest project 名称', 'type' => 'string', 'example' => '-', ], 'secondRankAlgoDeploymentId' => [ 'description' => '精排部署ID', 'type' => 'integer', 'format' => 'int32', 'example' => '0', ], 'commodityCode' => [ 'description' => '商品CODE', 'type' => 'string', 'example' => 'opensearch', ], 'switchedTime' => [ 'description' => '在线版本切换时间戳', 'type' => 'integer', 'format' => 'int32', 'example' => '1590486386', ], 'expireOn' => [ 'description' => '过期时间', 'type' => 'string', 'example' => '-', ], 'description' => [ 'description' => '描述', 'type' => 'string', 'example' => '""', ], 'firstRankAlgoDeploymentId' => [ 'description' => '粗排部署id', 'type' => 'integer', 'format' => 'int32', 'example' => '0', ], 'lockedByExpiration' => [ 'description' => '实例是否过期自动锁定'."\n" .'- 0：否'."\n" .'- 1：是', 'type' => 'integer', 'format' => 'int32', 'example' => '0', ], 'produced' => [ 'description' => '是否生产', 'type' => 'integer', 'format' => 'int32', 'example' => '0', ], 'name' => [ 'description' => '名称', 'type' => 'string', 'example' => '-', ], 'processingOrderId' => [ 'description' => '处理中的', 'type' => 'string', 'example' => '-', ], 'instanceId' => [ 'description' => '请求的实例id', 'type' => 'string', 'example' => '-', ], 'versions' => [ 'description' => '版本信息', 'type' => 'array', 'items' => [ 'description' => '版本信息', 'type' => 'string', 'example' => '-', ], ], 'quota' => [ 'description' => '配置信息', 'type' => 'object', 'properties' => [ 'spec' => [ 'description' => '配置型号', 'type' => 'string', 'example' => '-', ], 'docSize' => [ 'description' => '适用于定制应用', 'type' => 'integer', 'format' => 'int32', 'example' => '1', ], 'computeResource' => [ 'description' => '配置数量', 'type' => 'integer', 'format' => 'int32', 'example' => '20', ], ], ], ], 'example' => '{}', ], ], ], ], '5XX' => [ 'schema' => [ 'type' => 'object', 'properties' => [ 'code' => [ 'type' => 'string', ], 'httpCode' => [ 'type' => 'integer', 'format' => 'int32', ], 'requestId' => [ 'type' => 'string', ], 'message' => [ 'type' => 'string', ], ], ], ], ], 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"requestId\\": \\"AC5F78BA-66B9-545B-9CF1-8F542E682E1F\\",\\n \\"result\\": {\\n \\"created\\": 1588054131,\\n \\"currentVersion\\": \\"100302903\\",\\n \\"pendingSecondRankAlgoDeploymentId\\": 0,\\n \\"type\\": \\"-\\",\\n \\"chargingWay\\": 1,\\n \\"lockMode\\": \\"Unlock\\",\\n \\"status\\": \\"normal\\",\\n \\"updated\\": 1581065904,\\n \\"chargeType\\": \\"POSTPAY\\",\\n \\"id\\": \\"-\\",\\n \\"hasPendingQuotaReviewTask\\": 0,\\n \\"projectId\\": \\"-\\",\\n \\"secondRankAlgoDeploymentId\\": 0,\\n \\"commodityCode\\": \\"opensearch\\",\\n \\"switchedTime\\": 1590486386,\\n \\"expireOn\\": \\"-\\",\\n \\"description\\": \\"\\\\\\"\\\\\\"\\",\\n \\"firstRankAlgoDeploymentId\\": 0,\\n \\"lockedByExpiration\\": 0,\\n \\"produced\\": 0,\\n \\"name\\": \\"-\\",\\n \\"processingOrderId\\": \\"-\\",\\n \\"instanceId\\": \\"-\\",\\n \\"versions\\": [\\n \\"-\\"\\n ],\\n \\"quota\\": {\\n \\"spec\\": \\"-\\",\\n \\"docSize\\": 1,\\n \\"computeResource\\": 20\\n }\\n }\\n}","type":"json"}]', 'title' => '应用服务型转实例型', 'summary' => '应用服务型转实例型。', ], 'ListSortScripts' => [ 'summary' => '获取指定版本下所有的排序脚本。', 'path' => '/v4/openapi/app-groups/{appGroupIdentity}/apps/{appVersionId}/sort-scripts', 'methods' => [ 'get', ], 'schemes' => [ 'http', 'https', ], 'security' => [ [ 'AK' => [], ], ], 'operationType' => 'read', 'deprecated' => false, 'systemTags' => [ 'operationType' => 'list', 'riskType' => 'none', 'chargeType' => 'free', 'abilityTreeNodes' => [ 'FEATUREopensearchN8M8WS', ], ], 'parameters' => [ [ 'name' => 'appGroupIdentity', 'in' => 'path', 'schema' => [ 'description' => '应用的名称或者是应用id', 'type' => 'string', 'required' => true, 'docRequired' => true, 'example' => 'my_app', ], ], [ 'name' => 'appVersionId', 'in' => 'path', 'schema' => [ 'description' => '应用下的版本id', 'type' => 'string', 'required' => true, 'docRequired' => true, 'example' => '110142366', ], ], ], 'responses' => [ 200 => [ 'schema' => [ 'type' => 'object', 'properties' => [ 'requestId' => [ 'description' => '唯一标识一次请求', 'type' => 'string', 'example' => 'ABCDEFGH', ], 'result' => [ 'description' => '脚本列表', 'type' => 'array', 'items' => [ 'type' => 'object', 'properties' => [ 'type' => [ 'description' => '脚本的类型', 'type' => 'string', 'example' => 'cava_script', ], 'scope' => [ 'description' => '脚本的作用范围', 'type' => 'string', 'example' => 'second_rank', ], 'createTime' => [ 'description' => '脚本创建时间', 'type' => 'string', 'example' => '2020-04-02 20:21:14', ], 'status' => [ 'description' => '脚本的状态：'."\n" ."\n" .'- configurable：脚本创建成功，还未上传文件'."\n" .'- not compiled：脚本未编译'."\n" .'- compile failed：脚本编译失败'."\n" .'- compile successful：脚本编译成功'."\n" .'- released：脚本已发布', 'type' => 'string', 'example' => 'released', ], 'modifyTime' => [ 'description' => '脚本最后一次修改时间', 'type' => 'string', 'example' => '2020-04-02 21:21:14', ], 'scriptName' => [ 'description' => '脚本名称', 'type' => 'string', 'example' => 'test', ], ], ], ], ], ], ], '5XX' => [ 'schema' => [ 'type' => 'object', 'properties' => [ 'code' => [ 'type' => 'string', ], 'message' => [ 'type' => 'string', ], 'requestId' => [ 'type' => 'string', ], 'httpCode' => [ 'type' => 'integer', 'format' => 'int32', ], ], ], ], ], 'responseDemo' => '[{"type":"json","example":"{\\n \\"requestId\\": \\"ABCDEFGH\\",\\n \\"result\\": [\\n {\\n \\"type\\": \\"cava_script\\",\\n \\"scope\\": \\"second_rank\\",\\n \\"createTime\\": \\"2020-04-02 20:21:14\\",\\n \\"status\\": \\"released\\",\\n \\"modifyTime\\": \\"2020-04-02 21:21:14\\",\\n \\"scriptName\\": \\"test\\"\\n }\\n ]\\n}","errorExample":""},{"type":"xml","example":"ABCDEFGH\\n\\n cava_script\\n second_rank\\n released\\n 2020-04-02 20:21:14\\n 2020-04-02 21:21:14\\n","errorExample":""}]', 'title' => '获取指定版本下所有的排序脚本', 'requestParamsDescription' => ' ', 'responseParamsDescription' => ' ```'."\n" .'错误返回'."\n" .'{'."\n" .' "requestId" : "ABCDEFGH",'."\n" .' "code":"InvalidAppSpec",'."\n" .' "message":"The cava scripts only support the private spec app.",'."\n" .' "httpCode":400'."\n" .'}'."\n" .'```', 'extraInfo' => ' ', ], 'ListDataSourceTables' => [ 'path' => '/v4/openapi/assist/data-sources/{dataSourceType}/tables', 'methods' => [ 'get', ], 'schemes' => [ 'http', 'https', ], 'security' => [ [ 'AK' => [], ], ], 'operationType' => 'read', 'deprecated' => false, 'systemTags' => [ 'operationType' => 'get', ], 'parameters' => [ [ 'name' => 'dataSourceType', 'in' => 'path', 'schema' => [ 'description' => '数据源类型'."\n" ."\n" .'- rds'."\n" .'- polardb'."\n" .'- odps'."\n" .'- mysql'."\n" .'- drds', 'type' => 'string', 'required' => true, 'docRequired' => true, 'example' => 'rds', ], ], [ 'name' => 'params', 'in' => 'query', 'schema' => [ 'description' => '数据源参数。json字符串，需要urlencode编码。'."\n" ."\n" .'各数据源参数不同，参考：'."\n" ."\n" .'- [rds](~~170005~~)'."\n" .'- [polardb](~~170005~~)'."\n" .'- [odps](~~170005~~)'."\n" .'- [mysql](~~173627~~)'."\n" .'- [drds](~~173627~~)', 'type' => 'string', 'required' => true, 'docRequired' => true, 'example' => '-', ], ], ], 'responses' => [ 200 => [ 'schema' => [ 'type' => 'object', 'properties' => [ 'requestId' => [ 'description' => '请求ID', 'type' => 'string', 'example' => '0A6EB64B-B4C8-CF02-810F-E660812972FF', ], 'result' => [ 'type' => 'array', 'items' => [ 'description' => '数据源表集合', 'type' => 'string', 'example' => '{}', ], ], ], ], ], '5XX' => [ 'schema' => [ 'type' => 'object', 'properties' => [ 'code' => [ 'type' => 'string', ], 'message' => [ 'type' => 'string', ], 'requestId' => [ 'type' => 'string', ], 'httpCode' => [ 'type' => 'integer', 'format' => 'int32', ], ], ], ], ], 'responseDemo' => '[{"type":"json","example":"{\\n \\"requestId\\": \\"0A6EB64B-B4C8-CF02-810F-E660812972FF\\",\\n \\"result\\": [\\n \\"{}\\"\\n ]\\n}","errorExample":""},{"type":"xml","example":"0A6EB64B-B4C8-CF02-810F-E660812972FF\\ncate_test\\noffline_error\\nplugin\\nquota_test\\nsmoke\\nsmoke_1\\nsmoke_2\\nstudents","errorExample":""}]', 'title' => '获取指定实例的数据源列表', 'summary' => '获取指定数据源的所有数据。', 'requestParamsDescription' => ' ', 'responseParamsDescription' => ' ', 'extraInfo' => ' ', ], 'ListDataSourceTableFields' => [ 'path' => '/v4/openapi/assist/data-sources/{dataSourceType}/fields', 'methods' => [ 'get', ], 'schemes' => [ 'http', 'https', ], 'security' => [ [ 'AK' => [], ], ], 'operationType' => 'read', 'deprecated' => false, 'systemTags' => [ 'operationType' => 'get', ], 'parameters' => [ [ 'name' => 'dataSourceType', 'in' => 'path', 'schema' => [ 'description' => '数据源类型'."\n" ."\n" .'- rds'."\n" .'- polardb'."\n" .'- odps'."\n" .'- mysql'."\n" .'- drds', 'type' => 'string', 'required' => true, 'docRequired' => true, 'enumValueTitles' => [ 'rds' => 'rds', 'mysql' => 'mysql', 'odps' => 'odps', 'saro' => 'saro', 'polardb' => 'polardb', ], 'example' => 'rds', ], ], [ 'name' => 'params', 'in' => 'query', 'schema' => [ 'description' => '数据源参数。json字符串，需要urlencode编码。'."\n" ."\n" .'各数据源参数不同，参考：'."\n" ."\n" .'- [rds](~~170005~~)'."\n" .'- [polardb](~~170005~~)'."\n" .'- [odps](~~170005~~)'."\n" .'- [mysql](~~173627~~)'."\n" .'- [drds](~~173627~~)', 'type' => 'string', 'required' => true, 'docRequired' => true, 'example' => '{}', ], ], [ 'name' => 'rawType', 'in' => 'query', 'schema' => [ 'description' => '是否返回数据源原始字段类型', 'type' => 'boolean', 'required' => false, 'example' => 'false', ], ], ], 'responses' => [ 200 => [ 'schema' => [ 'description' => '响应体', 'type' => 'object', 'properties' => [ 'result' => [ 'description' => '数据源表集合', 'type' => 'object', 'example' => '{}', ], 'requestId' => [ 'description' => '唯一标识一次请求', 'type' => 'string', 'example' => '0A6EB64B-B4C8-CF02-810F-E660812972FF', ], ], 'example' => '{}', ], ], '5XX' => [ 'schema' => [ 'type' => 'object', 'properties' => [ 'code' => [ 'type' => 'string', ], 'message' => [ 'type' => 'string', ], 'requestId' => [ 'type' => 'string', ], 'httpCode' => [ 'type' => 'integer', 'format' => 'int32', ], ], ], ], ], 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"result\\": {},\\n \\"requestId\\": \\"0A6EB64B-B4C8-CF02-810F-E660812972FF\\"\\n}","type":"json"}]', 'title' => '获取指定数据表的所有字段', 'summary' => '获取指定数据表的所有字段，为内部接口。', ], 'GetDomain' => [ 'path' => '/v4/openapi/domains/{domainName}', 'methods' => [ 'get', ], 'schemes' => [ 'http', 'https', ], 'security' => [ [ 'AK' => [], ], ], 'operationType' => 'read', 'deprecated' => false, 'systemTags' => [ 'operationType' => 'get', ], 'parameters' => [ [ 'name' => 'domainName', 'in' => 'path', 'schema' => [ 'description' => '行业类型', 'type' => 'string', 'required' => true, 'docRequired' => true, 'example' => 'ecommerce', ], ], [ 'name' => 'appGroupIdentity', 'in' => 'query', 'schema' => [ 'description' => '应用的名称或者是应用id', 'type' => 'string', 'required' => true, 'docRequired' => true, 'example' => 'my_app_group_name', ], ], ], 'responses' => [ 200 => [ 'schema' => [ 'type' => 'object', 'properties' => [ 'result' => [ 'description' => '返回结果', 'type' => 'object', 'example' => '-', ], 'requestId' => [ 'description' => '请求id', 'type' => 'string', 'example' => '271D5762-32B7-5F0D-B97D-463EB67F1F3B', ], ], ], ], '5XX' => [ 'schema' => [ 'type' => 'object', 'properties' => [ 'code' => [ 'type' => 'string', ], 'message' => [ 'type' => 'string', ], 'requestId' => [ 'type' => 'string', ], 'httpCode' => [ 'type' => 'integer', 'format' => 'int32', ], ], ], ], ], 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"result\\": {\\n \\"test\\": \\"test\\",\\n \\"test2\\": 1\\n },\\n \\"requestId\\": \\"271D5762-32B7-5F0D-B97D-463EB67F1F3B\\"\\n}","type":"json"}]', 'title' => '获取行业类型 ', 'summary' => '获取行业类型。', ], 'GenerateMergedTable' => [ 'path' => '/v4/openapi/assist/schema/actions/merge', 'methods' => [ 'post', ], 'schemes' => [ 'http', 'https', ], 'security' => [ [ 'AK' => [], ], ], 'operationType' => 'read', 'deprecated' => false, 'systemTags' => [ 'operationType' => 'get', ], 'parameters' => [ [ 'name' => 'spec', 'in' => 'query', 'schema' => [ 'description' => '目标版本规格（用于独享型特殊限制校验）。'."\n" ."\n" .'默认：opensearch.share.common'."\n" ."\n" .'参考：Quota 的 spec', 'type' => 'string', 'required' => false, 'example' => '"opensearch.share.common"', ], ], [ 'name' => 'body', 'in' => 'body', 'schema' => [ 'description' => '请求参数。', 'required' => false, '$ref' => '#/components/schemas/Schema', ], ], ], 'responses' => [ 200 => [ 'schema' => [ 'type' => 'object', 'properties' => [ 'requestId' => [ 'description' => '请求ID', 'type' => 'string', 'example' => 'ABCDEFGH', ], 'result' => [ 'description' => '返回结果', 'type' => 'object', 'properties' => [ 'primaryKey' => [ 'description' => '主键', 'type' => 'string', 'example' => '-', ], 'mergeTable' => [ 'description' => '合并后的表', 'type' => 'object', 'example' => '-', ], 'fromTable' => [ 'description' => '需要合并的表', 'type' => 'object', 'example' => '-', ], ], ], ], ], ], '5XX' => [ 'schema' => [ 'type' => 'object', 'properties' => [ 'code' => [ 'type' => 'string', ], 'message' => [ 'type' => 'string', ], 'requestId' => [ 'type' => 'string', ], 'httpCode' => [ 'type' => 'integer', 'format' => 'int32', ], ], ], ], ], 'responseDemo' => '[{"type":"json","example":"{\\n \\"requestId\\": \\"ABCDEFGH\\",\\n \\"result\\": {\\n \\"primaryKey\\": \\"-\\",\\n \\"mergeTable\\": {\\n \\"test\\": \\"test\\",\\n \\"test2\\": 1\\n },\\n \\"fromTable\\": {\\n \\"test\\": \\"test\\",\\n \\"test2\\": 1\\n }\\n }\\n}","errorExample":""},{"type":"xml","example":"8EF9C2DF-34C3-EDCF-6DEA-0445EE53DA20\\n\\n \\n \\n id\\n INT\\n 1\\n 0\\n 0\\n \\n \\n classid\\n INT\\n 0\\n 0\\n 0\\n \\n \\n <name>title</name>\\n <type>TEXT</type>\\n <isPk>0</isPk>\\n <isMulti>0</isMulti>\\n <isAttribute>0</isAttribute>\\n \\n \\n js\\n TEXT\\n 0\\n 0\\n 0\\n \\n \\n classid_1\\n INT\\n 0\\n 0\\n 0\\n \\n \\n infotags\\n TEXT\\n 0\\n 0\\n 0\\n \\n \\n \\n \\n \\n \\n id\\n INT\\n 1\\n 0\\n \\n \\n classid\\n INT\\n 0\\n 0\\n \\n \\n <name>title</name>\\n <type>TEXT</type>\\n <isPk>0</isPk>\\n <isMulti>0</isMulti>\\n \\n \\n js\\n TEXT\\n 0\\n 0\\n \\n \\n \\n \\n id_1\\n INT\\n 1\\n 0\\n \\n \\n classid_1\\n INT\\n 0\\n 0\\n \\n \\n infotags\\n TEXT\\n 0\\n 0\\n \\n \\n \\n phome_ecms_tuzhi\\n \\n 0\\n 1\\n \\n \\n \\n \\n phome_ecms_tuzhi_data_1
\\n id_1\\n \\n classid_1\\n infotags\\n \\n \\n \\n \\n \\n id\\n","errorExample":""}]', 'title' => '获取合并后的宽表', 'summary' => '获取合并后的宽表。', 'requestParamsDescription' => ' **请求体**'."\n" .'| 字段 | 类型 | 是否必要 | 示例值 | 描述 |'."\n" .'| --- | --- | --- | --- | --- |'."\n" .'| tables | Object | 是 | | 表结构 |'."\n" .'| indexes | Object | 否 | | 索引结构 |'."\n", 'responseParamsDescription' => ' **返回参数**'."\n" .'| 名称 | 类型 | 描述 |'."\n" .'| --- | --- | --- |'."\n" .'| requestId | String | 请求ID |'."\n" .'| result.mergeTable | Object | 合并后的宽表结果
键为字段名，值为字段详情 |'."\n" .'| result.fromTable | Object | 源表信息 |'."\n" .'| result.fromTable.tables | Object | 表信息
键为表名，值为表结构信息 |'."\n" .'| result.fromTable.tables.* | Object | 键为字段名，值为字段详情 |'."\n" .'| result.fromTable.master | String | 主表 |'."\n" .'| result.fromTable.level | Object | 表层级信息，从0开始
键为表名，值为层级 |'."\n" .'| result.fromTable.joinMap | Object | 外表连接信息
键为表名，值为外表连接信息 |'."\n" .'| result.fromTable.joinMap.* | Object | 外表连接字段信息
键为字段，值为外表连接字段信息 |'."\n" .'| result.primaryKey | String | 主键字段 |'."\n" ."\n\n" .' **TableFields**'."\n" .'| 名称 | 类型 | 描述 |'."\n" .'| --- | --- | --- |'."\n" .'| name | String | 字段名 |'."\n" .'| type | String | 字段类型
参考：[数据表字段](~~179404~~) |'."\n" .'| isPk | String| 是否为主键
0：否
1：是 |'."\n" .'| isMulti | Integer | 是否为多值
0：否
1：是 |'."\n" .'| isAttribute | Integer | 是否为属性字段
0：否
1：是 |'."\n" ."\n\n" .' **JoinMapFields**'."\n" .'| 名称 | 类型 | 描述 |'."\n" .'| --- | --- | --- |'."\n" .'| table | String | 外连表名 |'."\n" .'| key | String | 外连表主键名 |'."\n" .'| join | Object | 外连表的扩展字段 |'."\n" ."\n\n" ."\n\n" ."\n", 'extraInfo' => ' ', ], 'DescribeRegions' => [ 'path' => '/v4/openapi/regions', 'methods' => [ 'get', ], 'schemes' => [ 'http', 'https', ], 'security' => [ [ 'AK' => [], ], ], 'operationType' => 'read', 'deprecated' => false, 'systemTags' => [ 'operationType' => 'get', 'abilityTreeCode' => '55180', 'abilityTreeNodes' => [ 'FEATUREopensearch447AAX', ], ], 'parameters' => [], 'responses' => [ 200 => [ 'schema' => [ 'type' => 'object', 'properties' => [ 'requestId' => [ 'description' => '请求ID', 'type' => 'string', 'example' => '3B7E42BD-1D63-2F6B-C8E0-41BACEA76EEB', ], 'result' => [ 'description' => '返回结果', 'type' => 'array', 'items' => [ 'type' => 'object', 'properties' => [ 'endpoint' => [ 'description' => '接入点地址', 'type' => 'string', 'example' => 'opensearch.cn-hangzhou.aliyuncs.com', ], 'regionId' => [ 'description' => '区域ID', 'type' => 'string', 'example' => 'cn-hangzhou', ], 'localName' => [ 'description' => '区域名称', 'type' => 'string', 'example' => '华东1（杭州）', ], 'consoleUrl' => [ 'description' => '控制台地址', 'type' => 'string', 'example' => 'https://opensearch-cn-hangzhou.console.aliyun.com', ], ], ], ], ], ], ], '5XX' => [ 'schema' => [ 'type' => 'object', 'properties' => [ 'code' => [ 'type' => 'string', ], 'message' => [ 'type' => 'string', ], 'requestId' => [ 'type' => 'string', ], 'httpCode' => [ 'type' => 'integer', 'format' => 'int32', ], ], ], ], ], 'responseDemo' => '[{"type":"json","example":"{\\n \\"requestId\\": \\"3B7E42BD-1D63-2F6B-C8E0-41BACEA76EEB\\",\\n \\"result\\": [\\n {\\n \\"endpoint\\": \\"opensearch.cn-hangzhou.aliyuncs.com\\",\\n \\"regionId\\": \\"cn-hangzhou\\",\\n \\"localName\\": \\"华东1（杭州）\\",\\n \\"consoleUrl\\": \\"https://opensearch-cn-hangzhou.console.aliyun.com\\"\\n }\\n ]\\n}","errorExample":""},{"type":"xml","example":"3B7E42BD-1D63-2F6B-C8E0-41BACEA76EEB\\n\\n cn-hangzhou\\n 华东1（杭州）\\n opensearch.cn-hangzhou.aliyuncs.com\\n https://opensearch-cn-hangzhou.console.aliyun.com\\n\\n\\n cn-shanghai\\n 华东2（上海）\\n opensearch.cn-shanghai.aliyuncs.com\\n https://opensearch-cn-shanghai.console.aliyun.com\\n\\n\\n cn-qingdao\\n 华北1（青岛）\\n opensearch.cn-qingdao.aliyuncs.com\\n https://opensearch-cn-qingdao.console.aliyun.com\\n\\n\\n cn-beijing\\n 华北2（北京）\\n opensearch.cn-beijing.aliyuncs.com\\n https://opensearch-cn-beijing.console.aliyun.com\\n\\n\\n cn-zhangjiakou\\n 华北3（张家口）\\n opensearch.cn-zhangjiakou.aliyuncs.com\\n https://opensearch-cn-zhangjiakou.console.aliyun.com\\n\\n\\n cn-shenzhen\\n 华南1（深圳）\\n opensearch.cn-shenzhen.aliyuncs.com\\n https://opensearch-cn-shenzhen.console.aliyun.com\\n\\n\\n ap-southeast-1\\n 新加坡\\n opensearch.ap-southeast-1.aliyuncs.com\\n https://opensearch-ap-southeast-1.console.aliyun.com\\n\\n\\n cn-internal\\n 内网1（中心）\\n opensearch.cn-zhangbei-center.aliyuncs.com\\n https://opensearch-cn-shanghai-in.console.aliyun.com\\n\\n\\n cn-zhangbei-in\\n 内网2（张北）\\n opensearch.cn-zhangbei-in.aliyuncs.com\\n https://opensearch-cn-zhangbei-in.console.aliyun.com\\n\\n\\n us-west-1-in\\n 内网3（美国）\\n opensearch.innet-us.aliyuncs.com\\n http://opensearch-us-in.console.aliyun.com\\n\\n\\n rus-west-1-in\\n 内网4（俄罗斯）\\n \\n https://opensearch-rg-ru-in.console.aliyun.com\\n\\n\\n cn-daily\\n 内网日常\\n opensearch.cn-daily.aliyuncs.com\\n https://opensearch-cn-daily.console.aliyun.com\\n\\n\\n pre-hangzhou\\n 杭州预发\\n opensearch.pre-hangzhou.aliyuncs.com\\n https://opensearch-pre-hangzhou.console.aliyun.com\\n","errorExample":""}]', 'title' => '查询可以使用的阿里云地域', 'summary' => '获取所有区域的接入地址。', ], 'DescribeDataCollction' => [ 'path' => '/v4/openapi/app-groups/{appGroupIdentity}/data-collections/{dataCollectionIdentity}', 'methods' => [ 'get', ], 'schemes' => [ 'http', 'https', ], 'security' => [ [ 'AK' => [], ], ], 'operationType' => 'read', 'deprecated' => false, 'systemTags' => [ 'operationType' => 'get', 'abilityTreeCode' => '55174', 'abilityTreeNodes' => [ 'FEATUREopensearch4M1CGO', ], ], 'parameters' => [ [ 'name' => 'appGroupIdentity', 'in' => 'path', 'schema' => [ 'description' => '应用名称', 'type' => 'string', 'required' => true, 'docRequired' => true, 'example' => 'my_app_group_name', ], ], [ 'name' => 'dataCollectionIdentity', 'in' => 'path', 'schema' => [ 'description' => '数据采集ID', 'type' => 'string', 'required' => true, 'docRequired' => true, 'example' => '286', ], ], ], 'responses' => [ 200 => [ 'schema' => [ 'type' => 'object', 'properties' => [ 'requestId' => [ 'description' => '请求ID', 'type' => 'string', 'example' => '72FAD77B-83F9-F393-BA8E-5834E2427BF8', ], 'result' => [ 'description' => '数据采集信息', 'type' => 'object', 'properties' => [ 'created' => [ 'description' => '创建时间', 'type' => 'integer', 'format' => 'int32', 'example' => '1581065837', ], 'dataCollectionType' => [ 'description' => '数据采集的类型'."\n" .'- behavior 行为'."\n" .'- item_info 项目信息'."\n" .'- industry_specific 工业特性', 'type' => 'string', 'example' => 'BEHAVIOR', ], 'type' => [ 'description' => '数据采集端的类型'."\n" .'- server'."\n" .'- web'."\n" .'- app'."\n" .'注：目前只支持 server', 'type' => 'string', 'example' => 'server', ], 'industryName' => [ 'description' => '行业名称'."\n" .'- general 通用'."\n" .'- ecommerce 电商', 'type' => 'string', 'example' => 'GENERAL', ], 'status' => [ 'description' => '状态'."\n" .'- 0 未开通'."\n" .'- 1 开通中'."\n" .'- 2 开通成功'."\n" .'- 3 开通失败', 'type' => 'integer', 'format' => 'int32', 'example' => '2', ], 'updated' => [ 'description' => '更新时间', 'type' => 'integer', 'format' => 'int32', 'example' => '1581065904', ], 'name' => [ 'description' => '数据采集名称', 'type' => 'string', 'example' => 'os_function_test_v1', ], 'sundialId' => [ 'description' => 'sundial的ID', 'type' => 'string', 'example' => '1755', ], 'id' => [ 'description' => '数据采集ID', 'type' => 'string', 'example' => '286', ], ], ], ], ], ], '5XX' => [ 'schema' => [ 'type' => 'object', 'properties' => [ 'code' => [ 'type' => 'string', ], 'httpCode' => [ 'type' => 'integer', 'format' => 'int32', ], 'requestId' => [ 'type' => 'string', ], 'message' => [ 'type' => 'string', ], ], ], ], ], 'responseDemo' => '[{"type":"json","example":"{\\n \\"requestId\\": \\"72FAD77B-83F9-F393-BA8E-5834E2427BF8\\",\\n \\"result\\": {\\n \\"created\\": 1581065837,\\n \\"dataCollectionType\\": \\"BEHAVIOR\\",\\n \\"type\\": \\"server\\",\\n \\"industryName\\": \\"GENERAL\\",\\n \\"status\\": 2,\\n \\"updated\\": 1581065904,\\n \\"name\\": \\"os_function_test_v1\\",\\n \\"sundialId\\": \\"1755\\",\\n \\"id\\": \\"286\\"\\n }\\n}","errorExample":""},{"type":"xml","example":"72FAD77B-83F9-F393-BA8E-5834E2427BF8\\n\\n 286\\n os_function_test_v1\\n server\\n 2\\n BEHAVIOR\\n GENERAL\\n 1581065837\\n 1581065904\\n 1755\\n","errorExample":""}]', 'title' => 'DescribeDataCollection', 'summary' => '获取指定应用的数据采集详情。', 'requestParamsDescription' => ' ', 'responseParamsDescription' => ' ', 'extraInfo' => ' ', ], 'ListDataCollections' => [ 'path' => '/v4/openapi/app-groups/{appGroupIdentity}/data-collections', 'methods' => [ 'get', ], 'schemes' => [ 'http', 'https', ], 'security' => [ [ 'AK' => [], ], ], 'operationType' => 'read', 'deprecated' => false, 'systemTags' => [ 'operationType' => 'get', ], 'parameters' => [ [ 'name' => 'appGroupIdentity', 'in' => 'path', 'schema' => [ 'description' => '应用名称', 'type' => 'string', 'required' => true, 'docRequired' => true, 'example' => 'my_app_group_name', ], ], [ 'name' => 'pageNumber', 'in' => 'query', 'schema' => [ 'description' => '页码，默认 pageNumber = 1', 'type' => 'integer', 'format' => 'int32', 'required' => false, 'example' => '1', ], ], [ 'name' => 'pageSize', 'in' => 'query', 'schema' => [ 'description' => '每页返回数目，默认 pageSize = 10', 'type' => 'integer', 'format' => 'int32', 'required' => false, 'example' => '10', ], ], ], 'responses' => [ 200 => [ 'schema' => [ 'type' => 'object', 'properties' => [ 'totalCount' => [ 'description' => '总条数', 'type' => 'integer', 'format' => 'int32', 'example' => '1', ], 'requestId' => [ 'description' => '请求ID', 'type' => 'string', 'example' => '959D8782-B130-95EB-86CC-1F6ED447981F', ], 'result' => [ 'description' => '数据采集信息'."\n" ."\n" .'参考：[DataCollection](~~173605~~)', 'type' => 'array', 'items' => [ 'type' => 'object', 'properties' => [ 'created' => [ 'description' => '创建时间', 'type' => 'integer', 'format' => 'int32', 'example' => '1581065837', ], 'dataCollectionType' => [ 'description' => '数据采集的类型'."\n" ."\n" .'- behavior 行为'."\n" .'- item_info 项目信息'."\n" .'- industry_specific 工业特性', 'type' => 'string', 'example' => 'BEHAVIOR', ], 'type' => [ 'description' => '数据采集端的类型'."\n" ."\n" .'- server'."\n" .'- web'."\n" .'- app'."\n" ."\n" .'注：目前只支持 server', 'type' => 'string', 'example' => 'server', ], 'industryName' => [ 'description' => '行业名称'."\n" ."\n" .'- general 通用'."\n" .'- ecommerce 电商', 'type' => 'string', 'example' => 'GENERAL', ], 'status' => [ 'description' => '状态'."\n" ."\n" .'- 0 未开通'."\n" .'- 1 开通中'."\n" .'- 2 开通成功'."\n" .'- 3 开通失败', 'type' => 'integer', 'format' => 'int32', 'example' => '2', ], 'updated' => [ 'description' => '更新时间', 'type' => 'integer', 'format' => 'int32', 'example' => '1581065904', ], 'name' => [ 'description' => '数据采集名称', 'type' => 'string', 'example' => 'os_function_test_v1', ], 'sundialId' => [ 'description' => 'sundial的ID', 'type' => 'string', 'example' => '1755', ], 'id' => [ 'description' => '数据采集ID', 'type' => 'string', 'example' => '286', ], ], ], ], ], ], ], '5XX' => [ 'schema' => [ 'type' => 'object', 'properties' => [ 'code' => [ 'type' => 'string', ], 'httpCode' => [ 'type' => 'integer', 'format' => 'int32', ], 'requestId' => [ 'type' => 'string', ], 'message' => [ 'type' => 'string', ], ], ], ], ], 'responseDemo' => '[{"type":"json","example":"{\\n \\"totalCount\\": 1,\\n \\"requestId\\": \\"959D8782-B130-95EB-86CC-1F6ED447981F\\",\\n \\"result\\": [\\n {\\n \\"created\\": 1581065837,\\n \\"dataCollectionType\\": \\"BEHAVIOR\\",\\n \\"type\\": \\"server\\",\\n \\"industryName\\": \\"GENERAL\\",\\n \\"status\\": 2,\\n \\"updated\\": 1581065904,\\n \\"name\\": \\"os_function_test_v1\\",\\n \\"sundialId\\": \\"1755\\",\\n \\"id\\": \\"286\\"\\n }\\n ]\\n}","errorExample":""},{"type":"xml","example":"959D8782-B130-95EB-86CC-1F6ED447981F\\n1\\n\\n 286\\n os_function_test_v1\\n server\\n 2\\n BEHAVIOR\\n GENERAL\\n 1581065837\\n 1581065904\\n 1755\\n","errorExample":""}]', 'title' => 'ListDataCollections', 'summary' => '获取OpenSearch应用的数据采集清单。', 'requestParamsDescription' => ' ', 'responseParamsDescription' => ' ', 'extraInfo' => ' ', ], 'RemoveDataCollection' => [ 'path' => '/v4/openapi/app-groups/{appGroupIdentity}/data-collections/{dataCollectionIdentity}', 'methods' => [ 'delete', ], 'schemes' => [ 'http', 'https', ], 'security' => [ [ 'AK' => [], ], ], 'operationType' => 'write', 'deprecated' => false, 'systemTags' => [ 'operationType' => 'delete', 'abilityTreeCode' => '55250', 'abilityTreeNodes' => [ 'FEATUREopensearchAROC40', ], ], 'parameters' => [ [ 'name' => 'appGroupIdentity', 'in' => 'path', 'schema' => [ 'description' => '应用名称', 'type' => 'string', 'required' => true, 'docRequired' => true, 'example' => '“my_app_group_name”', ], ], [ 'name' => 'dataCollectionIdentity', 'in' => 'path', 'schema' => [ 'description' => '数据采集ID', 'type' => 'string', 'required' => true, 'docRequired' => true, 'example' => '286', ], ], ], 'responses' => [ 200 => [ 'schema' => [ 'type' => 'object', 'properties' => [ 'result' => [ 'description' => '—', 'type' => 'string', 'example' => '{}', ], 'requestId' => [ 'description' => '请求ID', 'type' => 'string', 'example' => 'D77D0DAF-790D-F5F5-A9C0-133738165014', ], ], ], ], '5XX' => [ 'schema' => [ 'type' => 'object', 'properties' => [ 'code' => [ 'type' => 'string', ], 'message' => [ 'type' => 'string', ], 'requestId' => [ 'type' => 'string', ], 'httpCode' => [ 'type' => 'integer', 'format' => 'int32', ], ], ], ], ], 'responseDemo' => '[{"type":"json","example":"{\\n \\"result\\": \\"{}\\",\\n \\"requestId\\": \\"D77D0DAF-790D-F5F5-A9C0-133738165014\\"\\n}","errorExample":""},{"type":"xml","example":"D77D0DAF-790D-F5F5-A9C0-133738165014\\n","errorExample":""}]', 'title' => 'RemoveDataCollection', 'summary' => '关闭数据采集。', 'requestParamsDescription' => ' ', 'responseParamsDescription' => ' ', 'extraInfo' => ' ', ], 'UntagResources' => [ 'summary' => '删标签接口。', 'path' => '/v4/openapi/resource-tags', 'methods' => [ 'delete', ], 'schemes' => [ 'http', 'https', ], 'security' => [ [ 'AK' => [], ], ], 'produces' => [ 'application/json', ], 'operationType' => 'readAndWrite', 'deprecated' => false, 'systemTags' => [ 'operationType' => 'none', 'abilityTreeCode' => '152938', 'abilityTreeNodes' => [ 'FEATUREopensearch447AAX', ], ], 'parameters' => [ [ 'name' => 'resourceType', 'in' => 'query', 'schema' => [ 'title' => '资源类型', 'description' => '资源类型', 'type' => 'string', 'required' => true, 'example' => 'ProductVersion', ], ], [ 'name' => 'resourceId', 'in' => 'query', 'style' => 'json', 'schema' => [ 'title' => '资源ID,最多 50个子项', 'description' => '资源ID,最多 50个子项', 'type' => 'array', 'items' => [ 'description' => '查询的资源的id列表。resource id与tags应至少存在一个。', 'type' => 'string', 'required' => false, 'example' => '55111', ], 'required' => true, ], ], [ 'name' => 'tagKey', 'in' => 'query', 'style' => 'json', 'schema' => [ 'title' => '对应标签键列表，最多包含20个子项', 'description' => '对应标签键列表，最多包含20个子项', 'type' => 'array', 'items' => [ 'description' => '业务tagKey', 'type' => 'string', 'required' => false, 'example' => 'GENIE_FUNCTION', ], 'required' => false, ], ], [ 'name' => 'all', 'in' => 'query', 'schema' => [ 'title' => '是否全部删除，只针对tags为空时有效。取值范围： true false True False 默认是 false', 'description' => '是否全部删除，只针对tags为空时有效。取值范围： true false True False 默认是 false', 'type' => 'boolean', 'required' => false, 'example' => 'true', ], ], ], 'responses' => [ 200 => [ 'schema' => [ 'description' => '响应体', 'type' => 'object', 'properties' => [ 'tequestId' => [ 'description' => '请求id', 'type' => 'string', 'example' => '1-B-2-V', ], ], ], ], ], 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"tequestId\\": \\"1-B-2-V\\"\\n}","type":"json"}]', 'title' => '删除标签', ], 'ListTagResources' => [ 'summary' => '查标签接口。', 'path' => '/v4/openapi/resource-tags', 'methods' => [ 'get', ], 'schemes' => [ 'http', 'https', ], 'security' => [ [ 'AK' => [], ], ], 'produces' => [ 'application/json', ], 'operationType' => 'read', 'deprecated' => false, 'systemTags' => [ 'operationType' => 'get', 'abilityTreeCode' => '152935', 'abilityTreeNodes' => [ 'FEATUREopensearchGVH0IN', 'FEATUREopensearch447AAX', 'FEATUREopensearch5OZOSP', ], ], 'parameters' => [ [ 'name' => 'resourceType', 'in' => 'query', 'schema' => [ 'title' => '资源类型', 'description' => '资源类型', 'type' => 'string', 'required' => true, 'example' => 'BIGDATA', ], ], [ 'name' => 'resourceId', 'in' => 'query', 'style' => 'json', 'schema' => [ 'title' => '资源ID,最多 50个子项', 'description' => '资源ID,最多 50个子项', 'type' => 'array', 'items' => [ 'description' => '查询的资源的id列表。resource id与tags应至少存在一个。', 'type' => 'string', 'required' => false, 'example' => 'i-bp185wwblwfvh1a1y1me', ], 'required' => false, ], ], [ 'name' => 'tag', 'in' => 'query', 'style' => 'json', 'schema' => [ 'title' => '对应新增标签列表，最多包含20个子项', 'description' => '对应新增标签列表，最多包含20个子项', 'type' => 'array', 'items' => [ 'description' => '实体类型的内部英文表示', 'type' => 'object', 'properties' => [ 'key' => [ 'title' => '标签键', 'description' => '标签键', 'type' => 'string', 'required' => false, 'example' => 'bm', ], 'value' => [ 'title' => '标签值', 'description' => '标签值', 'type' => 'string', 'required' => false, 'example' => 'Uefi', ], ], 'required' => false, ], 'required' => false, ], ], [ 'name' => 'nextToken', 'in' => 'query', 'schema' => [ 'title' => '下一个查询开始Token', 'description' => '下一个查询开始Token', 'type' => 'string', 'required' => false, 'example' => '60', ], ], ], 'responses' => [ 200 => [ 'schema' => [ 'type' => 'object', 'properties' => [ 'requestId' => [ 'title' => '请求id', 'description' => '请求id', 'type' => 'string', 'example' => 'D77D0DAF-790D-F5F5-A9C0-133738165014', ], 'nextToken' => [ 'title' => '下一个查询开始Token', 'description' => '下一个查询开始Token', 'type' => 'string', 'example' => '20', ], 'result' => [ 'title' => '资源列表', 'description' => '资源列表', 'type' => 'array', 'items' => [ 'description' => '返回结果', 'type' => 'object', 'properties' => [ 'tagKey' => [ 'title' => '标签键', 'description' => '标签键', 'type' => 'string', 'example' => 'GENIE_FUNCTION', ], 'tagValue' => [ 'title' => '标签值', 'description' => '标签值', 'type' => 'string', 'example' => 'ALLOW', ], 'resourceId' => [ 'title' => '资源ID', 'description' => '资源ID', 'type' => 'string', 'example' => '54041', ], 'resourceType' => [ 'title' => '资源类型', 'description' => '资源类型', 'type' => 'string', 'example' => 'hostGroup', ], ], ], ], ], ], ], ], 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"requestId\\": \\"D77D0DAF-790D-F5F5-A9C0-133738165014\\",\\n \\"nextToken\\": \\"20\\",\\n \\"result\\": [\\n {\\n \\"tagKey\\": \\"GENIE_FUNCTION\\",\\n \\"tagValue\\": \\"ALLOW\\",\\n \\"resourceId\\": \\"54041\\",\\n \\"resourceType\\": \\"hostGroup\\"\\n }\\n ]\\n}","type":"json"}]', 'title' => '查标签列表', ], 'TagResources' => [ 'summary' => '打标签接口。', 'path' => '/v4/openapi/resource-tags', 'methods' => [ 'post', ], 'schemes' => [ 'http', 'https', ], 'security' => [ [ 'AK' => [], ], ], 'produces' => [ 'application/json', ], 'operationType' => 'readAndWrite', 'deprecated' => false, 'systemTags' => [ 'operationType' => 'none', 'abilityTreeCode' => '152937', 'abilityTreeNodes' => [ 'FEATUREopensearch447AAX', ], ], 'parameters' => [ [ 'name' => 'body', 'in' => 'body', 'style' => 'json', 'schema' => [ 'description' => '请求参数。', 'type' => 'object', 'properties' => [ 'resourceType' => [ 'title' => '资源类型', 'description' => '资源类型', 'type' => 'string', 'required' => true, 'example' => 'ProductVersion', ], 'resourceId' => [ 'title' => '资源ID,最多 50个子项', 'description' => '资源ID,最多 50个子项', 'type' => 'array', 'items' => [ 'description' => '资源的id。', 'type' => 'string', 'required' => false, 'example' => '68968', ], 'required' => true, ], 'tag' => [ 'title' => '对应新增标签列表，最多包含20个子项', 'description' => '对应新增标签列表，最多包含20个子项', 'type' => 'array', 'items' => [ 'description' => '实体类型的内部英文表示', 'type' => 'object', 'properties' => [ 'key' => [ 'title' => '标签键', 'description' => '标签键', 'type' => 'string', 'required' => false, 'example' => 'cloud_manage', ], 'value' => [ 'title' => '标签值', 'description' => '标签值', 'type' => 'string', 'required' => false, 'example' => '31261301', ], ], 'required' => false, ], 'required' => true, ], ], 'required' => false, ], ], ], 'responses' => [ 200 => [ 'schema' => [ 'description' => '响应体', 'type' => 'object', 'properties' => [ 'requestId' => [ 'title' => '请求id', 'description' => '请求id', 'type' => 'string', 'example' => 'ABCDEFGH', ], ], ], ], ], 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"requestId\\": \\"ABCDEFGH\\"\\n}","type":"json"}]', 'title' => '为实例打标签', ], 'GetFunctionResource' => [ 'summary' => '获取指定名称的算法资源。', 'path' => '/v4/openapi/app-groups/{appGroupIdentity}/functions/{functionName}/resources/{resourceName}', 'methods' => [ 'get', ], 'schemes' => [ 'http', 'https', ], 'security' => [ [ 'AK' => [], ], ], 'produces' => [ 'application/json', ], 'operationType' => 'read', 'deprecated' => false, 'systemTags' => [ 'operationType' => 'get', 'abilityTreeCode' => '173353', 'abilityTreeNodes' => [ 'FEATUREopensearchZAE4HR', ], ], 'parameters' => [ [ 'name' => 'appGroupIdentity', 'in' => 'path', 'schema' => [ 'title' => '应用ID', 'description' => '应用ID', 'type' => 'string', 'required' => true, 'example' => 'my_app_group_name', ], ], [ 'name' => 'functionName', 'in' => 'path', 'schema' => [ 'title' => '功能名称', 'description' => '功能名称', 'type' => 'string', 'required' => true, 'example' => 'rank', ], ], [ 'name' => 'resourceName', 'in' => 'path', 'schema' => [ 'title' => '实例名称', 'description' => '实例名称', 'type' => 'string', 'required' => true, 'example' => 'fg_json', ], ], [ 'name' => 'output', 'in' => 'query', 'schema' => [ 'title' => '输出等级', 'description' => '输出等级', 'type' => 'string', 'required' => false, 'example' => 'detail', 'enum' => [ 'simple', 'normal', 'detail', ], ], ], ], 'responses' => [ 200 => [ 'schema' => [ 'type' => 'object', 'properties' => [ 'Status' => [ 'description' => '状态码'."\n" ."\n" .'- OK 成功'."\n" .'- FAIL 失败', 'type' => 'string', 'example' => 'OK', ], 'HttpCode' => [ 'description' => 'HTTP状态码', 'type' => 'integer', 'format' => 'int64', 'example' => '200', ], 'RequestId' => [ 'description' => '请求ID', 'type' => 'string', 'example' => 'E215C843-0795-5293-AC9A-14FE0723E890', ], 'Message' => [ 'description' => '返回的错误信息', 'type' => 'string', 'example' => 'Resource not exist.', ], 'Code' => [ 'description' => '返回的错误码（没有错误为空）', 'type' => 'string', 'example' => 'Resource.NotExist', ], 'Result' => [ 'description' => '返回结果', 'type' => 'object', 'properties' => [ 'CreateTime' => [ 'description' => '创建时间 （单位毫秒）', 'type' => 'integer', 'format' => 'int64', 'example' => '1234', ], 'Data' => [ 'description' => '资源数据，不同resourceType对应的data结构不同', 'type' => 'object', 'properties' => [ 'Content' => [ 'description' => 'raw_file类型资源对应的文件内容', 'type' => 'string', 'example' => 'abc', ], 'Generators' => [ 'description' => 'feature_generator类型资源对应的特征生成列表', 'type' => 'array', 'items' => [ 'description' => '特征生成描述', 'type' => 'object', 'properties' => [ 'Generator' => [ 'description' => '特征生成的类型', 'type' => 'string', 'example' => 'id', ], 'Input' => [ 'description' => '输入', 'type' => 'object', 'properties' => [ 'Features' => [ 'description' => '输入特征列表', 'type' => 'array', 'items' => [ 'description' => '输入特征', 'type' => 'object', 'properties' => [ 'Name' => [ 'description' => '特征名', 'type' => 'string', 'example' => 'system_item_id', ], 'Type' => [ 'description' => '特征类型', 'type' => 'string', 'example' => 'item', ], ], ], ], ], ], 'Output' => [ 'description' => '输出的特征名', 'type' => 'string', 'example' => 'output_feature_name', ], ], ], ], ], ], 'Description' => [ 'description' => '资源描述', 'type' => 'string', 'example' => '""', ], 'FunctionName' => [ 'description' => '功能名称', 'type' => 'string', 'example' => 'rank', ], 'ModifyTime' => [ 'description' => '修改时间（单位毫秒）', 'type' => 'integer', 'format' => 'int64', 'example' => '1234', ], 'ReferencedInstances' => [ 'description' => '引用的算法实例名称列表', 'type' => 'array', 'items' => [ 'description' => '实例名称', 'type' => 'string', 'example' => 'instance1', ], ], 'ResourceName' => [ 'description' => '资源名称', 'type' => 'string', 'example' => 'fg_json', ], 'ResourceType' => [ 'description' => '资源类型', 'type' => 'string', 'example' => 'raw_file', ], ], ], 'Latency' => [ 'description' => 'api请求耗时（单位毫秒）', 'type' => 'number', 'format' => 'double', 'example' => '123', ], ], ], ], ], 'staticInfo' => [ 'returnType' => 'synchronous', ], 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"Status\\": \\"OK\\",\\n \\"HttpCode\\": 200,\\n \\"RequestId\\": \\"E215C843-0795-5293-AC9A-14FE0723E890\\",\\n \\"Message\\": \\"Resource not exist.\\",\\n \\"Code\\": \\"Resource.NotExist\\",\\n \\"Result\\": {\\n \\"CreateTime\\": 1234,\\n \\"Data\\": {\\n \\"Content\\": \\"abc\\",\\n \\"Generators\\": [\\n {\\n \\"Generator\\": \\"id\\",\\n \\"Input\\": {\\n \\"Features\\": [\\n {\\n \\"Name\\": \\"system_item_id\\",\\n \\"Type\\": \\"item\\"\\n }\\n ]\\n },\\n \\"Output\\": \\"output_feature_name\\"\\n }\\n ]\\n },\\n \\"Description\\": \\"\\\\\\"\\\\\\"\\",\\n \\"FunctionName\\": \\"rank\\",\\n \\"ModifyTime\\": 1234,\\n \\"ReferencedInstances\\": [\\n \\"instance1\\"\\n ],\\n \\"ResourceName\\": \\"fg_json\\",\\n \\"ResourceType\\": \\"raw_file\\"\\n },\\n \\"Latency\\": 123\\n}","type":"json"}]', 'title' => '获取算法资源', ], 'ListFunctionResources' => [ 'summary' => '获取算法资源列表。', 'path' => '/v4/openapi/app-groups/{appGroupIdentity}/functions/{functionName}/resources', 'methods' => [ 'get', ], 'schemes' => [ 'http', 'https', ], 'security' => [ [ 'AK' => [], ], ], 'produces' => [ 'application/json', ], 'operationType' => 'read', 'deprecated' => false, 'systemTags' => [ 'operationType' => 'list', 'abilityTreeCode' => '173357', 'abilityTreeNodes' => [ 'FEATUREopensearch447AAX', ], ], 'parameters' => [ [ 'name' => 'appGroupIdentity', 'in' => 'path', 'schema' => [ 'title' => '应用ID', 'description' => '应用ID', 'type' => 'string', 'required' => true, 'example' => 'my_app_group_name', ], ], [ 'name' => 'functionName', 'in' => 'path', 'schema' => [ 'title' => '功能名称', 'description' => '功能名称', 'type' => 'string', 'required' => true, 'example' => 'rank', ], ], [ 'name' => 'resourceType', 'in' => 'query', 'schema' => [ 'title' => '资源类型', 'description' => '资源类型', 'type' => 'string', 'required' => false, 'enumValueTitles' => [ 'feature_generator' => 'feature_generator', 'raw_file' => 'raw_file', ], 'example' => 'feature_generator', ], ], [ 'name' => 'output', 'in' => 'query', 'schema' => [ 'title' => '输出等级', 'description' => '输出等级', 'type' => 'string', 'required' => false, 'example' => 'detail', 'enum' => [ 'simple', 'normal', 'detail', ], ], ], [ 'name' => 'pageNumber', 'in' => 'query', 'schema' => [ 'title' => '页码', 'description' => '页码', 'type' => 'integer', 'format' => 'int32', 'required' => false, 'example' => '1', 'default' => '1', ], ], [ 'name' => 'pageSize', 'in' => 'query', 'schema' => [ 'title' => '分页大小', 'description' => '分页大小', 'type' => 'integer', 'format' => 'int32', 'required' => false, 'example' => '10', 'default' => '10', ], ], ], 'responses' => [ 200 => [ 'schema' => [ 'type' => 'object', 'properties' => [ 'Status' => [ 'description' => '请求状态: OK/FAIL', 'type' => 'string', 'example' => 'OK', ], 'HttpCode' => [ 'description' => 'HTTP状态码', 'type' => 'integer', 'format' => 'int64', 'example' => '200', ], 'TotalCount' => [ 'description' => '符合要求的总记录数', 'type' => 'integer', 'format' => 'int64', 'example' => '2', ], 'RequestId' => [ 'description' => '请求ID', 'type' => 'string', 'example' => '"3A809095-C554-5CF5-8FCE-BE19D4673790"', ], 'Message' => [ 'description' => '返回的错误信息', 'type' => 'string', 'example' => 'Invalid resource name.', ], 'Code' => [ 'description' => '返回的错误码（没有错误为空）', 'type' => 'string', 'example' => 'Resource.InvalidResourceName', ], 'Result' => [ 'description' => '返回结果', 'type' => 'array', 'items' => [ 'description' => '结果体', 'type' => 'object', 'properties' => [ 'CreateTime' => [ 'description' => '创建时间 （单位毫秒）', 'type' => 'integer', 'format' => 'int64', 'example' => '1234', ], 'Data' => [ 'description' => '资源数据，不同resourceType对应的data结构不同', 'type' => 'object', 'properties' => [ 'Content' => [ 'description' => 'raw_file类型资源对应的文件内容', 'type' => 'string', 'example' => '"abc"', ], 'Generators' => [ 'description' => 'feature_generator类型资源对应的特征生成列表', 'type' => 'array', 'items' => [ 'description' => '特征生成描述', 'type' => 'object', 'properties' => [ 'Generator' => [ 'description' => '特征生成的类型', 'type' => 'string', 'example' => 'combo', ], 'Input' => [ 'description' => '输入', 'type' => 'object', 'properties' => [ 'Features' => [ 'description' => '输入特征列表', 'type' => 'array', 'items' => [ 'description' => '输入特征', 'type' => 'object', 'properties' => [ 'Name' => [ 'description' => '特征名', 'type' => 'string', 'example' => 'system_item_id', ], 'Type' => [ 'description' => '特征类型', 'type' => 'string', 'enumValueTitles' => [ 'item' => 'item', 'user' => 'user', ], 'example' => 'item', ], ], ], ], ], ], 'Output' => [ 'description' => '输出的特征名', 'type' => 'string', 'example' => 'feature1', ], ], ], ], ], ], 'Description' => [ 'description' => '资源描述', 'type' => 'string', 'example' => 'resource description', ], 'FunctionName' => [ 'description' => '功能名称', 'type' => 'string', 'example' => 'rank', ], 'ModifyTime' => [ 'description' => '修改时间（单位毫秒）', 'type' => 'integer', 'format' => 'int64', 'example' => '1234', ], 'ReferencedInstances' => [ 'description' => '引用的算法实例名称列表', 'type' => 'array', 'items' => [ 'description' => '实例名称', 'type' => 'string', 'example' => 'rank_model1', ], ], 'ResourceName' => [ 'description' => '资源名称', 'type' => 'string', 'example' => 'fg_json', ], 'ResourceType' => [ 'description' => '资源类型', 'type' => 'string', 'example' => 'feature_generator', ], ], ], ], 'Latency' => [ 'description' => '请求耗时（单位毫秒）', 'type' => 'number', 'format' => 'double', 'example' => '123', ], ], ], ], ], 'staticInfo' => [ 'returnType' => 'synchronous', ], 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"Status\\": \\"OK\\",\\n \\"HttpCode\\": 200,\\n \\"TotalCount\\": 2,\\n \\"RequestId\\": \\"\\\\\\"3A809095-C554-5CF5-8FCE-BE19D4673790\\\\\\"\\",\\n \\"Message\\": \\"Invalid resource name.\\",\\n \\"Code\\": \\"Resource.InvalidResourceName\\",\\n \\"Result\\": [\\n {\\n \\"CreateTime\\": 1234,\\n \\"Data\\": {\\n \\"Content\\": \\"\\\\\\"abc\\\\\\"\\",\\n \\"Generators\\": [\\n {\\n \\"Generator\\": \\"combo\\",\\n \\"Input\\": {\\n \\"Features\\": [\\n {\\n \\"Name\\": \\"system_item_id\\",\\n \\"Type\\": \\"item\\"\\n }\\n ]\\n },\\n \\"Output\\": \\"feature1\\"\\n }\\n ]\\n },\\n \\"Description\\": \\"resource description\\",\\n \\"FunctionName\\": \\"rank\\",\\n \\"ModifyTime\\": 1234,\\n \\"ReferencedInstances\\": [\\n \\"rank_model1\\"\\n ],\\n \\"ResourceName\\": \\"fg_json\\",\\n \\"ResourceType\\": \\"feature_generator\\"\\n }\\n ],\\n \\"Latency\\": 123\\n}","type":"json"}]', 'title' => '获取算法资源列表', ], 'DeleteFunctionResource' => [ 'summary' => '删除指定算法资源。', 'path' => '/v4/openapi/app-groups/{appGroupIdentity}/functions/{functionName}/resources/{resourceName}', 'methods' => [ 'delete', ], 'schemes' => [ 'http', 'https', ], 'security' => [ [ 'AK' => [], ], ], 'produces' => [ 'application/json', ], 'operationType' => 'write', 'deprecated' => false, 'systemTags' => [ 'operationType' => 'delete', 'abilityTreeCode' => '173355', 'abilityTreeNodes' => [ 'FEATUREopensearchBQB5UI', ], ], 'parameters' => [ [ 'name' => 'appGroupIdentity', 'in' => 'path', 'schema' => [ 'title' => '应用ID', 'description' => '应用ID', 'type' => 'string', 'required' => true, 'example' => 'my_app_group_name', ], ], [ 'name' => 'functionName', 'in' => 'path', 'schema' => [ 'title' => '功能名称', 'description' => '功能名称', 'type' => 'string', 'required' => true, 'example' => 'rank', ], ], [ 'name' => 'resourceName', 'in' => 'path', 'schema' => [ 'title' => '资源名称', 'description' => '资源名称', 'type' => 'string', 'required' => true, 'example' => 'fg_json', ], ], ], 'responses' => [ 200 => [ 'schema' => [ 'type' => 'object', 'properties' => [ 'Status' => [ 'description' => '状态码'."\n" ."\n" .'- OK 成功'."\n" .'- FAIL 失败', 'type' => 'string', 'example' => 'OK', ], 'HttpCode' => [ 'description' => 'HTTP状态码', 'type' => 'integer', 'format' => 'int64', 'example' => '200', ], 'RequestId' => [ 'description' => '请求ID', 'type' => 'string', 'example' => 'A4D487A9-A456-5AA5-A9C6-B7BF2889CF74', ], 'Message' => [ 'description' => '错误信息', 'type' => 'string', 'example' => '""', ], 'Code' => [ 'description' => '返回的错误码（没有错误为空）', 'type' => 'string', 'example' => '""', ], 'Latency' => [ 'description' => '请求耗时（单位毫秒）', 'type' => 'number', 'format' => 'double', 'example' => '123', ], ], ], ], ], 'staticInfo' => [ 'returnType' => 'synchronous', ], 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"Status\\": \\"OK\\",\\n \\"HttpCode\\": 200,\\n \\"RequestId\\": \\"A4D487A9-A456-5AA5-A9C6-B7BF2889CF74\\",\\n \\"Message\\": \\"\\\\\\"\\\\\\"\\",\\n \\"Code\\": \\"\\\\\\"\\\\\\"\\",\\n \\"Latency\\": 123\\n}","type":"json"}]', 'title' => '删除算法资源', ], 'UpdateFunctionResource' => [ 'summary' => '更新算法资源。', 'path' => '/v4/openapi/app-groups/{appGroupIdentity}/functions/{functionName}/resources/{resourceName}', 'methods' => [ 'put', ], 'schemes' => [ 'http', 'https', ], 'security' => [ [ 'AK' => [], ], ], 'consumes' => [ 'application/json', ], 'produces' => [ 'application/json', ], 'operationType' => 'write', 'deprecated' => false, 'systemTags' => [ 'operationType' => 'update', 'abilityTreeCode' => '173356', 'abilityTreeNodes' => [ 'FEATUREopensearchUIICM8', ], ], 'parameters' => [ [ 'name' => 'appGroupIdentity', 'in' => 'path', 'schema' => [ 'title' => '应用ID', 'description' => '应用ID', 'type' => 'string', 'required' => true, 'example' => 'my_app_group_name', ], ], [ 'name' => 'functionName', 'in' => 'path', 'schema' => [ 'title' => '功能名称', 'description' => '功能名称', 'type' => 'string', 'required' => true, 'example' => 'rank', ], ], [ 'name' => 'resourceName', 'in' => 'path', 'schema' => [ 'title' => '资源名称', 'description' => '资源名称', 'type' => 'string', 'required' => true, 'example' => 'fg_json', ], ], [ 'name' => 'body', 'in' => 'body', 'style' => 'json', 'schema' => [ 'description' => '请求体', 'type' => 'object', 'properties' => [ 'Data' => [ 'description' => '资源数据，不同resourceType对应的data结构不同', 'type' => 'object', 'properties' => [ 'Content' => [ 'description' => 'raw_file类型资源对应的文件内容', 'type' => 'string', 'required' => false, 'example' => 'abc', ], 'Generators' => [ 'description' => 'feature_generator类型资源对应的特征生成列表', 'type' => 'array', 'items' => [ 'description' => '特征生成描述', 'type' => 'object', 'properties' => [ 'Generator' => [ 'description' => '特征生成的类型', 'type' => 'string', 'required' => false, 'example' => 'combo', ], 'Input' => [ 'description' => '输入', 'type' => 'object', 'properties' => [ 'Features' => [ 'description' => '输入特征列表', 'type' => 'array', 'items' => [ 'description' => '输入特征', 'type' => 'object', 'properties' => [ 'Name' => [ 'description' => '特征名', 'type' => 'string', 'required' => false, 'example' => 'system_item_id', ], 'Type' => [ 'description' => '特征类型', 'type' => 'string', 'required' => false, 'example' => 'item', ], ], 'required' => false, ], 'required' => false, ], ], 'required' => false, ], 'Output' => [ 'description' => '输出的特征名', 'type' => 'string', 'required' => false, 'example' => 'feature1', ], ], 'required' => false, ], 'required' => false, ], ], 'required' => false, ], 'Description' => [ 'description' => '资源描述', 'type' => 'string', 'required' => false, 'example' => 'updated description', ], ], 'required' => false, ], ], ], 'responses' => [ 200 => [ 'schema' => [ 'type' => 'object', 'properties' => [ 'Status' => [ 'description' => '请求状态', 'type' => 'string', 'example' => 'OK', ], 'HttpCode' => [ 'description' => 'HTTP状态码', 'type' => 'integer', 'format' => 'int64', 'example' => '200', ], 'RequestId' => [ 'description' => '请求ID', 'type' => 'string', 'example' => '7E375703-5B12-5466-8B48-C4D01AE1291A', ], 'Message' => [ 'description' => '错误信息', 'type' => 'string', 'example' => 'Invalid request.', ], 'Code' => [ 'description' => '返回的错误码（没有错误为空）', 'type' => 'string', 'example' => 'InvalidRequest', ], 'Latency' => [ 'description' => '请求耗时（单位毫秒）', 'type' => 'number', 'format' => 'double', 'example' => '123', ], ], ], ], ], 'staticInfo' => [ 'returnType' => 'synchronous', ], 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"Status\\": \\"OK\\",\\n \\"HttpCode\\": 200,\\n \\"RequestId\\": \\"7E375703-5B12-5466-8B48-C4D01AE1291A\\",\\n \\"Message\\": \\"Invalid request.\\",\\n \\"Code\\": \\"InvalidRequest\\",\\n \\"Latency\\": 123\\n}","type":"json"}]', 'title' => '更新算法资源', 'description' => '根据资源名称更新资源信息，目前只支持data、description更新。', ], 'CreateAppGroupCredentials' => [ 'path' => '/v4/openapi/app-groups/{appGroupIdentity}/credentials', 'methods' => [ 'post', ], 'schemes' => [ 'http', 'https', ], 'security' => [ [ 'AK' => [], ], ], 'operationType' => 'readAndWrite', 'deprecated' => false, 'systemTags' => [ 'operationType' => 'create', 'abilityTreeCode' => '228583', 'abilityTreeNodes' => [ 'FEATUREopensearch1AJKH0', ], ], 'parameters' => [ [ 'name' => 'dryRun', 'in' => 'query', 'schema' => [ 'description' => '指定此次操作是否为 dry run，即只检查参数，不实际执行操作。', 'type' => 'boolean', 'required' => false, ], ], [ 'name' => 'body', 'in' => 'body', 'style' => 'json', 'schema' => [ 'description' => '请求体，包含凭据类型等信息。', 'type' => 'object', 'properties' => [ 'type' => [ 'description' => '凭据类型，如 api-key、account、invoke-key 或 api-token。创建 api-key 时写为 api-token。', 'type' => 'string', 'required' => false, 'example' => 'api-token', ], ], 'required' => false, ], ], [ 'name' => 'appGroupIdentity', 'in' => 'path', 'schema' => [ 'description' => '应用组标识符。', 'type' => 'string', 'required' => true, 'example' => 'app_group_123', ], ], ], 'responses' => [ 200 => [ 'schema' => [ 'title' => 'Schema of Response', 'description' => '成功响应的结构。', 'type' => 'object', 'properties' => [ 'requestId' => [ 'title' => 'Id of the request', 'description' => '请求唯一标识。', 'type' => 'string', 'example' => '1-2-3-4', ], 'result' => [ 'description' => '操作结果详情。', 'type' => 'object', 'properties' => [ 'appGroupId' => [ 'description' => '应用组ID。', 'type' => 'integer', 'format' => 'int64', 'example' => 'app_group_123', ], 'type' => [ 'description' => '凭据类型。', 'type' => 'string', 'example' => 'api-token', ], 'enabled' => [ 'description' => '凭据是否启用。', 'type' => 'boolean', ], 'token' => [ 'description' => '生成的凭据令牌。', 'type' => 'string', 'example' => 'generated_token_string', ], ], ], ], ], ], ], 'staticInfo' => [ 'returnType' => 'synchronous', ], 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"requestId\\": \\"1-2-3-4\\",\\n \\"result\\": {\\n \\"appGroupId\\": 0,\\n \\"type\\": \\"api-token\\",\\n \\"enabled\\": true,\\n \\"token\\": \\"generated_token_string\\"\\n }\\n}","type":"json"}]', 'title' => '创建应用组凭据', 'summary' => '按需创建指定应用组的访问凭据，支持dryRun模式预览操作。', ], ], 'endpoints' => [ [ 'regionId' => 'cn-qingdao', 'endpoint' => 'opensearch.cn-qingdao.aliyuncs.com', ], [ 'regionId' => 'cn-beijing', 'endpoint' => 'opensearch.cn-beijing.aliyuncs.com', ], [ 'regionId' => 'cn-zhangjiakou', 'endpoint' => 'opensearch.cn-zhangjiakou.aliyuncs.com', ], [ 'regionId' => 'cn-hangzhou', 'endpoint' => 'opensearch.cn-hangzhou.aliyuncs.com', ], [ 'regionId' => 'cn-shanghai', 'endpoint' => 'opensearch.cn-shanghai.aliyuncs.com', ], [ 'regionId' => 'cn-shenzhen', 'endpoint' => 'opensearch.cn-shenzhen.aliyuncs.com', ], [ 'regionId' => 'cn-hongkong', 'endpoint' => 'opensearch.cn-hongkong.aliyuncs.com', ], [ 'regionId' => 'ap-southeast-1', 'endpoint' => 'opensearch.ap-southeast-1.aliyuncs.com', ], [ 'regionId' => 'ap-southeast-5', 'endpoint' => 'opensearch.ap-southeast-5.aliyuncs.com', ], [ 'regionId' => 'us-east-1', 'endpoint' => 'opensearch.us-east-1.aliyuncs.com', ], [ 'regionId' => 'eu-central-1', 'endpoint' => 'opensearch.eu-central-1.aliyuncs.com', ], ], ];