应用实例
| OpenAPI 名称 | 描述 | 操作 |
|---|---|---|
| 应用管理 | ||
CreateAppGroup | 创建一个OpenSearch应用 | 查看文档去调试 |
| ListAppGroups | 获取OpenSearch应用列表 | 查看文档去调试 |
| RenewAppGroup | 为应用续费（续费暂不支持API调用，请在控制台操作续费） | 查看文档去调试 |
| ModifyAppGroup | 修改 OpenSearch 应用属性或设置应用在线版本 | 查看文档去调试 |
| ModifyAppGroupQuota | 修改 OpenSearch 应用配额 | 查看文档去调试 |
| RemoveAppGroup | 删除一个OpenSearch应用 | 查看文档去调试 |
| 应用版本 | ||
| CreateApp | 创建一个OpenSearch应用版本 | 查看文档去调试 |
| DescribeApps | 获取一个 OpenSearch 应用的版本列表 | 查看文档去调试 |
| DescribeApp | 查看一个 OpenSearch 应用版本详情 | 查看文档去调试 |
| DescribeAppStatistics | 获取 OpenSearch 应用版本的统计结果 | 查看文档去调试 |
| RemoveApp | 删除一个 OpenSearch应用版本 | 查看文档去调试 |
实例周边
| OpenAPI 名称 | 描述 | 操作 |
|---|---|---|
| 自定义分析器 | ||
| CreateUserAnalyzer | 创建自定义分析器 | 查看文档去调试 |
| ListUserAnalyzers | 获取用户的自定义分词器列表 | 查看文档去调试 |
| DescribeUserAnalyzer | 获取自定义分析器详情 | 查看文档去调试 |
| ListUserAnalyzerEntries | 获取自定义分析器词条清单 | 查看文档去调试 |
| PushUserAnalyzerEntries | 接收自定义分析器词条变更 | 查看文档去调试 |
| RemoveUserAnalyzer | 删除自定义分析器 | 查看文档去调试 |
| ABTest | ||
| 实验场景 | ||
| CreateABTestScene | 创建实验场景 | 查看文档去调试 |
| ListABTestScenes | 列出场景清单 | 查看文档去调试 |
| DescribeABTestScene | 获取实验场景详情 | 查看文档去调试 |
| UpdateABTestScene | 修改实验场景 | 查看文档去调试 |
| DeleteABTestScene | 删除实验场景 | 查看文档去调试 |
| 实验组 | ||
| CreateABTestGroup | 创建实验组 | 查看文档去调试 |
| ListABTestGroups | 获取实验组清单 | 查看文档去调试 |
| DescribeABTestGroup | 获取实验组详情 | 查看文档去调试 |
| UpdateABTestGroup | 修改实验组 | 查看文档去调试 |
| DeleteABTestGroup | 删除实验组 | 查看文档去调试 |
| 实验 | ||
| CreateABTestExperiment | 创建实验 | 查看文档去调试 |
| ListABTestExperiments | 列出实验清单 | 查看文档去调试 |
| DescribeABTestExperiment | 获取实验详情 | 查看文档去调试 |
| UpdateABTestExperiment | 修改实验参数 | 查看文档去调试 |
| DeleteABTestExperiment | 删除实验 | 查看文档去调试 |
| 白名单 | ||
| ListABTestFixedFlowDividers | 获取白名单清单 | 查看文档去调试 |
| UpdateABTestFixedFlowDividers | 更新白名单数据 | 查看文档去调试 |
| 粗排表达式 | ||
| CreateFirstRank | 创建一个OpenSearch应用版本的粗排表达式配置。当 dryRun=true 时，表示进行粗排表达式校验，默认 dryRun不传为false | 查看文档去调试 |
| ListFirstRanks | 获取指定OpenSearch应用版本的粗排配置列表 | 查看文档去调试 |
| DescribeFirstRank | 查看一个 OpenSearch 应用版本的粗排表达式配置 | 查看文档去调试 |
| ModifyFirstRank | 修改一个 OpenSearch 应用版本的粗排表达式配置当 dryRun=true 时，表示修改后的粗排表达式进行校验，默认 dryRun 不传为 false | 查看文档去调试 |
| RemoveFirstRank | 删除指定 OpenSearch 应用版本的粗排配置 | 查看文档去调试 |
| 精排表达式 | ||
| CreateSecondRank | 当 dryRun=true 时，表示进行精排表达式校验，默认 dryRun 不传为 false | 查看文档去调试 |
| ListSecondRanks | 获取指定 OpenSearch 应用版本的精排排配置列表 | 查看文档去调试 |
| DescribeSecondRank | 查看一个 OpenSearch 应用版本的精排表达式配置 | 查看文档去调试 |
| ModifySecondRank | 修改一个OpenSearch 应用版本的精排配置。当 dryRun=true 时，表示修改后的精排表达式进行校验，默认 dryRun 不传为 false | 查看文档去调试 |
| RemoveSecondRank | 删除一个 OpenSearch 应用版本的精排表达式配置 | 查看文档去调试 |
| 查询分析器 | ||
| CreateQueryProcessor | 创建一个查询分析规则。当 dryRun=true 时，表示进行查询分析规则校验，默认 dryRun 不传为 false | 查看文档去调试 |
| ListQueryProcessors | 获取指定OpenSearch应用版本的查询分析规则列表 | 查看文档去调试 |
| DescribeQueryProcessor | 获取指定 OpenSearch 应用版本的查询分析规则列表 | 查看文档去调试 |
| ListQueryProcessorNers | 实体识别：获取推荐的实体类型重要性设置 | 查看文档去调试 |
| ListQueryProcessorAnalyzerResults | 查询分析效果测试。（仅限开源兼容版存量应用调用） | 查看文档去调试 |
| ModifyQueryProcessor | 修改指定应用版本查询分析规则。当 dryRun=true 时，表示进行查询分析规则校验，默认 dryRun 不传为 false | 查看文档去调试 |
| RemoveQueryProcessor | 删除指定 OpenSearch 应用版本的查询分析规则 | 查看文档去调试 |
| 干预词典 | ||
| CreateInterventionDictionary | 创建干预词典 | 查看文档去调试 |
| ListInterventionDictionaries | 获取用户的干预词典列表 | 查看文档去调试 |
| DescribeInterventionDictionary | 获取干预词典详情 | 查看文档去调试 |
| ListInterventionDictionaryEntries | 获取干预词条清单 | 查看文档去调试 |
| ListInterventionDictionaryRelatedEntities | 获取与干预词典关联的资源清单。如果某个干预词典被qp引用，则列出来所有的应用及QP信息 | 查看文档去调试 |
| ListInterventionDictionaryNerResults | 获取实体识别结果 | 查看文档去调试 |
| PushInterventionDictionaryEntries | 接收干预词条变更 | 查看文档去调试 |
| RemoveInterventionDictionary | 删除干预词典 | 查看文档去调试 |
| 优化大师 | ||
| DescribeSlowQueryStatus | 获取优化大师慢查询开通状态 | 查看文档去调试 |
| ListSlowQueryQueries | 列出优化大师慢查询Query清单 | 查看文档去调试 |
| ListSlowQueryCategories | 列出优化大师慢查询优化建议清单 | 查看文档去调试 |
| EnableSlowQuery | 启用优化大师慢查询服务 | 查看文档去调试 |
| DisableSlowQuery | 禁用优化大师慢查询服务 | 查看文档去调试 |
| StartSlowQueryAnalyzer | 立即进行慢查询分析 | 查看文档去调试 |
| 配额审批 | ||
| ListQuotaReviewTasks | 获取指定 opensearch 应用配额审批清单 | 查看文档去调试 |
| 定时任务 | ||
| CreateScheduledTask | 创建一个 OpenSearch 应用的定时任务 | 查看文档去调试 |
| ListScheduledTasks | 获取OpenSearch应用定时任务列表 | 查看文档去调试 |
| DescribeScheduledTask | 查看 OpenSearch 应用定时任务详情 | 查看文档去调试 |
| ModifyScheduledTask | 修改一个定时任务 | 查看文档去调试 |
| RemoveScheduledTask | 删除 OpenSearch 应用定时任务 | 查看文档去调试 |
| 搜索策略 | ||
| ListSortExpressions | 获取应用版本上的排序表达式列表 | 查看文档去调试 |
| ElasticSearch引擎实例 | ||
| UnbindEsInstance | 为 opensearch 应用解绑es实例 | 查看文档去调试 |
| BindEsInstance | 绑定依赖性 Elasticsearch 实例 | 查看文档去调试 |
| BindESUserAnalyzer | 为es实例绑定自定义分析器 | 查看文档去调试 |
| UnbindESUserAnalyzer | 为Elasticsearch实例解绑自定义分析器 | 查看文档去调试 |
| 当前处理流 | ||
| ListProceedings | 查看当前的处理流 | 查看文档去调试 |
| 统计 | ||
| ListStatisticLogs | 查询日志类统计，例如：应用错误日志、热词榜单、慢日志 | 查看文档去调试 |
| ListStatisticReport | 应用场景有：应用报表、下拉提示报表、热词底纹报表、abtest报表、数据质量报告等 | 查看文档去调试 |
| cava脚本 | ||
| CreateSortScript | 创建排序脚本 | 查看文档去调试 |
| GetSortScriptFile | 获取排序脚本内容 | 查看文档去调试 |
| GetSortScript | 获取排序脚本详情 | 查看文档去调试 |
| GetScriptFileNames | 获取指定版本指定脚本下所有的文件名 | 查看文档去调试 |
| UpdateSortScript | 修改排序脚本备注 | 查看文档去调试 |
| SaveSortScriptFile | 上传排序脚本内容 | 查看文档去调试 |
| ReleaseSortScript | 发布排序脚本 | 查看文档去调试 |
| CompileSortScript | 编译排序脚本 | 查看文档去调试 |
| DeleteSortScriptFile | 删除脚本文件 | 查看文档去调试 |
| DeleteSortScript | 删除排序脚本 | 查看文档去调试 |
| 查询策略 | ||
| CreateSearchStrategy | 创建查询策略 | 查看文档去调试 |
| ListSearchStrategies | 获取查询策略详情 | 查看文档去调试 |
| GetSearchStrategy | 获取查询策略详情 | 查看文档去调试 |
| UpdateSearchStrategy | 支持dryrun | 查看文档去调试 |
| RemoveSearchStrategy | 删除查询策略 | 查看文档去调试 |
算法周边
| OpenAPI 名称 | 描述 | 操作 |
|---|---|---|
| CreateFunctionResource | 创建指定功能下的算法资源 | 查看文档去调试 |
| CreateFunctionTask | 启动一个训练任务 | 查看文档去调试 |
| CreateFunctionInstance | 创建指定功能的一个算法实例 | 查看文档去调试 |
| GetFunctionCurrentVersion | 获取当前功能新建实例时使用的版本信息 | 查看文档去调试 |
| GetFunctionVersion | 根据版本ID获取版本信息 | 查看文档去调试 |
| GetFunctionDefaultInstance | 获取app默认使用的算法实例 | 查看文档去调试 |
| ListFunctionTasks | 获取训练记录。返回结果按开始时间降序排序 | 查看文档去调试 |
| GetFunctionTask | 获取训练详情 | 查看文档去调试 |
| ListFunctionInstances | 获取用户下，符合条件的所有实例 | 查看文档去调试 |
| GetFunctionInstance | 根据实例名称获取实例详情 | 查看文档去调试 |
| UpdateFunctionDefaultInstance | 为指定app设置默认使用的算法实例，自动覆盖上一次设置的默认实例 空表示取消默认实例 | 查看文档去调试 |
| UpdateFunctionInstance | 根据实例名称更新实例信息 | 查看文档去调试 |
| DeleteFunctionTask | 删除训练记录。正在训练中的记录无法删除 | 查看文档去调试 |
| DeleteFunctionInstance | 删除算法实例，删除前请确保该实例不在使用中，以免影响在线服务 | 查看文档去调试 |
其它(未在目录中的文档)
| OpenAPI 名称 | 描述 | 操作 |
|---|---|---|
| DescribeAppGroup | 查看一个 OpenSearch 应用详情 | 查看文档去调试 |
| ValidateDataSources | 验证数据源 | 查看文档去调试 |
| ListSortScripts | 获取指定版本下所有的排序脚本 | 查看文档去调试 |
| ListDataSourceTables | 获取指定数据源的所有数据 | 查看文档去调试 |
| ListDataSourceTableFields | 获取指定数据表的所有字段，为内部接口 | 查看文档去调试 |
| GetDomain | 获取行业类型 | 查看文档去调试 |
| DescribeRegions | 获取所有区域的接入地址 | 查看文档去调试 |
| ReplaceAppGroupCommodityCode | 应用服务型转实例型 | 查看文档去调试 |
| GenerateMergedTable | 获取合并后的宽表 | 查看文档去调试 |
其他
| OpenAPI 名称 | 描述 | 操作 |
|---|---|---|
| DescribeDataCollction | 获取指定应用的数据采集详情 | 查看文档去调试 |
| ListDataCollections | 获取OpenSearch应用的数据采集清单 | 查看文档去调试 |
| ListTagResources | 查标签接口 | 查看文档去调试 |
| RemoveDataCollection | 关闭数据采集 | 查看文档去调试 |
| UntagResources | 删标签接口 | 查看文档去调试 |
| TagResources | 打标签接口 | 查看文档去调试 |
| GetFunctionResource | 获取指定名称的算法资源 | 查看文档去调试 |
| ListFunctionResources | 获取算法资源列表 | 查看文档去调试 |
| DeleteFunctionResource | 删除指定算法资源 | 查看文档去调试 |
| UpdateFunctionResource | 更新算法资源 | 查看文档去调试 |
| CreateAppGroupCredentials | 按需创建指定应用组的访问凭据，支持dryRun模式预览操作 | 查看文档去调试 |