diff options
| author | Zhineng Li <[email protected]> | 2026-02-13 10:54:11 +0800 |
|---|---|---|
| committer | Zhineng Li <[email protected]> | 2026-02-13 10:54:11 +0800 |
| commit | 7347bac4ab7e136157fc94777e6cf87ef9e08599 (patch) | |
| tree | 0dec367dac6e152161a6f7cc0dba6ebbef1f34a2 /data/en_us/opensearch/2017-12-25 | |
| download | acs-metadata-full-7347bac4ab7e136157fc94777e6cf87ef9e08599.tar.gz acs-metadata-full-7347bac4ab7e136157fc94777e6cf87ef9e08599.zip | |
first commitHEADv1.0.0+20260212main
Diffstat (limited to 'data/en_us/opensearch/2017-12-25')
| -rw-r--r-- | data/en_us/opensearch/2017-12-25/api-docs.php | 23328 |
1 files changed, 23328 insertions, 0 deletions
diff --git a/data/en_us/opensearch/2017-12-25/api-docs.php b/data/en_us/opensearch/2017-12-25/api-docs.php new file mode 100644 index 0000000..c947db9 --- /dev/null +++ b/data/en_us/opensearch/2017-12-25/api-docs.php @@ -0,0 +1,23328 @@ +<?php return [ + 'version' => '1.0', + 'info' => [ + 'style' => 'ROA', + 'product' => 'OpenSearch', + 'version' => '2017-12-25', + ], + 'directories' => [ + [ + 'id' => 170735, + 'title' => 'Application instance', + 'type' => 'directory', + 'children' => [ + [ + 'id' => 170736, + 'title' => 'Application Management', + 'type' => 'directory', + 'children' => [ + 'RenewAppGroup', + 'CreateAppGroup', + 'ModifyAppGroup', + 'ModifyAppGroupQuota', + 'RemoveAppGroup', + 'ListAppGroups', + ], + ], + [ + 'id' => 170744, + 'title' => 'Application Version', + 'type' => 'directory', + 'children' => [ + 'CreateApp', + 'RemoveApp', + 'DescribeApps', + 'DescribeApp', + 'DescribeAppStatistics', + ], + ], + ], + ], + [ + 'id' => 170894, + 'title' => 'Instance surrounding', + 'type' => 'directory', + 'children' => [ + [ + 'id' => 170895, + 'title' => 'Custom analyzer', + 'type' => 'directory', + 'children' => [ + 'ListUserAnalyzers', + 'CreateUserAnalyzer', + 'DescribeUserAnalyzer', + 'RemoveUserAnalyzer', + 'ListUserAnalyzerEntries', + 'PushUserAnalyzerEntries', + ], + ], + [ + 'id' => 170905, + 'title' => 'ABTest', + 'type' => 'directory', + 'children' => [ + [ + 'id' => 170906, + 'title' => 'Experimental scene', + 'type' => 'directory', + 'children' => [ + 'ListABTestScenes', + 'CreateABTestScene', + 'DescribeABTestScene', + 'UpdateABTestScene', + 'DeleteABTestScene', + ], + ], + [ + 'id' => 170976, + 'title' => 'The experimental group', + 'type' => 'directory', + 'children' => [ + 'ListABTestGroups', + 'CreateABTestGroup', + 'DeleteABTestGroup', + 'DescribeABTestGroup', + 'UpdateABTestGroup', + ], + ], + [ + 'id' => 170977, + 'title' => 'Experiment', + 'type' => 'directory', + 'children' => [ + 'ListABTestExperiments', + 'CreateABTestExperiment', + 'DescribeABTestExperiment', + 'UpdateABTestExperiment', + 'DeleteABTestExperiment', + ], + ], + [ + 'id' => 170978, + 'title' => 'Whitelist', + 'type' => 'directory', + 'children' => [ + 'ListABTestFixedFlowDividers', + 'UpdateABTestFixedFlowDividers', + ], + ], + ], + ], + [ + 'id' => 170979, + 'title' => 'The crude row expression', + 'type' => 'directory', + 'children' => [ + 'ListFirstRanks', + 'CreateFirstRank', + 'DescribeFirstRank', + 'RemoveFirstRank', + 'ModifyFirstRank', + ], + ], + [ + 'id' => 170980, + 'title' => 'Fine row expression', + 'type' => 'directory', + 'children' => [ + 'ListSecondRanks', + 'CreateSecondRank', + 'DescribeSecondRank', + 'ModifySecondRank', + 'RemoveSecondRank', + ], + ], + [ + 'id' => 170981, + 'title' => 'Query analyzer', + 'type' => 'directory', + 'children' => [ + 'ListQueryProcessors', + 'CreateQueryProcessor', + 'ModifyQueryProcessor', + 'RemoveQueryProcessor', + 'DescribeQueryProcessor', + 'ListQueryProcessorNers', + 'ListQueryProcessorAnalyzerResults', + ], + ], + [ + 'id' => 170982, + 'title' => 'Intervention Dictionary', + 'type' => 'directory', + 'children' => [ + 'ListInterventionDictionaries', + 'CreateInterventionDictionary', + 'DescribeInterventionDictionary', + 'RemoveInterventionDictionary', + 'ListInterventionDictionaryEntries', + 'PushInterventionDictionaryEntries', + 'ListInterventionDictionaryRelatedEntities', + 'ListInterventionDictionaryNerResults', + ], + ], + [ + 'id' => 170983, + 'title' => 'The Master', + 'type' => 'directory', + 'children' => [ + 'EnableSlowQuery', + 'DisableSlowQuery', + 'DescribeSlowQueryStatus', + 'StartSlowQueryAnalyzer', + 'ListSlowQueryQueries', + 'ListSlowQueryCategories', + ], + ], + [ + 'id' => 170984, + 'title' => 'Quota approval', + 'type' => 'directory', + 'children' => [ + 'ListQuotaReviewTasks', + ], + ], + [ + 'id' => 170985, + 'title' => 'Scheduled Tasks', + 'type' => 'directory', + 'children' => [ + 'ListScheduledTasks', + 'CreateScheduledTask', + 'DescribeScheduledTask', + 'ModifyScheduledTask', + 'RemoveScheduledTask', + ], + ], + [ + 'id' => 170986, + 'title' => 'Search Strategy', + 'type' => 'directory', + 'children' => [ + 'ListSortExpressions', + ], + ], + [ + 'id' => 170987, + 'title' => 'ElasticSearch Engine instance', + 'type' => 'directory', + 'children' => [ + 'UnbindEsInstance', + 'BindEsInstance', + 'BindESUserAnalyzer', + 'UnbindESUserAnalyzer', + ], + ], + [ + 'id' => 170988, + 'title' => 'The current process flow', + 'type' => 'directory', + 'children' => [ + 'ListProceedings', + ], + ], + [ + 'id' => 170989, + 'title' => 'Statistics', + 'type' => 'directory', + 'children' => [ + 'ListStatisticLogs', + 'ListStatisticReport', + ], + ], + [ + 'id' => 175840, + 'title' => 'cava script', + 'type' => 'directory', + 'children' => [ + 'UpdateSortScript', + 'SaveSortScriptFile', + 'ReleaseSortScript', + 'GetSortScriptFile', + 'GetSortScript', + 'GetScriptFileNames', + 'DeleteSortScriptFile', + 'DeleteSortScript', + 'CreateSortScript', + 'CompileSortScript', + ], + ], + [ + 'id' => 175844, + 'title' => 'Query the throttling policies', + 'type' => 'directory', + 'children' => [ + 'UpdateSearchStrategy', + 'RemoveSearchStrategy', + 'ListSearchStrategies', + 'GetSearchStrategy', + 'CreateSearchStrategy', + ], + ], + ], + ], + [ + 'id' => 170990, + 'title' => 'Version surrounding', + 'type' => 'directory', + 'children' => [ + [ + 'id' => 170991, + 'title' => 'By default fields', + 'type' => 'directory', + 'children' => [ + 'UpdateFetchFields', + ], + ], + [ + 'id' => 170992, + 'title' => 'A summary of search results and', + 'type' => 'directory', + 'children' => [ + 'UpdateSummaries', + ], + ], + ], + ], + [ + 'id' => 170993, + 'title' => 'Algorithm surrounding', + 'type' => 'directory', + 'children' => [ + 'CreateFunctionResource', + 'GetFunctionCurrentVersion', + 'GetFunctionVersion', + 'GetFunctionDefaultInstance', + 'UpdateFunctionDefaultInstance', + 'ListFunctionTasks', + 'GetFunctionTask', + 'DeleteFunctionTask', + 'CreateFunctionTask', + 'ListFunctionInstances', + 'GetFunctionInstance', + 'DeleteFunctionInstance', + 'UpdateFunctionInstance', + 'CreateFunctionInstance', + ], + ], + [ + 'id' => 170783, + 'title' => 'Others', + 'type' => 'directory', + 'children' => [ + 'DescribeAppGroup', + 'ValidateDataSources', + 'ReplaceAppGroupCommodityCode', + 'ListSortScripts', + 'ListDataSourceTables', + 'ListDataSourceTableFields', + 'GetDomain', + 'GenerateMergedTable', + 'DescribeRegions', + ], + ], + [ + 'id' => 170995, + 'title' => 'other', + 'type' => 'directory', + 'children' => [ + 'DescribeDataCollction', + 'ListDataCollections', + 'RemoveDataCollection', + 'UntagResources', + 'ListTagResources', + 'TagResources', + 'GetFunctionResource', + 'ListFunctionResources', + 'DeleteFunctionResource', + 'UpdateFunctionResource', + 'CreateAppGroupCredentials', + ], + ], + ], + 'components' => [ + 'schemas' => [ + 'ABTestExperiment' => [ + 'title' => '', + 'description' => '', + 'visibility' => 'Public', + 'type' => 'object', + 'properties' => [ + 'name' => [ + 'title' => '', + 'description' => '', + 'visibility' => 'Public', + 'type' => 'string', + 'example' => 'my_test', + 'backendName' => 'name', + ], + 'traffic' => [ + 'title' => '', + 'description' => '', + 'visibility' => 'Public', + 'type' => 'integer', + 'format' => 'int32', + 'example' => '10', + 'backendName' => 'traffic', + ], + 'serialNumber' => [ + 'title' => '', + 'description' => '', + 'visibility' => 'Public', + 'type' => 'integer', + 'format' => 'int32', + 'example' => '85373', + 'backendName' => 'serialNumber', + ], + 'online' => [ + 'title' => '', + 'description' => '', + 'visibility' => 'Public', + 'type' => 'boolean', + 'example' => 'false', + 'backendName' => 'online', + ], + 'params' => [ + 'title' => '', + 'description' => '', + 'visibility' => 'Public', + 'type' => 'object', + 'additionalProperties' => [ + 'description' => '', + 'visibility' => 'Public', + 'type' => 'string', + 'example' => '{'."\n" + .' "firstFormulaName": "default"'."\n" + .' }', + ], + 'backendName' => 'params', + ], + ], + ], + 'ABTestGroup' => [ + 'title' => '', + 'description' => 'The information about an A/B test group.'."\n", + 'visibility' => 'Public', + 'type' => 'object', + 'properties' => [ + 'name' => [ + 'title' => '', + 'description' => 'The alias of the test group.'."\n", + 'visibility' => 'Public', + 'type' => 'string', + 'example' => '“kevin_test”', + 'backendName' => 'name', + ], + 'status' => [ + 'title' => '', + 'description' => 'The status of the test group. Valid values:'."\n" + ."\n" + .'* 0: not in effect'."\n" + .'* 1: in effect'."\n", + 'visibility' => 'Public', + 'type' => 'integer', + 'format' => 'int32', + 'example' => '1', + 'backendName' => 'status', + ], + ], + ], + 'ABTestScene' => [ + 'title' => '', + 'description' => 'The information about an A/B test scene.'."\n", + 'visibility' => 'Public', + 'type' => 'object', + 'properties' => [ + 'name' => [ + 'title' => '', + 'description' => 'The alias of the test scenario.'."\n", + 'visibility' => 'Public', + 'type' => 'string', + 'example' => 'test', + 'backendName' => 'name', + ], + 'values' => [ + 'title' => '', + 'description' => 'The ID of the test scenario'."\n", + 'visibility' => 'Public', + 'type' => 'array', + 'items' => [ + 'description' => 'The indicators of the test scenarios.'."\n", + 'visibility' => 'Public', + 'type' => 'string', + 'example' => 'test', + 'extendType' => 'true', + ], + 'backendName' => 'values', + ], + 'status' => [ + 'title' => '', + 'description' => 'The status of the test scenario. Valid values:'."\n" + ."\n" + .'* 0: not in effect'."\n" + .'* 1: in effect'."\n", + 'visibility' => 'Public', + 'type' => 'integer', + 'format' => 'int32', + 'example' => '0', + 'backendName' => 'status', + ], + ], + ], + 'PrepayOrderInfo' => [ + 'title' => '', + 'description' => 'The information about the subscription order.'."\n", + 'visibility' => 'public', + 'type' => 'object', + 'properties' => [ + 'duration' => [ + 'title' => '', + 'description' => 'The subscription duration.'."\n", + 'visibility' => 'public', + 'type' => 'integer', + 'format' => 'int32', + 'example' => '1', + 'backendName' => 'duration', + ], + 'pricingCycle' => [ + 'title' => '', + 'description' => 'The billing cycle. Valid values:'."\n" + ."\n" + .'* Year'."\n" + .'* Month'."\n", + 'visibility' => 'public', + 'type' => 'string', + 'example' => 'Year', + 'backendName' => 'pricingCycle', + ], + 'autoRenew' => [ + 'title' => '', + 'description' => 'Specifies whether to enable auto-renewal for the instance.'."\n", + 'visibility' => 'public', + 'type' => 'boolean', + 'example' => 'false', + 'backendName' => 'autoRenew', + ], + ], + ], + ], + ], + 'apis' => [ + 'RenewAppGroup' => [ + 'summary' => 'Renews an application. This operation is not available now. You must renew an application in the OpenSearch console.', + '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' => 'The name of the application.'."\n", + 'type' => 'string', + 'required' => true, + 'docRequired' => true, + 'example' => 'my_app', + ], + ], + [ + 'name' => 'clientToken', + 'in' => 'query', + 'schema' => [ + 'description' => 'The client token that is used to ensure the idempotence of the request.'."\n", + 'type' => 'string', + 'required' => false, + 'example' => '74db41d8cd3c784209093aa76afbe89e', + ], + ], + [ + 'name' => 'body', + 'in' => 'body', + 'schema' => [ + 'description' => 'The renewal request body.'."\n", + 'required' => false, + '$ref' => '#/components/schemas/PrepayOrderInfo', + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'description' => 'The response body.'."\n", + 'type' => 'object', + 'properties' => [ + 'requestId' => [ + 'description' => 'The request ID.'."\n", + 'type' => 'string', + 'example' => 'D77D0DAF-790D-F5F5-A9C0-133738165014', + ], + 'result' => [ + 'description' => 'Indicates whether the application was renewed.'."\n", + '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":"<requestId>D77D0DAF-790D-F5F5-A9C0-133738165014</requestId>\\n<result/>","errorExample":""}]', + 'title' => 'RenewAppGroup', + 'requestParamsDescription' => '**Optional parameters**'."\n" + ."\n" + .'|Parameter|Type|Description|'."\n" + .'|---|---|---|'."\n" + .'|duration|Integer|The renewal duration. Default value: 1.Valid values:\\- \\[1,2\\]. Unit: year.\\- \\[1,9\\]. Unit: month.|'."\n" + .'|pricingCycle|String|The unit of the renewal duration.Valid values:\\- Year\\- Month|'."\n" + .'|autoRenew|boolean|Specifies whether to enable auto-renewal. Default value: false.Valid values:\\- false\\- true|', + 'responseParamsDescription' => ' ', + 'extraInfo' => ' ', + ], + 'CreateAppGroup' => [ + 'summary' => 'Creates an OpenSearch application.', + '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' => 'The request body.'."\n", + 'type' => 'object', + 'properties' => [ + 'name' => [ + 'description' => 'The name of the application.'."\n", + 'type' => 'string', + 'required' => false, + 'example' => 'jmbon_analyzer', + ], + 'chargeType' => [ + 'description' => 'The billing method. Valid values:'."\n" + ."\n" + .'* POSTPAY: pay-as-you-go'."\n" + .'* PREPAY: subscription'."\n", + 'type' => 'string', + 'required' => false, + 'enumValueTitles' => [], + 'example' => 'POSTPAY', + ], + 'type' => [ + 'description' => 'The type of the application. Valid values:'."\n" + ."\n" + .'* standard'."\n" + .'* enhanced'."\n", + 'type' => 'string', + 'required' => false, + 'example' => 'enhanced', + ], + 'resourceGroupId' => [ + 'description' => 'The ID of the resource group to which the instance belongs.'."\n", + 'type' => 'string', + 'required' => false, + 'example' => 'rg-acfm2ij6pwxsvua', + ], + 'tags' => [ + 'description' => 'The tags.'."\n", + 'type' => 'array', + 'items' => [ + 'description' => 'The tag.'."\n", + 'type' => 'object', + 'properties' => [ + 'key' => [ + 'description' => 'The tag key.'."\n", + 'type' => 'string', + 'required' => false, + 'example' => 'a', + ], + 'value' => [ + 'description' => 'The tag value.'."\n", + 'type' => 'string', + 'required' => false, + 'example' => '1', + ], + ], + 'required' => false, + ], + 'required' => false, + ], + 'quota' => [ + 'description' => 'The quota.'."\n", + 'type' => 'object', + 'properties' => [ + 'docSize' => [ + 'description' => 'The storage capacity. Unit: GB.'."\n", + 'type' => 'integer', + 'format' => 'int32', + 'required' => false, + 'example' => '1', + ], + 'computeResource' => [ + 'description' => 'The computing resources. Unit: logical computing unit (LCU).'."\n", + 'type' => 'integer', + 'format' => 'int32', + 'required' => false, + 'example' => '20', + ], + 'spec' => [ + 'description' => 'The specifications. Valid values:'."\n" + ."\n" + .'* opensearch.share.junior: basic'."\n" + .'* opensearch.share.common: shared general-purpose'."\n" + .'* opensearch.share.compute: shared computing'."\n" + .'* opensearch.share.storage: shared storage'."\n" + .'* opensearch.private.common: exclusive general-purpose'."\n" + .'* opensearch.private.compute: exclusive computing'."\n" + .'* opensearch.private.storage: exclusive storage'."\n", + 'type' => 'string', + 'required' => false, + 'example' => 'opensearch.share.common', + ], + ], + 'required' => false, + ], + ], + 'required' => false, + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'description' => 'The rsponse body.'."\n", + 'type' => 'object', + 'properties' => [ + 'requestId' => [ + 'description' => 'The request ID.'."\n", + 'type' => 'string', + 'example' => '766CF6DB-CA02-3E12-7CBA-6AC21FC978FD', + ], + 'result' => [ + 'description' => 'None'."\n", + 'type' => 'object', + 'properties' => [ + 'created' => [ + 'description' => 'The timestamp when the application was created.'."\n", + 'type' => 'integer', + 'format' => 'int32', + 'example' => '1590139542', + ], + 'currentVersion' => [ + 'description' => 'The ID of the current online version.'."\n", + 'type' => 'string', + 'example' => '100302903', + ], + 'lockMode' => [ + 'description' => 'The lock state. Valid values:'."\n" + ."\n" + .'* Unlock: The instance is unlocked.'."\n" + .'* LockByExpiration: The instance is automatically locked after it expires.'."\n" + .'* ManualLock: The instance is manually locked.'."\n", + 'type' => 'string', + 'example' => 'Unlock', + ], + 'updated' => [ + 'description' => 'The timestamp when the application was last modified.'."\n", + 'type' => 'integer', + 'format' => 'int32', + 'example' => '1590978265', + ], + 'id' => [ + 'description' => 'The application ID.'."\n", + 'type' => 'string', + 'example' => '100302881', + ], + 'chargeType' => [ + 'description' => 'The billing method. Valid values:'."\n" + ."\n" + .'* POSTPAY: pay-as-you-go.'."\n" + .'* PREPAY: subscription.'."\n", + 'type' => 'string', + 'example' => 'POSTPAY', + ], + 'hasPendingQuotaReviewTask' => [ + 'description' => 'The approval state of the quotas. Valid values:'."\n" + ."\n" + .'* 0: The application is in service.'."\n" + .'* 1: The quotas are being reviewed.'."\n", + 'type' => 'integer', + 'format' => 'int32', + 'example' => '0', + ], + 'name' => [ + 'description' => 'The name of the application.'."\n", + 'type' => 'string', + 'example' => 'lsh_test_1', + ], + 'instanceId' => [ + 'description' => 'The ID of the instance.'."\n", + 'type' => 'string', + 'example' => '-', + ], + 'chargingWay' => [ + 'description' => 'The type of billing. Valid values:'."\n" + ."\n" + .'* 1: computing resources.'."\n" + .'* 2: queries per second (QPS).'."\n", + 'type' => 'integer', + 'format' => 'int32', + 'example' => '1', + ], + 'type' => [ + 'description' => 'The type of the application. Valid values:'."\n" + ."\n" + .'* standard: a standard edition application.'."\n" + .'* advance: an advanced edition which is of an old version. New version is not supported for this edition.'."\n" + .'* enhanced: an advanced edition application of a new version.'."\n", + 'type' => 'string', + 'example' => 'enhanced', + ], + 'status' => [ + 'description' => 'The status of the application. Valid values:'."\n" + ."\n" + .'* producing: The application is being created.'."\n" + .'* review_pending: The application is being reviewed.'."\n" + .'* config_pending: The application is to be configured.'."\n" + .'* normal: The application is in service.'."\n" + .'* frozen: The application is frozen.'."\n", + 'type' => 'string', + 'example' => 'normal', + ], + 'projectId' => [ + 'description' => 'The name of the A/B test group.'."\n", + 'type' => 'string', + 'example' => '-', + ], + 'switchedTime' => [ + 'description' => 'The timestamp when the current online version was published.'."\n", + 'type' => 'integer', + 'format' => 'int32', + 'example' => '1590486386', + ], + 'commodityCode' => [ + 'description' => 'The commodity code.'."\n", + 'type' => 'string', + 'example' => 'opensearch', + ], + 'expireOn' => [ + 'description' => 'The expiration time.'."\n", + 'type' => 'string', + 'example' => '-', + ], + 'domain' => [ + 'description' => 'The type of the industry. Valid values:'."\n" + ."\n" + .'* GENERAL'."\n" + .'* ECOMMERCE'."\n" + .'* IT_CONTENT'."\n", + 'type' => 'string', + 'example' => 'GENERAL', + ], + 'description' => [ + 'description' => 'The description of the application.'."\n", + 'type' => 'string', + 'example' => '-', + ], + 'produced' => [ + 'description' => 'Indicates whether the application is created. Valid values:'."\n" + ."\n" + .'* 0: The application is being created.'."\n" + .'* 1: The application is created.'."\n", + 'type' => 'integer', + 'format' => 'int32', + 'example' => '1', + ], + 'quota' => [ + 'description' => 'The information about the quotas of the application.'."\n", + 'type' => 'object', + 'properties' => [ + 'spec' => [ + 'description' => 'The specifications. Valid values:'."\n" + ."\n" + .'* opensearch.share.junior: basic.'."\n" + .'* opensearch.share.common: shared general-purpose.'."\n" + .'* opensearch.share.compute: shared computing.'."\n" + .'* opensearch.share.storage: shared storage.'."\n" + .'* opensearch.private.common: exclusive general-purpose.'."\n" + .'* opensearch.private.compute: exclusive computing.'."\n" + .'* opensearch.private.storage: exclusive storage.'."\n", + 'type' => 'string', + 'example' => 'opensearch.share.common', + ], + 'docSize' => [ + 'description' => 'The storage capacity. Unit: GB.'."\n", + 'type' => 'integer', + 'format' => 'int32', + 'example' => '1', + ], + 'computeResource' => [ + 'description' => 'The computing resources. Unit: logical computing units (LCUs).'."\n", + 'type' => 'integer', + 'format' => 'int32', + 'example' => '20', + ], + ], + ], + 'engineType' => [ + 'description' => 'The engine type.'."\n", + '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":"<requestId>766CF6DB-CA02-3E12-7CBA-6AC21FC978FD</requestId>","errorExample":""}]', + 'title' => 'CreateAppGroup', + 'requestParamsDescription' => '**Request body**'."\n" + ."\n" + .'|Parameter|Type|Required|Example|Description|'."\n" + .'|---|---|---|---|---|'."\n" + .'|name|String|Yes|"my\\_app"|The name of the application.|'."\n" + .'|type|String|Yes|"standard"|The type of the application.Valid values: standardand enhanced.|'."\n" + .'|quota|Object|Yes||The quota information about the application. For more information, see [Quota](~~170001~~).|'."\n" + .'|chargeType|String|No|"POSTPAY"|The billing method.Valid values: POSTPAYand PREPAY.|'."\n" + .'|order|Object|No|{"duration": 1,"pricingCycle": "Year"}|The information about the subscription period.|'."\n" + .'|order.duration|Integer|\\--|1|The subscription duration. The minimum value is no less than 0.|'."\n" + .'|order.pricingCycle|String|\\--|"Year"|The unit of the subscription duration.YearMonth.|'."\n" + .'|order.autoRenew|Boolean|No|true|Specifies whether to enable auto-renewal. This parameter takes effect only when the chargeType parameter is set to PREPAY. Valid values:true.false (the default value).|', + 'responseParamsDescription' => ' ', + 'extraInfo' => ' ', + ], + 'ModifyAppGroup' => [ + 'summary' => 'Modifies the properties of an OpenSearch application or sets the online version of an OpenSearch application.', + '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' => 'The name of the application.'."\n", + 'type' => 'string', + 'required' => true, + 'docRequired' => true, + 'example' => 'my_app_group_name', + ], + ], + [ + 'name' => 'body', + 'in' => 'body', + 'style' => 'json', + 'schema' => [ + 'description' => 'The request parameters for the operation.'."\n", + 'type' => 'object', + 'properties' => [ + 'description' => [ + 'description' => 'The description of the application.'."\n", + 'type' => 'string', + 'required' => false, + 'example' => '"test"', + ], + 'currentVersion' => [ + 'description' => 'The online version of the application.'."\n", + 'type' => 'string', + 'required' => false, + 'example' => '1223232', + ], + 'domain' => [ + 'description' => 'The type of the industry. Valid values:'."\n" + ."\n" + .'* general: general.'."\n" + .'* ecommerce: e-commerce.'."\n" + .'* education: education.'."\n" + .'* esports: electronic sports.'."\n" + .'* community: content community.'."\n", + 'type' => 'string', + 'required' => false, + 'example' => '"ecommerce"', + ], + 'resourceGroupId' => [ + 'description' => 'The ID of the resource group to which the instance belongs.'."\n", + 'type' => 'string', + 'required' => false, + 'example' => 'rg-****', + ], + ], + 'required' => false, + ], + ], + [ + 'name' => 'dryRun', + 'in' => 'query', + 'schema' => [ + 'description' => 'Specifies whether to verify the application before modification. Valid values: true and false.'."\n", + 'type' => 'boolean', + 'required' => false, + 'example' => 'true', + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'description' => 'The response body.', + 'type' => 'object', + 'properties' => [ + 'requestId' => [ + 'description' => 'The request ID.'."\n", + 'type' => 'string', + 'example' => 'D77D0DAF-790D-F5F5-A9C0-133738165014', + ], + 'result' => [ + 'description' => 'Response parameters'."\n", + 'type' => 'object', + 'properties' => [ + 'created' => [ + 'description' => 'The timestamp when the application was created.'."\n", + 'type' => 'integer', + 'format' => 'int32', + 'example' => '1590139524', + ], + 'currentVersion' => [ + 'description' => 'The ID of the current online version.'."\n", + 'type' => 'string', + 'example' => '100302903', + ], + 'lockMode' => [ + 'description' => 'The lock status. Valid values:'."\n" + ."\n" + .'* Unlock: The instance is unlocked.'."\n" + .'* LockByExpiration: The instance is automatically locked after it expires.'."\n" + .'* ManualLock: The instance is manually locked.'."\n", + 'type' => 'string', + 'example' => 'Unlock', + ], + 'updated' => [ + 'description' => 'The timestamp when the application was last modified.'."\n", + 'type' => 'integer', + 'format' => 'int32', + 'example' => '1590978265', + ], + 'id' => [ + 'description' => 'The application ID.'."\n", + 'type' => 'string', + 'example' => '100302881', + ], + 'chargeType' => [ + 'description' => 'The billing method. Valid values:'."\n" + ."\n" + .'* POSTPAY: pay-as-you-go.'."\n" + .'* PREPAY: subscription.'."\n", + 'type' => 'string', + 'example' => 'POSTPAY', + ], + 'hasPendingQuotaReviewTask' => [ + 'description' => 'The approval status of the quotas. Valid values:'."\n" + ."\n" + .'* 0: normal.'."\n" + .'* 1: being approved.'."\n", + 'type' => 'integer', + 'format' => 'int32', + 'example' => '0', + ], + 'name' => [ + 'description' => 'The name of the application.'."\n", + 'type' => 'string', + 'example' => 'lsh_test_1', + ], + 'instanceId' => [ + 'description' => 'The instance ID.'."\n", + 'type' => 'string', + 'example' => '10030288', + ], + 'chargingWay' => [ + 'description' => 'The billable item. Valid values:'."\n" + ."\n" + .'* 1: computing resources.'."\n" + .'* 2: QPS.'."\n", + 'type' => 'integer', + 'format' => 'int32', + 'example' => '1', + ], + 'type' => [ + 'description' => 'The type of the application. Valid values:'."\n" + ."\n" + .'* standard: a standard edition application.'."\n" + .'* advance: an advanced edition application of an old version. New versions are not supported for this edition.'."\n" + .'* enhanced: an advanced edition application of a new version.'."\n", + 'type' => 'string', + 'example' => 'enhanced', + ], + 'status' => [ + 'description' => 'The state of the application. Valid values:'."\n" + ."\n" + .'* producing: being produced.'."\n" + .'* review_pending: being approved.'."\n" + .'* config_pending: to be configured.'."\n" + .'* normal: normal.'."\n" + .'* frozen: frozen.'."\n", + 'type' => 'string', + 'example' => 'normal', + ], + 'projectId' => [ + 'description' => 'The name of the A/B test group.'."\n", + 'type' => 'string', + 'example' => '1', + ], + 'switchedTime' => [ + 'description' => 'The timestamp when the current online version was published.'."\n", + 'type' => 'integer', + 'format' => 'int32', + 'example' => '1590486386', + ], + 'commodityCode' => [ + 'description' => 'The code of the commodity.'."\n", + 'type' => 'string', + 'example' => 'opensearch', + ], + 'expireOn' => [ + 'description' => 'The time when the application expired.'."\n", + 'type' => 'string', + 'example' => '1', + ], + 'domain' => [ + 'description' => 'The type of the industry. Valid values:'."\n" + ."\n" + .'* GENERAL: general.'."\n" + .'* ECOMMERCE: e-commerce.'."\n" + .'* IT_CONTENT: IT content.'."\n", + 'type' => 'string', + 'example' => 'GENERAL', + ], + 'description' => [ + 'description' => 'The description of the application.'."\n", + 'type' => 'string', + 'example' => '1', + ], + 'produced' => [ + 'description' => 'Indicates whether the order is complete. Valid values:'."\n" + ."\n" + .'* 0: The order is in progress.'."\n" + .'* 1: The order is complete.'."\n", + 'type' => 'integer', + 'format' => 'int32', + 'example' => '1', + ], + 'quota' => [ + 'description' => 'The information about the quotas of the application.'."\n", + 'type' => 'object', + 'properties' => [ + 'spec' => [ + 'description' => 'The specifications. Valid values:'."\n" + ."\n" + .'* opensearch.share.junior: basic.'."\n" + .'* opensearch.share.common: shared general-purpose.'."\n" + .'* opensearch.share.compute: shared computing.'."\n" + .'* opensearch.share.storage: shared storage.'."\n" + .'* opensearch.private.common: exclusive general-purpose.'."\n" + .'* opensearch.private.compute: exclusive computing.'."\n" + .'* opensearch.private.storage: exclusive storage.'."\n", + 'type' => 'string', + 'example' => 'opensearch.share.common', + ], + 'docSize' => [ + 'description' => 'The storage capacity. Unit: GB.'."\n", + 'type' => 'integer', + 'format' => 'int32', + 'example' => '1', + ], + 'computeResource' => [ + 'description' => 'The computing resources. Unit: logical computing unit (LCU).'."\n", + 'type' => 'integer', + 'format' => 'int32', + 'example' => '20', + ], + ], + 'example' => '{}', + ], + 'engineType' => [ + 'description' => 'The engine type.'."\n", + 'type' => 'string', + 'example' => 'ha3', + ], + 'resourceGroupId' => [ + 'description' => 'The ID of the resource group to which the instance belongs.'."\n", + '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":"<requestId>0A6EB64B-B4C8-CF02-810F-E660812972FF</requestId>\\n<result>\\n <id>110116134</id>\\n <name>os_function_test_v1</name>\\n <currentVersion>110116134</currentVersion>\\n <switchedTime>0</switchedTime>\\n <quota>\\n <docSize>1</docSize>\\n <computeResource>20</computeResource>\\n <spec>opensearch.share.common</spec>\\n </quota>\\n <chargingWay>1</chargingWay>\\n <type>enhanced</type>\\n <projectId/>\\n <chargeType>POSTPAY</chargeType>\\n <expireOn/>\\n <instanceId/>\\n <commodityCode>opensearch</commodityCode>\\n <processingOrderId/>\\n <firstRankAlgoDeploymentId>0</firstRankAlgoDeploymentId>\\n <secondRankAlgoDeploymentId>0</secondRankAlgoDeploymentId>\\n <pendingSecondRankAlgoDeploymentId>0</pendingSecondRankAlgoDeploymentId>\\n <description>opensearch-demo</description>\\n <produced>1</produced>\\n <lockedByExpiration>0</lockedByExpiration>\\n <hasPendingQuotaReviewTask>0</hasPendingQuotaReviewTask>\\n <created>1575442875</created>\\n <updated>1578916076</updated>\\n <status>normal</status>\\n <lockMode>Unlock</lockMode>\\n</result>","errorExample":""}]', + 'title' => 'ModifyAppGroup', + 'requestParamsDescription' => '**Request body**'."\n" + ."\n" + .'|Parameter|Type|Required|Example|Description|'."\n" + .'|---|---|---|---|---|'."\n" + .'|chargingWay|Integer|No|1|The billing type. Valid values:1: computing resources.2: queries per second (QPS).|'."\n" + .'|description|String|No|"my\\_first\\_app"|The description of the application.|'."\n" + .'|currentVersion|Integer|No|12345678|The ID of the application version.|'."\n" + ."\n\n" + .'Note: The currentVersion parameter takes effect if all fields are included in the request. In this case, this operation preferentially configures the online version of the application.', + 'responseParamsDescription' => ' ', + ], + 'ModifyAppGroupQuota' => [ + 'summary' => 'Modifies the quotas of an OpenSearch application.', + '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' => 'The name of the application'."\n", + 'type' => 'string', + 'required' => true, + 'docRequired' => true, + 'example' => 'my_app_group_name', + ], + ], + [ + 'name' => 'clientToken', + 'in' => 'query', + 'schema' => [ + 'title' => '用于保证请求的幂等性。由客户端生成该参数值，要保证在不同请求间唯一，最大不超过64个ASCII字符。', + 'type' => 'string', + ], + ], + [ + 'name' => 'dryRun', + 'in' => 'query', + 'schema' => [ + 'description' => 'Specifies whether to check the validity of input parameters. Default value: false.'."\n" + ."\n" + .'Valid values:'."\n" + ."\n" + .'* **true**: checks only the validity of input parameters.'."\n" + .'* **false**: checks the validity of input parameters and creates an attribution configuration.'."\n", + 'type' => 'boolean', + 'required' => false, + 'example' => 'false', + ], + ], + [ + 'name' => 'body', + 'in' => 'body', + 'schema' => [ + 'description' => 'The request body.'."\n", + 'required' => false, + '$ref' => '#/components/schemas/Quota', + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'description' => 'The rsponse body.'."\n", + 'type' => 'object', + 'properties' => [ + 'requestId' => [ + 'description' => 'The request ID.'."\n", + 'type' => 'string', + 'example' => '0A6EB64B-B4C8-CF02-810F-E660812972FF', + ], + 'result' => [ + 'description' => 'The information about the application.'."\n", + 'type' => 'object', + 'properties' => [ + 'created' => [ + 'description' => 'The timestamp when the application was created.'."\n", + 'type' => 'integer', + 'format' => 'int32', + 'example' => '1590139542', + ], + 'currentVersion' => [ + 'description' => 'The ID of the current online version.'."\n", + 'type' => 'string', + 'example' => '100302903', + ], + 'type' => [ + 'description' => 'The type of the application. Valid values:'."\n" + ."\n" + .'* standard: a standard edition application.'."\n" + .'* advance: an advanced edition application of an old version. New versions are not supported for this edition.'."\n" + .'* enhanced: an advanced edition application of a new version.'."\n", + 'type' => 'string', + 'example' => 'enhanced', + ], + 'chargingWay' => [ + 'description' => 'The billable item. Valid values:'."\n" + ."\n" + .'* 1: computing resources.'."\n" + .'* 2: queries per second (QPS).'."\n", + 'type' => 'integer', + 'format' => 'int32', + 'example' => '1', + ], + 'lockMode' => [ + 'description' => 'The lock state. Valid values:'."\n" + ."\n" + .'* Unlock: The instance is unlocked.'."\n" + .'* LockByExpiration: The instance is automatically locked after it expires.'."\n" + .'* ManualLock: The instance is manually locked.'."\n", + 'type' => 'string', + 'example' => 'Unlock', + ], + 'status' => [ + 'description' => 'The state of the application. Valid values:'."\n" + ."\n" + .'* producing: The application is being created.'."\n" + .'* review_pending: The application is being reviewed.'."\n" + .'* config_pending: The application is to be configured.'."\n" + .'* normal: The application is in service.'."\n" + .'* frozen: The application is frozen.'."\n", + 'type' => 'string', + 'example' => 'normal', + ], + 'updated' => [ + 'description' => 'The timestamp when the application was last modified.'."\n", + 'type' => 'integer', + 'format' => 'int32', + 'example' => '1590978265', + ], + 'chargeType' => [ + 'description' => 'The billing method. Valid values:'."\n" + ."\n" + .'* POSTPAY: pay-as-you-go.'."\n" + .'* PREPAY: subscription.'."\n", + 'type' => 'string', + 'example' => 'POSTPAY', + ], + 'id' => [ + 'description' => 'The application ID.'."\n", + 'type' => 'string', + 'example' => '100302881', + ], + 'hasPendingQuotaReviewTask' => [ + 'description' => 'The approval state of the quotas. Valid values:'."\n" + ."\n" + .'* 0: The application is in service.'."\n" + .'* 1: The quotas are being reviewed.'."\n", + 'type' => 'integer', + 'format' => 'int32', + 'example' => '0', + ], + 'projectId' => [ + 'description' => 'The name of the A/B test group.'."\n", + 'type' => 'string', + 'example' => '1000', + ], + 'commodityCode' => [ + 'description' => 'The commodity code.'."\n", + 'type' => 'string', + 'example' => 'opensearch', + ], + 'switchedTime' => [ + 'description' => 'The timestamp when the current online version was published.'."\n", + 'type' => 'integer', + 'format' => 'int32', + 'example' => '1590486386', + ], + 'expireOn' => [ + 'description' => 'The time when the application expired.'."\n", + 'type' => 'string', + 'example' => ' 1', + ], + 'description' => [ + 'description' => 'The description of the application.'."\n", + 'type' => 'string', + 'example' => ' 1', + ], + 'produced' => [ + 'description' => 'Indicates whether the application is created. Valid values:'."\n" + ."\n" + .'* 0: The application is being created.'."\n" + .'* 1: The application is created.'."\n", + 'type' => 'integer', + 'format' => 'int32', + 'example' => '1', + ], + 'name' => [ + 'description' => 'The name of the application'."\n", + 'type' => 'string', + 'example' => 'lsh_test_1', + ], + 'instanceId' => [ + 'description' => 'The instance ID.'."\n", + 'type' => 'string', + 'example' => '1', + ], + 'quota' => [ + 'description' => 'The information about the quotas of the application.'."\n", + 'type' => 'object', + 'properties' => [ + 'spec' => [ + 'description' => 'The specifications. Valid values:'."\n" + ."\n" + .'* opensearch.share.junior: basic.'."\n" + .'* opensearch.share.common: shared general-purpose.'."\n" + .'* opensearch.share.compute: shared computing.'."\n" + .'* opensearch.share.storage: shared storage.'."\n" + .'* opensearch.private.common: exclusive general-purpose.'."\n" + .'* opensearch.private.compute: exclusive computing.'."\n" + .'* opensearch.private.storage: exclusive storage.'."\n", + 'type' => 'string', + 'example' => 'opensearch.share.common', + ], + 'docSize' => [ + 'description' => 'The storage capacity. Unit: GB.'."\n", + 'type' => 'integer', + 'format' => 'int32', + 'example' => '1', + ], + 'computeResource' => [ + 'description' => 'The computing resources. Unit: logical computing unit (LCU).'."\n", + 'type' => 'integer', + 'format' => 'int32', + 'example' => '20', + ], + ], + ], + 'engineType' => [ + 'description' => 'The engine type.'."\n" + ."\n" + .'Valid values:'."\n" + ."\n" + .'* ha3: ha3.'."\n", + 'type' => 'string', + 'enumValueTitles' => [ + 'ha3' => 'ha3', + ], + 'example' => 'ha3', + ], + 'resourceGroupId' => [ + 'description' => 'The ID of the resource group to which the instance belongs.'."\n", + '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":"<requestId>0A6EB64B-B4C8-CF02-810F-E660812972FF</requestId>\\n<result>\\n <id>110116134</id>\\n <name>os_function_test_v1</name>\\n <currentVersion>110116134</currentVersion>\\n <switchedTime>0</switchedTime>\\n <quota>\\n <docSize>1</docSize>\\n <computeResource>20</computeResource>\\n <spec>opensearch.share.common</spec>\\n </quota>\\n <chargingWay>1</chargingWay>\\n <type>enhanced</type>\\n <projectId/>\\n <chargeType>POSTPAY</chargeType>\\n <expireOn/>\\n <instanceId/>\\n <commodityCode>opensearch</commodityCode>\\n <processingOrderId/>\\n <firstRankAlgoDeploymentId>0</firstRankAlgoDeploymentId>\\n <secondRankAlgoDeploymentId>0</secondRankAlgoDeploymentId>\\n <pendingSecondRankAlgoDeploymentId>0</pendingSecondRankAlgoDeploymentId>\\n <description/>\\n <produced>1</produced>\\n <lockedByExpiration>0</lockedByExpiration>\\n <hasPendingQuotaReviewTask>0</hasPendingQuotaReviewTask>\\n <created>1575442875</created>\\n <updated>1578916076</updated>\\n <status>normal</status>\\n <lockMode>Unlock</lockMode>\\n</result>","errorExample":""}]', + 'title' => 'ModifyAppGroupQuota', + 'requestParamsDescription' => '**Request body**'."\n" + ."\n" + .'|Parameter|Type|Required|Example|Description|'."\n" + .'|---|---|---|---|---|'."\n" + .'|docSize|Integer|Yes|1|The storage capacity (Unit: GB). Shared general-purpose (1 to 300 GB).|'."\n" + .'|computeResource|Integer|Yes|20|The computing resources (unit: LCUs). Shared general-purpose (20 to 5000 LCUs).|'."\n" + .'|spec|String|Yes|"opensearch.share.common"|The specifications.|'."\n" + .'|orderType|String|No|"UPGRADE"|The type of specification change. Valid values:UPGRADE: specification upgradeDOWNGRADE: specification downgrade|'."\n" + ."\n" + .'For more information, see [Quota](~~170001~~).', + 'responseParamsDescription' => ' ', + ], + 'RemoveAppGroup' => [ + 'summary' => 'Deletes an OpenSearch application.', + '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' => 'The name of the application'."\n", + 'type' => 'string', + 'required' => true, + 'docRequired' => true, + 'example' => '121001650', + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'type' => 'object', + 'properties' => [ + 'requestId' => [ + 'description' => 'The request ID.'."\n", + 'type' => 'string', + 'example' => '3AA29D02-54F3-8569-F71A-90E1B7BE4E7E', + ], + 'result' => [ + 'description' => 'The returned results.'."\n", + 'type' => 'array', + 'items' => [ + 'description' => 'The returned result.'."\n", + 'type' => 'integer', + 'format' => 'int32', + 'example' => '[]', + ], + ], + ], + 'description' => '', + ], + ], + '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' => 'RemoveAppGroup', + 'description' => 'You can delete only pay-as-you-go applications. You cannot delete subscription applications.'."\n", + ], + 'ListAppGroups' => [ + 'summary' => 'Queries a list of OpenSearch applications.', + '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' => 'The page number. Default value: 1.'."\n", + 'type' => 'integer', + 'format' => 'int32', + 'required' => false, + 'example' => '1', + ], + ], + [ + 'name' => 'pageSize', + 'in' => 'query', + 'schema' => [ + 'description' => 'The number of entries per page. Default value: 10.'."\n", + 'type' => 'integer', + 'format' => 'int32', + 'required' => false, + 'example' => '10', + ], + ], + [ + 'name' => 'instanceId', + 'in' => 'query', + 'schema' => [ + 'description' => 'The ID of the instance. Exact match is used.'."\n", + 'type' => 'string', + 'required' => false, + 'example' => 'ops-cn-xxxx', + ], + ], + [ + 'name' => 'name', + 'in' => 'query', + 'schema' => [ + 'description' => 'The name of the application.'."\n", + 'type' => 'string', + 'required' => false, + 'example' => 'my_name', + ], + ], + [ + 'name' => 'type', + 'in' => 'query', + 'schema' => [ + 'description' => 'The type of the application. Valid values:'."\n" + ."\n" + .'* standard: a High-performance Search Edition application.'."\n" + .'* enhanced: an Industry Algorithm Edition application.'."\n", + 'type' => 'string', + 'required' => false, + 'example' => 'standard', + ], + ], + [ + 'name' => 'sortBy', + 'in' => 'query', + 'schema' => [ + 'description' => 'The method based on which applications are sorted. Valid values:'."\n" + ."\n" + .'* 0: sorts applications in descending order by creation time.'."\n" + .'* 1: sorts applications in descending order by modification time.'."\n" + ."\n" + .'Default value: 0.'."\n", + 'type' => 'integer', + 'format' => 'int32', + 'required' => false, + 'example' => '0', + ], + ], + [ + 'name' => 'resourceGroupId', + 'in' => 'query', + 'schema' => [ + 'description' => 'The ID of the resource group.'."\n", + 'type' => 'string', + 'required' => false, + 'example' => '"110123123"', + ], + ], + [ + 'name' => 'tags', + 'in' => 'query', + 'style' => 'json', + 'schema' => [ + 'description' => 'The tags.'."\n", + 'type' => 'array', + 'items' => [ + 'type' => 'object', + 'properties' => [ + 'key' => [ + 'description' => 'The tag key.'."\n", + 'type' => 'string', + 'required' => false, + 'example' => 'foo', + ], + 'value' => [ + 'description' => 'The tag value.'."\n", + 'type' => 'string', + 'required' => false, + 'example' => 'bar', + ], + ], + 'required' => false, + 'description' => 'The tag dictionary. ', + ], + 'required' => false, + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'description' => 'The response body.'."\n", + 'type' => 'object', + 'properties' => [ + 'totalCount' => [ + 'description' => 'The total number of entries returned.'."\n", + 'type' => 'integer', + 'format' => 'int32', + 'example' => '1', + ], + 'requestId' => [ + 'description' => 'The request ID.'."\n", + 'type' => 'string', + 'example' => '0A6EB64B-B4C8-CF02-810F-E660812972FF', + ], + 'result' => [ + 'description' => 'The information about the application.'."\n" + ."\n" + .'For more information, see [AppGroup](~~170000~~).'."\n", + 'type' => 'array', + 'items' => [ + 'description' => 'The result body.'."\n", + 'type' => 'object', + 'properties' => [ + 'created' => [ + 'description' => 'The timestamp when the application was created.'."\n", + 'type' => 'integer', + 'format' => 'int32', + 'example' => '1575442875', + ], + 'currentVersion' => [ + 'description' => 'The ID of the current online version.'."\n", + 'type' => 'string', + 'example' => '110116134', + ], + 'lockMode' => [ + 'description' => 'The lock state. Valid values:'."\n" + ."\n" + .'* Unlock: The instance is unlocked.'."\n" + .'* LockByExpiration: The instance is automatically locked after it expires.'."\n" + .'* ManualLock: The instance is manually locked.'."\n", + 'type' => 'string', + 'example' => 'Unlock', + ], + 'updated' => [ + 'description' => 'The timestamp when the application was last updated.'."\n", + 'type' => 'integer', + 'format' => 'int32', + 'example' => '1578916076', + ], + 'id' => [ + 'description' => 'The application ID.'."\n", + 'type' => 'string', + 'example' => '110116134', + ], + 'chargeType' => [ + 'description' => 'The billing method. Valid values:'."\n" + ."\n" + .'* POSTPAY: pay-as-you-go.'."\n" + .'* PREPAY: subscription.'."\n", + 'type' => 'string', + 'example' => 'POSTPAY', + ], + 'hasPendingQuotaReviewTask' => [ + 'description' => 'The approval state of the quotas. Valid values:'."\n" + ."\n" + .'* 0: The application is in service.'."\n" + .'* 1: The quotas are being reviewed.'."\n", + 'type' => 'integer', + 'format' => 'int32', + 'example' => '0', + ], + 'name' => [ + 'description' => 'The application name.'."\n", + 'type' => 'string', + 'example' => 'os_function_test_v1', + ], + 'instanceId' => [ + 'description' => 'The instance ID.'."\n", + 'type' => 'string', + 'example' => '"xxx"', + ], + 'chargingWay' => [ + 'description' => 'The billable item. Valid values:'."\n" + ."\n" + .'* 1: computing resources.'."\n" + .'* 2: queries per second (QPS).'."\n", + 'type' => 'integer', + 'format' => 'int32', + 'example' => '1', + ], + 'type' => [ + 'description' => 'The type of the application. Valid values:'."\n" + ."\n" + .'* standard: a High-performance Search Edition application.'."\n" + .'* enhanced: an Industry Algorithm Edition application.', + 'type' => 'string', + 'example' => 'enhanced', + ], + 'status' => [ + 'description' => 'The state of the application. Valid values:'."\n" + ."\n" + .'* producing: The application is being created.'."\n" + .'* review_pending: The application is being reviewed.'."\n" + .'* config_pending: The application is to be configured.'."\n" + .'* normal: The application is in service.'."\n" + .'* frozen: The application is frozen.'."\n", + 'type' => 'string', + 'example' => 'normal', + ], + 'projectId' => [ + 'description' => 'The name of the A/B test group.'."\n", + 'type' => 'string', + 'example' => '"xxx"', + ], + 'switchedTime' => [ + 'description' => 'The timestamp when the current online version was published.'."\n", + 'type' => 'integer', + 'format' => 'int32', + 'example' => '0', + ], + 'commodityCode' => [ + 'description' => 'The commodity code.'."\n", + 'type' => 'string', + 'example' => 'opensearch', + ], + 'expireOn' => [ + 'description' => 'The time when the application expired.'."\n", + 'type' => 'string', + 'example' => '"xxx"', + ], + 'domain' => [ + 'description' => 'The industry of the application.'."\n", + 'type' => 'string', + 'example' => '""', + ], + 'description' => [ + 'description' => 'The description of the application.'."\n", + 'type' => 'string', + 'example' => '"xxx"', + ], + 'produced' => [ + 'description' => 'Indicates whether the application is created. Valid values:'."\n" + ."\n" + .'* 0: The application is being created.'."\n" + .'* 1: The application is created.'."\n", + 'type' => 'integer', + 'format' => 'int32', + 'example' => '1', + ], + 'lockedByExpiration' => [ + 'description' => 'Indicates whether the instance is automatically locked after it expires.'."\n", + 'type' => 'integer', + 'format' => 'int32', + 'example' => '0', + ], + 'quota' => [ + 'description' => 'The information about the quotas of the application. For more information, see [Quota](~~170001~~).'."\n", + 'type' => 'object', + 'properties' => [ + 'spec' => [ + 'description' => 'The specifications. Valid values:'."\n" + ."\n" + .'* opensearch.share.junior: basic.'."\n" + .'* opensearch.share.common: shared general-purpose.'."\n" + .'* opensearch.share.compute: shared computing.'."\n" + .'* opensearch.share.storage: shared storage.'."\n" + .'* opensearch.private.common: exclusive general-purpose.'."\n" + .'* opensearch.private.compute: exclusive computing.'."\n" + .'* opensearch.private.storage: exclusive storage.'."\n", + 'type' => 'string', + 'example' => 'opensearch.share.common', + ], + 'docSize' => [ + 'description' => 'The storage capacity. Unit: GB.'."\n", + 'type' => 'integer', + 'format' => 'int32', + 'example' => '1', + ], + 'computeResource' => [ + 'description' => 'The computing resources. Unit: logical computing unit (LCU).'."\n", + 'type' => 'integer', + 'format' => 'int32', + 'example' => '20', + ], + ], + 'example' => '{}', + ], + 'tags' => [ + 'description' => 'The application tags.'."\n", + 'type' => 'array', + 'items' => [ + 'description' => 'The tag dictionary.', + 'type' => 'object', + 'properties' => [ + 'key' => [ + 'description' => 'The tag key.'."\n", + 'type' => 'string', + 'example' => 'foo', + ], + 'value' => [ + 'description' => 'The tag value.'."\n", + 'type' => 'string', + 'example' => 'bar', + ], + ], + ], + ], + 'engineType' => [ + 'description' => 'The engine type.'."\n", + '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":"<requestId>0A6EB64B-B4C8-CF02-810F-E660812972FF</requestId>\\n<totalCount>1</totalCount>\\n<result>\\n <id>110116134</id>\\n <name>os_function_test_v1</name>\\n <currentVersion>110116134</currentVersion>\\n <switchedTime>0</switchedTime>\\n <quota>\\n <docSize>1</docSize>\\n <computeResource>20</computeResource>\\n <spec>opensearch.share.common</spec>\\n </quota>\\n <chargingWay>1</chargingWay>\\n <type>enhanced</type>\\n <projectId/>\\n <chargeType>POSTPAY</chargeType>\\n <expireOn/>\\n <instanceId/>\\n <commodityCode>opensearch</commodityCode>\\n <processingOrderId/>\\n <firstRankAlgoDeploymentId>0</firstRankAlgoDeploymentId>\\n <secondRankAlgoDeploymentId>0</secondRankAlgoDeploymentId>\\n <pendingSecondRankAlgoDeploymentId>0</pendingSecondRankAlgoDeploymentId>\\n <description/>\\n <produced>1</produced>\\n <lockedByExpiration>0</lockedByExpiration>\\n <hasPendingQuotaReviewTask>0</hasPendingQuotaReviewTask>\\n <created>1575442875</created>\\n <updated>1578916076</updated>\\n <status>normal</status>\\n <lockMode>Unlock</lockMode>\\n</result>","errorExample":""}]', + 'title' => 'ListAppGroups', + 'description' => '* This operation allows you to query applications by application name, instance ID, and application type.'."\n" + .'* This operation allows you to sort the applications based on their creation time.'."\n" + .'* This operation supports the parameters for paging.'."\n", + 'requestParamsDescription' => ' ', + 'responseParamsDescription' => ' ', + 'extraInfo' => ' ', + ], + 'CreateApp' => [ + 'summary' => 'Creates a version for an OpenSearch application.', + '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' => 'The name of the application'."\n", + 'type' => 'string', + 'required' => true, + 'docRequired' => true, + 'example' => 'my_app_group_name', + ], + ], + [ + 'name' => 'dryRun', + 'in' => 'query', + 'schema' => [ + 'description' => 'Specifies whether to perform a dry run. This parameter is only used to check whether the data source is valid. Valid values: true and false.'."\n", + 'type' => 'boolean', + 'required' => false, + 'example' => 'true', + ], + ], + [ + 'name' => 'body', + 'in' => 'body', + 'style' => 'json', + 'schema' => [ + 'description' => 'The request body.'."\n", + 'type' => 'object', + 'properties' => [ + 'autoSwitch' => [ + 'description' => 'Specifies whether to automatically switch the created version to an online version. Valid values:'."\n" + ."\n" + .'* true'."\n" + .'* false'."\n", + 'type' => 'boolean', + 'required' => false, + 'example' => 'false', + ], + 'networkType' => [ + 'description' => 'The zone identifier. Valid values:'."\n" + ."\n" + .'* vpc'."\n" + .'* oxs'."\n", + 'type' => 'string', + 'required' => false, + 'example' => 'vpc', + ], + 'description' => [ + 'description' => 'The version description.'."\n", + 'type' => 'string', + 'required' => false, + 'example' => '"Version description"'."\n", + ], + 'schema' => [ + 'description' => 'The single-table schema.'."\n", + 'type' => 'object', + 'properties' => [ + 'tables' => [ + 'description' => 'The table schema.'."\n", + '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' => 'The index schema.'."\n", + 'type' => 'object', + 'properties' => [ + 'filterFields' => [ + 'description' => 'The attribute fields.'."\n", + 'type' => 'array', + 'items' => [ + 'description' => 'The attribute field.'."\n", + 'type' => 'string', + 'required' => false, + 'example' => 'id', + ], + 'required' => false, + ], + 'searchFields' => [ + 'description' => 'The index fields.'."\n", + 'type' => 'object', + 'required' => false, + 'example' => '{'."\n" + .' "fields": ["title"],'."\n" + .' "analyzer": "chn_standard"'."\n" + .'}', + ], + ], + 'required' => false, + ], + 'routeField' => [ + 'description' => 'The name of the level-1 routing field.'."\n", + 'type' => 'string', + 'required' => false, + 'example' => 'field1', + ], + 'routeFieldValues' => [ + 'description' => 'The hot values of the level-1 routing field. After you configure this parameter, level-2 routing is enabled.'."\n", + 'type' => 'array', + 'items' => [ + 'description' => 'The hot value of the level-1 routing field.'."\n", + 'type' => 'string', + 'required' => false, + 'example' => 'routeFieldValues', + ], + 'required' => false, + ], + 'secondRouteField' => [ + 'description' => 'The name of the level-2 routing field. This parameter takes effect only when the `routeFieldValues` parameter is configured. By default, the wide-table primary key field is used as the level-2 routing field.'."\n", + 'type' => 'string', + 'required' => false, + 'example' => 'field2', + ], + 'ttlField' => [ + 'description' => 'The document clearing configurations.'."\n", + 'type' => 'object', + 'properties' => [ + 'name' => [ + 'description' => 'The name of the document time field.'."\n", + 'type' => 'string', + 'required' => false, + 'example' => 'text1', + ], + 'ttl' => [ + 'description' => 'The TTL. Unit: milliseconds.'."\n", + 'type' => 'integer', + 'format' => 'int64', + 'required' => false, + 'example' => '1000', + ], + ], + 'required' => false, + ], + 'indexSortConfig' => [ + 'description' => 'The sort configurations.'."\n", + 'type' => 'array', + 'items' => [ + 'type' => 'object', + 'properties' => [ + 'field' => [ + 'description' => 'The sort field.'."\n", + 'type' => 'string', + 'required' => false, + 'example' => 'field1', + ], + 'direction' => [ + 'description' => 'The sort method.'."\n", + 'type' => 'string', + 'required' => false, + 'example' => 'ASC;'."\n" + .'DESC;', + ], + ], + 'required' => false, + 'description' => '', + 'title' => '倒排索引配置', + ], + 'required' => false, + ], + 'name' => [ + 'description' => 'The name of the wide table.'."\n", + 'type' => 'string', + 'required' => false, + 'example' => 'table_name', + ], + ], + 'required' => false, + ], + 'schemas' => [ + 'description' => 'The multi-table schema.'."\n", + 'type' => 'array', + 'items' => [ + 'description' => 'The single-table schema.'."\n", + 'type' => 'object', + 'properties' => [ + 'tables' => [ + 'description' => 'The table schema.'."\n", + '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' => 'The index schema.'."\n", + 'type' => 'object', + 'properties' => [ + 'filterFields' => [ + 'description' => 'The attribute fields.'."\n", + 'type' => 'array', + 'items' => [ + 'description' => 'The attribute field.'."\n", + 'type' => 'string', + 'required' => false, + 'example' => 'id', + ], + 'required' => false, + ], + 'searchFields' => [ + 'description' => 'The index fields.'."\n", + 'type' => 'object', + 'required' => false, + 'example' => '{'."\n" + .' "fields": ["title"],'."\n" + .' "analyzer": "chn_standard"'."\n" + .'}', + ], + ], + 'required' => false, + ], + 'routeField' => [ + 'description' => 'The name of the level-1 routing field.'."\n", + 'type' => 'string', + 'required' => false, + 'example' => 'field1', + ], + 'routeFieldValues' => [ + 'description' => 'The hot values of the level-1 routing field. After you configure this parameter, level-2 routing is enabled.'."\n", + 'type' => 'array', + 'items' => [ + 'description' => 'The hot value of the level-1 routing field.'."\n", + 'type' => 'string', + 'required' => false, + 'example' => 'routeFieldValues'."\n", + ], + 'required' => false, + ], + 'secondRouteField' => [ + 'description' => 'The name of the level-2 routing field. This parameter takes effect only when the routeFieldValues parameter is configured. By default, the wide-table primary key field is used as the level-2 routing field.'."\n", + 'type' => 'string', + 'required' => false, + 'example' => 'field2', + ], + 'ttlField' => [ + 'description' => 'The document clearing configurations.'."\n", + 'type' => 'object', + 'properties' => [ + 'name' => [ + 'description' => 'The name of the document time field.'."\n", + 'type' => 'string', + 'required' => false, + 'example' => 'text1', + ], + 'ttl' => [ + 'description' => 'The TTL. Unit: milliseconds.'."\n", + 'type' => 'integer', + 'format' => 'int64', + 'required' => false, + 'example' => '1000', + ], + ], + 'required' => false, + ], + 'indexSortConfig' => [ + 'description' => 'The sort configurations.'."\n", + 'type' => 'array', + 'items' => [ + 'type' => 'object', + 'properties' => [ + 'field' => [ + 'description' => 'The sort field.'."\n", + 'type' => 'string', + 'required' => false, + 'example' => 'field1', + ], + 'direction' => [ + 'description' => 'The sort method.'."\n" + ."\n" + .'* ASC'."\n" + .'* DESC'."\n", + 'type' => 'string', + 'required' => false, + 'example' => 'DESC', + ], + ], + 'required' => false, + 'description' => '', + 'title' => '倒排索引配置', + ], + 'required' => false, + 'title' => '', + ], + 'name' => [ + 'description' => 'The name of the wide table.'."\n", + 'type' => 'string', + 'required' => false, + 'example' => 'table_name', + ], + ], + 'required' => false, + ], + 'required' => false, + ], + 'firstRanks' => [ + 'description' => 'The configurations of rough sort.'."\n", + 'type' => 'array', + 'items' => [ + 'description' => 'The configurations of rough sort.'."\n", + 'type' => 'object', + 'properties' => [ + 'type' => [ + 'description' => 'The expression type. Valid values:'."\n" + ."\n" + .'* STRUCT: The content of the expression is a structure.'."\n" + .'* STRING (default): You can configure a custom formula.'."\n", + 'type' => 'string', + 'required' => false, + 'example' => 'STRING', + ], + 'name' => [ + 'description' => 'The name of the rough sort expression.'."\n", + 'type' => 'string', + 'required' => false, + 'example' => 'test', + ], + 'description' => [ + 'description' => 'The description.'."\n", + 'type' => 'string', + 'required' => false, + 'example' => 'Description'."\n", + ], + 'active' => [ + 'description' => 'Specifies whether the expression is the default one.'."\n", + 'type' => 'boolean', + 'required' => false, + 'example' => 'False', + ], + 'meta' => [ + 'description' => 'The information about the expression. The information can be of the array or string type.'."\n", + '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' => 'The configurations of fine sort.'."\n", + 'type' => 'array', + 'items' => [ + 'description' => 'The configurations of fine sort.'."\n", + 'type' => 'object', + 'properties' => [ + 'meta' => [ + 'description' => 'The fine sort expression. You can define an expression that contains fields, feature functions, and mathematical functions to implement complex sort logic.'."\n", + 'type' => 'any', + 'required' => false, + 'example' => '"cate_id > 0 and cate_id < 1000"', + ], + 'name' => [ + 'description' => 'The name of the fine sort expression.'."\n", + 'type' => 'string', + 'required' => false, + 'example' => 'default', + ], + 'description' => [ + 'description' => 'The description.'."\n", + 'type' => 'string', + 'required' => false, + 'example' => 'Description'."\n", + ], + 'active' => [ + 'description' => 'Specifies whether the expression is the default one.'."\n", + 'type' => 'boolean', + 'required' => false, + 'example' => 'False', + ], + ], + 'required' => false, + ], + 'required' => false, + ], + 'dataSources' => [ + 'description' => 'The configurations of data sources.'."\n", + 'type' => 'array', + 'items' => [ + 'description' => 'The configurations of the data source.'."\n", + 'type' => 'object', + 'properties' => [ + 'tableName' => [ + 'description' => 'The name of the table in the application.'."\n", + 'type' => 'string', + 'required' => false, + 'example' => 'main', + ], + 'type' => [ + 'description' => 'The type of the data source. Valid values:'."\n" + ."\n" + .'* rds'."\n" + .'* odps'."\n" + .'* opensearch'."\n" + .'* polardb'."\n", + 'type' => 'string', + 'required' => false, + 'example' => 'rds', + ], + 'fields' => [ + 'description' => 'The information about field mappings.'."\n", + 'type' => 'array', + 'items' => [ + 'description' => 'The information about field mappings.'."\n", + 'type' => 'object', + 'required' => false, + 'example' => '{'."\n" + .' "id": "id"'."\n" + .' }', + ], + 'required' => false, + ], + 'plugins' => [ + 'description' => 'The plug-ins that are used for data processing.'."\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'."\n", + 'type' => 'object', + 'required' => false, + 'example' => '{'."\n" + .' "name": "JsonKeyValueExtractor",'."\n" + .' "parameters": {'."\n" + .' "key": "my_field"'."\n" + .'}'."\n" + .'}', + ], + 'keyField' => [ + 'description' => 'The primary key.'."\n", + 'type' => 'string', + 'required' => false, + 'example' => 'id', + ], + 'schemaName' => [ + 'description' => 'The name of the wide table.'."\n", + 'type' => 'string', + 'required' => false, + 'example' => 'table_name', + ], + 'parameters' => [ + 'description' => 'The information about the data source.'."\n", + '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' => 'The summary configurations of search results.'."\n", + 'type' => 'array', + 'items' => [ + 'description' => 'The summary configurations of search results.'."\n", + 'type' => 'object', + 'properties' => [ + 'name' => [ + 'description' => 'The group name.'."\n", + 'type' => 'string', + 'required' => false, + 'example' => 'default', + ], + 'meta' => [ + 'description' => 'The collection of summary configurations.'."\n", + 'type' => 'array', + 'items' => [ + 'description' => 'The summary configurations.'."\n", + 'type' => 'object', + 'properties' => [ + 'field' => [ + 'description' => 'The field.'."\n", + 'type' => 'string', + 'required' => false, + 'example' => 'field1', + ], + 'len' => [ + 'description' => 'The length of the segment. Valid values: 1 to 300.'."\n", + 'type' => 'integer', + 'format' => 'int32', + 'required' => false, + 'example' => '50', + ], + 'element' => [ + 'description' => 'The element that is used for highlighting.'."\n", + 'type' => 'string', + 'required' => false, + 'example' => 'em', + ], + 'ellipsis' => [ + 'description' => 'The connector that is used to connect segments.'."\n", + 'type' => 'string', + 'required' => false, + 'example' => '...', + ], + 'snippet' => [ + 'description' => 'The number of segments. Valid values: 1 to 5.'."\n", + 'type' => 'string', + 'required' => false, + 'example' => '1', + ], + ], + 'required' => false, + ], + 'required' => false, + ], + ], + 'required' => false, + ], + 'required' => false, + ], + 'fetchFields' => [ + 'description' => 'The default display fields.'."\n", + 'type' => 'array', + 'items' => [ + 'description' => 'The field.'."\n", + 'type' => 'string', + 'required' => false, + 'example' => 'field1', + ], + 'required' => false, + ], + 'queryProcessors' => [ + 'description' => 'The query intent understanding configurations.'."\n", + 'type' => 'array', + 'items' => [ + 'description' => 'The query intent understanding configurations.'."\n", + 'type' => 'object', + 'properties' => [ + 'name' => [ + 'description' => 'The rule name.'."\n", + 'type' => 'string', + 'required' => false, + 'example' => 'name', + ], + 'domain' => [ + 'description' => 'The industry type. Valid values:'."\n" + ."\n" + .'* GENERAL'."\n" + .'* ECOMMERCE'."\n" + .'* IT_CONTENT'."\n", + 'type' => 'string', + 'required' => false, + 'example' => 'ECOMMERCE', + ], + 'category' => [ + 'description' => 'The industry category.'."\n", + 'type' => 'string', + 'required' => false, + 'example' => '""', + ], + 'processors' => [ + 'description' => 'The features.'."\n", + 'type' => 'array', + 'items' => [ + 'description' => 'The feature.'."\n", + 'type' => 'object', + 'required' => false, + 'example' => '{'."\n" + .'"name": "stop_word", "useSystemDictionary": true,'."\n" + .'"interventionDictionary": "my_dict",'."\n" + .' "ignoreSpace": true'."\n" + .'}', + ], + 'required' => false, + ], + 'indexes' => [ + 'description' => 'The index range.'."\n", + 'type' => 'array', + 'items' => [ + 'description' => 'The index.'."\n", + 'type' => 'string', + 'required' => false, + 'example' => 'default', + ], + 'required' => false, + ], + 'active' => [ + 'description' => 'Specifies whether the rule is the default one.'."\n", + 'type' => 'boolean', + 'required' => false, + 'example' => 'True', + ], + ], + 'required' => false, + ], + 'required' => false, + ], + 'cluster' => [ + 'description' => 'The capability opening configurations.'."\n", + 'type' => 'object', + 'properties' => [ + 'maxTimeoutMS' => [ + 'description' => 'The timeout period. Unit: milliseconds.'."\n", + 'type' => 'integer', + 'format' => 'int32', + 'required' => false, + 'example' => '750', + ], + 'maxQueryClauseLength' => [ + 'description' => 'The maximum length of the query clause.'."\n", + 'type' => 'integer', + 'format' => 'int32', + 'required' => false, + 'example' => '1024', + ], + 'textSparseEmbeddingModel' => [ + 'title' => '用于指定LLM应用版本使用的稀疏向量模型', + 'type' => 'string', + 'example' => 'ops-text-sparse-embedding-001', + ], + 'textEmbeddingModel' => [ + 'title' => '用于指定LLM应用版本使用的文本向量化模型', + 'type' => 'string', + 'example' => 'ops-text-embedding-002', + ], + 'chunkModels' => [ + 'title' => '切片方式', + 'type' => 'array', + 'items' => [ + 'title' => '切片方式配置项', + 'type' => 'object', + ], + ], + 'imageContentRecognizerModels' => [ + 'title' => '图片内容识别的模型', + 'type' => 'array', + 'items' => [ + 'title' => '图片内容识别的模型配置项', + 'type' => 'object', + ], + ], + 'graphRag' => [ + 'title' => 'GraphRAG集成配置', + 'type' => 'object', + ], + 'vectorIndexConfigs' => [ + 'title' => '独享型向量索引高级配置', + 'type' => 'array', + 'items' => [ + 'title' => '独享型向量索引高级配置配置项', + 'type' => 'object', + ], + ], + ], + 'required' => false, + ], + 'domain' => [ + 'description' => 'The industry model module.'."\n", + 'type' => 'object', + 'properties' => [ + 'name' => [ + 'description' => 'The industry type.'."\n", + 'type' => 'string', + 'required' => false, + 'example' => 'ecommerce', + ], + 'category' => [ + 'description' => 'The industry category.'."\n", + 'type' => 'string', + 'required' => false, + 'example' => 'general', + ], + 'functions' => [ + 'description' => 'The selected feature category. Valid values:'."\n" + ."\n" + .'* qp: query analysis'."\n" + .'* algo: sort policy'."\n" + .'* service: service'."\n", + 'type' => 'object', + 'required' => false, + 'example' => '{"qp":["spellcheck"],"algo":["pop"],"service":["suggest"]}', + ], + ], + 'required' => false, + ], + 'realtimeShared' => [ + 'title' => '是否共享实时流', + 'type' => 'boolean', + ], + 'interpretations' => [ + 'title' => 'LLM表字段描述', + 'type' => 'array', + 'items' => [ + 'title' => 'LLM表字段描述', + 'type' => 'object', + ], + ], + 'prompts' => [ + 'title' => 'prompt配置', + 'type' => 'array', + 'items' => [ + 'title' => '请求体中第一个提示内容', + 'type' => 'object', + ], + ], + 'configItems' => [ + 'title' => '请求体中的配置项列表', + 'type' => 'array', + 'items' => [ + 'title' => '配置项列表中的第一个元素', + 'type' => 'object', + ], + ], + ], + 'required' => false, + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'type' => 'object', + 'properties' => [ + 'requestId' => [ + 'description' => 'The request ID.'."\n", + 'type' => 'string', + 'example' => 'ABCDEFG', + ], + 'result' => [ + 'description' => 'The response parameters.'."\n", + 'type' => 'object', + 'properties' => [ + 'id' => [ + 'description' => 'The application ID.'."\n", + 'type' => 'string', + 'example' => '12888', + ], + 'isCurrent' => [ + 'description' => 'Indicates whether the version is an online version.'."\n", + 'type' => 'boolean', + 'example' => '12333', + ], + 'clusterName' => [ + 'description' => 'The name of the cluster.'."\n", + 'type' => 'string', + 'example' => 'vpc_sh_domain_1', + 'deprecated' => true, + ], + 'type' => [ + 'description' => 'The type of the application. Valid values:'."\n" + ."\n" + .'* standard'."\n" + .'* enhanced'."\n", + 'type' => 'string', + 'example' => 'standard', + ], + 'description' => [ + 'description' => 'The description of the application.'."\n", + 'type' => 'string', + 'example' => 'My application'."\n", + ], + 'status' => [ + 'description' => 'The status of the application. Valid values:'."\n" + ."\n" + .'* OK'."\n" + .'* STOPPED'."\n" + .'* FROZEN'."\n" + .'* INITIALIZING'."\n" + .'* UNAVAILABLE'."\n" + .'* DATA_WAITING'."\n" + .'* DATA_PREPARING'."\n", + 'type' => 'string', + 'example' => 'OK', + ], + 'schema' => [ + 'description' => 'The single-table schema.'."\n", + 'type' => 'object', + 'properties' => [ + 'tables' => [ + 'description' => 'The table schema.'."\n", + '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' => 'The index schema.'."\n", + 'type' => 'object', + 'properties' => [ + 'filterFields' => [ + 'description' => 'The attribute fields.'."\n", + 'type' => 'array', + 'items' => [ + 'description' => 'The attribute field.'."\n", + 'type' => 'string', + 'example' => 'id', + ], + ], + 'searchFields' => [ + 'description' => 'The index fields.'."\n", + 'type' => 'object', + 'example' => '{'."\n" + .' "fields": ["title"],'."\n" + .' "analyzer": "chn_standard"'."\n" + .'}', + ], + ], + ], + 'routeField' => [ + 'description' => 'The name of the level-1 routing field.'."\n", + 'type' => 'string', + 'example' => 'field1', + ], + 'routeFieldValues' => [ + 'description' => 'The name of the level-2 routing field. This parameter takes effect only when the routeFieldValues parameter is configured. By default, the wide-table primary key field is used as the level-2 routing field.'."\n", + 'type' => 'array', + 'items' => [ + 'description' => 'The hot value of the level-1 routing field.'."\n", + 'type' => 'string', + 'example' => 'routeFieldValues', + ], + ], + 'secondRouteField' => [ + 'description' => 'The name of the level-2 routing field. This parameter takes effect only when the routeFieldValues parameter is configured. By default, the wide-table primary key field is used as the level-2 routing field.'."\n", + 'type' => 'string', + 'example' => 'field2'."\n", + ], + 'ttlField' => [ + 'description' => 'The document clearing configurations.'."\n", + 'type' => 'object', + 'properties' => [ + 'name' => [ + 'description' => 'The name of the document time field.'."\n", + 'type' => 'string', + 'example' => 'text1'."\n", + ], + 'ttl' => [ + 'description' => 'The TTL. Unit: milliseconds.'."\n", + 'type' => 'integer', + 'format' => 'int64', + 'example' => '1000', + ], + ], + ], + 'indexSortConfig' => [ + 'description' => 'The sort configurations.'."\n", + 'type' => 'array', + 'items' => [ + 'description' => 'The sort configurations.'."\n", + 'type' => 'object', + 'properties' => [ + 'field' => [ + 'description' => 'The sort field.'."\n", + 'type' => 'string', + 'example' => 'field1', + ], + 'direction' => [ + 'description' => 'The sort method. Valid values:'."\n" + ."\n" + .'* ASC'."\n" + .'* DESC'."\n", + 'type' => 'string', + 'example' => 'DESC', + ], + ], + ], + ], + 'name' => [ + 'description' => 'The name of the wide table.'."\n", + 'type' => 'string', + 'example' => 'test', + ], + ], + ], + 'progressPercent' => [ + 'description' => 'The percentage for the data import progress.'."\n", + 'type' => 'integer', + 'format' => 'int32', + 'example' => '100', + ], + 'fetchFields' => [ + 'description' => 'The default display fields.'."\n", + 'type' => 'array', + 'items' => [ + 'description' => 'The default display fields.'."\n", + 'type' => 'string', + 'example' => 'field1', + ], + ], + 'domain' => [ + 'description' => 'The industry model module.'."\n", + 'type' => 'object', + 'properties' => [ + 'category' => [ + 'description' => 'The industry category.'."\n", + 'type' => 'string', + 'example' => '-', + ], + 'name' => [ + 'description' => 'The industry type. Valid values:'."\n" + ."\n" + .'* GENERAL'."\n" + .'* ECOMMERCE'."\n" + .'* IT_CONTENT'."\n", + 'type' => 'string', + 'example' => 'GENERAL', + ], + 'functions' => [ + 'description' => 'The selected features.'."\n", + 'type' => 'object', + 'properties' => [ + 'service' => [ + 'description' => 'The features of the service category.'."\n", + 'type' => 'array', + 'items' => [ + 'description' => 'The feature of the service category.'."\n", + 'type' => 'string', + 'example' => 'suggest'."\n" + ."\n", + ], + ], + 'qp' => [ + 'description' => 'The features of the query analysis category.'."\n", + 'type' => 'array', + 'items' => [ + 'description' => 'The feature of the query analysis category.'."\n", + 'type' => 'string', + 'example' => 'spellcheck', + ], + ], + 'algo' => [ + 'description' => 'The features of the sort policy category.'."\n", + 'type' => 'array', + 'items' => [ + 'description' => 'The feature of the sort policy category.'."\n", + 'type' => 'string', + 'example' => 'pop', + ], + ], + ], + ], + ], + ], + 'schemas' => [ + 'description' => 'The multi-table schema.'."\n", + 'type' => 'array', + 'items' => [ + 'description' => 'The schema.'."\n", + 'type' => 'object', + 'properties' => [ + 'tables' => [ + 'description' => 'The table schema.'."\n", + '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' => 'The index schema.'."\n", + 'type' => 'object', + 'properties' => [ + 'filterFields' => [ + 'description' => 'The attribute fields.'."\n", + 'type' => 'array', + 'items' => [ + 'description' => 'The attribute field.'."\n", + 'type' => 'string', + 'example' => 'field1', + ], + ], + 'searchFields' => [ + 'description' => 'The index fields.'."\n", + 'type' => 'object', + 'example' => '{'."\n" + .' "fields": ["title"],'."\n" + .' "analyzer": "chn_standard"'."\n" + .'}'."\n", + ], + ], + ], + 'routeField' => [ + 'description' => 'The name of the level-1 routing field.'."\n", + 'type' => 'string', + 'example' => 'field1'."\n", + ], + 'routeFieldValues' => [ + 'description' => 'The hot values of the level-1 routing field. After you configure this parameter, level-2 routing is enabled.'."\n", + 'type' => 'array', + 'items' => [ + 'description' => 'The hot value of the level-1 routing field.'."\n", + 'type' => 'string', + 'example' => 'routeFieldValues', + ], + ], + 'secondRouteField' => [ + 'description' => 'The name of the level-2 routing field. This parameter takes effect only when the routeFieldValues parameter is configured. By default, the wide-table primary key field is used as the level-2 routing field.'."\n", + 'type' => 'string', + 'example' => 'field2', + ], + 'ttlField' => [ + 'description' => 'The document clearing configurations.'."\n", + 'type' => 'object', + 'properties' => [ + 'name' => [ + 'description' => 'The name of the document time field.'."\n", + 'type' => 'string', + 'example' => 'fIeld1', + ], + 'ttl' => [ + 'description' => 'The TTL. Unit: milliseconds.'."\n", + 'type' => 'integer', + 'format' => 'int64', + 'example' => '1000', + ], + ], + ], + 'indexSortConfig' => [ + 'description' => 'The sort configurations.'."\n", + 'type' => 'array', + 'items' => [ + 'description' => 'The sort configurations.'."\n", + 'type' => 'object', + 'properties' => [ + 'field' => [ + 'description' => 'The sort field.'."\n", + 'type' => 'string', + 'example' => 'fIeld1', + ], + 'direction' => [ + 'description' => 'The sort method. Valid values:'."\n" + ."\n" + .'* ASC'."\n" + .'* DESC'."\n", + 'type' => 'string', + 'example' => 'DESC', + ], + ], + ], + ], + 'name' => [ + 'description' => 'The name of the wide table.'."\n", + 'type' => 'string', + 'example' => 'main', + ], + ], + ], + ], + 'firstRanks' => [ + 'description' => 'The configurations of rough sort.'."\n", + 'type' => 'array', + 'items' => [ + 'description' => 'The configurations of rough sort.'."\n", + 'type' => 'object', + 'properties' => [ + 'type' => [ + 'description' => 'The expression type. Valid values:'."\n" + ."\n" + .'STRUCT: The content of the expression is a structure. STRING (default): You can configure a custom formula.'."\n", + 'type' => 'string', + 'example' => 'STRING', + ], + 'name' => [ + 'description' => 'The name of the rough sort expression.'."\n", + 'type' => 'string', + 'example' => 'test', + ], + 'description' => [ + 'description' => 'The description.'."\n", + 'type' => 'string', + 'example' => 'Description'."\n", + ], + 'active' => [ + 'description' => 'Indicates whether the expression is the default one.'."\n", + 'type' => 'boolean', + 'example' => 'False', + ], + 'meta' => [ + 'description' => 'The information about the expression. The information can be of the array or string type.'."\n", + 'type' => 'any', + 'example' => 'String :"random()*100+now()";'."\n" + .'Array: ['."\n" + .' {'."\n" + .' "attribute": "static_bm25()",'."\n" + .' "arg": "",'."\n" + .' "weight": 10'."\n" + .' }'."\n" + .' ]', + ], + ], + ], + ], + 'secondRanks' => [ + 'description' => 'The configurations of fine sort.'."\n", + 'type' => 'array', + 'items' => [ + 'description' => 'The configurations of fine sort.'."\n", + 'type' => 'object', + 'properties' => [ + 'meta' => [ + 'description' => 'The fine sort expression. You can define an expression that contains fields, feature functions, and mathematical functions to implement complex sort logic.'."\n", + 'type' => 'any', + 'example' => '"cate_id > 0 and cate_id < 1000"'."\n", + ], + 'name' => [ + 'description' => 'The name of the fine sort expression.'."\n", + 'type' => 'string', + 'example' => 'default'."\n", + ], + 'description' => [ + 'description' => 'The description.'."\n", + 'type' => 'string', + 'example' => 'default'."\n", + ], + 'active' => [ + 'description' => 'Indicates whether the expression is the default one.'."\n", + 'type' => 'boolean', + 'example' => 'False', + ], + ], + ], + ], + 'dataSources' => [ + 'description' => 'The configurations of the data sources.'."\n", + 'type' => 'array', + 'items' => [ + 'description' => 'The configurations of the data source.'."\n", + 'type' => 'object', + 'properties' => [ + 'tableName' => [ + 'description' => 'The name of the table in the application.'."\n", + 'type' => 'string', + 'example' => 'main', + ], + 'type' => [ + 'description' => 'The type of the data source. Valid values:'."\n" + ."\n" + .'* rds'."\n" + .'* odps'."\n" + .'* opensearch'."\n" + .'* polardb'."\n", + 'type' => 'string', + 'example' => 'rds', + ], + 'fields' => [ + 'description' => 'The information about field mappings.'."\n", + 'type' => 'array', + 'items' => [ + 'description' => 'The information about field mappings.'."\n", + 'type' => 'object', + 'example' => '{'."\n" + .' "id": "id"'."\n" + .' }'."\n", + ], + ], + 'plugins' => [ + 'description' => 'The plug-ins that are used for data processing.'."\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'."\n", + 'type' => 'object', + 'example' => '{'."\n" + .' "name": "JsonKeyValueExtractor",'."\n" + .' "parameters": {'."\n" + .' "key": "my_field"'."\n" + .'}'."\n" + .'}', + ], + 'keyField' => [ + 'description' => 'The primary key.'."\n", + 'type' => 'string', + 'example' => 'id', + ], + 'schemaName' => [ + 'description' => 'The name of the wide table.'."\n", + 'type' => 'string', + 'example' => 'table_name', + ], + 'parameters' => [ + 'description' => 'The information about the data source.'."\n", + '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' => 'The summary configurations of search results.'."\n", + 'type' => 'array', + 'items' => [ + 'description' => 'The summary configurations of search results.'."\n", + 'type' => 'object', + 'properties' => [ + 'name' => [ + 'description' => 'The group name.'."\n", + 'type' => 'string', + 'example' => 'fefault', + ], + 'meta' => [ + 'description' => 'The collection of summary configurations.'."\n", + 'type' => 'array', + 'items' => [ + 'description' => 'The summary configurations.'."\n", + 'type' => 'object', + 'properties' => [ + 'field' => [ + 'description' => 'The field.'."\n", + 'type' => 'string', + 'example' => 'field1', + ], + 'len' => [ + 'description' => 'The length of the segment. Valid values: 1 to 300.'."\n", + 'type' => 'integer', + 'format' => 'int32', + 'example' => '50', + ], + 'element' => [ + 'description' => 'The element that is used for highlighting.'."\n", + 'type' => 'string', + 'example' => 'em', + ], + 'ellipsis' => [ + 'description' => 'The connector that is used to connect segments.'."\n", + 'type' => 'string', + 'example' => '...', + ], + 'snippet' => [ + 'description' => 'The number of segments. Valid values: 1 to 5.'."\n", + 'type' => 'string', + 'example' => '5', + ], + ], + ], + ], + ], + ], + ], + 'queryProcessors' => [ + 'description' => 'The query intent understanding configurations.'."\n", + 'type' => 'array', + 'items' => [ + 'description' => 'The query intent understanding configurations.'."\n", + 'type' => 'object', + 'properties' => [ + 'name' => [ + 'description' => 'The rule name.'."\n", + 'type' => 'string', + 'example' => 'test', + ], + 'domain' => [ + 'description' => 'The industry type. Valid values:'."\n" + ."\n" + .'* GENERAL'."\n" + .'* ECOMMERCE'."\n" + .'* IT_CONTENT'."\n", + 'type' => 'string', + 'example' => 'GENERAL', + ], + 'category' => [ + 'description' => 'The industry category.'."\n", + 'type' => 'string', + 'example' => '""', + ], + 'processors' => [ + 'description' => 'The features.'."\n", + 'type' => 'array', + 'items' => [ + 'description' => 'The feature.'."\n", + 'type' => 'object', + 'example' => '{'."\n" + .'"name": "stop_word", "useSystemDictionary": true,'."\n" + .'"interventionDictionary": "my_dict",'."\n" + .' "ignoreSpace": true'."\n" + .'}', + ], + ], + 'indexes' => [ + 'description' => 'The index range.'."\n", + 'type' => 'array', + 'items' => [ + 'description' => 'The index.'."\n", + 'type' => 'string', + 'example' => 'id', + ], + ], + 'active' => [ + 'description' => 'Indicates whether the rule is the default one.'."\n", + 'type' => 'boolean', + 'example' => 'False', + ], + ], + ], + ], + 'cluster' => [ + 'description' => 'The capability opening configurations.'."\n", + 'type' => 'object', + 'properties' => [ + 'maxTimeoutMS' => [ + 'description' => 'The timeout period. Unit: milliseconds.'."\n", + 'type' => 'integer', + 'format' => 'int32', + 'example' => '750', + ], + 'maxQueryClauseLength' => [ + 'description' => 'The maximum length of the query clause.'."\n", + 'type' => 'integer', + 'format' => 'int32', + 'example' => '1024', + ], + 'textEmbeddingModel' => [ + 'title' => '用于指定LLM应用版本使用的文本向量化模型', + 'type' => 'string', + ], + 'textSparseEmbeddingModel' => [ + 'title' => '用于指定LLM应用版本使用的稀疏向量模型', + 'type' => 'string', + ], + 'chunkModels' => [ + 'title' => '用于指定LLM应用版本使用的切片方式', + 'type' => 'array', + 'items' => [ + 'title' => '切片方式配置项', + 'type' => 'object', + ], + ], + 'imageContentRecognizerModels' => [ + 'title' => '用于指定LLM应用版本使用的图片内容识别的模型', + 'type' => 'array', + 'items' => [ + 'title' => '图片内容识别的模型配置项', + 'type' => 'object', + ], + ], + 'graphRag' => [ + 'title' => '用于指定LLM应用版本使用的GraphRAG集成配置', + 'type' => 'object', + ], + 'vectorIndexConfigs' => [ + 'title' => '独享型向量索引高级配置', + 'type' => 'array', + 'items' => [ + 'title' => '独享型向量索引高级配置配置项', + 'type' => 'object', + ], + ], + ], + ], + 'prompts' => [ + 'description' => 'The prompt configurations'."\n", + 'type' => 'array', + 'items' => [ + 'description' => 'The prompt configurations'."\n", + 'type' => 'object', + 'example' => '{ "name" : "prompt_name", "isDefault" : false, "description":"Description", "prompt" : { "parameters" : \\[ { "name" : "docs", "value" : "The way in which the content of documents is concatenated, such as \'\\<article>\\n${doc}\\n\\</article>\\n." } ], "messages":\\[ { "role" : "role_name: specifies whether to specify only system, user, or assistant or specify a custom value.", "content" : "The content of the prompt configured by the user. ${parameter_key} can be used to specify the content that you want to dynamically replace. For more information about replacement rules, see the following instructions." } ] } }'."\n", + ], + ], + 'quota' => [ + 'description' => 'The quota.'."\n", + 'type' => 'object', + 'properties' => [ + 'qps' => [ + 'description' => 'The search request.'."\n", + 'type' => 'integer', + 'format' => 'int32', + 'example' => '5', + ], + 'computeResource' => [ + 'description' => 'The computing resources.'."\n", + 'type' => 'integer', + 'format' => 'int32', + 'example' => '20', + ], + 'docSize' => [ + 'description' => 'The storage capacity.'."\n", + 'type' => 'integer', + 'format' => 'int32', + 'example' => '1', + ], + 'spec' => [ + 'description' => 'The specifications. Valid values:'."\n" + ."\n" + .'* opensearch.share.junior: basic'."\n" + .'* opensearch.share.common: shared general-purpose'."\n" + .'* opensearch.share.compute: shared computing'."\n" + .'* opensearch.share.storage: shared storage'."\n" + .'* opensearch.private.common: exclusive general-purpose'."\n" + .'* opensearch.private.compute: exclusive computing'."\n" + .'* opensearch.private.storage: exclusive storage'."\n", + 'type' => 'string', + 'example' => 'opensearch.share.common', + ], + 'usedQps' => [ + 'title' => '已使用的QPS', + 'type' => 'integer', + 'format' => 'int32', + 'example' => '100', + ], + 'usedDocSize' => [ + 'title' => '已使用的文档存储空间', + 'type' => 'number', + 'format' => 'double', + 'example' => '1024', + ], + 'usedComputeResource' => [ + 'title' => '已使用的计算资源配额', + 'type' => 'integer', + 'format' => 'int32', + 'example' => '100', + ], + ], + ], + 'interpretations' => [ + 'description' => 'The descriptions of the LLM table fields.'."\n", + 'type' => 'array', + 'example' => '{ "name": "longyu_llm\\_1", "schemas": \\[], "interpretations": \\[ { "table": "table1", "fields": \\[ { "name": "field1", "interpretation": "Title" }, { "name": "field2", "interpretation": "Number" } ] } ] }'."\n", + 'title' => 'LLM表字段描述', + 'items' => [ + 'title' => 'LLM表字段描述', + 'type' => 'object', + ], + ], + 'configItems' => [ + 'title' => '配置项列表', + 'type' => 'array', + 'items' => [ + 'title' => '配置项列表中的第一个元素', + 'type' => 'object', + ], + ], + 'updated' => [ + 'title' => '变更时间', + 'type' => 'integer', + 'format' => 'int64', + ], + 'created' => [ + 'title' => '创建时间', + 'type' => 'integer', + 'format' => 'int64', + ], + 'switchTime' => [ + 'title' => '切换上线时间', + 'type' => 'integer', + 'format' => 'int64', + ], + ], + 'example' => '{}', + ], + ], + 'description' => '', + 'title' => '根节点或根目录', + ], + ], + '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的 \'<article>\\\\n${doc}\\\\n</article>\\\\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":"<requestId>8664F6B7-9DD8-096A-FA3E-EBEE199EB94C</requestId>\\n<result>\\n <id>123456</id>\\n <description/>\\n <status>initializing</status>\\n <fetchFields>id</fetchFields>\\n <fetchFields>title</fetchFields>\\n <fetchFields>buy</fetchFields>\\n <fetchFields>cate_id</fetchFields>\\n <fetchFields>cate_name</fetchFields>\\n <type>enhanced</type>\\n <schema>\\n <tables>\\n <main>\\n <name>main</name>\\n <primaryTable>true</primaryTable>\\n <fields>\\n <id>\\n <name>id</name>\\n <type>LITERAL</type>\\n <primaryKey>true</primaryKey>\\n </id>\\n <title>\\n <name>title</name>\\n <type>TEXT</type>\\n <primaryKey>false</primaryKey>\\n </title>\\n <buy>\\n <name>buy</name>\\n <type>INT</type>\\n <primaryKey>false</primaryKey>\\n </buy>\\n <cate_id>\\n <name>cate_id</name>\\n <type>INT</type>\\n <primaryKey>false</primaryKey>\\n </cate_id>\\n <cate_name>\\n <name>cate_name</name>\\n <type>LITERAL</type>\\n <primaryKey>false</primaryKey>\\n </cate_name>\\n </fields>\\n </main>\\n </tables>\\n <indexes>\\n <searchFields>\\n <id>\\n <fields>id</fields>\\n </id>\\n <default>\\n <fields>title</fields>\\n <analyzer>chn_standard</analyzer>\\n </default>\\n <cate_name>\\n <fields>cate_name</fields>\\n </cate_name>\\n </searchFields>\\n <filterFields>id</filterFields>\\n <filterFields>buy</filterFields>\\n <filterFields>cate_id</filterFields>\\n <filterFields>cate_name</filterFields>\\n </indexes>\\n </schema>\\n <algoDeploymentId>0</algoDeploymentId>\\n <created>0</created>\\n <progressPercent>0</progressPercent>\\n</result>","errorExample":""}]', + 'title' => 'CreateApp', + 'description' => '* When you create a standard application, a new version of the application is created if the specified application name already exists.'."\n" + .'* When you create a version of an existing application, you must specify the autoSwitch and realtimeShared parameters.'."\n" + .'* When you create a version of an existing application, the value of the quota parameter is the same as that of the quota parameter in the previous version of the application.'."\n" + .'* When you create a version of an existing application, the modification of the value of the quota parameter does not take effect.'."\n", + 'requestParamsDescription' => '**Request body**'."\n" + ."\n" + .'|Parameter|Type|Required|Example|Description|'."\n" + .'|---|---|---|---|---|'."\n" + .'|type|String|Yes|"standard"|The type of the application. Valid values:standard: standard edition.enhanced: advanced edition.|'."\n" + .'|schema|Object|Yes||The schema of the application.For more information, see [Schema](~~170003~~).|'."\n" + .'|fetchFields|Array|Yes|\\["id", "name"\\]|The default display fields.|'."\n" + .'|realtimeShared|Boolean|Yes|false|Specifies whether to synchronize real-time data between the online and offline versions of the application.|'."\n" + .'|autoSwitch|Boolean|Yes|false|Specifies whether to automatically publish the new version of the application.|'."\n" + .'|description|String|No|"demo"|The description of the application.|'."\n" + .'|quota|Object|No||The quota information about the application.For more information, see [Quota](~~170001~~).|'."\n" + .'|dataSources\\[\\]|Object|No||The information about each data source.For more information, see [DataSource](~~170005~~).|'."\n" + .'|firstRanks\\[\\]|Object|No||The information about each rough sort expression.For more information, see [FirstRank](~~170007~~).|'."\n" + .'|secondRanks\\[\\]|Object|No||The information about each fine sort expression.For more information, see [SecondRank](~~170008~~).|'."\n" + .'|queryProcessors\\[\\]|Object|No||The information about each query analysis rule.For more information, see [QueryProcessor](~~170014~~).|'."\n" + .'|summaries\\[\\]|Object|No||The settings of search result summaries.For more information, see [Summary](~~170016~~).|', + 'responseParamsDescription' => ' ', + 'extraInfo' => ' ', + ], + 'RemoveApp' => [ + 'summary' => 'Deletes a version of an OpenSearch application.', + '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' => 'The name or ID of the application.'."\n", + 'type' => 'string', + 'required' => true, + 'docRequired' => true, + 'example' => '“my_app_group_name”', + ], + ], + [ + 'name' => 'appId', + 'in' => 'path', + 'schema' => [ + 'description' => 'The ID of the version.'."\n", + 'type' => 'integer', + 'format' => 'int32', + 'required' => true, + 'docRequired' => true, + 'example' => '110116134', + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'type' => 'object', + 'properties' => [ + 'requestId' => [ + 'description' => 'The request ID.'."\n", + 'type' => 'string', + 'example' => '33477D76-C380-2D84-A4AD-043F52876CB1', + ], + 'result' => [ + 'description' => 'The return result.', + 'type' => 'array', + 'items' => [ + 'description' => 'The return result.', + 'type' => 'integer', + 'format' => 'int32', + 'example' => '""', + ], + ], + ], + 'description' => '', + ], + ], + '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' => 'RemoveApp', + ], + 'DescribeApps' => [ + 'summary' => 'Queries the version list of an OpenSearch application.', + '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' => 'my_app_group_name'."\n", + 'type' => 'string', + 'required' => true, + 'docRequired' => true, + 'example' => 'my_app_group_name', + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'type' => 'object', + 'properties' => [ + 'requestId' => [ + 'description' => 'The ID of the request.'."\n", + 'type' => 'string', + 'example' => '77CAA411-0010-4DB9-82E2-1C384E590AFF', + ], + 'result' => [ + 'description' => 'The response parameters.'."\n", + 'type' => 'array', + 'items' => [ + 'description' => 'The version information. For more information, see [App](~~170002~~).'."\n", + 'type' => 'object', + 'properties' => [ + 'id' => [ + 'description' => 'The group ID.'."\n", + 'type' => 'string', + 'example' => '100302881', + ], + 'isCurrent' => [ + 'description' => 'Indicates whether the version is an online version.'."\n", + 'type' => 'boolean', + 'example' => '12333', + ], + 'clusterName' => [ + 'description' => 'The cluster name.'."\n", + 'type' => 'string', + 'example' => 'vpc_sh_domain_1', + ], + 'autoSwitch' => [ + 'description' => 'Indicates whether the version is automatically switched to an online version.'."\n", + 'type' => 'boolean', + 'example' => 'true', + ], + 'type' => [ + 'description' => 'The type of the application. Valid values:'."\n" + ."\n" + .'* standard: a standard edition application.'."\n" + .'* advance: an advanced edition application of an old version. New versions are not supported for this edition.'."\n" + .'* enhanced: an advanced edition application of a new version.'."\n", + 'type' => 'string', + 'example' => 'enhanced', + ], + 'description' => [ + 'description' => 'The description.'."\n", + 'type' => 'string', + 'example' => '""', + ], + 'status' => [ + 'description' => 'The status of the version. Valid values:'."\n" + ."\n" + .'* ok: The version is normal.'."\n" + .'* stopped: The version is suspended.'."\n" + .'* frozen: The version is frozen.'."\n" + .'* initializing: The version is being initialized.'."\n" + .'* unavailable: The version is invalid.'."\n" + .'* data_waiting: Data is to be initialized.'."\n" + .'* data_preparing: Data is being initialized.'."\n", + 'type' => 'string', + 'example' => 'normal', + ], + 'schema' => [ + 'description' => 'The application schema.'."\n", + 'type' => 'object', + 'properties' => [ + 'tables' => [ + 'description' => 'The table schema.'."\n", + 'type' => 'object', + ], + 'indexes' => [ + 'description' => 'The index schema.'."\n", + 'type' => 'object', + 'properties' => [ + 'filterFields' => [ + 'description' => 'The attribute fields.'."\n", + 'type' => 'array', + 'items' => [ + 'description' => 'The attribute field.'."\n", + 'type' => 'string', + 'example' => 'id', + ], + ], + 'searchFields' => [ + 'description' => 'The index fields.'."\n", + 'type' => 'object', + ], + ], + ], + 'routeField' => [ + 'description' => 'The level-1 routing field.'."\n", + 'type' => 'string', + 'example' => 'field1', + ], + 'routeFieldValues' => [ + 'description' => 'The hot values of the level-1 routing field.'."\n", + 'type' => 'array', + 'items' => [ + 'description' => 'The hot value of the level-1 routing field.'."\n", + 'type' => 'string', + 'example' => 'routeFieldValues', + ], + ], + 'secondRouteField' => [ + 'description' => 'The level-2 routing field. This parameter is returned if the routeFieldValues parameter is returned. By default, the wide-table primary key field is used as the level-2 routing field.'."\n", + 'type' => 'string', + 'example' => 'field2'."\n", + ], + 'ttlField' => [ + 'description' => 'The document clearing configurations.'."\n", + 'type' => 'object', + 'properties' => [ + 'name' => [ + 'description' => 'The document clearing field.'."\n", + 'type' => 'string', + 'example' => 'text1'."\n", + ], + 'ttl' => [ + 'description' => 'The TTL. Unit: milliseconds.'."\n", + 'type' => 'integer', + 'format' => 'int64', + 'example' => '1000', + ], + ], + ], + 'indexSortConfig' => [ + 'description' => 'The sort configurations.'."\n", + 'type' => 'array', + 'items' => [ + 'description' => 'The sort configurations.'."\n", + 'type' => 'object', + 'properties' => [ + 'field' => [ + 'description' => 'The sort field.'."\n", + 'type' => 'string', + 'example' => 'field1', + ], + 'direction' => [ + 'description' => 'The sort method. Valid values:'."\n" + ."\n" + .'* ASC'."\n" + .'* DESC'."\n", + 'type' => 'string', + 'example' => 'DESC', + ], + ], + ], + ], + 'name' => [ + 'description' => 'The name of the wide table.'."\n", + 'type' => 'string', + 'example' => 'test', + ], + ], + ], + 'progressPercent' => [ + 'description' => 'The progress of data import, in percentage. For example, a value of 83 indicates 83%.'."\n", + 'type' => 'integer', + 'format' => 'int32', + 'example' => '100', + ], + 'fetchFields' => [ + 'description' => 'The default display fields.'."\n", + 'type' => 'array', + 'items' => [ + 'description' => 'The default display field.'."\n", + 'type' => 'string', + 'example' => '{}', + ], + ], + 'quota' => [ + 'description' => 'The quota information.'."\n", + 'type' => 'object', + 'properties' => [ + 'spec' => [ + 'description' => 'The specifications. Valid values:'."\n" + ."\n" + .'* opensearch.share.junior: basic'."\n" + .'* opensearch.share.common: shared general-purpose'."\n" + .'* opensearch.share.compute: shared computing'."\n" + .'* opensearch.share.storage: shared storage'."\n" + .'* opensearch.private.common: exclusive general-purpose'."\n" + .'* opensearch.private.compute: exclusive computing'."\n" + .'* opensearch.private.storage: exclusive storage'."\n", + 'type' => 'string', + 'example' => 'opensearch.share.common', + ], + 'qps' => [ + 'description' => 'The number of search requests per second. You are charged based on the number of search requests per second in the earlier billing model.'."\n", + 'type' => 'integer', + 'format' => 'int32', + 'example' => '5', + ], + 'docSize' => [ + 'description' => 'The storage capacity. Unit: GB.'."\n", + 'type' => 'integer', + 'format' => 'int32', + 'example' => '1', + ], + 'computeResource' => [ + 'description' => 'The computing resources. Unit: logical computing unit (LCU).'."\n", + 'type' => 'integer', + 'format' => 'int32', + 'example' => '20', + ], + ], + ], + 'domain' => [ + 'description' => 'The type of the industry. Valid values:'."\n" + ."\n" + .'* GENERAL'."\n" + .'* ECOMMERCE'."\n" + .'* IT_CONTENT'."\n", + 'type' => 'object', + 'properties' => [ + 'category' => [ + 'description' => 'The type of the edition. Valid values: standard, advance, and enhanced. A value of standard indicates a standard edition. A value of advance indicates an advanced edition which is of an old version. New version is not supported for this edition. A value of enhanced indicates an advanced edition which is of a new version.'."\n", + 'type' => 'string', + 'example' => '-', + ], + 'name' => [ + 'description' => 'The name (in English).'."\n", + 'type' => 'string', + 'example' => 'test', + ], + 'functions' => [ + 'description' => 'The search results.'."\n", + 'type' => 'object', + 'properties' => [ + 'service' => [ + 'description' => 'Feature 1.'."\n", + 'type' => 'array', + 'items' => [ + 'description' => 'Feature 1.'."\n", + 'type' => 'string', + 'example' => '-', + ], + ], + 'qp' => [ + 'description' => 'Information 1.'."\n", + 'type' => 'array', + 'items' => [ + 'description' => 'Information 1.'."\n", + 'type' => 'string', + 'example' => 'spellcheck', + ], + ], + 'algo' => [ + 'description' => 'Structure 1.'."\n", + 'type' => 'array', + 'items' => [ + 'description' => 'Structure 1.'."\n", + 'type' => 'string', + 'example' => 'pop', + ], + ], + ], + ], + ], + ], + 'schemas' => [ + 'description' => 'The single-table schema.'."\n", + 'type' => 'array', + 'items' => [ + 'description' => 'The single-table schema.'."\n", + 'type' => 'object', + 'properties' => [ + 'tables' => [ + 'description' => 'The table schema.'."\n", + 'type' => 'object', + ], + 'indexes' => [ + 'description' => 'The index schema.'."\n", + 'type' => 'object', + 'properties' => [ + 'filterFields' => [ + 'description' => 'The attribute fields.'."\n", + 'type' => 'array', + 'items' => [ + 'description' => 'The attribute field.'."\n", + 'type' => 'string', + 'example' => 'field1', + ], + ], + 'searchFields' => [ + 'description' => 'The index fields.'."\n", + 'type' => 'object', + ], + ], + ], + 'routeField' => [ + 'description' => 'The level-1 routing field.'."\n", + 'type' => 'string', + 'example' => 'field1'."\n", + ], + 'routeFieldValues' => [ + 'description' => 'The hot values of the level-1 routing field.'."\n", + 'type' => 'array', + 'items' => [ + 'description' => 'The hot value of the level-1 routing field.'."\n", + 'type' => 'string', + 'example' => 'routeFieldValues', + ], + ], + 'secondRouteField' => [ + 'description' => 'The level-2 routing field. This parameter is returned if the routeFieldValues parameter is returned. By default, the wide-table primary key field is used as the level-2 routing field.'."\n", + 'type' => 'string', + 'example' => 'field2', + ], + 'ttlField' => [ + 'description' => 'The document clearing configurations.'."\n", + 'type' => 'object', + 'properties' => [ + 'name' => [ + 'description' => 'The document time field.'."\n", + 'type' => 'string', + 'example' => 'fIeld1', + ], + 'ttl' => [ + 'description' => 'The TTL. Unit: milliseconds.'."\n", + 'type' => 'integer', + 'format' => 'int64', + 'example' => '1000', + ], + ], + ], + 'indexSortConfig' => [ + 'description' => 'The sort configurations.'."\n", + 'type' => 'array', + 'items' => [ + 'description' => 'The sort configurations.'."\n", + 'type' => 'object', + 'properties' => [ + 'field' => [ + 'description' => 'The sort field.'."\n", + 'type' => 'string', + 'example' => 'fIeld1', + ], + 'direction' => [ + 'description' => 'The sort method. Valid values:'."\n" + ."\n" + .'* ASC'."\n" + .'* DESC'."\n", + 'type' => 'string', + 'example' => 'DESC', + ], + ], + ], + ], + 'name' => [ + 'description' => 'The name of the wide table.'."\n", + 'type' => 'string', + 'example' => 'main', + ], + ], + ], + ], + 'firstRanks' => [ + 'description' => 'The configurations of rough sort.'."\n", + 'type' => 'array', + 'items' => [ + 'description' => 'The configurations of rough sort.'."\n", + 'type' => 'object', + 'properties' => [ + 'type' => [ + 'description' => 'The expression type. Valid values:'."\n" + ."\n" + .'STRUCT: The content of the expression is a structure. STRING (default): a custom formula.'."\n", + 'type' => 'string', + 'example' => 'STRING', + ], + 'name' => [ + 'description' => 'The name of the rough sort expression.'."\n", + 'type' => 'string', + 'example' => 'test', + ], + 'description' => [ + 'description' => 'The description.'."\n", + 'type' => 'string', + 'example' => 'Description'."\n", + ], + 'active' => [ + 'description' => 'Indicates whether the expression is the default one.'."\n", + 'type' => 'boolean', + 'example' => 'False', + ], + 'meta' => [ + 'description' => 'The information about the expression. The information is displayed in the array or string format.'."\n", + 'type' => 'any', + 'example' => 'String :"random()*100+now()";'."\n" + .'Array: ['."\n" + .' {'."\n" + .' "attribute": "static_bm25()",'."\n" + .' "arg": "",'."\n" + .' "weight": 10'."\n" + .' }'."\n" + .' ]', + ], + ], + ], + ], + 'secondRanks' => [ + 'description' => 'The configurations of fine sort.'."\n", + 'type' => 'array', + 'items' => [ + 'description' => 'The configurations of fine sort.'."\n", + 'type' => 'object', + 'properties' => [ + 'meta' => [ + 'description' => 'The fine sort expression. You can define an expression that consists of fields, feature functions, and mathematical functions to implement complex sort logic.'."\n", + 'type' => 'any', + 'example' => '"cate_id > 0 and cate_id < 1000"'."\n", + ], + 'name' => [ + 'description' => 'The name of the fine sort expression.'."\n", + 'type' => 'string', + 'example' => 'default'."\n", + ], + 'description' => [ + 'description' => 'The description.'."\n", + 'type' => 'string', + 'example' => 'Description'."\n", + ], + 'active' => [ + 'description' => 'Indicates whether the expression is the default one.'."\n", + 'type' => 'boolean', + 'example' => 'False', + ], + ], + ], + ], + 'dataSources' => [ + 'description' => 'The configurations of data sources.'."\n", + 'type' => 'array', + 'items' => [ + 'description' => 'The configurations of the data source.'."\n", + 'type' => 'object', + 'properties' => [ + 'tableName' => [ + 'description' => 'The name of the table in the application.'."\n", + 'type' => 'string', + 'example' => 'main', + ], + 'type' => [ + 'description' => 'The type of the data source. Valid values:'."\n" + ."\n" + .'* rds'."\n" + .'* odps'."\n" + .'* opensearch'."\n" + .'* polardb'."\n", + 'type' => 'string', + 'example' => 'rds', + ], + 'fields' => [ + 'description' => 'The information about field mappings.'."\n", + 'type' => 'array', + 'items' => [ + 'description' => 'The information about field mappings.'."\n", + 'type' => 'object', + ], + ], + 'plugins' => [ + 'description' => 'The plug-ins that are used for data processing.'."\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'."\n", + 'type' => 'object', + ], + 'keyField' => [ + 'description' => 'The primary key.'."\n", + 'type' => 'string', + 'example' => 'id', + ], + 'schemaName' => [ + 'description' => 'The name of the wide table.'."\n", + 'type' => 'string', + 'example' => 'name', + ], + 'parameters' => [ + 'description' => 'The information about the data source.'."\n", + 'type' => 'object', + ], + ], + ], + ], + 'summaries' => [ + 'description' => 'The search result summary configurations.'."\n", + 'type' => 'array', + 'items' => [ + 'description' => 'The search result summary configurations.'."\n", + 'type' => 'object', + 'properties' => [ + 'name' => [ + 'description' => 'The group name.'."\n", + 'type' => 'string', + 'example' => 'fefault', + ], + 'meta' => [ + 'description' => 'The summary configurations.'."\n", + 'type' => 'array', + 'items' => [ + 'description' => 'The summary configurations.'."\n", + 'type' => 'object', + 'properties' => [ + 'field' => [ + 'description' => 'The field.'."\n", + 'type' => 'string', + 'example' => 'field1', + ], + 'len' => [ + 'description' => 'The length of the segment. Valid values: 1 to 300.'."\n", + 'type' => 'integer', + 'format' => 'int32', + 'example' => '50', + ], + 'element' => [ + 'description' => 'The element that is used for highlighting.'."\n", + 'type' => 'string', + 'example' => 'em', + ], + 'ellipsis' => [ + 'description' => 'The connector that is used to connect segments.'."\n", + 'type' => 'string', + 'example' => '...', + ], + 'snippet' => [ + 'description' => 'The number of segments. Valid values: 1 to 5.'."\n", + 'type' => 'string', + 'example' => '5', + ], + ], + ], + ], + ], + ], + ], + 'queryProcessors' => [ + 'description' => 'The query intent understanding configurations.'."\n", + 'type' => 'array', + 'items' => [ + 'description' => 'The query intent understanding configurations.'."\n", + 'type' => 'object', + 'properties' => [ + 'name' => [ + 'description' => 'The rule name.'."\n", + 'type' => 'string', + 'example' => 'test', + ], + 'domain' => [ + 'description' => 'The type of the industry. Valid values:'."\n" + ."\n" + .'* GENERAL'."\n" + .'* ECOMMERCE'."\n" + .'* IT_CONTENT'."\n", + 'type' => 'string', + 'example' => 'GENERAL', + ], + 'category' => [ + 'description' => 'The industry category.'."\n", + 'type' => 'string', + 'example' => '""', + ], + 'processors' => [ + 'description' => 'The features.'."\n", + 'type' => 'array', + 'items' => [ + 'description' => 'The feature.'."\n", + 'type' => 'object', + ], + ], + 'indexes' => [ + 'description' => 'The indexes.'."\n", + 'type' => 'array', + 'items' => [ + 'description' => 'The index.'."\n", + 'type' => 'string', + 'example' => 'default', + ], + ], + 'active' => [ + 'description' => 'Indicates whether the rule is the default one.'."\n", + 'type' => 'boolean', + 'example' => 'False', + ], + ], + ], + ], + 'cluster' => [ + 'description' => 'The capability opening configurations.'."\n", + 'type' => 'object', + 'properties' => [ + 'maxTimeoutMS' => [ + 'description' => 'The timeout period. Unit: milliseconds.'."\n", + 'type' => 'integer', + 'format' => 'int32', + 'example' => '750', + ], + 'maxQueryClauseLength' => [ + 'description' => 'The maximum length of the query clause.'."\n", + 'type' => 'integer', + 'format' => 'int32', + 'example' => '1024', + ], + ], + ], + 'interpretations' => [ + 'description' => 'The field model.'."\n", + 'type' => 'object', + ], + 'prompts' => [ + 'description' => 'The prompt configurations.'."\n", + 'type' => 'array', + 'items' => [ + 'description' => 'The prompt configurations.'."\n", + 'type' => 'object', + ], + ], + ], + 'example' => '{}', + ], + ], + ], + 'description' => '', + ], + ], + '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":"<requestId>71AB199D-8F00-5E69-BDC6-2829553D9BBC</requestId>\\n<result>\\n <id>123123321</id>\\n <virtualCluster/>\\n <description/>\\n <created>1650264344</created>\\n <updated>1650264631</updated>\\n <type>standard</type>\\n <status>ok</status>\\n <progressPercent>100</progressPercent>\\n <quota>\\n <docSize>1</docSize>\\n <computeResource>1</computeResource>\\n <qps>0</qps>\\n <spec>opensearch.share.common</spec>\\n <usedDocSize>0</usedDocSize>\\n <usedComputeResource>0</usedComputeResource>\\n <usedQps>0</usedQps>\\n </quota>\\n <schema>\\n <tables>\\n <test>\\n <name>test</name>\\n <primaryTable>true</primaryTable>\\n <fields>\\n <description>\\n <name>description</name>\\n <primaryKey>false</primaryKey>\\n <type>LITERAL</type>\\n </description>\\n <id>\\n <name>id</name>\\n <primaryKey>true</primaryKey>\\n <type>INT</type>\\n </id>\\n </fields>\\n </test>\\n </tables>\\n <indexes>\\n <searchFields>\\n <description>\\n <fields>description</fields>\\n </description>\\n <id>\\n <fields>id</fields>\\n </id>\\n </searchFields>\\n <filterFields>id</filterFields>\\n <filterFields>description</filterFields>\\n </indexes>\\n </schema>\\n <fetchFields>id</fetchFields>\\n <fetchFields>description</fetchFields>\\n <firstRanks>\\n <name>default</name>\\n <description>sys default</description>\\n <active>true</active>\\n <created>1650264343</created>\\n <updated>1650264343</updated>\\n <type>STRUCT</type>\\n <meta>\\n <attribute>static_bm25()</attribute>\\n <arg/>\\n <weight>1</weight>\\n </meta>\\n </firstRanks>\\n <secondRanks>\\n <name>default</name>\\n <description>sys default</description>\\n <active>true</active>\\n <created>1650264343</created>\\n <updated>1650264343</updated>\\n <meta/>\\n <isDefault>true</isDefault>\\n </secondRanks>\\n <switchTime>1645520103</switchTime>\\n <isCurrent>false</isCurrent>\\n</result>\\n<result>\\n <id>121305419</id>\\n <virtualCluster/>\\n <description/>\\n <created>1645519817</created>\\n <updated>1645520103</updated>\\n <type>standard</type>\\n <status>ok</status>\\n <progressPercent>100</progressPercent>\\n <quota>\\n <docSize>1</docSize>\\n <computeResource>1</computeResource>\\n <qps>0</qps>\\n <spec>opensearch.share.common</spec>\\n <usedDocSize>0</usedDocSize>\\n <usedComputeResource>0</usedComputeResource>\\n <usedQps>0</usedQps>\\n </quota>\\n <schema>\\n <tables>\\n <test>\\n <name>test</name>\\n <primaryTable>true</primaryTable>\\n <fields>\\n <description>\\n <name>description</name>\\n <primaryKey>false</primaryKey>\\n <type>LITERAL</type>\\n </description>\\n <id>\\n <name>id</name>\\n <primaryKey>true</primaryKey>\\n <type>INT</type>\\n </id>\\n </fields>\\n </test>\\n </tables>\\n <indexes>\\n <searchFields>\\n <description>\\n <fields>description</fields>\\n </description>\\n <id>\\n <fields>id</fields>\\n </id>\\n </searchFields>\\n <filterFields>id</filterFields>\\n <filterFields>description</filterFields>\\n </indexes>\\n </schema>\\n <fetchFields>id</fetchFields>\\n <fetchFields>description</fetchFields>\\n <firstRanks>\\n <name>default</name>\\n <description>sys default</description>\\n <active>true</active>\\n <created>1645519817</created>\\n <updated>1645519817</updated>\\n <type>STRUCT</type>\\n <meta>\\n <attribute>static_bm25()</attribute>\\n <arg/>\\n <weight>1</weight>\\n </meta>\\n </firstRanks>\\n <secondRanks>\\n <name>default</name>\\n <description>sys default</description>\\n <active>true</active>\\n <created>1645519817</created>\\n <updated>1645519817</updated>\\n <meta/>\\n <isDefault>true</isDefault>\\n </secondRanks>\\n <switchTime>1645520103</switchTime>\\n <isCurrent>true</isCurrent>\\n</result>","errorExample":""}]', + 'title' => 'DescribeApps', + 'description' => '* When you create a standard application, a new version of the application is created if the specified application name already exists.'."\n" + .'* When you create a version of an existing application, you must specify the autoSwitch and realtimeShared parameters.'."\n" + .'* When you create a version of an existing application, the value of the quota parameter is the same as that of the quota parameter in the previous version of the application.'."\n" + .'* When you create a version of an existing application, the modification of the value of the quota parameter does not take effect.'."\n", + 'requestParamsDescription' => ' ', + 'responseParamsDescription' => ' ', + 'extraInfo' => ' ', + ], + 'DescribeApp' => [ + 'summary' => 'Queries the information about a version of an OpenSearch application.', + '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' => 'The name of the application'."\n", + 'type' => 'string', + 'required' => true, + 'docRequired' => true, + 'example' => 'my_app_group_name', + ], + ], + [ + 'name' => 'appId', + 'in' => 'path', + 'schema' => [ + 'description' => 'The version ID.'."\n", + 'type' => 'integer', + 'format' => 'int32', + 'required' => true, + 'docRequired' => true, + 'example' => '110116134', + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'description' => 'The response body.'."\n", + 'type' => 'object', + 'properties' => [ + 'requestId' => [ + 'description' => 'The request ID.'."\n", + 'type' => 'string', + 'example' => '33477D76-C380-1D84-A4AD-043F52876CB1', + ], + 'result' => [ + 'description' => 'The version information.'."\n", + 'type' => 'object', + 'properties' => [ + 'id' => [ + 'description' => 'The version ID.'."\n", + 'type' => 'string', + 'example' => '100303063', + ], + 'isCurrent' => [ + 'description' => 'Indices whether the version is an online version.'."\n", + 'type' => 'boolean', + 'example' => 'True', + ], + 'clusterName' => [ + 'description' => 'The cluster name.'."\n", + 'type' => 'string', + 'example' => '-', + ], + 'autoSwitch' => [ + 'description' => 'Indicates whether the version is automatically switched to an online version.'."\n", + 'type' => 'boolean', + 'example' => 'true', + ], + 'type' => [ + 'description' => 'The edition type. Valid values:'."\n" + ."\n" + .'* standard: a standard edition application.'."\n" + .'* advance: an advanced edition application of an old version. New versions are not supported for this edition.'."\n" + .'* enhanced: an advanced edition application of a new version.'."\n", + 'type' => 'string', + 'example' => 'enhanced', + ], + 'description' => [ + 'description' => 'The description of the version.'."\n", + 'type' => 'string', + 'example' => '-', + ], + 'status' => [ + 'description' => 'The status of the version. Valid values:'."\n" + ."\n" + .'* ok: The version is normal.'."\n" + .'* stopped: The version is suspended.'."\n" + .'* frozen: The version is frozen.'."\n" + .'* initializing: The version is being initialized.'."\n" + .'* unavailable: The version is invalid.'."\n" + .'* data_waiting: Data is to be initialized.'."\n" + .'* data_preparing: Data is being initialized.'."\n", + 'type' => 'string', + 'example' => 'ok', + ], + 'schema' => [ + 'description' => 'The schema of the application.'."\n", + 'type' => 'object', + 'properties' => [ + 'tables' => [ + 'description' => 'The table schema.'."\n", + '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' => 'The index schema.'."\n", + 'type' => 'object', + 'properties' => [ + 'filterFields' => [ + 'description' => 'The attribute fields.'."\n", + 'type' => 'array', + 'items' => [ + 'description' => 'The attribute field.'."\n", + 'type' => 'string', + 'example' => 'id', + ], + ], + 'searchFields' => [ + 'description' => 'The index fields.'."\n", + 'type' => 'object', + 'example' => '{'."\n" + .' "fields": ["title"],'."\n" + .' "analyzer": "chn_standard"'."\n" + .'}', + ], + ], + ], + 'routeField' => [ + 'description' => 'The name of the level-1 routing field.'."\n", + 'type' => 'string', + 'example' => 'field1', + ], + 'routeFieldValues' => [ + 'description' => 'The hot values of the level-1 routing field.'."\n", + 'type' => 'array', + 'items' => [ + 'description' => 'The hot value of the level-1 routing field.'."\n", + 'type' => 'string', + 'example' => 'routeFieldValues', + ], + ], + 'secondRouteField' => [ + 'description' => 'The name of the level-2 routing field. This parameter takes effect only when the routeFieldValues parameter is configured. By default, the wide-table primary key field is used as the level-2 routing field.'."\n", + 'type' => 'string', + 'example' => 'field2'."\n", + ], + 'ttlField' => [ + 'description' => 'The document clearing configurations.'."\n", + 'type' => 'object', + 'properties' => [ + 'name' => [ + 'description' => 'The document time field.'."\n", + 'type' => 'string', + 'example' => 'text1'."\n", + ], + 'ttl' => [ + 'description' => 'The TTL. Unit: milliseconds.'."\n", + 'type' => 'integer', + 'format' => 'int64', + 'example' => '1000', + ], + ], + ], + 'indexSortConfig' => [ + 'description' => 'The sort configurations.'."\n", + 'type' => 'array', + 'items' => [ + 'description' => 'The sort configurations.'."\n", + 'type' => 'object', + 'properties' => [ + 'field' => [ + 'description' => 'The sort field.'."\n", + 'type' => 'string', + 'example' => 'field1', + ], + 'direction' => [ + 'description' => 'The sort method. Valid values:'."\n" + ."\n" + .'* ASC'."\n" + .'* DESC'."\n", + 'type' => 'string', + 'example' => 'DESC', + ], + ], + ], + ], + 'name' => [ + 'description' => 'The name of the wide table.'."\n", + 'type' => 'string', + 'example' => 'test', + ], + ], + 'example' => '{}', + ], + 'progressPercent' => [ + 'description' => 'The progress of data import, in percentage. For example, a value of 83 indicates 83%.'."\n", + 'type' => 'integer', + 'format' => 'int32', + 'example' => '100', + ], + 'fetchFields' => [ + 'description' => 'The default display fields.'."\n", + 'type' => 'array', + 'items' => [ + 'description' => 'The default display fields.'."\n", + 'type' => 'string', + 'example' => '{}', + ], + 'example' => '[]', + ], + 'quota' => [ + 'description' => 'The quota information.'."\n", + 'type' => 'object', + 'properties' => [ + 'spec' => [ + 'description' => 'The specifications. Valid values:'."\n" + ."\n" + .'* opensearch.share.junior: basic'."\n" + .'* opensearch.share.common: shared general-purpose'."\n" + .'* opensearch.share.compute: shared computing'."\n" + .'* opensearch.share.storage: shared storage'."\n" + .'* opensearch.private.common: exclusive general-purpose'."\n" + .'* opensearch.private.compute: exclusive computing'."\n" + .'* opensearch.private.storage: exclusive storage'."\n", + 'type' => 'string', + 'example' => 'opensearch.share.common', + ], + 'qps' => [ + 'description' => 'The number of search requests per second. You are charged based on the number of search requests per second in the earlier billing model.'."\n", + 'type' => 'integer', + 'format' => 'int32', + 'example' => '5', + ], + 'docSize' => [ + 'description' => 'The storage capacity. Unit: GB.'."\n", + 'type' => 'integer', + 'format' => 'int32', + 'example' => '1', + ], + 'computeResource' => [ + 'description' => 'The computing resources. Unit: logical computing unit (LCU).'."\n", + 'type' => 'integer', + 'format' => 'int32', + 'example' => '20', + ], + ], + 'example' => '{}', + ], + 'domain' => [ + 'description' => 'The industry type. Valid values:'."\n" + ."\n" + .'* GENERAL'."\n" + .'* ECOMMERCE'."\n" + .'* IT_CONTENT'."\n", + 'type' => 'object', + 'properties' => [ + 'category' => [ + 'description' => 'The type of the edition. Valid values: standard, advance, and enhanced. A value of standard indicates a standard edition. A value of advance indicates an advanced edition which is of an old version. New version is not supported for this edition. A value of enhanced indicates an advanced edition which is of a new version.'."\n", + 'type' => 'string', + 'example' => '-', + ], + 'name' => [ + 'description' => 'The name (in English).'."\n", + 'type' => 'string', + 'example' => 'test', + ], + 'functions' => [ + 'description' => 'The search results.'."\n", + 'type' => 'object', + 'properties' => [ + 'service' => [ + 'description' => 'The description of each feature.'."\n", + 'type' => 'array', + 'items' => [ + 'description' => 'Feature 1.'."\n", + 'type' => 'string', + 'example' => '-', + ], + 'example' => '[]', + ], + 'qp' => [ + 'description' => 'The information about the layout.'."\n", + 'type' => 'array', + 'items' => [ + 'description' => 'Information 1.'."\n", + 'type' => 'string', + 'example' => '-', + ], + 'example' => '[]', + ], + 'algo' => [ + 'description' => 'The structure of the algorithm.'."\n", + 'type' => 'array', + 'items' => [ + 'description' => 'Structure 1.'."\n", + 'type' => 'string', + 'example' => '-', + ], + 'example' => '[]', + ], + ], + 'example' => '{}', + ], + ], + 'example' => 'GENERAL', + ], + 'schemas' => [ + 'description' => 'The multi-table schema.'."\n", + 'type' => 'array', + 'items' => [ + 'description' => 'The single-table schema.'."\n", + 'type' => 'object', + 'properties' => [ + 'tables' => [ + 'description' => 'The table schema.'."\n", + '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' => 'The index schema.'."\n", + 'type' => 'object', + 'properties' => [ + 'filterFields' => [ + 'description' => 'The attribute fields.'."\n", + 'type' => 'array', + 'items' => [ + 'description' => 'The attribute field.'."\n", + 'type' => 'string', + 'example' => 'field1', + ], + ], + 'searchFields' => [ + 'description' => 'The index fields.'."\n", + 'type' => 'object', + 'example' => '{'."\n" + .' "fields": ["title"],'."\n" + .' "analyzer": "chn_standard"'."\n" + .'}'."\n", + ], + ], + ], + 'routeField' => [ + 'description' => 'The name of the level-1 routing field.'."\n", + 'type' => 'string', + 'example' => 'field1'."\n", + ], + 'routeFieldValues' => [ + 'description' => 'The hot values of the level-1 routing field.'."\n", + 'type' => 'array', + 'items' => [ + 'description' => 'The hot value of the level-1 routing field.'."\n", + 'type' => 'string', + 'example' => 'routeFieldValues', + ], + ], + 'secondRouteField' => [ + 'description' => 'The name of the level-2 routing field. This parameter takes effect only when the routeFieldValues parameter is configured. By default, the wide-table primary key field is used as the level-2 routing field.'."\n", + 'type' => 'string', + 'example' => 'field2', + ], + 'ttlField' => [ + 'description' => 'The document clearing configurations.'."\n", + 'type' => 'object', + 'properties' => [ + 'name' => [ + 'description' => 'The document time field.'."\n", + 'type' => 'string', + 'example' => 'fIeld1', + ], + 'ttl' => [ + 'description' => 'The TTL. Unit: milliseconds.'."\n", + 'type' => 'integer', + 'format' => 'int64', + 'example' => '1000', + ], + ], + ], + 'indexSortConfig' => [ + 'description' => 'The sort configurations.'."\n", + 'type' => 'array', + 'items' => [ + 'description' => 'The sort configurations.'."\n", + 'type' => 'object', + 'properties' => [ + 'field' => [ + 'description' => 'The sort field.'."\n", + 'type' => 'string', + 'example' => 'fIeld1', + ], + 'direction' => [ + 'description' => 'The sort method. Valid values:'."\n" + ."\n" + .'* ASC'."\n" + .'* DESC'."\n", + 'type' => 'string', + 'example' => 'DESC', + ], + ], + ], + ], + 'name' => [ + 'description' => 'The name of the wide table.'."\n", + 'type' => 'string', + 'example' => 'main', + ], + ], + ], + ], + 'firstRanks' => [ + 'description' => 'The configurations of rough sort.'."\n", + 'type' => 'array', + 'items' => [ + 'description' => 'The configurations of rough sort.'."\n", + 'type' => 'object', + 'properties' => [ + 'type' => [ + 'description' => 'The expression type. Valid values:'."\n" + ."\n" + .'STRUCT: The content of the expression is a structure. STRING (default): custom formula.'."\n", + 'type' => 'string', + 'example' => 'STRING', + ], + 'name' => [ + 'description' => 'The name of the rough sort expression.'."\n", + 'type' => 'string', + 'example' => 'test', + ], + 'description' => [ + 'description' => 'The description.'."\n", + 'type' => 'string', + 'example' => 'abc', + ], + 'active' => [ + 'description' => 'Indicates whether the expression is the default one.'."\n", + 'type' => 'boolean', + 'example' => 'False', + ], + 'meta' => [ + 'description' => 'The information about the expression. The information can be of the array or string type.'."\n", + 'type' => 'any', + 'example' => 'String :"random()*100+now()";'."\n" + .'Array: ['."\n" + .' {'."\n" + .' "attribute": "static_bm25()",'."\n" + .' "arg": "",'."\n" + .' "weight": 10'."\n" + .' }'."\n" + .' ]', + ], + ], + ], + ], + 'secondRanks' => [ + 'description' => 'The configurations of fine sort.'."\n", + 'type' => 'array', + 'items' => [ + 'description' => 'The configurations of fine sort.'."\n", + 'type' => 'object', + 'properties' => [ + 'meta' => [ + 'description' => 'The fine sort expression. You can define an expression that contains fields, feature functions, and mathematical functions to implement complex sort logic.'."\n", + 'type' => 'any', + 'example' => '"cate_id > 0 and cate_id < 1000"'."\n", + ], + 'name' => [ + 'description' => 'The name of the fine sort expression.'."\n", + 'type' => 'string', + 'example' => 'default'."\n", + ], + 'description' => [ + 'description' => 'The description.'."\n", + 'type' => 'string', + 'example' => 'Description', + ], + 'active' => [ + 'description' => 'Indicates whether the expression is the default one.'."\n", + 'type' => 'boolean', + 'example' => 'False', + ], + ], + ], + ], + 'dataSources' => [ + 'description' => 'The configurations of the data sources.'."\n", + 'type' => 'array', + 'items' => [ + 'description' => 'The configurations of the data source.'."\n", + 'type' => 'object', + 'properties' => [ + 'tableName' => [ + 'description' => 'The name of the table in the application.'."\n", + 'type' => 'string', + 'example' => 'main', + ], + 'type' => [ + 'description' => 'The type of the data source. Valid values:'."\n" + ."\n" + .'* rds'."\n" + .'* odps'."\n" + .'* opensearch'."\n" + .'* polardb'."\n", + 'type' => 'string', + 'example' => 'rds', + ], + 'fields' => [ + 'description' => 'The information about field mappings.'."\n", + 'type' => 'array', + 'items' => [ + 'description' => 'The information about field mappings.'."\n", + 'type' => 'object', + 'example' => '{'."\n" + .' "id": "id"'."\n" + .' }'."\n", + ], + ], + 'plugins' => [ + 'description' => 'The plug-ins that are used for data processing.'."\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'."\n", + 'type' => 'object', + 'example' => '{'."\n" + .' "name": "JsonKeyValueExtractor",'."\n" + .' "parameters": {'."\n" + .' "key": "my_field"'."\n" + .'}'."\n" + .'}', + ], + 'keyField' => [ + 'description' => 'The primary key.'."\n", + 'type' => 'string', + 'example' => 'id', + ], + 'schemaName' => [ + 'description' => 'The name of the wide table.'."\n", + 'type' => 'string', + 'example' => 'name', + ], + 'parameters' => [ + 'description' => 'The information about the data source.'."\n", + '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' => 'The summary configurations of search results.'."\n", + 'type' => 'array', + 'items' => [ + 'description' => 'The summary configurations of search results.'."\n", + 'type' => 'object', + 'properties' => [ + 'name' => [ + 'description' => 'The group name.'."\n", + 'type' => 'string', + 'example' => 'default', + ], + 'meta' => [ + 'description' => 'The summary configurations.'."\n", + 'type' => 'array', + 'items' => [ + 'description' => 'The summary configurations.'."\n", + 'type' => 'object', + 'properties' => [ + 'field' => [ + 'description' => 'The field.'."\n", + 'type' => 'string', + 'example' => 'field1', + ], + 'len' => [ + 'description' => 'The length of the segment. Valid values: 1 to 300.'."\n", + 'type' => 'integer', + 'format' => 'int32', + 'example' => '50', + ], + 'element' => [ + 'description' => 'The element that is used for highlighting.'."\n", + 'type' => 'string', + 'example' => 'em', + ], + 'ellipsis' => [ + 'description' => 'The connector that is used to connect segments.'."\n", + 'type' => 'string', + 'example' => '...', + ], + 'snippet' => [ + 'description' => 'The number of segments. Valid values: 1 to 5.'."\n", + 'type' => 'string', + 'example' => '5', + ], + ], + ], + ], + ], + ], + ], + 'queryProcessors' => [ + 'description' => 'The query intent understanding configurations.'."\n", + 'type' => 'array', + 'items' => [ + 'description' => 'The query intent understanding configurations.'."\n", + 'type' => 'object', + 'properties' => [ + 'name' => [ + 'description' => 'The rule name.'."\n", + 'type' => 'string', + 'example' => 'test', + ], + 'domain' => [ + 'description' => 'The industry type. Valid values:'."\n" + ."\n" + .'* GENERAL'."\n" + .'* ECOMMERCE'."\n" + .'* IT_CONTENT'."\n", + 'type' => 'string', + 'example' => 'GENERAL', + ], + 'category' => [ + 'description' => 'The industry category.'."\n", + 'type' => 'string', + 'example' => '""', + ], + 'processors' => [ + 'description' => 'The features.'."\n", + 'type' => 'array', + 'items' => [ + 'description' => 'The features.'."\n", + 'type' => 'object', + 'example' => '{'."\n" + .'"name": "stop_word", "useSystemDictionary": true,'."\n" + .'"interventionDictionary": "my_dict",'."\n" + .' "ignoreSpace": true'."\n" + .'}', + ], + ], + 'indexes' => [ + 'description' => 'Then index range.'."\n", + 'type' => 'array', + 'items' => [ + 'description' => 'The index.'."\n", + 'type' => 'string', + 'example' => 'default', + ], + ], + 'active' => [ + 'description' => 'Indicates whether the rule is the default one.'."\n", + 'type' => 'boolean', + 'example' => 'False', + ], + ], + ], + ], + 'cluster' => [ + 'description' => 'The capability opening configurations.'."\n", + 'type' => 'object', + 'properties' => [ + 'maxTimeoutMS' => [ + 'description' => 'The timeout period. Unit: milliseconds.'."\n", + 'type' => 'integer', + 'format' => 'int32', + 'example' => '750', + ], + 'maxQueryClauseLength' => [ + 'description' => 'The maximum length of the query clause.'."\n", + 'type' => 'integer', + 'format' => 'int32', + 'example' => '1024', + ], + ], + ], + 'interpretations' => [ + 'description' => 'The industry model module.'."\n", + 'type' => 'object', + 'example' => '\\[ { "table": "table1", "fields": \\[ { "name": "field1", "interpretation": "Title" }, { "name": "field2", "interpretation": "Number" } ] } ]'."\n", + ], + 'prompts' => [ + 'description' => 'The prompt configurations.'."\n", + 'type' => 'array', + 'items' => [ + 'description' => 'The prompt configurations.'."\n", + 'type' => 'object', + 'example' => '{ "parameters" : \\[ { "name" : "docs", "value" : "The way in which the content of documents is concatenated, such as \'\\<article>\\n${doc}\\n\\</article>\\n." } ], "messages":\\[ { "role" : "role_name: specifies whether to specify only system, user, or assistant or specify a custom value.", "content" : "The content of the prompt configured by the user. ${parameter_key} can be used to specify the content that you want to dynamically replace. For more information about replacement rules, see the following instructions." } ] }'."\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的 \'<article>\\\\n${doc}\\\\n</article>\\\\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":"<requestId>33477D76-C380-1D84-A4AD-043F52876CB1</requestId>\\n<result>\\n <id>100303063</id>\\n <description/>\\n <status>ok</status>\\n <fetchFields>id</fetchFields>\\n <fetchFields>title</fetchFields>\\n <fetchFields>buy</fetchFields>\\n <fetchFields>cate_id</fetchFields>\\n <fetchFields>cate_name</fetchFields>\\n <type>enhanced</type>\\n <schema>\\n <tables>\\n <main>\\n <primaryTable>true</primaryTable>\\n <name>main</name>\\n <fields>\\n <id>\\n <name>id</name>\\n <type>LITERAL</type>\\n <primaryKey>true</primaryKey>\\n </id>\\n <title>\\n <name>title</name>\\n <type>TEXT</type>\\n <primaryKey>false</primaryKey>\\n </title>\\n <buy>\\n <name>buy</name>\\n <type>INT</type>\\n <primaryKey>false</primaryKey>\\n </buy>\\n <cate_id>\\n <name>cate_id</name>\\n <type>INT</type>\\n <primaryKey>false</primaryKey>\\n </cate_id>\\n <cate_name>\\n <name>cate_name</name>\\n <type>LITERAL</type>\\n <primaryKey>false</primaryKey>\\n </cate_name>\\n </fields>\\n </main>\\n </tables>\\n <indexes>\\n <searchFields>\\n <id>\\n <fields>id</fields>\\n </id>\\n <default>\\n <fields>title</fields>\\n <analyzer>chn_standard</analyzer>\\n </default>\\n <buy>\\n <fields>buy</fields>\\n </buy>\\n </searchFields>\\n <filterFields>id</filterFields>\\n <filterFields>buy</filterFields>\\n <filterFields>cate_id</filterFields>\\n <filterFields>cate_name</filterFields>\\n </indexes>\\n </schema>\\n <algoDeploymentId>0</algoDeploymentId>\\n <firstRanks>\\n <id/>\\n <name>default</name>\\n <description/>\\n <active>false</active>\\n <type>STRUCT</type>\\n <meta>\\n <attribute>static_bm25()</attribute>\\n <arg/>\\n <weight>1</weight>\\n </meta>\\n <created>0</created>\\n <updated>0</updated>\\n </firstRanks>\\n <firstRanks>\\n <id>887857</id>\\n <name>first_rank_lsh_1</name>\\n <description/>\\n <active>true</active>\\n <type>STRUCT</type>\\n <meta>\\n <attribute>static_bm25()</attribute>\\n <arg/>\\n <weight>10</weight>\\n </meta>\\n <meta>\\n <attribute>exact_match_boost()</attribute>\\n <arg/>\\n <weight>20</weight>\\n </meta>\\n <meta>\\n <attribute>buy</attribute>\\n <arg/>\\n <weight>30</weight>\\n </meta>\\n <created>1590977140</created>\\n <updated>1590977140</updated>\\n </firstRanks>\\n <secondRanks>\\n <id>-1</id>\\n <name>default</name>\\n <meta/>\\n <active>true</active>\\n <description/>\\n <created>0</created>\\n <updated>0</updated>\\n </secondRanks>\\n <summaries>\\n <name>default</name>\\n <meta>\\n <field>title</field>\\n <len>50</len>\\n <element>em</element>\\n <ellipsis>...</ellipsis>\\n <snippet>1</snippet>\\n </meta>\\n </summaries>\\n <created>1590977140</created>\\n <queryProcessors>\\n <name>sum_lsh_test_1</name>\\n <active>true</active>\\n <indexes>default</indexes>\\n <processors>\\n <useSystemDictionary>true</useSystemDictionary>\\n <interventionDictionary/>\\n <name>stop_word</name>\\n </processors>\\n <processors>\\n <useSystemDictionary>true</useSystemDictionary>\\n <interventionDictionary/>\\n <name>spell_check</name>\\n </processors>\\n <processors>\\n <useSystemDictionary>true</useSystemDictionary>\\n <interventionDictionary/>\\n <name>term_weighting</name>\\n </processors>\\n <processors>\\n <useSystemDictionary>true</useSystemDictionary>\\n <interventionDictionary/>\\n <name>synonym</name>\\n </processors>\\n <domain>GENERAL</domain>\\n <created>1590977142</created>\\n <updated>1590977142</updated>\\n </queryProcessors>\\n <progressPercent>100</progressPercent>\\n</result>","errorExample":""}]', + 'title' => 'DescribeApp', + 'requestParamsDescription' => ' ', + 'responseParamsDescription' => ' ', + 'extraInfo' => ' ', + 'translator' => 'machine', + ], + 'DescribeAppStatistics' => [ + 'summary' => 'Queries the statistics about a version of an OpenSearch application.', + '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' => 'The name of the application.'."\n", + 'type' => 'string', + 'required' => true, + 'docRequired' => true, + 'example' => 'my_app_group_name', + ], + ], + [ + 'name' => 'appId', + 'in' => 'path', + 'schema' => [ + 'description' => 'The version number of the application.'."\n", + 'type' => 'string', + 'required' => true, + 'docRequired' => true, + 'example' => '110157886', + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'type' => 'object', + 'properties' => [ + 'result' => [ + 'description' => 'The statistics.'."\n", + 'type' => 'object', + 'example' => '{}', + ], + 'requestId' => [ + 'description' => 'The request ID.'."\n", + 'type' => 'string', + 'example' => '76FC45F1-4167-D3CD-6737-4F97BA503FA0', + ], + ], + 'description' => '', + ], + ], + '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":"<requestId>76FC45F1-4167-D3CD-6737-4F97BA503FA0</requestId>\\n<result>\\n <pv>5002</pv>\\n <docCount>168</docCount>\\n <docLastUpdated>1582522280</docLastUpdated>\\n <quota>\\n <instance>\\n <used>0.000002</used>\\n <quota>1</quota>\\n <outOfLimit>false</outOfLimit>\\n <tables>\\n <main>2222</main>\\n </tables>\\n </instance>\\n <qps>\\n <used>0</used>\\n <quota>0</quota>\\n <outOfLimit>false</outOfLimit>\\n </qps>\\n <computeResource>\\n <used>0</used>\\n <quota>20</quota>\\n <outOfLimit>false</outOfLimit>\\n <dailyPeak>1.0306227624786388</dailyPeak>\\n </computeResource>\\n <spec>opensearch.share.common</spec>\\n <docCount>\\n <main>168</main>\\n </docCount>\\n <mainTable>main</mainTable>\\n </quota>\\n</result>","errorExample":""}]', + 'title' => 'DescribeAppStatistics', + 'requestParamsDescription' => ' ', + 'responseParamsDescription' => '**Statistical results**'."\n" + ."\n" + .'|Parameter|Type|Description|'."\n" + .'|---|---|---|'."\n" + .'|result.pv|Integer|The number of requests.|'."\n" + .'|result.docCount|Integer|The number of documents.|'."\n" + .'|result.docLastUpdated|String|The timestamp when the document was last updated.|'."\n" + .'|result.quota|Object|The statistics about the quotas.|'."\n" + .'|result.quota.instance|Object|The statistics about the instance.|'."\n" + .'|result.quota.instance.used|Float|The used quota. Unit: LCUs.|'."\n" + .'|result.quota.instance.quota|Integer|The quota capacity. Unit:GB.|'."\n" + .'|result.quota.instance.outOfLimit|Boolean|Indicates whether the quotas are exceeded.|'."\n" + .'|result.quota.instance.tables|Object|The statistics used by each data table. The key name is the name of the table, and the value is the used capacity.|'."\n" + .'|result.quota.qps|Object|The statistics about the quota of queries per second (QPS).|'."\n" + .'|result.quota.qps.used|Float|The used quota of QPS.|'."\n" + .'|result.quota.qps.quota|Integer|The total quota of QPS.|'."\n" + .'|result.quota.qps.outOfLimit|Boolean|Indicates whether the quotas are exceeded.|'."\n" + .'|result.quota.qps.tables|Array|\\--|'."\n" + .'|result.quota.computeResource|Object|The statistics about the quota of computing resources.|'."\n" + .'|result.quota.computeResource.used|Float|The used computing resources. Unit: LCUs.|'."\n" + .'|result.quota.computeResource.quota|Integer|The quota of computing resources. Unit: GB.|'."\n" + .'|result.quota.computeResource.outOfLimit|Boolean|Indicates whether the quotas are exceeded.|'."\n" + .'|result.quota.computeResource.dailyPeak|Float|The maximum amount of computing resources used. Unit: LCUs.|'."\n" + .'|result.quota.spec|String|The specifications of the application. Valid values:opensearch.share.junior: basicopensearch.share.common: shared general-purposeopensearch.share.compute: shared computingopensearch.share.storage: shared storageopensearch.private.common: exclusive general-purposeopensearch.private.compute: exclusive computingopensearch.private.storage: exclusive storage|'."\n" + .'|result.quota.docCount|Object|The statistics of the document number. The key indicates the name of the table. The value indicates the used quotas.|'."\n" + .'|result.quota.mainTable|String|The name of the primary table.|', + 'extraInfo' => ' ', + ], + 'ListUserAnalyzers' => [ + 'summary' => 'Queries the custom analyzers that belong to the current account.', + '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' => 'The number of the page to return. Default value: 1.'."\n", + 'type' => 'integer', + 'format' => 'int32', + 'required' => false, + 'maximum' => '999999999', + 'minimum' => '-1', + 'example' => '1', + ], + ], + [ + 'name' => 'pageSize', + 'in' => 'query', + 'schema' => [ + 'description' => 'The number of entries to return on each page. Default value: 10.'."\n", + 'type' => 'integer', + 'format' => 'int32', + 'required' => false, + 'maximum' => '999999999', + 'minimum' => '-1', + 'example' => '10', + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'type' => 'object', + 'properties' => [ + 'totalCount' => [ + 'description' => 'The total number.'."\n", + 'type' => 'integer', + 'format' => 'int32', + 'example' => '1', + ], + 'requestId' => [ + 'description' => 'The ID of the request.'."\n", + 'type' => 'string', + 'example' => '0A6EB64B-B4C8-CF02-810F-E660812972FF', + ], + 'result' => [ + 'description' => 'The custom analyzer.'."\n" + ."\n" + .'For more information, see [UserAnalyzer](~~178934~~).'."\n", + 'type' => 'array', + 'items' => [ + 'type' => 'object', + 'properties' => [ + 'created' => [ + 'description' => 'The timestamp when the application was created.'."\n", + 'type' => 'integer', + 'format' => 'int32', + 'example' => '1588054131', + ], + 'available' => [ + 'description' => 'Indicates whether the application is available.'."\n", + 'type' => 'boolean', + 'example' => 'false', + ], + 'name' => [ + 'description' => 'The name of the custom analyzer.'."\n", + 'type' => 'string', + 'example' => 'kevin_test2', + ], + 'updated' => [ + 'description' => 'The timestamp when the application was last updated.'."\n", + 'type' => 'integer', + 'format' => 'int32', + 'example' => '1588054131', + ], + 'id' => [ + 'description' => 'The ID of the custom analyzer.'."\n", + 'type' => 'string', + 'example' => '1234', + ], + 'business' => [ + 'description' => 'The basic analyzer. Valid values:'."\n" + ."\n" + .'* chn_standard: [a common analyzer in Chinese](~~179424~~)'."\n" + .'* chn_scene_name: an analyzer for person names in Chinese'."\n" + .'* chn_ecommerce: [an analyzer for E-commerce in Chinese](~~179424~~)'."\n" + .'* chn_it_content: [an analyzer for IT content in Chinese](~~179424~~)'."\n" + .'* en_min: a small-granularity analyzer in English'."\n" + .'* th_standard: a common analyzer in Thai'."\n" + .'* th_ecommerce: an analyzer for E-commerce in Thai'."\n" + .'* vn_standard: a common analyzer in Vietnamese'."\n" + .'* chn_community_it: an analyzer for IT community content in Chinese'."\n" + .'* chn_ecommerce_general: a common analyzer for the E-commerce industry in Chinese'."\n" + .'* chn_esports_general: a common analyzer for the gaming industry in Chinese'."\n" + .'* chn_edu_question: an analyzer for question search of the education industry in Chinese'."\n", + 'type' => 'string', + 'example' => 'chn_standard', + ], + 'dicts' => [ + 'description' => 'The dictionaries that are used by the custom analyzer.'."\n" + ."\n" + .'For more information, see [UserDict](~~178933~~).'."\n", + 'type' => 'array', + 'items' => [ + 'type' => 'object', + 'properties' => [ + 'created' => [ + 'description' => 'The timestamp when the application was created.'."\n", + 'type' => 'integer', + 'format' => 'int32', + 'example' => '1588054131', + ], + 'entriesCount' => [ + 'description' => 'The number of intervention entries.'."\n", + 'type' => 'integer', + 'format' => 'int32', + 'example' => '-1', + ], + 'type' => [ + 'description' => 'The type. Valid value:'."\n" + ."\n" + .'* segment'."\n", + 'type' => 'string', + 'example' => 'segment', + ], + 'entriesLimit' => [ + 'description' => 'The maximum number of intervention entries that can be created in the dictionary.'."\n", + 'type' => 'integer', + 'format' => 'int32', + 'example' => '4', + ], + 'available' => [ + 'description' => 'Indicates whether the application is available.'."\n", + 'type' => 'boolean', + 'example' => 'false', + ], + 'updated' => [ + 'description' => 'The timestamp when the application was last updated.'."\n", + 'type' => 'integer', + 'format' => 'int32', + 'example' => '1588054131', + ], + 'id' => [ + 'description' => 'The ID of the dictionary.'."\n", + '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":"<requestId>0A6EB64B-B4C8-CF02-810F-E660812972FF</requestId>\\n<totalCount>1</totalCount>\\n<result>\\n <id>1234</id>\\n <name>kevin_test2</name>\\n <business>chn_standard</business>\\n <dicts>\\n <id>123</id>\\n <type>segment</type>\\n <entriesLimit>4</entriesLimit>\\n <entriesCount>-1</entriesCount>\\n <available>false</available>\\n <created>1588054131</created>\\n <updated>1588054131</updated>\\n </dicts>\\n <available>true</available>\\n <created>1588054131</created>\\n <updated>1588054131</updated>\\n</result>","errorExample":""}]', + 'title' => 'ListUserAnalyzers', + 'requestParamsDescription' => ' ', + 'responseParamsDescription' => ' ', + 'extraInfo' => ' ', + ], + 'CreateUserAnalyzer' => [ + 'summary' => 'Create a custom analyzer.', + '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' => 'The request body.', + 'type' => 'object', + 'properties' => [ + 'name' => [ + 'title' => '名称', + 'description' => 'The analyzer name.', + 'type' => 'string', + 'required' => false, + 'example' => 'jmbon_analyzer', + ], + 'business' => [ + 'title' => '基础分词器', + 'description' => 'The basic analyzer.', + 'type' => 'string', + 'required' => false, + 'example' => 'chn_standard', + ], + 'businessType' => [ + 'title' => '基础分词器类型 (AUTO, MODEL, SYSTEM, USER)', + 'description' => 'The basic analyzer type. Valid values: AUTO, MODEL, SYSTEM, and USER.', + 'type' => 'string', + 'required' => false, + 'example' => 'AUTO', + ], + 'type' => [ + 'title' => '引擎类型 (HA3, ES)', + 'description' => 'The engine type. Valid values: HA3 and ES.', + 'type' => 'string', + 'required' => false, + 'example' => 'HA3', + ], + 'businessAppGroupId' => [ + 'description' => 'The application ID of the custom analyzer.', + 'type' => 'string', + 'required' => false, + 'example' => '110123123', + ], + ], + 'required' => false, + ], + ], + [ + 'name' => 'dryRun', + 'in' => 'query', + 'schema' => [ + 'description' => 'Specifies whether to perform only a dry run, without performing the actual request. Default value: false.'."\n" + .'Valid values:'."\n" + .'* **true**'."\n" + .'* **false**', + 'type' => 'boolean', + 'required' => false, + 'example' => 'false', + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'type' => 'object', + 'properties' => [ + 'result' => [ + 'description' => 'The custom analyzer.', + 'type' => 'object', + 'example' => '{}', + ], + 'RequestId' => [ + 'description' => 'The ID of the request.', + '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' => 'Create Custom Analyzer', + 'translator' => 'machine', + ], + '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' => 'The name of the analyzer.', + 'type' => 'string', + 'required' => true, + 'docRequired' => true, + 'example' => 'kevin_test', + ], + ], + [ + 'name' => 'with', + 'in' => 'query', + 'schema' => [ + 'description' => 'The Associated information,output properties based on hierarchy.'."\n" + .'* **all**: Outputs associated app information', + 'type' => 'string', + 'required' => false, + 'example' => 'all', + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'type' => 'object', + 'properties' => [ + 'result' => [ + 'description' => 'The details of the custom analyzer.'."\n", + 'type' => 'object', + 'example' => '{}', + ], + 'requestId' => [ + 'description' => 'The ID of the request.'."\n", + '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":"<requestId>FFAEF396-10EF-53C7-1F51-518853880729</requestId>\\n<result>\\n <id>1234</id>\\n <name>kevin_test</name>\\n <business>chn_it_content</business>\\n <available>true</available>\\n <relatedAppInfoList>\\n <id>100298352</id>\\n <name>test_srn_mysql</name>\\n </relatedAppInfoList>\\n <dicts>\\n <id>123</id>\\n <type>segment</type>\\n <entries>\\n <cmd>add</cmd>\\n <key>kevintest</key>\\n <value>kevin test</value>\\n <created>1536690285</created>\\n <updated>1537348987</updated>\\n <status>ACTIVE</status>\\n <splitEnabled>true</splitEnabled>\\n </entries>\\n <entries>\\n <cmd>add</cmd>\\n <key>abcd</key>\\n <value>abcd</value>\\n <created>1536690285</created>\\n <updated>1537348987</updated>\\n <status>ACTIVE</status>\\n <splitEnabled>true</splitEnabled>\\n </entries>\\n <entriesLimit>4</entriesLimit>\\n <entriesCount>2</entriesCount>\\n <available>true</available>\\n <created>1584702214</created>\\n <updated>1584702214</updated>\\n </dicts>\\n <created>1584702212</created>\\n <updated>1584702212</updated>\\n</result>","errorExample":""}]', + 'title' => 'DescribeUserAnalyzer', + ], + 'RemoveUserAnalyzer' => [ + 'summary' => 'Deletes a custom analyzer.', + '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' => 'The name of the analyzer'."\n", + 'type' => 'string', + 'required' => true, + 'docRequired' => true, + 'example' => '“kevin_test”', + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'type' => 'object', + 'properties' => [ + 'result' => [ + 'description' => 'The result set. This parameter is not returned if the request is successful.'."\n", + 'type' => 'object', + 'example' => '[]', + ], + 'requestId' => [ + 'description' => 'The request ID.'."\n", + 'type' => 'string', + 'example' => 'D77D0DAF-790D-F5F5-A9C0-133738165014', + ], + ], + 'description' => '', + ], + ], + '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":"<requestId>D77D0DAF-790D-F5F5-A9C0-133738165014</requestId>","errorExample":""}]', + 'title' => 'RemoveUserAnalyzer', + 'requestParamsDescription' => ' ', + 'responseParamsDescription' => ' ', + 'extraInfo' => ' ', + ], + 'ListUserAnalyzerEntries' => [ + 'summary' => 'Queries the entries of a custom analyzer.', + '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' => 'The name of the analyzer.'."\n", + 'type' => 'string', + 'required' => true, + 'docRequired' => true, + 'example' => 'kevin_test', + ], + ], + [ + 'name' => 'word', + 'in' => 'query', + 'schema' => [ + 'description' => 'The key to be used to query entries.'."\n", + 'type' => 'string', + 'required' => false, + 'example' => 'kevintest', + ], + ], + [ + 'name' => 'pageNumber', + 'in' => 'query', + 'schema' => [ + 'description' => 'The page number. Default value: 1.'."\n", + 'type' => 'integer', + 'format' => 'int32', + 'required' => false, + 'maximum' => '999999999', + 'minimum' => '-1', + 'example' => '1', + ], + ], + [ + 'name' => 'pageSize', + 'in' => 'query', + 'schema' => [ + 'description' => 'The number of entries per page. Default value: 10.'."\n", + 'type' => 'integer', + 'format' => 'int32', + 'required' => false, + 'maximum' => '999999999', + 'minimum' => '-1', + 'example' => '10', + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'type' => 'object', + 'properties' => [ + 'result' => [ + 'description' => 'The entries of the custom analyzer. For more information, see [UserAnalyzerEntry](https://www.alibabacloud.com/help/en/open-search/industry-algorithm-edition/useranalyzerentry).', + 'type' => 'object', + 'example' => '[]', + ], + 'RequestId' => [ + 'description' => 'The request ID.'."\n", + 'type' => 'string', + 'example' => '516A02B7-2167-8D92-12D0-B639A2A0F3C5', + ], + ], + 'description' => '', + ], + ], + '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' => 'ListUserAnalyzerEntries', + ], + 'PushUserAnalyzerEntries' => [ + 'summary' => 'Accepts the changes in the entries of a custom analyzer.', + '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' => 'The name of the analyzer.'."\n", + 'type' => 'string', + 'required' => true, + 'docRequired' => true, + 'example' => '“kevin_test”', + ], + ], + [ + 'name' => 'dryRun', + 'in' => 'query', + 'schema' => [ + 'description' => 'Specifies whether to perform a dry run. This parameter is only used to check whether the data source is valid. Valid values: true and false.'."\n", + 'type' => 'boolean', + 'required' => false, + 'example' => 'true', + ], + ], + [ + 'name' => 'body', + 'in' => 'body', + 'style' => 'json', + 'schema' => [ + 'description' => 'The request body.'."\n", + 'type' => 'object', + 'properties' => [ + 'entries' => [ + 'description' => 'The entries of the custom analyzer.'."\n", + 'type' => 'array', + 'items' => [ + 'type' => 'object', + 'properties' => [ + 'cmd' => [ + 'description' => 'The operation to be performed on the entries.'."\n" + ."\n" + .'Valid values:'."\n" + ."\n" + .'* add'."\n" + .'* delete'."\n", + 'type' => 'string', + 'required' => false, + 'example' => '"add"', + ], + 'key' => [ + 'description' => 'The key to be used to query entries.'."\n", + 'type' => 'string', + 'required' => false, + 'example' => '"testvalue"', + ], + 'value' => [ + 'description' => 'The analysis result.'."\n", + 'type' => 'string', + 'required' => false, + 'example' => '"test value"', + ], + 'splitEnabled' => [ + 'description' => 'Specifies whether to further analyze the terms that are generated after the search query is analyzed.'."\n" + ."\n" + .'Default value: true.'."\n", + 'type' => 'boolean', + 'required' => false, + 'example' => 'true', + ], + ], + 'required' => false, + ], + 'required' => false, + 'maxItems' => 100, + ], + ], + 'required' => false, + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'type' => 'object', + 'properties' => [ + 'result' => [ + 'description' => 'The result returned.'."\n", + 'type' => 'object', + 'example' => '{}', + ], + 'RequestId' => [ + 'description' => 'The request ID.'."\n", + 'type' => 'string', + 'example' => 'D77D0DAF-790D-F5F5-A9C0-133738165014', + ], + ], + 'description' => '', + ], + ], + '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' => 'PushUserAnalyzerEntries', + 'requestParamsDescription' => 'Note: Use lowercase letters when you add intervention entries.'."\n", + ], + 'ListABTestScenes' => [ + 'summary' => 'Queries test scenarios.', + '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' => 'The name of the application'."\n", + 'type' => 'string', + 'required' => true, + 'docRequired' => true, + 'example' => 'my_app_group_name', + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'type' => 'object', + 'properties' => [ + 'requestId' => [ + 'description' => 'The request ID.'."\n", + 'type' => 'string', + 'example' => 'D77D0DAF-790D-F5F5-A9C0-133738165014', + ], + 'result' => [ + 'description' => 'The details of the test scenario.'."\n" + ."\n" + .'For more information, see [ABTestScene](~~173618~~).'."\n", + 'type' => 'array', + 'items' => [ + 'description' => 'The returned data.'."\n", + 'type' => 'object', + 'properties' => [ + 'created' => [ + 'description' => 'The time when the test group was created.'."\n", + 'type' => 'integer', + 'format' => 'int32', + 'example' => '1588836130', + ], + 'status' => [ + 'description' => 'The status of the test group. Valid values:'."\n" + ."\n" + .'* 0: not in effect'."\n" + .'* 1: in effect'."\n", + 'type' => 'integer', + 'format' => 'int32', + 'example' => '1', + ], + 'updated' => [ + 'description' => 'The time when the test group was last updated.'."\n", + 'type' => 'integer', + 'format' => 'int32', + 'example' => '1588836129', + ], + 'name' => [ + 'description' => 'The alias of the test group.'."\n", + 'type' => 'string', + 'example' => 'kevintest_2020-5-7_15:21:482', + ], + 'id' => [ + 'description' => 'The ID of the test group.'."\n", + 'type' => 'string', + 'example' => '20404', + ], + 'values' => [ + 'description' => 'The name of the test scenario.'."\n", + 'type' => 'array', + 'items' => [ + 'description' => 'The list of scenarios.'."\n", + 'type' => 'string', + 'example' => '["kevintest2"]', + ], + ], + ], + ], + ], + ], + 'description' => '', + ], + ], + '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":"<requestId>D77D0DAF-790D-F5F5-A9C0-133738165014</requestId>\\n<result>\\n <id>20404</id>\\n <name>kevintest_2020-5-7_15:21:482</name>\\n <status>1</status>\\n <created>1588836130</created>\\n <updated>1588836129</updated>\\n <values>kevintest2</values>\\n</result>","errorExample":""}]', + 'title' => 'ListABTestScenes', + 'requestParamsDescription' => ' ', + 'responseParamsDescription' => ' ', + 'extraInfo' => ' ', + ], + 'CreateABTestScene' => [ + 'summary' => 'Creates an scenario.', + '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' => 'The name of the application'."\n", + 'type' => 'string', + 'required' => true, + 'docRequired' => true, + 'example' => 'my_app_group_name', + ], + ], + [ + 'name' => 'body', + 'in' => 'body', + 'schema' => [ + 'description' => 'The ABTest scenario. For more information, see [ABTestScene](~~173618~~)'."\n", + 'required' => false, + '$ref' => '#/components/schemas/ABTestScene', + ], + ], + [ + 'name' => 'dryRun', + 'in' => 'query', + 'schema' => [ + 'description' => 'Specifies whether to check the validity of input parameters. Default value: false.'."\n" + ."\n" + .'Valid values:'."\n" + ."\n" + .'* **true**: checks only the validity of input parameters.'."\n" + .'* **false**: checks the validity of input parameters and creates an attribution configuration.'."\n", + 'type' => 'boolean', + 'required' => false, + 'example' => 'false', + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'type' => 'object', + 'properties' => [ + 'requestId' => [ + 'description' => 'The request ID.'."\n", + 'type' => 'string', + 'example' => 'D77D0DAF-790D-F5F5-A9C0-133738165014', + ], + 'result' => [ + 'description' => 'The returned data.'."\n", + 'type' => 'object', + 'properties' => [ + 'created' => [ + 'description' => 'The time when the test scenario was created.'."\n", + 'type' => 'integer', + 'format' => 'int32', + 'example' => '0', + ], + 'status' => [ + 'description' => 'The status. Valid values:'."\n" + ."\n" + .'* 0: not in effect'."\n" + .'* 1: in effect'."\n", + 'type' => 'integer', + 'format' => 'int32', + 'example' => '1', + ], + 'updated' => [ + 'description' => 'The time when the test scenario was last updated.'."\n", + 'type' => 'integer', + 'format' => 'int32', + 'example' => '1589012351', + ], + 'name' => [ + 'description' => 'The name of the A/B test group.'."\n", + 'type' => 'string', + 'example' => 'kevintest_2020-5-7_15:21:48', + ], + 'id' => [ + 'description' => 'The ID of the test group.'."\n", + 'type' => 'string', + 'example' => '20405', + ], + 'values' => [ + 'description' => 'The ID of the test scenario'."\n", + 'type' => 'array', + 'items' => [ + 'description' => 'The ID of the test scenario'."\n", + 'type' => 'string', + 'example' => '[ "kevintest" ]', + ], + ], + ], + ], + ], + 'description' => '', + ], + ], + '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":"<requestId>D77D0DAF-790D-F5F5-A9C0-133738165014</requestId>\\n<result>\\n <id>20405</id>\\n <name>kevintest_2020-5-7_15:21:48</name>\\n <status>1</status>\\n <created>1589012351</created>\\n <updated>1589012351</updated>\\n <values>kevintest</values>\\n</result>","errorExample":""}]', + 'title' => 'CreateABTestScene', + 'requestParamsDescription' => '**Request body**'."\n" + ."\n" + .'|Parameter|Type|Required|Example|Description|'."\n" + .'|---|---|---|---|---|'."\n" + .'|name|String|Yes|"kevintest22"|The name of the test scenario.|'."\n" + .'|status|Integer|No|0|The status of the scenario. Valid values:- 0: The test is stopped.- 1: The test is started.|'."\n" + .'|created|Integer|No|1589012351|The time when the test scenario was created.|'."\n" + .'|updated|Integer|No|1589012351|The time when the test scenario was last updated.|'."\n" + .'|values\\[\\]|String|No|"kevintest22"|The ID of the test scenario|', + 'responseParamsDescription' => ' ', + 'extraInfo' => ' ', + ], + 'DescribeABTestScene' => [ + 'summary' => 'Queries the information about an A/B test scenario.', + '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' => 'The name or ID of the application.'."\n", + 'type' => 'string', + 'required' => true, + 'docRequired' => true, + 'example' => 'my_app_group_name', + ], + ], + [ + 'name' => 'sceneId', + 'in' => 'path', + 'schema' => [ + 'description' => 'The ID of the test scenario.'."\n", + 'type' => 'integer', + 'format' => 'int32', + 'required' => true, + 'docRequired' => true, + 'maximum' => '999999999', + 'minimum' => '-1', + 'example' => '20404', + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'type' => 'object', + 'properties' => [ + 'requestId' => [ + 'description' => 'The request ID.'."\n", + 'type' => 'string', + 'example' => 'D77D0DAF-790D-F5F5-A9C0-133738165014', + ], + 'result' => [ + 'description' => 'The details of the test scenario.'."\n", + 'type' => 'object', + 'properties' => [ + 'created' => [ + 'description' => 'The time when the test scenario was created.'."\n", + 'type' => 'integer', + 'format' => 'int32', + 'example' => '1596527691', + ], + 'status' => [ + 'description' => 'The status of the test scenario. Valid values:'."\n" + ."\n" + .'* 0: The test is stopped.'."\n" + .'* 1: The test is started.'."\n", + 'type' => 'integer', + 'format' => 'int32', + 'example' => '0', + ], + 'updated' => [ + 'description' => 'The time when the test was last modified.'."\n", + 'type' => 'integer', + 'format' => 'int32', + 'example' => '1596527691', + ], + 'name' => [ + 'description' => 'The name of the test scenario.'."\n", + 'type' => 'string', + 'example' => 'test', + ], + 'id' => [ + 'description' => 'The ID of the test scenario.'."\n", + 'type' => 'string', + 'example' => '20614', + ], + 'values' => [ + 'description' => 'The indicators of the test scenarios.'."\n", + 'type' => 'array', + 'items' => [ + 'description' => 'The indicator of the test scenario.'."\n", + 'type' => 'string', + 'example' => 'test', + ], + ], + ], + ], + ], + 'description' => '', + ], + ], + '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' => 'DescribeABTestScene', + ], + 'UpdateABTestScene' => [ + 'summary' => 'Modifies an A/B test scenario.', + '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' => 'The name of the application.'."\n", + 'type' => 'string', + 'required' => true, + 'docRequired' => true, + 'example' => '“my_app_group_name”', + ], + ], + [ + 'name' => 'sceneId', + 'in' => 'path', + 'schema' => [ + 'description' => 'The ID of the test scenario.'."\n", + 'type' => 'integer', + 'format' => 'int32', + 'required' => true, + 'docRequired' => true, + 'maximum' => '999999999', + 'minimum' => '-1', + 'example' => '20404', + ], + ], + [ + 'name' => 'body', + 'in' => 'body', + 'schema' => [ + 'description' => 'The request body.'."\n", + 'required' => false, + '$ref' => '#/components/schemas/ABTestScene', + ], + ], + [ + 'name' => 'dryRun', + 'in' => 'query', + 'schema' => [ + 'description' => 'Specifies whether to perform a dry run. This parameter is only used to check whether the data source is valid. Valid values: true and false.'."\n", + 'type' => 'boolean', + 'required' => false, + 'example' => 'true', + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'description' => 'The response body.'."\n", + 'type' => 'object', + 'properties' => [ + 'requestId' => [ + 'description' => 'The request ID.'."\n", + 'type' => 'string', + 'example' => 'D77D0DAF-790D-F5F5-A9C0-133738165014', + ], + 'result' => [ + 'description' => 'The details of the test scenario. For more information, see [ABTestScene](~~173618~~).'."\n", + 'type' => 'object', + 'properties' => [ + 'created' => [ + 'description' => 'The time when the test scenario was created.'."\n", + 'type' => 'integer', + 'format' => 'int32', + 'example' => '1596527691', + ], + 'params' => [ + 'description' => 'The parameters of the A/B test.'."\n", + 'type' => 'object', + 'example' => '{}', + ], + 'traffic' => [ + 'description' => 'The percentage of traffic that is allocated to the A/B test. Valid values: 0 to 100.'."\n", + 'type' => 'integer', + 'format' => 'int32', + 'example' => '111', + ], + 'online' => [ + 'description' => 'The status of the test. Valid values:'."\n" + ."\n" + .'* true: The test is started.'."\n" + .'* false: The test is stopped.'."\n", + 'type' => 'boolean', + 'example' => 'true', + ], + 'name' => [ + 'description' => 'The name of the test scenario.'."\n", + 'type' => 'string', + 'example' => 'kevintest22', + ], + 'updated' => [ + 'description' => 'The time when the test scenario was last modified.'."\n", + 'type' => 'integer', + 'format' => 'int32', + 'example' => '1596527691', + ], + 'id' => [ + 'description' => 'The ID of the test scenario.'."\n", + '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":"<requestId>D77D0DAF-790D-F5F5-A9C0-133738165014</requestId>\\n<result>\\n <id>20405</id>\\n <name>kevintest22</name>\\n <status>1</status>\\n <created>1589012351</created>\\n <updated>1589012351</updated>\\n <values>kevintest22</values>\\n</result>","errorExample":""}]', + 'title' => 'UpdateABTestScene', + 'requestParamsDescription' => '**Request body**'."\n" + ."\n" + .'|Parameter|Type|Required|Example|Description|'."\n" + .'|---|---|---|---|---|'."\n" + .'|name|String|Yes|"kevintest22"|The name of the test scenario.|'."\n" + .'|values\\[\\]|String|Yes|"kevintest22"|The indicator of the test scenario.|', + 'responseParamsDescription' => ' ', + 'extraInfo' => ' ', + ], + 'DeleteABTestScene' => [ + 'summary' => 'Deletes an A/B test scenario.', + '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' => 'The name or ID of the application.'."\n", + 'type' => 'string', + 'required' => true, + 'docRequired' => true, + 'example' => 'my_app_group_name', + ], + ], + [ + 'name' => 'sceneId', + 'in' => 'path', + 'schema' => [ + 'description' => 'The test scenario ID.'."\n", + 'type' => 'integer', + 'format' => 'int32', + 'required' => true, + 'docRequired' => true, + 'maximum' => '999999999', + 'minimum' => '-1', + 'example' => '20404', + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'type' => 'object', + 'properties' => [ + 'result' => [ + 'description' => 'The returned results.'."\n", + 'type' => 'object', + 'example' => '{}', + ], + 'requestId' => [ + 'description' => 'The request ID.'."\n", + 'type' => 'string', + 'example' => 'ABCDEFGH', + ], + ], + 'description' => '', + ], + ], + '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' => 'DeleteABTestScene', + ], + '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' => 'The application name.', + 'type' => 'string', + 'required' => true, + 'docRequired' => true, + 'example' => ' “my_app_group_name”', + ], + ], + [ + 'name' => 'sceneId', + 'in' => 'path', + 'schema' => [ + 'description' => 'The scenario ID.', + 'type' => 'integer', + 'format' => 'int32', + 'required' => true, + 'docRequired' => true, + 'maximum' => '999999999', + 'minimum' => '-1', + 'example' => '20404', + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'type' => 'object', + 'properties' => [ + 'requestId' => [ + 'description' => 'The ID of the request.'."\n", + 'type' => 'string', + 'example' => 'D77D0DAF-790D-F5F5-A9C0-133738165014', + ], + 'result' => [ + 'description' => 'The test groups.'."\n" + ."\n" + .'For more information, see [ABTestGroup](~~178935~~).'."\n", + 'type' => 'array', + 'items' => [ + 'type' => 'object', + 'properties' => [ + 'created' => [ + 'description' => 'The time when the test group was created.'."\n", + 'type' => 'integer', + 'format' => 'int32', + 'example' => '1588839490', + ], + 'status' => [ + 'description' => 'The status of the test group. Valid values:'."\n" + ."\n" + .'* 0: not in effect'."\n" + .'* 1: in effect'."\n", + 'type' => 'integer', + 'format' => 'int32', + 'example' => '1', + ], + 'updated' => [ + 'description' => 'The time when the test group was last modified.'."\n", + 'type' => 'integer', + 'format' => 'int32', + 'example' => '1588839490', + ], + 'name' => [ + 'description' => 'The name of the test group.'."\n", + 'type' => 'string', + 'example' => 'Group_2020-5-7_15:23:3', + ], + 'id' => [ + 'description' => 'The ID of the test group.'."\n", + '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":"<requestId>D77D0DAF-790D-F5F5-A9C0-133738165014</requestId>\\n<result>\\n <id>13466</id>\\n <name>Group_2020-5-7_15:23:3</name>\\n <status>1</status>\\n <created>1588839490</created>\\n <updated>1588839490</updated>\\n</result>","errorExample":""}]', + 'title' => 'ListABTestGroups', + 'requestParamsDescription' => ' ', + 'responseParamsDescription' => ' ', + 'extraInfo' => ' ', + ], + 'CreateABTestGroup' => [ + 'summary' => 'Creates a test group.', + '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' => 'The name of the application.'."\n", + 'type' => 'string', + 'required' => true, + 'docRequired' => true, + 'example' => 'my_app_group_name', + ], + ], + [ + 'name' => 'sceneId', + 'in' => 'path', + 'schema' => [ + 'description' => 'The scenario ID.'."\n", + 'type' => 'integer', + 'format' => 'int32', + 'required' => false, + 'maximum' => '999999999', + 'minimum' => '-1', + 'example' => '20404', + ], + ], + [ + 'name' => 'body', + 'in' => 'body', + 'schema' => [ + 'description' => 'The request body. For more information, see [ABTestGroup](~~178935~~).'."\n", + 'required' => false, + '$ref' => '#/components/schemas/ABTestGroup', + ], + ], + [ + 'name' => 'dryRun', + 'in' => 'query', + 'schema' => [ + 'description' => 'Specifies whether to check the validity of input parameters. Default value: false.'."\n" + ."\n" + .'Valid values:'."\n" + ."\n" + .'* **true**: checks only the validity of input parameters.'."\n" + .'* **false**: checks the validity of input parameters and creates an attribution configuration.'."\n", + 'type' => 'boolean', + 'required' => false, + 'example' => 'true', + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'type' => 'object', + 'properties' => [ + 'requestId' => [ + 'description' => 'The request ID.'."\n", + 'type' => 'string', + 'example' => 'D77D0DAF-790D-F5F5-A9C0-133738165014', + ], + 'result' => [ + 'description' => 'The returned results.'."\n", + 'type' => 'object', + 'properties' => [ + 'created' => [ + 'description' => 'The time when the test group was created.'."\n", + 'type' => 'integer', + 'format' => 'int32', + 'example' => '1588839490', + ], + 'status' => [ + 'description' => 'The status of the test group.'."\n" + ."\n" + .'* 0: not in effect'."\n" + .'* 1: in effect'."\n", + 'type' => 'integer', + 'format' => 'int32', + 'example' => '1', + ], + 'updated' => [ + 'description' => 'The time when the test group was last updated.'."\n", + 'type' => 'integer', + 'format' => 'int32', + 'example' => '1588839490', + ], + 'name' => [ + 'description' => 'The alias of the test group.'."\n", + 'type' => 'string', + 'example' => 'Group_2020-5-7_15:23:3', + ], + 'id' => [ + 'description' => 'The ID of the test group.'."\n", + 'type' => 'string', + 'example' => '13466', + ], + ], + ], + ], + 'description' => '', + ], + ], + '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":"<result>\\n <created>1588839490</created>\\n <name>Group_2020-5-7_15:23:3</name>\\n <id>13466</id>\\n <updated>1588839490</updated>\\n <status>1</status>\\n</result>\\n<requestId>D77D0DAF-790D-F5F5-A9C0-133738165014</requestId>","errorExample":""}]', + 'title' => 'CreateABTestGroup', + 'requestParamsDescription' => '**Request body**'."\n" + ."\n" + .'|Parameter|Type|Required|Example|Description|'."\n" + .'|---|---|---|---|---|'."\n" + .'|name|String|Yes|"kevintest3"|The name of the test group.|', + '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' => 'The application name.', + 'type' => 'string', + 'required' => true, + 'docRequired' => true, + 'example' => 'my_app_group_name', + ], + ], + [ + 'name' => 'sceneId', + 'in' => 'path', + 'schema' => [ + 'description' => 'The scenario ID.', + 'type' => 'integer', + 'format' => 'int32', + 'required' => true, + 'docRequired' => true, + 'maximum' => '999999999', + 'minimum' => '-1', + 'example' => '20404', + ], + ], + [ + 'name' => 'groupId', + 'in' => 'path', + 'schema' => [ + 'description' => 'The group ID.', + 'type' => 'integer', + 'format' => 'int32', + 'required' => true, + 'docRequired' => true, + 'maximum' => '999999999', + 'minimum' => '-1', + 'example' => '13467', + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'type' => 'object', + 'properties' => [ + 'result' => [ + 'description' => 'The return result.'."\n", + 'type' => 'object', + 'example' => '{}', + ], + 'requestId' => [ + 'description' => 'The ID of the request.'."\n", + '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":"<requestId>D77D0DAF-790D-F5F5-A9C0-133738165014</requestId>","errorExample":""}]', + 'title' => 'DeleteABTestGroup', + ], + 'DescribeABTestGroup' => [ + 'summary' => 'Queries the details of a test group.', + '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' => 'The name of the application'."\n", + 'type' => 'string', + 'required' => true, + 'docRequired' => true, + 'example' => 'my_app_group_name', + ], + ], + [ + 'name' => 'sceneId', + 'in' => 'path', + 'schema' => [ + 'description' => 'The scenario ID.'."\n", + 'type' => 'integer', + 'format' => 'int32', + 'required' => true, + 'docRequired' => true, + 'maximum' => '999999999', + 'minimum' => '-1', + 'example' => '20404', + ], + ], + [ + 'name' => 'groupId', + 'in' => 'path', + 'schema' => [ + 'description' => 'The ID of the test group.'."\n", + 'type' => 'integer', + 'format' => 'int32', + 'required' => true, + 'docRequired' => true, + 'maximum' => '999999999', + 'minimum' => '-1', + 'example' => '13467', + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'type' => 'object', + 'properties' => [ + 'requestId' => [ + 'description' => 'The request ID.'."\n", + 'type' => 'string', + 'example' => 'D77D0DAF-790D-F5F5-A9C0-133738165014', + ], + 'result' => [ + 'description' => 'The details of the test group.'."\n", + 'type' => 'object', + 'properties' => [ + 'created' => [ + 'description' => 'The time when the test group was created.'."\n", + 'type' => 'integer', + 'format' => 'int32', + 'example' => '1588839490', + ], + 'status' => [ + 'description' => 'The status of the test group. Valid values:'."\n" + ."\n" + .'* 0: not in effect'."\n" + .'* 1: in effect'."\n", + 'type' => 'integer', + 'format' => 'int32', + 'example' => '1', + ], + 'updated' => [ + 'description' => 'The time when the test group was last updated.'."\n", + 'type' => 'integer', + 'format' => 'int32', + 'example' => '1588839490', + ], + 'name' => [ + 'description' => 'The alias of the test group.'."\n", + 'type' => 'string', + 'example' => 'Group_2020-5-7_15:23:3', + ], + 'id' => [ + 'description' => 'The ID of the test group.'."\n", + 'type' => 'string', + 'example' => '13466', + ], + ], + ], + ], + 'description' => '', + ], + ], + '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":"<requestId>D77D0DAF-790D-F5F5-A9C0-133738165014</requestId>\\n<result>\\n <id>13466</id>\\n <name>Group_2020-5-7_15:23:3</name>\\n <status>1</status>\\n <created>1588839490</created>\\n <updated>1588839490</updated>\\n</result>","errorExample":""}]', + 'title' => 'DescribeABTestGroup', + 'requestParamsDescription' => ' ', + 'responseParamsDescription' => ' ', + 'extraInfo' => ' ', + ], + 'UpdateABTestGroup' => [ + 'summary' => 'Modifies a test group.', + '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' => 'The name of the application.'."\n", + 'type' => 'string', + 'required' => true, + 'docRequired' => true, + 'example' => '“my_app_group_name”', + ], + ], + [ + 'name' => 'sceneId', + 'in' => 'path', + 'schema' => [ + 'description' => 'The scenario ID.'."\n", + 'type' => 'integer', + 'format' => 'int32', + 'required' => true, + 'docRequired' => true, + 'maximum' => '999999999', + 'minimum' => '-1', + 'example' => '20404', + ], + ], + [ + 'name' => 'groupId', + 'in' => 'path', + 'schema' => [ + 'description' => 'The ID of the test group.'."\n", + 'type' => 'integer', + 'format' => 'int32', + 'required' => true, + 'docRequired' => true, + 'maximum' => '999999999', + 'minimum' => '-1', + 'example' => '13467', + ], + ], + [ + 'name' => 'body', + 'in' => 'body', + 'schema' => [ + 'description' => 'The request body. For more information, see [ABTestGroup](~~178935~~).'."\n", + 'required' => false, + '$ref' => '#/components/schemas/ABTestGroup', + ], + ], + [ + 'name' => 'dryRun', + 'in' => 'query', + 'schema' => [ + 'description' => 'Specifies whether to perform only a dry run, without performing the actual request. Valid values:'."\n" + ."\n" + .'* true: performs only a dry run. No endpoint is created. The system checks whether your AccessKey is valid, whether Resource Access Management (RAM) users are authorized, and whether the required parameters are set.'."\n" + .'* false (default): creates an endpoint immediately.'."\n", + 'type' => 'boolean', + 'required' => false, + 'example' => 'true', + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'type' => 'object', + 'properties' => [ + 'requestId' => [ + 'description' => 'The request ID.'."\n", + 'type' => 'string', + 'example' => '\'\'1111\'\'', + ], + 'result' => [ + 'description' => 'The details of the test group.'."\n", + 'type' => 'object', + 'properties' => [ + 'created' => [ + 'description' => 'The time when the test group was created.'."\n", + 'type' => 'integer', + 'format' => 'int32', + 'example' => '1588839490', + ], + 'status' => [ + 'description' => 'The status of the test group. Valid values:'."\n" + ."\n" + .'* 0: not in effect'."\n" + .'* 1: in effect'."\n", + 'type' => 'integer', + 'format' => 'int32', + 'example' => '1', + ], + 'updated' => [ + 'description' => 'The time when the test group was last updated.'."\n", + 'type' => 'integer', + 'format' => 'int32', + 'example' => '1588839490', + ], + 'name' => [ + 'description' => 'The alias of the test group.'."\n", + 'type' => 'string', + 'example' => 'Group_2020-5-7_15:23:3', + ], + 'id' => [ + 'description' => 'The ID of the test group.'."\n", + 'type' => 'string', + 'example' => '13466', + ], + ], + ], + ], + 'description' => '', + ], + ], + '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":"<requestId>D77D0DAF-790D-F5F5-A9C0-133738165014</requestId>\\n<result>\\n <id>13467</id>\\n <name>kevintestgroup222</name>\\n <status>1</status>\\n <created>1589016325</created>\\n <updated>1589016544</updated>\\n</result>","errorExample":""}]', + 'title' => 'UpdateABTestGroup', + 'requestParamsDescription' => '**Request body**'."\n" + ."\n" + .'|Parameter|Type|Required|Example|Description|'."\n" + .'|---|---|---|---|---|'."\n" + .'|name|String|Yes|"kevintest3"|The name of the test group.|', + 'responseParamsDescription' => ' ', + 'extraInfo' => ' ', + ], + 'ListABTestExperiments' => [ + 'summary' => 'Queries a list of experiments.', + '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' => 'The application name.'."\n", + 'type' => 'string', + 'required' => true, + 'docRequired' => true, + 'example' => '“my_app_group_name”', + ], + ], + [ + 'name' => 'sceneId', + 'in' => 'path', + 'schema' => [ + 'description' => 'The scenario ID.'."\n", + 'type' => 'integer', + 'format' => 'int32', + 'required' => true, + 'docRequired' => true, + 'maximum' => '999999999', + 'minimum' => '-1', + 'example' => '13467', + ], + ], + [ + 'name' => 'groupId', + 'in' => 'path', + 'schema' => [ + 'description' => 'The group ID.'."\n", + 'type' => 'integer', + 'format' => 'int32', + 'required' => true, + 'docRequired' => true, + 'maximum' => '999999999', + 'minimum' => '-1', + 'example' => '20404', + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'type' => 'object', + 'properties' => [ + 'requestId' => [ + 'description' => 'The request ID.'."\n", + 'type' => 'string', + 'example' => 'D77D0DAF-790D-F5F5-A9C0-133738165014', + ], + 'result' => [ + 'description' => 'The experiment details.\\'."\n" + .'For more information, see [ABTestExperiment](~~173617~~).'."\n", + 'type' => 'array', + 'items' => [ + 'type' => 'object', + 'properties' => [ + 'created' => [ + 'description' => 'The time when the experiment was created.'."\n", + 'type' => 'integer', + 'format' => 'int32', + 'example' => '1588842080', + ], + 'params' => [ + 'description' => 'The experiment parameters.'."\n", + 'type' => 'object', + 'example' => '1', + ], + 'traffic' => [ + 'description' => 'The percentage of traffic that is routed to the experiment.'."\n" + ."\n" + .'Valid values: \\[0,100]'."\n", + 'type' => 'integer', + 'format' => 'int32', + 'example' => '30', + ], + 'online' => [ + 'description' => 'Indicates whether the experiment is in effect. Valid values:'."\n" + ."\n" + .'* true'."\n" + .'* false'."\n", + 'type' => 'boolean', + 'example' => 'true', + ], + 'name' => [ + 'description' => 'The group alias.'."\n", + 'type' => 'string', + 'example' => 'test1', + ], + 'updated' => [ + 'description' => 'The time when the experiment was last modified.'."\n", + 'type' => 'integer', + 'format' => 'int32', + 'example' => '1588842080', + ], + 'id' => [ + 'description' => 'The experiment ID.'."\n", + 'type' => 'string', + 'example' => '12888', + ], + ], + ], + ], + ], + 'description' => '', + ], + ], + '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":"<requestId>D77D0DAF-790D-F5F5-A9C0-133738165014</requestId>\\n<result>\\n <id>12888</id>\\n <name>test1</name>\\n <params>\\n <firstFormulaName>default</firstFormulaName>\\n </params>\\n <created>1588842080</created>\\n <updated>1588842080</updated>\\n <online>true</online>\\n <traffic>30</traffic>\\n</result>","errorExample":""}]', + 'title' => 'ListABTestExperiments', + 'requestParamsDescription' => ' ', + 'responseParamsDescription' => ' ', + 'extraInfo' => ' ', + ], + 'CreateABTestExperiment' => [ + 'summary' => 'Creates an experiment.', + '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' => 'The application name.'."\n", + 'type' => 'string', + 'required' => true, + 'docRequired' => true, + 'example' => 'my_app_group_name', + ], + ], + [ + 'name' => 'sceneId', + 'in' => 'path', + 'schema' => [ + 'description' => 'The scenario ID.'."\n", + 'type' => 'integer', + 'format' => 'int32', + 'required' => true, + 'docRequired' => true, + 'maximum' => '999999999', + 'minimum' => '-1', + 'example' => '20404', + ], + ], + [ + 'name' => 'groupId', + 'in' => 'path', + 'schema' => [ + 'description' => 'The group ID.'."\n", + 'type' => 'integer', + 'format' => 'int32', + 'required' => true, + 'docRequired' => true, + 'maximum' => '999999999', + 'minimum' => '-1', + 'example' => '13467', + ], + ], + [ + 'name' => 'dryRun', + 'in' => 'query', + 'schema' => [ + 'description' => 'Specifies whether to perform a dry run. This parameter is only used to check whether the data source is valid. Valid values: true and false.'."\n", + 'type' => 'boolean', + 'required' => false, + 'example' => 'false', + ], + ], + [ + 'name' => 'body', + 'in' => 'body', + 'schema' => [ + 'description' => 'The request body.'."\n", + 'required' => false, + '$ref' => '#/components/schemas/ABTestExperiment', + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'type' => 'object', + 'properties' => [ + 'requestId' => [ + 'description' => 'The request ID.'."\n", + 'type' => 'string', + 'example' => 'D77D0DAF-790D-F5F5-A9C0-133738165014', + ], + 'result' => [ + 'description' => 'The experiment details.'."\n", + 'type' => 'object', + 'properties' => [ + 'created' => [ + 'description' => 'The time when the experiment was created.'."\n", + 'type' => 'integer', + 'format' => 'int32', + 'example' => '0', + ], + 'params' => [ + 'description' => 'The experiment parameters.'."\n", + 'type' => 'object', + 'example' => '{"firstFormulaName": "default"}', + ], + 'traffic' => [ + 'description' => 'The percentage of traffic that is routed to the experiment.'."\n", + 'type' => 'integer', + 'format' => 'int32', + 'example' => '30', + ], + 'online' => [ + 'description' => 'Indicates whether the experiment is in effect. Valid values:'."\n" + ."\n" + .'* true'."\n" + .'* false'."\n", + 'type' => 'boolean', + 'example' => 'true', + ], + 'name' => [ + 'description' => 'The experiment alias.'."\n", + 'type' => 'string', + 'example' => 'test3', + ], + 'updated' => [ + 'description' => 'The time when the experiment was last modified.'."\n", + 'type' => 'integer', + 'format' => 'int32', + 'example' => '1589017861', + ], + 'id' => [ + 'description' => 'The experiment ID.'."\n", + 'type' => 'string', + 'example' => '12889', + ], + ], + ], + ], + 'description' => '', + ], + ], + '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":"<result>\\n <created>0</created>\\n <name>test3</name>\\n <online>true</online>\\n <id>12889</id>\\n <params>\\n <firstFormulaName>default</firstFormulaName>\\n </params>\\n <updated>1589017861</updated>\\n <traffic>30</traffic>\\n</result>\\n<requestId>D77D0DAF-790D-F5F5-A9C0-133738165014</requestId>","errorExample":""}]', + 'title' => 'CreateABTestExperiment', + 'requestParamsDescription' => '**Request body**'."\n" + ."\n" + .'|Parameter|Type|Required|Example|Description|'."\n" + .'|---|---|---|---|---|'."\n" + .'|name|String|Yes|"my\\_test"|The experiment name.|'."\n" + .'|traffic|Integer|Yes|30|The traffic that is routed to the experiment.|'."\n" + .'|online|Boolean|Yes|true|Specifies whether the experiment is in effect.|'."\n" + .'|params|Object|Yes|{"firstFormulaName": "default"}|The experiment configurations. For more information, see [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' => 'The application name.', + 'type' => 'string', + 'required' => true, + 'docRequired' => true, + 'example' => 'my_app_group_name', + ], + ], + [ + 'name' => 'sceneId', + 'in' => 'path', + 'schema' => [ + 'description' => 'The scenario ID.', + 'type' => 'integer', + 'format' => 'int32', + 'required' => true, + 'docRequired' => true, + 'maximum' => '999999999', + 'minimum' => '-1', + 'example' => '20404', + ], + ], + [ + 'name' => 'groupId', + 'in' => 'path', + 'schema' => [ + 'description' => 'The group ID.', + 'type' => 'integer', + 'format' => 'int32', + 'required' => true, + 'docRequired' => true, + 'maximum' => '999999999', + 'minimum' => '-1', + 'example' => '13467', + ], + ], + [ + 'name' => 'experimentId', + 'in' => 'path', + 'schema' => [ + 'description' => 'The experiment ID', + 'type' => 'integer', + 'format' => 'int32', + 'required' => true, + 'docRequired' => true, + 'maximum' => '999999999', + 'minimum' => '-1', + 'example' => '12889', + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'type' => 'object', + 'properties' => [ + 'requestId' => [ + 'description' => 'The ID of the request.'."\n", + 'type' => 'string', + 'example' => 'D77D0DAF-790D-F5F5-A9C0-133738165014', + ], + 'result' => [ + 'description' => 'The details of the test.'."\n", + 'type' => 'object', + 'properties' => [ + 'created' => [ + 'description' => 'The time when the test was created.'."\n", + 'type' => 'integer', + 'format' => 'int32', + 'example' => '1588842080', + ], + 'traffic' => [ + 'description' => 'The percentage of traffic that is routed to the test.'."\n", + 'type' => 'integer', + 'format' => 'int32', + 'example' => '30', + ], + 'online' => [ + 'description' => 'The status of the test. Valid values:'."\n" + ."\n" + .'* true: in effect'."\n" + .'* false: not in effect'."\n", + 'type' => 'boolean', + 'example' => 'true', + ], + 'name' => [ + 'description' => 'The name of the test.'."\n", + 'type' => 'string', + 'example' => 'test1', + ], + 'updated' => [ + 'description' => 'The time when the test was last modified.'."\n", + 'type' => 'integer', + 'format' => 'int32', + 'example' => '1588842080', + ], + 'id' => [ + 'description' => 'The ID of the test.'."\n", + 'type' => 'string', + 'example' => '12888', + ], + 'params' => [ + 'description' => 'The parameters of the test.'."\n", + 'type' => 'object', + 'properties' => [ + 'first_formula_name' => [ + 'description' => 'The name of the rough sort policy.'."\n", + '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":"<requestId>D77D0DAF-790D-F5F5-A9C0-133738165014</requestId>\\n<result>\\n <id>12888</id>\\n <name>test1</name>\\n <params>\\n <first_formula_name>default</first_formula_name>\\n </params>\\n <created>1588842080</created>\\n <updated>1588842080</updated>\\n <online>true</online>\\n <traffic>30</traffic>\\n</result>","errorExample":""}]', + 'title' => 'DescribeABTestExperiment', + 'requestParamsDescription' => ' ', + 'responseParamsDescription' => ' ', + 'extraInfo' => ' ', + ], + 'UpdateABTestExperiment' => [ + 'summary' => 'Modifies the parameters of an A/B test.', + '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' => 'The name of the application.'."\n", + 'type' => 'string', + 'required' => true, + 'docRequired' => true, + 'example' => '“my_app_group_name”', + ], + ], + [ + 'name' => 'sceneId', + 'in' => 'path', + 'schema' => [ + 'description' => 'The scenario ID.'."\n", + 'type' => 'integer', + 'format' => 'int32', + 'required' => true, + 'docRequired' => true, + 'maximum' => '999999999', + 'minimum' => '-1', + 'example' => '20404', + ], + ], + [ + 'name' => 'groupId', + 'in' => 'path', + 'schema' => [ + 'description' => 'The ID of the test group'."\n", + 'type' => 'integer', + 'format' => 'int32', + 'required' => true, + 'docRequired' => true, + 'maximum' => '999999999', + 'minimum' => '-1', + 'example' => '13467', + ], + ], + [ + 'name' => 'experimentId', + 'in' => 'path', + 'schema' => [ + 'description' => 'The test ID.'."\n", + 'type' => 'integer', + 'format' => 'int32', + 'required' => true, + 'docRequired' => true, + 'maximum' => '999999999', + 'minimum' => '-1', + 'example' => '12889', + ], + ], + [ + 'name' => 'dryRun', + 'in' => 'query', + 'schema' => [ + 'description' => 'Specifies whether to perform only a dry run, without performing the actual request. Valid values:'."\n" + ."\n" + .'* true: performs only a dry run. No endpoint is created. The system checks whether your AccessKey is valid, whether Resource Access Management (RAM) users are authorized, and whether the required parameters are set.'."\n" + .'* false (default): creates an endpoint immediately.'."\n", + 'type' => 'boolean', + 'required' => false, + 'example' => 'true', + ], + ], + [ + 'name' => 'body', + 'in' => 'body', + 'schema' => [ + 'description' => 'The request body. For more information, see [ABTestExperiment](~~173617~~).'."\n", + 'required' => false, + '$ref' => '#/components/schemas/ABTestExperiment', + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'type' => 'object', + 'properties' => [ + 'requestId' => [ + 'description' => 'The request ID.'."\n", + 'type' => 'string', + 'example' => 'D77D0DAF-790D-F5F5-A9C0-133738165014', + ], + 'result' => [ + 'description' => 'The details of the test.'."\n", + 'type' => 'object', + 'properties' => [ + 'created' => [ + 'description' => 'The time when the test was created.'."\n", + 'type' => 'integer', + 'format' => 'int32', + 'example' => '1588842080', + ], + 'params' => [ + 'description' => 'The test parameters.'."\n", + 'type' => 'object', + 'example' => '{}', + ], + 'traffic' => [ + 'description' => 'The percentage of traffic that is routed to the test. Valid values: \\[0,100]'."\n", + 'type' => 'integer', + 'format' => 'int32', + 'example' => '30', + ], + 'online' => [ + 'description' => 'Indicates whether the test is in effect. Valid values:'."\n" + ."\n" + .'* true'."\n" + .'* false'."\n", + 'type' => 'boolean', + 'example' => 'true', + ], + 'name' => [ + 'description' => 'The alias of the test.'."\n", + 'type' => 'string', + 'example' => 'test1', + ], + 'updated' => [ + 'description' => 'The time when the test was last modified.'."\n", + 'type' => 'integer', + 'format' => 'int32', + 'example' => '1588842080', + ], + 'id' => [ + 'description' => 'The test ID.'."\n", + 'type' => 'string', + 'example' => '12888', + ], + ], + ], + ], + 'description' => '', + ], + ], + '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":"<requestId>D77D0DAF-790D-F5F5-A9C0-133738165014</requestId>\\n<result>\\n <id>12889</id>\\n <name>test333</name>\\n <params>\\n <firstFormulaName>default</firstFormulaName>\\n </params>\\n <created>1589017860</created>\\n <updated>1589018211</updated>\\n <online>true</online>\\n <traffic>40</traffic>\\n</result>","errorExample":""}]', + 'title' => 'UpdateABTestExperiment', + 'requestParamsDescription' => '**Request body**'."\n" + ."\n" + .'|Parameter|Type|Required|Example|Description|'."\n" + .'|---|---|---|---|---|'."\n" + .'|name|String|No|"my\\_test"|The name of the test.|'."\n" + .'|traffic|Integer|No|30|The traffic that is routed to the test.|'."\n" + .'|online|Boolean|No|true|Specifies whether the test is in effect.|'."\n" + .'|params|Object|No|{"firstFormulaName": "default"}|The test configurations.|', + 'responseParamsDescription' => ' ', + 'extraInfo' => ' ', + ], + 'DeleteABTestExperiment' => [ + 'summary' => 'Deletes a test.', + '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' => 'The name of the application'."\n", + 'type' => 'string', + 'required' => true, + 'docRequired' => true, + 'example' => 'my_app_group_name', + ], + ], + [ + 'name' => 'sceneId', + 'in' => 'path', + 'schema' => [ + 'description' => 'The scenario ID.'."\n", + 'type' => 'integer', + 'format' => 'int32', + 'required' => true, + 'docRequired' => true, + 'maximum' => '999999999', + 'minimum' => '-1', + 'example' => '20404', + ], + ], + [ + 'name' => 'groupId', + 'in' => 'path', + 'schema' => [ + 'description' => 'The ID of the test group.'."\n", + 'type' => 'integer', + 'format' => 'int32', + 'required' => true, + 'docRequired' => true, + 'maximum' => '999999999', + 'minimum' => '-1', + 'example' => '13467', + ], + ], + [ + 'name' => 'experimentId', + 'in' => 'path', + 'schema' => [ + 'description' => 'The test ID.'."\n", + 'type' => 'integer', + 'format' => 'int32', + 'required' => true, + 'docRequired' => true, + 'maximum' => '999999999', + 'minimum' => '-1', + 'example' => '12889', + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'type' => 'object', + 'properties' => [ + 'result' => [ + 'description' => 'The returned data.'."\n", + 'type' => 'object', + 'example' => '{}', + ], + 'requestId' => [ + 'description' => 'The request ID.'."\n", + 'type' => 'string', + 'example' => 'ABCDEFGH', + ], + ], + 'description' => '', + ], + ], + '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":"<requestId>D77D0DAF-790D-F5F5-A9C0-133738165014</requestId>","errorExample":""}]', + 'title' => 'DeleteABTestExperiment', + 'requestParamsDescription' => ' ', + 'responseParamsDescription' => ' ', + 'extraInfo' => ' ', + ], + 'ListABTestFixedFlowDividers' => [ + 'summary' => 'Queries whitelists.', + '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' => 'The name of the application'."\n", + 'type' => 'string', + 'required' => true, + 'docRequired' => true, + 'example' => '“my_app_group_name”', + ], + ], + [ + 'name' => 'sceneId', + 'in' => 'path', + 'schema' => [ + 'description' => 'The scenario ID.'."\n", + 'type' => 'integer', + 'format' => 'int32', + 'required' => true, + 'docRequired' => true, + 'maximum' => '999999999', + 'minimum' => '-1', + 'example' => '12889', + ], + ], + [ + 'name' => 'groupId', + 'in' => 'path', + 'schema' => [ + 'description' => 'The group ID'."\n", + 'type' => 'integer', + 'format' => 'int32', + 'required' => true, + 'docRequired' => true, + 'maximum' => '999999999', + 'minimum' => '-1', + 'example' => '13467', + ], + ], + [ + 'name' => 'experimentId', + 'in' => 'path', + 'schema' => [ + 'description' => 'The test ID.'."\n", + 'type' => 'integer', + 'format' => 'int32', + 'required' => true, + 'docRequired' => true, + 'maximum' => '999999999', + 'minimum' => '-1', + 'example' => '20404', + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'type' => 'object', + 'properties' => [ + 'requestId' => [ + 'description' => 'The request ID.'."\n", + 'type' => 'string', + 'example' => 'D77D0DAF-790D-F5F5-A9C0-133738165014', + ], + 'result' => [ + 'type' => 'array', + 'items' => [ + 'description' => 'The whitelist'."\n", + 'type' => 'string', + 'example' => '[ "D77D0DAF", "133738165014" ]', + ], + 'description' => '', + ], + ], + 'description' => '', + ], + ], + '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":"<requestId>D77D0DAF-790D-F5F5-A9C0-133738165014</requestId>\\n<result>D77D0DAF</result>\\n<result>133738165014</result>","errorExample":""}]', + 'title' => 'ListABTestFixedFlowDividers', + 'requestParamsDescription' => ' ', + 'responseParamsDescription' => ' ', + 'extraInfo' => ' ', + ], + 'UpdateABTestFixedFlowDividers' => [ + 'summary' => 'Modifies whitelists.', + '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' => 'The name of the application.'."\n", + 'type' => 'string', + 'required' => true, + 'docRequired' => true, + 'example' => '“my_app_group_name”', + ], + ], + [ + 'name' => 'sceneId', + 'in' => 'path', + 'schema' => [ + 'description' => 'The scenario ID.'."\n", + 'type' => 'integer', + 'format' => 'int32', + 'required' => true, + 'docRequired' => true, + 'maximum' => '999999999', + 'minimum' => '-1', + 'example' => '20404', + ], + ], + [ + 'name' => 'groupId', + 'in' => 'path', + 'schema' => [ + 'description' => 'The ID of the test group.'."\n", + 'type' => 'integer', + 'format' => 'int32', + 'required' => true, + 'docRequired' => true, + 'maximum' => '999999999', + 'minimum' => '-1', + 'example' => '13467', + ], + ], + [ + 'name' => 'experimentId', + 'in' => 'path', + 'schema' => [ + 'description' => 'The test ID.'."\n", + 'type' => 'integer', + 'format' => 'int32', + 'required' => true, + 'docRequired' => true, + 'maximum' => '999999999', + 'minimum' => '-1', + 'example' => '12889', + ], + ], + [ + 'name' => 'body', + 'in' => 'body', + 'style' => 'json', + 'schema' => [ + 'description' => 'The request body.'."\n", + 'type' => 'array', + 'items' => [ + 'description' => 'The whitelist that you want to update'."\n", + 'type' => 'string', + 'required' => false, + 'example' => '"D77D0DAF" ', + ], + 'required' => false, + 'maxItems' => 100, + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'type' => 'object', + 'properties' => [ + 'requestId' => [ + 'description' => 'The request ID.'."\n", + 'type' => 'string', + 'example' => 'D77D0DAF-790D-F5F5-A9C0-133738165014', + ], + 'result' => [ + 'description' => 'The returned results.'."\n", + 'type' => 'array', + 'items' => [ + 'description' => 'The whitelist.'."\n", + 'type' => 'string', + 'example' => '[ "D77D0DAF", "133738165014" ]', + ], + ], + ], + 'description' => '', + ], + ], + '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":"<requestId>D77D0DAF-790D-F5F5-A9C0-133738165014</requestId>\\n<result>D77D0DAF</result>\\n<result>133738165014</result>","errorExample":""}]', + 'title' => 'UpdateABTestFixedFlowDividers', + 'requestParamsDescription' => '**Request body**'."\n" + ."\n" + .'|Parameter|Type|Required|Example|Description|'."\n" + .'|---|---|---|---|---|'."\n" + .'|\\[\\]|String|Yes|"D77D0DAF"|The whitelist that you want to update.|', + 'responseParamsDescription' => ' ', + 'extraInfo' => ' ', + ], + 'ListFirstRanks' => [ + 'summary' => 'Queries the rough sort expressions that are configured for a version of an OpenSearch application.', + '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' => 'The name of the application.'."\n", + 'type' => 'string', + 'required' => true, + 'docRequired' => true, + 'example' => 'my_app_group_name', + ], + ], + [ + 'name' => 'appId', + 'in' => 'path', + 'schema' => [ + 'description' => 'The version number of the application.'."\n", + 'type' => 'integer', + 'format' => 'int32', + 'required' => true, + 'docRequired' => true, + 'example' => '110157886', + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'description' => 'The rsponse body.'."\n", + 'type' => 'object', + 'properties' => [ + 'requestId' => [ + 'description' => 'The request ID.'."\n", + 'type' => 'string', + 'example' => '0A6EB64B-B4C8-CF02-810F-E660812972FF', + ], + 'result' => [ + 'description' => 'The information about the rough sort expression.'."\n" + ."\n" + .'For more information, see [FirstRank](~~170007~~).'."\n", + 'type' => 'array', + 'items' => [ + 'description' => 'The result body.'."\n", + 'type' => 'object', + 'properties' => [ + 'created' => [ + 'description' => 'The time when the expression was created.'."\n", + 'type' => 'integer', + 'format' => 'int32', + 'example' => '0', + ], + 'active' => [ + 'description' => 'Specifies whether to set the fine sort expression as the default sort expression.'."\n", + 'type' => 'boolean', + 'example' => 'true', + ], + 'description' => [ + 'description' => 'Description'."\n", + 'type' => 'string', + 'example' => '""', + ], + 'updated' => [ + 'description' => 'The time when the expression was updated.'."\n", + 'type' => 'integer', + 'format' => 'int32', + 'example' => '0', + ], + 'name' => [ + 'description' => 'The name.'."\n", + 'type' => 'string', + 'example' => 'default', + ], + 'meta' => [ + 'description' => 'The information about the expression.'."\n", + 'type' => 'array', + 'items' => [ + 'description' => 'The message body'."\n", + 'type' => 'object', + 'properties' => [ + 'arg' => [ + 'description' => 'The parameters that are used by a function in the expression.'."\n" + ."\n" + .'For more information, see [Rough sort functions](~~180765~~).'."\n", + 'type' => 'string', + 'example' => '""', + ], + 'attribute' => [ + 'description' => 'The attribute, feature function, or field to be searched for.'."\n" + ."\n" + .'For more information about supported feature functions, see [Rough sort functions](~~180765~~).'."\n", + 'type' => 'string', + 'example' => 'static_bm25()', + ], + 'weight' => [ + 'description' => 'The weight. Valid values: -100000 to 100000. The value cannot be 0.'."\n", + '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":"<requestId>0A6EB64B-B4C8-CF02-810F-E660812972FF</requestId>\\n<result>\\n <name>default</name>\\n <description/>\\n <active>true</active>\\n <type>STRUCT</type>\\n <meta>\\n <attribute>static_bm25()</attribute>\\n <arg/>\\n <weight>1</weight>\\n </meta>\\n <created>0</created>\\n <updated>0</updated>\\n</result>","errorExample":""}]', + 'title' => 'ListFirstRanks', + ], + 'CreateFirstRank' => [ + 'summary' => 'Creates a rough sort expression for a version of an OpenSearch application. If you set dryRun to true, this operation checks the specified rough sort expression. By default, the value of dryRun is false if you do not set this parameter.', + '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' => 'Specifies whether to perform a dry run.'."\n", + 'type' => 'boolean', + 'required' => false, + 'example' => 'true', + ], + ], + [ + 'name' => 'appGroupIdentity', + 'in' => 'path', + 'schema' => [ + 'description' => 'The name of the application'."\n", + 'type' => 'string', + 'required' => true, + 'docRequired' => true, + 'example' => 'my_app_group_name', + ], + ], + [ + 'name' => 'appId', + 'in' => 'path', + 'schema' => [ + 'description' => 'The version number of the application.'."\n", + 'type' => 'integer', + 'format' => 'int32', + 'required' => true, + 'docRequired' => true, + 'example' => '110157886', + ], + ], + [ + 'name' => 'body', + 'in' => 'body', + 'schema' => [ + 'description' => 'The request body that contains the parameters of the rough sort expression.'."\n", + 'required' => false, + '$ref' => '#/components/schemas/FirstRank', + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'type' => 'object', + 'properties' => [ + 'requestId' => [ + 'description' => 'The request ID.'."\n", + 'type' => 'string', + 'example' => '0A6EB64B-B4C8-CF02-810F-E660812972FF', + ], + 'result' => [ + 'description' => 'The information about the rough sort expression.'."\n", + 'type' => 'object', + 'properties' => [ + 'active' => [ + 'description' => 'Indicates whether the expression is the default one.'."\n", + 'type' => 'boolean', + 'example' => 'true', + ], + 'name' => [ + 'description' => 'The name of the expression.'."\n", + 'type' => 'string', + 'example' => 'default', + ], + 'meta' => [ + 'description' => 'The content of the expression.'."\n", + 'type' => 'array', + 'items' => [ + 'type' => 'object', + 'properties' => [ + 'arg' => [ + 'description' => 'The parameters that are used by a function in the expression.'."\n", + 'type' => 'string', + 'example' => '1', + ], + 'attribute' => [ + 'description' => 'The attribute, feature functions, or field to be searched for.'."\n", + 'type' => 'string', + 'example' => 'static_bm25()', + ], + 'weight' => [ + 'description' => 'The weight. Valid values: \\[-100000,100000]. The value cannot be 0.'."\n", + 'type' => 'number', + 'format' => 'float', + 'example' => '10', + ], + ], + ], + ], + ], + ], + ], + 'description' => '', + ], + ], + '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":"<requestId>0A6EB64B-B4C8-CF02-810F-E660812972FF</requestId>\\n<result>\\n <name>general_default</name>\\n <description/>\\n <active>false</active>\\n <type>STRUCT</type>\\n <meta>\\n <attribute>static_bm25()</attribute>\\n <arg/>\\n <weight>2</weight>\\n </meta>\\n <meta>\\n <attribute>hot_score</attribute>\\n <arg/>\\n <weight>0.000001</weight>\\n </meta>\\n <created>0</created>\\n <updated>0</updated>\\n</result>","errorExample":""}]', + 'title' => 'CreateFirstRank', + 'requestParamsDescription' => '**Request body**'."\n" + ."\n" + .'|Parameter|Type|Required|Example|Description|'."\n" + .'|---|---|---|---|---|'."\n" + .'|name|String|Yes|"test"|The name of the expression.|'."\n" + .'|type|String|Yes|"STRUCT"|The type of the expression. Valid values:STRUCT: The content of the expression is a structure. This is the default value.STRING: The content of the expression is a custom formula.|'."\n" + .'|meta|Array or String|Yes||The content of the expression.|'."\n" + .'|description|String|No|"my\\_test"|The description of the expression.|'."\n" + .'|active|Boolean|No|true|Specifies whether the expression is the default one.|', + 'responseParamsDescription' => ' ', + 'extraInfo' => ' ', + ], + 'DescribeFirstRank' => [ + 'summary' => 'Queries a rough sort expression that is configured for an OpenSearch application version.', + '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' => 'The name of the application.'."\n", + 'type' => 'string', + 'required' => true, + 'docRequired' => true, + 'example' => 'my_app_group_name', + ], + ], + [ + 'name' => 'appId', + 'in' => 'path', + 'schema' => [ + 'description' => 'The version number.'."\n", + 'type' => 'integer', + 'format' => 'int32', + 'required' => true, + 'docRequired' => true, + 'example' => '110157886', + ], + ], + [ + 'name' => 'name', + 'in' => 'path', + 'schema' => [ + 'description' => 'The name of the rough sort expression'."\n", + 'type' => 'string', + 'required' => true, + 'docRequired' => true, + 'example' => 'test', + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'type' => 'object', + 'properties' => [ + 'requestId' => [ + 'description' => 'The request ID.'."\n", + 'type' => 'string', + 'example' => '0A6EB64B-B4C8-CF02-810F-E660812972FF', + ], + 'result' => [ + 'description' => 'The information about the rough sort expression.'."\n", + 'type' => 'object', + 'properties' => [ + 'description' => [ + 'description' => 'Description'."\n", + 'type' => 'string', + 'example' => '-', + ], + 'active' => [ + 'description' => 'Indicates whether the expression is the default one.'."\n", + 'type' => 'boolean', + 'example' => 'false', + ], + 'name' => [ + 'description' => 'Parameter'."\n", + 'type' => 'string', + 'example' => 'ar_wear_edit_time', + ], + 'meta' => [ + 'description' => 'The information about the expression.'."\n", + 'type' => 'array', + 'items' => [ + 'type' => 'object', + 'properties' => [ + 'arg' => [ + 'description' => 'The parameters that are used by a function in the expression.'."\n", + 'type' => 'string', + 'example' => 'ar_edit_time', + ], + 'attribute' => [ + 'description' => 'The attribute, feature function, or field to be searched for.'."\n", + 'type' => 'string', + 'example' => 'timeliness_ms()', + ], + 'weight' => [ + 'description' => 'The weight. Valid values: -100000 to 100000. The value cannot be 0.'."\n", + 'type' => 'number', + 'format' => 'float', + 'example' => '1', + ], + ], + 'description' => '', + ], + ], + ], + ], + ], + 'description' => '', + ], + ], + '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":"<requestId>0A6EB64B-B4C8-CF02-810F-E660812972FF</requestId>\\n<result>\\n <name>ar_wear_edit_time</name>\\n <type>STRUCT</type>\\n <meta>\\n <attribute>timeliness_ms()</attribute>\\n <arg>ar_edit_time</arg>\\n <weight>1</weight>\\n </meta>\\n <description/>\\n <active>false</active>\\n <created>0</created>\\n <updated>0</updated>\\n</result>","errorExample":""}]', + 'title' => 'DescribeFirstRank', + 'requestParamsDescription' => ' ', + 'responseParamsDescription' => ' ', + 'extraInfo' => ' ', + ], + 'RemoveFirstRank' => [ + 'summary' => 'Deletes a rough sort expression for a version of an OpenSearch application.', + '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' => 'The name of the application'."\n", + 'type' => 'string', + 'required' => true, + 'docRequired' => true, + 'example' => '“my_app_group_name”', + ], + ], + [ + 'name' => 'appId', + 'in' => 'path', + 'schema' => [ + 'description' => 'The version number of the application.'."\n", + 'type' => 'integer', + 'format' => 'int32', + 'required' => true, + 'docRequired' => true, + 'example' => '110157886', + ], + ], + [ + 'name' => 'name', + 'in' => 'path', + 'schema' => [ + 'description' => 'The name of the rough sort expression.'."\n", + 'type' => 'string', + 'required' => true, + 'docRequired' => true, + 'example' => '“test”', + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'type' => 'object', + 'properties' => [ + 'requestId' => [ + 'description' => 'The request ID.'."\n", + 'type' => 'string', + 'example' => 'E676FAB6-A0AC-64D9-F9D7-D0D33C930CFF', + ], + 'result' => [ + 'description' => 'The information about the rough sort expression.'."\n", + 'type' => 'object', + 'properties' => [ + 'description' => [ + 'description' => 'Description'."\n", + 'type' => 'string', + 'example' => '""', + ], + 'active' => [ + 'description' => 'Specifies whether to set the fine sort expression as the default sort expression.'."\n", + 'type' => 'boolean', + 'example' => 'true', + ], + 'name' => [ + 'description' => 'Parameter'."\n", + 'type' => 'string', + 'example' => 'default', + ], + 'meta' => [ + 'description' => 'The information about the expression.'."\n", + 'type' => 'array', + 'items' => [ + 'type' => 'object', + 'properties' => [ + 'arg' => [ + 'description' => 'The parameters that are used by a function in the expression. For more information, see Rough sort functions.[](~~170007~~)'."\n", + 'type' => 'string', + 'example' => '""', + ], + 'attribute' => [ + 'description' => 'The attribute, which refers to the scoring feature or search field, For more information about supported feature functions, see Rough sort functions.[](~~170007~~)'."\n", + 'type' => 'string', + 'example' => 'static_bm25()', + ], + 'weight' => [ + 'description' => 'The weight. Valid values: -100000 to 100000. The value cannot be 0.'."\n", + 'type' => 'number', + 'format' => 'float', + 'example' => '10', + ], + ], + 'description' => '', + ], + ], + ], + ], + ], + 'description' => '', + ], + ], + '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":"<requestId>E676FAB6-A0AC-64D9-F9D7-D0D33C930CFF</requestId>\\n<result>\\n <name>test2</name>\\n <description/>\\n <active>false</active>\\n <type>STRUCT</type>\\n <meta>\\n <attribute>timeliness()</attribute>\\n <arg>hid</arg>\\n <weight>1</weight>\\n </meta>\\n <created>1587708467</created>\\n <updated>1587708467</updated>\\n</result>","errorExample":""}]', + 'title' => 'RemoveFirstRank', + 'requestParamsDescription' => ' ', + 'responseParamsDescription' => ' ', + ], + 'ModifyFirstRank' => [ + 'summary' => 'Modifies a rough sort expression for an OpenSearch application. If you set dryRun to true, this operation checks the rough sort expression after the expression is modified. If you do not specify this parameter, false is used by default.', + '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' => 'Specifies whether the request is a dry run.'."\n", + 'type' => 'boolean', + 'required' => false, + 'example' => 'true', + ], + ], + [ + 'name' => 'appGroupIdentity', + 'in' => 'path', + 'schema' => [ + 'description' => 'The name of the application.'."\n", + 'type' => 'string', + 'required' => true, + 'docRequired' => true, + 'example' => 'my_app_group_name', + ], + ], + [ + 'name' => 'appId', + 'in' => 'path', + 'schema' => [ + 'description' => 'The version number of the application.'."\n", + 'type' => 'integer', + 'format' => 'int32', + 'required' => true, + 'docRequired' => true, + 'example' => '110157886', + ], + ], + [ + 'name' => 'name', + 'in' => 'path', + 'schema' => [ + 'description' => 'The name of the rough sort expression'."\n", + 'type' => 'string', + 'required' => true, + 'docRequired' => true, + 'example' => 'test', + ], + ], + [ + 'name' => 'body', + 'in' => 'body', + 'schema' => [ + 'description' => 'The request body.'."\n", + 'required' => false, + '$ref' => '#/components/schemas/FirstRank', + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'type' => 'object', + 'properties' => [ + 'requestId' => [ + 'description' => 'The request ID.'."\n", + 'type' => 'string', + 'example' => '0A6EB64B-B4C8-CF02-810F-E660812972FF', + ], + 'result' => [ + 'description' => 'The information about the rough sort expression.'."\n", + 'type' => 'object', + 'properties' => [ + 'description' => [ + 'description' => 'The description of the rough sort expression.'."\n", + 'type' => 'string', + 'example' => '1', + ], + 'active' => [ + 'description' => 'Indicates whether the expression is the default one.'."\n", + 'type' => 'boolean', + 'example' => 'true', + ], + 'name' => [ + 'description' => 'The name of the expression.'."\n", + 'type' => 'string', + 'example' => 'default', + ], + 'meta' => [ + 'description' => 'The information about the expression.'."\n", + 'type' => 'array', + 'items' => [ + 'type' => 'object', + 'properties' => [ + 'arg' => [ + 'description' => 'The parameters that are used by a function in the expression.'."\n", + 'type' => 'string', + 'example' => '“1 ”', + ], + 'attribute' => [ + 'description' => 'The attribute, feature function, or field to be searched for.'."\n", + 'type' => 'string', + 'example' => 'static_bm25()', + ], + 'weight' => [ + 'description' => 'The weight. Valid values: -100000 to 100000. The value cannot be 0.'."\n", + 'type' => 'number', + 'format' => 'float', + 'example' => '10', + ], + ], + ], + ], + ], + ], + ], + 'description' => '', + ], + ], + '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":"<requestId>0A6EB64B-B4C8-CF02-810F-E660812972FF</requestId>\\n<result>\\n <name>ar_wear_edit_time</name>\\n <type>STRUCT</type>\\n <meta>\\n <attribute>timeliness_ms()</attribute>\\n <arg>ar_edit_time</arg>\\n <weight>1</weight>\\n </meta>\\n <description/>\\n <active>false</active>\\n <created>0</created>\\n <updated>0</updated>\\n</result>","errorExample":""}]', + 'title' => 'ModifyFirstRank', + 'requestParamsDescription' => '**Request body**'."\n" + ."\n" + .'|Field|Type|Required|Example|Description|'."\n" + .'|---|---|---|---|---|'."\n" + .'|type|String|Yes|"STRUCT"|The type of the expression.Valid values: STRUCT and STRING.A value of STRUCT indicates that the content of the expression is a structure. This is the default value. A value of STRING indicates that the content of the expression is a custom formula.|'."\n" + .'|meta|Array or string|Yes||The information about the expression.|'."\n" + .'|description|String|No|"my\\_test"|The description of the rough sort expression.|'."\n" + .'|active|Boolean|No|true|Specifies whether the expression is the default one.|'."\n" + ."\n" + .'For more information, see [FirstRank](~~170007~~).', + 'responseParamsDescription' => ' ', + 'extraInfo' => ' ', + ], + 'ListSecondRanks' => [ + 'summary' => 'Queries the fine sort expressions that are configured for a version of an OpenSearch application.', + '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' => 'The name of the application'."\n", + 'type' => 'string', + 'required' => true, + 'docRequired' => true, + 'example' => 'my_app_group_name', + ], + ], + [ + 'name' => 'appId', + 'in' => 'path', + 'schema' => [ + 'description' => 'The version number of the application.'."\n", + 'type' => 'integer', + 'format' => 'int32', + 'required' => true, + 'docRequired' => true, + 'example' => '110157886', + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'type' => 'object', + 'properties' => [ + 'totalCount' => [ + 'description' => 'The total number of entries returned.'."\n", + 'type' => 'integer', + 'format' => 'int32', + 'example' => '1', + ], + 'requestId' => [ + 'description' => 'The request ID.'."\n", + 'type' => 'string', + 'example' => '0A6EB64B-B4C8-CF02-810F-E660812972FF', + ], + 'result' => [ + 'description' => 'The information about the fine sort expression.'."\n" + ."\n" + .'For more information, see [SecondRank](~~170008~~).'."\n", + 'type' => 'array', + 'items' => [ + 'type' => 'object', + 'properties' => [ + 'created' => [ + 'description' => 'The time when the expression was created.'."\n", + 'type' => 'integer', + 'format' => 'int32', + 'example' => '0', + ], + 'active' => [ + 'description' => 'Indicates whether the expression is the default one.'."\n", + 'type' => 'boolean', + 'example' => 'false', + ], + 'isDefault' => [ + 'description' => 'Indicates whether the expression is the default one. This parameter is displayed only in the response. Valid values:'."\n" + ."\n" + .'* true: the expression is the default one.'."\n" + .'* false: the expression is not the default one.'."\n", + 'type' => 'string', + 'example' => 'false', + ], + 'isSys' => [ + 'description' => 'Indicates whether the expression is a system expression. This parameter is displayed only in the response. Valid values:'."\n" + ."\n" + .'* true: The expression is a system expression.'."\n" + .'* false:The expression is not a system expression'."\n", + 'type' => 'string', + 'example' => 'true', + ], + 'description' => [ + 'description' => 'Description'."\n", + 'type' => 'string', + 'example' => '""', + ], + 'updated' => [ + 'description' => 'The time when the expression was updated.'."\n", + 'type' => 'integer', + 'format' => 'int32', + 'example' => '1587052801', + ], + 'name' => [ + 'description' => 'Parameter'."\n", + 'type' => 'string', + 'example' => 'tests', + ], + 'meta' => [ + 'description' => 'The content of the fine sort expression. You can define an expression that consists of fields, feature functions, and mathematical functions to implement complex sort logic.'."\n", + 'type' => 'string', + 'example' => 'random()+now()', + ], + 'id' => [ + 'description' => 'The expression ID. This parameter is displayed only in the response.'."\n", + 'type' => 'string', + 'example' => '890473', + ], + ], + 'description' => '', + ], + ], + ], + 'description' => '', + ], + ], + '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":"<requestId>0A6EB64B-B4C8-CF02-810F-E660812972FF</requestId>\\n<result>\\n <name>default</name>\\n <meta/>\\n <active>false</active>\\n <description/>\\n <id>890473</id>\\n <created>0</created>\\n <updated>0</updated>\\n <isDefault>false</isDefault>\\n <isSys>true</isSys>\\n</result>\\n<result>\\n <name>tests</name>\\n <meta>random()+now()</meta>\\n <active>true</active>\\n <description/>\\n <id>890474</id>\\n <created>1587052801</created>\\n <updated>1587052801</updated>\\n <isDefault>true</isDefault>\\n <isSys>false</isSys>\\n</result>\\n<result>\\n <name>test</name>\\n <meta>query_term_count()</meta>\\n <active>false</active>\\n <description/>\\n <id>890475</id>\\n <created>1587052801</created>\\n <updated>1587052801</updated>\\n <isDefault>false</isDefault>\\n <isSys>false</isSys>\\n</result>\\n<totalCount>3</totalCount>","errorExample":""}]', + 'title' => 'ListSecondRanks', + 'requestParamsDescription' => ' ', + 'responseParamsDescription' => ' ', + 'extraInfo' => ' ', + ], + 'CreateSecondRank' => [ + 'summary' => 'Creates a fine sort expression for a version of an OpenSearch application. If you set dryRun to true, this operation checks the specified fine sort expression. The default value of dryRun is false if you do not set this parameter.', + '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' => 'The name of the application.'."\n", + 'type' => 'string', + 'required' => true, + 'docRequired' => true, + 'example' => 'my_app_group_name', + ], + ], + [ + 'name' => 'appId', + 'in' => 'path', + 'schema' => [ + 'description' => 'The version number of the application.'."\n", + 'type' => 'integer', + 'format' => 'int32', + 'required' => true, + 'docRequired' => true, + 'example' => '110157886', + ], + ], + [ + 'name' => 'dryRun', + 'in' => 'query', + 'schema' => [ + 'description' => 'Specifies whether to perform a dry run.'."\n", + 'type' => 'boolean', + 'required' => false, + 'example' => 'true', + ], + ], + [ + 'name' => 'body', + 'in' => 'body', + 'schema' => [ + 'description' => 'The request body. For more information, see [SecondRank](~~170008~~).'."\n", + 'required' => false, + '$ref' => '#/components/schemas/SecondRank', + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'type' => 'object', + 'properties' => [ + 'result' => [ + 'description' => 'The information about the fine sort expression.'."\n", + 'type' => 'object', + 'example' => '{}', + ], + 'RequestId' => [ + 'description' => 'The request ID.'."\n", + 'type' => 'string', + 'example' => 'ABCDEFGH', + ], + ], + 'description' => '', + ], + ], + '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":"<requestId>C5E2F73C-8241-81F8-3A62-65478C5A3111</requestId>\\n<result>\\n <id>89047</id>\\n <name>test_1</name>\\n <meta>text_relevance(title)</meta>\\n <active>true</active>\\n <description>123</description>\\n <created>1593679894</created>\\n <updated>1593679894</updated>\\n <isDefault>true</isDefault>\\n <isSys>false</isSys>\\n</result>","errorExample":""}]', + 'title' => 'CreateSecondRank', + 'requestParamsDescription' => '**Request body**'."\n" + ."\n" + .'|Parameter|Type|Required|Example|Description|'."\n" + .'|---|---|---|---|---|'."\n" + .'|name|String|No|"test"|The name of the expression.|'."\n" + .'|meta|String|No|"random()"|The content of the expression.|'."\n" + .'|description|String|No|"my\\_test"|The description of the expression.|'."\n" + .'|active|Boolean|No|true|Specifies whether the expression is the default one.|'."\n" + ."\n" + .'For more information, see [SecondRank](~~170008~~) '."\n" + .'.', + 'responseParamsDescription' => ' ', + 'extraInfo' => ' ', + ], + 'DescribeSecondRank' => [ + 'summary' => 'Queries a fine sort expression that is configured for a version of an OpenSearch application.', + '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' => 'The name of the application'."\n", + 'type' => 'string', + 'required' => true, + 'docRequired' => true, + 'example' => 'my_app_group_name', + ], + ], + [ + 'name' => 'appId', + 'in' => 'path', + 'schema' => [ + 'description' => 'The version number of the application.'."\n", + 'type' => 'integer', + 'format' => 'int32', + 'required' => true, + 'docRequired' => true, + 'example' => '110157886', + ], + ], + [ + 'name' => 'name', + 'in' => 'path', + 'schema' => [ + 'description' => 'The name of the fine sort expression'."\n", + 'type' => 'string', + 'required' => true, + 'docRequired' => true, + 'example' => 'test', + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'type' => 'object', + 'properties' => [ + 'requestId' => [ + 'description' => 'The request ID.'."\n", + 'type' => 'string', + 'example' => '0A6EB64B-B4C8-CF02-810F-E660812972FF', + ], + 'result' => [ + 'description' => 'The information about the fine sort expression.'."\n", + 'type' => 'object', + 'properties' => [ + 'created' => [ + 'description' => 'The time when the expression was created.'."\n", + 'type' => 'integer', + 'format' => 'int32', + 'example' => '1587052801', + ], + 'active' => [ + 'description' => 'Specifies whether to set the fine sort expression as the default sort expression.'."\n", + 'type' => 'boolean', + 'example' => 'true', + ], + 'isDefault' => [ + 'description' => 'Indicates whether the expression is the default one. This parameter appears only in the response. Valid values:'."\n" + ."\n" + .'* true'."\n" + .'* false'."\n", + 'type' => 'string', + 'example' => 'true', + ], + 'isSys' => [ + 'description' => 'Indicates whether the expression is a system expression. This parameter appears only in the response. Valid values:'."\n" + ."\n" + .'* true'."\n" + .'* false'."\n", + 'type' => 'string', + 'example' => 'false', + ], + 'description' => [ + 'description' => 'Description'."\n", + 'type' => 'string', + 'example' => '-', + ], + 'updated' => [ + 'description' => 'The time when the expression was updated.'."\n", + 'type' => 'integer', + 'format' => 'int32', + 'example' => '1587052801', + ], + 'name' => [ + 'description' => 'The name.'."\n", + 'type' => 'string', + 'example' => 'tests', + ], + 'meta' => [ + 'description' => 'The content of the fine sort expression. You can define an expression that consists of fields, feature functions, and mathematical functions to implement complex sort logic.'."\n", + 'type' => 'string', + 'example' => 'random()+now()', + ], + 'id' => [ + 'description' => 'The ID of the expression. This parameter appears only in the response.'."\n", + 'type' => 'string', + 'example' => '89047', + ], + ], + ], + ], + 'description' => '', + ], + ], + '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":"<requestId>0A6EB64B-B4C8-CF02-810F-E660812972FF</requestId>\\n<result>\\n <id>89047</id>\\n <name>tests</name>\\n <meta>random()+now()</meta>\\n <active>true</active>\\n <description/>\\n <created>1587052801</created>\\n <updated>1587052801</updated>\\n <isDefault>true</isDefault>\\n <isSys>false</isSys>\\n</result>","errorExample":""}]', + 'title' => 'DescribeSecondRank', + 'requestParamsDescription' => ' ', + 'responseParamsDescription' => ' ', + 'extraInfo' => ' ', + ], + 'ModifySecondRank' => [ + 'summary' => 'Modifies a fine sort expression that is configured for a specific OpenSearch application version. If you set dryRun to true, the specified fine sort expression is checked after the expression is modified. By default, the value of dryRun is false if you do not specify this parameter.', + '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' => 'The application name.'."\n", + 'type' => 'string', + 'required' => true, + 'docRequired' => true, + 'example' => '“my_app_group_name”', + ], + ], + [ + 'name' => 'appId', + 'in' => 'path', + 'schema' => [ + 'description' => 'The version number of the application.'."\n", + 'type' => 'integer', + 'format' => 'int32', + 'required' => true, + 'docRequired' => true, + 'example' => '110157886', + ], + ], + [ + 'name' => 'name', + 'in' => 'path', + 'schema' => [ + 'description' => 'The name of the fine sort expression.'."\n", + 'type' => 'string', + 'required' => true, + 'docRequired' => true, + 'example' => 'true', + ], + ], + [ + 'name' => 'dryRun', + 'in' => 'query', + 'schema' => [ + 'description' => 'Specifies whether the request is a dry run.'."\n", + 'type' => 'boolean', + 'required' => false, + 'example' => 'true', + ], + ], + [ + 'name' => 'body', + 'in' => 'body', + 'schema' => [ + 'description' => 'The request parameters.'."\n", + 'required' => false, + '$ref' => '#/components/schemas/SecondRank', + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'description' => 'The response parameters.'."\n", + 'type' => 'object', + 'properties' => [ + 'requestId' => [ + 'description' => 'The request ID.'."\n", + 'type' => 'string', + 'example' => 'C5E2F73C-8241-81F8-3A62-65478C5A3111', + ], + 'result' => [ + 'description' => 'The information about the fine sort expression.'."\n", + 'type' => 'object', + 'properties' => [ + 'created' => [ + 'description' => 'The time when the expression was created.'."\n", + 'type' => 'integer', + 'format' => 'int32', + 'example' => '1', + ], + 'active' => [ + 'description' => 'Indicates whether the expression is the default one.'."\n", + 'type' => 'boolean', + 'example' => 'true', + ], + 'isDefault' => [ + 'description' => 'Indicates whether the expression is the default one. This parameter is displayed only in the response. Valid values:'."\n" + ."\n" + .'* true: the expression is the default one.'."\n" + .'* false: the expression is not the default one.'."\n", + 'type' => 'string', + 'example' => 'true', + ], + 'isSys' => [ + 'description' => 'Indicates whether the expression is a system expression. This parameter is displayed only in the response. Valid values:'."\n" + ."\n" + .'* true: The expression is a system expression.'."\n" + .'* false:The expression is not a system expression'."\n", + 'type' => 'string', + 'example' => 'false', + ], + 'description' => [ + 'description' => 'The description of the expression.'."\n", + 'type' => 'string', + 'example' => '"11"', + ], + 'updated' => [ + 'description' => 'The time when the expression was updated.'."\n", + 'type' => 'integer', + 'format' => 'int32', + 'example' => '1', + ], + 'name' => [ + 'description' => 'The expression name.'."\n", + 'type' => 'string', + 'example' => 'lsh_second_1', + ], + 'meta' => [ + 'description' => 'The content of the fine sort expression. You can define an expression that consists of fields, feature functions, and mathematical functions to implement complex sort logic.'."\n", + 'type' => 'string', + 'example' => 'cate_id > 0 and cate_id < 1000', + ], + 'id' => [ + 'description' => 'The expression ID. This parameter is displayed only in the response.'."\n", + '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":"<requestId>C5E2F73C-8241-81F8-3A62-65478C5A3111</requestId>\\n<result>\\n <id>890473</id>\\n <name>name_relevance</name>\\n <meta>text_relevance(name)</meta>\\n <active>true</active>\\n <description>123</description>\\n <created>1593679894</created>\\n <updated>1593679894</updated>\\n <isDefault>true</isDefault>\\n <isSys>false</isSys>\\n</result>","errorExample":""}]', + 'title' => 'ModifySecondRank', + 'requestParamsDescription' => '**Request body**'."\n" + ."\n" + .'|Parameter|Type|Required|Example|Description|'."\n" + .'|---|---|---|---|---|'."\n" + .'|meta|String|No|"text\\_relevance(name)"|The content of the expression.|'."\n" + .'|description|String|No|"my\\_test"|The description of the expression.|'."\n" + .'|active|Boolean|No|true|Indicates whether the expression is the default one.|', + 'responseParamsDescription' => ' ', + 'extraInfo' => ' ', + ], + 'RemoveSecondRank' => [ + 'summary' => 'Deletes a fine sort expression from a version of an OpenSearch application.', + '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' => 'The name of the application'."\n", + 'type' => 'string', + 'required' => true, + 'docRequired' => true, + 'example' => '“my_app_group_name”', + ], + ], + [ + 'name' => 'appId', + 'in' => 'path', + 'schema' => [ + 'description' => 'The version number'."\n", + 'type' => 'integer', + 'format' => 'int32', + 'required' => true, + 'docRequired' => true, + 'example' => '110157886', + ], + ], + [ + 'name' => 'name', + 'in' => 'path', + 'schema' => [ + 'description' => 'The name of the fine sort expression.'."\n", + 'type' => 'string', + 'required' => true, + 'docRequired' => true, + 'example' => '“tests”', + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'type' => 'object', + 'properties' => [ + 'result' => [ + 'description' => 'The returned results.', + 'type' => 'object', + 'example' => '{}', + ], + 'requestId' => [ + 'description' => 'The request ID.'."\n", + 'type' => 'string', + 'example' => '0A6EB64B-B4C8-CF02-810F-E660812972FF', + ], + ], + 'description' => '', + ], + ], + '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":"<requestId>0A6EB64B-B4C8-CF02-810F-E660812972FF</requestId>","errorExample":""}]', + 'title' => 'RemoveSecondRank', + 'requestParamsDescription' => ' ', + 'responseParamsDescription' => ' ', + 'extraInfo' => ' ', + ], + 'ListQueryProcessors' => [ + 'summary' => 'Queries a list of query analysis rules that are configured for a version of an OpenSearch application.', + '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' => 'The application name.'."\n", + 'type' => 'string', + 'required' => true, + 'docRequired' => true, + 'example' => 'my_app_group_name', + ], + ], + [ + 'name' => 'appId', + 'in' => 'path', + 'schema' => [ + 'description' => 'The application version number.'."\n", + 'type' => 'integer', + 'format' => 'int32', + 'required' => true, + 'docRequired' => true, + 'example' => '110157886', + ], + ], + [ + 'name' => 'isActive', + 'in' => 'query', + 'schema' => [ + 'description' => 'The scope of query analysis rules to be queried. Default value: 0. Valid values:'."\n" + ."\n" + .'* 0: queries all query analysis rules.'."\n" + .'* 1: queries the default query analysis rules.'."\n" + .'* 2: queries the query analysis rules that are not the default rules.'."\n", + 'type' => 'integer', + 'format' => 'int32', + 'required' => false, + 'example' => '0', + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'type' => 'object', + 'properties' => [ + 'requestId' => [ + 'description' => 'The request ID.'."\n", + 'type' => 'string', + 'example' => '0A6EB64B-B4C8-CF02-810F-E660812972FF', + ], + 'result' => [ + 'description' => 'The information about the query analysis rule.'."\n" + ."\n" + .'For more information, see [QueryProcessor](~~170014~~).'."\n", + 'type' => 'array', + 'items' => [ + 'description' => '', + 'type' => 'object', + 'properties' => [ + 'created' => [ + 'description' => 'The time when the query analysis rule was created.'."\n", + 'type' => 'integer', + 'format' => 'int32', + 'example' => '1587398402', + ], + 'active' => [ + 'description' => 'Indicates whether the query analysis rule is a default rule.'."\n", + 'type' => 'boolean', + 'example' => 'true', + ], + 'updated' => [ + 'description' => 'The time when the query analysis rule was last modified.'."\n", + 'type' => 'integer', + 'format' => 'int32', + 'example' => '1587398402', + ], + 'name' => [ + 'description' => 'The name of the query analysis rule.'."\n", + 'type' => 'string', + 'example' => 'ner', + ], + 'domain' => [ + 'description' => 'The type of the industry to which the query analysis rule is applied. Valid values:'."\n" + ."\n" + .'* GENERAL'."\n" + .'* ECOMMERCE'."\n" + .'* IT_CONTENT'."\n", + 'type' => 'string', + 'example' => 'GENERAL', + ], + 'indexes' => [ + 'description' => 'The indexes to which the query analysis rule is applied.'."\n", + 'type' => 'array', + 'items' => [ + 'description' => 'The indexes to which the query analysis rule is applied.'."\n", + 'type' => 'string', + 'example' => '[ "default" ]', + ], + ], + 'processors' => [ + 'description' => 'The features that are used in the query analysis rule.'."\n", + 'type' => 'array', + 'items' => [ + 'description' => 'The feature that is used in the query analysis rule.'."\n" + ."\n" + .'For more information, see [Processor](~~170014~~).'."\n", + 'type' => 'object', + 'example' => '[]', + ], + ], + ], + ], + ], + ], + 'description' => '', + ], + ], + '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":"<requestId>0A6EB64B-B4C8-CF02-810F-E660812972FF</requestId>\\n<result>\\n <name>test</name>\\n <active>true</active>\\n <indexes>default</indexes>\\n <processors>\\n <useSystemDictionary>true</useSystemDictionary>\\n <name>ner</name>\\n <interventionDictionary/>\\n <priorities>\\n <tag>brand</tag>\\n <priority>HIGH</priority>\\n </priorities>\\n <priorities>\\n <tag>category</tag>\\n <priority>HIGH</priority>\\n </priorities>\\n <priorities>\\n <tag>material</tag>\\n <priority>MIDDLE</priority>\\n </priorities>\\n <priorities>\\n <tag>element</tag>\\n <priority>MIDDLE</priority>\\n </priorities>\\n <priorities>\\n <tag>style</tag>\\n <priority>MIDDLE</priority>\\n </priorities>\\n <priorities>\\n <tag>color</tag>\\n <priority>MIDDLE</priority>\\n </priorities>\\n <priorities>\\n <tag>function</tag>\\n <priority>MIDDLE</priority>\\n </priorities>\\n <priorities>\\n <tag>scenario</tag>\\n <priority>MIDDLE</priority>\\n </priorities>\\n <priorities>\\n <tag>people</tag>\\n <priority>MIDDLE</priority>\\n </priorities>\\n <priorities>\\n <tag>season</tag>\\n <priority>MIDDLE</priority>\\n </priorities>\\n <priorities>\\n <tag>model</tag>\\n <priority>MIDDLE</priority>\\n </priorities>\\n <priorities>\\n <tag>region</tag>\\n <priority>MIDDLE</priority>\\n </priorities>\\n <priorities>\\n <tag>name</tag>\\n <priority>MIDDLE</priority>\\n </priorities>\\n <priorities>\\n <tag>adjective</tag>\\n <priority>MIDDLE</priority>\\n </priorities>\\n <priorities>\\n <tag>category-modifier</tag>\\n <priority>MIDDLE</priority>\\n </priorities>\\n <priorities>\\n <tag>size</tag>\\n <priority>LOW</priority>\\n </priorities>\\n <priorities>\\n <tag>quality</tag>\\n <priority>LOW</priority>\\n </priorities>\\n <priorities>\\n <tag>suit</tag>\\n <priority>LOW</priority>\\n </priorities>\\n <priorities>\\n <tag>new-release</tag>\\n <priority>LOW</priority>\\n </priorities>\\n <priorities>\\n <tag>series</tag>\\n <priority>LOW</priority>\\n </priorities>\\n <priorities>\\n <tag>marketing</tag>\\n <priority>LOW</priority>\\n </priorities>\\n <priorities>\\n <tag>entertainment</tag>\\n <priority>LOW</priority>\\n </priorities>\\n <priorities>\\n <tag>organization</tag>\\n <priority>LOW</priority>\\n </priorities>\\n <priorities>\\n <tag>movie</tag>\\n <priority>LOW</priority>\\n </priorities>\\n <priorities>\\n <tag>game</tag>\\n <priority>LOW</priority>\\n </priorities>\\n <priorities>\\n <tag>number</tag>\\n <priority>LOW</priority>\\n </priorities>\\n <priorities>\\n <tag>unit</tag>\\n <priority>LOW</priority>\\n </priorities>\\n <priorities>\\n <tag>common</tag>\\n <priority>LOW</priority>\\n </priorities>\\n <priorities>\\n <tag>new-word</tag>\\n <priority>LOW</priority>\\n </priorities>\\n <priorities>\\n <tag>proper-noun</tag>\\n <priority>LOW</priority>\\n </priorities>\\n <priorities>\\n <tag>symbol</tag>\\n <priority>LOW</priority>\\n </priorities>\\n <priorities>\\n <tag>prefix</tag>\\n <priority>LOW</priority>\\n </priorities>\\n <priorities>\\n <tag>suffix</tag>\\n <priority>LOW</priority>\\n </priorities>\\n <priorities>\\n <tag>gift</tag>\\n <priority>LOW</priority>\\n </priorities>\\n <priorities>\\n <tag>negative</tag>\\n <priority>LOW</priority>\\n </priorities>\\n <priorities>\\n <tag>agent</tag>\\n <priority>LOW</priority>\\n </priorities>\\n </processors>\\n <processors>\\n <useSystemDictionary>true</useSystemDictionary>\\n <name>synonym</name>\\n <interventionDictionary/>\\n </processors>\\n <processors>\\n <useSystemDictionary>true</useSystemDictionary>\\n <name>term_weighting</name>\\n <interventionDictionary/>\\n </processors>\\n <processors>\\n <useSystemDictionary>true</useSystemDictionary>\\n <name>spell_check</name>\\n <interventionDictionary/>\\n </processors>\\n <processors>\\n <name>category_prediction</name>\\n <categoryPrediction>60</categoryPrediction>\\n <projectId>848</projectId>\\n </processors>\\n <domain>GENERAL</domain>\\n <created>1587398402</created>\\n <updated>1587398402</updated>\\n</result>","errorExample":""}]', + 'title' => 'ListQueryProcessors', + 'requestParamsDescription' => ' ', + 'responseParamsDescription' => ' ', + 'extraInfo' => ' ', + ], + 'CreateQueryProcessor' => [ + 'summary' => 'Creates a query analysis rule. If you set dryRun to true, this operation checks the specified query analysis rule. By default, the value of dryRun is false if you do not set this parameter.', + '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' => 'The name of the application.'."\n", + 'type' => 'string', + 'required' => true, + 'docRequired' => true, + 'example' => 'my_app_group_name', + ], + ], + [ + 'name' => 'appId', + 'in' => 'path', + 'schema' => [ + 'description' => 'The version number of the application.'."\n", + 'type' => 'integer', + 'format' => 'int32', + 'required' => true, + 'docRequired' => true, + 'example' => '110157886', + ], + ], + [ + 'name' => 'dryRun', + 'in' => 'query', + 'schema' => [ + 'description' => 'Specifies whether to perform a dry run.'."\n", + 'type' => 'boolean', + 'required' => false, + 'example' => 'true', + ], + ], + [ + 'name' => 'body', + 'in' => 'body', + 'schema' => [ + 'description' => 'The request body.'."\n", + 'type' => 'any', + 'required' => false, + 'example' => '{}', + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'type' => 'object', + 'properties' => [ + 'requestId' => [ + 'description' => 'The request ID.'."\n", + 'type' => 'string', + 'example' => '0A6EB64B-B4C8-CF02-810F-E660812972FF', + ], + 'result' => [ + 'description' => 'The information about the query analysis rule.'."\n", + 'type' => 'object', + 'properties' => [ + 'created' => [ + 'description' => 'The time when the query analysis rule was created.'."\n", + 'type' => 'integer', + 'format' => 'int32', + 'example' => '1587398402', + ], + 'active' => [ + 'description' => 'Indicates whether the query analysis rule is the default one.'."\n", + 'type' => 'boolean', + 'example' => 'true', + ], + 'updated' => [ + 'description' => 'The time when the query analysis rule was last modified.'."\n", + 'type' => 'integer', + 'format' => 'int32', + 'example' => '1587398402', + ], + 'name' => [ + 'description' => 'The name of the query analysis rule.'."\n", + 'type' => 'string', + 'example' => 'query_filter', + ], + 'domain' => [ + 'description' => 'The type of the industry to which the query analysis rule was applied. Valid values:'."\n" + ."\n" + .'* GENERAL: general.'."\n" + .'* ECOMMERCE: e-commerce.'."\n" + .'* IT_CONTENT: IT content.'."\n", + 'type' => 'string', + 'example' => 'GENERAL', + ], + 'indexes' => [ + 'description' => 'The indexes to which the query analysis rule was applied.'."\n", + 'type' => 'array', + 'items' => [ + 'description' => 'The indexes to which the query analysis rule was applied.'."\n", + 'type' => 'string', + 'example' => '"default"', + ], + ], + 'processors' => [ + 'description' => 'The features that are used in the query analysis rule.'."\n" + ."\n" + .'For more information, see [QueryProcessor](~~170014~~).'."\n", + 'type' => 'array', + 'items' => [ + 'description' => 'The features that are used in the query analysis rule.'."\n", + 'type' => 'object', + 'example' => '{}', + ], + ], + ], + ], + ], + 'description' => '', + ], + ], + '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":"<requestId>0A6EB64B-B4C8-CF02-810F-E660812972FF</requestId>\\n<result>\\n <name>query_filter</name>\\n <active>true</active>\\n <indexes>default</indexes>\\n <processors>\\n <name>synonym</name>\\n <useSystemDictionary>true</useSystemDictionary>\\n </processors>\\n <processors>\\n <name>stop_word</name>\\n <useSystemDictionary>true</useSystemDictionary>\\n <interventionDictionary>980</interventionDictionary>\\n </processors>\\n <domain>GENERAL</domain>\\n <created>1587398402</created>\\n <updated>1587398402</updated>\\n</result>","errorExample":""}]', + 'title' => 'CreateQueryProcessor', + 'requestParamsDescription' => '**Request body**'."\n" + ."\n" + .'|Parameter|Type|Required|Example|Description|'."\n" + .'|---|---|---|---|---|'."\n" + .'|name|String|Yes|"test"|The name of the query analysis rule.|'."\n" + .'|processors\\[\\]|Object|Yes|N/A|The query analysis rule.For more information, see [QueryProcessor](~~170014~~).|'."\n" + .'|domain|String|No|"GENERAL"|The type of the industry to which the query analysis rule applies. Valid values:GENERAL: general.ECOMMERCE: e-commerce.IT\\_CONTENT: IT content.|'."\n" + .'|indexes|Array|No|\\["default"\\]|The indexes to which the query analysis rule applies.|'."\n" + .'|active|Boolean|No|true|Specifies whether to enable the query analysis rule.|'."\n" + ."\n\n" + .'For more information, see [QueryProcessor](~~170014~~).', + 'responseParamsDescription' => ' ', + 'extraInfo' => ' ', + ], + 'ModifyQueryProcessor' => [ + 'summary' => 'Modifies a query analysis rule for a specific application version. If you set dryRun to true, this operation checks the specified query analysis rule. By default, the value of dryRun is false if you do not specify this parameter.', + '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' => 'The application name.'."\n", + 'type' => 'string', + 'required' => true, + 'docRequired' => true, + 'example' => '“my_app_group_name”', + ], + ], + [ + 'name' => 'appId', + 'in' => 'path', + 'schema' => [ + 'description' => 'The version number of the application.'."\n", + 'type' => 'integer', + 'format' => 'int32', + 'required' => true, + 'docRequired' => true, + 'example' => '110157886', + ], + ], + [ + 'name' => 'dryRun', + 'in' => 'query', + 'schema' => [ + 'description' => 'Specifies whether the request is a dry run.'."\n", + 'type' => 'boolean', + 'required' => false, + 'example' => 'true', + ], + ], + [ + 'name' => 'name', + 'in' => 'path', + 'schema' => [ + 'description' => 'The name of the query analysis rule'."\n", + 'type' => 'string', + 'required' => true, + 'docRequired' => true, + 'example' => '“test”', + ], + ], + [ + 'name' => 'body', + 'in' => 'body', + 'schema' => [ + 'description' => 'The request parameters.'."\n", + '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' => 'The response parameters.'."\n", + 'type' => 'object', + 'properties' => [ + 'requestId' => [ + 'description' => 'The request ID.'."\n", + 'type' => 'string', + 'example' => 'D77D0DAF-790D-F5F5-A9C0-133738165014', + ], + 'result' => [ + 'description' => 'The information about the query analysis rule.'."\n", + 'type' => 'object', + 'properties' => [ + 'created' => [ + 'description' => 'The time when the rule was created.'."\n", + 'type' => 'integer', + 'format' => 'int32', + 'example' => '0', + ], + 'active' => [ + 'description' => 'Indicates whether the query analysis rule is a default rule.'."\n", + 'type' => 'boolean', + 'example' => 'true', + ], + 'updated' => [ + 'description' => 'The time when the rule was updated.'."\n", + 'type' => 'integer', + 'format' => 'int32', + 'example' => '1', + ], + 'name' => [ + 'description' => 'The name of the query analysis rule.'."\n", + 'type' => 'string', + 'example' => 'synonym', + ], + 'domain' => [ + 'description' => 'The type of the industry to which the query analysis rule is applied. Valid values:'."\n" + ."\n" + .'* GENERAL'."\n" + .'* ECOMMERCE'."\n" + .'* IT_CONTENT'."\n", + 'type' => 'string', + 'example' => 'GENERAL', + ], + 'indexes' => [ + 'description' => 'The indexes to which the query analysis rule is applied.'."\n", + 'type' => 'array', + 'items' => [ + 'description' => 'The indexes to which the query analysis rule is applied.'."\n", + 'type' => 'string', + 'example' => '[ "default" ]', + ], + 'example' => '["default"]', + ], + 'processors' => [ + 'description' => 'The analysis rule.'."\n", + 'type' => 'array', + 'items' => [ + 'description' => 'The response parameters.'."\n", + '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":"<requestId>0A6EB64B-B4C8-CF02-810F-E660812972FF</requestId>\\n<result>\\n <name>query_filter</name>\\n <active>true</active>\\n <indexes>default</indexes>\\n <processors>\\n <name>synonym</name>\\n <useSystemDictionary>true</useSystemDictionary>\\n </processors>\\n <processors>\\n <name>stop_word</name>\\n <useSystemDictionary>true</useSystemDictionary>\\n </processors>\\n <domain>GENERAL</domain>\\n <created>1587398402</created>\\n <updated>1587398402</updated>\\n</result>","errorExample":""}]', + 'title' => 'ModifyQueryProcessor', + 'requestParamsDescription' => '**Request body**'."\n" + ."\n" + .'|Parameter|Type|Required|Example|Description|'."\n" + .'|---|---|---|---|---|'."\n" + .'|domain|String|No|"GENERAL"|The type of the industry to which the query analysis rule applies. Valid values:GENERAL: General industryECOMMERCE: E-commerceIT\\_CONTENT: IT industry|'."\n" + .'|indexes|Array|No|\\["default"\\]|The indexes to which the query analysis rule applies.|'."\n" + .'|processors\\[\\]|Object|No||The query analysis rule.For more information, see [Processor](~~170014~~).|'."\n" + .'|active|Boolean|No|true|Specifies whether to enable the query analysis rule.|'."\n" + ."\n" + .'For more information, see [QueryProcessor](~~170014~~).', + 'responseParamsDescription' => '**Response parameters**'."\n" + ."\n" + .'|Parameter|Type|Description|'."\n" + .'|---|---|---|'."\n" + .'|requestId|String|The request ID.|'."\n" + .'|result|Object|The information about the rule.For more information, see [QueryProcessor](~~170014~~).|', + 'extraInfo' => "\n", + ], + 'RemoveQueryProcessor' => [ + 'summary' => 'Deletes a query analysis rule for an OpenSearch application version.', + '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' => 'The name of the application'."\n", + 'type' => 'string', + 'required' => true, + 'docRequired' => true, + 'example' => '“my_app_group_name”', + ], + ], + [ + 'name' => 'appId', + 'in' => 'path', + 'schema' => [ + 'description' => 'The version number'."\n", + 'type' => 'integer', + 'format' => 'int32', + 'required' => true, + 'docRequired' => true, + 'example' => '110157886', + ], + ], + [ + 'name' => 'name', + 'in' => 'path', + 'schema' => [ + 'description' => 'The name of the query analysis rule.'."\n", + 'type' => 'string', + 'required' => true, + 'docRequired' => true, + 'example' => '“test”', + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'type' => 'object', + 'properties' => [ + 'result' => [ + 'description' => '\\--'."\n", + 'type' => 'string', + 'example' => '[]', + ], + 'requestId' => [ + 'description' => 'The request ID.'."\n", + 'type' => 'string', + 'example' => '0A6EB64B-B4C8-CF02-810F-E660812972FF', + ], + ], + 'description' => '', + ], + ], + '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":"<requestId>0A6EB64B-B4C8-CF02-810F-E660812972FF</requestId>","errorExample":""}]', + 'title' => 'RemoveQueryProcessor', + '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' => 'my_app_group_name'."\n", + 'type' => 'string', + 'required' => true, + 'docRequired' => true, + 'example' => 'my_app_group_name', + ], + ], + [ + 'name' => 'appId', + 'in' => 'path', + 'schema' => [ + 'description' => '110157886'."\n", + 'type' => 'integer', + 'format' => 'int32', + 'required' => true, + 'docRequired' => true, + 'example' => '110157886', + ], + ], + [ + 'name' => 'name', + 'in' => 'path', + 'schema' => [ + 'description' => 'test'."\n", + 'type' => 'string', + 'required' => true, + 'docRequired' => true, + 'example' => 'test', + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'type' => 'object', + 'properties' => [ + 'requestId' => [ + 'description' => 'The ID of the request.'."\n", + 'type' => 'string', + 'example' => '0A6EB64B-B4C8-CF02-810F-E660812972FF', + ], + 'result' => [ + 'description' => 'The information about the query analysis rule.'."\n", + 'type' => 'object', + 'properties' => [ + 'created' => [ + 'description' => 'The time when the query analysis rule was created.'."\n", + 'type' => 'integer', + 'format' => 'int32', + 'example' => '1587398402', + ], + 'active' => [ + 'description' => 'Indicates whether the query analysis rule is the default one.'."\n", + 'type' => 'boolean', + 'example' => 'true', + ], + 'updated' => [ + 'description' => 'The time when the query analysis rule was last updated.'."\n", + 'type' => 'integer', + 'format' => 'int32', + 'example' => '1587398402', + ], + 'name' => [ + 'description' => 'The name of the query analysis rule.'."\n", + 'type' => 'string', + 'example' => 'test', + ], + 'domain' => [ + 'description' => 'The type of the industry. Valid values:'."\n" + ."\n" + .'* GENERAL'."\n" + .'* ECOMMERCE'."\n" + .'* IT_CONTENT'."\n", + 'type' => 'string', + 'example' => 'GENERAL', + ], + 'indexes' => [ + 'type' => 'array', + 'items' => [ + 'description' => '', + 'type' => 'string', + 'example' => 'default', + ], + 'description' => 'The indexes to which the query analysis rule applies.'."\n", + ], + 'processors' => [ + 'type' => 'array', + 'items' => [ + 'description' => '', + 'type' => 'object', + 'example' => '{}', + ], + 'description' => 'The features that are used in the query analysis rule.'."\n", + ], + ], + ], + ], + ], + ], + '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":"<requestId>0A6EB64B-B4C8-CF02-810F-E660812972FF</requestId>\\n<result>\\n <name>test</name>\\n <active>true</active>\\n <indexes>default</indexes>\\n <processors>\\n <useSystemDictionary>true</useSystemDictionary>\\n <name>ner</name>\\n <interventionDictionary/>\\n <priorities>\\n <tag>brand</tag>\\n <priority>HIGH</priority>\\n </priorities>\\n <priorities>\\n <tag>category</tag>\\n <priority>HIGH</priority>\\n </priorities>\\n <priorities>\\n <tag>material</tag>\\n <priority>MIDDLE</priority>\\n </priorities>\\n <priorities>\\n <tag>element</tag>\\n <priority>MIDDLE</priority>\\n </priorities>\\n <priorities>\\n <tag>style</tag>\\n <priority>MIDDLE</priority>\\n </priorities>\\n <priorities>\\n <tag>color</tag>\\n <priority>MIDDLE</priority>\\n </priorities>\\n <priorities>\\n <tag>function</tag>\\n <priority>MIDDLE</priority>\\n </priorities>\\n <priorities>\\n <tag>scenario</tag>\\n <priority>MIDDLE</priority>\\n </priorities>\\n <priorities>\\n <tag>people</tag>\\n <priority>MIDDLE</priority>\\n </priorities>\\n <priorities>\\n <tag>season</tag>\\n <priority>MIDDLE</priority>\\n </priorities>\\n <priorities>\\n <tag>model</tag>\\n <priority>MIDDLE</priority>\\n </priorities>\\n <priorities>\\n <tag>region</tag>\\n <priority>MIDDLE</priority>\\n </priorities>\\n <priorities>\\n <tag>name</tag>\\n <priority>MIDDLE</priority>\\n </priorities>\\n <priorities>\\n <tag>adjective</tag>\\n <priority>MIDDLE</priority>\\n </priorities>\\n <priorities>\\n <tag>category-modifier</tag>\\n <priority>MIDDLE</priority>\\n </priorities>\\n <priorities>\\n <tag>size</tag>\\n <priority>LOW</priority>\\n </priorities>\\n <priorities>\\n <tag>quality</tag>\\n <priority>LOW</priority>\\n </priorities>\\n <priorities>\\n <tag>suit</tag>\\n <priority>LOW</priority>\\n </priorities>\\n <priorities>\\n <tag>new-release</tag>\\n <priority>LOW</priority>\\n </priorities>\\n <priorities>\\n <tag>series</tag>\\n <priority>LOW</priority>\\n </priorities>\\n <priorities>\\n <tag>marketing</tag>\\n <priority>LOW</priority>\\n </priorities>\\n <priorities>\\n <tag>entertainment</tag>\\n <priority>LOW</priority>\\n </priorities>\\n <priorities>\\n <tag>organization</tag>\\n <priority>LOW</priority>\\n </priorities>\\n <priorities>\\n <tag>movie</tag>\\n <priority>LOW</priority>\\n </priorities>\\n <priorities>\\n <tag>game</tag>\\n <priority>LOW</priority>\\n </priorities>\\n <priorities>\\n <tag>number</tag>\\n <priority>LOW</priority>\\n </priorities>\\n <priorities>\\n <tag>unit</tag>\\n <priority>LOW</priority>\\n </priorities>\\n <priorities>\\n <tag>common</tag>\\n <priority>LOW</priority>\\n </priorities>\\n <priorities>\\n <tag>new-word</tag>\\n <priority>LOW</priority>\\n </priorities>\\n <priorities>\\n <tag>proper-noun</tag>\\n <priority>LOW</priority>\\n </priorities>\\n <priorities>\\n <tag>symbol</tag>\\n <priority>LOW</priority>\\n </priorities>\\n <priorities>\\n <tag>prefix</tag>\\n <priority>LOW</priority>\\n </priorities>\\n <priorities>\\n <tag>suffix</tag>\\n <priority>LOW</priority>\\n </priorities>\\n <priorities>\\n <tag>gift</tag>\\n <priority>LOW</priority>\\n </priorities>\\n <priorities>\\n <tag>negative</tag>\\n <priority>LOW</priority>\\n </priorities>\\n <priorities>\\n <tag>agent</tag>\\n <priority>LOW</priority>\\n </priorities>\\n </processors>\\n <processors>\\n <useSystemDictionary>true</useSystemDictionary>\\n <name>synonym</name>\\n <interventionDictionary/>\\n </processors>\\n <processors>\\n <use_system_dictionary>true</use_system_dictionary>\\n <name>term_weighting</name>\\n <interventionDictionary/>\\n </processors>\\n <processors>\\n <use_system_dictionary>true</use_system_dictionary>\\n <name>spell_check</name>\\n <interventionDictionary/>\\n </processors>\\n <processors>\\n <name>category_prediction</name>\\n <categoryPrediction>60</categoryPrediction>\\n <projectId>848</projectId>\\n </processors>\\n <domain>GENERAL</domain>\\n <created>1587398402</created>\\n <updated>1587398402</updated>\\n</result>","errorExample":""}]', + 'title' => 'DescribeQueryProcessor', + 'summary' => 'Queries the query analysis rule for a version of an OpenSearch application.', + 'requestParamsDescription' => ' ', + 'responseParamsDescription' => ' ', + 'extraInfo' => ' ', + ], + 'ListQueryProcessorNers' => [ + 'summary' => 'Queries the recommended priority settings of entity types for named entity recognition (NER).', + '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' => 'The type of the industry.'."\n" + ."\n" + .'* ECOMMERCE'."\n", + 'type' => 'string', + 'required' => false, + 'docRequired' => true, + 'example' => 'ECOMMERCE', + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'type' => 'object', + 'properties' => [ + 'requestId' => [ + 'description' => 'The request ID.'."\n", + 'type' => 'string', + 'example' => '0A6EB64B-B4C8-CF02-810F-E660812972FF', + ], + 'result' => [ + 'description' => 'The priority settings of entity types.'."\n" + ."\n" + .'For more information, see [Priority settings of entity types](~~173616~~).'."\n", + 'type' => 'array', + 'items' => [ + 'type' => 'object', + 'properties' => [ + 'tag' => [ + 'description' => 'The internal name of the entity type.'."\n", + 'type' => 'string', + 'example' => 'brand', + ], + 'order' => [ + 'description' => 'The priority of an entity type among entity types that have the same priority level. A smaller value indicates a higher priority. Default value: 0.'."\n", + 'type' => 'integer', + 'format' => 'int32', + 'example' => '1', + ], + 'priority' => [ + 'description' => 'The priority level of the entity type. Valid values:'."\n" + ."\n" + .'* HIGH'."\n" + .'* MIDDLE'."\n" + .'* LOW'."\n", + 'type' => 'string', + 'example' => 'HIGH', + ], + 'label' => [ + 'description' => 'The name of the entity type.'."\n", + 'type' => 'string', + 'example' => 'brand', + ], + ], + 'description' => 'The result'."\n", + ], + ], + ], + 'description' => '', + ], + ], + '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":"<requestId>0A6EB64B-B4C8-CF02-810F-E660812972FF</requestId>\\n<result>\\n <tag>brand</tag>\\n <priority>HIGH</priority>\\n <order>1</order>\\n <label>品牌</label>\\n</result>\\n<result>\\n <tag>category</tag>\\n <priority>HIGH</priority>\\n <order>2</order>\\n <label>品类</label>\\n</result>\\n<result>\\n <tag>material</tag>\\n <priority>MIDDLE</priority>\\n <order>3</order>\\n <label>材质</label>\\n</result>\\n<result>\\n <tag>element</tag>\\n <priority>MIDDLE</priority>\\n <order>4</order>\\n <label>款式元素</label>\\n</result>\\n<result>\\n <tag>style</tag>\\n <priority>MIDDLE</priority>\\n <order>5</order>\\n <label>风格</label>\\n</result>\\n<result>\\n <tag>color</tag>\\n <priority>MIDDLE</priority>\\n <order>6</order>\\n <label>颜色</label>\\n</result>\\n<result>\\n <tag>function</tag>\\n <priority>MIDDLE</priority>\\n <order>7</order>\\n <label>功能功效</label>\\n</result>\\n<result>\\n <tag>scenario</tag>\\n <priority>MIDDLE</priority>\\n <order>8</order>\\n <label>场景</label>\\n</result>\\n<result>\\n <tag>people</tag>\\n <priority>MIDDLE</priority>\\n <order>9</order>\\n <label>人群</label>\\n</result>\\n<result>\\n <tag>season</tag>\\n <priority>MIDDLE</priority>\\n <order>10</order>\\n <label>时间季节</label>\\n</result>\\n<result>\\n <tag>model</tag>\\n <priority>MIDDLE</priority>\\n <order>11</order>\\n <label>型号</label>\\n</result>\\n<result>\\n <tag>region</tag>\\n <priority>MIDDLE</priority>\\n <order>12</order>\\n <label>地点地域</label>\\n</result>\\n<result>\\n <tag>name</tag>\\n <priority>MIDDLE</priority>\\n <order>13</order>\\n <label>人名</label>\\n</result>\\n<result>\\n <tag>adjective</tag>\\n <priority>MIDDLE</priority>\\n <order>14</order>\\n <label>修饰</label>\\n</result>\\n<result>\\n <tag>category-modifier</tag>\\n <priority>MIDDLE</priority>\\n <order>15</order>\\n <label>品类修饰词</label>\\n</result>\\n<result>\\n <tag>size</tag>\\n <priority>LOW</priority>\\n <order>16</order>\\n <label>尺寸规格</label>\\n</result>\\n<result>\\n <tag>quality</tag>\\n <priority>LOW</priority>\\n <order>17</order>\\n <label>品质成色</label>\\n</result>\\n<result>\\n <tag>suit</tag>\\n <priority>LOW</priority>\\n <order>18</order>\\n <label>套装</label>\\n</result>\\n<result>\\n <tag>new-release</tag>\\n <priority>LOW</priority>\\n <order>19</order>\\n <label>新品</label>\\n</result>\\n<result>\\n <tag>series</tag>\\n <priority>LOW</priority>\\n <order>20</order>\\n <label>系列</label>\\n</result>\\n<result>\\n <tag>marketing</tag>\\n <priority>LOW</priority>\\n <order>21</order>\\n <label>营销服务</label>\\n</result>\\n<result>\\n <tag>entertainment</tag>\\n <priority>LOW</priority>\\n <order>22</order>\\n <label>文娱书文曲</label>\\n</result>\\n<result>\\n <tag>organization</tag>\\n <priority>LOW</priority>\\n <order>23</order>\\n <label>机构实体</label>\\n</result>\\n<result>\\n <tag>movie</tag>\\n <priority>LOW</priority>\\n <order>24</order>\\n <label>影视名称</label>\\n</result>\\n<result>\\n <tag>game</tag>\\n <priority>LOW</priority>\\n <order>25</order>\\n <label>游戏名称</label>\\n</result>\\n<result>\\n <tag>number</tag>\\n <priority>LOW</priority>\\n <order>26</order>\\n <label>数字</label>\\n</result>\\n<result>\\n <tag>unit</tag>\\n <priority>LOW</priority>\\n <order>27</order>\\n <label>单位</label>\\n</result>\\n<result>\\n <tag>common</tag>\\n <priority>LOW</priority>\\n <order>28</order>\\n <label>普通词</label>\\n</result>\\n<result>\\n <tag>new-word</tag>\\n <priority>LOW</priority>\\n <order>29</order>\\n <label>新词</label>\\n</result>\\n<result>\\n <tag>proper-noun</tag>\\n <priority>LOW</priority>\\n <order>30</order>\\n <label>专有名词</label>\\n</result>\\n<result>\\n <tag>symbol</tag>\\n <priority>LOW</priority>\\n <order>31</order>\\n <label>符号</label>\\n</result>\\n<result>\\n <tag>prefix</tag>\\n <priority>LOW</priority>\\n <order>32</order>\\n <label>前缀</label>\\n</result>\\n<result>\\n <tag>suffix</tag>\\n <priority>LOW</priority>\\n <order>33</order>\\n <label>后缀</label>\\n</result>\\n<result>\\n <tag>gift</tag>\\n <priority>LOW</priority>\\n <order>34</order>\\n <label>赠送</label>\\n</result>\\n<result>\\n <tag>negative</tag>\\n <priority>LOW</priority>\\n <order>35</order>\\n <label>否定</label>\\n</result>\\n<result>\\n <tag>agent</tag>\\n <priority>LOW</priority>\\n <order>36</order>\\n <label>代理</label>\\n</result>","errorExample":""}]', + 'title' => 'ListQueryProcessorNers', + 'requestParamsDescription' => ' ', + 'responseParamsDescription' => ' ', + 'extraInfo' => ' ', + ], + 'ListQueryProcessorAnalyzerResults' => [ + 'summary' => 'Queries the results of a query analysis test. This API operation is available only to existing applications of OpenSearch Open Source Compatible Edition.', + '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' => 'The name of the application'."\n", + 'type' => 'string', + 'required' => true, + 'docRequired' => true, + 'example' => 'my_app_group_name', + ], + ], + [ + 'name' => 'appId', + 'in' => 'path', + 'schema' => [ + 'description' => 'The version number.'."\n", + 'type' => 'string', + 'required' => true, + 'docRequired' => true, + 'example' => '"110157886"', + ], + ], + [ + 'name' => 'name', + 'in' => 'path', + 'schema' => [ + 'description' => 'The name of the test.'."\n", + 'type' => 'string', + 'required' => true, + 'docRequired' => true, + 'example' => '"test"', + ], + ], + [ + 'name' => 'text', + 'in' => 'query', + 'schema' => [ + 'description' => 'The text to be tested.'."\n", + 'type' => 'string', + 'required' => true, + 'docRequired' => true, + 'example' => '"abcde"', + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'description' => 'The response body.'."\n", + 'type' => 'object', + 'properties' => [ + 'result' => [ + 'description' => 'The data returned.'."\n", + 'type' => 'object', + 'example' => '{}', + ], + 'RequestId' => [ + 'description' => 'The ID of the request.'."\n", + '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' => 'ListQueryProcessorAnalyzerResults', + ], + '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' => 'The number of entries to return on each page. Default value: 10.', + 'type' => 'integer', + 'format' => 'int32', + 'required' => false, + 'example' => '10', + ], + ], + [ + 'name' => 'pageNumber', + 'in' => 'query', + 'schema' => [ + 'description' => 'The number of the page to return. Default value: 1.', + 'type' => 'integer', + 'format' => 'int32', + 'required' => false, + 'example' => '1', + ], + ], + [ + 'name' => 'types', + 'in' => 'query', + 'schema' => [ + 'description' => 'The type of the intervention dictionary. Valid values:'."\n" + ."\n" + .'* stopword: an intervention dictionary for stop word filtering'."\n" + .'* synonym: an intervention dictionary for synonym configuration'."\n" + .'* correction: an intervention dictionary for spelling correction'."\n" + .'* category_prediction: an intervention dictionary for category prediction'."\n" + .'* ner: an intervention dictionary for named entity recognition (NER)'."\n" + .'* term_weighting: an intervention dictionary for term weight analysis', + 'type' => 'string', + 'required' => false, + 'example' => '["synonym"]', + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'type' => 'object', + 'properties' => [ + 'totalCount' => [ + 'description' => 'The total number of entries returned.'."\n", + 'type' => 'integer', + 'format' => 'int32', + 'example' => '2', + ], + 'requestId' => [ + 'description' => 'The ID of the request.'."\n", + 'type' => 'string', + 'example' => '0A6EB64B-B4C8-CF02-810F-E660812972FF', + ], + 'result' => [ + 'description' => 'The information about each intervention dictionary.'."\n" + ."\n" + .'For more information, see [InterventionDictionary](~~173608~~).'."\n", + 'type' => 'array', + 'items' => [ + 'type' => 'object', + 'properties' => [ + 'created' => [ + 'description' => 'The time when the intervention dictionary was created.'."\n", + 'type' => 'integer', + 'format' => 'int32', + 'example' => '1539158325', + ], + 'type' => [ + 'description' => 'The type of the intervention dictionary. Valid values:'."\n" + ."\n" + .'* stopword: an intervention dictionary for stop word filtering'."\n" + .'* synonym: an intervention dictionary for synonym configuration'."\n" + .'* correction: an intervention dictionary for spelling correction'."\n" + .'* category_prediction: an intervention dictionary for category prediction'."\n" + .'* ner: an intervention dictionary for named entity recognition (NER)'."\n" + .'* term_weighting: an intervention dictionary for term weight analysis'."\n", + 'type' => 'string', + 'example' => 'synonym', + ], + 'analyzer' => [ + 'description' => 'The custom analyzer.'."\n", + 'type' => 'string', + 'example' => '""', + ], + 'name' => [ + 'description' => 'The name of the intervention dictionary.'."\n", + 'type' => 'string', + 'example' => 'tongyici', + ], + 'updated' => [ + 'description' => 'The time when the intervention dictionary was last updated.'."\n", + 'type' => 'integer', + 'format' => 'int32', + 'example' => '1539158313', + ], + 'id' => [ + 'description' => 'The ID of the intervention dictionary.'."\n", + '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":"<requestId>0A6EB64B-B4C8-CF02-810F-E660812972FF</requestId>\\n<totalCount>2</totalCount>\\n<result>\\n <id>1</id>\\n <name>tongyici</name>\\n <type>synonym</type>\\n <analyzer/>\\n <created>1539158313</created>\\n <updated>1539158313</updated>\\n</result>\\n<result>\\n <id>2</id>\\n <name>tingyongci</name>\\n <type>stopword</type>\\n <analyzer/>\\n <created>1539158325</created>\\n <updated>1539158325</updated>\\n</result>","errorExample":""}]', + 'title' => 'ListInterventionDictionaries', + 'requestParamsDescription' => ' ', + 'responseParamsDescription' => ' ', + 'extraInfo' => ' ', + ], + 'CreateInterventionDictionary' => [ + 'summary' => 'Create an intervention dictionary.', + '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' => 'Specifies whether to perform only a dry run, without performing the actual request. Default value: false.'."\n" + ."\n" + .'Valid values:'."\n" + ."\n" + .'* **true**'."\n" + .'* **false**'."\n", + 'type' => 'boolean', + 'required' => false, + 'example' => 'false', + ], + ], + [ + 'name' => 'body', + 'in' => 'body', + 'style' => 'json', + 'schema' => [ + 'description' => 'The request body.'."\n", + 'type' => 'object', + 'properties' => [ + 'name' => [ + 'description' => 'The name of the intervention dictionary.'."\n", + 'type' => 'string', + 'required' => false, + 'example' => 'ner_dict_ec', + ], + 'type' => [ + 'description' => 'The type of the intervention dictionary. Valid values:'."\n" + ."\n" + .'* stopword: an intervention dictionary for stop word filtering.'."\n" + .'* synonym: an intervention dictionary for synonym configuration.'."\n" + .'* correction: an intervention dictionary for spelling correction.'."\n" + .'* category_prediction: an intervention dictionary for category prediction.'."\n" + .'* ner: an intervention dictionary for named entity recognition (NER).'."\n" + .'* term_weighting: an intervention dictionary for term weight analysis.'."\n" + .'* suggest_allowlist: a drop-down suggestion whitelist.'."\n" + .'* suggest_denylist: a drop-down suggestion blacklist.'."\n" + .'* hot_allowlist: a top search whitelist.'."\n" + .'* hot_denylist: a top search blacklist.'."\n" + .'* hint_allowlist: a hint whitelist.'."\n" + .'* hint_denylist: a hint blacklist.'."\n", + 'type' => 'string', + 'required' => false, + 'example' => 'ner', + ], + 'analyzerType' => [ + 'description' => 'The type of the analyzer. Valid values:'."\n" + ."\n" + .'* MODEL: model-based custom analyzer.'."\n" + .'* SYSTEM: system analyzer.'."\n" + .'* USER: custom analyzer.'."\n", + 'type' => 'string', + 'required' => false, + 'example' => 'SYSTEM', + ], + ], + 'required' => false, + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'type' => 'object', + 'properties' => [ + 'requestId' => [ + 'description' => 'The ID of the request.'."\n", + 'type' => 'string', + 'example' => '80326EFE-485F-46E7-B291-5A1DD08D2198', + ], + 'result' => [ + 'description' => 'The returned results.', + 'type' => 'object', + 'properties' => [ + 'created' => [ + 'description' => 'The time when the test scenario was created.', + 'type' => 'string', + 'example' => '1591086323', + ], + 'analyzer' => [ + 'description' => 'The custom analyzer.', + 'type' => 'string', + 'example' => 'dianshang', + ], + 'updated' => [ + 'description' => 'The time when the intervention dictionary was last updated.', + 'type' => 'string', + 'example' => '1591086323', + ], + 'type' => [ + 'description' => 'The type of the intervention dictionary. Valid values:'."\n" + ."\n" + .'* stopword: an intervention dictionary for stop word filtering'."\n" + .'* synonym: an intervention dictionary for synonym configuration'."\n" + .'* correction: an intervention dictionary for spelling correction'."\n" + .'* category_prediction: an intervention dictionary for category prediction'."\n" + .'* ner: an intervention dictionary for named entity recognition (NER)'."\n" + .'* term_weighting: an intervention dictionary for term weight analysis'."\n", + 'type' => 'string', + 'example' => 'ner', + ], + 'name' => [ + 'description' => 'The name of the test group.'."\n", + '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":"<requestId>80326EFE-485F-46E7-B291-5A1DD08D2198</requestId>\\n<result>\\n <analyzer>dianshang</analyzer>\\n <created>1591086323</created>\\n <id>1001</id>\\n <name>testb</name>\\n <type>ner</type>\\n <updated>1591086323</updated>\\n</result>","errorExample":""}]', + 'title' => 'CreateInterventionDictionary', + 'requestParamsDescription' => '**Request body**'."\n" + ."\n" + .'|Parameter|Type|Required|Example|Description|'."\n" + .'|---|---|---|---|---|'."\n" + .'|name|String|Yes|"my\\_dict"|The name of the intervention dictionary.|'."\n" + .'|type|String|Yes|"ner"|The type of the intervention dictionary.|'."\n" + .'|analyzer|String|No|"my\\_analyzer"|The name of the custom analyzer. This parameter is required if type is set to ner.|'."\n" + .'|analyzerType|String|No|"SYSTEM"|The type of the analyzer.|'."\n" + ."\n\n" + .'For more information, see [InterventionDictionary](~~173608~~).', + 'responseParamsDescription' => ' ', + 'extraInfo' => ' ', + ], + 'DescribeInterventionDictionary' => [ + 'summary' => 'Queries the details of an intervention dictionary.', + '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' => 'The name of the intervention dictionary.'."\n", + 'type' => 'string', + 'required' => true, + 'docRequired' => true, + 'example' => 'my_dict', + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'type' => 'object', + 'properties' => [ + 'requestId' => [ + 'description' => 'The request ID.'."\n", + 'type' => 'string', + 'example' => 'D7CCF454-472A-030E-F254-604520B028AA', + ], + 'result' => [ + 'description' => 'The details about the intervention dictionary.'."\n", + 'type' => 'object', + 'properties' => [ + 'created' => [ + 'description' => 'The time when the the intervention dictionary was created.'."\n", + 'type' => 'string', + 'example' => '1536233287', + ], + 'analyzer' => [ + 'description' => 'The custom analyzer.'."\n", + 'type' => 'string', + 'example' => '-', + ], + 'updated' => [ + 'description' => 'The time when the the intervention dictionary was modified.'."\n", + 'type' => 'string', + 'example' => '1536233287', + ], + 'type' => [ + 'description' => 'Type'."\n" + ."\n" + .'* stopword: an intervention dictionary for stop word filtering.'."\n" + .'* synonym: an intervention dictionary for synonym configuration.'."\n" + .'* correction: an intervention dictionary for spelling correction.'."\n" + .'* category_prediction: an intervention dictionary for category prediction.'."\n" + .'* ner: an intervention dictionary for named entity recognition.'."\n" + .'* term_weighting: an intervention dictionary for term weight analysis.'."\n", + 'type' => 'string', + 'example' => 'category_prediction', + ], + 'name' => [ + 'description' => 'The name of the the intervention dictionary.'."\n", + 'type' => 'string', + 'example' => 'test', + ], + ], + ], + ], + 'description' => '', + ], + ], + '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":"<requestId>D7CCF454-472A-030E-F254-604520B028AA</requestId>\\n<result>\\n <name>test</name>\\n <type>category_prediction</type>\\n <analyzer/>\\n <created>1536233287</created>\\n <updated>1536233287</updated>\\n</result>","errorExample":""}]', + 'title' => 'DescribeInterventionDictionary', + ], + 'RemoveInterventionDictionary' => [ + 'summary' => 'Deletes an intervention dictionary.', + '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' => 'The name of the intervention dictionary'."\n", + 'type' => 'string', + 'required' => false, + 'example' => '“my_dict”', + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'type' => 'object', + 'properties' => [ + 'requestId' => [ + 'description' => 'The request ID.'."\n", + 'type' => 'string', + 'example' => '06BBD41A-5F72-34E4-2DAF-E43B0526051D', + ], + 'result' => [ + 'description' => 'The information about the intervention dictionary.'."\n", + 'type' => 'object', + 'properties' => [ + 'created' => [ + 'description' => 'The time when the intervention dictionary was created.'."\n", + 'type' => 'string', + 'example' => '1539158313', + ], + 'analyzer' => [ + 'description' => 'The custom analyzer.'."\n", + 'type' => 'string', + 'example' => '""', + ], + 'updated' => [ + 'description' => 'The time when the the intervention dictionary was modified.'."\n", + 'type' => 'string', + 'example' => '1539158313', + ], + 'type' => [ + 'description' => 'Type'."\n" + ."\n" + .'* stopword: an intervention dictionary for stop word filtering.'."\n" + .'* synonym: an intervention dictionary for synonym configuration.'."\n" + .'* correction: an intervention dictionary for spelling correction.'."\n" + .'* category_prediction: an intervention dictionary for category prediction.'."\n" + .'* ner: an intervention dictionary for named entity recognition.'."\n" + .'* term_weighting: an intervention dictionary for term weight analysis.'."\n", + 'type' => 'string', + 'example' => 'synonym', + ], + 'name' => [ + 'description' => 'Parameter'."\n", + 'type' => 'string', + 'example' => 'tongyici', + ], + ], + ], + ], + 'description' => '', + ], + ], + '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":"<requestId>06BBD41A-5F72-34E4-2DAF-E43B0526051D</requestId>\\n<result>\\n <id>123</id>\\n <name>testb</name>\\n <type>ner</type>\\n <analyzer>abc</analyzer>\\n <created>1587957529</created>\\n <updated>1587957529</updated>\\n</result>","errorExample":""}]', + 'title' => 'RemoveInterventionDictionary', + 'requestParamsDescription' => ' ', + 'responseParamsDescription' => ' ', + ], + 'ListInterventionDictionaryEntries' => [ + 'summary' => 'Queries the intervention entries in an intervention dictionary.', + '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' => 'The name of the intervention dictionary.'."\n", + 'type' => 'string', + 'required' => true, + 'docRequired' => true, + 'example' => 'my_dict', + ], + ], + [ + 'name' => 'word', + 'in' => 'query', + 'schema' => [ + 'description' => 'The intervention entry.'."\n", + 'type' => 'string', + 'required' => false, + 'example' => 'test', + ], + ], + [ + 'name' => 'pageNumber', + 'in' => 'query', + 'schema' => [ + 'description' => 'The page number. Default value: 1.'."\n", + 'type' => 'integer', + 'format' => 'int32', + 'required' => false, + 'docRequired' => false, + 'example' => '1', + ], + ], + [ + 'name' => 'pageSize', + 'in' => 'query', + 'schema' => [ + 'description' => 'The number of entries returned per page. Default value: 10.'."\n", + 'type' => 'integer', + 'format' => 'int32', + 'required' => false, + 'example' => '10', + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'type' => 'object', + 'properties' => [ + 'totalCount' => [ + 'description' => 'The total number of entries returned.'."\n", + 'type' => 'integer', + 'format' => 'int32', + 'example' => '8', + ], + 'requestId' => [ + 'description' => 'The request ID.'."\n", + 'type' => 'string', + 'example' => '516A02B7-2167-8D92-12D0-B639A2A0F3C5', + ], + 'result' => [ + 'description' => 'The information about intervention entries.'."\n" + ."\n" + .'For more information, see [InterventionDictionaryEntry](~~173606~~).'."\n", + 'type' => 'array', + 'items' => [ + 'type' => 'object', + 'properties' => [ + 'cmd' => [ + 'description' => 'The command. Valid values:'."\n" + ."\n" + .'* add'."\n" + .'* delete'."\n", + 'type' => 'string', + 'example' => 'add', + ], + 'created' => [ + 'description' => 'The timestamp when the intervention entry was created.'."\n", + 'type' => 'integer', + 'format' => 'int64', + 'example' => '1536690285', + ], + 'word' => [ + 'description' => 'The intervention entry.'."\n", + 'type' => 'string', + 'example' => '\\u8fc7\\u513f', + ], + 'relevance' => [ + 'description' => 'The content of an intervention entry for category prediction. The field value consists of key-value pairs. The key in a key-value pair indicates the ID of the category. The value in a key-value pair indicates the relevance to the category. A value of 0 indicates irrelevant. A value of 1 indicates slightly relevant. A value of 2 indicates relevant. Example: {"2":1, "100":0}'."\n", + 'type' => 'object', + 'example' => ' { "100": "0", "200": "2" }', + ], + 'status' => [ + 'description' => 'The status of the intervention entry. Valid value:'."\n" + ."\n" + .'* ACTIVE: The intervention entry takes effect.'."\n", + 'type' => 'string', + 'example' => 'ACTIVE', + ], + 'updated' => [ + 'description' => 'The timestamp when the intervention entry was last updated.'."\n", + 'type' => 'integer', + 'format' => 'int64', + 'example' => '1537348987', + ], + 'tokens' => [ + 'description' => 'The content of the intervention entry for term weight analysis.'."\n", + 'type' => 'array', + 'items' => [ + 'type' => 'object', + 'properties' => [ + 'tag' => [ + 'description' => 'The internal name of the identified entity type. Valid values:'."\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'."\n", + 'type' => 'string', + 'example' => 'category', + ], + 'token' => [ + 'description' => 'The entity.'."\n", + 'type' => 'string', + 'example' => 'category', + ], + 'order' => [ + 'description' => 'The sequence number.'."\n", + 'type' => 'integer', + 'format' => 'int32', + 'example' => '1', + ], + 'tagLabel' => [ + 'description' => 'The description of the internal name of the identified entity type.'."\n", + 'type' => 'string', + 'example' => 'category', + ], + ], + 'description' => '', + ], + ], + ], + 'description' => '', + ], + ], + ], + 'description' => '', + ], + ], + '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":"<requestId>516A02B7-2167-8D92-12D0-B639A2A0F3C5</requestId>\\n<result>\\n <cmd>add</cmd>\\n <word>过儿</word>\\n <created>1536690285</created>\\n <updated>1537348987</updated>\\n <status>ACTIVE</status>\\n <relevance>\\n <100>0</100>\\n <200>2</200>\\n </relevance>\\n</result>\\n<result>\\n <cmd>add</cmd>\\n <word>过</word>\\n <created>1536690308</created>\\n <updated>1537349055</updated>\\n <status>ACTIVE</status>\\n <relevance>\\n <200>2</200>\\n </relevance>\\n</result>\\n<result>\\n <cmd>add</cmd>\\n <word>苹</word>\\n <created>1536683292</created>\\n <updated>1537220498</updated>\\n <status>ACTIVE</status>\\n <relevance>\\n <12>1</12>\\n </relevance>\\n</result>\\n<result>\\n <cmd>add</cmd>\\n <word>吧</word>\\n <created>1536690347</created>\\n <updated>1537220498</updated>\\n <status>ACTIVE</status>\\n <relevance>\\n <100>2</100>\\n <200>0</200>\\n </relevance>\\n</result>\\n<result>\\n <cmd>add</cmd>\\n <word>果</word>\\n <created>1536690184</created>\\n <updated>1537220498</updated>\\n <status>ACTIVE</status>\\n <relevance>\\n <100>2</100>\\n </relevance>\\n</result>\\n<result>\\n <cmd>add</cmd>\\n <word>裤子</word>\\n <created>1537353071</created>\\n <updated>1537353074</updated>\\n <status>ACTIVE</status>\\n <relevance>\\n <100>1</100>\\n <200>2</200>\\n </relevance>\\n</result>\\n<result>\\n <cmd>add</cmd>\\n <word>adfads</word>\\n <created>1536690258</created>\\n <updated>1537220498</updated>\\n <status>ACTIVE</status>\\n <relevance>\\n <1>1</1>\\n <2>1</2>\\n <3>1</3>\\n </relevance>\\n</result>\\n<result>\\n <cmd>add</cmd>\\n <word>zvzcxv</word>\\n <created>1536690537</created>\\n <updated>1537220498</updated>\\n <status>ACTIVE</status>\\n <relevance>\\n <100>1</100>\\n </relevance>\\n</result>\\n<totalCount>8</totalCount>","errorExample":""}]', + 'title' => 'ListInterventionDictionaryEntries', + 'requestParamsDescription' => ' ', + 'responseParamsDescription' => ' ', + 'extraInfo' => ' ', + ], + 'PushInterventionDictionaryEntries' => [ + 'summary' => 'Accepts the changes in intervention entries.', + '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' => 'The name of the intervention dictionary.'."\n", + 'type' => 'string', + 'required' => true, + 'docRequired' => true, + 'example' => 'my_dict', + ], + ], + [ + 'name' => 'dryRun', + 'in' => 'query', + 'schema' => [ + 'description' => 'Specifies whether to check the validity of input parameters. Default value: false.'."\n" + ."\n" + .'Valid values:'."\n" + ."\n" + .'* **true**: checks only the validity of input parameters.'."\n" + .'* **false**: checks the validity of input parameters and creates an attribution configuration.'."\n", + 'type' => 'boolean', + 'required' => false, + 'example' => 'false', + ], + ], + [ + 'name' => 'body', + 'in' => 'body', + 'style' => 'json', + 'schema' => [ + 'description' => 'The request body.'."\n", + 'type' => 'array', + 'items' => [ + 'description' => 'The request body.'."\n", + 'type' => 'object', + 'required' => false, + 'example' => '', + ], + 'required' => false, + 'maxItems' => 100, + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'type' => 'object', + 'properties' => [ + 'requestId' => [ + 'description' => 'The request ID.'."\n", + 'type' => 'string', + 'example' => 'D77D0DAF-790D-F5F5-A9C0-133738165014', + ], + 'result' => [ + 'description' => 'The returned results.'."\n", + 'type' => 'array', + 'items' => [ + 'description' => 'The returned result.'."\n", + 'type' => 'string', + 'example' => '[]', + ], + ], + ], + 'description' => '', + ], + ], + '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":"<requestId>D77D0DAF-790D-F5F5-A9C0-133738165014</requestId>","errorExample":""}]', + 'title' => 'PushInterventionDictionaryEntries', + 'requestParamsDescription' => 'Common parameters of the **request body**'."\n" + ."\n" + .'|Parameter|Type|Required|Example|Description|'."\n" + .'|---|---|---|---|---|'."\n" + .'|\\[\\]|Object|Yes||The information about the intervention entry.|'."\n" + .'|\\[\\].cmd|String|Yes|"add"|The command. Valid values:adddelete|'."\n" + .'|\\[\\].word|String|Yes|"Alibaba Cloud"|The intervention entry.|'."\n" + ."\n" + .'Dictionary-specific parameters References:'."\n" + ."\n" + .'* [stopword: an intervention entry for stop word filtering](~~173606~~)'."\n" + .'* [synonym: an intervention entry for synonym configuration](~~173606~~)'."\n" + .'* [correction: an intervention entry for spelling correction](~~173606~~)'."\n" + .'* [term\\_weighting: an intervention dictionary for term weight analysis](~~173606~~)'."\n" + .'* [category\\_prediction: an intervention entry for category prediction](~~173606~~)'."\n" + .'* [ner: an intervention entry for named entity recognition (NER)](~~173606~~)'."\n" + .'* [suggest\\_allowlist: a drop-down suggestion whitelist](~~173606~~)'."\n" + .'* [suggest\\_denylist: a drop-down suggestion blacklist](~~173606~~)'."\n" + .'* [hot\\_allowlist: a top search whitelist](~~173606~~)'."\n" + .'* [hot\\_denylist: a top search blacklist](~~173606~~)'."\n" + .'* [hint\\_allowlist: a hint whitelist](~~173606~~)'."\n" + .'* [hint\\_denylist: a hint blacklist](~~173606~~)', + 'responseParamsDescription' => ' ', + 'extraInfo' => ' ', + ], + 'ListInterventionDictionaryRelatedEntities' => [ + 'summary' => 'Queries the resources that are associated with an intervention dictionary. If the intervention dictionary is referenced by query analysis rules, this operation returns all applications that use the intervention dictionary and the information about the query analysis rules.', + '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' => 'The name of the intervention dictionary.'."\n", + 'type' => 'string', + 'required' => true, + 'docRequired' => true, + 'example' => 'my_dict', + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'type' => 'object', + 'properties' => [ + 'requestId' => [ + 'description' => 'The request ID.'."\n", + 'type' => 'string', + 'example' => 'D77D0DAF-790D-F5F5-A9C0-133738165014', + ], + 'result' => [ + 'type' => 'array', + 'items' => [ + 'description' => 'The information about each application and each query analysis rule. If no query analysis rule references the intervention dictionary, this value is empty.'."\n", + 'type' => 'object', + 'example' => '[]', + ], + 'description' => 'The returned results.', + ], + ], + 'description' => '', + ], + ], + '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":"<requestId>65956EC5-71B8-8A21-2F2E-FBE7E7292AD6</requestId>\\n<result>\\n <appGroup>test_srn_mysql</appGroup>\\n <queryProcessor>\\n <name>it_content</name>\\n <active>true</active>\\n <indexes>short_text</indexes>\\n <indexes>text_pack</indexes>\\n <indexes>short_text_pack</indexes>\\n <processors>\\n <useSystemDictionary>true</useSystemDictionary>\\n <interventionDictionary>tst</interventionDictionary>\\n <name>stop_word</name>\\n </processors>\\n <processors>\\n <useSystemDictionary>true</useSystemDictionary>\\n <interventionDictionary>test_han_jiuduo_2</interventionDictionary>\\n <name>spell_check</name>\\n </processors>\\n <processors>\\n <useSystemDictionary>true</useSystemDictionary>\\n <interventionDictionary>test_han_tongyici</interventionDictionary>\\n <name>synonym</name>\\n </processors>\\n <processors>\\n <useSystemDictionary>true</useSystemDictionary>\\n <interventionDictionary/>\\n <name>term_weighting</name>\\n </processors>\\n <domain>IT_CONTENT</domain>\\n <created>1585714793</created>\\n <updated>1591163738</updated>\\n </queryProcessor>\\n</result>","errorExample":""}]', + 'title' => 'ListInterventionDictionaryRelatedEntities', + 'requestParamsDescription' => ' ', + 'responseParamsDescription' => '|Parameter|Type|Description|'."\n" + .'|---|---|---|'."\n" + .'|result\\[\\].appGroup|String|The name of the application.|'."\n" + .'|result\\[\\].queryProcessor|Object|The information about the rule. For more information, see [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' => 'The dictionary name.', + 'type' => 'string', + 'required' => true, + 'docRequired' => true, + 'example' => 'my_dict', + ], + ], + [ + 'name' => 'query', + 'in' => 'query', + 'schema' => [ + 'description' => 'Query keywords.', + 'type' => 'string', + 'required' => true, + 'docRequired' => true, + 'example' => '"hello world"', + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'type' => 'object', + 'properties' => [ + 'requestId' => [ + 'description' => 'The ID of the request.'."\n", + 'type' => 'string', + 'example' => '8F780CA8-D4D4-2FFE-B8AC-42040822C554', + ], + 'result' => [ + 'description' => 'The NER result.'."\n" + ."\n" + .'For more information, see [InterventionDictionaryEntry](~~173606~~).'."\n", + 'type' => 'array', + 'items' => [ + 'type' => 'object', + 'properties' => [ + 'tag' => [ + 'description' => 'The internal name of the identified entity type. Valid values:'."\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'."\n", + 'type' => 'string', + 'example' => 'category', + ], + 'token' => [ + 'description' => 'The entity.'."\n", + 'type' => 'string', + 'example' => 'eaa73f35-007a-4be7-88c7-37dca4a04ab7', + ], + 'order' => [ + 'description' => 'The sequence number.'."\n", + 'type' => 'integer', + 'format' => 'int32', + 'example' => '1', + ], + 'tagLabel' => [ + 'description' => 'The description of the internal name of the identified entity type.'."\n", + 'type' => 'string', + 'example' => 'category', + ], + ], + 'description' => 'The result'."\n", + ], + ], + ], + ], + ], + '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' => 'ListInterventionDictionaryNerResults', + 'requestParamsDescription' => ' ', + 'responseParamsDescription' => ' ', + 'extraInfo' => ' ', + ], + 'EnableSlowQuery' => [ + 'summary' => 'Enables slow query optimization of Optimization Master.', + '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' => 'The name of the application'."\n", + 'type' => 'string', + 'required' => true, + 'docRequired' => true, + 'example' => 'my_app_group_name', + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'type' => 'object', + 'properties' => [ + 'result' => [ + 'description' => 'The returned data.'."\n", + 'type' => 'object', + 'example' => '{}', + ], + 'requestId' => [ + 'description' => 'The request ID.'."\n", + 'type' => 'string', + 'example' => '728E89C6-8673-D39B-39A1-5BA2B56D448F', + ], + ], + 'description' => '', + ], + ], + '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":"<requestId>728E89C6-8673-D39B-39A1-5BA2B56D448F</requestId>\\n<result/>","errorExample":""}]', + 'title' => 'EnableSlowQuery', + ], + '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' => 'my_app_group_name'."\n", + 'type' => 'string', + 'required' => true, + 'docRequired' => true, + 'example' => 'my_app_group_name', + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'type' => 'object', + 'properties' => [ + 'result' => [ + 'description' => 'The return result.'."\n", + 'type' => 'object', + 'example' => '{}', + ], + 'requestId' => [ + 'description' => 'The ID of the request.'."\n", + '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":"<requestId>728E89C6-8673-D39B-39A1-5BA2B56D448F</requestId>\\n<result/>","errorExample":""}]', + 'title' => 'DisableSlowQuery', + ], + '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' => 'my_app_group_name'."\n", + 'type' => 'string', + 'required' => true, + 'docRequired' => true, + 'example' => 'my_app_group_name', + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'type' => 'object', + 'properties' => [ + 'requestId' => [ + 'description' => 'The ID of the request.'."\n", + 'type' => 'string', + 'example' => '5C1C1C45-C64A-AD30-565F-140871D57E5E', + ], + 'result' => [ + 'description' => 'The return result.'."\n", + 'type' => 'object', + 'properties' => [ + 'region' => [ + 'description' => 'The network type of the slow query optimization service. Valid values:'."\n" + ."\n" + .'* outer: the Internet'."\n" + .'* internal: the internal network'."\n", + 'type' => 'string', + 'example' => 'internal', + ], + 'status' => [ + 'description' => 'The status of the slow query optimization service. Valid values:'."\n" + ."\n" + .'* enabled'."\n" + .'* disabled'."\n" + .'* n/a'."\n", + 'type' => 'string', + 'example' => 'disabled', + ], + 'appGroupId' => [ + 'description' => 'The ID of the application.'."\n", + '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":"<requestId>5C1C1C45-C64A-AD30-565F-140871D57E5E</requestId>\\n<result>\\n <region>internal</region>\\n <appGroupId>100298370</appGroupId>\\n <status>disabled</status>\\n</result>","errorExample":""}]', + 'title' => 'DescribeSlowQueryStatus', + ], + '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' => '"my_app_group_name"'."\n", + 'type' => 'string', + 'required' => true, + 'docRequired' => true, + 'example' => '“my_app_group_name”', + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'type' => 'object', + 'properties' => [ + 'result' => [ + 'description' => 'N/A'."\n", + 'type' => 'object', + 'example' => '{}', + ], + 'requestId' => [ + 'description' => 'The ID of the request.'."\n", + '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":"<requestId>D77D0DAF-790D-F5F5-A9C0-133738165014</requestId>\\n<result/>","errorExample":""}]', + 'title' => 'StartSlowQueryAnalyzer', + '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' => 'my_app_group_name'."\n", + 'type' => 'string', + 'required' => true, + 'docRequired' => true, + 'example' => 'my_app_group_name', + ], + ], + [ + 'name' => 'categoryIndex', + 'in' => 'path', + 'schema' => [ + 'description' => '0'."\n", + 'type' => 'string', + 'required' => true, + 'docRequired' => true, + 'example' => '0', + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'type' => 'object', + 'properties' => [ + 'requestId' => [ + 'description' => 'The ID of the request.'."\n", + 'type' => 'string', + 'example' => 'EB250CA0-ACFD-C5DE-17CD-01445BFE8AE5', + ], + 'result' => [ + 'description' => 'The return result.'."\n", + 'type' => 'object', + 'properties' => [ + 'index' => [ + 'description' => 'The ID of the optimization suggestion.'."\n", + 'type' => 'integer', + 'format' => 'int32', + 'example' => '0', + ], + 'appQuery' => [ + 'description' => 'The content of the optimization suggestion for the query.'."\n", + 'type' => 'string', + 'example' => 'no data', + ], + 'start' => [ + 'description' => 'The beginning of the time range that was queried.'."\n", + 'type' => 'integer', + 'format' => 'int32', + 'example' => '1589986800', + ], + 'end' => [ + 'description' => 'The end of the time range that was queried.'."\n", + '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":"<requestId>EB250CA0-ACFD-C5DE-17CD-01445BFE8AE5</requestId>\\n<result>\\n <start>1589986800</start>\\n <end>1589990340</end>\\n <index>0</index>\\n <appQuery>no data</appQuery>\\n</result>","errorExample":""}]', + 'title' => 'ListSlowQueryQueries', + 'responseParamsDescription' => ' ', + 'extraInfo' => ' ', + ], + 'ListSlowQueryCategories' => [ + 'summary' => 'Queries the suggestions that are provided by Optimization Master for slow queries.', + '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' => 'The name of the application'."\n", + 'type' => 'string', + 'required' => true, + 'docRequired' => true, + 'example' => 'my_app_group_name', + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'type' => 'object', + 'properties' => [ + 'requestId' => [ + 'description' => 'The ID of the request.'."\n", + 'type' => 'string', + 'example' => '4406F40B-A0A2-9D5D-531F-3B6936567584', + ], + 'result' => [ + 'description' => 'The data returned.'."\n", + 'type' => 'object', + 'properties' => [ + 'start' => [ + 'description' => 'The timestamp that indicates the beginning of the time range to query.'."\n", + 'type' => 'integer', + 'format' => 'int32', + 'example' => '1589986800', + ], + 'analyzeStatus' => [ + 'description' => 'The status of the analysis. Valid values:'."\n" + ."\n" + .'* PENDING: preparing'."\n" + .'* SUCCESS: succeeded'."\n" + .'* RUNNING: running'."\n" + .'* FAILED: failed'."\n" + .'* N/A: unknown'."\n", + 'type' => 'string', + 'example' => '"PENDING"', + ], + 'end' => [ + 'description' => 'The timestamp that indicates the end of the time range to query.'."\n", + '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":"<requestId>4406F40B-A0A2-9D5D-531F-3B6936567584</requestId>\\n<result>\\n <analyzeStatus>PENDING</analyzeStatus>\\n <start>1589986800</start>\\n <end>1589990340</end>\\n</result>","errorExample":""}]', + 'title' => 'ListSlowQueryCategories', + 'requestParamsDescription' => '**Sample requests**'."\n" + ."\n" + .'`GET /v4/openapi/app-groups/kevintest2/optimizers/slow-query/categories?end=1589990340&sort=max&start=1589986800`'."\n" + ."\n" + .'**Query parameters**'."\n" + ."\n" + .'|Parameter|Type|Required|Example|Description|'."\n" + .'|---|---|---|---|---|'."\n" + .'|start|Integer|Yes|1589986800|The timestamp that specifies the beginning of the time range to query. The time is accurate to seconds.|'."\n" + .'|end|Integer|Yes|1589990340|The timestamp that specifies the end of the time range to query. The time is accurate to seconds.|'."\n" + .'|sort|String|No|"max"|The sort type.<br /> Valid values:<br />-max: the maximum value<br />-avg: the average value<br />-sum: the sum value<br />-queryProportion: the query proportion|', + ], + 'ListQuotaReviewTasks' => [ + 'summary' => 'Queries tickets that are submitted to apply for quotas for an OpenSearch application.', + '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' => 'The application name.'."\n", + 'type' => 'string', + 'required' => true, + 'docRequired' => true, + 'example' => '"my_app_name"', + ], + ], + [ + 'name' => 'pageNumber', + 'in' => 'query', + 'schema' => [ + 'description' => 'The page number. Default value: 1.'."\n", + 'type' => 'integer', + 'format' => 'int32', + 'required' => false, + 'example' => '1', + ], + ], + [ + 'name' => 'pageSize', + 'in' => 'query', + 'schema' => [ + 'description' => 'The number of entries to return on each page. Default value: 10.'."\n", + 'type' => 'integer', + 'format' => 'int32', + 'required' => false, + 'example' => '10', + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'description' => 'The response parameters.'."\n", + 'type' => 'object', + 'properties' => [ + 'totalCount' => [ + 'description' => 'The total number of entries returned.'."\n", + 'type' => 'integer', + 'format' => 'int32', + 'example' => '500', + ], + 'requestId' => [ + 'description' => 'The request ID.'."\n", + 'type' => 'string', + 'example' => '"3351A21F-705B-508C-9450-DA65A681547F"', + ], + 'result' => [ + 'description' => 'The information about the tickets. For more information, see [QuotaReviewTask](~~173609~~).'."\n", + 'type' => 'array', + 'items' => [ + 'description' => '', + 'type' => 'object', + 'properties' => [ + 'oldDocSize' => [ + 'description' => 'The original quota of storage capacity.'."\n", + 'type' => 'integer', + 'format' => 'int32', + 'example' => '900', + ], + 'pending' => [ + 'description' => 'Indicates whether the ticket is pending.'."\n", + 'type' => 'boolean', + 'example' => 'false', + ], + 'memo' => [ + 'description' => 'The remarks.'."\n", + 'type' => 'string', + 'example' => 'null', + ], + 'approved' => [ + 'description' => 'Indicates whether the ticket is approved.'."\n", + 'type' => 'boolean', + 'example' => 'true', + ], + 'oldSpec' => [ + 'description' => 'The original specifications of the application.'."\n", + 'type' => 'string', + 'example' => '"opensearch.private.common"', + ], + 'oldComputeResource' => [ + 'description' => 'The original quota of computing resources.'."\n", + 'type' => 'integer', + 'format' => 'int32', + 'example' => '500', + ], + 'appGroupType' => [ + 'description' => 'The application type.'."\n", + 'type' => 'string', + 'example' => '"standard"', + ], + 'available' => [ + 'description' => 'Indicates whether the application is available.'."\n", + 'type' => 'boolean', + 'example' => 'true', + ], + 'gmtCreate' => [ + 'description' => 'The time when the ticket was created.'."\n", + 'type' => 'string', + 'example' => '"2020-04-08T08:29:45+0000"', + ], + 'newSocSize' => [ + 'description' => 'The storage capacity quota that is applied for.'."\n", + 'type' => 'integer', + 'format' => 'int32', + 'example' => '1100', + ], + 'id' => [ + 'description' => 'The ticket ID.'."\n", + 'type' => 'integer', + 'format' => 'int32', + 'example' => '142', + ], + 'appGroupId' => [ + 'description' => 'The application ID.'."\n", + 'type' => 'integer', + 'format' => 'int32', + 'example' => '120123456', + ], + 'newComputeResource' => [ + 'description' => 'The computing resource quota that is applied for.'."\n", + 'type' => 'integer', + 'format' => 'int32', + 'example' => '6000', + ], + 'appGroupName' => [ + 'description' => 'The application name.'."\n", + 'type' => 'string', + 'example' => '"td_test_os"', + ], + 'gmtModified' => [ + 'description' => 'The time when the ticket was last updated.'."\n", + 'type' => 'string', + 'example' => '"2020-04-08T08:36:36+0000"', + ], + 'newSpec' => [ + 'description' => 'The application specifications that are applied for.'."\n", + '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' => 'ListQuotaReviewTasks', + 'requestParamsDescription' => 'Sample requests'."\n" + ."\n" + .' GET /v4/openapi/app-groups/demo/quota-review-tasks'."\n", + 'responseParamsDescription' => 'Sample responses'."\n" + ."\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" + .'```'."\n", + ], + 'ListScheduledTasks' => [ + 'summary' => 'Queries a list of scheduled tasks of an OpenSearch application.', + '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' => 'The application name.'."\n", + 'type' => 'string', + 'required' => true, + 'docRequired' => true, + 'example' => 'my_app_group_name', + ], + ], + [ + 'name' => 'type', + 'in' => 'query', + 'schema' => [ + 'description' => 'The scheduled task type. Valid values:'."\n" + ."\n" + .'* wipe: data cleaning.'."\n" + .'* fork: reindexing.'."\n" + .'* check-status: application status check.'."\n" + .'* index: reindexing.'."\n", + 'type' => 'string', + 'required' => false, + 'example' => 'wipe', + ], + ], + [ + 'name' => 'pageNumber', + 'in' => 'query', + 'schema' => [ + 'description' => 'The page number. Default value: 1.'."\n", + 'type' => 'integer', + 'format' => 'int32', + 'required' => false, + 'example' => '1', + ], + ], + [ + 'name' => 'pageSize', + 'in' => 'query', + 'schema' => [ + 'description' => 'The number of entries per page. Default value: 10.'."\n", + 'type' => 'integer', + 'format' => 'int32', + 'required' => false, + 'example' => '10', + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'type' => 'object', + 'properties' => [ + 'totalCount' => [ + 'description' => 'The total number of entries returned.'."\n", + 'type' => 'integer', + 'format' => 'int64', + 'example' => '1', + ], + 'requestId' => [ + 'description' => 'The request ID.'."\n", + 'type' => 'string', + 'example' => '0A6EB64B-B4C8-CF02-810F-E660812972FF', + ], + 'result' => [ + 'type' => 'array', + 'items' => [ + 'description' => 'The information about the scheduled task.'."\n" + ."\n" + .'For more information, see [ScheduledTask](~~173610~~).'."\n", + 'type' => 'object', + 'example' => '[]', + ], + 'description' => '', + ], + ], + 'description' => '', + ], + ], + '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":"<requestId>0A6EB64B-B4C8-CF02-810F-E660812972FF</requestId>\\n<totalCount>1</totalCount>\\n<result>\\n <id>2f12c585-5873-11ea-974a-7cd30ad3e268</id>\\n <progress>0</progress>\\n <status>3</status>\\n <lastRanTimestamp/>\\n <type>wipe</type>\\n <running>false</running>\\n <paused>false</paused>\\n <finished>false</finished>\\n <idle>true</idle>\\n <created>1582706232</created>\\n <updated>1582706232</updated>\\n <cron>0 0 * * 1,2,3,4,5,6,7</cron>\\n <enabled>true</enabled>\\n <appId/>\\n <appGroupId>110091051</appGroupId>\\n <ownerId>2656</ownerId>\\n <lastScheduledTimestamp/>\\n <forkedAppId/>\\n <appGroup>\\n <id>110091051</id>\\n </appGroup>\\n <owner>\\n <id>2656</id>\\n </owner>\\n <filter>\\n <field>ctime</field>\\n <days>30</days>\\n <unit>s</unit>\\n </filter>\\n</result>","errorExample":""}]', + 'title' => 'ListScheduledTasks', + 'requestParamsDescription' => '**Request parameters**'."\n" + ."\n" + .'|Parameter|Type|Required|Example|Description|'."\n" + .'|---|---|---|---|---|'."\n" + .'|id|String|No|"2f12c585-5873-11ea-974a-7cd30ad3e268"|The task ID.|'."\n" + .'|enabled|Boolean|No|true|Specifies whether the scheduled task is enabled.|'."\n" + .'|updated|Integer|No|1582706232|The timestamp when the scheduled task was last updated.|', + 'responseParamsDescription' => ' ', + 'extraInfo' => ' ', + ], + 'CreateScheduledTask' => [ + 'summary' => 'Creates a scheduled task for an OpenSearch application.', + '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' => 'The name of the application.'."\n", + 'type' => 'string', + 'required' => true, + 'docRequired' => true, + 'example' => 'my_app_group_name', + ], + ], + [ + 'name' => 'body', + 'in' => 'body', + 'schema' => [ + 'description' => 'The request body.'."\n", + 'required' => false, + '$ref' => '#/components/schemas/ScheduledTask', + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'type' => 'object', + 'properties' => [ + 'result' => [ + 'description' => 'For more information about a scheduled task, see [ScheduledTask](~~173610~~).'."\n", + 'type' => 'object', + 'example' => '{}', + ], + 'requestId' => [ + 'description' => 'The request ID.'."\n", + 'type' => 'string', + 'example' => 'ABCDEFGH', + ], + ], + 'description' => '', + ], + ], + '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":"<requestId>0BECF34E-125A-D35F-1E5D-ABB66B11FAB8</requestId>\\n<result>\\n <id>cfd5ebe9-bcdd-11ea-a58d-98039b07e4ec</id>\\n <progress>0</progress>\\n <status>3</status>\\n <lastRanTimestamp/>\\n <type>wipe</type>\\n <running>false</running>\\n <paused>false</paused>\\n <finished>false</finished>\\n <idle>true</idle>\\n <created>1593747144</created>\\n <updated>1593747144</updated>\\n <cron>0 0 * * 1,2,3,4,5,6,7</cron>\\n <enabled>true</enabled>\\n <lastScheduledTimestamp/>\\n <forkedAppId/>\\n <filter>\\n <field>title</field>\\n <days>30</days>\\n <unit>s</unit>\\n </filter>\\n</result>","errorExample":""}]', + 'title' => 'CreateScheduledTask', + 'requestParamsDescription' => '**Request body**'."\n" + ."\n" + .'|Parameter|Type|Required|Example|Description|'."\n" + .'|---|---|---|---|---|'."\n" + .'|type|String|Yes|"wipe"|The type of the scheduled task. Valid values:wipe: data scrubbingfork: data import and reindexingreindex: reindexingclear: data clearing|'."\n" + .'|cron|String|Yes|"10 20 \\* \\* 1,2,3,4,5"|The configuration of the scheduled task. For more information, see [cron field in ScheduledTask](~~173611~~).|'."\n" + .'|enabled|Boolean|Yes|true|Specify whether the scheduled task is enabled.|'."\n" + .'|appStrategy|String|No|delete-idle|The policy for creating a new version. Valid values:delete-idle: Two versions exist. Delete the non-online version first and then create a new version.need-slot: Only one version exists. Create a new version directly.|'."\n" + .'|filter|Object|No||The conditions that are used to delete data.|'."\n" + .'|filter.days|Integer|Yes|7|The remaining validity period.Valid values: \\[7,180\\]. Unit: days.|'."\n" + .'|filter.unit|String|Yes|"s"|The unit of the expiration time of the field. Valid values:s: secondsms: milliseconds|'."\n" + .'|filter.field|String|No|"cate\\_id"|The field that the task clears based on the expiration settings.|'."\n" + .'|runNow|Boolean|No|false|Specifies whether to immediately execute the task. Default value: false.|'."\n" + .'|permanent|Boolean|No|true|Specifies whether the scheduled task can always be executed. Default value: true.|', + 'responseParamsDescription' => ' ', + 'extraInfo' => ' ', + ], + 'DescribeScheduledTask' => [ + 'summary' => '查看应用定时任务详情', + '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' => 'The name of the application', + 'type' => 'string', + 'required' => true, + 'docRequired' => true, + 'example' => 'my_app_group_name', + ], + ], + [ + 'name' => 'taskId', + 'in' => 'path', + 'schema' => [ + 'description' => 'The ID of the task.', + 'type' => 'string', + 'required' => true, + 'docRequired' => true, + 'example' => '2f12c585-5873-11ea-974a-7cd30ad3e268', + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'type' => 'object', + 'properties' => [ + 'result' => [ + 'description' => 'The details of the scheduled task.'."\n", + 'type' => 'object', + 'example' => '{}', + ], + 'requestId' => [ + 'description' => 'The ID of the request.'."\n", + '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":"<requestId>922DC0D9-31B5-45F9-47B7-37DC678D61A8</requestId>\\n<result>\\n <id>2f12c585-5873-11ea-974a-7cd30ad3e268</id>\\n <progress>60</progress>\\n <status>0</status>\\n <lastRanTimestamp>1593755495</lastRanTimestamp>\\n <type>wipe</type>\\n <running>true</running>\\n <paused>false</paused>\\n <finished>false</finished>\\n <idle>false</idle>\\n <created>1593747144</created>\\n <updated>1593755504</updated>\\n <cron>0 0 * * 1,2,3,4,5,6,7</cron>\\n <enabled>true</enabled>\\n <appId/>\\n <appGroupId>110091051</appGroupId>\\n <ownerId>84</ownerId>\\n <lastScheduledTimestamp/>\\n <forkedAppId>100304004</forkedAppId>\\n <appGroup>\\n <id>110091051</id>\\n </appGroup>\\n <owner>\\n <id>84</id>\\n </owner>\\n <filter>\\n <field>title</field>\\n <days>30</days>\\n <unit>s</unit>\\n </filter>\\n</result>","errorExample":""}]', + 'title' => 'DescribeScheduledTask', + ], + 'ModifyScheduledTask' => [ + 'summary' => 'Modifies a scheduled task.', + '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' => 'The application name or ID.'."\n", + 'type' => 'string', + 'required' => true, + 'docRequired' => true, + 'example' => '121414148', + ], + ], + [ + 'name' => 'taskId', + 'in' => 'path', + 'schema' => [ + 'description' => 'The task ID.'."\n", + 'type' => 'string', + 'required' => true, + 'docRequired' => true, + 'example' => '56e9c2e7-5a4d-481a-9f1b-b07da6909450', + ], + ], + [ + 'name' => 'body', + 'in' => 'body', + 'schema' => [ + 'description' => 'The request parameters.'."\n", + 'type' => 'any', + 'required' => false, + 'example' => 'The request parameters.'."\n", + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'type' => 'object', + 'properties' => [ + 'result' => [ + 'description' => 'The information about the scheduled task.'."\n", + 'type' => 'object', + 'example' => 'Array', + ], + 'requestId' => [ + 'description' => 'The request ID.'."\n", + 'type' => 'string', + 'example' => 'D77D0DAF-790D-F5F5-A9C0-133738165014', + ], + ], + 'description' => '', + ], + ], + '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' => 'ModifyScheduledTask', + ], + 'RemoveScheduledTask' => [ + 'summary' => 'Deletes a scheduled task of an OpenSearch application.', + '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' => 'The name of the application.'."\n", + 'type' => 'string', + 'required' => true, + 'docRequired' => true, + 'example' => '“my_app_group_name”', + ], + ], + [ + 'name' => 'taskId', + 'in' => 'path', + 'schema' => [ + 'description' => 'The task ID.'."\n", + 'type' => 'string', + 'required' => true, + 'docRequired' => true, + 'example' => '“2f12c585-5873-11ea-974a-7cd30ad3e268”', + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'type' => 'object', + 'properties' => [ + 'requestId' => [ + 'description' => 'The request ID.'."\n", + 'type' => 'string', + 'example' => '0A6EB64B-B4C8-CF02-810F-E660812972FF', + ], + 'result' => [ + 'description' => 'The returned results.'."\n", + 'type' => 'array', + 'items' => [ + 'description' => 'The result list that is returned. This parameter is not returned if the request is successful.'."\n", + 'type' => 'integer', + 'format' => 'int32', + 'example' => '1', + ], + ], + ], + 'description' => '', + ], + ], + '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":"<requestId>0A6EB64B-B4C8-CF02-810F-E660812972FF</requestId>","errorExample":""}]', + 'title' => 'RemoveScheduledTask', + 'requestParamsDescription' => ' ', + 'responseParamsDescription' => ' ', + 'extraInfo' => ' ', + ], + 'ListSortExpressions' => [ + 'summary' => 'Queries a list of sort expressions that are configured for a version of an OpenSearch application.', + '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' => 'The application name.'."\n", + 'type' => 'string', + 'required' => true, + 'docRequired' => true, + 'example' => 'my_app_group_name', + ], + ], + [ + 'name' => 'appId', + 'in' => 'path', + 'schema' => [ + 'description' => 'The version ID.'."\n", + 'type' => 'integer', + 'format' => 'int32', + 'required' => true, + 'docRequired' => true, + 'maximum' => '999999999', + 'minimum' => '1', + 'example' => '110116134', + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'type' => 'object', + 'properties' => [ + 'requestId' => [ + 'description' => 'The request ID.'."\n", + 'type' => 'string', + 'example' => 'D77D0DAF-790D-F5F5-A9C0-133738165014', + ], + 'result' => [ + 'description' => 'The information about the rough sort or fine sort expressions that are returned.'."\n" + ."\n" + .'For more information, see [FirstRank](~~170007~~) and [SecondRank](~~170008~~).'."\n", + 'type' => 'array', + 'items' => [ + 'type' => 'object', + 'properties' => [ + 'created' => [ + 'description' => 'The timestamp when the sort expression was created.'."\n", + 'type' => 'integer', + 'format' => 'int32', + 'example' => '1655793690', + ], + 'active' => [ + 'description' => 'Indicates whether the expression is the default one.'."\n", + 'type' => 'boolean', + 'example' => 'true', + ], + 'description' => [ + 'description' => 'The description of the sort expression.'."\n", + 'type' => 'string', + 'example' => '""', + ], + 'updated' => [ + 'description' => 'The timestamp when the sort expression was updated.'."\n", + 'type' => 'integer', + 'format' => 'int32', + 'example' => '1655793690', + ], + 'name' => [ + 'description' => 'The name of the sort expression.'."\n", + 'type' => 'string', + 'example' => 'default', + ], + ], + ], + ], + ], + 'description' => '', + ], + ], + '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":"<requestId>D77D0DAF-790D-F5F5-A9C0-133738165014</requestId>\\n<result>\\n <name>default</name>\\n <description/>\\n <active>true</active>\\n <meta>\\n <attribute>static_bm25()</attribute>\\n <arg/>\\n <weight>1</weight>\\n </meta>\\n <created>1655793690</created>\\n <updated>1655793690</updated>\\n</result>\\n<result>\\n <name>default</name>\\n <meta/>\\n <active>false</active>\\n <description/>\\n <created>0</created>\\n <updated>0</updated>\\n <isDefault>false</isDefault>\\n <isSys>true</isSys>\\n</result>\\n<result>\\n <name>tests</name>\\n <meta>random()+now()</meta>\\n <active>true</active>\\n <description/>\\n <created>1587052801</created>\\n <updated>1587052801</updated>\\n <isDefault>true</isDefault>\\n <isSys>false</isSys>\\n</result>\\n<result>\\n <name>test</name>\\n <meta>query_term_count()</meta>\\n <active>false</active>\\n <description/>\\n <created>1587052801</created>\\n <updated>1587052801</updated>\\n <isDefault>false</isDefault>\\n <isSys>false</isSys>\\n</result>\\n<totalCount>4</totalCount>","errorExample":""}]', + 'title' => 'ListSortExpressions', + 'requestParamsDescription' => '**Paging parameters**'."\n" + ."\n" + .'|Parameter|Type|Required|Example|Description|'."\n" + .'|---|---|---|---|---|'."\n" + .'|pageNumber|Integer|No|1|The page number. Default value: 1.|'."\n" + .'|pageSize|Integer|No|10|The number of entries per page. Default value: 10.|', + 'responseParamsDescription' => ' ', + 'extraInfo' => ' ', + ], + 'UnbindEsInstance' => [ + 'summary' => 'Unbinds an Elasticsearch instance from an OpenSearch application.', + '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' => 'The name of the application.'."\n", + 'type' => 'string', + 'required' => true, + 'docRequired' => true, + 'example' => '"my_app_group_name"', + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'type' => 'object', + 'properties' => [ + 'result' => [ + 'description' => 'The data returned.'."\n", + 'type' => 'object', + 'example' => '{}', + ], + 'requestId' => [ + 'description' => 'The ID of the request.'."\n", + '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' => 'UnbindEsInstance', + ], + 'BindEsInstance' => [ + 'summary' => 'Binds an Elasticsearch instance.', + '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' => 'The name of the application.'."\n", + 'type' => 'string', + 'required' => true, + 'docRequired' => true, + 'example' => 'my_app_group_name', + ], + ], + [ + 'name' => 'body', + 'in' => 'body', + 'style' => 'json', + 'schema' => [ + 'type' => 'object', + 'required' => false, + 'description' => 'The body of the request.'."\n", + 'example' => '{'."\n" + .' "esInstanceId": "es-cn-abcde"'."\n" + .'}', + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'description' => '', + 'type' => 'object', + 'properties' => [ + 'result' => [ + 'description' => 'The result'."\n", + 'type' => 'object', + 'example' => '[]', + ], + 'requestId' => [ + 'description' => 'The ID of the request.'."\n", + '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' => 'BindEsInstance', + ], + 'BindESUserAnalyzer' => [ + 'summary' => 'Binds a custom analyzer to an Elasticsearch instance.', + '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' => 'The name of the application.'."\n", + 'type' => 'string', + 'required' => true, + 'docRequired' => true, + 'example' => '130187460', + ], + ], + [ + 'name' => 'esInstanceId', + 'in' => 'path', + 'schema' => [ + 'description' => 'The ID of the instance.'."\n", + 'type' => 'string', + 'required' => true, + 'docRequired' => true, + 'example' => 'es-cn-zvp2g952l000v5uxp', + ], + ], + [ + 'name' => 'body', + 'in' => 'body', + 'schema' => [ + 'description' => 'The request parameters.'."\n", + 'type' => 'any', + 'required' => false, + 'example' => '{'."\n" + .' "name": "kevintest-analyzer"'."\n" + .'}', + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'description' => 'The response body.'."\n", + 'type' => 'object', + 'properties' => [ + 'result' => [ + 'description' => 'The custom analyzer.'."\n", + 'type' => 'object', + 'example' => '[]', + ], + 'requestId' => [ + 'description' => 'The ID of the request.'."\n", + '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' => 'BindESUserAnalyzer', + ], + 'UnbindESUserAnalyzer' => [ + 'summary' => 'Unbinds a custom analyzer from an Elasticsearch instance.', + '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' => 'The name of the application.'."\n", + 'type' => 'string', + 'required' => true, + 'docRequired' => true, + 'example' => 'my_app_group_name', + ], + ], + [ + 'name' => 'esInstanceId', + 'in' => 'path', + 'schema' => [ + 'description' => 'The ID of the instance.'."\n", + 'type' => 'string', + 'required' => true, + 'docRequired' => true, + 'example' => 'es-cn-zvp2ff3iq000myzv7', + ], + ], + [ + 'name' => 'body', + 'in' => 'body', + 'schema' => [ + 'description' => 'The request parameters.'."\n", + 'type' => 'any', + 'required' => false, + 'example' => '{'."\n" + .' "name": "kevintest-analyzer"'."\n" + .'}', + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'description' => 'The response body.'."\n", + 'type' => 'object', + 'properties' => [ + 'result' => [ + 'description' => 'The custom analyzer.'."\n", + 'type' => 'object', + 'example' => '[]', + ], + 'requestId' => [ + 'description' => 'The ID of the request.'."\n", + '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' => 'UnbindESUserAnalyzer', + 'description' => 'You can call this operation to unbind a custom analyzer from an Elasticsearch instance.'."\n", + ], + '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' => 'The ID of the application instance group.'."\n", + 'type' => 'string', + 'required' => true, + 'docRequired' => true, + 'example' => '120677456', + ], + ], + [ + 'name' => 'filterFinished', + 'in' => 'query', + 'schema' => [ + 'description' => 'Specifies whether the filtering is complete.'."\n", + 'type' => 'boolean', + 'required' => false, + 'example' => 'true', + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'title' => 'Schema of Response', + 'description' => 'The schema of the response.'."\n", + 'type' => 'object', + 'properties' => [ + 'requestId' => [ + 'title' => 'Id of the request', + 'description' => 'The ID of the request.'."\n", + 'type' => 'string', + 'example' => 'F5099063-6B86-F398-D843-905F9EFB683A', + ], + ], + 'example' => '{}', + ], + ], + ], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"requestId\\": \\"F5099063-6B86-F398-D843-905F9EFB683A\\"\\n}","type":"json"}]', + 'title' => 'ListProceedings', + ], + 'ListStatisticLogs' => [ + 'summary' => 'Queries log statistics, such as application error logs, hotword rankings, and slow query logs.', + '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' => 'The application name.'."\n", + 'type' => 'string', + 'required' => true, + 'docRequired' => true, + 'example' => 'app_group_name', + ], + ], + [ + 'name' => 'moduleName', + 'in' => 'path', + 'schema' => [ + 'description' => 'The module name. Valid values:'."\n" + ."\n" + .'* hot: rankings of hotwords.'."\n" + .'* error: application error logs.'."\n" + .'* slow-log: slow query logs.'."\n" + ."\n" + .'Set the value to hot.'."\n", + 'type' => 'string', + 'required' => true, + 'docRequired' => true, + 'example' => 'hot', + ], + ], + [ + 'name' => 'startTime', + 'in' => 'query', + 'schema' => [ + 'description' => 'The beginning of the time range to query. The default value is the timestamp of 00:00:00 on the current day.'."\n", + 'type' => 'integer', + 'format' => 'int32', + 'required' => false, + 'maximum' => '9999999999', + 'minimum' => '0', + 'example' => '1582214400', + ], + ], + [ + 'name' => 'stopTime', + 'in' => 'query', + 'schema' => [ + 'description' => 'The end of the time range to query. The default value is the timestamp of 24:00:00 on the current day.'."\n", + 'type' => 'integer', + 'format' => 'int32', + 'required' => false, + 'maximum' => '9999999999', + 'minimum' => '0', + 'example' => '1682222400', + ], + ], + [ + 'name' => 'pageNumber', + 'in' => 'query', + 'schema' => [ + 'description' => 'The page number. Default value: 1.'."\n", + 'type' => 'integer', + 'format' => 'int32', + 'required' => false, + 'maximum' => '1000', + 'minimum' => '1', + 'example' => '1', + ], + ], + [ + 'name' => 'pageSize', + 'in' => 'query', + 'schema' => [ + 'description' => 'The number of entries per page. Default value: 10.'."\n", + 'type' => 'integer', + 'format' => 'int32', + 'required' => false, + 'maximum' => '10000', + 'minimum' => '1', + 'example' => '10', + ], + ], + [ + 'name' => 'query', + 'in' => 'query', + 'schema' => [ + 'description' => 'The content of the query clause.'."\n", + 'type' => 'string', + 'required' => false, + 'example' => '"default:\'OpenSearch\'"', + ], + ], + [ + 'name' => 'sortBy', + 'in' => 'query', + 'schema' => [ + 'description' => 'The content of the sort clause.'."\n", + 'type' => 'string', + 'required' => false, + 'example' => '"-id"', + ], + ], + [ + 'name' => 'distinct', + 'in' => 'query', + 'schema' => [ + 'description' => 'Specifies whether to use the distinct clause.'."\n", + 'type' => 'boolean', + 'required' => false, + 'example' => 'true', + ], + ], + [ + 'name' => 'columns', + 'in' => 'query', + 'schema' => [ + 'description' => 'The fields to query. Format: columns=wordsTopPv.'."\n" + ."\n" + .'For more information, see [Metrics in statistical reports](~~187665~~).'."\n", + 'type' => 'string', + 'required' => false, + 'example' => 'wordsTopPv', + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'description' => 'The response parameters.'."\n", + 'type' => 'object', + 'properties' => [ + 'totalCount' => [ + 'description' => 'The total number of entries returned.'."\n", + 'type' => 'integer', + 'format' => 'int64', + 'example' => '1', + ], + 'requestId' => [ + 'description' => 'The request ID.'."\n", + 'type' => 'string', + 'example' => 'F76ACE3D-E510-EE2C-B7B1-39B3136A61EE', + ], + 'result' => [ + 'description' => 'The returned result. For more information, see'."\n" + ."\n" + .'* [Parameters of hotwords rankings](~~421248~~).'."\n", + 'type' => 'array', + 'items' => [ + 'description' => 'The returned result. For more information, see'."\n" + ."\n" + .'* [Parameters of hotwords rankings](~~187660~~).'."\n", + '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' => '[{"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":"<requestId>F76ACE3D-E510-EE2C-B7B1-39B3136A61EE</requestId>\\n<result>\\n <rawQuery>淘宝</rawQuery>\\n <pv>100</pv>\\n</result>\\n<totalCount>1</totalCount>","errorExample":""}]', + 'title' => 'ListStatisticLogs', + 'requestParamsDescription' => ' ', + 'responseParamsDescription' => '**Parameters of hotwords rankings**'."\n" + ."\n" + .'|Parameter|Type|Description|'."\n" + .'|---|---|---|'."\n" + .'|rawQuery|String|The hotword.|'."\n" + .'|pv|Integer|The number of page views.|', + 'extraInfo' => ' ', + ], + 'ListStatisticReport' => [ + 'summary' => 'Queries statistical reports, such as application reports, drop-down suggestion reports, hotword shading reports, A/B test reports, and data quality reports.', + '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' => 'The name of the application'."\n", + 'type' => 'string', + 'required' => true, + 'docRequired' => true, + 'example' => 'app_group_name', + ], + ], + [ + 'name' => 'moduleName', + 'in' => 'path', + 'schema' => [ + 'description' => 'The module name. Valid values:'."\n" + ."\n" + .'* app: Business operation report.'."\n" + .'* app-query: Business operation report> Query analysis metric.'."\n" + .'* abtest: A/B test report.'."\n" + .'* suggest: Drop-down suggestion report.'."\n" + .'* hot: Hotword report.'."\n" + .'* hint: Shading report'."\n" + .'* data-quality'."\n" + .'* es: Open-source compatible instance report'."\n", + 'type' => 'string', + 'required' => true, + 'docRequired' => true, + 'example' => 'suggest', + ], + ], + [ + 'name' => 'startTime', + 'in' => 'query', + 'schema' => [ + 'description' => 'The start timestamp of the query. Unit: seconds.'."\n", + 'type' => 'integer', + 'format' => 'int32', + 'required' => false, + 'maximum' => '9999999999', + 'minimum' => '0', + 'example' => '1582214400', + ], + ], + [ + 'name' => 'endTime', + 'in' => 'query', + 'schema' => [ + 'description' => 'The end timestamp of the query. By default, the end time is the current time. Unit: seconds.'."\n", + 'type' => 'integer', + 'format' => 'int32', + 'required' => false, + 'maximum' => '9999999999', + 'minimum' => '0', + 'example' => '1582646399', + ], + ], + [ + 'name' => 'pageNumber', + 'in' => 'query', + 'schema' => [ + 'description' => 'The page number.'."\n" + ."\n" + .'Default value: 1.'."\n", + 'type' => 'integer', + 'format' => 'int32', + 'required' => false, + 'maximum' => '100', + 'minimum' => '1', + 'example' => '1', + ], + ], + [ + 'name' => 'pageSize', + 'in' => 'query', + 'schema' => [ + 'description' => 'The number of entries per page. Default value: 10.'."\n", + 'type' => 'integer', + 'format' => 'int32', + 'required' => false, + 'maximum' => '10000', + 'minimum' => '1', + 'example' => '10', + ], + ], + [ + 'name' => 'columns', + 'in' => 'query', + 'schema' => [ + 'description' => 'The fields to query. Set this parameter in the format of columns="pv,uv,ipv". For more information, see [Metrics of statistical reports](~~187665~~).', + 'type' => 'string', + 'required' => false, + 'example' => 'pv,uv', + ], + ], + [ + 'name' => 'query', + 'in' => 'query', + 'schema' => [ + 'description' => 'The query conditions. Set this parameter in the format of k1:v1,k2:v2. Valid values:'."\n" + ."\n" + .'* experimentSerialNumber: the globally unique sequence number of the test'."\n" + .'* sceneTag: the tag of the test scenario'."\n" + .'* bizType: the type of the business'."\n" + .'* modelId: the ID of the algorithm model'."\n", + 'type' => 'string', + 'required' => false, + 'example' => 'bizType:test,sceneTag:myTag', + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'description' => 'The rsponse body.'."\n", + 'type' => 'object', + 'properties' => [ + 'totalCount' => [ + 'description' => 'The total number of entries returned.'."\n", + 'type' => 'integer', + 'format' => 'int64', + 'example' => '43', + ], + 'requestId' => [ + 'description' => 'The request ID.'."\n", + 'type' => 'string', + 'example' => 'F65C8BB2-C14F-5983-888B-41C4E082D3BC', + ], + 'result' => [ + 'description' => 'The statistical reports. Valid values:'."\n" + ."\n" + .'* For more information about the metrics in data quality reports, see the Upload behavioral data section of [Data collection 2.0](~~131547~~).'."\n" + .'* For more information about the metrics in application and A/B test reports, see the Core metrics section of [Metrics of statistical reports](~~187665~~).'."\n" + .'* For more information about the metrics in query analysis reports, see the Query analysis metrics section of [Metrics of statistical reports](~~187665~~).'."\n", + 'type' => 'array', + 'items' => [ + 'description' => 'The result body.'."\n", + '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' => 'ListStatisticReport', + ], + 'UpdateSortScript' => [ + 'summary' => 'Modifies the description of a sort script.', + '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' => 'The name of the application or the ID of the application.'."\n", + 'type' => 'string', + 'required' => true, + 'docRequired' => true, + 'example' => 'my_app', + ], + ], + [ + 'name' => 'appVersionId', + 'in' => 'path', + 'schema' => [ + 'description' => 'The version number of the application.'."\n", + 'type' => 'string', + 'required' => true, + 'docRequired' => true, + 'example' => '123456', + ], + ], + [ + 'name' => 'scriptName', + 'in' => 'path', + 'schema' => [ + 'description' => 'The name of the script.'."\n", + 'type' => 'string', + 'required' => true, + 'docRequired' => true, + 'example' => 'test_cava', + ], + ], + [ + 'name' => 'body', + 'in' => 'body', + 'style' => 'json', + 'schema' => [ + 'title' => '请求体内容', + 'type' => 'object', + 'properties' => [ + 'description' => [ + 'title' => '脚本备注', + 'type' => 'string', + ], + ], + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'description' => 'The response body.'."\n", + 'type' => 'object', + 'properties' => [ + 'requestId' => [ + 'description' => 'The ID of the request.'."\n", + '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' => 'UpdateSortScript', + 'description' => 'You can call this operation to modify the description of a sort script.'."\n", + 'responseParamsDescription' => '**Examples**'."\n" + ."\n" + .'Sample requests'."\n" + ."\n" + .' PUT /v4/openapi/app-groups/my_app/apps/123456/sort-scripts/test_cava'."\n" + .' {'."\n" + .' "description" : "just for test"'."\n" + .' }'."\n" + ."\n" + .'Sample success responses'."\n" + ."\n" + .'XML format'."\n" + ."\n" + .' <requestId>ABCDEFGH</requestId>'."\n" + ."\n" + .'JSON format'."\n" + ."\n" + .' {"requestId":"ABCDEFGH"}'."\n", + ], + 'SaveSortScriptFile' => [ + 'summary' => 'Uploads a sort script.', + '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' => 'The name or ID of the application.'."\n", + 'type' => 'string', + 'required' => true, + 'docRequired' => true, + 'example' => '\'\'1111\'\'', + ], + ], + [ + 'name' => 'scriptName', + 'in' => 'path', + 'schema' => [ + 'description' => 'The name of the script whose content you want to update.'."\n", + 'type' => 'string', + 'required' => true, + 'docRequired' => true, + 'example' => '\'\'11111\'\'', + ], + ], + [ + 'name' => 'appVersionId', + 'in' => 'path', + 'schema' => [ + 'description' => 'The version number of the application.'."\n", + 'type' => 'string', + 'required' => true, + 'docRequired' => true, + 'example' => '\'\'111111\'\'', + ], + ], + [ + 'name' => 'fileName', + 'in' => 'path', + 'schema' => [ + 'description' => 'The file name.'."\n", + 'type' => 'string', + 'required' => true, + 'docRequired' => true, + 'example' => '\'\'11111\'\'', + ], + ], + [ + 'name' => 'body', + 'in' => 'body', + 'style' => 'json', + 'schema' => [ + 'description' => 'The information about the script content.'."\n", + 'type' => 'object', + 'properties' => [ + 'content' => [ + 'description' => 'The script content that is encoded in the Base64 format.'."\n", + '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' => 'The version number of the script content.'."\n", + 'type' => 'integer', + 'format' => 'int32', + 'required' => false, + 'example' => '2022-12-01', + ], + ], + 'required' => false, + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'description' => 'The response parameters.'."\n", + 'type' => 'object', + 'properties' => [ + 'requestId' => [ + 'description' => 'The request ID.'."\n", + '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":"<requestId>ABCDEFGH</requestId>","errorExample":""}]', + 'title' => 'SaveSortScriptFile', + 'requestParamsDescription' => '## scriptContent'."\n" + ."\n" + .'|Parameter|Type|Required|Description|'."\n" + .'|---|---|---|---|'."\n" + .'|content|String|Yes|The script content that is encoded in the Base64 format.|'."\n" + .'|version|Integer|No|The version number of the script content. This version number is used to ensure that the script content is updated in order when the script content is concurrently updated by multiple users. Default value: the current time.|', + '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' => '\'\'1234\'\''."\n", + 'type' => 'string', + 'required' => true, + 'docRequired' => true, + 'example' => '\'\'1234\'\'', + ], + ], + [ + 'name' => 'scriptName', + 'in' => 'path', + 'schema' => [ + 'description' => '\'\'test\'\''."\n", + 'type' => 'string', + 'required' => true, + 'docRequired' => true, + 'example' => '\'\'test\'\'', + ], + ], + [ + 'name' => 'appVersionId', + 'in' => 'path', + 'schema' => [ + 'description' => '\'\'12345\'\''."\n", + 'type' => 'string', + 'required' => true, + 'docRequired' => true, + 'example' => '\'\'12345\'\'', + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'type' => 'object', + 'properties' => [ + 'requestId' => [ + 'description' => 'The ID of the request.'."\n", + '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":"<requestId>ABCDEFGH</requestId>","errorExample":""}]', + 'title' => 'ReleaseSortScript', + 'requestParamsDescription' => ' ', + 'responseParamsDescription' => ' ', + ], + 'GetSortScriptFile' => [ + 'summary' => 'Queries the content of a sort script.', + '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' => 'The name or ID of the application.'."\n", + 'type' => 'string', + 'required' => true, + 'docRequired' => true, + 'example' => 'my_app', + ], + ], + [ + 'name' => 'scriptName', + 'in' => 'path', + 'schema' => [ + 'description' => 'The name of the script.'."\n", + 'type' => 'string', + 'required' => true, + 'docRequired' => true, + 'example' => 'UserScorer.cava', + ], + ], + [ + 'name' => 'appVersionId', + 'in' => 'path', + 'schema' => [ + 'description' => 'The version ID of the application.'."\n", + 'type' => 'string', + 'required' => true, + 'docRequired' => true, + 'example' => '123456', + ], + ], + [ + 'name' => 'fileName', + 'in' => 'path', + 'schema' => [ + 'description' => 'The name of the script file.'."\n", + 'type' => 'string', + 'required' => true, + 'docRequired' => true, + 'example' => 'script1', + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'type' => 'object', + 'properties' => [ + 'requestId' => [ + 'description' => 'The request ID.'."\n", + 'type' => 'string', + 'example' => 'ABCDEFGH', + ], + 'result' => [ + 'description' => 'The content of the sort script.'."\n", + 'type' => 'object', + 'properties' => [ + 'content' => [ + 'description' => 'The script content that is encoded in the Base64 format.'."\n", + 'type' => 'string', + 'example' => 'YWJjZGVmZw==', + ], + 'createTime' => [ + 'description' => 'The time when the script was created.'."\n", + 'type' => 'string', + 'example' => '2020-04-02 20:21:14', + ], + 'modifyTime' => [ + 'description' => 'The time when the script was last modified.'."\n", + 'type' => 'string', + 'example' => '2020-04-02 21:21:14', + ], + 'version' => [ + 'description' => 'The version of the script content.'."\n", + 'type' => 'integer', + 'format' => 'int64', + 'example' => '123456', + ], + ], + ], + ], + 'description' => '', + ], + ], + '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":"<requestId>ABCDEFGH</requestId>\\n<result>\\n <content>YWJjZGVmZw==</content>\\n <version>123456</version>\\n</result>","errorExample":""}]', + 'title' => 'GetSortScriptFile', + 'requestParamsDescription' => ' ', + 'responseParamsDescription' => ' Error response{'."\n" + .' "requestId" : "ABCDEFGH",'."\n" + .' "code":"ResourceNotFound",'."\n" + .' "message":"The specified script not found.",'."\n" + .' "httpCode":404'."\n" + .' }'."\n", + 'extraInfo' => ' ', + ], + 'GetSortScript' => [ + 'summary' => 'Queries the details of a sort script.', + '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' => 'The name or ID of the application.'."\n", + 'type' => 'string', + 'required' => true, + 'docRequired' => true, + 'enumValueTitles' => [], + 'example' => 'my_app', + ], + ], + [ + 'name' => 'scriptName', + 'in' => 'path', + 'schema' => [ + 'description' => 'The name of the script.'."\n", + 'type' => 'string', + 'required' => true, + 'docRequired' => true, + 'enumValueTitles' => [], + 'example' => 'script1', + ], + ], + [ + 'name' => 'appVersionId', + 'in' => 'path', + 'schema' => [ + 'description' => 'The version ID of the application.'."\n", + 'type' => 'string', + 'required' => true, + 'docRequired' => true, + 'enumValueTitles' => [], + 'example' => '160051478', + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'type' => 'object', + 'properties' => [ + 'requestId' => [ + 'description' => 'The request ID.'."\n", + 'type' => 'string', + 'enumValueTitles' => [], + 'example' => 'ABCDEFGH', + ], + 'result' => [ + 'description' => 'The details of the script.'."\n", + 'type' => 'object', + 'properties' => [ + 'scope' => [ + 'description' => 'The sort phase to which the script applies.'."\n", + 'type' => 'string', + 'example' => 'second_rank', + ], + 'createTime' => [ + 'description' => 'The time when the script was created.'."\n", + 'type' => 'string', + 'example' => '2020-04-02 20:21:14', + ], + 'status' => [ + 'description' => 'The status of the script. For more information, see the description of the status response parameter in the ListSortScripts topic.'."\n", + 'type' => 'string', + 'example' => 'released', + ], + 'modifyTime' => [ + 'description' => 'The time when the script was last modified.'."\n", + 'type' => 'string', + 'example' => '2020-04-02 21:21:14', + ], + 'type' => [ + 'description' => 'The type of the script.', + 'type' => 'string', + 'enumValueTitles' => [], + 'example' => 'cava_script', + ], + 'scriptName' => [ + 'description' => 'The name of the script.'."\n", + 'type' => 'string', + 'example' => 'rank_cava_20230606_v7'."\n", + ], + 'description' => [ + 'title' => '脚本备注', + 'type' => 'string', + ], + ], + ], + ], + 'enumValueTitles' => [], + 'description' => '', + ], + ], + '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' => 'GetSortScript', + 'responseParamsDescription' => ' Error response{'."\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' => 'my_app'."\n", + 'type' => 'string', + 'required' => true, + 'docRequired' => true, + 'example' => 'my_app', + ], + ], + [ + 'name' => 'appVersionId', + 'in' => 'path', + 'schema' => [ + 'description' => '123456'."\n", + 'type' => 'string', + 'required' => true, + 'docRequired' => true, + 'example' => '123456', + ], + ], + [ + 'name' => 'scriptName', + 'in' => 'path', + 'schema' => [ + 'description' => 'file_names'."\n", + 'type' => 'string', + 'required' => true, + 'docRequired' => true, + 'example' => 'file_names', + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'type' => 'object', + 'properties' => [ + 'requestId' => [ + 'description' => 'The ID of the request.'."\n", + 'type' => 'string', + 'example' => 'ABCDEFGH', + ], + 'result' => [ + 'description' => 'The files of the script.'."\n", + 'type' => 'array', + 'items' => [ + 'type' => 'object', + 'properties' => [ + 'createTime' => [ + 'description' => 'The time when the script file was created.'."\n", + 'type' => 'string', + 'example' => '2020-04-02 20:21:14', + ], + 'fileName' => [ + 'description' => 'The name of the script file.'."\n", + 'type' => 'string', + 'example' => 'my_cava_script.cava', + ], + 'modifyTime' => [ + 'description' => 'The time when the script file was last modified.'."\n", + 'type' => 'string', + 'example' => '2020-04-02 21:21:14', + ], + 'pathName' => [ + 'description' => 'The path name of the script file.', + '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":"<requestId>ABCDEFGH</requestId>\\n<result>\\n <fileName>my_cava_script.cava</fileName>\\n <pathName>src</pathName>\\n <createTime>2020-04-02 20:21:14</createTime>\\n <modifyTime>2020-04-02 21:21:14</modifyTime>\\n</result>","errorExample":""}]', + 'title' => 'GetScriptFileNames', + 'requestParamsDescription' => ' ', + 'extraInfo' => ' ', + ], + 'DeleteSortScriptFile' => [ + 'summary' => 'Deletes a script file.', + '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' => 'The name of the application'."\n", + 'type' => 'string', + 'required' => true, + 'docRequired' => true, + 'example' => 'search', + ], + ], + [ + 'name' => 'appVersionId', + 'in' => 'path', + 'schema' => [ + 'description' => 'The version ID.'."\n", + 'type' => 'string', + 'required' => true, + 'docRequired' => true, + 'example' => '1234567', + ], + ], + [ + 'name' => 'scriptName', + 'in' => 'path', + 'schema' => [ + 'description' => 'The name of the script.'."\n", + 'type' => 'string', + 'required' => true, + 'docRequired' => true, + 'example' => 'cava', + ], + ], + [ + 'name' => 'fileName', + 'in' => 'path', + 'schema' => [ + 'description' => 'The name of the script file to delete.'."\n", + 'type' => 'string', + 'required' => true, + 'docRequired' => true, + 'example' => 'cavafile', + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'type' => 'object', + 'properties' => [ + 'requestId' => [ + 'description' => 'The request ID.'."\n", + 'type' => 'string', + 'example' => 'ABCDEFGH', + ], + ], + 'description' => '', + ], + ], + '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":"<requestId>ABCDEFGH</requestId>","errorExample":""}]', + 'title' => 'DeleteSortScriptFile', + 'requestParamsDescription' => ' ', + 'responseParamsDescription' => ' ', + 'extraInfo' => ' ', + 'translator' => 'machine', + ], + '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' => 'search'."\n", + 'type' => 'string', + 'required' => true, + 'docRequired' => true, + 'example' => 'search', + ], + ], + [ + 'name' => 'scriptName', + 'in' => 'path', + 'schema' => [ + 'description' => 'cava'."\n", + 'type' => 'string', + 'required' => true, + 'docRequired' => true, + 'example' => 'cava', + ], + ], + [ + 'name' => 'appVersionId', + 'in' => 'path', + 'schema' => [ + 'description' => '1234567'."\n", + 'type' => 'string', + 'required' => true, + 'docRequired' => true, + 'example' => '1234567', + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'type' => 'object', + 'properties' => [ + 'requestId' => [ + 'description' => 'The ID of the request.'."\n", + '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":"<requestId>ABCDEFGH</requestId>","errorExample":""}]', + 'title' => 'DeleteSortScript', + ], + 'CreateSortScript' => [ + 'summary' => 'Creates a sort script.', + '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' => 'The application name or ID.'."\n", + 'type' => 'string', + 'required' => true, + 'docRequired' => true, + 'example' => 'search', + ], + ], + [ + 'name' => 'appVersionId', + 'in' => 'path', + 'schema' => [ + 'description' => 'The ID of the report in the application.'."\n", + 'type' => 'string', + 'required' => true, + 'docRequired' => true, + 'example' => '1234567', + ], + ], + [ + 'name' => 'body', + 'in' => 'body', + 'style' => 'json', + 'schema' => [ + 'description' => 'The request body.'."\n", + 'type' => 'object', + 'properties' => [ + 'scriptName' => [ + 'description' => 'The script name.'."\n", + 'type' => 'string', + 'required' => false, + 'example' => 'rank_cava_20230606_v7', + ], + 'type' => [ + 'description' => 'The script type. Set the value to cava_script.'."\n", + 'type' => 'string', + 'required' => false, + 'example' => 'cava_script'."\n", + ], + 'scope' => [ + 'description' => 'The sort phase to which the script applies.'."\n", + 'type' => 'string', + 'required' => false, + 'example' => 'second_rank', + ], + 'description' => [ + 'title' => '脚本备注', + 'type' => 'string', + ], + ], + 'required' => false, + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'type' => 'object', + 'properties' => [ + 'requestId' => [ + 'description' => 'The request ID.'."\n", + 'type' => 'string', + 'example' => 'ABCDEFGH', + ], + 'result' => [ + 'description' => 'The response parameters.'."\n", + 'type' => 'object', + 'properties' => [ + 'scriptName' => [ + 'description' => 'The script name.'."\n", + 'type' => 'string', + 'example' => 'rank_cava_20230606_v7'."\n", + ], + 'type' => [ + 'description' => 'The script type.'."\n", + 'type' => 'string', + 'example' => 'cava_script', + ], + 'scope' => [ + 'description' => 'The sort phase to which the script applies.'."\n", + 'type' => 'string', + 'example' => 'second_rank', + ], + ], + ], + ], + 'description' => '', + ], + ], + '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":"<requestId>ABCDEFGH</requestId>","errorExample":""}]', + 'title' => 'CreateSortScript', + 'requestParamsDescription' => '**Request parameters**'."\n" + ."\n" + .'|Parameter|Type|Required|Description|'."\n" + .'|---|---|---|---|'."\n" + .'|scriptParams|Map|Yes|The parameters of the script to register.|'."\n" + ."\n\n" + .'**scriptParams**'."\n" + ."\n" + .'|Parameter|Type|Required|Description|'."\n" + .'|---|---|---|---|'."\n" + .'|scriptName|String|Yes|The script name.|'."\n" + .'|type|String|Yes|The script type. Set the value to cava\\_script.|'."\n" + .'|scope|String|Yes|The sort phase to which the script applies. Set the value to second\\_rank.|', + 'responseParamsDescription' => ' ', + 'extraInfo' => ' ', + ], + 'CompileSortScript' => [ + 'summary' => 'Compiles a sort script.', + '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' => 'The name and ID of the application.'."\n", + 'type' => 'string', + 'required' => true, + 'docRequired' => true, + 'example' => 'search', + ], + ], + [ + 'name' => 'scriptName', + 'in' => 'path', + 'schema' => [ + 'description' => 'The name of the script.'."\n", + 'type' => 'string', + 'required' => true, + 'docRequired' => true, + 'example' => 'script', + ], + ], + [ + 'name' => 'appVersionId', + 'in' => 'path', + 'schema' => [ + 'description' => 'The version ID of the application.'."\n", + 'type' => 'string', + 'required' => false, + 'example' => '130196473', + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'type' => 'object', + 'properties' => [ + 'requestId' => [ + 'description' => 'The request ID.'."\n", + 'type' => 'string', + 'example' => 'ABCDEFGH', + ], + ], + 'description' => '', + ], + ], + '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' => 'CompileSortScript', + 'responseParamsDescription' => ' Error response'."\n" + .' {'."\n" + .' "requestId" : "ABCDEFGH",'."\n" + .' "code":"InvalidAppStatus",'."\n" + .' "message":"invalid app status.",'."\n" + .' "httpCode":400'."\n" + .' }'."\n", + ], + 'UpdateSearchStrategy' => [ + 'summary' => 'Modifies a query policy.', + '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' => 'The name of the application.'."\n", + 'type' => 'string', + 'required' => true, + 'docRequired' => true, + 'example' => 'group_name', + ], + ], + [ + 'name' => 'appId', + 'in' => 'path', + 'schema' => [ + 'description' => 'The version number.'."\n", + 'type' => 'string', + 'required' => true, + 'docRequired' => true, + 'example' => '"110157886"', + ], + ], + [ + 'name' => 'strategyName', + 'in' => 'path', + 'schema' => [ + 'description' => 'The name of the policy.'."\n", + 'type' => 'string', + 'required' => true, + 'docRequired' => true, + 'example' => 'default', + ], + ], + [ + 'name' => 'body', + 'in' => 'body', + 'schema' => [ + 'description' => 'The request body.'."\n", + 'required' => false, + '$ref' => '#/components/schemas/SearchStrategy', + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'description' => 'The response body.'."\n", + 'type' => 'object', + 'properties' => [ + 'requestId' => [ + 'description' => 'The ID of the request.'."\n", + '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' => 'UpdateSearchStrategy', + ], + 'RemoveSearchStrategy' => [ + 'summary' => 'Deletes a query policy.', + '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' => 'The name of the application.'."\n", + 'type' => 'string', + 'required' => true, + 'docRequired' => true, + 'example' => 'my_app_group_name', + ], + ], + [ + 'name' => 'appId', + 'in' => 'path', + 'schema' => [ + 'description' => 'The version number.'."\n", + 'type' => 'string', + 'required' => true, + 'docRequired' => true, + 'example' => '110157886', + ], + ], + [ + 'name' => 'strategyName', + 'in' => 'path', + 'schema' => [ + 'description' => 'The name of the policy.'."\n", + 'type' => 'string', + 'required' => true, + 'docRequired' => true, + 'example' => 'default', + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'description' => 'The response body.'."\n", + 'type' => 'object', + 'properties' => [ + 'requestId' => [ + 'description' => 'The ID of the request.'."\n", + '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' => 'RemoveSearchStrategy', + ], + 'ListSearchStrategies' => [ + 'summary' => 'Queries the details of query policies.', + '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' => 'The name of the application.'."\n", + 'type' => 'string', + 'required' => true, + 'docRequired' => true, + 'example' => '"my_app"', + ], + ], + [ + 'name' => 'appId', + 'in' => 'path', + 'schema' => [ + 'description' => 'The ID of the version.'."\n", + 'type' => 'string', + 'required' => true, + 'docRequired' => true, + 'example' => '"110123456"', + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'description' => 'The data returned.'."\n", + 'type' => 'object', + 'properties' => [ + 'requestId' => [ + 'description' => 'The ID of the request.'."\n", + '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' => 'ListSearchStrategies', + 'responseParamsDescription' => 'Sample responses'."\n" + ."\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" + .'```'."\n", + ], + 'GetSearchStrategy' => [ + 'summary' => 'Queries the details of a query policy.', + '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' => 'The ID of the application.'."\n", + 'type' => 'string', + 'required' => true, + 'docRequired' => true, + 'example' => 'my_app_group_name', + ], + ], + [ + 'name' => 'appId', + 'in' => 'path', + 'schema' => [ + 'description' => 'The version of the application.'."\n", + 'type' => 'string', + 'required' => true, + 'docRequired' => true, + 'example' => '110157886', + ], + ], + [ + 'name' => 'strategyName', + 'in' => 'path', + 'schema' => [ + 'description' => 'The name of the policy.'."\n", + 'type' => 'string', + 'required' => true, + 'docRequired' => true, + 'example' => 'default', + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'type' => 'object', + 'properties' => [ + 'requestId' => [ + 'description' => 'The ID of the request.'."\n", + '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' => 'GetSearchStrategy', + ], + 'CreateSearchStrategy' => [ + 'summary' => 'Creates a query policy.', + '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' => 'The name of the application.'."\n", + 'type' => 'string', + 'required' => true, + 'docRequired' => true, + 'example' => '"my_app"', + ], + ], + [ + 'name' => 'appId', + 'in' => 'path', + 'schema' => [ + 'description' => 'The version number of the application.'."\n", + 'type' => 'string', + 'required' => true, + 'docRequired' => true, + 'example' => '1234', + ], + ], + [ + 'name' => 'body', + 'in' => 'body', + 'schema' => [ + 'description' => 'The query policy.'."\n", + 'required' => false, + '$ref' => '#/components/schemas/SearchStrategy', + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'description' => 'The response body.'."\n", + 'type' => 'object', + 'properties' => [ + 'requestId' => [ + 'description' => 'The ID of the request.'."\n", + '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' => 'CreateSearchStrategy', + ], + 'UpdateFetchFields' => [ + 'summary' => 'Updates fetch fields. A dry run is supported.', + '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' => 'Specifies whether the request is a dry run.'."\n", + 'type' => 'boolean', + 'required' => false, + 'example' => 'true', + ], + ], + [ + 'name' => 'appGroupIdentity', + 'in' => 'path', + 'schema' => [ + 'description' => 'The name of the application'."\n", + 'type' => 'string', + 'required' => true, + 'docRequired' => true, + 'example' => '“my_app_group_name”', + ], + ], + [ + 'name' => 'appId', + 'in' => 'path', + 'schema' => [ + 'description' => 'The version number.'."\n", + 'type' => 'integer', + 'format' => 'int32', + 'required' => true, + 'docRequired' => true, + 'example' => '110157886', + ], + ], + [ + 'name' => 'body', + 'in' => 'body', + 'style' => 'json', + 'schema' => [ + 'description' => 'The request body.'."\n", + 'type' => 'array', + 'items' => [ + 'description' => 'The field array.'."\n", + 'type' => 'string', + 'required' => false, + 'example' => '\'["id", "name", "title"]\'', + ], + 'required' => false, + 'maxItems' => 100, + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'type' => 'object', + 'properties' => [ + 'result' => [ + 'description' => 'Indicates whether the operation was successful.'."\n", + 'type' => 'boolean', + 'example' => 'true', + ], + 'requestId' => [ + 'description' => 'The request ID.'."\n", + 'type' => 'string', + 'example' => 'D77D0DAF-790D-F5F5-A9C0-133738165014', + ], + ], + 'description' => '', + ], + ], + '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":"<requestId>D77D0DAF-790D-F5F5-A9C0-133738165014</requestId>\\n<result>true</result>","errorExample":""}]', + 'title' => 'UpdateFetchFields', + 'requestParamsDescription' => '**Request body**'."\n" + ."\n" + .'> You can specify the names of multiple display fields, such as id, name, and title, in the request body.'."\n", + 'responseParamsDescription' => ' ', + 'extraInfo' => ' ', + 'translator' => 'machine', + ], + 'UpdateSummaries' => [ + 'summary' => 'Updates summaries. A dry run is supported.', + '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' => 'Specifies whether the request is a dry run.'."\n", + 'type' => 'boolean', + 'required' => false, + 'example' => 'true', + ], + ], + [ + 'name' => 'appGroupIdentity', + 'in' => 'path', + 'schema' => [ + 'description' => 'The name of the application.'."\n", + 'type' => 'string', + 'required' => true, + 'docRequired' => true, + 'example' => '“my_app_group_name”', + ], + ], + [ + 'name' => 'appId', + 'in' => 'path', + 'schema' => [ + 'description' => 'The version number of the application.'."\n", + 'type' => 'integer', + 'format' => 'int32', + 'required' => true, + 'docRequired' => true, + 'example' => '10157886', + ], + ], + [ + 'name' => 'body', + 'in' => 'body', + 'style' => 'json', + 'schema' => [ + 'description' => 'The request body.'."\n", + 'type' => 'array', + 'items' => [ + 'description' => 'The request body.', + 'type' => 'object', + 'properties' => [ + 'field' => [ + 'description' => 'The field.'."\n", + 'type' => 'string', + 'required' => false, + 'example' => '"title"', + ], + 'len' => [ + 'description' => 'The length of a segment.'."\n", + 'type' => 'integer', + 'format' => 'int32', + 'required' => false, + 'example' => '50', + ], + 'element' => [ + 'description' => 'The HTML tag that is used to highlight terms in red.'."\n", + 'type' => 'string', + 'required' => false, + 'example' => '"em" ', + ], + 'ellipsis' => [ + 'description' => 'The connector that is used to connect segments.'."\n", + 'type' => 'string', + 'required' => false, + 'example' => '"..."', + ], + 'snippet' => [ + 'description' => 'The number of segments.'."\n", + 'type' => 'integer', + 'format' => 'int32', + 'required' => false, + 'example' => '1', + ], + ], + 'required' => false, + ], + 'required' => false, + 'maxItems' => 100, + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'type' => 'object', + 'properties' => [ + 'result' => [ + 'description' => 'Indicates whether the request was successful.'."\n", + 'type' => 'boolean', + 'example' => 'true', + ], + 'requestId' => [ + 'description' => 'The request ID.'."\n", + 'type' => 'string', + 'example' => '7A389E09-7964-5A2B-FE9D-F6CFA7162852', + ], + ], + 'description' => '', + ], + ], + '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":"<result>true</result>\\n<requestId>7A389E09-7964-5A2B-FE9D-F6CFA7162852</requestId>","errorExample":""}]', + 'title' => 'UpdateSummaries', + 'requestParamsDescription' => '**Request body**'."\n" + ."\n" + .'|Field|Type|Required|Example|Description|'."\n" + .'|---|---|---|---|---|'."\n" + .'|\\[\\]|Object|Yes||The summary settings. For more information, see [Summary](~~170016~~).|'."\n" + .'|\\[\\].field|String|Yes|"title"|The field.|'."\n" + .'|\\[\\].len|Integer|Yes|50|The length of a segment.|'."\n" + .'|\\[\\].element|String|Yes|"em"|The HTML tag that is used to highlight terms in red.|'."\n" + .'|\\[\\].ellipsis|String|Yes|"..."|The connector that is used to connect segments.|'."\n" + .'|\\[\\].snippet|Integer|Yes|1|The number of segments.|', + 'responseParamsDescription' => ' ', + 'extraInfo' => ' ', + ], + 'CreateFunctionResource' => [ + 'summary' => 'Creates an algorithm resource for a specific feature.', + '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' => 'The name of the application.'."\n", + 'type' => 'string', + 'required' => true, + 'example' => 'my_app_group_name', + ], + ], + [ + 'name' => 'functionName', + 'in' => 'path', + 'schema' => [ + 'title' => '功能名称', + 'description' => 'The name of the feature.'."\n", + 'type' => 'string', + 'required' => true, + 'example' => 'rank', + ], + ], + [ + 'name' => 'body', + 'in' => 'body', + 'style' => 'json', + 'schema' => [ + 'description' => 'The body of the request.'."\n", + 'type' => 'object', + 'properties' => [ + 'Data' => [ + 'description' => 'The resource data. The data structure varies with the resource type.'."\n", + 'type' => 'object', + 'properties' => [ + 'Content' => [ + 'description' => 'The content of the file that corresponds to a resource of the raw_file type.'."\n", + 'type' => 'string', + 'required' => false, + 'example' => '"abc"', + ], + 'Generators' => [ + 'description' => 'The feature generators that correspond to resources of the feature_generator type.'."\n", + 'type' => 'array', + 'items' => [ + 'description' => '', + 'type' => 'object', + 'properties' => [ + 'Generator' => [ + 'description' => 'The type of the feature generator.'."\n" + ."\n" + .'Valid values:'."\n" + ."\n" + .'* lookup'."\n" + ."\n" + .' <!-- -->'."\n" + ."\n" + .' <!-- -->'."\n" + ."\n" + .' <!-- -->'."\n" + ."\n" + .'* sequence'."\n" + ."\n" + .' <!-- -->'."\n" + ."\n" + .' <!-- -->'."\n" + ."\n" + .' <!-- -->'."\n" + ."\n" + .'* overlap'."\n" + ."\n" + .' <!-- -->'."\n" + ."\n" + .' <!-- -->'."\n" + ."\n" + .' <!-- -->'."\n" + ."\n" + .'* raw'."\n" + ."\n" + .' <!-- -->'."\n" + ."\n" + .' <!-- -->'."\n" + ."\n" + .' <!-- -->'."\n" + ."\n" + .'* combo'."\n" + ."\n" + .' <!-- -->'."\n" + ."\n" + .' <!-- -->'."\n" + ."\n" + .' <!-- -->'."\n" + ."\n" + .'* id'."\n" + ."\n" + .' <!-- -->'."\n" + ."\n" + .' <!-- -->'."\n" + ."\n" + .' <!-- -->'."\n", + 'type' => 'string', + 'required' => false, + 'enumValueTitles' => [ + 'lookup' => 'lookup', + 'sequence' => 'sequence', + 'overlap' => 'overlap', + 'raw' => 'raw', + 'combo' => 'combo', + 'id' => 'id', + ], + 'example' => 'id', + ], + 'Input' => [ + 'description' => 'The input.'."\n", + 'type' => 'object', + 'properties' => [ + 'Features' => [ + 'description' => 'The input features.'."\n", + 'type' => 'array', + 'items' => [ + 'description' => '', + 'type' => 'object', + 'properties' => [ + 'Name' => [ + 'description' => 'The name of the feature.'."\n", + 'type' => 'string', + 'required' => false, + 'example' => 'system_item_id', + ], + 'Type' => [ + 'description' => 'The type of the feature.'."\n" + ."\n" + .'Valid values:'."\n" + ."\n" + .'* item'."\n" + ."\n" + .' <!-- -->'."\n" + ."\n" + .' <!-- -->'."\n" + ."\n" + .' <!-- -->'."\n" + ."\n" + .'* user'."\n" + ."\n" + .' <!-- -->'."\n" + ."\n" + .' <!-- -->'."\n" + ."\n" + .' <!-- -->'."\n", + 'type' => 'string', + 'required' => false, + 'enumValueTitles' => [ + 'item' => 'item', + 'user' => 'user', + ], + 'example' => 'item', + ], + ], + 'required' => false, + ], + 'required' => false, + ], + ], + 'required' => false, + ], + 'Output' => [ + 'description' => 'The name of the output feature.'."\n", + 'type' => 'string', + 'required' => false, + 'example' => 'item_id_feature', + ], + ], + 'required' => false, + ], + 'required' => false, + ], + ], + 'required' => false, + ], + 'Description' => [ + 'description' => 'The description of the resource.'."\n", + 'type' => 'string', + 'required' => false, + 'example' => '""', + ], + 'ResourceName' => [ + 'description' => 'The name of the resource.'."\n", + 'type' => 'string', + 'required' => false, + 'example' => 'fg_jsoon', + ], + 'ResourceType' => [ + 'description' => 'The resource type.'."\n" + ."\n" + .'Valid values:'."\n" + ."\n" + .'* feature_generator'."\n" + ."\n" + .' <!-- -->'."\n" + ."\n" + .' <!-- -->'."\n" + ."\n" + .' <!-- -->'."\n" + ."\n" + .'* raw_file'."\n" + ."\n" + .' <!-- -->'."\n" + ."\n" + .' <!-- -->'."\n" + ."\n" + .' <!-- -->'."\n", + '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' => 'The status code. Valid values:'."\n" + ."\n" + .'* OK'."\n" + .'* FAIL'."\n", + 'type' => 'string', + 'example' => 'OK', + ], + 'HttpCode' => [ + 'description' => 'The HTTP status code returned.'."\n", + 'type' => 'integer', + 'format' => 'int64', + 'example' => '200', + ], + 'RequestId' => [ + 'description' => 'The request ID.'."\n", + 'type' => 'string', + 'example' => 'A4D487A9-A456-5AA5-A9C6-B7BF2889CF74', + ], + 'Message' => [ + 'description' => 'The error message returned.'."\n", + 'type' => 'string', + 'example' => '""', + ], + 'Code' => [ + 'description' => 'The error code. If no error occurs, this parameter is left empty.'."\n", + 'type' => 'string', + 'example' => '""', + ], + 'Latency' => [ + 'description' => 'The time consumed for the request. Unit: milliseconds.'."\n", + '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' => 'CreateFunctionResource', + ], + 'GetFunctionCurrentVersion' => [ + 'summary' => 'Queries the version information about the current feature when you create an instance.', + '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' => 'The name of the feature. Valid values:'."\n" + ."\n" + .'* ctr: click-through rate (CTR) model'."\n" + .'* pop: popularity model'."\n" + .'* category: category model'."\n" + .'* hot: hotword model'."\n" + .'* hint: shading model'."\n" + .'* suggest: drop-down suggestion model'."\n" + .'* analyzer: word segmentation model'."\n" + .'* termweight: word weight model'."\n", + 'type' => 'string', + 'required' => true, + 'example' => 'ctr', + ], + ], + [ + 'name' => 'modelType', + 'in' => 'query', + 'schema' => [ + 'description' => 'The type of the model. The following features correspond to different model types:'."\n" + ."\n" + .'* CTR model: tf_checkpoint'."\n" + .'* Popularity model: pop'."\n" + .'* Category model: offline_inference'."\n" + .'* Hotword model: offline_inference'."\n" + .'* Shading model: offline_inference'."\n" + .'* Drop-down suggestion model: offline_inference'."\n" + .'* Word segmentation model: text'."\n" + .'* Word weight model: tf_checkpoint'."\n", + 'type' => 'string', + 'required' => true, + 'enumValueTitles' => [ + 'pop' => '', + 'offline_inference' => '', + 'tf_checkpoint' => '', + 'text' => '', + ], + 'example' => 'tf_checkpoint', + ], + ], + [ + 'name' => 'functionType', + 'in' => 'query', + 'schema' => [ + 'description' => 'The type of the feature. Valid values:'."\n" + ."\n" + .'* PAAS. This is the default value.'."\n" + .'* SAAS.'."\n", + 'type' => 'string', + 'required' => false, + 'example' => 'PAAS', + ], + ], + [ + 'name' => 'domain', + 'in' => 'query', + 'schema' => [ + 'description' => 'The industry. By default, this parameter is left empty, which indicates General-purpose Edition.'."\n", + 'type' => 'string', + 'required' => false, + 'enumValueTitles' => [ + 'education' => '', + 'ecommerce' => '', + 'community' => '', + ], + 'example' => 'ecommerce', + ], + ], + [ + 'name' => 'category', + 'in' => 'query', + 'schema' => [ + 'description' => 'The category. By default, this parameter is left empty.'."\n", + 'type' => 'string', + 'required' => false, + 'enumValueTitles' => [ + 'general' => '', + 'question' => '', + 'it' => '', + ], + 'example' => 'general', + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'description' => 'The response body.'."\n", + 'type' => 'object', + 'properties' => [ + 'Status' => [ + 'description' => 'The status of the request.'."\n", + 'type' => 'string', + 'example' => 'OK', + ], + 'HttpCode' => [ + 'description' => 'The HTTP status code.'."\n", + 'type' => 'integer', + 'format' => 'int64', + 'example' => '200', + ], + 'RequestId' => [ + 'description' => 'The ID of the request.'."\n", + 'type' => 'string', + 'example' => '1638157479281', + ], + 'Message' => [ + 'description' => 'The error message.'."\n", + 'type' => 'string', + 'example' => 'version not exist.', + ], + 'Code' => [ + 'description' => 'The error code.'."\n", + 'type' => 'string', + 'example' => 'Version.NotExist', + ], + 'Result' => [ + 'description' => 'The result of the request.'."\n", + 'type' => 'object', + 'properties' => [ + 'FunctionName' => [ + 'description' => 'The name of the feature.'."\n", + 'type' => 'string', + 'example' => 'ctr', + ], + 'FunctionType' => [ + 'description' => 'The type of the feature. Valid values:'."\n" + ."\n" + .'* PAAS'."\n" + .'* SAAS'."\n", + 'type' => 'string', + 'example' => 'PAAS', + ], + 'ModelType' => [ + 'description' => 'The type of the model.'."\n", + 'type' => 'string', + 'example' => 'tf_checkpoint', + ], + 'VersionConfig' => [ + 'description' => 'The configuration information about the instance.'."\n", + 'type' => 'object', + 'properties' => [ + 'CreateParameters' => [ + 'description' => 'The parameters that are used to create the instance.'."\n", + 'type' => 'array', + 'items' => [ + 'description' => 'The parameter body.'."\n", + 'type' => 'object', + 'properties' => [ + 'Name' => [ + 'description' => 'The name of the parameter.'."\n", + 'type' => 'string', + 'example' => 'params1', + ], + 'Required' => [ + 'description' => 'Indicates whether the parameter is required.'."\n", + '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' => 'The dependencies of the instance.'."\n", + 'type' => 'array', + 'items' => [ + 'description' => 'The parameter body.'."\n", + 'type' => 'object', + 'properties' => [ + 'Condition' => [ + 'description' => 'The condition.'."\n", + 'type' => 'string', + 'example' => '""', + ], + 'Dependency' => [ + 'description' => 'The dependency.'."\n", + 'type' => 'string', + 'example' => '""', + ], + 'Description' => [ + 'description' => 'The description.'."\n", + 'type' => 'string', + 'example' => '""', + ], + ], + 'example' => '', + ], + 'example' => '', + ], + 'UsageParameters' => [ + 'description' => 'The parameters that are used to use the instance online.'."\n", + 'type' => 'array', + 'items' => [ + 'description' => 'The parameter body.'."\n", + 'type' => 'object', + 'properties' => [ + 'Name' => [ + 'description' => 'The name of the parameter.'."\n", + 'type' => 'string', + 'example' => '""', + ], + 'Required' => [ + 'description' => 'Indicates whether the parameter is required.'."\n", + 'type' => 'string', + 'example' => '""', + ], + ], + 'example' => '{}', + ], + 'example' => '[]', + ], + ], + 'example' => '', + ], + 'VersionId' => [ + 'description' => 'The ID of the version.'."\n", + 'type' => 'integer', + 'format' => 'int64', + 'example' => '101', + ], + 'VersionName' => [ + 'description' => 'The name of the version.'."\n", + 'type' => 'string', + 'example' => 'v1', + ], + ], + 'example' => '', + ], + 'Latency' => [ + 'description' => 'The time consumed for the request, in milliseconds.'."\n", + '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' => 'GetFunctionCurrentVersion', + 'requestParamsDescription' => '### Sample requests'."\n" + ."\n" + .'`GET /v4/openapi/functions/ctr/current-version?modelType=_checkpoint&functionType=PAAS&domain=ecommerce&category=general`'."\n", + 'responseParamsDescription' => '### Sample success responses (In this example, hotword model is used.)'."\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": "The level of the data integrity must be equal to or greater than 1."'."\n" + .' }'."\n" + .' ],'."\n" + .' "deployment": "",'."\n" + .' "dagTemplate": "opensearch_hot_train"'."\n" + .' }'."\n" + .' }'."\n" + .' }'."\n", + ], + 'GetFunctionVersion' => [ + 'summary' => 'Queries version information by version 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' => 'The name of the feature.'."\n", + 'type' => 'string', + 'required' => true, + 'example' => 'ctr', + ], + ], + [ + 'name' => 'versionId', + 'in' => 'path', + 'schema' => [ + 'description' => 'The ID of the version.'."\n", + 'type' => 'integer', + 'format' => 'int32', + 'required' => true, + 'example' => '100', + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'description' => 'The response body.'."\n", + 'type' => 'object', + 'properties' => [ + 'Status' => [ + 'description' => 'The status of the request.'."\n", + 'type' => 'string', + 'example' => 'OK', + ], + 'HttpCode' => [ + 'description' => 'The HTTP status code.'."\n", + 'type' => 'integer', + 'format' => 'int64', + 'example' => '200', + ], + 'RequestId' => [ + 'description' => 'The ID of the request.'."\n", + 'type' => 'string', + 'example' => '1638157479281', + ], + 'Message' => [ + 'description' => 'The error message.'."\n", + 'type' => 'string', + 'example' => 'version not exist.', + ], + 'Code' => [ + 'description' => 'The error code.'."\n", + 'type' => 'string', + 'example' => 'Version.NotExist', + ], + 'Result' => [ + 'description' => 'The result body.'."\n", + 'type' => 'object', + 'properties' => [ + 'FunctionName' => [ + 'description' => 'The name of the feature.'."\n", + 'type' => 'string', + 'example' => 'ctr', + ], + 'FunctionType' => [ + 'description' => 'The type of the feature. Valid values:'."\n" + ."\n" + .'* PAAS'."\n" + .'* SAAS'."\n", + 'type' => 'string', + 'example' => 'PAAS', + ], + 'ModelType' => [ + 'description' => 'The type of the model.'."\n", + 'type' => 'string', + 'example' => 'tf_checkpoint', + ], + 'VersionConfig' => [ + 'description' => 'The configuration information.'."\n", + 'type' => 'object', + 'properties' => [ + 'CreateParameters' => [ + 'description' => 'The parameters that are used to create the instance.'."\n", + 'type' => 'array', + 'items' => [ + 'description' => 'The parameter body.'."\n", + 'type' => 'object', + 'properties' => [ + 'Name' => [ + 'description' => 'The name of the parameter.'."\n", + 'type' => 'string', + 'example' => 'params1', + ], + 'Required' => [ + 'description' => 'Indicates whether the parameter is required.'."\n", + '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' => 'The dependencies of the instance.'."\n", + 'type' => 'array', + 'items' => [ + 'description' => 'The parameter body.'."\n", + 'type' => 'object', + 'properties' => [ + 'Condition' => [ + 'description' => 'The condition.'."\n", + 'type' => 'string', + 'example' => '""', + ], + 'Dependency' => [ + 'description' => 'The dependency.'."\n", + 'type' => 'string', + 'example' => '""', + ], + 'Description' => [ + 'description' => 'The description.'."\n", + 'type' => 'string', + 'example' => '""', + ], + ], + 'example' => '{}', + ], + 'example' => '', + ], + 'UsageParameters' => [ + 'description' => 'The parameters that are used during online use of the instance.'."\n", + 'type' => 'array', + 'items' => [ + 'description' => 'The parameter body.'."\n", + 'type' => 'object', + 'properties' => [ + 'Name' => [ + 'description' => 'The name of the instance.'."\n", + 'type' => 'string', + 'example' => '""', + ], + 'Required' => [ + 'description' => 'Indicates whether the parameter is required.'."\n", + 'type' => 'string', + 'example' => '""', + ], + ], + 'example' => '{}', + ], + 'example' => '[]', + ], + ], + 'example' => '', + ], + 'VersionId' => [ + 'description' => 'The ID of the version.'."\n", + 'type' => 'integer', + 'format' => 'int64', + 'example' => '101', + ], + 'VersionName' => [ + 'description' => 'The name of the version.'."\n", + 'type' => 'string', + 'example' => 'v1', + ], + ], + 'example' => '[]', + ], + 'Latency' => [ + 'description' => 'The maximum duration for which a task can be executed.'."\n", + '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' => 'GetFunctionVersion', + 'requestParamsDescription' => '### Sample requests'."\n" + ."\n" + .'`GET /v4/openapi/functions/ctr/version/101`'."\n", + 'responseParamsDescription' => '### Sample success responses'."\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": "the dependency",'."\n" + .' "condition": "the condition",'."\n" + .' "description": ""'."\n" + .' }'."\n" + .' ],'."\n" + .' "usageParameters": []'."\n" + .' }'."\n" + .' }'."\n" + .' }'."\n", + ], + 'GetFunctionDefaultInstance' => [ + 'summary' => 'Queries the algorithm instance that an application uses by default.', + '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' => 'The name of the application.'."\n", + 'type' => 'string', + 'required' => true, + 'example' => 'my_app_group_name', + ], + ], + [ + 'name' => 'functionName', + 'in' => 'path', + 'schema' => [ + 'description' => 'The name of the feature.'."\n", + 'type' => 'string', + 'required' => true, + 'example' => 'ctr', + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'description' => 'The response body.'."\n", + 'type' => 'object', + 'properties' => [ + 'Status' => [ + 'description' => 'The status of the request.'."\n", + 'type' => 'string', + 'example' => 'OK', + ], + 'HttpCode' => [ + 'description' => 'The HTTP status code.'."\n", + 'type' => 'integer', + 'format' => 'int64', + 'example' => '200', + ], + 'RequestId' => [ + 'description' => 'The ID of the request.'."\n", + 'type' => 'string', + 'example' => '062BA91F-A568-5779-8A5B-9E62C9BB3DC1', + ], + 'Message' => [ + 'description' => 'The error message.'."\n", + 'type' => 'string', + 'example' => 'default instance not set.', + ], + 'Code' => [ + 'description' => 'The error code.'."\n", + 'type' => 'string', + 'example' => 'DefaultInstance.NotExist', + ], + 'Result' => [ + 'description' => 'The result of the request.'."\n", + 'type' => 'object', + 'properties' => [ + 'InstanceName' => [ + 'description' => 'The default instance name.'."\n", + 'type' => 'string', + 'example' => 'model1', + ], + ], + 'example' => '{\'Pagination\': {\'TotalCount\': 0, \'PageNumber\': 1, \'PageSize\': 10}, \'AntConsortiums\': []}', + ], + 'Latency' => [ + 'description' => 'The default running time.'."\n", + 'type' => 'integer', + 'format' => 'int64', + 'example' => '123', + ], + 'InstanceName' => [ + 'title' => '实例名称', + 'description' => 'The name of the instance.'."\n", + 'type' => 'string', + 'example' => 'sh-bp1oi31w1jn4ctdyv', + 'readOnly' => false, + ], + 'FunctionName' => [ + 'title' => '功能名称', + 'description' => 'The name of the feature.'."\n", + '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' => 'GetFunctionDefaultInstance', + 'requestParamsDescription' => '### Sample requests'."\n" + ."\n" + .'`GET /v4/openapi/app-groups/my-app/functions/pop/default-instances`'."\n", + 'responseParamsDescription' => '### Sample success responses'."\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' => 'Sets the default algorithm instance used by the specified application. The new algorithm instance automatically overwrites the most recently set default instance. If no instance is set, the default instance is canceled.', + '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' => 'The request parameters.'."\n", + 'type' => 'object', + 'properties' => [ + 'instanceName' => [ + 'title' => '实例名称', + 'description' => 'The name of the instance.'."\n", + 'type' => 'string', + 'required' => false, + 'example' => '"pop_test"', + ], + ], + 'required' => false, + 'docRequired' => true, + 'example' => '{}', + ], + ], + [ + 'name' => 'appGroupIdentity', + 'in' => 'path', + 'schema' => [ + 'description' => 'The name of the application.'."\n", + 'type' => 'string', + 'required' => true, + 'example' => '"app_group_name"', + ], + ], + [ + 'name' => 'functionName', + 'in' => 'path', + 'schema' => [ + 'description' => 'The name of the feature.'."\n", + 'type' => 'string', + 'required' => true, + 'example' => 'pop', + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'description' => 'response'."\n", + 'type' => 'object', + 'properties' => [ + 'Status' => [ + 'description' => 'The status of the request.'."\n", + 'type' => 'string', + 'example' => 'OK', + ], + 'HttpCode' => [ + 'description' => 'The HTTP status code.'."\n", + 'type' => 'integer', + 'format' => 'int64', + 'example' => '200', + ], + 'RequestId' => [ + 'description' => 'The ID of the request.'."\n", + 'type' => 'string', + 'example' => 'A4D487A9-A456-5AA5-A9C6-B7BF2889CF74', + ], + 'Message' => [ + 'description' => 'The error message.'."\n", + 'type' => 'string', + 'example' => 'success', + ], + 'Code' => [ + 'description' => 'The error code.'."\n", + 'type' => 'string', + 'example' => 'DefaultInstance.SetFail', + ], + 'Latency' => [ + 'description' => 'The time consumed for the request, in milliseconds.'."\n", + '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' => 'UpdateFunctionDefaultInstance', + ], + 'ListFunctionTasks' => [ + 'summary' => 'Queries the training tasks. The returned results are sorted by start time in descending order.', + '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' => 'The name of the application.'."\n", + 'type' => 'string', + 'required' => true, + 'example' => 'app_group_name', + ], + ], + [ + 'name' => 'functionName', + 'in' => 'path', + 'schema' => [ + 'description' => 'The name of the feature.'."\n", + 'type' => 'string', + 'required' => true, + 'example' => 'ctr', + ], + ], + [ + 'name' => 'instanceName', + 'in' => 'path', + 'schema' => [ + 'description' => 'The name of the instance.'."\n", + 'type' => 'string', + 'required' => true, + 'example' => 'test_model_2', + ], + ], + [ + 'name' => 'status', + 'in' => 'query', + 'schema' => [ + 'description' => 'The status of the task. Valid values:'."\n" + ."\n" + .'* success'."\n" + .'* failed'."\n" + .'* running'."\n", + 'type' => 'string', + 'required' => false, + 'example' => 'success', + ], + ], + [ + 'name' => 'startTime', + 'in' => 'query', + 'schema' => [ + 'description' => 'The start time is greater than the specified time. Specify the time in the UNIX timestamp format. Unit: milliseconds.'."\n", + 'type' => 'integer', + 'format' => 'int64', + 'required' => false, + 'example' => '1582214400', + ], + ], + [ + 'name' => 'endTime', + 'in' => 'query', + 'schema' => [ + 'description' => 'The end time is less than the specified time. Specify the time in the UNIX timestamp format. Unit: milliseconds.'."\n", + 'type' => 'integer', + 'format' => 'int64', + 'required' => false, + 'example' => '1582646399', + ], + ], + [ + 'name' => 'pageNumber', + 'in' => 'query', + 'schema' => [ + 'description' => 'The number of the page to return. Default value: 1.'."\n", + 'type' => 'integer', + 'format' => 'int32', + 'required' => false, + 'example' => '1', + ], + ], + [ + 'name' => 'pageSize', + 'in' => 'query', + 'schema' => [ + 'description' => 'The number of entries to return on each page. Default value: 1.'."\n", + 'type' => 'integer', + 'format' => 'int32', + 'required' => false, + 'example' => '10', + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'description' => 'The response body.'."\n", + 'type' => 'object', + 'properties' => [ + 'Status' => [ + 'description' => 'The status of the request.'."\n", + 'type' => 'string', + 'example' => '200', + ], + 'HttpCode' => [ + 'description' => 'The HTTP status code.'."\n", + 'type' => 'integer', + 'format' => 'int64', + 'example' => '200', + ], + 'TotalCount' => [ + 'description' => 'The total number of records that meet the requirements.'."\n", + 'type' => 'integer', + 'format' => 'int64', + 'example' => '2', + ], + 'RequestId' => [ + 'description' => 'The ID of the request.'."\n", + 'type' => 'string', + 'example' => '1638157479281', + ], + 'Message' => [ + 'description' => 'The error message.'."\n", + 'type' => 'string', + 'example' => 'fail', + ], + 'Code' => [ + 'description' => 'The error code.'."\n", + 'type' => 'string', + 'example' => '200', + ], + 'Result' => [ + 'description' => 'The returned result.'."\n", + 'type' => 'array', + 'items' => [ + 'description' => 'The result body.'."\n", + 'type' => 'object', + 'properties' => [ + 'EndTime' => [ + 'description' => 'The timestamp that indicates the end time. Unit: milliseconds. 0 indicates that the task has not ended.'."\n", + 'type' => 'integer', + 'format' => 'int64', + 'example' => '100010', + ], + 'ExtendInfo' => [ + 'description' => 'The value is a JSON string. It includes model evaluation information and training error information.'."\n", + 'type' => 'string', + 'example' => '{\\"recall\\":91,\\"errors\\":[]}', + ], + 'FunctionName' => [ + 'description' => 'The name of the feature.'."\n", + 'type' => 'string', + 'example' => 'ctr', + ], + 'Progress' => [ + 'description' => 'The progress. 90 indicates 90%.'."\n", + 'type' => 'integer', + 'format' => 'int64', + 'example' => '90', + ], + 'RunId' => [ + 'description' => 'The ID of the task.'."\n", + 'type' => 'string', + 'example' => 'trigger__2021-03-05T12:18:41', + ], + 'StartTime' => [ + 'description' => 'The timestamp that indicates the start time. Unit: milliseconds.'."\n", + 'type' => 'integer', + 'format' => 'int64', + 'example' => '100010', + ], + 'Status' => [ + 'description' => 'The status of the task. Valid values:'."\n" + ."\n" + .'* success'."\n" + .'* failed'."\n" + .'* running'."\n", + 'type' => 'string', + 'example' => 'success', + ], + 'Generation' => [ + 'description' => 'The number of iterations.'."\n", + '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' => 'The time consumed for the request, in milliseconds.'."\n", + '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' => 'ListFunctionTasks', + 'requestParamsDescription' => '### Sample requests'."\n" + ."\n" + .'`GET /v4/openapi/app-groups/my-app/functions/ctr/instances/ctr_test/tasks`'."\n", + 'responseParamsDescription' => '### Sample success responses'."\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", + ], + 'GetFunctionTask' => [ + 'summary' => 'Queries the details of a training task.', + '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' => 'The name of the application.'."\n", + 'type' => 'string', + 'required' => true, + 'example' => 'my_app_group_name', + ], + ], + [ + 'name' => 'functionName', + 'in' => 'path', + 'schema' => [ + 'title' => '功能名称', + 'description' => 'The name of the feature.'."\n", + 'type' => 'string', + 'required' => true, + 'example' => 'ctr', + ], + ], + [ + 'name' => 'instanceName', + 'in' => 'path', + 'schema' => [ + 'title' => '实例名称', + 'description' => 'The name of the instance.'."\n", + 'type' => 'string', + 'required' => true, + 'example' => 'test_model_2', + ], + ], + [ + 'name' => 'generation', + 'in' => 'path', + 'schema' => [ + 'title' => '迭代次数', + 'description' => 'The number of iterations.'."\n", + 'type' => 'string', + 'required' => true, + 'example' => '1', + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'description' => 'The schema of the response.'."\n", + 'type' => 'object', + 'properties' => [ + 'Status' => [ + 'description' => 'The status of the request.'."\n", + 'type' => 'string', + 'example' => 'OK', + ], + 'HttpCode' => [ + 'description' => 'The HTTP status code.'."\n", + 'type' => 'integer', + 'format' => 'int64', + 'example' => '200', + ], + 'RequestId' => [ + 'description' => 'The ID of the request.'."\n", + 'type' => 'string', + 'example' => 'A4D487A9-A456-5AA5-A9C6-B7BF2889CF74', + ], + 'Message' => [ + 'description' => 'The error message.'."\n", + 'type' => 'string', + 'example' => 'operation success', + ], + 'Code' => [ + 'description' => 'The error code.'."\n", + 'type' => 'string', + 'example' => 'Task.NotExist', + ], + 'Result' => [ + 'description' => 'The result of the request.'."\n", + 'type' => 'object', + 'properties' => [ + 'EndTime' => [ + 'description' => 'The timestamp that indicates the end time of the task. Unit: milliseconds.'."\n", + 'type' => 'integer', + 'format' => 'int64', + 'example' => '1647213406267', + ], + 'ExtendInfo' => [ + 'description' => 'The extended information, which is a JSON string.'."\n", + 'type' => 'string', + 'example' => '{\\"recall\\":91,\\"errors\\":[]}', + ], + 'FunctionName' => [ + 'description' => 'The name of the feature.'."\n", + 'type' => 'string', + 'example' => 'ctr', + ], + 'Generation' => [ + 'description' => 'The number of iterations.'."\n", + 'type' => 'string', + 'example' => '1', + ], + 'Progress' => [ + 'description' => 'The progress. 90 indicates 90%.'."\n", + 'type' => 'integer', + 'format' => 'int64', + 'example' => '90', + ], + 'RunId' => [ + 'description' => 'The ID of the task.'."\n", + 'type' => 'string', + 'example' => 'trigger__2021-03-05T12:18:41', + ], + 'StartTime' => [ + 'description' => 'The timestamp that indicates the start time of the task. Unit: milliseconds.'."\n", + 'type' => 'integer', + 'format' => 'int64', + 'example' => '1647212220000', + ], + 'Status' => [ + 'description' => 'The status of the task. Valid values:'."\n" + ."\n" + .'* success'."\n" + .'* failed'."\n" + .'* running'."\n", + 'type' => 'string', + 'example' => 'success', + ], + ], + ], + 'Latency' => [ + 'description' => 'The time consumed for the request, in milliseconds.'."\n", + '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' => 'GetFunctionTask', + 'requestParamsDescription' => '### Sample requests'."\n" + ."\n" + .'`GET /v4/openapi/app-groups/my-app/functions/ctr/instances/ctr_test/tasks/3`'."\n", + 'responseParamsDescription' => '### Sample success responses'."\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' => 'Deletes a training task. The training task in progress cannot be deleted.', + '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' => 'The name of the application.'."\n", + 'type' => 'string', + 'required' => true, + 'example' => 'my_app_group_name', + ], + ], + [ + 'name' => 'functionName', + 'in' => 'path', + 'schema' => [ + 'title' => '功能名称', + 'description' => 'The name of the feature.'."\n", + 'type' => 'string', + 'required' => true, + 'example' => 'ctr', + ], + ], + [ + 'name' => 'instanceName', + 'in' => 'path', + 'schema' => [ + 'title' => '实例名称', + 'description' => 'The name of the instance.'."\n", + 'type' => 'string', + 'required' => true, + 'example' => 'ctr_test', + ], + ], + [ + 'name' => 'generation', + 'in' => 'path', + 'schema' => [ + 'title' => '迭代次数', + 'description' => 'The number of iterations.'."\n", + 'type' => 'string', + 'required' => true, + 'example' => '1', + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'description' => 'The schema of the response.'."\n", + 'type' => 'object', + 'properties' => [ + 'Status' => [ + 'description' => 'The status of the request.'."\n", + 'type' => 'string', + 'example' => 'OK', + ], + 'HttpCode' => [ + 'description' => 'The HTTP status code.'."\n", + 'type' => 'integer', + 'format' => 'int64', + 'example' => '200', + ], + 'RequestId' => [ + 'description' => 'The ID of the request.'."\n", + 'type' => 'string', + 'example' => '"1081EB05-473C-5BF4-95BE-6D7CAD5E2213"', + ], + 'Message' => [ + 'description' => 'The error message.'."\n", + 'type' => 'string', + 'example' => 'operation success', + ], + 'Code' => [ + 'description' => 'The error code. If no error occurs, this parameter is left empty.'."\n", + 'type' => 'string', + 'example' => 'Task.UnableDelete', + ], + 'Latency' => [ + 'description' => 'The time consumed for the request, in milliseconds.'."\n", + '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' => 'DeleteFunctionTask', + 'responseParamsDescription' => '### Sample success responses'."\n" + ."\n" + .' {'."\n" + .' "status": "OK",'."\n" + .' "requestId": "",'."\n" + .' "httpCode": 200,'."\n" + .' "code": "",'."\n" + .' "message": "",'."\n" + .' "latency": 123,'."\n" + .' "result": {}'."\n" + .' }'."\n", + ], + 'CreateFunctionTask' => [ + 'summary' => 'Starts a training task for an algorithm instance.', + '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' => 'The name of the application.'."\n", + 'type' => 'string', + 'required' => true, + 'example' => 'app_group_name', + ], + ], + [ + 'name' => 'functionName', + 'in' => 'path', + 'schema' => [ + 'description' => 'The name of the feature.'."\n", + 'type' => 'string', + 'required' => true, + 'example' => 'ctr', + ], + ], + [ + 'name' => 'instanceName', + 'in' => 'path', + 'schema' => [ + 'description' => 'The name of the instance.'."\n", + 'type' => 'string', + 'required' => true, + 'example' => 'ctr_test', + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'description' => 'The response body.'."\n", + 'type' => 'object', + 'properties' => [ + 'Status' => [ + 'description' => 'The status of the request.'."\n", + 'type' => 'string', + 'example' => 'OK', + ], + 'HttpCode' => [ + 'description' => 'The HTTP status code.'."\n", + 'type' => 'integer', + 'format' => 'int64', + 'example' => '200', + ], + 'RequestId' => [ + 'description' => 'The ID of the request.'."\n", + 'type' => 'string', + 'example' => '1638157990724', + ], + 'Message' => [ + 'description' => 'The error message.'."\n", + 'type' => 'string', + 'example' => 'success', + ], + 'Code' => [ + 'description' => 'The error code.'."\n", + 'type' => 'string', + 'example' => 'Task.IsRunning', + ], + 'Latency' => [ + 'description' => 'The time consumed for the request, in milliseconds.'."\n", + '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' => 'CreateFunctionTask', + 'requestParamsDescription' => '### Sample requests'."\n" + ."\n" + .'`POST /v4/openapi/app-groups/my-app/functions/ctr/instances/ctr_test/task`'."\n", + 'responseParamsDescription' => '### Sample success responses'."\n" + ."\n" + .' {'."\n" + .' "status" : "OK",'."\n" + .' "requestId" : "",'."\n" + .' "httpCode": 200,'."\n" + .' "code": "",'."\n" + .' "message": "",'."\n" + .' "latency" : 123,'."\n" + .' "result" : {},'."\n" + .' }'."\n", + ], + 'ListFunctionInstances' => [ + 'summary' => 'Queries all algorithm instances of a user, which meet specified conditions.', + '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' => 'The name of the application.'."\n", + 'type' => 'string', + 'required' => true, + 'example' => 'app_group_name', + ], + ], + [ + 'name' => 'functionName', + 'in' => 'path', + 'schema' => [ + 'title' => '功能名称', + 'description' => 'The name of the feature.'."\n", + 'type' => 'string', + 'required' => true, + 'example' => 'ctr', + ], + ], + [ + 'name' => 'modelType', + 'in' => 'query', + 'schema' => [ + 'title' => '模型类型', + 'description' => 'The type of the model.'."\n", + 'type' => 'string', + 'required' => false, + 'example' => 'tf_checkpoint', + ], + ], + [ + 'name' => 'functionType', + 'in' => 'query', + 'schema' => [ + 'title' => '功能类型', + 'description' => 'The type of the feature.'."\n", + 'type' => 'string', + 'required' => false, + 'example' => '"PAAS"', + ], + ], + [ + 'name' => 'source', + 'in' => 'query', + 'schema' => [ + 'title' => '实例来源', + 'description' => 'How the instance is created. Valid values:'."\n" + ."\n" + .'* builtin: The instance is created by system.'."\n" + .'* user: The instance is created by user. This is the default value.'."\n" + .'* all: all instances'."\n", + 'type' => 'string', + 'required' => false, + 'example' => 'user', + ], + ], + [ + 'name' => 'pageNumber', + 'in' => 'query', + 'schema' => [ + 'title' => '页码', + 'description' => 'The number of the page to return. Default value: 1.'."\n", + 'type' => 'integer', + 'format' => 'int32', + 'required' => false, + 'example' => '1', + ], + ], + [ + 'name' => 'pageSize', + 'in' => 'query', + 'schema' => [ + 'title' => '每页大小', + 'description' => 'The number of entries to return on each page. Default value: 10.'."\n", + 'type' => 'integer', + 'format' => 'int32', + 'required' => false, + 'example' => '10', + ], + ], + [ + 'name' => 'output', + 'in' => 'query', + 'schema' => [ + 'title' => '返回信息的丰富度', + 'description' => 'The richness of the returned information. Valid values:'."\n" + ."\n" + .'* normal: displays information such as createParameters and cron. This is the default value.'."\n" + .'* simple: displays only the basic information.'."\n" + .'* detail: returns the details of the training task.'."\n", + 'type' => 'string', + 'required' => false, + 'enumValueTitles' => [], + 'example' => 'normal', + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'description' => 'The response body.'."\n", + 'type' => 'object', + 'properties' => [ + 'Status' => [ + 'description' => 'The status of the request.'."\n", + 'type' => 'string', + 'example' => '"OK"', + ], + 'HttpCode' => [ + 'description' => 'The HTTP status code.'."\n", + 'type' => 'integer', + 'format' => 'int64', + 'example' => '200', + ], + 'TotalCount' => [ + 'description' => 'The total number of entries returned.'."\n", + 'type' => 'integer', + 'format' => 'int64', + 'example' => '2', + ], + 'RequestId' => [ + 'description' => 'The ID of the request.'."\n", + 'type' => 'string', + 'example' => 'A4D487A9-A456-5AA5-A9C6-B7BF2889CF74', + ], + 'Message' => [ + 'description' => 'The error message. If no error occurs, the parameter is left empty.'."\n", + 'type' => 'string', + 'example' => 'instance not exist.', + ], + 'Code' => [ + 'description' => 'The error code. If no error occurs, the parameter is left empty.'."\n", + 'type' => 'string', + 'example' => 'Instance.NotExist', + ], + 'Result' => [ + 'description' => 'The information about the instances.'."\n", + 'type' => 'array', + 'items' => [ + 'description' => 'The information about the instance.'."\n", + 'type' => 'object', + 'properties' => [ + 'Belongs' => [ + 'description' => ' The information about the instance.'."\n", + 'type' => 'object', + 'properties' => [ + 'Category' => [ + 'description' => 'The category.'."\n", + 'type' => 'string', + 'example' => '"general"', + ], + 'Domain' => [ + 'description' => 'The industry.'."\n", + 'type' => 'string', + 'example' => '"ecommerce"', + ], + 'Language' => [ + 'description' => 'The abbreviation of the language that applies.'."\n", + 'type' => 'string', + 'example' => '"zh" ', + ], + ], + 'example' => '{}', + ], + 'CreateParameters' => [ + 'description' => 'The parameters of the instance.'."\n", + 'type' => 'array', + 'items' => [ + 'description' => 'The parameter body.'."\n", + 'type' => 'object', + 'properties' => [ + 'Name' => [ + 'description' => 'The name of the parameter.'."\n", + 'type' => 'string', + 'example' => '"param1"', + ], + 'Value' => [ + 'description' => 'The value of the parameter.'."\n", + 'type' => 'string', + 'example' => '"value1"', + ], + ], + 'example' => '{}', + ], + 'example' => '[]', + ], + 'UsageParameters' => [ + 'description' => 'The parameters that are used.'."\n", + 'type' => 'array', + 'items' => [ + 'description' => 'The parameter body.'."\n", + 'type' => 'object', + 'properties' => [ + 'Name' => [ + 'description' => 'The name of the parameter.'."\n", + 'type' => 'string', + 'example' => 'use_param1', + ], + 'Value' => [ + 'description' => 'The value of the parameter.'."\n", + 'type' => 'string', + 'example' => 'value1', + ], + ], + ], + ], + 'CreateTime' => [ + 'description' => 'The time when the instance was created.'."\n", + 'type' => 'integer', + 'format' => 'int64', + 'example' => '1234', + ], + 'Cron' => [ + 'description' => 'The cron expression used to schedule training, in the format of (Minutes Hours DayofMonth Month DayofWeek). If the value is empty, it indicates that no periodic training is performed.'."\n", + 'type' => 'string', + 'example' => '0 3 ? \\* 0,1,3,5 (at 3 a.m. on Sunday, Monday, Wednesday, and Friday)'."\n", + ], + 'Description' => [ + 'description' => 'The description.'."\n", + 'type' => 'string', + 'example' => '" "', + ], + 'ExtendInfo' => [ + 'description' => 'The extended information, which is a JSON string. It includes model evaluation information and error information.'."\n", + 'type' => 'string', + 'example' => '"{\\"dataReport\\":{},\\"errors\\":{}}"', + ], + 'FunctionName' => [ + 'description' => 'The name of the feature.'."\n", + 'type' => 'string', + 'example' => '"ctr"', + ], + 'FunctionType' => [ + 'description' => 'The type of the feature.'."\n", + 'type' => 'string', + 'example' => '"PAAS"', + ], + 'InstanceName' => [ + 'description' => 'The name of the instance.'."\n", + 'type' => 'string', + 'example' => '"ctr_test"', + ], + 'ModelType' => [ + 'description' => 'The type of the model.'."\n", + 'type' => 'string', + 'example' => '"tf_checkpoint"', + ], + 'Source' => [ + 'description' => 'How the instance is created. Valid values:'."\n" + ."\n" + .'* user: The instance is created by user.'."\n" + .'* builtin: The instance is created by system.'."\n", + 'type' => 'string', + 'example' => '"user"', + ], + 'Status' => [ + 'description' => 'The state of the instance. Valid values:'."\n" + ."\n" + .'1. unavailable: No model is available. Models must be trained before you can use them.'."\n" + .'2. available: Models can be used.'."\n", + 'type' => 'string', + 'example' => 'available', + ], + 'VersionId' => [ + 'description' => 'The ID of the version.'."\n", + 'type' => 'integer', + 'format' => 'int64', + 'example' => '123', + ], + ], + 'example' => '{}', + ], + 'example' => '[]', + ], + 'Latency' => [ + 'description' => 'The time consumed for the request, in milliseconds.'."\n", + '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' => 'ListFunctionInstances', + 'requestParamsDescription' => '### Sample requests'."\n" + ."\n" + .'`GET /v4/openapi/app-groups/my-app/functions/ctr/instances?source=all&output=simple`'."\n", + 'responseParamsDescription' => '### Sample success responses'."\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' => 'Queries the details of an algorithm instance by instance name.', + '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' => 'The name of the application.'."\n", + 'type' => 'string', + 'required' => true, + 'example' => '150057101', + ], + ], + [ + 'name' => 'functionName', + 'in' => 'path', + 'schema' => [ + 'description' => 'The name of the feature.'."\n", + 'type' => 'string', + 'required' => true, + 'example' => 'ctr', + ], + ], + [ + 'name' => 'instanceName', + 'in' => 'path', + 'schema' => [ + 'description' => 'The name of the instance.'."\n", + 'type' => 'string', + 'required' => true, + 'example' => 'ctr_test', + ], + ], + [ + 'name' => 'output', + 'in' => 'query', + 'schema' => [ + 'description' => 'Specifies the richness of returned information. Valid values:'."\n" + ."\n" + .'* simple: displays only the basic information.'."\n" + .'* normal: displays information such as createParameters and cron. This is the default value.'."\n" + .'* detail: returns the details of the training task.'."\n", + 'type' => 'string', + 'required' => false, + 'example' => 'detail', + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'description' => 'The response body.'."\n", + 'type' => 'object', + 'properties' => [ + 'Status' => [ + 'description' => 'The status of the request.'."\n", + 'type' => 'string', + 'example' => 'OK', + ], + 'HttpCode' => [ + 'description' => 'The HTTP status code.'."\n", + 'type' => 'integer', + 'format' => 'int64', + 'example' => '200', + ], + 'RequestId' => [ + 'description' => 'The ID of the request.'."\n", + 'type' => 'string', + 'example' => '68ED4E1B-92B8-5821-A886-9C90686139EB', + ], + 'Message' => [ + 'description' => 'The error message.'."\n", + 'type' => 'string', + 'example' => 'instance not exist.', + ], + 'Code' => [ + 'description' => 'The error code. If no error occurs, this parameter is left empty.'."\n", + 'type' => 'string', + 'example' => 'Instance.NotExist', + ], + 'Result' => [ + 'description' => 'The details of the instance.'."\n", + 'type' => 'object', + 'properties' => [ + 'Belongs' => [ + 'description' => 'The information about the instance.'."\n", + 'type' => 'object', + 'properties' => [ + 'Category' => [ + 'description' => 'The category.'."\n", + 'type' => 'string', + 'example' => 'general', + ], + 'Domain' => [ + 'description' => 'The industry.'."\n", + 'type' => 'string', + 'example' => 'ecommerce', + ], + 'Language' => [ + 'description' => 'The abbreviation of the language that applies.'."\n", + 'type' => 'string', + 'example' => 'zh'."\n", + ], + ], + ], + 'CreateParameters' => [ + 'description' => 'The parameters that are used to create the instance.'."\n", + 'type' => 'array', + 'items' => [ + 'description' => 'The parameter body.'."\n", + 'type' => 'object', + 'properties' => [ + 'Name' => [ + 'description' => 'The name of the parameter.'."\n", + 'type' => 'string', + 'example' => 'param1', + ], + 'Value' => [ + 'description' => 'The value of the parameter.'."\n", + 'type' => 'string', + 'example' => 'value1', + ], + ], + ], + ], + 'UsageParameters' => [ + 'description' => 'The parameters that are used.'."\n", + 'type' => 'array', + 'items' => [ + 'description' => 'The parameter body.'."\n", + 'type' => 'object', + 'properties' => [ + 'Name' => [ + 'description' => 'The name of the parameter.'."\n", + 'type' => 'string', + 'example' => 'use_param1', + ], + 'Value' => [ + 'description' => 'The value of the parameter.'."\n", + 'type' => 'string', + 'example' => 'value1', + ], + ], + ], + ], + 'CreateTime' => [ + 'description' => 'The time when the task was created. Unit: milliseconds.'."\n", + 'type' => 'integer', + 'format' => 'int64', + 'example' => '1234', + ], + 'Cron' => [ + 'description' => 'The cron expression used to schedule training, in the format of (Minutes Hours DayofMonth Month DayofWeek). If the value is empty, it indicates that no periodic training is performed.'."\n", + 'type' => 'string', + 'example' => '0 3 ? \\* 0,1,3,5 (at 3 a.m. on Sunday, Monday, Wednesday, and Friday)'."\n", + ], + 'Description' => [ + 'description' => 'The description of the instance.'."\n", + 'type' => 'string', + 'example' => 'instance descriptions', + ], + 'ExtendInfo' => [ + 'description' => 'The extended information, which is a JSON string.'."\n", + 'type' => 'string', + 'example' => '{\\"dataReport\\":{},\\"errors\\":{}}', + ], + 'FunctionName' => [ + 'description' => 'The name of the feature.'."\n", + 'type' => 'string', + 'example' => 'ctr', + ], + 'FunctionType' => [ + 'description' => 'The type of the feature.'."\n", + 'type' => 'string', + 'example' => 'PAAS', + ], + 'InstanceName' => [ + 'description' => 'The name of the instance.'."\n", + 'type' => 'string', + 'example' => 'ctr_test', + ], + 'ModelType' => [ + 'description' => 'The type of the model.'."\n", + 'type' => 'string', + 'example' => 'tf_checkpoint', + ], + 'Source' => [ + 'description' => 'How the instance is created. Valid values:'."\n" + ."\n" + .'* user: The instance is created by user.'."\n" + .'* builtin: The instance is created by the system.'."\n", + 'type' => 'string', + 'example' => 'user', + ], + 'Status' => [ + 'description' => 'The status of the instance. Valid values:'."\n" + ."\n" + .'1. unavailable: No model is available. Models must be trained before you can use them.'."\n" + .'2. available: Models can be used.'."\n", + 'type' => 'string', + 'example' => 'available', + ], + 'Task' => [ + 'description' => 'The information about the training task. This parameter is not displayed if no task is available.'."\n", + 'type' => 'object', + 'properties' => [ + 'DagStatus' => [ + 'description' => 'The status of the task. Valid values:'."\n" + ."\n" + .'* success: succeeded'."\n" + .'* failed: failed'."\n" + .'* untrained: to be trained'."\n" + .'* pending: being scheduled'."\n" + .'* running: being trained'."\n", + 'type' => 'string', + 'example' => 'success', + ], + 'LastRunTime' => [ + 'description' => 'The time consumed for the most recent run, in milliseconds.'."\n", + 'type' => 'integer', + 'format' => 'int64', + 'example' => '1234', + ], + ], + ], + 'VersionId' => [ + 'description' => 'The ID of the version.'."\n", + 'type' => 'integer', + 'format' => 'int64', + 'example' => '101', + ], + ], + 'example' => '{}', + ], + 'Latency' => [ + 'description' => 'The time consumed for the request, in milliseconds.'."\n", + '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' => 'GetFunctionInstance', + 'requestParamsDescription' => '### Sample requests'."\n" + ."\n" + .'`GET /v4/openapi/app-groups/my-app/functions/ctr/instances/ctr_test?output=detail`'."\n", + 'responseParamsDescription' => '### Sample success responses'."\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": "test",'."\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' => 'Deletes an algorithm instance. Before you delete an instance, make sure that it is not in use to prevent service interruptions.', + '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' => 'The name of the application.'."\n", + 'type' => 'string', + 'required' => true, + 'example' => '“my_app_group_name”', + ], + ], + [ + 'name' => 'functionName', + 'in' => 'path', + 'schema' => [ + 'title' => '功能名称', + 'description' => 'The name of the feature.'."\n", + 'type' => 'string', + 'required' => true, + 'example' => '"ctr"', + ], + ], + [ + 'name' => 'instanceName', + 'in' => 'path', + 'schema' => [ + 'title' => '实例名称', + 'description' => 'The name of the instance.'."\n", + 'type' => 'string', + 'required' => true, + 'example' => '"ctr_test"', + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'description' => 'The result of the request.'."\n", + 'type' => 'object', + 'properties' => [ + 'Status' => [ + 'description' => 'The status of the request. Valid values:'."\n" + ."\n" + .'* OK: The request is successful.'."\n" + .'* FAIL: The request fails.'."\n", + 'type' => 'string', + 'example' => '"OK"', + ], + 'HttpCode' => [ + 'description' => 'The HTTP status code.'."\n", + 'type' => 'integer', + 'format' => 'int64', + 'example' => '200', + ], + 'RequestId' => [ + 'description' => 'The ID of the request.'."\n", + 'type' => 'string', + 'example' => '"1081EB05-473C-5BF4-95BE-6D7CAD5E2213"', + ], + 'Message' => [ + 'description' => 'The error message. If no error occurs, this parameter is left empty.'."\n", + 'type' => 'string', + 'example' => '"instance not exist."', + ], + 'Code' => [ + 'description' => 'The error code. If no error occurs, this parameter is left empty.'."\n", + 'type' => 'string', + 'example' => '"Instance.NotExist"', + ], + 'Latency' => [ + 'description' => 'The time consumed for the request, in milliseconds.'."\n", + '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' => 'DeleteFunctionInstance', + 'requestParamsDescription' => '### Sample requests'."\n" + ."\n" + .'`DELETE /v4/openapi/app-groups/my-app/functions/ctr/instances/ctr_test`'."\n", + ], + 'UpdateFunctionInstance' => [ + 'summary' => 'Updates an algorithm instance.', + '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' => 'The parameter body.'."\n", + 'type' => 'object', + 'properties' => [ + 'cron' => [ + 'title' => '周期训练', + 'description' => 'The cron expression used to schedule periodic training, in the format of (Minutes Hours DayofMonth Month DayofWeek). The default value is empty, which indicates that no periodic training is performed. DayofWeek 0 indicates Sunday.'."\n", + 'type' => 'string', + 'required' => false, + 'example' => '"0 3 ? * 0,1,3,5"', + ], + 'createParameters' => [ + 'title' => '创建参数', + 'description' => 'The parameters that are used to create the instance.'."\n", + 'type' => 'array', + 'items' => [ + 'description' => 'The parameter body.'."\n", + 'type' => 'object', + 'properties' => [ + 'name' => [ + 'title' => '参数名称', + 'description' => 'The name of the parameter.'."\n", + 'type' => 'string', + 'required' => false, + 'example' => 'title_field', + ], + 'value' => [ + 'title' => '参数值', + 'description' => 'The value of the parameter.'."\n", + 'type' => 'string', + 'required' => false, + 'example' => 'title', + ], + ], + 'required' => false, + 'example' => '{}', + ], + 'required' => false, + 'example' => '{ "name": "title_field", "value": "title" }', + ], + 'usageParameters' => [ + 'title' => '使用参数', + 'description' => 'The parameters that are used.'."\n", + 'type' => 'array', + 'items' => [ + 'description' => 'The parameter body.'."\n", + 'type' => 'object', + 'properties' => [ + 'name' => [ + 'description' => 'The name of the parameter.'."\n", + 'type' => 'string', + 'required' => false, + 'example' => 'allow_dict_id', + ], + 'value' => [ + 'description' => 'The value of the parameter.'."\n", + 'type' => 'string', + 'required' => false, + 'example' => '123', + ], + ], + 'required' => false, + ], + 'required' => false, + ], + 'description' => [ + 'title' => '实例描述', + 'description' => 'The description of the instance.'."\n", + 'type' => 'string', + 'required' => false, + 'example' => 'test instance'."\n", + ], + ], + 'required' => false, + 'example' => '{}', + ], + ], + [ + 'name' => 'appGroupIdentity', + 'in' => 'path', + 'schema' => [ + 'title' => 'opensearch应用名', + 'description' => 'The name of the application.'."\n", + 'type' => 'string', + 'required' => true, + 'example' => '"app_group_name"', + ], + ], + [ + 'name' => 'functionName', + 'in' => 'path', + 'schema' => [ + 'title' => '功能名称', + 'description' => 'The name of the feature.'."\n", + 'type' => 'string', + 'required' => true, + 'example' => '"ctr"', + ], + ], + [ + 'name' => 'instanceName', + 'in' => 'path', + 'schema' => [ + 'title' => '实例名称', + 'description' => 'The name of the instance.'."\n", + 'type' => 'string', + 'required' => true, + 'example' => '"ctr_test"', + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'title' => 'Schema of Response', + 'description' => 'The schema of the response.'."\n", + 'type' => 'object', + 'properties' => [ + 'Status' => [ + 'description' => 'The status of the request. Valid values:'."\n" + ."\n" + .'* OK: The request was successful.'."\n" + .'* FAIL: The request failed.'."\n", + 'type' => 'string', + 'example' => 'OK', + ], + 'HttpCode' => [ + 'description' => 'The HTTP status code.'."\n", + 'type' => 'integer', + 'format' => 'int64', + 'example' => '200', + ], + 'RequestId' => [ + 'description' => 'The ID of the request.'."\n", + 'type' => 'string', + 'example' => '"3A809095-C554-5CF5-8FCE-BE19D4673790"', + ], + 'Message' => [ + 'title' => '错误信息', + 'description' => 'The error message.'."\n", + 'type' => 'string', + 'example' => '"instance not exist."', + ], + 'Code' => [ + 'title' => '错误码', + 'description' => 'The error code.'."\n", + 'type' => 'string', + 'example' => '"Instance.NotExist"', + ], + 'Latency' => [ + 'title' => '耗时', + 'description' => 'The time consumed for the request, in milliseconds.'."\n", + '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' => 'UpdateFunctionInstance', + 'requestParamsDescription' => '### Sample requests (Only the createParameters and cron parameters are updated.)'."\n" + ."\n" + .'`PUT /v4/openapi/app-groups/my-app/functions/ctr/instances/ctr_test`'."\n" + ."\n" + .' {'."\n" + .' "createParameters": ['."\n" + .' {'."\n" + .' "name": "param1",'."\n" + .' "value": "new value"'."\n" + .' }'."\n" + .' ],'."\n" + .' "cron": ""'."\n" + .' }'."\n", + ], + 'CreateFunctionInstance' => [ + 'summary' => 'Creates an algorithm instance of a feature.', + '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' => 'The request body.'."\n", + 'type' => 'object', + 'properties' => [ + 'instanceName' => [ + 'title' => '实例名称', + 'description' => 'The instance name. The name must be 1 to 30 characters in length and can contain letters, digits, and underscores (\\_). The name is case-sensitive and must start with a letter.'."\n", + 'type' => 'string', + 'required' => true, + 'example' => 'ctr_test', + ], + 'modelType' => [ + 'title' => '模型类型', + 'description' => 'The model type. The value varies based on the model.'."\n" + ."\n" + .'* Click-through rate (CTR) model: tf_checkpoint'."\n" + .'* Popularity model: pop'."\n" + .'* Category model: offline_inference'."\n" + .'* Hotword model: offline_inference'."\n" + .'* Hint model: offline_inference'."\n" + .'* Hotword model for real-time top searches: near_realtime'."\n" + .'* Personalized hint model: near_realtime'."\n" + .'* Drop-down suggestion model: offline_inference'."\n" + .'* Tokenization model: text'."\n" + .'* Term weight model: tf_checkpoint'."\n" + .'* Synonym model: offline_inference'."\n", + 'type' => 'string', + 'required' => true, + 'example' => 'tf_checkpoint', + ], + 'functionType' => [ + 'title' => '功能类型', + 'description' => 'The feature type.'."\n" + ."\n" + .'* Default value: PAAS. Training is required before you can use the feature.'."\n", + 'type' => 'string', + 'required' => false, + 'example' => 'PAAS', + ], + 'description' => [ + 'title' => '实例描述', + 'description' => 'The description.'."\n", + 'type' => 'string', + 'required' => false, + 'example' => 'test instance'."\n", + ], + 'createParameters' => [ + 'title' => '创建参数', + 'description' => 'The parameters used to create the instance.'."\n", + 'type' => 'array', + 'items' => [ + 'description' => 'The parameter body.'."\n", + 'type' => 'object', + 'properties' => [ + 'name' => [ + 'title' => '参数名称', + 'description' => 'The parameter name.'."\n", + 'type' => 'string', + 'required' => false, + 'example' => 'title_field', + ], + 'value' => [ + 'title' => '参数值', + 'description' => 'The parameter value.'."\n", + 'type' => 'string', + 'required' => false, + 'example' => 'title', + ], + ], + 'required' => false, + 'example' => '{ "name": "title_field", "value": "title" }', + ], + 'required' => false, + 'example' => '[ { "name": "param1", "value": "val1" } ]', + ], + 'usageParameters' => [ + 'title' => '使用参数', + 'description' => 'The parameters used to use the instance.'."\n", + 'type' => 'array', + 'items' => [ + 'description' => 'The parameters that are used online, such as the blacklist and whitelist.'."\n", + 'type' => 'object', + 'properties' => [ + 'name' => [ + 'title' => '参数名称', + 'description' => 'The parameter name.'."\n", + 'type' => 'string', + 'required' => false, + 'example' => 'allow_dict_id', + ], + 'value' => [ + 'title' => '参数值', + 'description' => 'The parameter value.'."\n", + 'type' => 'string', + 'required' => false, + 'example' => '123', + ], + ], + 'required' => false, + ], + 'required' => false, + ], + 'cron' => [ + 'title' => '周期训练', + 'description' => 'The CRON expression used to schedule periodic training, in the format of Minutes Hours DayofMonth Month DayofWeek. The default value is empty, which specifies that no periodic training is performed. A value of 0 for DayofWeek specifies Sunday.'."\n", + 'type' => 'string', + 'required' => false, + 'example' => '0 0 ? * 0,1,2,3,4,5,6', + ], + ], + 'required' => false, + 'docRequired' => true, + 'example' => '', + ], + ], + [ + 'name' => 'appGroupIdentity', + 'in' => 'path', + 'schema' => [ + 'description' => 'The name of the application.'."\n", + 'type' => 'string', + 'required' => true, + 'example' => 'my_app_group_name', + ], + ], + [ + 'name' => 'functionName', + 'in' => 'path', + 'schema' => [ + 'description' => 'The feature name. Valid values:'."\n" + ."\n" + .'* ctr: CTR model.'."\n" + .'* pop: popularity model.'."\n" + .'* category: category model.'."\n" + .'* hot: hotword model.'."\n" + .'* hint: hint model.'."\n" + .'* suggest: drop-down suggestion model.'."\n" + .'* analyzer: tokenization model.'."\n" + .'* termweight: term weight model.'."\n" + .'* synonym: synonym model.'."\n", + 'type' => 'string', + 'required' => true, + 'example' => 'ctr', + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'description' => 'The parameter body.'."\n", + 'type' => 'object', + 'properties' => [ + 'Status' => [ + 'description' => 'The status of the request.'."\n", + 'type' => 'string', + 'example' => 'OK', + ], + 'HttpCode' => [ + 'description' => 'The HTTP status code.'."\n", + 'type' => 'integer', + 'format' => 'int64', + 'example' => '200', + ], + 'RequestId' => [ + 'description' => 'The ID of the request.'."\n", + 'type' => 'string', + 'example' => '98724351-D6B2-5D8A-B089-7FFD1821A7E9', + ], + 'Message' => [ + 'description' => 'The error message. If no error occurs, this parameter is left empty.'."\n", + 'type' => 'string', + 'example' => 'version not exist.', + ], + 'Code' => [ + 'description' => 'The error code.'."\n", + 'type' => 'string', + 'example' => 'Version.NotExist', + ], + 'Latency' => [ + 'description' => 'The time consumed for the request, in milliseconds.'."\n", + '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' => 'CreateFunctionInstance', + 'description' => 'You can call the [GetFunctionCurrentVersion](~~421377~~) operation to query the latest version of a feature. The response of the operation includes the createParameters parameter that is used to create an algorithm instance, the usageParameters parameter, and the requirements for setting these parameters.'."\n", + 'requestParamsDescription' => '### Sample requests (In this example, the functionName parameter is set to 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" + .'### Sample requests (In this example, the functionName parameter is set to 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' => '### Sample success responses'."\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' => 'The application name.'."\n", + 'type' => 'string', + 'required' => true, + 'docRequired' => true, + 'example' => 'my_app_group_name', + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'type' => 'object', + 'properties' => [ + 'requestId' => [ + 'description' => 'The request ID.'."\n", + 'type' => 'string', + 'example' => '0A6EB64B-B4C8-CF02-810F-E660812972FF', + ], + 'result' => [ + 'description' => 'The information about the application.'."\n", + 'type' => 'object', + 'properties' => [ + 'created' => [ + 'description' => 'The timestamp when the application was created.'."\n", + 'type' => 'integer', + 'format' => 'int32', + 'example' => '1575442875', + ], + 'currentVersion' => [ + 'description' => 'The ID of the current online version.'."\n", + 'type' => 'string', + 'example' => '110116134', + ], + 'pendingSecondRankAlgoDeploymentId' => [ + 'description' => 'The ID of the fine sort expression that is being created.'."\n", + 'type' => 'integer', + 'format' => 'int32', + 'example' => '0', + ], + 'lockMode' => [ + 'description' => 'The lock state. Valid values:'."\n" + ."\n" + .'* Unlock: The instance is unlocked.'."\n" + .'* LockByExpiration: The instance is automatically locked after it expires.'."\n" + .'* ManualLock: The instance is manually locked.'."\n", + 'type' => 'string', + 'example' => 'Unlock', + ], + 'updated' => [ + 'description' => 'The timestamp when the application was last updated.'."\n", + 'type' => 'integer', + 'format' => 'int32', + 'example' => '1578916076', + ], + 'id' => [ + 'description' => 'The application ID.'."\n", + 'type' => 'string', + 'example' => '110116134', + ], + 'chargeType' => [ + 'description' => 'The billing method. Valid values:'."\n" + ."\n" + .'* POSTPAY: pay-as-you-go.'."\n" + .'* PREPAY: subscription.'."\n", + 'type' => 'string', + 'example' => 'POSTPAY', + ], + 'hasPendingQuotaReviewTask' => [ + 'description' => 'The approval state of the quotas. Valid values:'."\n" + ."\n" + .'* 0: The application is in service.'."\n" + .'* 1: The quotas are being reviewed.'."\n", + 'type' => 'integer', + 'format' => 'int32', + 'example' => '0', + ], + 'secondRankAlgoDeploymentId' => [ + 'description' => 'The ID of the created fine sort expression.'."\n", + 'type' => 'integer', + 'format' => 'int32', + 'example' => '0', + ], + 'name' => [ + 'description' => 'The application name.'."\n", + 'type' => 'string', + 'example' => 'os_function_test_v1', + ], + 'instanceId' => [ + 'description' => 'The instance ID.'."\n", + 'type' => 'string', + 'example' => '-', + ], + 'processingOrderId' => [ + 'description' => 'The ID of the order that is not complete.'."\n", + 'type' => 'string', + 'example' => '-', + ], + 'chargingWay' => [ + 'description' => 'The billable item. Valid values:'."\n" + ."\n" + .'* 1: computing resources.'."\n" + .'* 2: queries per second (QPS).'."\n", + 'type' => 'integer', + 'format' => 'int32', + 'example' => '1', + ], + 'type' => [ + 'description' => 'The type of the application. Valid values:'."\n" + ."\n" + .'* standard: a High-performance Search Edition application.'."\n" + .'* enhanced: an Industry Algorithm Edition application.', + 'type' => 'string', + 'example' => 'enhanced', + ], + 'status' => [ + 'description' => 'The state of the application. Valid values:'."\n" + ."\n" + .'* producing: The application is being created.'."\n" + .'* review_pending: The application is being reviewed.'."\n" + .'* config_pending: The application is to be configured.'."\n" + .'* normal: The application is in service.'."\n" + .'* frozen: The application is frozen.'."\n", + 'type' => 'string', + 'example' => 'normal', + ], + 'projectId' => [ + 'description' => 'The name of the A/B test group.'."\n", + 'type' => 'string', + 'example' => '-', + ], + 'switchedTime' => [ + 'description' => 'The timestamp when the current online version was published.'."\n", + 'type' => 'integer', + 'format' => 'int32', + 'example' => '0', + ], + 'commodityCode' => [ + 'description' => 'The commodity code.'."\n", + 'type' => 'string', + 'example' => 'opensearch', + ], + 'expireOn' => [ + 'description' => 'The expiration time.'."\n", + 'type' => 'string', + 'example' => '-', + ], + 'domain' => [ + 'description' => 'The industry of the application.'."\n", + 'type' => 'string', + 'example' => 'ecommerce', + ], + 'description' => [ + 'description' => 'The description of the application.'."\n", + 'type' => 'string', + 'example' => '-', + ], + 'firstRankAlgoDeploymentId' => [ + 'description' => 'The ID of the created rough sort expression.'."\n", + 'type' => 'integer', + 'format' => 'int32', + 'example' => '0', + ], + 'produced' => [ + 'description' => 'Indicates whether the application is created. Valid values:'."\n" + ."\n" + .'* 0: The application is being created.'."\n" + .'* 1: The application is created.'."\n", + 'type' => 'integer', + 'format' => 'int32', + 'example' => '1', + ], + 'lockedByExpiration' => [ + 'description' => 'Indicates whether the instance is automatically locked after it expires.'."\n", + 'type' => 'integer', + 'format' => 'int32', + 'example' => '0', + ], + 'quota' => [ + 'description' => 'The information about the quotas of the application.'."\n", + 'type' => 'object', + 'properties' => [ + 'spec' => [ + 'description' => 'The specifications. Valid values:'."\n" + ."\n" + .'* opensearch.share.junior: basic.'."\n" + .'* opensearch.share.common: shared general-purpose.'."\n" + .'* opensearch.share.compute: shared computing.'."\n" + .'* opensearch.share.storage: shared storage.'."\n" + .'* opensearch.private.common: exclusive general-purpose.'."\n" + .'* opensearch.private.compute: exclusive computing.'."\n" + .'* opensearch.private.storage: exclusive storage.'."\n", + 'type' => 'string', + 'example' => 'opensearch.share.common', + ], + 'docSize' => [ + 'description' => 'The storage capacity. Unit: GB.'."\n", + 'type' => 'integer', + 'format' => 'int32', + 'example' => '1', + ], + 'computeResource' => [ + 'description' => 'The computing resources. Unit: logical computing unit (LCU).'."\n", + 'type' => 'integer', + 'format' => 'int32', + 'example' => '20', + ], + ], + ], + 'tags' => [ + 'description' => 'The application tags.'."\n", + 'type' => 'array', + 'items' => [ + 'description' => '', + 'type' => 'object', + 'properties' => [ + 'key' => [ + 'description' => 'The tag key.'."\n", + 'type' => 'string', + 'example' => 'foo', + ], + 'value' => [ + 'description' => 'The tag value'."\n", + 'type' => 'string', + 'example' => 'bar', + ], + ], + ], + ], + 'resourceGroupId' => [ + 'description' => 'The ID of the resource group to which the network instance belongs.'."\n", + 'type' => 'string', + 'example' => 'rg-acfmoiyerh6nzly', + ], + 'engineType' => [ + 'description' => 'The engine type.'."\n", + 'type' => 'string', + 'example' => 'ha3', + ], + ], + ], + ], + 'description' => '', + ], + ], + '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":"<requestId>0A6EB64B-B4C8-CF02-810F-E660812972FF</requestId>\\n<result>\\n <id>110116134</id>\\n <name>os_function_test_v1</name>\\n <currentVersion>110116134</currentVersion>\\n <switchedTime>0</switchedTime>\\n <quota>\\n <docSize>1</docSize>\\n <computeResource>20</computeResource>\\n <spec>opensearch.share.common</spec>\\n </quota>\\n <chargingWay>1</chargingWay>\\n <type>enhanced</type>\\n <versions>100298792</versions>\\n <projectId/>\\n <chargeType>POSTPAY</chargeType>\\n <expireOn/>\\n <instanceId/>\\n <commodityCode>opensearch</commodityCode>\\n <processingOrderId/>\\n <firstRankAlgoDeploymentId>0</firstRankAlgoDeploymentId>\\n <secondRankAlgoDeploymentId>0</secondRankAlgoDeploymentId>\\n <pendingSecondRankAlgoDeploymentId>0</pendingSecondRankAlgoDeploymentId>\\n <description/>\\n <produced>1</produced>\\n <lockedByExpiration>0</lockedByExpiration>\\n <hasPendingQuotaReviewTask>0</hasPendingQuotaReviewTask>\\n <created>1575442875</created>\\n <updated>1578916076</updated>\\n <status>normal</status>\\n <lockMode>Unlock</lockMode>\\n</result>","errorExample":""}]', + 'title' => 'DescribeAppGroup', + 'summary' => 'Queries the details of an OpenSearch application.', + 'requestParamsDescription' => ' ', + 'responseParamsDescription' => ' ', + 'extraInfo' => ' ', + ], + 'ValidateDataSources' => [ + 'summary' => 'Verifies data sources.', + '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' => 'The request parameter. For more information, see [DataSource](~~170005~~).'."\n", + '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' => 'The result returned.'."\n", + 'type' => 'array', + 'items' => [ + 'description' => 'The result that was returned.'."\n", + 'type' => 'object', + 'properties' => [ + 'code' => [ + 'description' => 'The code returned for the request.'."\n", + 'type' => 'string', + 'example' => 'SUCCEED', + ], + 'message' => [ + 'description' => 'The status of the execution.'."\n", + 'type' => 'string', + 'example' => 'successful', + ], + 'dataSource' => [ + 'description' => 'The data source.'."\n", + 'type' => 'object', + 'properties' => [ + 'tableName' => [ + 'description' => 'The name of the table.'."\n", + 'type' => 'string', + 'example' => 'user_activity_decision', + ], + 'type' => [ + 'description' => 'The type of the data source.', + 'type' => 'string', + 'example' => 'rds', + ], + 'parameters' => [ + 'description' => 'The parameters of the data source.', + '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' => 'ValidateDataSources', + ], + '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' => 'The name of the application'."\n", + 'type' => 'string', + 'required' => true, + 'docRequired' => true, + 'example' => 'my_app', + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'description' => 'The response body.'."\n", + 'type' => 'object', + 'properties' => [ + 'requestId' => [ + 'description' => 'The request ID.'."\n", + 'type' => 'string', + 'example' => 'AC5F78BA-66B9-545B-9CF1-8F542E682E1F', + ], + 'result' => [ + 'description' => 'The returned result.'."\n", + 'type' => 'object', + 'properties' => [ + 'created' => [ + 'description' => 'The timestamp when the application was created.'."\n", + 'type' => 'integer', + 'format' => 'int32', + 'example' => '1588054131', + ], + 'currentVersion' => [ + 'description' => 'The ID of the current online version.'."\n", + 'type' => 'string', + 'example' => '100302903', + ], + 'pendingSecondRankAlgoDeploymentId' => [ + 'description' => 'The ID of the fine sort expression that is being created.'."\n", + 'type' => 'integer', + 'format' => 'int32', + 'example' => '0', + ], + 'type' => [ + 'description' => 'The type of the application.'."\n", + 'type' => 'string', + 'example' => '-', + ], + 'chargingWay' => [ + 'description' => 'The billing type. Valid values:'."\n" + ."\n" + .'* 1: computing resources.'."\n" + .'* 2: queries per second (QPS).'."\n", + 'type' => 'integer', + 'format' => 'int32', + 'example' => '1', + ], + 'lockMode' => [ + 'description' => 'The lock state. Valid values:'."\n" + ."\n" + .'* Unlock: The instance is unlocked.'."\n" + .'* LockByExpiration: The instance is automatically locked after it expires.'."\n" + .'* ManualLock: The instance is manually locked.'."\n", + 'type' => 'string', + 'example' => 'Unlock', + ], + 'status' => [ + 'description' => 'The status of the application.'."\n", + 'type' => 'string', + 'example' => 'normal', + ], + 'updated' => [ + 'description' => 'The timestamp when the application was updated.'."\n", + 'type' => 'integer', + 'format' => 'int32', + 'example' => '1581065904', + ], + 'chargeType' => [ + 'description' => 'The billing method. Valid values:'."\n" + ."\n" + .'* POSTPAY: pay-as-you-go.'."\n" + .'* PREPAY: subscription.'."\n", + 'type' => 'string', + 'example' => 'POSTPAY', + ], + 'id' => [ + 'description' => 'The application ID.'."\n", + 'type' => 'string', + 'example' => '-', + ], + 'hasPendingQuotaReviewTask' => [ + 'description' => 'The approval state of the quotas. Valid values:'."\n" + ."\n" + .'* 0: The approval status is normal.'."\n" + .'* 1: The quotas are being approved.'."\n", + 'type' => 'integer', + 'format' => 'int32', + 'example' => '0', + ], + 'projectId' => [ + 'description' => 'The name of the A/B test group.'."\n", + 'type' => 'string', + 'example' => '-', + ], + 'secondRankAlgoDeploymentId' => [ + 'description' => 'The ID of the fine sort expression.'."\n", + 'type' => 'integer', + 'format' => 'int32', + 'example' => '0', + ], + 'commodityCode' => [ + 'description' => 'The code of the commodity.'."\n", + 'type' => 'string', + 'example' => 'opensearch', + ], + 'switchedTime' => [ + 'description' => 'The timestamp when the current online version was published.'."\n", + 'type' => 'integer', + 'format' => 'int32', + 'example' => '1590486386', + ], + 'expireOn' => [ + 'description' => 'The expiration time.'."\n", + 'type' => 'string', + 'example' => '-', + ], + 'description' => [ + 'description' => 'The description of the application.'."\n", + 'type' => 'string', + 'example' => '""', + ], + 'firstRankAlgoDeploymentId' => [ + 'description' => 'The ID of the rough sort expression.'."\n", + 'type' => 'integer', + 'format' => 'int32', + 'example' => '0', + ], + 'lockedByExpiration' => [ + 'description' => 'Indicates whether the instance is automatically locked after it expires. Valid values:'."\n" + ."\n" + .'* 0: The instance is not automatically locked after it expires.'."\n" + .'* 1: The instance is automatically locked after it expires.'."\n", + 'type' => 'integer', + 'format' => 'int32', + 'example' => '0', + ], + 'produced' => [ + 'description' => 'Indicates whether the order is produced.'."\n", + 'type' => 'integer', + 'format' => 'int32', + 'example' => '0', + ], + 'name' => [ + 'description' => 'The name of the order.'."\n", + 'type' => 'string', + 'example' => '-', + ], + 'processingOrderId' => [ + 'description' => 'The ID of the order that is in progress.'."\n", + 'type' => 'string', + 'example' => '-', + ], + 'instanceId' => [ + 'description' => 'The instance ID.'."\n", + 'type' => 'string', + 'example' => '-', + ], + 'versions' => [ + 'description' => 'The versions.'."\n", + 'type' => 'array', + 'items' => [ + 'description' => 'The version.'."\n", + 'type' => 'string', + 'example' => '-', + ], + ], + 'quota' => [ + 'description' => 'The configuration information.'."\n", + 'type' => 'object', + 'properties' => [ + 'spec' => [ + 'description' => 'The specifications configured.'."\n", + 'type' => 'string', + 'example' => '-', + ], + 'docSize' => [ + 'description' => 'The storage capacity.'."\n", + 'type' => 'integer', + 'format' => 'int32', + 'example' => '1', + ], + 'computeResource' => [ + 'description' => 'The number of computing resources configured.'."\n", + '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' => 'ReplaceAppGroupCommodityCode', + 'summary' => 'Converts a service-based application to an instance-based application.', + ], + 'ListSortScripts' => [ + 'summary' => 'Queries all sort scripts of an application version.', + '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' => 'The name or ID of the application.'."\n", + 'type' => 'string', + 'required' => true, + 'docRequired' => true, + 'example' => 'my_app', + ], + ], + [ + 'name' => 'appVersionId', + 'in' => 'path', + 'schema' => [ + 'description' => 'The version ID of the application.'."\n", + 'type' => 'string', + 'required' => true, + 'docRequired' => true, + 'example' => '110142366', + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'type' => 'object', + 'properties' => [ + 'requestId' => [ + 'description' => 'The request ID.'."\n", + 'type' => 'string', + 'example' => 'ABCDEFGH', + ], + 'result' => [ + 'description' => 'The scripts.'."\n", + 'type' => 'array', + 'items' => [ + 'type' => 'object', + 'properties' => [ + 'type' => [ + 'description' => 'The type of the script.'."\n", + 'type' => 'string', + 'example' => 'cava_script', + ], + 'scope' => [ + 'description' => 'The sort phase to which the script applies.'."\n", + 'type' => 'string', + 'example' => 'second_rank', + ], + 'createTime' => [ + 'description' => 'The time when the script was created.'."\n", + 'type' => 'string', + 'example' => '2020-04-02 20:21:14', + ], + 'status' => [ + 'description' => 'The status of the script. Valid values:'."\n" + ."\n" + .'* configurable: The script is created, but no script files are uploaded.'."\n" + .'* not compiled: The script is not compiled.'."\n" + .'* compile failed: The compilation of the script failed.'."\n" + .'* compile successful: The script is compiled.'."\n" + .'* released: The script is published.'."\n", + 'type' => 'string', + 'example' => 'released', + ], + 'modifyTime' => [ + 'description' => 'The time when the script was last modified.'."\n", + 'type' => 'string', + 'example' => '2020-04-02 21:21:14', + ], + 'scriptName' => [ + 'description' => 'The name of the script.'."\n", + 'type' => 'string', + 'example' => 'test', + ], + ], + ], + ], + ], + 'description' => '', + ], + ], + '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":"<requestId>ABCDEFGH</requestId>\\n<result>\\n <type>cava_script</type>\\n <scope>second_rank</scope>\\n <status>released</status>\\n <createTime>2020-04-02 20:21:14</createTime>\\n <modifyTime>2020-04-02 21:21:14</modifyTime>\\n</result>","errorExample":""}]', + 'title' => 'ListSortScripts', + 'requestParamsDescription' => ' ', + 'responseParamsDescription' => ' Error response'."\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' => 'The type of the data source. Valid values:'."\n" + ."\n" + .'* rds'."\n" + .'* polardb'."\n" + .'* odps'."\n" + .'* mysql'."\n" + .'* drds'."\n", + 'type' => 'string', + 'required' => true, + 'docRequired' => true, + 'example' => 'rds', + ], + ], + [ + 'name' => 'params', + 'in' => 'query', + 'schema' => [ + 'description' => 'The parameters of the data source. The value is a JSON string which must be encoded in the urlencode format.'."\n" + ."\n" + .'Different types of data sources use different parameters. For more information, see the following sections of the "DataSource" topic:'."\n" + ."\n" + .'* [rds](~~170005~~)'."\n" + .'* [polardb](~~170005~~)'."\n" + .'* [odps](~~170005~~)'."\n" + .'* [mysql](~~173627~~)'."\n" + .'* [drds](~~173627~~)'."\n", + 'type' => 'string', + 'required' => true, + 'docRequired' => true, + 'example' => '-', + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'type' => 'object', + 'properties' => [ + 'requestId' => [ + 'description' => 'The request ID.'."\n", + 'type' => 'string', + 'example' => '0A6EB64B-B4C8-CF02-810F-E660812972FF', + ], + 'result' => [ + 'type' => 'array', + 'items' => [ + 'description' => 'The returned result.'."\n", + 'type' => 'string', + 'example' => '{}', + ], + 'description' => '', + ], + ], + 'description' => '', + ], + ], + '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":"<requestId>0A6EB64B-B4C8-CF02-810F-E660812972FF</requestId>\\n<result>cate_test</result>\\n<result>offline_error</result>\\n<result>plugin</result>\\n<result>quota_test</result>\\n<result>smoke</result>\\n<result>smoke_1</result>\\n<result>smoke_2</result>\\n<result>students</result>","errorExample":""}]', + 'title' => 'ListDataSourceTables', + 'summary' => 'Obtains all data from a specified data source.', + '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' => 'The type of the data source. Valid values:'."\n" + ."\n" + .'* rds'."\n" + .'* polardb'."\n" + .'* odps'."\n" + .'* mysql'."\n" + .'* drds'."\n", + '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' => 'The parameters of the data source. The value of the params parameter is a JSON string. The value must be URL-encoded.'."\n" + ."\n" + .'Different types of data sources use different parameters. For more information, see the following sections of the "DataSource" topic:'."\n" + ."\n" + .'* [rds](~~170005~~)'."\n" + .'* [polardb](~~170005~~)'."\n" + .'* [odps](~~170005~~)'."\n" + .'* [mysql](~~173627~~)'."\n" + .'* [drds](~~173627~~)'."\n", + 'type' => 'string', + 'required' => true, + 'docRequired' => true, + 'example' => '{}', + ], + ], + [ + 'name' => 'rawType', + 'in' => 'query', + 'schema' => [ + 'description' => 'Specifies whether to return the original field types of the data source.'."\n", + 'type' => 'boolean', + 'required' => false, + 'example' => 'false', + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'description' => 'The response body.'."\n", + 'type' => 'object', + 'properties' => [ + 'result' => [ + 'description' => 'The returned result.'."\n", + 'type' => 'object', + 'example' => '{}', + ], + 'requestId' => [ + 'description' => 'The request ID.'."\n", + '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' => 'ListDataSourceTableFields', + 'summary' => 'Queries all fields in a table of a data source. This operation is for internal use only.', + ], + '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' => 'The type of the industry.'."\n", + 'type' => 'string', + 'required' => true, + 'docRequired' => true, + 'example' => '-', + ], + ], + [ + 'name' => 'appGroupIdentity', + 'in' => 'query', + 'schema' => [ + 'description' => 'The name or ID of the application.'."\n", + 'type' => 'string', + 'required' => true, + 'docRequired' => true, + 'example' => 'my_app_group_name', + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'type' => 'object', + 'properties' => [ + 'result' => [ + 'description' => 'The returned result.'."\n", + 'type' => 'object', + 'example' => '-', + ], + 'requestId' => [ + 'description' => 'The request ID.'."\n", + 'type' => 'string', + 'example' => 'ABCDEFGH', + ], + ], + 'description' => '', + ], + ], + '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' => 'GetDomain', + 'summary' => 'Queries the type of an industry.', + ], + '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' => 'The specifications of the OpenSearch instance. This parameter is used to check whether the OpenSearch instance meets the special limits on an exclusive instance.'."\n" + ."\n" + .'Default value: opensearch.share.common.'."\n" + ."\n" + .'For more information, see the description of the spec field in the Quota topic.'."\n", + 'type' => 'string', + 'required' => false, + 'example' => '"opensearch.share.common"', + ], + ], + [ + 'name' => 'body', + 'in' => 'body', + 'schema' => [ + 'description' => 'The request body parameters.'."\n", + 'required' => false, + '$ref' => '#/components/schemas/Schema', + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'type' => 'object', + 'properties' => [ + 'requestId' => [ + 'description' => 'The request ID.'."\n", + 'type' => 'string', + 'example' => 'ABCDEFGH', + ], + 'result' => [ + 'description' => 'The response parameters.'."\n", + 'type' => 'object', + 'properties' => [ + 'primaryKey' => [ + 'description' => 'The primary key.'."\n", + 'type' => 'string', + 'example' => '-', + ], + 'mergeTable' => [ + 'description' => 'The wide table that is generated after the JOIN operation is performed on multiple tables.'."\n", + 'type' => 'object', + 'example' => '-', + ], + 'fromTable' => [ + 'description' => 'The tables on which the JOIN operation is performed.'."\n", + 'type' => 'object', + 'example' => '-', + ], + ], + ], + ], + 'description' => '', + ], + ], + '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":"<requestId>8EF9C2DF-34C3-EDCF-6DEA-0445EE53DA20</requestId>\\n<result>\\n <mergeTable>\\n <id>\\n <name>id</name>\\n <type>INT</type>\\n <isPk>1</isPk>\\n <isMulti>0</isMulti>\\n <isAttribute>0</isAttribute>\\n </id>\\n <classid>\\n <name>classid</name>\\n <type>INT</type>\\n <isPk>0</isPk>\\n <isMulti>0</isMulti>\\n <isAttribute>0</isAttribute>\\n </classid>\\n <title>\\n <name>title</name>\\n <type>TEXT</type>\\n <isPk>0</isPk>\\n <isMulti>0</isMulti>\\n <isAttribute>0</isAttribute>\\n </title>\\n <js>\\n <name>js</name>\\n <type>TEXT</type>\\n <isPk>0</isPk>\\n <isMulti>0</isMulti>\\n <isAttribute>0</isAttribute>\\n </js>\\n <classid_1>\\n <name>classid_1</name>\\n <type>INT</type>\\n <isPk>0</isPk>\\n <isMulti>0</isMulti>\\n <isAttribute>0</isAttribute>\\n </classid_1>\\n <infotags>\\n <name>infotags</name>\\n <type>TEXT</type>\\n <isPk>0</isPk>\\n <isMulti>0</isMulti>\\n <isAttribute>0</isAttribute>\\n </infotags>\\n </mergeTable>\\n <fromTable>\\n <tables>\\n <phome_ecms_tuzhi>\\n <id>\\n <name>id</name>\\n <type>INT</type>\\n <isPk>1</isPk>\\n <isMulti>0</isMulti>\\n </id>\\n <classid>\\n <name>classid</name>\\n <type>INT</type>\\n <isPk>0</isPk>\\n <isMulti>0</isMulti>\\n </classid>\\n <title>\\n <name>title</name>\\n <type>TEXT</type>\\n <isPk>0</isPk>\\n <isMulti>0</isMulti>\\n </title>\\n <js>\\n <name>js</name>\\n <type>TEXT</type>\\n <isPk>0</isPk>\\n <isMulti>0</isMulti>\\n </js>\\n </phome_ecms_tuzhi>\\n <phome_ecms_tuzhi_data_1>\\n <id_1>\\n <name>id_1</name>\\n <type>INT</type>\\n <isPk>1</isPk>\\n <isMulti>0</isMulti>\\n </id_1>\\n <classid_1>\\n <name>classid_1</name>\\n <type>INT</type>\\n <isPk>0</isPk>\\n <isMulti>0</isMulti>\\n </classid_1>\\n <infotags>\\n <name>infotags</name>\\n <type>TEXT</type>\\n <isPk>0</isPk>\\n <isMulti>0</isMulti>\\n </infotags>\\n </phome_ecms_tuzhi_data_1>\\n </tables>\\n <master>phome_ecms_tuzhi</master>\\n <level>\\n <phome_ecms_tuzhi>0</phome_ecms_tuzhi>\\n <phome_ecms_tuzhi_data_1>1</phome_ecms_tuzhi_data_1>\\n </level>\\n <joinMap>\\n <phome_ecms_tuzhi>\\n <id>\\n <table>phome_ecms_tuzhi_data_1</table>\\n <key>id_1</key>\\n <join>\\n <classid_1>classid_1</classid_1>\\n <infotags>infotags</infotags>\\n </join>\\n </id>\\n </phome_ecms_tuzhi>\\n </joinMap>\\n </fromTable>\\n <primaryKey>id</primaryKey>\\n</result>","errorExample":""}]', + 'title' => 'GenerateMergedTable', + 'summary' => 'Queries the information about a wide table that is generated after a JOIN operation is performed on multiple tables.', + 'requestParamsDescription' => '**Request body**'."\n" + ."\n" + .'|Parameter|Type|Required|Example|Description|'."\n" + .'|---|---|---|---|---|'."\n" + .'|tables|Object|Yes||The table schema.|'."\n" + .'|indexes|Object|No||The index schema.|', + 'responseParamsDescription' => '**Response parameters**'."\n" + ."\n" + .'|Parameter|Type|Description|'."\n" + .'|---|---|---|'."\n" + .'|requestId|String|The request ID.|'."\n" + .'|result.mergeTable|Object|The wide table that is generated after the JOIN operation is performed on multiple tables. The key is the field name and the value is the field content.|'."\n" + .'|result.fromTable|Object|The information about the tables on which the JOIN operation is performed.|'."\n" + .'|result.fromTable.tables|Object|The information about the tables. The key is the table name and the value is the information about the table schema.|'."\n" + .'|result.fromTable.tables.\\*|Object|The key is the field name and the value is the field content.|'."\n" + .'|result.fromTable.master|String|The primary table.|'."\n" + .'|result.fromTable.level|Object|The information about table levels. The table level starts from 0.The key is the table name and the value is the table level.|'."\n" + .'|result.fromTable.joinMap|Object|The information about the external table. The key is the table name and the value is the information about the external table.|'."\n" + .'|result.fromTable.joinMap.\\*|Object|The information about the fields of the external table. The key is the field name and the value is the field content.|'."\n" + .'|result.primaryKey|String|The primary key field.|'."\n" + ."\n\n" + .'**TableFields**'."\n" + ."\n" + .'|Parameter|Type|Description|'."\n" + .'|---|---|---|'."\n" + .'|name|String|The name of the field.|'."\n" + .'|type|String|The type of the field. For more information, see [Fields in a data table](~~179404~~).|'."\n" + .'|isPk|String|Indicates whether the field is the primary key field. Valid values:0: The field is not the primary key field.1: The field is the primary key field.|'."\n" + .'|isMulti|Integer|Indicates whether the field is a multi-value field. Valid values:0: The field is not a multi-value field.1: The field is a multi-value field.|'."\n" + .'|isAttribute|Integer|Indicates whether the field is an attribute field. Valid values:0: The field is not an attribute field.1: The field is an attribute field.|'."\n" + ."\n\n" + .'**JoinMapFields**'."\n" + ."\n" + .'|Parameter|Type|Description|'."\n" + .'|---|---|---|'."\n" + .'|table|String|The name of the external table.|'."\n" + .'|key|String|The name of the primary key of the external table.|'."\n" + .'|join|Object|The extended fields of the external table.|', + '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' => 'The request ID.'."\n", + 'type' => 'string', + 'example' => '3B7E42BD-1D63-2F6B-C8E0-41BACEA76EEB', + ], + 'result' => [ + 'description' => 'The results returned.'."\n", + 'type' => 'array', + 'items' => [ + 'type' => 'object', + 'properties' => [ + 'endpoint' => [ + 'description' => 'The endpoint.'."\n", + 'type' => 'string', + 'example' => 'opensearch.cn-hangzhou.aliyuncs.com', + ], + 'regionId' => [ + 'description' => 'The region ID.'."\n", + 'type' => 'string', + 'example' => 'cn-hangzhou', + ], + 'localName' => [ + 'description' => 'The region name.'."\n", + 'type' => 'string', + 'example' => 'China (Hangzhou)'."\n", + ], + 'consoleUrl' => [ + 'description' => 'The console URL.'."\n", + 'type' => 'string', + 'example' => 'https://opensearch-cn-hangzhou.console.aliyun.com', + ], + ], + 'description' => '', + ], + ], + ], + 'description' => '', + ], + ], + '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":"<requestId>3B7E42BD-1D63-2F6B-C8E0-41BACEA76EEB</requestId>\\n<result>\\n <regionId>cn-hangzhou</regionId>\\n <localName>华东1（杭州）</localName>\\n <endpoint>opensearch.cn-hangzhou.aliyuncs.com</endpoint>\\n <consoleUrl>https://opensearch-cn-hangzhou.console.aliyun.com</consoleUrl>\\n</result>\\n<result>\\n <regionId>cn-shanghai</regionId>\\n <localName>华东2（上海）</localName>\\n <endpoint>opensearch.cn-shanghai.aliyuncs.com</endpoint>\\n <consoleUrl>https://opensearch-cn-shanghai.console.aliyun.com</consoleUrl>\\n</result>\\n<result>\\n <regionId>cn-qingdao</regionId>\\n <localName>华北1（青岛）</localName>\\n <endpoint>opensearch.cn-qingdao.aliyuncs.com</endpoint>\\n <consoleUrl>https://opensearch-cn-qingdao.console.aliyun.com</consoleUrl>\\n</result>\\n<result>\\n <regionId>cn-beijing</regionId>\\n <localName>华北2（北京）</localName>\\n <endpoint>opensearch.cn-beijing.aliyuncs.com</endpoint>\\n <consoleUrl>https://opensearch-cn-beijing.console.aliyun.com</consoleUrl>\\n</result>\\n<result>\\n <regionId>cn-zhangjiakou</regionId>\\n <localName>华北3（张家口）</localName>\\n <endpoint>opensearch.cn-zhangjiakou.aliyuncs.com</endpoint>\\n <consoleUrl>https://opensearch-cn-zhangjiakou.console.aliyun.com</consoleUrl>\\n</result>\\n<result>\\n <regionId>cn-shenzhen</regionId>\\n <localName>华南1（深圳）</localName>\\n <endpoint>opensearch.cn-shenzhen.aliyuncs.com</endpoint>\\n <consoleUrl>https://opensearch-cn-shenzhen.console.aliyun.com</consoleUrl>\\n</result>\\n<result>\\n <regionId>ap-southeast-1</regionId>\\n <localName>新加坡</localName>\\n <endpoint>opensearch.ap-southeast-1.aliyuncs.com</endpoint>\\n <consoleUrl>https://opensearch-ap-southeast-1.console.aliyun.com</consoleUrl>\\n</result>\\n<result>\\n <regionId>cn-internal</regionId>\\n <localName>内网1（中心）</localName>\\n <endpoint>opensearch.cn-zhangbei-center.aliyuncs.com</endpoint>\\n <consoleUrl>https://opensearch-cn-shanghai-in.console.aliyun.com</consoleUrl>\\n</result>\\n<result>\\n <regionId>cn-zhangbei-in</regionId>\\n <localName>内网2（张北）</localName>\\n <endpoint>opensearch.cn-zhangbei-in.aliyuncs.com</endpoint>\\n <consoleUrl>https://opensearch-cn-zhangbei-in.console.aliyun.com</consoleUrl>\\n</result>\\n<result>\\n <regionId>us-west-1-in</regionId>\\n <localName>内网3（美国）</localName>\\n <endpoint>opensearch.innet-us.aliyuncs.com</endpoint>\\n <consoleUrl>http://opensearch-us-in.console.aliyun.com</consoleUrl>\\n</result>\\n<result>\\n <regionId>rus-west-1-in</regionId>\\n <localName>内网4（俄罗斯）</localName>\\n <endpoint/>\\n <consoleUrl>https://opensearch-rg-ru-in.console.aliyun.com</consoleUrl>\\n</result>\\n<result>\\n <regionId>cn-daily</regionId>\\n <localName>内网日常</localName>\\n <endpoint>opensearch.cn-daily.aliyuncs.com</endpoint>\\n <consoleUrl>https://opensearch-cn-daily.console.aliyun.com</consoleUrl>\\n</result>\\n<result>\\n <regionId>pre-hangzhou</regionId>\\n <localName>杭州预发</localName>\\n <endpoint>opensearch.pre-hangzhou.aliyuncs.com</endpoint>\\n <consoleUrl>https://opensearch-pre-hangzhou.console.aliyun.com</consoleUrl>\\n</result>","errorExample":""}]', + 'title' => 'DescribeRegions', + 'summary' => 'Queries the endpoints of all regions that support OpenSearch.', + ], + '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' => 'The application name.'."\n", + 'type' => 'string', + 'required' => true, + 'docRequired' => true, + 'example' => 'my_app_group_name', + ], + ], + [ + 'name' => 'dataCollectionIdentity', + 'in' => 'path', + 'schema' => [ + 'description' => 'The ID of the data collection task.'."\n", + 'type' => 'string', + 'required' => true, + 'docRequired' => true, + 'example' => '286', + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'type' => 'object', + 'properties' => [ + 'requestId' => [ + 'description' => 'The request ID.'."\n", + 'type' => 'string', + 'example' => '72FAD77B-83F9-F393-BA8E-5834E2427BF8', + ], + 'result' => [ + 'description' => 'The details of the data collection task.'."\n", + 'type' => 'object', + 'properties' => [ + 'created' => [ + 'description' => 'The time when the task was created.'."\n", + 'type' => 'integer', + 'format' => 'int32', + 'example' => '1581065837', + ], + 'dataCollectionType' => [ + 'description' => 'The type of data collected. Valid values:'."\n" + ."\n" + .'* behavior: behavioral data.'."\n" + .'* item_info: project information.'."\n" + .'* industry_specific: industry-specific data.'."\n", + 'type' => 'string', + 'example' => 'BEHAVIOR', + ], + 'type' => [ + 'description' => 'The type of the source from which data was collected. Valid values:'."\n" + ."\n" + .'* server'."\n" + .'* web'."\n" + .'* app Note: Only server is supported.'."\n", + 'type' => 'string', + 'example' => 'server', + ], + 'industryName' => [ + 'description' => 'The industry name. Valid values:'."\n" + ."\n" + .'* general'."\n" + .'* ecommerce'."\n", + 'type' => 'string', + 'example' => 'GENERAL', + ], + 'status' => [ + 'description' => 'The status of the data collection feature. Valid values:'."\n" + ."\n" + .'* 0: The feature is disabled.'."\n" + .'* 1: The feature is being enabled.'."\n" + .'* 2: The feature is enabled.'."\n" + .'* 3: The feature failed to be enabled.'."\n", + 'type' => 'integer', + 'format' => 'int32', + 'example' => '2', + ], + 'updated' => [ + 'description' => 'The time when the data collection task was updated.'."\n", + 'type' => 'integer', + 'format' => 'int32', + 'example' => '1581065904', + ], + 'name' => [ + 'description' => 'The name of the data collection task.'."\n", + 'type' => 'string', + 'example' => 'os_function_test_v1', + ], + 'sundialId' => [ + 'description' => 'The sundial ID.'."\n", + 'type' => 'string', + 'example' => '1755', + ], + 'id' => [ + 'description' => 'The ID of the data collection task.'."\n", + 'type' => 'string', + 'example' => '286', + ], + ], + ], + ], + 'description' => '', + ], + ], + '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":"<requestId>72FAD77B-83F9-F393-BA8E-5834E2427BF8</requestId>\\n<result>\\n <id>286</id>\\n <name>os_function_test_v1</name>\\n <type>server</type>\\n <status>2</status>\\n <dataCollectionType>BEHAVIOR</dataCollectionType>\\n <industryName>GENERAL</industryName>\\n <created>1581065837</created>\\n <updated>1581065904</updated>\\n <sundialId>1755</sundialId>\\n</result>","errorExample":""}]', + 'title' => 'DescribeDataCollction', + 'summary' => 'Queries the details of a data collection task of an application.', + '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' => 'The name of the application.'."\n", + 'type' => 'string', + 'required' => true, + 'docRequired' => true, + 'example' => 'my_app_group_name', + ], + ], + [ + 'name' => 'pageNumber', + 'in' => 'query', + 'schema' => [ + 'description' => 'The page number. Default value: 1.'."\n", + 'type' => 'integer', + 'format' => 'int32', + 'required' => false, + 'example' => '1', + ], + ], + [ + 'name' => 'pageSize', + 'in' => 'query', + 'schema' => [ + 'description' => 'The number of entries per page. Default value: 10.'."\n", + 'type' => 'integer', + 'format' => 'int32', + 'required' => false, + 'example' => '10', + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'type' => 'object', + 'properties' => [ + 'totalCount' => [ + 'description' => 'The total number of entries returned.'."\n", + 'type' => 'integer', + 'format' => 'int32', + 'example' => '1', + ], + 'requestId' => [ + 'description' => 'The request ID.'."\n", + 'type' => 'string', + 'example' => '959D8782-B130-95EB-86CC-1F6ED447981F', + ], + 'result' => [ + 'description' => 'The details of the data collection task.'."\n" + ."\n" + .'For more information, see [DataCollection](~~173605~~).'."\n", + 'type' => 'array', + 'items' => [ + 'type' => 'object', + 'properties' => [ + 'created' => [ + 'description' => 'The time when the task was created.'."\n", + 'type' => 'integer', + 'format' => 'int32', + 'example' => '1581065837', + ], + 'dataCollectionType' => [ + 'description' => 'The type of data collected. Valid values:'."\n" + ."\n" + .'* behavior: behavioral data.'."\n" + .'* item_info: project information.'."\n" + .'* industry_specific: industry-specific data.'."\n", + 'type' => 'string', + 'example' => 'BEHAVIOR', + ], + 'type' => [ + 'description' => 'The type of the source from which data was collected. Valid values:'."\n" + ."\n" + .'* server'."\n" + .'* web'."\n" + .'* app'."\n" + ."\n" + .'Only server is supported.'."\n", + 'type' => 'string', + 'example' => 'server', + ], + 'industryName' => [ + 'description' => 'The industry name. Valid values:'."\n" + ."\n" + .'* general'."\n" + .'* ecommerce'."\n", + 'type' => 'string', + 'example' => 'GENERAL', + ], + 'status' => [ + 'description' => 'The status of the data collection feature. Valid values:'."\n" + ."\n" + .'* 0: The feature is disabled.'."\n" + .'* 1: The feature is being enabled.'."\n" + .'* 2: The feature is enabled.'."\n" + .'* 3: The feature failed to be enabled.'."\n", + 'type' => 'integer', + 'format' => 'int32', + 'example' => '2', + ], + 'updated' => [ + 'description' => 'The time when the data collection task was updated.'."\n", + 'type' => 'integer', + 'format' => 'int32', + 'example' => '1581065904', + ], + 'name' => [ + 'description' => 'The name of the data collection task.'."\n", + 'type' => 'string', + 'example' => 'os_function_test_v1', + ], + 'sundialId' => [ + 'description' => 'The sundial ID.'."\n", + 'type' => 'string', + 'example' => '1755', + ], + 'id' => [ + 'description' => 'The data collection ID.'."\n", + 'type' => 'string', + 'example' => '286', + ], + ], + 'description' => '', + ], + ], + ], + 'description' => '', + ], + ], + '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":"<requestId>959D8782-B130-95EB-86CC-1F6ED447981F</requestId>\\n<totalCount>1</totalCount>\\n<result>\\n <id>286</id>\\n <name>os_function_test_v1</name>\\n <type>server</type>\\n <status>2</status>\\n <dataCollectionType>BEHAVIOR</dataCollectionType>\\n <industryName>GENERAL</industryName>\\n <created>1581065837</created>\\n <updated>1581065904</updated>\\n <sundialId>1755</sundialId>\\n</result>","errorExample":""}]', + 'title' => 'ListDataCollections', + 'summary' => 'Queries the data collection tasks of an OpenSearch application.', + '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' => 'The name of the application'."\n", + 'type' => 'string', + 'required' => true, + 'docRequired' => true, + 'example' => '“my_app_group_name”', + ], + ], + [ + 'name' => 'dataCollectionIdentity', + 'in' => 'path', + 'schema' => [ + 'description' => 'The data collection ID.'."\n", + 'type' => 'string', + 'required' => true, + 'docRequired' => true, + 'example' => '286', + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'type' => 'object', + 'properties' => [ + 'result' => [ + 'description' => '-', + 'type' => 'string', + 'example' => '{}', + ], + 'requestId' => [ + 'description' => 'The request ID.'."\n", + 'type' => 'string', + 'example' => 'D77D0DAF-790D-F5F5-A9C0-133738165014', + ], + ], + 'description' => '', + ], + ], + '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":"<requestId>D77D0DAF-790D-F5F5-A9C0-133738165014</requestId>\\n<result/>","errorExample":""}]', + 'title' => 'RemoveDataCollection', + 'summary' => 'Disables data collection.', + 'requestParamsDescription' => ' ', + 'responseParamsDescription' => ' ', + 'extraInfo' => ' ', + ], + 'UntagResources' => [ + 'summary' => 'Remove tags from resources.', + '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' => 'The resource type.'."\n", + 'type' => 'string', + 'required' => true, + 'example' => 'ProductVersion', + ], + ], + [ + 'name' => 'resourceId', + 'in' => 'query', + 'style' => 'json', + 'schema' => [ + 'title' => '资源ID,最多 50个子项', + 'description' => 'The resource IDs. You can specify a maximum number of 50 IDs.'."\n", + 'type' => 'array', + 'items' => [ + 'description' => 'The IDs of the resources that you want to query. You must configure at least one of the resourceId and tagKey parameters.'."\n", + 'type' => 'string', + 'required' => false, + 'example' => '55111', + ], + 'required' => true, + ], + ], + [ + 'name' => 'tagKey', + 'in' => 'query', + 'style' => 'json', + 'schema' => [ + 'title' => '对应标签键列表，最多包含20个子项', + 'description' => 'The keys of tags. You can specify a maximum number of 20 keys.'."\n", + 'type' => 'array', + 'items' => [ + 'description' => 'The key of a tag.'."\n", + 'type' => 'string', + 'required' => false, + 'example' => 'GENIE_FUNCTION', + ], + 'required' => false, + ], + ], + [ + 'name' => 'all', + 'in' => 'query', + 'schema' => [ + 'title' => '是否全部删除，只针对tags为空时有效。取值范围： true false True False 默认是 false', + 'description' => 'Specifies whether to remove all tags from the specified one or more resources. This parameter takes effect only if the tagKey parameter is not specified. Valid values: true and false. Default value: false.'."\n", + 'type' => 'boolean', + 'required' => false, + 'example' => 'true', + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'description' => 'The response body.'."\n", + 'type' => 'object', + 'properties' => [ + 'tequestId' => [ + 'description' => 'The ID of the request.'."\n", + 'type' => 'string', + 'example' => '1-A-0-B', + ], + ], + ], + ], + ], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"tequestId\\": \\"1-B-2-V\\"\\n}","type":"json"}]', + 'title' => 'UntagResources', + ], + 'ListTagResources' => [ + 'summary' => 'Queries tagged resources.', + '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' => 'The resource type.'."\n", + 'type' => 'string', + 'required' => true, + 'example' => 'BIGDATA', + ], + ], + [ + 'name' => 'resourceId', + 'in' => 'query', + 'style' => 'json', + 'schema' => [ + 'title' => '资源ID,最多 50个子项', + 'description' => 'The resource IDs. You can specify a maximum number of 50 resource IDs.'."\n", + 'type' => 'array', + 'items' => [ + 'description' => 'The IDs of the resources that you want to query. You must configure at least one of the resourceId and tag parameters.'."\n", + 'type' => 'string', + 'required' => false, + 'example' => 'i-bp185wwblwfvh1a1y1me', + ], + 'required' => false, + ], + ], + [ + 'name' => 'tag', + 'in' => 'query', + 'style' => 'json', + 'schema' => [ + 'title' => '对应新增标签列表，最多包含20个子项', + 'description' => 'The tags. You can specify a maximum number of 20 tags.'."\n", + 'type' => 'array', + 'items' => [ + 'description' => 'The internal name of the entity type.'."\n", + 'type' => 'object', + 'properties' => [ + 'key' => [ + 'title' => '标签键', + 'description' => 'The key of the tag.'."\n", + 'type' => 'string', + 'required' => false, + 'example' => 'bm', + ], + 'value' => [ + 'title' => '标签值', + 'description' => 'The value of the tag.'."\n", + 'type' => 'string', + 'required' => false, + 'example' => 'Uefi', + ], + ], + 'required' => false, + ], + 'required' => false, + ], + ], + [ + 'name' => 'nextToken', + 'in' => 'query', + 'schema' => [ + 'title' => '下一个查询开始Token', + 'description' => 'The token that is used to retrieve the next page.'."\n", + 'type' => 'string', + 'required' => false, + 'example' => '60', + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'type' => 'object', + 'properties' => [ + 'requestId' => [ + 'title' => '请求id', + 'description' => 'The ID of the request.'."\n", + 'type' => 'string', + 'example' => 'D77D0DAF-790D-F5F5-A9C0-133738165014', + ], + 'nextToken' => [ + 'title' => '下一个查询开始Token', + 'description' => 'The token that is used to retrieve the next page.'."\n", + 'type' => 'string', + 'example' => '20', + ], + 'result' => [ + 'title' => '资源列表', + 'description' => 'The resources.'."\n", + 'type' => 'array', + 'items' => [ + 'description' => 'The result of the request.'."\n", + 'type' => 'object', + 'properties' => [ + 'tagKey' => [ + 'title' => '标签键', + 'description' => 'The key of the tag.'."\n", + 'type' => 'string', + 'example' => 'GENIE_FUNCTION', + ], + 'tagValue' => [ + 'title' => '标签值', + 'description' => 'The value of the tag.'."\n", + 'type' => 'string', + 'example' => 'ALLOW', + ], + 'resourceId' => [ + 'title' => '资源ID', + 'description' => 'The ID of the resource.'."\n", + 'type' => 'string', + 'example' => '54041', + ], + 'resourceType' => [ + 'title' => '资源类型', + 'description' => 'The resource type.'."\n", + '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' => 'ListTagResources', + ], + 'TagResources' => [ + 'summary' => 'Adds tags to resources.', + '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' => 'The request parameters.'."\n", + 'type' => 'object', + 'properties' => [ + 'resourceType' => [ + 'title' => '资源类型', + 'description' => 'The resource type.'."\n", + 'type' => 'string', + 'required' => true, + 'example' => 'ProductVersion', + ], + 'resourceId' => [ + 'title' => '资源ID,最多 50个子项', + 'description' => 'The resource IDs. You can specify a maximum number of 50 resource IDs.'."\n", + 'type' => 'array', + 'items' => [ + 'description' => 'The ID of the resource.'."\n", + 'type' => 'string', + 'required' => false, + 'example' => '68968', + ], + 'required' => true, + ], + 'tag' => [ + 'title' => '对应新增标签列表，最多包含20个子项', + 'description' => 'The tags. You can specify a maximum number of 20 tags.'."\n", + 'type' => 'array', + 'items' => [ + 'description' => 'The internal name of the entity type.'."\n", + 'type' => 'object', + 'properties' => [ + 'key' => [ + 'title' => '标签键', + 'description' => 'The key of the tag.'."\n", + 'type' => 'string', + 'required' => false, + 'example' => 'cloud_manage', + ], + 'value' => [ + 'title' => '标签值', + 'description' => 'The value of the tag.'."\n", + 'type' => 'string', + 'required' => false, + 'example' => '31261301', + ], + ], + 'required' => false, + ], + 'required' => true, + ], + ], + 'required' => false, + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'description' => 'The response body.'."\n", + 'type' => 'object', + 'properties' => [ + 'requestId' => [ + 'title' => '请求id', + 'description' => 'The ID of the request.'."\n", + 'type' => 'string', + 'example' => 'ABCDEFGH', + ], + ], + ], + ], + ], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"requestId\\": \\"ABCDEFGH\\"\\n}","type":"json"}]', + 'title' => 'TagResources', + ], + 'GetFunctionResource' => [ + 'summary' => 'Queries an algorithm resource.', + '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' => 'The ID of the application.'."\n", + 'type' => 'string', + 'required' => true, + 'example' => 'my_app_group_name', + ], + ], + [ + 'name' => 'functionName', + 'in' => 'path', + 'schema' => [ + 'title' => '功能名称', + 'description' => 'The name of the feature.'."\n", + 'type' => 'string', + 'required' => true, + 'example' => 'rank', + ], + ], + [ + 'name' => 'resourceName', + 'in' => 'path', + 'schema' => [ + 'title' => '实例名称', + 'description' => 'The name of the instance.'."\n", + 'type' => 'string', + 'required' => true, + 'example' => 'fg_json', + ], + ], + [ + 'name' => 'output', + 'in' => 'query', + 'schema' => [ + 'title' => '输出等级', + 'description' => 'The output level.'."\n" + ."\n" + .'Valid values:'."\n" + ."\n" + .'* simple'."\n" + .'* normal'."\n" + .'* detail'."\n", + 'type' => 'string', + 'required' => false, + 'example' => 'detail', + 'enum' => [ + 'simple', + 'normal', + 'detail', + ], + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'type' => 'object', + 'properties' => [ + 'Status' => [ + 'description' => 'The HTTP status code. Valid values:'."\n" + ."\n" + .'* OK'."\n" + .'* FAIL'."\n", + 'type' => 'string', + 'example' => 'OK', + ], + 'HttpCode' => [ + 'description' => 'The HTTP status code returned.'."\n", + 'type' => 'integer', + 'format' => 'int64', + 'example' => '200', + ], + 'RequestId' => [ + 'description' => 'The request ID.'."\n", + 'type' => 'string', + 'example' => 'E215C843-0795-5293-AC9A-14FE0723E890', + ], + 'Message' => [ + 'description' => 'The error message returned.'."\n", + 'type' => 'string', + 'example' => 'Resource not exist.', + ], + 'Code' => [ + 'description' => 'The error code returned. If no error occurs, this value is empty.'."\n", + 'type' => 'string', + 'example' => 'Resource.NotExist', + ], + 'Result' => [ + 'description' => 'The returned results.'."\n", + 'type' => 'object', + 'properties' => [ + 'CreateTime' => [ + 'description' => 'The time when the resource was created. Unit: milliseconds.'."\n", + 'type' => 'integer', + 'format' => 'int64', + 'example' => '1234', + ], + 'Data' => [ + 'description' => 'The resource data. The data structure varies with the resource type.'."\n", + 'type' => 'object', + 'properties' => [ + 'Content' => [ + 'description' => 'The content of the file that corresponds to a resource of the raw_file type.'."\n", + 'type' => 'string', + 'example' => 'abc', + ], + 'Generators' => [ + 'description' => 'The feature generators that correspond to resources of the feature_generator type.'."\n", + 'type' => 'array', + 'items' => [ + 'description' => '', + 'type' => 'object', + 'properties' => [ + 'Generator' => [ + 'description' => 'The type of the feature generator.'."\n", + 'type' => 'string', + 'example' => 'id', + ], + 'Input' => [ + 'description' => 'The input.'."\n", + 'type' => 'object', + 'properties' => [ + 'Features' => [ + 'description' => 'The input features.'."\n", + 'type' => 'array', + 'items' => [ + 'description' => '', + 'type' => 'object', + 'properties' => [ + 'Name' => [ + 'description' => 'The name of the feature.'."\n", + 'type' => 'string', + 'example' => 'system_item_id', + ], + 'Type' => [ + 'description' => 'The type of the feature.'."\n", + 'type' => 'string', + 'example' => 'item', + ], + ], + ], + ], + ], + ], + 'Output' => [ + 'description' => 'The name of the output feature.'."\n", + 'type' => 'string', + 'example' => 'output_feature_name', + ], + ], + ], + ], + ], + ], + 'Description' => [ + 'description' => 'The description of the resource.'."\n", + 'type' => 'string', + 'example' => '""', + ], + 'FunctionName' => [ + 'description' => 'The name of the feature.'."\n", + 'type' => 'string', + 'example' => 'rank', + ], + 'ModifyTime' => [ + 'description' => 'The time when the resource was modified. Unit: milliseconds.'."\n", + 'type' => 'integer', + 'format' => 'int64', + 'example' => '1234', + ], + 'ReferencedInstances' => [ + 'description' => 'The algorithm instances that are referenced.'."\n", + 'type' => 'array', + 'items' => [ + 'description' => 'The name of the instance.'."\n", + 'type' => 'string', + 'example' => 'instance1', + ], + ], + 'ResourceName' => [ + 'description' => 'The name of the resource.'."\n", + 'type' => 'string', + 'example' => 'fg_json', + ], + 'ResourceType' => [ + 'description' => 'The type of the resource.'."\n", + 'type' => 'string', + 'example' => 'raw_file', + ], + ], + ], + 'Latency' => [ + 'description' => 'The time consumed for the API request. Unit: milliseconds.'."\n", + 'type' => 'number', + 'format' => 'double', + 'example' => '123', + ], + ], + 'description' => '', + ], + ], + ], + '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' => 'GetFunctionResource', + ], + 'ListFunctionResources' => [ + 'summary' => 'Queries algorithm resources.', + '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' => 'The application ID.'."\n", + 'type' => 'string', + 'required' => true, + 'example' => 'my_app_group_name', + ], + ], + [ + 'name' => 'functionName', + 'in' => 'path', + 'schema' => [ + 'title' => '功能名称', + 'description' => 'The name of the feature.'."\n", + 'type' => 'string', + 'required' => true, + 'example' => 'rank', + ], + ], + [ + 'name' => 'resourceType', + 'in' => 'query', + 'schema' => [ + 'title' => '资源类型', + 'description' => 'The type of the resource.'."\n" + ."\n" + .'Valid values:'."\n" + ."\n" + .'* feature_generator'."\n" + ."\n" + .' <!-- -->'."\n" + ."\n" + .' <!-- -->'."\n" + ."\n" + .' <!-- -->'."\n" + ."\n" + .'* raw_file'."\n" + ."\n" + .' <!-- -->'."\n" + ."\n" + .' <!-- -->'."\n" + ."\n" + .' <!-- -->'."\n", + 'type' => 'string', + 'required' => false, + 'enumValueTitles' => [ + 'feature_generator' => 'feature_generator', + 'raw_file' => 'raw_file', + ], + 'example' => 'feature_generator', + ], + ], + [ + 'name' => 'output', + 'in' => 'query', + 'schema' => [ + 'title' => '输出等级', + 'description' => 'The output level.'."\n" + ."\n" + .'Valid values:'."\n" + ."\n" + .'* simple'."\n" + .'* normal'."\n" + .'* detail'."\n", + 'type' => 'string', + 'required' => false, + 'example' => 'detail', + 'enum' => [ + 'simple', + 'normal', + 'detail', + ], + ], + ], + [ + 'name' => 'pageNumber', + 'in' => 'query', + 'schema' => [ + 'title' => '页码', + 'description' => 'The page number.'."\n", + 'type' => 'integer', + 'format' => 'int32', + 'required' => false, + 'example' => '1', + 'default' => '1', + ], + ], + [ + 'name' => 'pageSize', + 'in' => 'query', + 'schema' => [ + 'title' => '分页大小', + 'description' => 'The number of entries returned per page.'."\n", + 'type' => 'integer', + 'format' => 'int32', + 'required' => false, + 'example' => '10', + 'default' => '10', + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'type' => 'object', + 'properties' => [ + 'Status' => [ + 'description' => 'The status of the request. Valid values: OK and FAIL.'."\n", + 'type' => 'string', + 'example' => 'OK', + ], + 'HttpCode' => [ + 'description' => 'The HTTP status code returned.'."\n", + 'type' => 'integer', + 'format' => 'int64', + 'example' => '200', + ], + 'TotalCount' => [ + 'description' => 'The total number of records that meet the requirements.'."\n", + 'type' => 'integer', + 'format' => 'int64', + 'example' => '2', + ], + 'RequestId' => [ + 'description' => 'The request ID.'."\n", + 'type' => 'string', + 'example' => '"3A809095-C554-5CF5-8FCE-BE19D4673790"', + ], + 'Message' => [ + 'description' => 'The error message returned.'."\n", + 'type' => 'string', + 'example' => 'Invalid resource name.', + ], + 'Code' => [ + 'description' => 'The error code returned. If no error occurs, this value is empty.'."\n", + 'type' => 'string', + 'example' => 'Resource.InvalidResourceName', + ], + 'Result' => [ + 'description' => 'The results returned.'."\n", + 'type' => 'array', + 'items' => [ + 'description' => '', + 'type' => 'object', + 'properties' => [ + 'CreateTime' => [ + 'description' => 'The time when the resource was created. Unit: milliseconds.'."\n", + 'type' => 'integer', + 'format' => 'int64', + 'example' => '1234', + ], + 'Data' => [ + 'description' => 'The resource data. The data structure varies with the resource type.'."\n", + 'type' => 'object', + 'properties' => [ + 'Content' => [ + 'description' => 'The content of the file that corresponds to a resource of the raw_file type.'."\n", + 'type' => 'string', + 'example' => '"abc"', + ], + 'Generators' => [ + 'description' => 'The feature generators that correspond to resources of the feature_generator type.'."\n", + 'type' => 'array', + 'items' => [ + 'description' => '', + 'type' => 'object', + 'properties' => [ + 'Generator' => [ + 'description' => 'The type of the feature generator.'."\n", + 'type' => 'string', + 'example' => 'combo', + ], + 'Input' => [ + 'description' => 'The input.'."\n", + 'type' => 'object', + 'properties' => [ + 'Features' => [ + 'description' => 'The input features.'."\n", + 'type' => 'array', + 'items' => [ + 'description' => '', + 'type' => 'object', + 'properties' => [ + 'Name' => [ + 'description' => 'The name of the feature.'."\n", + 'type' => 'string', + 'example' => 'system_item_id', + ], + 'Type' => [ + 'description' => 'The type of the feature.'."\n" + ."\n" + .'Valid values:'."\n" + ."\n" + .'* item'."\n" + ."\n" + .' <!-- -->'."\n" + ."\n" + .' <!-- -->'."\n" + ."\n" + .' <!-- -->'."\n" + ."\n" + .'* user'."\n" + ."\n" + .' <!-- -->'."\n" + ."\n" + .' <!-- -->'."\n" + ."\n" + .' <!-- -->'."\n", + 'type' => 'string', + 'enumValueTitles' => [ + 'item' => 'item', + 'user' => 'user', + ], + 'example' => 'item', + ], + ], + ], + ], + ], + ], + 'Output' => [ + 'description' => 'The name of the output feature.'."\n", + 'type' => 'string', + 'example' => 'feature1', + ], + ], + ], + ], + ], + ], + 'Description' => [ + 'description' => 'The description of the resource.'."\n", + 'type' => 'string', + 'example' => 'resource description', + ], + 'FunctionName' => [ + 'description' => 'The name of the feature.'."\n", + 'type' => 'string', + 'example' => 'rank', + ], + 'ModifyTime' => [ + 'description' => 'The time when the resource was modified. Unit: milliseconds.'."\n", + 'type' => 'integer', + 'format' => 'int64', + 'example' => '1234', + ], + 'ReferencedInstances' => [ + 'description' => 'The algorithm instances that are referenced.'."\n", + 'type' => 'array', + 'items' => [ + 'description' => 'The name of the instance.'."\n", + 'type' => 'string', + 'example' => 'rank_model1', + ], + ], + 'ResourceName' => [ + 'description' => 'The name of the resource.'."\n", + 'type' => 'string', + 'example' => 'fg_json', + ], + 'ResourceType' => [ + 'description' => 'The type of the resource.'."\n", + 'type' => 'string', + 'example' => 'feature_generator', + ], + ], + ], + ], + 'Latency' => [ + 'description' => 'The amount of time consumed for the request. Unit: milliseconds.'."\n", + 'type' => 'number', + 'format' => 'double', + 'example' => '123', + ], + ], + 'description' => '', + ], + ], + ], + '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' => 'ListFunctionResources', + ], + 'DeleteFunctionResource' => [ + 'summary' => 'Deletes an algorithm resource.', + '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' => 'The application ID.'."\n", + 'type' => 'string', + 'required' => true, + 'example' => 'my_app_group_name', + ], + ], + [ + 'name' => 'functionName', + 'in' => 'path', + 'schema' => [ + 'title' => '功能名称', + 'description' => 'The name of the feature.'."\n", + 'type' => 'string', + 'required' => true, + 'example' => 'rank', + ], + ], + [ + 'name' => 'resourceName', + 'in' => 'path', + 'schema' => [ + 'title' => '资源名称', + 'description' => 'The name of the resource.'."\n", + 'type' => 'string', + 'required' => true, + 'example' => 'fg_json', + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'type' => 'object', + 'properties' => [ + 'Status' => [ + 'description' => 'The status code. Valid values:'."\n" + ."\n" + .'* OK'."\n" + .'* FAIL'."\n", + 'type' => 'string', + 'example' => 'OK', + ], + 'HttpCode' => [ + 'description' => 'The HTTP status code returned.'."\n", + 'type' => 'integer', + 'format' => 'int64', + 'example' => '200', + ], + 'RequestId' => [ + 'description' => 'The request ID.'."\n", + 'type' => 'string', + 'example' => 'A4D487A9-A456-5AA5-A9C6-B7BF2889CF74', + ], + 'Message' => [ + 'description' => 'The error message.'."\n", + 'type' => 'string', + 'example' => '""', + ], + 'Code' => [ + 'description' => 'The error code returned. If no error occurs, this value is empty.'."\n", + 'type' => 'string', + 'example' => '""', + ], + 'Latency' => [ + 'description' => 'The time consumed for the request. Unit: milliseconds.'."\n", + 'type' => 'number', + 'format' => 'double', + 'example' => '123', + ], + ], + 'description' => '', + ], + ], + ], + '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' => 'DeleteFunctionResource', + ], + 'UpdateFunctionResource' => [ + 'summary' => 'Updates an algorithm resource.', + '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' => 'The application ID.'."\n", + 'type' => 'string', + 'required' => true, + 'example' => 'my_app_group_name', + ], + ], + [ + 'name' => 'functionName', + 'in' => 'path', + 'schema' => [ + 'title' => '功能名称', + 'description' => 'The name of the feature.'."\n", + 'type' => 'string', + 'required' => true, + 'example' => 'rank', + ], + ], + [ + 'name' => 'resourceName', + 'in' => 'path', + 'schema' => [ + 'title' => '资源名称', + 'description' => 'The name of the resource.'."\n", + 'type' => 'string', + 'required' => true, + 'example' => 'fg_json', + ], + ], + [ + 'name' => 'body', + 'in' => 'body', + 'style' => 'json', + 'schema' => [ + 'description' => 'The body of the request.'."\n", + 'type' => 'object', + 'properties' => [ + 'Data' => [ + 'description' => 'The resource data. The data structure varies with the resource type.'."\n", + 'type' => 'object', + 'properties' => [ + 'Content' => [ + 'description' => 'The content of the file that corresponds to a resource of the raw_file type.'."\n", + 'type' => 'string', + 'required' => false, + 'example' => 'abc', + ], + 'Generators' => [ + 'description' => 'The feature generators that correspond to resources of the feature_generator type.'."\n", + 'type' => 'array', + 'items' => [ + 'description' => '', + 'type' => 'object', + 'properties' => [ + 'Generator' => [ + 'description' => 'The type of the feature generator.'."\n", + 'type' => 'string', + 'required' => false, + 'example' => 'combo', + ], + 'Input' => [ + 'description' => 'The input.'."\n", + 'type' => 'object', + 'properties' => [ + 'Features' => [ + 'description' => 'The input features.'."\n", + 'type' => 'array', + 'items' => [ + 'description' => '', + 'type' => 'object', + 'properties' => [ + 'Name' => [ + 'description' => 'The name of the feature.'."\n", + 'type' => 'string', + 'required' => false, + 'example' => 'system_item_id', + ], + 'Type' => [ + 'description' => 'The type of the feature.'."\n", + 'type' => 'string', + 'required' => false, + 'example' => 'item', + ], + ], + 'required' => false, + ], + 'required' => false, + ], + ], + 'required' => false, + ], + 'Output' => [ + 'description' => 'The name of the output feature.'."\n", + 'type' => 'string', + 'required' => false, + 'example' => 'feature1', + ], + ], + 'required' => false, + ], + 'required' => false, + ], + ], + 'required' => false, + ], + 'Description' => [ + 'description' => 'The description of the resource.'."\n", + 'type' => 'string', + 'required' => false, + 'example' => 'updated description', + ], + ], + 'required' => false, + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'type' => 'object', + 'properties' => [ + 'Status' => [ + 'description' => 'The status of the request.'."\n", + 'type' => 'string', + 'example' => 'OK', + ], + 'HttpCode' => [ + 'description' => 'The HTTP status code returned.'."\n", + 'type' => 'integer', + 'format' => 'int64', + 'example' => '200', + ], + 'RequestId' => [ + 'description' => 'The request ID.'."\n", + 'type' => 'string', + 'example' => '7E375703-5B12-5466-8B48-C4D01AE1291A', + ], + 'Message' => [ + 'description' => 'The error message returned.'."\n", + 'type' => 'string', + 'example' => 'Invalid request.', + ], + 'Code' => [ + 'description' => 'The error code. If no error occurs, this parameter is left empty.'."\n", + 'type' => 'string', + 'example' => 'InvalidRequest', + ], + 'Latency' => [ + 'description' => 'The time consumed for the request. Unit: milliseconds.'."\n", + 'type' => 'number', + 'format' => 'double', + 'example' => '123', + ], + ], + 'description' => '', + ], + ], + ], + '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' => 'UpdateFunctionResource', + 'description' => 'You can call this operation to update the information about resources by resource name. You can modify only the values of data and description.'."\n", + ], + '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' => '', + 'type' => 'boolean', + 'required' => false, + ], + ], + [ + 'name' => 'body', + 'in' => 'body', + 'style' => 'json', + 'schema' => [ + 'description' => '', + 'type' => 'object', + 'properties' => [ + 'type' => [ + 'description' => '', + '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' => '', + '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' => 'CreateAppGroupCredentials', + ], + ], + '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', + ], + ], +]; |