summaryrefslogtreecommitdiff
path: root/data/en_us/searchplat/2024-04-01
diff options
context:
space:
mode:
authorZhineng Li <im@zhineng.li>2026-07-12 17:11:17 +0800
committerZhineng Li <im@zhineng.li>2026-07-12 17:11:17 +0800
commit1c7f908ce09f98fdcbf79ed2a8ae21be60eaa634 (patch)
tree5f0857666365b7e40cdaa3733ebe1f3ba9e13c67 /data/en_us/searchplat/2024-04-01
parent7347bac4ab7e136157fc94777e6cf87ef9e08599 (diff)
downloadafterglow-metadata-full-1c7f908ce09f98fdcbf79ed2a8ae21be60eaa634.tar.gz
afterglow-metadata-full-1c7f908ce09f98fdcbf79ed2a8ae21be60eaa634.zip
update APIs 20260712
Diffstat (limited to 'data/en_us/searchplat/2024-04-01')
-rw-r--r--data/en_us/searchplat/2024-04-01/api-docs.php6608
1 files changed, 6606 insertions, 2 deletions
diff --git a/data/en_us/searchplat/2024-04-01/api-docs.php b/data/en_us/searchplat/2024-04-01/api-docs.php
index 19d0733..02d36a3 100644
--- a/data/en_us/searchplat/2024-04-01/api-docs.php
+++ b/data/en_us/searchplat/2024-04-01/api-docs.php
@@ -1,4 +1,6608 @@
<?php return [
- 'code' => 500,
- 'message' => 'server error',
+ 'version' => '1.0',
+ 'info' => ['style' => 'ROA', 'product' => 'Searchplat', 'version' => '2024-04-01'],
+ 'directories' => [
+ [
+ 'children' => ['UpdateCredentials', 'CreateCredentials', 'DeleteCredentials', 'GetCredentials'],
+ 'type' => 'directory',
+ 'title' => 'Access credential',
+ ],
+ [
+ 'children' => ['GetExperienceData', 'DeleteExperienceData', 'CreateExperienceData', 'ListExperienceData'],
+ 'type' => 'directory',
+ 'title' => 'Experience data',
+ ],
+ [
+ 'children' => ['CreateAsyncTask'],
+ 'type' => 'directory',
+ 'title' => 'Asynchronous task',
+ ],
+ [
+ 'children' => ['ResumeFunctionInstance', 'UpdateFunctionInstance', 'ListFunctionInstances', 'CeaseFunctionInstance', 'CreateFunctionInstance', 'CreateFunctionTask', 'DeleteFunctionInstance', 'GetFunctionInstance', 'ListFunctionRestrictions'],
+ 'type' => 'directory',
+ 'title' => 'Model service',
+ ],
+ [
+ 'children' => ['DeleteRagEvaluatorTask', 'CreateRagEvaluatorTask', 'GetRagEvaluatorTask', 'ListRagEvaluatorTasks'],
+ 'type' => 'directory',
+ 'title' => 'Evaluation service',
+ ],
+ [
+ 'children' => ['StopOfflineTask', 'StartOfflineTask', 'ListOfflineTask', 'ModifyOfflineTask', 'CreateOfflineTask', 'GetOfflineTask', 'DeleteOfflineTask'],
+ 'type' => 'directory',
+ 'title' => 'Offline task',
+ ],
+ [
+ 'children' => ['UpdateCapability', 'ListCapabilities', 'DescribeCapability', 'DeleteCapability', 'CreateCapability'],
+ 'type' => 'directory',
+ 'title' => 'Knowledge base configuration',
+ ],
+ [
+ 'children' => ['GetTableFields'],
+ 'type' => 'directory',
+ 'title' => 'Data source',
+ ],
+ [
+ 'children' => ['GetTables'],
+ 'type' => 'directory',
+ 'title' => 'Other',
+ ],
+ [
+ 'children' => ['CreateWorkspace', 'DeleteWorkspace', 'DescribeRegions', 'GetAsyncTask', 'GetTableColumns', 'GetWorkspace', 'ListAsyncTasks', 'ListCredentials', 'ListServices', 'ListWorkspaces', 'UpdateWorkspace'],
+ 'title' => 'Others',
+ 'type' => 'directory',
+ ],
+ ],
+ 'components' => [
+ 'schemas' => [],
+ ],
+ 'apis' => [
+ 'CeaseFunctionInstance' => [
+ 'summary' => 'Stops a service.',
+ 'path' => '/openapi/platform/workspaces/{workspaceName}/functions/{functionName}/instances/{instanceName}/actions/cease',
+ 'methods' => ['post'],
+ 'schemes' => ['https'],
+ 'security' => [
+ [
+ 'AK' => [],
+ ],
+ ],
+ 'consumes' => ['application/json'],
+ 'produces' => ['application/json'],
+ 'operationType' => 'write',
+ 'deprecated' => false,
+ 'systemTags' => [
+ 'operationType' => 'none',
+ 'riskType' => 'none',
+ 'chargeType' => 'free',
+ 'abilityTreeCode' => '239777',
+ 'abilityTreeNodes' => ['FEATUREopensearchJK5SO0'],
+ 'autoTest' => true,
+ 'tenantRelevance' => 'tenant',
+ ],
+ 'parameters' => [
+ [
+ 'name' => 'workspaceName',
+ 'in' => 'path',
+ 'schema' => ['title' => '', 'description' => 'The name of the OpenSearch application.', 'type' => 'string', 'required' => false, 'example' => 'default'],
+ ],
+ [
+ 'name' => 'functionName',
+ 'in' => 'path',
+ 'schema' => ['title' => '', 'description' => 'The function name.', 'type' => 'string', 'required' => false, 'example' => 'notebook'],
+ ],
+ [
+ 'name' => 'instanceName',
+ 'in' => 'path',
+ 'schema' => ['title' => '', 'description' => 'The instance name.', 'type' => 'string', 'required' => true, 'example' => 'test_notebook'],
+ ],
+ ],
+ 'responses' => [
+ 200 => [
+ 'schema' => [
+ 'type' => 'object',
+ 'properties' => [
+ 'code' => ['description' => 'The error code.', 'type' => 'string', 'example' => 'not found', 'title' => ''],
+ 'httpCode' => ['description' => 'The HTTP status code.', 'type' => 'integer', 'format' => 'int64', 'example' => '200', 'title' => ''],
+ 'latency' => ['description' => 'The latency in minutes.', 'type' => 'integer', 'format' => 'int64', 'example' => '34.946', 'title' => ''],
+ 'message' => ['description' => 'The error message.', 'type' => 'string', 'example' => '"xx not found"', 'title' => ''],
+ 'requestId' => ['description' => 'The request ID.', 'type' => 'string', 'example' => '2423C841-91C4-5E51-B296-590D367967FC', 'title' => ''],
+ 'status' => ['description' => 'The request status.', 'type' => 'string', 'example' => 'OK', 'title' => ''],
+ ],
+ 'description' => '',
+ 'title' => '',
+ 'example' => '',
+ ],
+ ],
+ ],
+ 'staticInfo' => ['returnType' => 'synchronous'],
+ 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"code\\": \\"not found\\",\\n \\"httpCode\\": 200,\\n \\"latency\\": 34.946,\\n \\"message\\": \\"\\\\\\"xx not found\\\\\\"\\",\\n \\"requestId\\": \\"2423C841-91C4-5E51-B296-590D367967FC\\",\\n \\"status\\": \\"OK\\"\\n}","type":"json"}]',
+ 'title' => 'Stop notebook service',
+ 'changeSet' => [],
+ 'ramActions' => [
+ [
+ 'operationType' => 'none',
+ 'ramAction' => [
+ 'action' => 'searchplat:CeaseFunctionInstance',
+ 'authLevel' => 'operate',
+ 'actionConditions' => [],
+ 'resources' => [
+ ['validationType' => 'always', 'product' => 'SearchPlat', 'resourceType' => 'All Resource', 'arn' => '*'],
+ ],
+ ],
+ ],
+ ],
+ ],
+ 'CreateAsyncTask' => [
+ 'summary' => 'Creates an asynchronous task.',
+ 'path' => '/openapi/platform/workspaces/{workspaceName}/async-tasks',
+ 'methods' => ['post'],
+ 'schemes' => ['http', 'https'],
+ 'security' => [
+ [
+ 'AK' => [],
+ ],
+ ],
+ 'operationType' => 'readAndWrite',
+ 'deprecated' => false,
+ 'systemTags' => [
+ 'operationType' => 'create',
+ 'riskType' => 'none',
+ 'chargeType' => 'free',
+ 'abilityTreeCode' => '225786',
+ 'abilityTreeNodes' => ['FEATUREopensearch1AJKH0'],
+ ],
+ 'parameters' => [
+ [
+ 'name' => 'dryRun',
+ 'in' => 'query',
+ 'schema' => ['description' => 'Specifies whether to perform a dry run request.', 'type' => 'boolean', 'required' => false, 'example' => 'true', 'title' => ''],
+ ],
+ [
+ 'name' => 'workspaceName',
+ 'in' => 'path',
+ 'schema' => ['description' => 'The workspace name.', 'type' => 'string', 'required' => true, 'example' => 'myWorkspace', 'title' => ''],
+ ],
+ [
+ 'name' => 'body',
+ 'in' => 'body',
+ 'style' => 'json',
+ 'schema' => [
+ 'description' => 'The request body.',
+ 'type' => 'object',
+ 'properties' => [
+ 'id' => ['description' => 'The asynchronous task ID.', 'type' => 'string', 'required' => false, 'example' => 'fae9bcc5-949f-4c31-b9b7-a273bf891699', 'title' => ''],
+ 'serviceType' => ['description' => 'The service type.', 'type' => 'string', 'required' => false, 'example' => 'document-analyze', 'title' => ''],
+ 'serviceId' => ['description' => 'The service ID.', 'type' => 'string', 'required' => false, 'example' => 'ops-document-analyze-001', 'title' => ''],
+ 'dataId' => ['description' => 'The playground data ID.', 'type' => 'integer', 'format' => 'int64', 'required' => false, 'example' => '12323', 'title' => ''],
+ 'name' => ['description' => 'The task name.', 'type' => 'string', 'required' => false, 'example' => '文档解析任务', 'title' => ''],
+ ],
+ 'required' => false,
+ 'title' => '',
+ 'example' => '',
+ ],
+ ],
+ ],
+ 'responses' => [
+ 200 => [
+ 'schema' => [
+ 'title' => '',
+ 'description' => 'Schema of Response',
+ 'type' => 'object',
+ 'properties' => [
+ 'requestId' => ['title' => '', 'description' => 'Id of the request', 'type' => 'string', 'example' => '1CC93E65-6734-5060-BEF7-0EB0A4862BCF'],
+ 'result' => [
+ 'description' => 'The returned result.',
+ 'type' => 'array',
+ 'items' => [
+ 'description' => 'The returned result.',
+ 'type' => 'object',
+ 'properties' => [
+ 'id' => ['description' => 'The task ID.', 'type' => 'string', 'example' => 'fae9bcc5-949f-4c31-b9b7-a273bf891699', 'title' => ''],
+ 'serviceType' => ['description' => 'The service type.', 'type' => 'string', 'example' => 'document-analyze', 'title' => ''],
+ 'serviceId' => ['description' => 'The service ID.', 'type' => 'string', 'example' => 'ops-document-analyze-001', 'title' => ''],
+ 'name' => ['description' => 'The task name.', 'type' => 'string', 'example' => '文档解析任务', 'title' => ''],
+ 'dataId' => ['description' => 'The data ID.', 'type' => 'integer', 'format' => 'int32', 'example' => '1232', 'title' => ''],
+ 'status' => ['description' => 'The task status. Valid values:'."\n"
+ .'- PENDING: In progress.'."\n"
+ .'- SUCCESS: Parsing succeeded.'."\n"
+ .'- FAILED: Parsing failed.', 'type' => 'string', 'example' => 'SUCCESS', 'title' => ''],
+ 'result' => ['description' => 'The parsing result.', 'type' => 'string', 'example' => 'xx', 'title' => ''],
+ 'created' => ['description' => 'The creation time.', 'type' => 'integer', 'format' => 'int64', 'example' => '1729669284', 'title' => ''],
+ 'updated' => ['description' => 'The update time.', 'type' => 'integer', 'format' => 'int64', 'example' => '1729669284', 'title' => ''],
+ ],
+ 'title' => '',
+ 'example' => '',
+ ],
+ 'title' => '',
+ 'example' => '',
+ ],
+ ],
+ 'example' => '',
+ ],
+ ],
+ ],
+ 'staticInfo' => ['returnType' => 'synchronous'],
+ 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"requestId\\": \\"1CC93E65-6734-5060-BEF7-0EB0A4862BCF\\",\\n \\"result\\": [\\n {\\n \\"id\\": \\"fae9bcc5-949f-4c31-b9b7-a273bf891699\\",\\n \\"serviceType\\": \\"document-analyze\\",\\n \\"serviceId\\": \\"ops-document-analyze-001\\",\\n \\"name\\": \\"文档解析任务\\",\\n \\"dataId\\": 1232,\\n \\"status\\": \\"SUCCESS\\",\\n \\"result\\": \\"xx\\",\\n \\"created\\": 1729669284,\\n \\"updated\\": 1729669284\\n }\\n ]\\n}","type":"json"}]',
+ 'title' => 'Create an asynchronous task',
+ 'changeSet' => [],
+ 'ramActions' => [
+ [
+ 'operationType' => 'create',
+ 'ramAction' => [
+ 'action' => 'searchplat:WriteAsyncTask',
+ 'authLevel' => 'resource',
+ 'actionConditions' => [],
+ 'resources' => [
+ ['validationType' => 'always', 'product' => 'SearchPlat', 'resourceType' => 'AsyncTasks', 'arn' => 'acs:searchplat:{#regionId}:{#accountId}:workspaces/{#workspaceName}'],
+ ],
+ ],
+ ],
+ ],
+ ],
+ 'CreateCapability' => [
+ 'summary' => 'Creates a knowledge base-related configuration.',
+ 'path' => '/openapi/platform/workspaces/{workspaceName}/capabilities/{itemCategory}/items',
+ 'methods' => ['post'],
+ 'schemes' => ['https'],
+ 'security' => [
+ [
+ 'AK' => [],
+ ],
+ ],
+ 'consumes' => ['application/json'],
+ 'produces' => ['application/json'],
+ 'operationType' => 'write',
+ 'deprecated' => false,
+ 'systemTags' => [
+ 'operationType' => 'create',
+ 'riskType' => 'none',
+ 'chargeType' => 'free',
+ 'abilityTreeNodes' => ['FEATUREopensearch8B42ZS'],
+ 'tenantRelevance' => 'tenant',
+ ],
+ 'parameters' => [
+ [
+ 'name' => 'workspaceName',
+ 'in' => 'path',
+ 'schema' => ['description' => 'The workspace name.', 'type' => 'string', 'required' => true, 'example' => 'default', 'title' => ''],
+ ],
+ [
+ 'name' => 'itemCategory',
+ 'in' => 'path',
+ 'schema' => ['description' => 'The configuration category.'."\n"
+ ."\n"
+ .'- ai_search_agent.', 'type' => 'string', 'required' => true, 'example' => 'ai_search_agent', 'title' => ''],
+ ],
+ [
+ 'name' => 'dryRun',
+ 'in' => 'query',
+ 'schema' => ['description' => 'Specifies whether to check the validity of the request parameters without performing the actual operation. Default value: false.'."\n"
+ ."\n"
+ .'Valid values:'."\n"
+ ."\n"
+ .'- **true**'."\n"
+ ."\n"
+ .'- **false**.', 'type' => 'boolean', 'required' => false, 'example' => 'false', 'title' => ''],
+ ],
+ [
+ 'name' => 'body',
+ 'in' => 'body',
+ 'style' => 'json',
+ 'schema' => [
+ 'description' => 'The request body.',
+ 'type' => 'object',
+ 'properties' => [
+ 'itemName' => ['description' => 'The configuration name.', 'type' => 'string', 'required' => false, 'example' => 'es_knowledge_base', 'title' => ''],
+ 'itemDesc' => ['description' => 'The configuration description.', 'type' => 'string', 'required' => false, 'example' => '描述', 'title' => ''],
+ 'itemValue' => ['description' => 'The configuration item.', 'type' => 'object', 'required' => false, 'example' => '{'."\n"
+ .' "name": "知识库名称",'."\n"
+ .' "type": "aliyun-es",'."\n"
+ .' "endpoint": {'."\n"
+ .' "address": "http://xxxxx.es-serverless.aliyuncs.com:9200",'."\n"
+ .' "authorization": "xxx:ABCDxxxx",'."\n"
+ .' "network": {'."\n"
+ .' "type": "public"'."\n"
+ .' },'."\n"
+ .' "region": ""'."\n"
+ .' },'."\n"
+ .' "function": {'."\n"
+ .' "indexName": "product_info",'."\n"
+ .' "queryType": "hybrid-search",'."\n"
+ .' "description": "金融理财产品知识库,理财产品名称列表及详细描述",'."\n"
+ .' "parameters": {'."\n"
+ .' "properties": {'."\n"
+ .' "query": {'."\n"
+ .' "defaultValue": "",'."\n"
+ .' "description": "理财产品名称或详细描述",'."\n"
+ .' "type": "string"'."\n"
+ .' }'."\n"
+ .' },'."\n"
+ .' "required": ['."\n"
+ .' "query"'."\n"
+ .' ]'."\n"
+ .' },'."\n"
+ .' "template": "{\\"query\\":{\\"multi_match\\":{\\"query\\":\\"${parameters.query}\\",\\"fields\\": [\\"*\\"]}}}",'."\n"
+ .' "type": "dsl",'."\n"
+ .' "embedding": {'."\n"
+ .' "denseModel": "dense",'."\n"
+ .' "sparseModel": "sparse",'."\n"
+ .' "address": "address",'."\n"
+ .' "authorization": "authorization"'."\n"
+ .' },'."\n"
+ .' "filter": "es或os语句",'."\n"
+ .' "size": 10'."\n"
+ .' }'."\n"
+ .' }', 'title' => ''],
+ ],
+ 'required' => false,
+ 'title' => '',
+ 'example' => '',
+ ],
+ ],
+ ],
+ 'responses' => [
+ 200 => [
+ 'schema' => [
+ 'title' => '',
+ 'description' => 'Schema of Response',
+ 'type' => 'object',
+ 'properties' => [
+ 'requestId' => ['title' => '', 'description' => 'Id of the request', 'type' => 'string', 'example' => '1CC93E65-6734-5060-BEF7-0EB0A4862BCF'],
+ 'httpCode' => ['description' => 'The HTTP status code.', 'type' => 'integer', 'format' => 'int64', 'example' => '200', 'title' => ''],
+ 'status' => ['description' => 'The request status.', 'type' => 'string', 'example' => 'OK', 'title' => ''],
+ ],
+ 'example' => '',
+ ],
+ ],
+ ],
+ 'staticInfo' => ['returnType' => 'synchronous'],
+ 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"requestId\\": \\"1CC93E65-6734-5060-BEF7-0EB0A4862BCF\\",\\n \\"httpCode\\": 200,\\n \\"status\\": \\"OK\\"\\n}","type":"json"}]',
+ 'title' => 'Create a configuration',
+ 'changeSet' => [],
+ 'ramActions' => [
+ [
+ 'operationType' => 'create',
+ 'ramAction' => [
+ 'action' => 'searchplat:CreateCapability',
+ 'authLevel' => 'operate',
+ 'actionConditions' => [],
+ 'resources' => [
+ ['validationType' => 'always', 'product' => 'SearchPlat', 'resourceType' => 'All Resource', 'arn' => '*'],
+ ],
+ ],
+ ],
+ ],
+ ],
+ 'CreateCredentials' => [
+ 'path' => '/openapi/platform/workspaces/{workspaceName}/credentials',
+ 'methods' => ['post'],
+ 'schemes' => ['http', 'https'],
+ 'security' => [
+ [
+ 'AK' => [],
+ ],
+ ],
+ 'operationType' => 'readAndWrite',
+ 'deprecated' => false,
+ 'systemTags' => [
+ 'operationType' => 'create',
+ 'abilityTreeCode' => '220521',
+ 'abilityTreeNodes' => ['FEATUREopensearch1AJKH0'],
+ ],
+ 'parameters' => [
+ [
+ 'name' => 'dryRun',
+ 'in' => 'query',
+ 'schema' => ['description' => 'Specifies whether to only validate the request parameters. Default value: false.'."\n"
+ ."\n"
+ .'Valid values:'."\n"
+ ."\n"
+ .'- **true**: Only validates the request parameters.'."\n"
+ ."\n"
+ .'- **false**: Validates the request parameters and creates the attribution configuration.', 'type' => 'boolean', 'required' => false, 'example' => 'true', 'title' => ''],
+ ],
+ [
+ 'name' => 'body',
+ 'in' => 'body',
+ 'style' => 'json',
+ 'schema' => [
+ 'description' => 'Request body.',
+ 'type' => 'object',
+ 'properties' => [
+ 'type' => ['description' => 'The credential type. Valid types:'."\n"
+ .'- api-token', 'type' => 'string', 'required' => false, 'example' => 'api-token', 'title' => ''],
+ ],
+ 'required' => false,
+ 'title' => '',
+ 'example' => '',
+ ],
+ ],
+ [
+ 'name' => 'workspaceName',
+ 'in' => 'path',
+ 'schema' => ['description' => 'The workspace name.', 'type' => 'string', 'required' => true, 'example' => 'myWorkspace', 'title' => ''],
+ ],
+ ],
+ 'responses' => [
+ 200 => [
+ 'schema' => [
+ 'title' => '',
+ 'description' => 'Schema of Response',
+ 'type' => 'object',
+ 'properties' => [
+ 'requestId' => ['title' => '', 'description' => 'Id of the request', 'type' => 'string', 'example' => '2E37A447-C010-5A49-9F31-DE12E97710A3'],
+ 'result' => [
+ 'description' => 'The response result.',
+ 'type' => 'object',
+ 'properties' => [
+ 'appGroupId' => ['description' => 'The workspace ID.', 'type' => 'integer', 'format' => 'int64', 'example' => '12323', 'title' => ''],
+ 'type' => ['description' => 'The credential type.'."\n"
+ ."\n"
+ .'- api-token', 'type' => 'string', 'example' => 'api-token'."\n", 'title' => ''],
+ 'enabled' => ['description' => 'Indicates whether the credential is enabled.'."\n"
+ .'Valid values:'."\n"
+ ."\n"
+ .'- true: Enabled.'."\n"
+ .'- false: Disabled.', 'type' => 'boolean', 'example' => 'false', 'title' => ''],
+ 'token' => ['description' => 'The generated credential token.', 'type' => 'string', 'example' => 'OS-********', 'title' => ''],
+ ],
+ 'title' => '',
+ 'example' => '',
+ ],
+ ],
+ 'example' => '',
+ ],
+ ],
+ ],
+ 'staticInfo' => ['returnType' => 'synchronous'],
+ 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"requestId\\": \\"2E37A447-C010-5A49-9F31-DE12E97710A3\\",\\n \\"result\\": {\\n \\"appGroupId\\": 12323,\\n \\"type\\": \\"api-token\\\\n\\",\\n \\"enabled\\": false,\\n \\"token\\": \\"OS-********\\"\\n }\\n}","type":"json"}]',
+ 'title' => 'CreateCredentials',
+ 'summary' => 'Creates access credentials.',
+ 'changeSet' => [],
+ 'ramActions' => [
+ [
+ 'operationType' => 'create',
+ 'ramAction' => [
+ 'action' => 'searchplat:WriteCredentials',
+ 'authLevel' => 'resource',
+ 'actionConditions' => [],
+ 'resources' => [
+ ['validationType' => 'always', 'product' => 'SearchPlat', 'resourceType' => 'Credentials', 'arn' => 'acs:searchplat:{#regionId}:{#accountId}:workspaces/{#workspaceName}'],
+ ],
+ ],
+ ],
+ ],
+ ],
+ 'CreateExperienceData' => [
+ 'summary' => 'Creates experience data.',
+ 'path' => '/openapi/platform/workspaces/{workspaceName}/experience-data',
+ 'methods' => ['post'],
+ 'schemes' => ['http', 'https'],
+ 'security' => [
+ [
+ 'AK' => [],
+ ],
+ ],
+ 'operationType' => 'readAndWrite',
+ 'deprecated' => false,
+ 'systemTags' => [
+ 'operationType' => 'create',
+ 'riskType' => 'none',
+ 'chargeType' => 'free',
+ 'abilityTreeCode' => '225360',
+ 'abilityTreeNodes' => ['FEATUREopensearch8B42ZS'],
+ ],
+ 'parameters' => [
+ [
+ 'name' => 'dryRun',
+ 'in' => 'query',
+ 'schema' => ['description' => 'Specifies whether to perform a dry run request.', 'type' => 'boolean', 'required' => false, 'example' => 'true', 'title' => ''],
+ ],
+ [
+ 'name' => 'body',
+ 'in' => 'body',
+ 'style' => 'json',
+ 'schema' => [
+ 'description' => 'The request body.',
+ 'type' => 'object',
+ 'properties' => [
+ 'serviceType' => ['description' => 'The service type.', 'type' => 'string', 'required' => false, 'example' => 'document-analyze ', 'title' => ''],
+ 'dataType' => ['description' => 'The data type. Valid values:'."\n"
+ .'- file: file'."\n"
+ .'- url: URL.', 'type' => 'string', 'required' => false, 'example' => 'file', 'title' => ''],
+ 'name' => ['description' => 'The data name. This parameter is required when dataType is set to file.', 'type' => 'string', 'required' => false, 'example' => 'test', 'title' => ''],
+ 'dataValue' => ['description' => 'The data content.'."\n"
+ .'- If dataType is set to file, this field specifies the OSS address of the file.'."\n"
+ .'- If dataType is set to url, this field specifies the HTTP URL of the data.', 'type' => 'string', 'required' => false, 'example' => 'https://xxx', 'title' => ''],
+ 'dataSize' => ['description' => 'The data size.', 'type' => 'integer', 'format' => 'int64', 'required' => false, 'example' => '100', 'title' => ''],
+ 'contentType' => ['description' => 'The data content type. Valid values:'."\n"
+ .'- pdf'."\n"
+ .'- text'."\n"
+ .'- html'."\n"
+ .'- doc.', 'type' => 'string', 'required' => false, 'example' => 'text', 'title' => ''],
+ ],
+ 'required' => false,
+ 'title' => '',
+ 'example' => '',
+ ],
+ ],
+ [
+ 'name' => 'workspaceName',
+ 'in' => 'path',
+ 'schema' => ['description' => 'The workspace name.', 'type' => 'string', 'required' => true, 'example' => 'myWorkspace', 'title' => ''],
+ ],
+ ],
+ 'responses' => [
+ 200 => [
+ 'schema' => [
+ 'title' => '',
+ 'description' => 'Schema of Response',
+ 'type' => 'object',
+ 'properties' => [
+ 'requestId' => ['title' => '', 'description' => 'Id of the request', 'type' => 'string', 'example' => '7ACFD0C5-61E4-5DEA-A995-8279BB99C7E4'],
+ 'result' => [
+ 'description' => 'The returned result.',
+ 'type' => 'object',
+ 'properties' => [
+ 'id' => ['description' => 'The data ID.', 'type' => 'integer', 'format' => 'int64', 'example' => '1222212', 'title' => ''],
+ 'serviceType' => ['description' => 'The service type.', 'type' => 'string', 'example' => 'document-analyze', 'title' => ''],
+ 'dataType' => ['description' => 'The data type.', 'type' => 'boolean', 'example' => 'file', 'title' => ''],
+ 'name' => ['description' => 'The data name.', 'type' => 'string', 'example' => 'test', 'title' => ''],
+ 'dataValue' => ['description' => 'The data content.', 'type' => 'string', 'example' => 'http://xxx', 'title' => ''],
+ 'dataSize' => ['description' => 'The data size.', 'type' => 'integer', 'format' => 'int64', 'example' => '100', 'title' => ''],
+ 'created' => ['description' => 'The creation time.', 'type' => 'integer', 'format' => 'int64', 'example' => '1729665694', 'title' => ''],
+ 'updated' => ['description' => 'The update time.', 'type' => 'integer', 'format' => 'int64', 'example' => '1729665694', 'title' => ''],
+ 'contentType' => ['description' => 'The data content type.', 'type' => 'string', 'example' => 'text', 'title' => ''],
+ ],
+ 'title' => '',
+ 'example' => '',
+ ],
+ ],
+ 'example' => '',
+ ],
+ ],
+ ],
+ 'staticInfo' => ['returnType' => 'synchronous'],
+ 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"requestId\\": \\"7ACFD0C5-61E4-5DEA-A995-8279BB99C7E4\\",\\n \\"result\\": {\\n \\"id\\": 1222212,\\n \\"serviceType\\": \\"document-analyze\\",\\n \\"dataType\\": true,\\n \\"name\\": \\"test\\",\\n \\"dataValue\\": \\"http://xxx\\",\\n \\"dataSize\\": 100,\\n \\"created\\": 1729665694,\\n \\"updated\\": 1729665694,\\n \\"contentType\\": \\"text\\"\\n }\\n}","type":"json"}]',
+ 'title' => 'Create experience data',
+ 'changeSet' => [],
+ 'ramActions' => [
+ [
+ 'operationType' => 'create',
+ 'ramAction' => [
+ 'action' => 'searchplat:WriteExperienceData',
+ 'authLevel' => 'resource',
+ 'actionConditions' => [],
+ 'resources' => [
+ ['validationType' => 'always', 'product' => 'SearchPlat', 'resourceType' => 'ExperienceData', 'arn' => 'acs:searchplat:{#regionId}:{#accountId}:workspaces/{#workspaceName}'],
+ ],
+ ],
+ ],
+ ],
+ ],
+ 'CreateFunctionInstance' => [
+ 'summary' => 'Creates a service configuration.',
+ 'path' => '/openapi/platform/workspaces/{workspaceName}/functions/{functionName}/instances',
+ 'methods' => ['post'],
+ 'schemes' => ['https'],
+ 'security' => [
+ [
+ 'AK' => [],
+ ],
+ ],
+ 'consumes' => ['application/json'],
+ 'operationType' => 'readAndWrite',
+ 'deprecated' => false,
+ 'systemTags' => [
+ 'operationType' => 'create',
+ 'riskType' => 'none',
+ 'chargeType' => 'free',
+ 'abilityTreeCode' => '239769',
+ 'abilityTreeNodes' => ['FEATUREopensearchJK5SO0'],
+ 'autoTest' => true,
+ 'tenantRelevance' => 'publicInformation',
+ ],
+ 'parameters' => [
+ [
+ 'name' => 'workspaceName',
+ 'in' => 'path',
+ 'schema' => ['description' => 'The workspace name.', 'type' => 'string', 'required' => true, 'example' => 'myWorkspace', 'title' => ''],
+ ],
+ [
+ 'name' => 'functionName',
+ 'in' => 'path',
+ 'schema' => ['description' => 'The service or model type. Valid values:'."\n"
+ .'- nl2sql: service'."\n"
+ .'- embedding-tuning: model.', 'type' => 'string', 'required' => true, 'example' => 'nl2sql', 'title' => ''],
+ ],
+ [
+ 'name' => 'Body',
+ 'in' => 'body',
+ 'style' => 'json',
+ 'schema' => [
+ 'title' => '',
+ 'description' => 'The body parameters.',
+ 'type' => 'object',
+ 'properties' => [
+ 'instanceName' => ['title' => '', 'description' => 'The configuration or model name.', 'type' => 'string', 'required' => true, 'example' => 'test'],
+ 'modelType' => ['title' => '', 'description' => 'The service ID. Valid values:'."\n"
+ .'- ops-query-analyze-nl2sql-001'."\n"
+ .'- ops-embedding-dim-reduction-001: vector dimension reduction.', 'type' => 'string', 'required' => true, 'example' => 'ops-query-analyze-nl2sql-001'],
+ 'functionType' => ['title' => '', 'description' => 'The configuration type. Valid values:'."\n"
+ .'- PAAS'."\n"
+ .'- SAAS.', 'type' => 'string', 'required' => false, 'example' => 'PAAS'],
+ 'description' => ['title' => '', 'description' => 'The instance description.', 'type' => 'string', 'required' => false, 'example' => 'desc'],
+ 'createParameters' => [
+ 'title' => '',
+ 'description' => 'The creation parameters.',
+ 'type' => 'array',
+ 'items' => [
+ 'type' => 'object',
+ 'properties' => [
+ 'name' => ['title' => '', 'description' => 'The parameter name.', 'type' => 'string', 'required' => false, 'example' => 'config'],
+ 'value' => ['title' => '', 'description' => 'The parameter value.', 'type' => 'string', 'required' => false, 'example' => '{\\"DDL\\": [{\\"table\\": \\"schools\\",\\"columns\\": [{\\"column\\": \\"class\\",\\"column_des\\": \\"班级\\",\\"type\\": \\"str\\",\\"example\\": [\\"高一3班\\",\\"火箭班\\"],\\"value_mapping\\": {}},{\\"column\\": \\"school\\",\\"column_des\\": \\"学校\\",\\"type\\": \\"str\\",\\"example\\": [\\"清华大学\\",\\"北京大学\\"],\\"value_mapping\\": {}}]},{\\"table\\": \\"students\\",\\"columns\\": [{\\"column\\": \\"name\\",\\"column_des\\": \\"姓名\\",\\"type\\": \\"int\\",\\"example\\": [10002,100001],\\"value_mapping\\": [[10002,100001],[\\"张三\\",\\"李四\\"]]}]}],\\"foreign keys\\":[\\"table.column_1=table2.column_2\\",\\"table.column_1=table2.column_2\\"],\\"UDF\\": [[\\"初始节点\\",\\"aa\\"],[\\" (sub_action >100095 or action = 0001) and station =100001\\",\\"bbb\\"]],\\"Fewshot\\": [{\\"query\\": \\"叫张三的学生有多少\\",\\"sql\\": \\"SELECT COUNT(*) FROM students WHERE name = 10002\\"}]}'],
+ ],
+ 'required' => false,
+ 'description' => 'The parameter item.',
+ 'title' => '',
+ 'example' => '',
+ ],
+ 'required' => false,
+ 'example' => '',
+ ],
+ ],
+ 'required' => false,
+ 'docRequired' => true,
+ 'example' => '',
+ ],
+ ],
+ ],
+ 'responses' => [
+ 200 => [
+ 'schema' => [
+ 'type' => 'object',
+ 'properties' => [
+ 'status' => ['description' => 'The request status.', 'type' => 'string', 'example' => 'OK', 'title' => ''],
+ 'httpCode' => ['description' => 'Indicates whether the business request is successful. A non-empty value other than 200 indicates a business processing failure.', 'type' => 'integer', 'format' => 'int64', 'example' => '200', 'title' => ''],
+ 'requestId' => ['description' => 'The request ID.', 'type' => 'string', 'example' => '2BA0504F-B179-586D-8210-A7C7C09A9907', 'title' => ''],
+ 'message' => ['description' => 'The error message.', 'type' => 'string', 'example' => 'ok', 'title' => ''],
+ 'code' => ['description' => 'The error code.', 'type' => 'string', 'example' => 'not found', 'title' => ''],
+ 'latency' => ['description' => 'The latency score.', 'type' => 'integer', 'format' => 'int64', 'example' => '145.411', 'title' => ''],
+ ],
+ 'description' => '',
+ 'title' => '',
+ 'example' => '',
+ ],
+ ],
+ ],
+ 'staticInfo' => ['returnType' => 'synchronous'],
+ 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"status\\": \\"OK\\",\\n \\"httpCode\\": 200,\\n \\"requestId\\": \\"2BA0504F-B179-586D-8210-A7C7C09A9907\\",\\n \\"message\\": \\"ok\\",\\n \\"code\\": \\"not found\\",\\n \\"latency\\": 145.411\\n}","type":"json"}]',
+ 'title' => 'Create a service or model configuration',
+ 'changeSet' => [],
+ 'ramActions' => [
+ [
+ 'operationType' => 'create',
+ 'ramAction' => [
+ 'action' => 'searchplat:WriteFunction',
+ 'authLevel' => 'resource',
+ 'actionConditions' => [],
+ 'resources' => [
+ ['validationType' => 'always', 'product' => 'SearchPlat', 'resourceType' => 'FunctionInstance', 'arn' => 'acs:searchplat:{#regionId}:{#accountId}:workspaces/{#workspaceName}'],
+ ],
+ ],
+ ],
+ ],
+ ],
+ 'CreateFunctionTask' => [
+ 'summary' => 'Creates a service configuration task.',
+ 'path' => '/openapi/platform/workspaces/{workspaceName}/functions/{functionName}/instances/{instanceName}/tasks',
+ 'methods' => ['post'],
+ 'schemes' => ['https'],
+ 'security' => [
+ [
+ 'AK' => [],
+ ],
+ ],
+ 'operationType' => 'write',
+ 'deprecated' => false,
+ 'systemTags' => [
+ 'operationType' => 'create',
+ 'riskType' => 'none',
+ 'chargeType' => 'paid',
+ 'abilityTreeCode' => '239788',
+ 'abilityTreeNodes' => ['FEATUREopensearchJK5SO0'],
+ 'autoTest' => true,
+ 'tenantRelevance' => 'publicInformation',
+ ],
+ 'parameters' => [
+ [
+ 'name' => 'workspaceName',
+ 'in' => 'path',
+ 'schema' => ['description' => 'The workspace name.', 'type' => 'string', 'required' => true, 'example' => 'myWorkspace', 'title' => ''],
+ ],
+ [
+ 'name' => 'functionName',
+ 'in' => 'path',
+ 'schema' => ['description' => 'The service configuration.', 'type' => 'string', 'required' => true, 'example' => 'nl2sql', 'title' => ''],
+ ],
+ [
+ 'name' => 'instanceName',
+ 'in' => 'path',
+ 'schema' => ['description' => 'The configuration name.', 'type' => 'string', 'required' => true, 'example' => 'test', 'title' => ''],
+ ],
+ ],
+ 'responses' => [
+ 200 => [
+ 'schema' => [
+ 'type' => 'object',
+ 'properties' => [
+ 'code' => ['description' => 'The error code.', 'type' => 'string', 'example' => 'not found', 'title' => ''],
+ 'httpCode' => ['description' => 'The HTTP status code.', 'type' => 'integer', 'format' => 'int64', 'example' => '200', 'title' => ''],
+ 'latency' => ['description' => 'The latency in minutes.', 'type' => 'integer', 'format' => 'int64', 'example' => '145.411', 'title' => ''],
+ 'message' => ['description' => 'The error message.', 'type' => 'string', 'example' => '"xx not found"', 'title' => ''],
+ 'requestId' => ['description' => 'The request ID.', 'type' => 'string', 'example' => '58113A95-1858-5674-87E5-192AEE6FD9DD', 'title' => ''],
+ 'status' => ['description' => 'The request status.', 'type' => 'string', 'example' => 'OK', 'title' => ''],
+ ],
+ 'description' => '',
+ 'title' => '',
+ 'example' => '',
+ ],
+ ],
+ ],
+ 'staticInfo' => ['returnType' => 'synchronous'],
+ 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"code\\": \\"not found\\",\\n \\"httpCode\\": 200,\\n \\"latency\\": 145.411,\\n \\"message\\": \\"\\\\\\"xx not found\\\\\\"\\",\\n \\"requestId\\": \\"58113A95-1858-5674-87E5-192AEE6FD9DD\\",\\n \\"status\\": \\"OK\\"\\n}","type":"json"}]',
+ 'title' => 'Activate configuration',
+ 'changeSet' => [],
+ 'ramActions' => [
+ [
+ 'operationType' => 'create',
+ 'ramAction' => [
+ 'action' => 'searchplat:WriteFunction',
+ 'authLevel' => 'operate',
+ 'actionConditions' => [],
+ 'resources' => [
+ ['validationType' => 'always', 'product' => 'SearchPlat', 'resourceType' => 'All Resource', 'arn' => '*'],
+ ],
+ ],
+ ],
+ ],
+ ],
+ 'CreateOfflineTask' => [
+ 'summary' => 'Creates an offline processing task for video retrieval. You can configure the data source, processing parameters, and output destination.',
+ 'path' => '/openapi/platform/workspaces/{workspaceName}/offline-tasks/{type}',
+ 'methods' => ['post'],
+ 'schemes' => ['https'],
+ 'security' => [
+ [
+ 'AK' => [],
+ ],
+ ],
+ 'consumes' => ['application/json'],
+ 'produces' => ['application/json'],
+ 'operationType' => 'write',
+ 'deprecated' => false,
+ 'systemTags' => [
+ 'operationType' => 'create',
+ 'riskType' => 'none',
+ 'chargeType' => 'free',
+ 'abilityTreeNodes' => ['FEATUREopensearch8B42ZS'],
+ 'tenantRelevance' => 'tenant',
+ ],
+ 'parameters' => [
+ [
+ 'name' => 'workspaceName',
+ 'in' => 'path',
+ 'schema' => ['description' => 'The workspace name.', 'type' => 'string', 'required' => false, 'example' => 'default', 'title' => ''],
+ ],
+ [
+ 'name' => 'type',
+ 'in' => 'path',
+ 'schema' => ['description' => 'The task type.', 'type' => 'string', 'required' => false, 'example' => 'video', 'title' => ''],
+ ],
+ [
+ 'name' => 'draft',
+ 'in' => 'query',
+ 'schema' => ['description' => 'Specifies whether the task is a draft.', 'type' => 'boolean', 'required' => false, 'example' => 'false', 'title' => ''],
+ ],
+ [
+ 'name' => 'dryRun',
+ 'in' => 'query',
+ 'schema' => ['description' => 'Specifies whether to validate the parameters without creating the task.', 'type' => 'boolean', 'required' => false, 'example' => 'false', 'title' => ''],
+ ],
+ [
+ 'name' => 'regionId',
+ 'in' => 'query',
+ 'schema' => ['title' => '', 'description' => 'The region ID.', 'type' => 'string', 'example' => 'cn-shanghai', 'required' => false],
+ ],
+ [
+ 'name' => 'body',
+ 'in' => 'body',
+ 'style' => 'json',
+ 'schema' => [
+ 'description' => 'The request body.',
+ 'type' => 'object',
+ 'properties' => [
+ 'meta' => [
+ 'description' => 'The task metadata.',
+ 'type' => 'object',
+ 'properties' => [
+ 'apiKey' => ['description' => 'The access credential.', 'type' => 'string', 'required' => false, 'example' => 'OS-xxx', 'title' => ''],
+ 'regionId' => ['description' => 'The region ID.', 'type' => 'string', 'required' => false, 'example' => 'cn-shanghai', 'title' => ''],
+ 'taskName' => ['description' => 'The task name.', 'type' => 'string', 'required' => false, 'example' => 'test', 'title' => ''],
+ 'computeResource' => ['description' => 'The billing specification.', 'type' => 'string', 'required' => false, 'example' => 'small', 'title' => ''],
+ 'labels' => [
+ 'description' => 'The list of labels.',
+ 'type' => 'array',
+ 'items' => ['description' => 'The label value.', 'type' => 'string', 'required' => false, 'example' => 'name', 'title' => ''],
+ 'required' => false,
+ 'title' => '',
+ 'example' => '',
+ ],
+ ],
+ 'required' => false,
+ 'title' => '',
+ 'example' => '',
+ ],
+ 'source' => [
+ 'description' => 'The data source information.',
+ 'type' => 'array',
+ 'items' => [
+ 'description' => 'The data source.',
+ 'type' => 'object',
+ 'properties' => [
+ 'name' => ['description' => '**The data source name.**.', 'type' => 'string', 'required' => false, 'example' => 'table1', 'title' => ''],
+ 'type' => ['description' => '**The data source type.**.', 'type' => 'string', 'required' => false, 'example' => 'swift', 'title' => ''],
+ 'parameters' => [
+ 'description' => '**The datasource config parameters, which are determined by the type.**.',
+ 'type' => 'object',
+ 'required' => false,
+ 'additionalProperties' => ['type' => 'string', 'description' => '', 'title' => '', 'example' => ''],
+ 'example' => '{'."\n"
+ .' "key1": "value1",'."\n"
+ .' "key2": "value2"'."\n"
+ .'}',
+ 'title' => '',
+ ],
+ 'schema' => [
+ 'description' => '**The data source schema.**.',
+ 'type' => 'array',
+ 'items' => [
+ 'description' => 'The data source schema name.',
+ 'type' => 'object',
+ 'required' => false,
+ 'additionalProperties' => ['type' => 'string', 'description' => '', 'title' => '', 'example' => ''],
+ 'title' => '',
+ 'example' => '',
+ ],
+ 'required' => false,
+ 'title' => '',
+ 'example' => '',
+ ],
+ 'primaryKey' => ['description' => 'The primary key field of the data source.', 'type' => 'string', 'required' => false, 'example' => 'id', 'title' => ''],
+ ],
+ 'required' => false,
+ 'title' => '',
+ 'example' => '',
+ ],
+ 'required' => false,
+ 'title' => '',
+ 'example' => '',
+ ],
+ 'sink' => [
+ 'description' => 'The data sink information.',
+ 'type' => 'array',
+ 'items' => [
+ 'description' => 'The data sink.',
+ 'type' => 'object',
+ 'properties' => [
+ 'name' => ['description' => 'The data sink name.', 'type' => 'string', 'required' => false, 'example' => 'table2', 'title' => ''],
+ 'type' => ['description' => 'The data sink type.', 'type' => 'string', 'required' => false, 'example' => 'swift', 'title' => ''],
+ 'parameters' => [
+ 'description' => 'The data sink configuration parameters, which are determined by the type.',
+ 'type' => 'object',
+ 'required' => false,
+ 'additionalProperties' => ['type' => 'string', 'description' => '', 'title' => '', 'example' => ''],
+ 'title' => '',
+ 'example' => '',
+ ],
+ 'schema' => [
+ 'description' => 'The data sink schema.',
+ 'type' => 'array',
+ 'items' => [
+ 'description' => 'The data sink schema.',
+ 'type' => 'object',
+ 'required' => false,
+ 'additionalProperties' => ['type' => 'string', 'description' => '', 'title' => '', 'example' => ''],
+ 'title' => '',
+ 'example' => '',
+ ],
+ 'required' => false,
+ 'title' => '',
+ 'example' => '',
+ ],
+ 'primaryKey' => ['description' => 'The primary key field of the data sink.', 'type' => 'string', 'required' => false, 'example' => 'id', 'title' => ''],
+ ],
+ 'required' => false,
+ 'title' => '',
+ 'example' => '',
+ ],
+ 'required' => false,
+ 'title' => '',
+ 'example' => '',
+ ],
+ 'processors' => [
+ 'description' => 'The processing pipeline operators.',
+ 'type' => 'array',
+ 'items' => [
+ 'description' => 'The processing pipeline operators.',
+ 'type' => 'object',
+ 'properties' => [
+ 'name' => ['description' => 'The name.', 'type' => 'string', 'required' => false, 'example' => 'processor1', 'title' => ''],
+ 'type' => ['description' => 'The type.', 'type' => 'string', 'required' => false, 'example' => 'document-analyze', 'title' => ''],
+ 'input' => ['description' => 'The input parameters.', 'type' => 'object', 'required' => false, 'example' => '{'."\n"
+ .' "key": "content"'."\n"
+ .'}', 'title' => ''],
+ 'parameters' => ['description' => 'The processor parameters.', 'type' => 'object', 'required' => false, 'example' => '{'."\n"
+ .' "service_id": "xxx"'."\n"
+ .'}', 'title' => ''],
+ 'output' => ['description' => 'The output parameters.', 'type' => 'object', 'required' => false, 'example' => '{'."\n"
+ .'"vector": "syh_image_uri_multi-modal-embedding"'."\n"
+ .'}', 'title' => ''],
+ ],
+ 'required' => false,
+ 'title' => '',
+ 'example' => '',
+ ],
+ 'required' => false,
+ 'title' => '',
+ 'example' => '',
+ ],
+ 'parameters' => ['description' => 'The task processing parameters.', 'type' => 'object', 'required' => false, 'example' => '{'."\n"
+ .' "parameter1": {'."\n"
+ .' "key": "value"'."\n"
+ .' },'."\n"
+ .' "parameter2": {'."\n"
+ .' "key": "value"'."\n"
+ .' }'."\n"
+ .'}', 'title' => ''],
+ 'status' => [
+ 'description' => 'The task status.',
+ 'type' => 'object',
+ 'properties' => [
+ 'status' => ['description' => 'The task status.', 'type' => 'string', 'required' => false, 'example' => 'RUNNING', 'title' => ''],
+ 'errorMessage' => ['description' => 'The error message.', 'type' => 'string', 'required' => false, 'example' => '""', 'title' => ''],
+ 'createTime' => ['description' => 'The task start time.', 'type' => 'integer', 'format' => 'int64', 'required' => false, 'example' => '1744941600000', 'title' => ''],
+ 'deleteTime' => ['description' => 'The task stop time.', 'type' => 'integer', 'format' => 'int64', 'required' => false, 'example' => '1744941600000', 'title' => ''],
+ ],
+ 'required' => false,
+ 'title' => '',
+ 'example' => '',
+ ],
+ ],
+ 'required' => false,
+ 'example' => 'cn-shanghai',
+ 'title' => '',
+ ],
+ ],
+ ],
+ 'responses' => [
+ 200 => [
+ 'schema' => [
+ 'title' => '',
+ 'description' => 'Schema of Response',
+ 'type' => 'object',
+ 'properties' => [
+ 'requestId' => ['title' => '', 'description' => 'Id of the request', 'type' => 'string', 'example' => 'B7C901ED-2BC1-5CFB-BE23-242DE5E3BA5C'],
+ 'result' => [
+ 'description' => 'The response result.',
+ 'type' => 'object',
+ 'properties' => [
+ 'meta' => [
+ 'description' => 'The task metadata.',
+ 'type' => 'object',
+ 'properties' => [
+ 'taskName' => ['description' => 'The task name.', 'type' => 'string', 'example' => 'test', 'title' => ''],
+ 'computeResource' => ['description' => 'The billing specification.', 'type' => 'string', 'example' => 'small', 'title' => ''],
+ ],
+ 'title' => '',
+ 'example' => '',
+ ],
+ 'source' => [
+ 'description' => 'The data source information.',
+ 'type' => 'array',
+ 'items' => [
+ 'description' => 'The data source information.',
+ 'type' => 'object',
+ 'properties' => [
+ 'name' => ['description' => 'The data source name.', 'type' => 'string', 'example' => 'table1', 'title' => ''],
+ 'type' => ['description' => 'The data source type.', 'type' => 'string', 'example' => 'swift', 'title' => ''],
+ 'parameters' => [
+ 'description' => 'The datasource config parameters, which are determined by the type.',
+ 'type' => 'object',
+ 'additionalProperties' => ['description' => 'key为String类型', 'type' => 'string', 'example' => 'key', 'title' => ''],
+ 'title' => '',
+ 'example' => '',
+ ],
+ 'schema' => [
+ 'description' => 'The data source schema.',
+ 'type' => 'array',
+ 'items' => [
+ 'description' => 'Schema',
+ 'type' => 'object',
+ 'additionalProperties' => ['description' => 'key为String类型', 'type' => 'string', 'example' => '""', 'title' => ''],
+ 'title' => '',
+ 'example' => '',
+ ],
+ 'title' => '',
+ 'example' => '',
+ ],
+ 'primaryKey' => ['description' => 'The primary key field of the data source.', 'type' => 'string', 'example' => 'id', 'title' => ''],
+ ],
+ 'title' => '',
+ 'example' => '',
+ ],
+ 'title' => '',
+ 'example' => '',
+ ],
+ 'sink' => [
+ 'description' => 'The output destination information.',
+ 'type' => 'array',
+ 'items' => [
+ 'description' => 'The output destination information.',
+ 'type' => 'object',
+ 'properties' => [
+ 'name' => ['description' => 'The data sink name.', 'type' => 'string', 'example' => 'table2', 'title' => ''],
+ 'type' => ['description' => 'The data sink type.', 'type' => 'string', 'example' => 'swift', 'title' => ''],
+ 'parameters' => [
+ 'description' => 'The data sink configuration parameters, which are determined by the type.',
+ 'type' => 'object',
+ 'additionalProperties' => ['description' => 'key为String类型', 'type' => 'string', 'example' => 'key1', 'title' => ''],
+ 'title' => '',
+ 'example' => '',
+ ],
+ 'schema' => [
+ 'description' => 'The data sink schema.',
+ 'type' => 'array',
+ 'items' => [
+ 'description' => 'The data sink schema.',
+ 'type' => 'object',
+ 'additionalProperties' => ['description' => 'key为String类型', 'type' => 'string', 'example' => '"name"', 'title' => ''],
+ 'title' => '',
+ 'example' => '',
+ ],
+ 'title' => '',
+ 'example' => '',
+ ],
+ 'primaryKey' => ['description' => 'The primary key field of the data sink.', 'type' => 'string', 'example' => 'id', 'title' => ''],
+ ],
+ 'title' => '',
+ 'example' => '',
+ ],
+ 'title' => '',
+ 'example' => '',
+ ],
+ 'processors' => [
+ 'description' => 'The processing pipeline operators.',
+ 'type' => 'array',
+ 'items' => [
+ 'description' => 'The processing pipeline operators.',
+ 'type' => 'object',
+ 'properties' => [
+ 'name' => ['description' => 'The name.', 'type' => 'string', 'example' => '"processor1"', 'title' => ''],
+ 'type' => ['description' => 'The type.', 'type' => 'string', 'example' => '"document-analyze"', 'title' => ''],
+ 'input' => ['description' => 'The input parameters.', 'type' => 'object', 'title' => '', 'example' => ''],
+ 'parameters' => ['description' => 'The processor parameters.', 'type' => 'object', 'example' => '{'."\n"
+ .'"service_id": "xxx"'."\n"
+ .'}', 'title' => ''],
+ ],
+ 'title' => '',
+ 'example' => '',
+ ],
+ 'title' => '',
+ 'example' => '',
+ ],
+ 'parameters' => ['description' => 'The task processing parameters.', 'type' => 'object', 'example' => '{'."\n"
+ .'"parameter1": {'."\n"
+ .'"key": "value"'."\n"
+ .'},'."\n"
+ .'"parameter2": {'."\n"
+ .'"key": "value"'."\n"
+ .'}'."\n"
+ .'}', 'title' => ''],
+ 'status' => [
+ 'description' => 'The task status.',
+ 'type' => 'object',
+ 'properties' => [
+ 'status' => ['description' => 'The task status.', 'type' => 'string', 'example' => 'RUNNING', 'title' => ''],
+ 'createTime' => ['description' => 'The task start time.', 'type' => 'string', 'example' => '1744941600000', 'title' => ''],
+ 'deleteTime' => ['description' => 'The task stop time.', 'type' => 'string', 'example' => '1744941600000', 'title' => ''],
+ 'errorMessage' => ['description' => 'The error message.', 'type' => 'string', 'example' => '""', 'title' => ''],
+ ],
+ 'title' => '',
+ 'example' => '',
+ ],
+ ],
+ 'title' => '',
+ 'example' => '',
+ ],
+ ],
+ 'example' => '',
+ ],
+ ],
+ ],
+ 'staticInfo' => ['returnType' => 'synchronous'],
+ 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"requestId\\": \\"B7C901ED-2BC1-5CFB-BE23-242DE5E3BA5C\\",\\n \\"result\\": {\\n \\"meta\\": {\\n \\"taskName\\": \\"test\\",\\n \\"computeResource\\": \\"small\\"\\n },\\n \\"source\\": [\\n {\\n \\"name\\": \\"table1\\",\\n \\"type\\": \\"swift\\",\\n \\"parameters\\": {\\n \\"key\\": \\"key\\"\\n },\\n \\"schema\\": [\\n {\\n \\"key\\": \\"\\\\\\"\\\\\\"\\"\\n }\\n ],\\n \\"primaryKey\\": \\"id\\"\\n }\\n ],\\n \\"sink\\": [\\n {\\n \\"name\\": \\"table2\\",\\n \\"type\\": \\"swift\\",\\n \\"parameters\\": {\\n \\"key\\": \\"key1\\"\\n },\\n \\"schema\\": [\\n {\\n \\"key\\": \\"\\\\\\"name\\\\\\"\\"\\n }\\n ],\\n \\"primaryKey\\": \\"id\\"\\n }\\n ],\\n \\"processors\\": [\\n {\\n \\"name\\": \\"\\\\\\"processor1\\\\\\"\\",\\n \\"type\\": \\"\\\\\\"document-analyze\\\\\\"\\",\\n \\"input\\": {\\n \\"test\\": \\"test\\",\\n \\"test2\\": 1\\n },\\n \\"parameters\\": {\\n \\"service_id\\": \\"xxx\\"\\n }\\n }\\n ],\\n \\"parameters\\": {\\n \\"parameter1\\": {\\n \\"key\\": \\"value\\"\\n },\\n \\"parameter2\\": {\\n \\"key\\": \\"value\\"\\n }\\n },\\n \\"status\\": {\\n \\"status\\": \\"RUNNING\\",\\n \\"createTime\\": \\"1744941600000\\",\\n \\"deleteTime\\": \\"1744941600000\\",\\n \\"errorMessage\\": \\"\\\\\\"\\\\\\"\\"\\n }\\n }\\n}","type":"json"}]',
+ 'title' => 'Create an offline task',
+ 'description' => '## Operation description.',
+ 'changeSet' => [
+ ['createdAt' => '2025-12-02T07:12:30.000Z', 'description' => 'Request parameters changed'],
+ ],
+ 'ramActions' => [
+ [
+ 'operationType' => 'create',
+ 'ramAction' => [
+ 'action' => 'searchplat:CreateOfflineTask',
+ 'authLevel' => 'operate',
+ 'actionConditions' => [],
+ 'resources' => [
+ ['validationType' => 'always', 'product' => 'SearchPlat', 'resourceType' => 'All Resource', 'arn' => '*'],
+ ],
+ ],
+ ],
+ ],
+ ],
+ 'CreateRagEvaluatorTask' => [
+ 'summary' => 'Creates an evaluation task for the RAG edition.',
+ 'path' => '/openapi/platform/workspaces/{workspaceName}/rag-evaluator/v1/api/task',
+ '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' => '226065',
+ 'abilityTreeNodes' => ['FEATUREopensearchWAC9DF'],
+ ],
+ 'parameters' => [
+ [
+ 'name' => 'workspaceName',
+ 'in' => 'path',
+ 'schema' => ['description' => 'The workspace name.', 'type' => 'string', 'required' => false, 'example' => 'myWorkspace', 'title' => ''],
+ ],
+ [
+ 'name' => 'body',
+ 'in' => 'body',
+ 'style' => 'json',
+ 'schema' => [
+ 'description' => 'The request body.',
+ 'type' => 'object',
+ 'properties' => [
+ 'app_name' => ['description' => 'app_name', 'type' => 'string', 'required' => false, 'example' => '空', 'title' => ''],
+ 'task_name' => ['description' => 'The evaluation task name.', 'type' => 'string', 'required' => false, 'example' => 'taskName', 'title' => ''],
+ 'data' => [
+ 'description' => 'The list of evaluation data.',
+ 'type' => 'array',
+ 'items' => [
+ 'description' => 'The evaluation data.',
+ 'type' => 'object',
+ 'properties' => [
+ 'question' => ['description' => 'question', 'type' => 'string', 'required' => false, 'example' => '空', 'title' => ''],
+ 'standard_answer' => ['description' => 'standard_answer', 'type' => 'string', 'required' => false, 'example' => '空', 'title' => ''],
+ 'recall_docs' => [
+ 'description' => 'recall_docs',
+ 'type' => 'array',
+ 'items' => ['description' => 'recall_doc', 'type' => 'string', 'required' => false, 'example' => '空', 'title' => ''],
+ 'required' => false,
+ 'title' => '',
+ 'example' => '',
+ ],
+ 'model_answer' => ['description' => 'model_answer', 'type' => 'string', 'required' => false, 'example' => '空', 'title' => ''],
+ ],
+ 'required' => false,
+ 'title' => '',
+ 'example' => '',
+ ],
+ 'required' => false,
+ 'title' => '',
+ 'example' => '',
+ ],
+ 'evaluate_config' => [
+ 'description' => 'The evaluation configuration.',
+ 'type' => 'object',
+ 'properties' => [
+ 'model' => ['description' => 'The model to use.', 'type' => 'string', 'required' => false, 'example' => 'qwen-72b', 'title' => ''],
+ 'prompt' => ['description' => 'prompt', 'type' => 'string', 'required' => false, 'example' => '空', 'title' => ''],
+ 'run_all_step' => ['description' => 'run_all_step', 'type' => 'boolean', 'required' => false, 'example' => 'false', 'title' => ''],
+ ],
+ 'required' => false,
+ 'title' => '',
+ 'example' => '',
+ ],
+ 'metrics' => [
+ 'description' => 'The metric values. Valid values:'."\n"
+ .'- context_recall'."\n"
+ .'- context_precision'."\n"
+ .'- faithfulness'."\n"
+ .'- satisfaction'."\n"
+ .'- comprehensive_score.',
+ 'type' => 'array',
+ 'items' => ['description' => 'The metric value.', 'type' => 'any', 'required' => false, 'example' => 'context_recall', 'title' => ''],
+ 'required' => false,
+ 'title' => '',
+ 'example' => '',
+ ],
+ 'emails' => [
+ 'description' => 'emails',
+ 'type' => 'array',
+ 'items' => ['description' => 'email', 'type' => 'string', 'required' => false, 'example' => '空', 'title' => ''],
+ 'required' => false,
+ 'title' => '',
+ 'example' => '',
+ ],
+ 'has_data_source' => ['description' => 'has_data_source', 'type' => 'boolean', 'required' => false, 'example' => '空', 'title' => ''],
+ 'data_source_config' => ['description' => 'The datasource config.', 'type' => 'any', 'required' => false, 'example' => '{'."\n"
+ .'"data_source_type": "oss",'."\n"
+ .'"file_path": "oss://xxx.",'."\n"
+ .'"file_name": "04837719-default-zz.xlsx"'."\n"
+ .'}', 'title' => ''],
+ ],
+ 'required' => false,
+ 'title' => '',
+ 'example' => '',
+ ],
+ ],
+ ],
+ 'responses' => [
+ 200 => [
+ 'schema' => [
+ 'title' => '',
+ 'description' => 'Schema of Response',
+ 'type' => 'object',
+ 'properties' => [
+ 'requestId' => ['title' => '', 'description' => 'Id of the request', 'type' => 'string', 'example' => '0abb793917165176014887584e28d9'],
+ 'code' => ['description' => 'The error code.', 'type' => 'string', 'example' => 'not found', 'title' => ''],
+ 'message' => ['description' => 'The error message.', 'type' => 'string', 'example' => '"xx not found"', 'title' => ''],
+ 'result' => [
+ 'description' => 'The returned result.',
+ 'type' => 'object',
+ 'properties' => [
+ 'taskId' => ['description' => 'The task ID.', 'type' => 'string', 'example' => '1846389386674049024', 'title' => ''],
+ ],
+ 'title' => '',
+ 'example' => '',
+ ],
+ ],
+ 'example' => '',
+ ],
+ ],
+ ],
+ 'staticInfo' => ['returnType' => 'synchronous'],
+ 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"requestId\\": \\"0abb793917165176014887584e28d9\\",\\n \\"code\\": \\"not found\\",\\n \\"message\\": \\"\\\\\\"xx not found\\\\\\"\\",\\n \\"result\\": {\\n \\"taskId\\": \\"1846389386674049024\\"\\n }\\n}","type":"json"}]',
+ 'title' => 'Create an evaluation task',
+ 'changeSet' => [],
+ 'ramActions' => [
+ [
+ 'operationType' => 'create',
+ 'ramAction' => [
+ 'action' => 'searchplat:WriteEvaluation',
+ 'authLevel' => 'operate',
+ 'actionConditions' => [],
+ 'resources' => [
+ ['validationType' => 'always', 'product' => 'SearchPlat', 'resourceType' => 'All Resource', 'arn' => '*'],
+ ],
+ ],
+ ],
+ ],
+ ],
+ 'CreateWorkspace' => [
+ 'summary' => 'Create Workspace',
+ 'path' => '/openapi/platform/workspaces',
+ 'methods' => ['post'],
+ 'schemes' => ['http', 'https'],
+ 'security' => [
+ [
+ 'AK' => [],
+ ],
+ ],
+ 'operationType' => 'write',
+ 'deprecated' => false,
+ 'systemTags' => [
+ 'operationType' => 'none',
+ 'riskType' => 'none',
+ 'chargeType' => 'free',
+ 'abilityTreeCode' => '218195',
+ 'abilityTreeNodes' => ['FEATUREopensearch2ESE2N'],
+ ],
+ 'parameters' => [
+ [
+ 'name' => 'body',
+ 'in' => 'body',
+ 'style' => 'json',
+ 'schema' => [
+ 'description' => 'Request body.',
+ 'type' => 'object',
+ 'properties' => [
+ 'chargeType' => ['description' => 'Billing type'."\n"
+ .'- POSTPAY: Pay-as-you-go', 'type' => 'string', 'required' => false, 'example' => 'POSTPAY', 'title' => ''],
+ 'engineType' => ['description' => 'Engine type'."\n"
+ .'- rag', 'type' => 'string', 'required' => false, 'example' => 'rag', 'title' => ''],
+ 'name' => ['description' => 'Workspace name', 'type' => 'string', 'required' => false, 'example' => 'default', 'title' => ''],
+ 'quota' => [
+ 'description' => 'Quota',
+ 'type' => 'object',
+ 'properties' => [
+ 'computeResource' => ['description' => 'Compute resource (unit: LCU)', 'type' => 'integer', 'format' => 'int32', 'required' => false, 'example' => '0', 'title' => ''],
+ 'docSize' => ['description' => 'Storage capacity (unit: GB)', 'type' => 'integer', 'format' => 'int32', 'required' => false, 'example' => '0', 'title' => ''],
+ 'spec' => ['description' => 'Specification'."\n"
+ .'- rag.share.common', 'type' => 'string', 'required' => false, 'example' => 'rag.share.common'."\n", 'title' => ''],
+ ],
+ 'required' => false,
+ 'title' => '',
+ 'example' => '',
+ ],
+ 'type' => ['description' => 'Type'."\n"
+ .'- standard', 'type' => 'string', 'required' => false, 'example' => 'standard', 'title' => ''],
+ ],
+ 'required' => false,
+ 'title' => '',
+ 'example' => '',
+ ],
+ ],
+ ],
+ 'responses' => [
+ 200 => [
+ 'schema' => [
+ 'title' => '',
+ 'description' => 'Schema of Response',
+ 'type' => 'object',
+ 'properties' => [
+ 'requestId' => ['title' => '', 'description' => 'Id of the request', 'type' => 'string', 'example' => '2BA0504F-B179-586D-8210-A7C7C09A9907'],
+ 'result' => [
+ 'description' => 'Response result',
+ 'type' => 'object',
+ 'properties' => [
+ 'chargeType' => ['description' => 'Billing type'."\n"
+ .'- POSTPAY: Pay-as-you-go', 'type' => 'string', 'example' => 'POSTPAY', 'title' => ''],
+ 'commodityCode' => ['description' => 'Commodity code', 'type' => 'string', 'example' => 'opensearch_platform_public_cn', 'title' => ''],
+ 'description' => ['description' => 'Workspace description', 'type' => 'string', 'example' => '描述', 'title' => ''],
+ 'domainName' => ['description' => 'Custom domain name prefix', 'type' => 'string', 'example' => 'defalult-xxxx', 'title' => ''],
+ 'engineType' => ['description' => 'Engine type', 'type' => 'string', 'example' => 'rag', 'title' => ''],
+ 'id' => ['description' => 'Workspace ID', 'type' => 'string', 'example' => '120142804', 'title' => ''],
+ 'instanceId' => ['description' => 'Workspace instance ID', 'type' => 'string', 'example' => 'ops-xxxxx', 'title' => ''],
+ 'name' => ['description' => 'Workspace name', 'type' => 'string', 'example' => 'default', 'title' => ''],
+ 'quota' => [
+ 'description' => 'Quota',
+ 'type' => 'object',
+ 'properties' => [
+ 'computeResource' => ['description' => 'Compute resource', 'type' => 'integer', 'format' => 'int32', 'example' => '0', 'title' => ''],
+ 'docSize' => ['description' => 'Storage capacity', 'type' => 'integer', 'format' => 'int32', 'example' => '0', 'title' => ''],
+ 'spec' => ['description' => 'Specification', 'type' => 'string', 'example' => 'rag.share.common', 'title' => ''],
+ ],
+ 'title' => '',
+ 'example' => '',
+ ],
+ 'resourceGroupId' => ['description' => 'Resource group ID', 'type' => 'string', 'example' => 'rg-xxxxxx', 'title' => ''],
+ 'tags' => [
+ 'description' => 'Tags',
+ 'type' => 'array',
+ 'items' => [
+ 'type' => 'object',
+ 'properties' => [
+ 'tagKey' => ['description' => 'Tag key', 'type' => 'string', 'example' => 'a', 'title' => ''],
+ 'tagValue' => ['description' => 'Tag value', 'type' => 'string', 'example' => 'c', 'title' => ''],
+ ],
+ 'description' => '',
+ 'title' => '',
+ 'example' => '',
+ ],
+ 'title' => '',
+ 'example' => '',
+ ],
+ 'type' => ['description' => 'Type', 'type' => 'string', 'example' => 'standard', 'title' => ''],
+ ],
+ 'title' => '',
+ 'example' => '',
+ ],
+ ],
+ 'example' => '',
+ ],
+ ],
+ ],
+ 'staticInfo' => ['returnType' => 'synchronous'],
+ 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"requestId\\": \\"2BA0504F-B179-586D-8210-A7C7C09A9907\\",\\n \\"result\\": {\\n \\"chargeType\\": \\"POSTPAY\\",\\n \\"commodityCode\\": \\"opensearch_platform_public_cn\\",\\n \\"description\\": \\"描述\\",\\n \\"domainName\\": \\"defalult-xxxx\\",\\n \\"engineType\\": \\"rag\\",\\n \\"id\\": \\"120142804\\",\\n \\"instanceId\\": \\"ops-xxxxx\\",\\n \\"name\\": \\"default\\",\\n \\"quota\\": {\\n \\"computeResource\\": 0,\\n \\"docSize\\": 0,\\n \\"spec\\": \\"rag.share.common\\"\\n },\\n \\"resourceGroupId\\": \\"rg-xxxxxx\\",\\n \\"tags\\": [\\n {\\n \\"tagKey\\": \\"a\\",\\n \\"tagValue\\": \\"c\\"\\n }\\n ],\\n \\"type\\": \\"standard\\"\\n }\\n}","type":"json"}]',
+ 'title' => 'Create Workspace',
+ 'changeSet' => [],
+ 'ramActions' => [
+ [
+ 'operationType' => 'none',
+ 'ramAction' => [
+ 'action' => 'searchplat:WriteWorkspace',
+ 'authLevel' => 'resource',
+ 'actionConditions' => [],
+ 'resources' => [
+ ['validationType' => 'always', 'product' => 'SearchPlat', 'resourceType' => 'All Resource', 'arn' => '*'],
+ ],
+ ],
+ ],
+ ],
+ ],
+ 'DeleteCapability' => [
+ 'summary' => 'Deletes a specific configuration item from a specified workspace.',
+ 'path' => '/openapi/platform/workspaces/{workspaceName}/capabilities/{itemCategory}/items/{itemName}',
+ 'methods' => ['delete'],
+ 'schemes' => ['https'],
+ 'security' => [
+ [
+ 'AK' => [],
+ ],
+ ],
+ 'consumes' => ['application/json'],
+ 'produces' => ['application/json'],
+ 'operationType' => 'write',
+ 'deprecated' => false,
+ 'systemTags' => [
+ 'operationType' => 'delete',
+ 'riskType' => 'none',
+ 'chargeType' => 'free',
+ 'abilityTreeNodes' => ['FEATUREopensearch8B42ZS'],
+ 'tenantRelevance' => 'tenant',
+ ],
+ 'parameters' => [
+ [
+ 'name' => 'workspaceName',
+ 'in' => 'path',
+ 'schema' => ['description' => 'The workspace name.', 'type' => 'string', 'required' => true, 'example' => 'default', 'title' => ''],
+ ],
+ [
+ 'name' => 'itemCategory',
+ 'in' => 'path',
+ 'schema' => ['description' => 'The configuration category ai_search_agent.', 'type' => 'string', 'required' => true, 'example' => 'ai_search_agent', 'title' => ''],
+ ],
+ [
+ 'name' => 'itemName',
+ 'in' => 'path',
+ 'schema' => ['description' => 'The configuration name.', 'type' => 'string', 'required' => true, 'example' => 'es_knowledge_base', 'title' => ''],
+ ],
+ ],
+ 'responses' => [
+ 200 => [
+ 'schema' => [
+ 'title' => '',
+ 'description' => 'Schema of Response',
+ 'type' => 'object',
+ 'properties' => [
+ 'requestId' => ['title' => '', 'description' => 'The request ID.', 'type' => 'string', 'example' => '7CC54C38-D721-4C55-A410-2A94B5A6BE0F'],
+ 'httpCode' => ['description' => 'The HTTP status code.', 'type' => 'integer', 'format' => 'int64', 'example' => '200', 'title' => ''],
+ 'status' => ['description' => 'The status.', 'type' => 'string', 'example' => 'OK', 'title' => ''],
+ ],
+ 'example' => '',
+ ],
+ ],
+ ],
+ 'staticInfo' => ['returnType' => 'synchronous'],
+ 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"requestId\\": \\"7CC54C38-D721-4C55-A410-2A94B5A6BE0F\\",\\n \\"httpCode\\": 200,\\n \\"status\\": \\"OK\\"\\n}","type":"json"}]',
+ 'title' => 'Delete a configuration item',
+ 'description' => '## Operation description'."\n"
+ .'This API operation allows you to delete a specific configuration item by specifying the workspace name, configuration category, and configuration name. Before calling this operation, ensure that you have sufficient permissions (such as the `DeleteCapability` action in a RAM policy). After a configuration item is deleted, all related data and services may be affected.',
+ 'changeSet' => [],
+ 'ramActions' => [
+ [
+ 'operationType' => 'delete',
+ 'ramAction' => [
+ 'action' => 'searchplat:DeleteCapability',
+ 'authLevel' => 'operate',
+ 'actionConditions' => [],
+ 'resources' => [
+ ['validationType' => 'always', 'product' => 'SearchPlat', 'resourceType' => 'All Resource', 'arn' => '*'],
+ ],
+ ],
+ ],
+ ],
+ ],
+ 'DeleteCredentials' => [
+ 'path' => '/openapi/platform/workspaces/{workspaceName}/credentials/{token}',
+ 'methods' => ['delete'],
+ 'schemes' => ['http', 'https'],
+ 'security' => [
+ [
+ 'AK' => [],
+ ],
+ ],
+ 'operationType' => 'readAndWrite',
+ 'systemTags' => [
+ 'operationType' => 'delete',
+ 'abilityTreeCode' => '220523',
+ 'abilityTreeNodes' => ['FEATUREopensearch1AJKH0'],
+ ],
+ 'parameters' => [
+ [
+ 'name' => 'token',
+ 'in' => 'path',
+ 'schema' => ['description' => 'The access credential token.', 'type' => 'string', 'required' => true, 'example' => 'OS-********', 'title' => ''],
+ ],
+ [
+ 'name' => 'workspaceName',
+ 'in' => 'path',
+ 'schema' => ['description' => 'The workspace name.', 'type' => 'string', 'required' => true, 'example' => 'myWorkspace', 'title' => ''],
+ ],
+ ],
+ 'responses' => [
+ 200 => [
+ 'schema' => [
+ 'type' => 'object',
+ 'properties' => [
+ 'requestId' => ['description' => 'The request ID.', 'type' => 'string', 'example' => '2423C841-91C4-5E51-B296-590D367967FC', 'title' => ''],
+ ],
+ 'description' => '',
+ 'title' => '',
+ 'example' => '',
+ ],
+ ],
+ '5XX' => [
+ 'schema' => [
+ 'type' => 'object',
+ 'properties' => [
+ 'code' => ['type' => 'string', 'description' => '', 'title' => '', 'example' => ''],
+ 'requestId' => ['type' => 'string', 'description' => '', 'title' => '', 'example' => ''],
+ 'message' => ['type' => 'string', 'description' => '', 'title' => '', 'example' => ''],
+ 'httpCode' => ['type' => 'integer', 'format' => 'int32', 'description' => '', 'title' => '', 'example' => ''],
+ ],
+ 'description' => '',
+ 'title' => '',
+ 'example' => '',
+ ],
+ ],
+ ],
+ 'staticInfo' => ['returnType' => 'synchronous'],
+ 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"requestId\\": \\"2423C841-91C4-5E51-B296-590D367967FC\\"\\n}","type":"json"}]',
+ 'title' => 'Delete an access credential',
+ 'summary' => 'Deletes an access credential.',
+ 'changeSet' => [],
+ 'ramActions' => [
+ [
+ 'operationType' => 'delete',
+ 'ramAction' => [
+ 'action' => 'searchplat:WriteCredentials',
+ 'authLevel' => 'resource',
+ 'actionConditions' => [],
+ 'resources' => [
+ ['validationType' => 'always', 'product' => 'SearchPlat', 'resourceType' => 'Credentials', 'arn' => 'acs:searchplat:{#regionId}:{#accountId}:workspaces/{#workspaceName}'],
+ ],
+ ],
+ ],
+ ],
+ ],
+ 'DeleteExperienceData' => [
+ 'path' => '/openapi/platform/workspaces/{workspaceName}/experience-data/{id}',
+ 'methods' => ['delete'],
+ 'schemes' => ['http', 'https'],
+ 'security' => [
+ [
+ 'AK' => [],
+ ],
+ ],
+ 'operationType' => 'readAndWrite',
+ 'deprecated' => false,
+ 'systemTags' => [
+ 'operationType' => 'delete',
+ 'abilityTreeCode' => '225361',
+ 'abilityTreeNodes' => ['FEATUREopensearch1AJKH0'],
+ ],
+ 'parameters' => [
+ [
+ 'name' => 'dryRun',
+ 'in' => 'query',
+ 'schema' => ['description' => 'Whether this is a dry run request', 'type' => 'boolean', 'required' => false, 'example' => 'false', 'title' => ''],
+ ],
+ [
+ 'name' => 'id',
+ 'in' => 'path',
+ 'schema' => ['description' => 'Data ID', 'type' => 'integer', 'format' => 'int64', 'required' => true, 'example' => '1956', 'title' => ''],
+ ],
+ [
+ 'name' => 'workspaceName',
+ 'in' => 'path',
+ 'schema' => ['description' => 'The workspace name.', 'type' => 'string', 'required' => true, 'example' => 'myWorkspace', 'title' => ''],
+ ],
+ ],
+ 'responses' => [
+ 200 => [
+ 'schema' => [
+ 'title' => '',
+ 'description' => 'Schema of Response',
+ 'type' => 'object',
+ 'properties' => [
+ 'requestId' => ['title' => '', 'description' => 'Id of the request', 'type' => 'string', 'example' => '65C620DA-D6BE-5F56-BBCD-6F2282BB7BAD'],
+ ],
+ 'example' => '',
+ ],
+ ],
+ ],
+ 'staticInfo' => ['returnType' => 'synchronous'],
+ 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"requestId\\": \\"65C620DA-D6BE-5F56-BBCD-6F2282BB7BAD\\"\\n}","type":"json"}]',
+ 'title' => 'Delete Experience Data',
+ 'summary' => 'Delete experience data',
+ 'changeSet' => [],
+ 'ramActions' => [
+ [
+ 'operationType' => 'delete',
+ 'ramAction' => [
+ 'action' => 'searchplat:WriteExperienceData',
+ 'authLevel' => 'resource',
+ 'actionConditions' => [],
+ 'resources' => [
+ ['validationType' => 'always', 'product' => 'SearchPlat', 'resourceType' => 'ExperienceData', 'arn' => 'acs:searchplat:{#regionId}:{#accountId}:workspaces/{#workspaceName}'],
+ ],
+ ],
+ ],
+ ],
+ ],
+ 'DeleteFunctionInstance' => [
+ 'summary' => 'Deletes a service configuration.',
+ 'path' => '/openapi/platform/workspaces/{workspaceName}/functions/{functionName}/instances/{instanceName}',
+ 'methods' => ['delete'],
+ 'schemes' => ['https'],
+ 'security' => [
+ [
+ 'AK' => [],
+ ],
+ ],
+ 'operationType' => 'write',
+ 'deprecated' => false,
+ 'systemTags' => [
+ 'operationType' => 'delete',
+ 'riskType' => 'none',
+ 'chargeType' => 'free',
+ 'abilityTreeCode' => '239777',
+ 'abilityTreeNodes' => ['FEATUREopensearchJK5SO0'],
+ 'autoTest' => true,
+ 'tenantRelevance' => 'publicInformation',
+ ],
+ 'parameters' => [
+ [
+ 'name' => 'workspaceName',
+ 'in' => 'path',
+ 'schema' => ['title' => '', 'description' => 'The workspace name.', 'type' => 'string', 'required' => false, 'example' => 'myWorkspace'],
+ ],
+ [
+ 'name' => 'functionName',
+ 'in' => 'path',
+ 'schema' => ['title' => '', 'description' => 'The service or model configuration.', 'type' => 'string', 'required' => false, 'example' => 'nl2sql'],
+ ],
+ [
+ 'name' => 'instanceName',
+ 'in' => 'path',
+ 'schema' => ['title' => '', 'description' => 'The configuration name.', 'type' => 'string', 'required' => true, 'example' => 'test'],
+ ],
+ ],
+ 'responses' => [
+ 200 => [
+ 'schema' => [
+ 'type' => 'object',
+ 'properties' => [
+ 'Code' => ['description' => 'The error code. This parameter is displayed only when an exception occurs.', 'type' => 'string', 'example' => 'iot.common.RamActionPermissionDeny', 'title' => ''],
+ 'HttpCode' => ['description' => 'The HTTP status code.', 'type' => 'integer', 'format' => 'int64', 'example' => '200', 'title' => ''],
+ 'Latency' => ['description' => 'The request latency, in milliseconds.', 'type' => 'integer', 'format' => 'int64', 'example' => '12', 'title' => ''],
+ 'Message' => ['description' => 'The error message. This parameter is displayed only when an exception occurs.', 'type' => 'string', 'example' => 'Managed id is empty', 'title' => ''],
+ 'RequestId' => ['description' => 'The request ID.', 'type' => 'string', 'example' => '786CC01F-0F1D-5FB5-8BFF-B0F3DB289772', 'title' => ''],
+ 'Status' => ['description' => 'The request status.', 'type' => 'string', 'example' => 'OK', 'title' => ''],
+ ],
+ 'description' => '',
+ 'title' => '',
+ 'example' => '',
+ ],
+ ],
+ ],
+ 'staticInfo' => ['returnType' => 'synchronous'],
+ 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"Code\\": \\"iot.common.RamActionPermissionDeny\\",\\n \\"HttpCode\\": 200,\\n \\"Latency\\": 12,\\n \\"Message\\": \\"Managed id is empty\\",\\n \\"RequestId\\": \\"786CC01F-0F1D-5FB5-8BFF-B0F3DB289772\\",\\n \\"Status\\": \\"OK\\"\\n}","type":"json"}]',
+ 'title' => 'Delete a service or model configuration',
+ 'changeSet' => [],
+ 'ramActions' => [
+ [
+ 'operationType' => 'delete',
+ 'ramAction' => [
+ 'action' => 'searchplat:WriteFunction',
+ 'authLevel' => 'resource',
+ 'actionConditions' => [],
+ 'resources' => [
+ ['validationType' => 'always', 'product' => 'SearchPlat', 'resourceType' => 'FunctionInstance', 'arn' => 'acs:searchplat:{#regionId}:{#accountId}:workspaces/{#workspaceName}'],
+ ],
+ ],
+ ],
+ ],
+ ],
+ 'DeleteOfflineTask' => [
+ 'summary' => 'Deletes a batch task.',
+ 'path' => '/openapi/platform/workspaces/{workspaceName}/offline-tasks/{type}/{taskName}',
+ 'methods' => ['delete'],
+ 'schemes' => ['https'],
+ 'security' => [
+ [
+ 'AK' => [],
+ ],
+ ],
+ 'consumes' => ['application/json'],
+ 'produces' => ['application/json'],
+ 'operationType' => 'read',
+ 'deprecated' => false,
+ 'systemTags' => [
+ 'operationType' => 'delete',
+ 'riskType' => 'none',
+ 'chargeType' => 'free',
+ 'abilityTreeNodes' => ['FEATUREopensearch8B42ZS'],
+ 'tenantRelevance' => 'tenant',
+ ],
+ 'parameters' => [
+ [
+ 'name' => 'workspaceName',
+ 'in' => 'path',
+ 'schema' => ['description' => 'The workspace name.', 'type' => 'string', 'required' => false, 'example' => 'default', 'title' => ''],
+ ],
+ [
+ 'name' => 'type',
+ 'in' => 'path',
+ 'schema' => ['description' => 'The type.', 'type' => 'string', 'required' => false, 'example' => 'video', 'title' => ''],
+ ],
+ [
+ 'name' => 'taskName',
+ 'in' => 'path',
+ 'schema' => ['description' => 'The node name.', 'type' => 'string', 'required' => false, 'example' => 'taskName', 'title' => ''],
+ ],
+ [
+ 'name' => 'regionId',
+ 'in' => 'query',
+ 'schema' => ['title' => '', 'description' => 'The region ID.', 'type' => 'string', 'example' => 'cn-shanghai', 'required' => false],
+ ],
+ ],
+ 'responses' => [
+ 200 => [
+ 'schema' => [
+ 'title' => '',
+ 'description' => 'Schema of Response',
+ 'type' => 'object',
+ 'properties' => [
+ 'requestId' => ['title' => '', 'description' => 'Id of the request', 'type' => 'string', 'example' => '2423C841-91C4-5E51-B296-590D367967FC'],
+ 'result' => ['description' => 'The returned result.', 'type' => 'boolean', 'example' => 'true', 'title' => ''],
+ ],
+ 'example' => '',
+ ],
+ ],
+ ],
+ 'staticInfo' => ['returnType' => 'synchronous'],
+ 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"requestId\\": \\"2423C841-91C4-5E51-B296-590D367967FC\\",\\n \\"result\\": true\\n}","type":"json"}]',
+ 'title' => 'Delete a batch task',
+ 'changeSet' => [
+ ['createdAt' => '2025-12-02T07:12:30.000Z', 'description' => 'Request parameters changed'],
+ ],
+ 'ramActions' => [
+ [
+ 'operationType' => 'delete',
+ 'ramAction' => [
+ 'action' => 'searchplat:DeleteOfflineTask',
+ 'authLevel' => 'operate',
+ 'actionConditions' => [],
+ 'resources' => [
+ ['validationType' => 'always', 'product' => 'SearchPlat', 'resourceType' => 'All Resource', 'arn' => '*'],
+ ],
+ ],
+ ],
+ ],
+ ],
+ 'DeleteRagEvaluatorTask' => [
+ 'summary' => 'Deletes a RAG evaluation task.',
+ 'path' => '/openapi/platform/workspaces/{workspaceName}/rag-evaluator/v1/api/task/{task_id}',
+ 'methods' => ['delete'],
+ 'schemes' => ['http', 'https'],
+ 'security' => [
+ [
+ 'AK' => [],
+ ],
+ ],
+ 'consumes' => ['application/json'],
+ 'produces' => ['application/json'],
+ 'operationType' => 'write',
+ 'deprecated' => false,
+ 'systemTags' => [
+ 'operationType' => 'delete',
+ 'riskType' => 'none',
+ 'chargeType' => 'free',
+ 'abilityTreeCode' => '226069',
+ 'abilityTreeNodes' => ['FEATUREopensearchWAC9DF'],
+ ],
+ 'parameters' => [
+ [
+ 'name' => 'workspaceName',
+ 'in' => 'path',
+ 'schema' => ['description' => 'The workspace name.', 'type' => 'string', 'required' => false, 'example' => 'myWorkspace', 'title' => ''],
+ ],
+ [
+ 'name' => 'task_id',
+ 'in' => 'path',
+ 'schema' => ['description' => 'The task ID.', 'type' => 'string', 'required' => false, 'example' => 'T-6684b38a48bc8e012d00052c', 'title' => ''],
+ ],
+ ],
+ 'responses' => [
+ 200 => [
+ 'schema' => [
+ 'title' => '',
+ 'description' => 'Schema of Response',
+ 'type' => 'object',
+ 'properties' => [
+ 'requestId' => ['title' => '', 'description' => 'Id of the request', 'type' => 'string', 'example' => '0B66A850-506C-56B7-B001-EA09411CCD69'],
+ 'code' => ['description' => 'The status code.', 'type' => 'string', 'example' => 'not found', 'title' => ''],
+ 'message' => ['description' => 'The error message.', 'type' => 'string', 'example' => '"xx not found"', 'title' => ''],
+ ],
+ 'example' => '',
+ ],
+ ],
+ ],
+ 'staticInfo' => ['returnType' => 'synchronous'],
+ 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"requestId\\": \\"0B66A850-506C-56B7-B001-EA09411CCD69\\",\\n \\"code\\": \\"not found\\",\\n \\"message\\": \\"\\\\\\"xx not found\\\\\\"\\"\\n}","type":"json"}]',
+ 'title' => 'Delete an evaluation task',
+ 'changeSet' => [],
+ 'ramActions' => [
+ [
+ 'operationType' => 'delete',
+ 'ramAction' => [
+ 'action' => 'searchplat:WriteEvaluation',
+ 'authLevel' => 'operate',
+ 'actionConditions' => [],
+ 'resources' => [
+ ['validationType' => 'always', 'product' => 'SearchPlat', 'resourceType' => 'All Resource', 'arn' => '*'],
+ ],
+ ],
+ ],
+ ],
+ ],
+ 'DeleteWorkspace' => [
+ 'summary' => 'Deletes a workspace.',
+ 'path' => '/openapi/platform/workspaces/{workspaceName}',
+ 'methods' => ['delete'],
+ 'schemes' => ['http', 'https'],
+ 'security' => [
+ [
+ 'AK' => [],
+ ],
+ ],
+ 'operationType' => 'write',
+ 'deprecated' => false,
+ 'systemTags' => [
+ 'operationType' => 'none',
+ 'riskType' => 'none',
+ 'chargeType' => 'free',
+ 'abilityTreeCode' => '218190',
+ 'abilityTreeNodes' => ['FEATUREopensearch2ESE2N'],
+ ],
+ 'parameters' => [
+ [
+ 'name' => 'workspaceName',
+ 'in' => 'path',
+ 'schema' => ['title' => '', 'description' => 'The workspace name.', 'type' => 'string', 'required' => true, 'example' => 'myWorkspace'],
+ ],
+ ],
+ 'responses' => [
+ 200 => [
+ 'schema' => [
+ 'title' => '',
+ 'description' => 'Schema of Response',
+ 'type' => 'object',
+ 'properties' => [
+ 'requestId' => ['title' => '', 'description' => 'Id of the request', 'type' => 'string', 'example' => '5950143C-B8F0-5758-A08A-66F302FD587F'],
+ 'result' => [
+ 'description' => 'The returned result.',
+ 'type' => 'object',
+ 'properties' => [
+ 'instanceId' => ['description' => 'The instance ID.', 'type' => 'string', 'example' => 'ops-cn-em93wcq0s001', 'title' => ''],
+ ],
+ 'title' => '',
+ 'example' => '',
+ ],
+ ],
+ 'example' => '',
+ ],
+ ],
+ ],
+ 'staticInfo' => ['returnType' => 'synchronous'],
+ 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"requestId\\": \\"5950143C-B8F0-5758-A08A-66F302FD587F\\",\\n \\"result\\": {\\n \\"instanceId\\": \\"ops-cn-em93wcq0s001\\"\\n }\\n}","type":"json"}]',
+ 'title' => 'Delete a workspace',
+ 'changeSet' => [],
+ 'ramActions' => [
+ [
+ 'operationType' => 'none',
+ 'ramAction' => [
+ 'action' => 'searchplat:WriteWorkspace',
+ 'authLevel' => 'resource',
+ 'actionConditions' => [],
+ 'resources' => [
+ ['validationType' => 'always', 'product' => 'SearchPlat', 'resourceType' => 'Workspace', 'arn' => 'acs:searchplat:{#regionId}:{#accountId}:workspaces/{#workspaceName}'],
+ ],
+ ],
+ ],
+ ],
+ ],
+ 'DescribeCapability' => [
+ 'summary' => 'Query the details of a configuration item of a specific category within a specified workspace.',
+ 'path' => '/openapi/platform/workspaces/{workspaceName}/capabilities/{itemCategory}/items/{itemName}',
+ 'methods' => ['get'],
+ 'schemes' => ['https'],
+ 'security' => [
+ [
+ 'AK' => [],
+ ],
+ ],
+ 'consumes' => ['application/json'],
+ 'produces' => ['application/json'],
+ 'operationType' => 'read',
+ 'deprecated' => false,
+ 'systemTags' => [
+ 'operationType' => 'get',
+ 'riskType' => 'none',
+ 'chargeType' => 'free',
+ 'abilityTreeNodes' => ['FEATUREopensearch8B42ZS'],
+ 'tenantRelevance' => 'tenant',
+ ],
+ 'parameters' => [
+ [
+ 'name' => 'workspaceName',
+ 'in' => 'path',
+ 'schema' => ['description' => '**Workspace name**'."\n", 'type' => 'string', 'required' => true, 'example' => 'default', 'title' => ''],
+ ],
+ [
+ 'name' => 'itemCategory',
+ 'in' => 'path',
+ 'schema' => ['description' => '**Configuration category ai_search_agent**'."\n", 'type' => 'string', 'required' => true, 'example' => 'ai_search_agent', 'title' => ''],
+ ],
+ [
+ 'name' => 'itemName',
+ 'in' => 'path',
+ 'schema' => ['description' => '**Configuration name**'."\n", 'type' => 'string', 'required' => true, 'example' => 'es_knowledge_base', 'title' => ''],
+ ],
+ ],
+ 'responses' => [
+ 200 => [
+ 'schema' => [
+ 'title' => '',
+ 'description' => 'Schema of Response',
+ 'type' => 'object',
+ 'properties' => [
+ 'requestId' => ['description' => 'Request ID', 'type' => 'string', 'example' => '0E3D5E2B-B63A-4445-B359-329CC07255EA', 'title' => ''],
+ 'status' => ['description' => 'Request status', 'type' => 'string', 'example' => 'OK', 'title' => ''],
+ 'httpCode' => ['description' => 'HTTP status code'."\n", 'type' => 'integer', 'format' => 'int64', 'example' => '200', 'title' => ''],
+ 'result' => [
+ 'description' => 'Response result',
+ 'type' => 'object',
+ 'properties' => [
+ 'created' => ['description' => 'Timestamp of creation time'."\n", 'type' => 'integer', 'format' => 'int64', 'example' => '1745893195510', 'title' => ''],
+ 'isDefault' => ['description' => 'Whether it is the default configuration'."\n", 'type' => 'boolean', 'example' => 'false', 'title' => ''],
+ 'itemCategory' => ['description' => 'Configuration category'."\n", 'type' => 'string', 'example' => 'ai_search_agent', 'title' => ''],
+ 'itemDesc' => ['description' => 'Configuration description'."\n", 'type' => 'string', 'example' => '描述'."\n"
+ ."\n", 'title' => ''],
+ 'itemName' => ['description' => 'Configuration name'."\n", 'type' => 'string', 'example' => 'es_knowledge_base', 'title' => ''],
+ 'itemValue' => ['description' => 'An object containing information such as endpoint and function, which describes the detailed configuration of the knowledge base.'."\n", 'type' => 'object', 'title' => '', 'example' => ''],
+ 'status' => ['description' => 'Status'."\n", 'type' => 'string', 'example' => 'available', 'title' => ''],
+ 'updated' => ['description' => 'Update timestamp'."\n", 'type' => 'integer', 'format' => 'int64', 'example' => '1729665694', 'title' => ''],
+ ],
+ 'title' => '',
+ 'example' => '',
+ ],
+ ],
+ 'example' => '',
+ ],
+ ],
+ ],
+ 'staticInfo' => ['returnType' => 'synchronous'],
+ 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"requestId\\": \\"0E3D5E2B-B63A-4445-B359-329CC07255EA\\",\\n \\"status\\": \\"OK\\",\\n \\"httpCode\\": 200,\\n \\"result\\": {\\n \\"created\\": 1745893195510,\\n \\"isDefault\\": false,\\n \\"itemCategory\\": \\"ai_search_agent\\",\\n \\"itemDesc\\": \\"描述\\\\n\\\\n\\",\\n \\"itemName\\": \\"es_knowledge_base\\",\\n \\"itemValue\\": {\\n \\"test\\": \\"test\\",\\n \\"test2\\": 1\\n },\\n \\"status\\": \\"available\\",\\n \\"updated\\": 1729665694\\n }\\n}","type":"json"}]',
+ 'title' => 'Get Configuration Details',
+ 'description' => '## Request Description'."\n"
+ .'This API is used to retrieve specific configuration information based on the provided workspace name, configuration category, and configuration name. Please ensure the parameters in the request path are accurate, especially the three required fields: `workspaceName`, `itemCategory`, and `itemName`. Additionally, please note that `itemCategory` currently only supports the `ai_search_agent` category.'."\n",
+ 'changeSet' => [],
+ 'ramActions' => [
+ [
+ 'operationType' => 'get',
+ 'ramAction' => [
+ 'action' => 'searchplat:DescribeCapability',
+ 'authLevel' => 'operate',
+ 'actionConditions' => [],
+ 'resources' => [
+ ['validationType' => 'always', 'product' => 'SearchPlat', 'resourceType' => 'All Resource', 'arn' => '*'],
+ ],
+ ],
+ ],
+ ],
+ ],
+ 'DescribeRegions' => [
+ 'path' => '/openapi/platform/regions',
+ 'methods' => ['get'],
+ 'schemes' => ['http', 'https'],
+ 'security' => [
+ [
+ 'AK' => [],
+ ],
+ ],
+ 'operationType' => 'read',
+ 'deprecated' => false,
+ 'systemTags' => [
+ 'operationType' => 'get',
+ 'abilityTreeCode' => '218714',
+ 'abilityTreeNodes' => ['FEATUREopensearchJK5SO0'],
+ ],
+ 'parameters' => [],
+ 'responses' => [
+ 200 => [
+ 'schema' => [
+ 'title' => '',
+ 'description' => 'Schema of Response',
+ 'type' => 'object',
+ 'properties' => [
+ 'requestId' => ['title' => '', 'description' => 'Id of the request', 'type' => 'string', 'example' => 'AE3554F3-313D-5712-919C-A334615C5DE5'],
+ ],
+ 'example' => '',
+ ],
+ ],
+ ],
+ 'staticInfo' => ['returnType' => 'synchronous'],
+ 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"requestId\\": \\"AE3554F3-313D-5712-919C-A334615C5DE5\\"\\n}","type":"json"}]',
+ 'title' => 'Query supported regions',
+ 'summary' => 'DescribeRegions.',
+ 'changeSet' => [],
+ 'ramActions' => [],
+ ],
+ 'GetAsyncTask' => [
+ 'summary' => 'Retrieves the details of an asynchronous task.',
+ 'path' => '/openapi/platform/workspaces/{workspaceName}/async-tasks/{id}',
+ 'methods' => ['get'],
+ 'schemes' => ['http', 'https'],
+ 'security' => [
+ [
+ 'AK' => [],
+ ],
+ ],
+ 'operationType' => 'read',
+ 'deprecated' => false,
+ 'systemTags' => [
+ 'operationType' => 'get',
+ 'riskType' => 'none',
+ 'chargeType' => 'free',
+ 'abilityTreeCode' => '225787',
+ 'abilityTreeNodes' => ['FEATUREopensearch1AJKH0'],
+ ],
+ 'parameters' => [
+ [
+ 'name' => 'dryRun',
+ 'in' => 'query',
+ 'schema' => ['description' => 'Specifies whether to perform a dry run request.', 'type' => 'boolean', 'required' => false, 'example' => 'false', 'title' => ''],
+ ],
+ [
+ 'name' => 'workspaceName',
+ 'in' => 'path',
+ 'schema' => ['description' => 'The workspace name.', 'type' => 'string', 'required' => true, 'example' => 'myWorkspace', 'title' => ''],
+ ],
+ [
+ 'name' => 'id',
+ 'in' => 'path',
+ 'schema' => ['description' => 'The asynchronous task ID.', 'type' => 'string', 'required' => true, 'example' => 'addf-dfd-faa', 'title' => ''],
+ ],
+ ],
+ 'responses' => [
+ 200 => [
+ 'schema' => [
+ 'title' => '',
+ 'description' => 'Schema of Response',
+ 'type' => 'object',
+ 'properties' => [
+ 'requestId' => ['title' => '', 'description' => 'Id of the request', 'type' => 'string', 'example' => '58113A95-1858-5674-87E5-192AEE6FD9DD'],
+ 'result' => [
+ 'description' => 'The response result.',
+ 'type' => 'object',
+ 'properties' => [
+ 'id' => ['description' => 'The asynchronous task ID.', 'type' => 'string', 'example' => 'taskf90b77d481c47b05c18266a31b6cdbdd', 'title' => ''],
+ 'serviceType' => ['description' => 'The service type.', 'type' => 'string', 'example' => 'document-analyze', 'title' => ''],
+ 'serviceId' => ['description' => 'The service ID.', 'type' => 'string', 'example' => 'ops-document-analyze-001', 'title' => ''],
+ 'name' => ['description' => 'The task name.', 'type' => 'string', 'example' => '文档解析任务', 'title' => ''],
+ 'dataId' => ['description' => 'The playground data ID.', 'type' => 'integer', 'format' => 'int32', 'example' => '123', 'title' => ''],
+ 'status' => ['description' => 'The task status. Valid values:'."\n"
+ .'- PENDING: in progress.'."\n"
+ .'- SUCCESS: parsing succeeded.'."\n"
+ .'- FAILED: parsing failed.', 'type' => 'string', 'example' => 'PENDING', 'title' => ''],
+ 'result' => ['description' => 'The parsing result.', 'type' => 'string', 'example' => '{}', 'title' => ''],
+ 'created' => ['description' => 'The creation time.', 'type' => 'integer', 'format' => 'int64', 'example' => '1729684154', 'title' => ''],
+ 'updated' => ['description' => 'The update time.', 'type' => 'integer', 'format' => 'int64', 'example' => '1729684154', 'title' => ''],
+ ],
+ 'title' => '',
+ 'example' => '',
+ ],
+ ],
+ 'example' => '',
+ ],
+ ],
+ ],
+ 'staticInfo' => ['returnType' => 'synchronous'],
+ 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"requestId\\": \\"58113A95-1858-5674-87E5-192AEE6FD9DD\\",\\n \\"result\\": {\\n \\"id\\": \\"taskf90b77d481c47b05c18266a31b6cdbdd\\",\\n \\"serviceType\\": \\"document-analyze\\",\\n \\"serviceId\\": \\"ops-document-analyze-001\\",\\n \\"name\\": \\"文档解析任务\\",\\n \\"dataId\\": 123,\\n \\"status\\": \\"PENDING\\",\\n \\"result\\": \\"{}\\",\\n \\"created\\": 1729684154,\\n \\"updated\\": 1729684154\\n }\\n}","type":"json"}]',
+ 'title' => 'Get task details',
+ 'changeSet' => [],
+ 'ramActions' => [
+ [
+ 'operationType' => 'get',
+ 'ramAction' => [
+ 'action' => 'searchplat:DescribeAsyncTask',
+ 'authLevel' => 'resource',
+ 'actionConditions' => [],
+ 'resources' => [
+ ['validationType' => 'always', 'product' => 'SearchPlat', 'resourceType' => 'AsyncTasks', 'arn' => 'acs:searchplat:{#regionId}:{#accountId}:workspaces/{#workspaceName}'],
+ ],
+ ],
+ ],
+ ],
+ ],
+ 'GetCredentials' => [
+ 'path' => '/openapi/platform/workspaces/{workspaceName}/credentials/{token}',
+ 'methods' => ['get'],
+ 'schemes' => ['http', 'https'],
+ 'security' => [
+ [
+ 'AK' => [],
+ ],
+ ],
+ 'operationType' => 'read',
+ 'systemTags' => [
+ 'operationType' => 'get',
+ 'abilityTreeCode' => '220524',
+ 'abilityTreeNodes' => ['FEATUREopensearch1AJKH0'],
+ ],
+ 'parameters' => [
+ [
+ 'name' => 'token',
+ 'in' => 'path',
+ 'schema' => ['description' => 'The access credential token.', 'type' => 'string', 'required' => true, 'example' => 'OS-********', 'title' => ''],
+ ],
+ [
+ 'name' => 'workspaceName',
+ 'in' => 'path',
+ 'schema' => ['description' => 'The workspace name.', 'type' => 'string', 'required' => true, 'example' => 'myWorkspace', 'title' => ''],
+ ],
+ ],
+ 'responses' => [
+ 200 => [
+ 'schema' => [
+ 'title' => '',
+ 'description' => 'Schema of Response',
+ 'type' => 'object',
+ 'properties' => [
+ 'requestId' => ['title' => '', 'description' => 'Id of the request', 'type' => 'string', 'example' => 'B7C901ED-2BC1-5CFB-BE23-242DE5E3BA5C'],
+ 'result' => [
+ 'description' => 'The query result.',
+ 'type' => 'object',
+ 'properties' => [
+ 'appGroupId' => ['description' => 'The workspace ID.', 'type' => 'integer', 'format' => 'int64', 'example' => '111111', 'title' => ''],
+ 'type' => ['description' => 'The credential type.'."\n"
+ ."\n"
+ .'- api-token.', 'type' => 'string', 'example' => 'api-token'."\n", 'title' => ''],
+ 'enabled' => ['description' => 'Indicates whether the credential is enabled. Valid values:'."\n"
+ ."\n"
+ .'- true: Enabled.'."\n"
+ ."\n"
+ .'- false: Disabled.', 'type' => 'boolean', 'example' => 'true', 'title' => ''],
+ 'token' => ['description' => 'The access credential token.', 'type' => 'string', 'example' => 'OS-********'."\n", 'title' => ''],
+ ],
+ 'title' => '',
+ 'example' => '',
+ ],
+ ],
+ 'example' => '',
+ ],
+ ],
+ ],
+ 'staticInfo' => ['returnType' => 'synchronous'],
+ 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"requestId\\": \\"B7C901ED-2BC1-5CFB-BE23-242DE5E3BA5C\\",\\n \\"result\\": {\\n \\"appGroupId\\": 111111,\\n \\"type\\": \\"api-token\\\\n\\",\\n \\"enabled\\": true,\\n \\"token\\": \\"OS-********\\\\n\\"\\n }\\n}","type":"json"}]',
+ 'title' => 'Get access credential details',
+ 'summary' => 'Retrieves the details of an access credential.',
+ 'changeSet' => [],
+ 'ramActions' => [
+ [
+ 'operationType' => 'get',
+ 'ramAction' => [
+ 'action' => 'searchplat:DescribeCredentials',
+ 'authLevel' => 'resource',
+ 'actionConditions' => [],
+ 'resources' => [
+ ['validationType' => 'always', 'product' => 'SearchPlat', 'resourceType' => 'Credentials', 'arn' => 'acs:searchplat:{#regionId}:{#accountId}:workspaces/{#workspaceName}'],
+ ],
+ ],
+ ],
+ ],
+ ],
+ 'GetExperienceData' => [
+ 'summary' => 'Retrieves the details of experience data.',
+ 'path' => '/openapi/platform/workspaces/{workspaceName}/experience-data/{id}',
+ 'methods' => ['get'],
+ 'schemes' => ['http', 'https'],
+ 'security' => [
+ [
+ 'AK' => [],
+ ],
+ ],
+ 'operationType' => 'readAndWrite',
+ 'deprecated' => false,
+ 'systemTags' => [
+ 'operationType' => 'get',
+ 'riskType' => 'none',
+ 'chargeType' => 'free',
+ 'abilityTreeCode' => '225363',
+ 'abilityTreeNodes' => ['FEATUREopensearch1AJKH0'],
+ ],
+ 'parameters' => [
+ [
+ 'name' => 'dryRun',
+ 'in' => 'query',
+ 'schema' => ['description' => 'Specifies whether to validate the request parameters without performing the actual operation. Default value: false.'."\n"
+ ."\n"
+ .'Valid values:'."\n"
+ ."\n"
+ .'- **true**'."\n"
+ ."\n"
+ .'- **false**.', 'type' => 'boolean', 'required' => false, 'example' => 'false', 'title' => ''],
+ ],
+ [
+ 'name' => 'workspaceName',
+ 'in' => 'path',
+ 'schema' => ['description' => 'The workspace name.', 'type' => 'string', 'required' => true, 'example' => 'default', 'title' => ''],
+ ],
+ [
+ 'name' => 'id',
+ 'in' => 'path',
+ 'schema' => ['description' => 'The experience data ID.', 'type' => 'integer', 'format' => 'int64', 'required' => true, 'example' => '1878', 'title' => ''],
+ ],
+ ],
+ 'responses' => [
+ 200 => [
+ 'schema' => [
+ 'title' => '',
+ 'description' => 'Schema of Response',
+ 'type' => 'object',
+ 'properties' => [
+ 'requestId' => ['title' => '', 'description' => 'Id of the request', 'type' => 'string', 'example' => '5950143C-B8F0-5758-A08A-66F302FD587F'],
+ 'result' => [
+ 'description' => 'The returned result.',
+ 'type' => 'object',
+ 'properties' => [
+ 'id' => ['description' => 'The data ID.', 'type' => 'integer', 'format' => 'int64', 'example' => '1877', 'title' => ''],
+ 'serviceType' => ['description' => 'The service type.'."\n"
+ ."\n"
+ .'- document-analyze.', 'type' => 'string', 'example' => 'document-analyze', 'title' => ''],
+ 'dataType' => ['description' => 'The data type.'."\n"
+ ."\n"
+ .'- file'."\n"
+ .'- url.', 'type' => 'string', 'example' => 'file', 'title' => ''],
+ 'name' => ['description' => 'The data name. This parameter is required when dataType is set to file.', 'type' => 'string', 'example' => 'a.pdf', 'title' => ''],
+ 'dataValue' => ['description' => 'The data content.'."\n"
+ ."\n"
+ .'- When dataType is set to file, this field is the OSS address of the file.'."\n"
+ .'- When dataType is set to url, this field is the HTTP URL of the data.', 'type' => 'string', 'example' => 'http://xxx', 'title' => ''],
+ 'dataSize' => ['description' => 'The data size.', 'type' => 'integer', 'format' => 'int64', 'example' => '100', 'title' => ''],
+ 'created' => ['description' => 'The creation time.', 'type' => 'integer', 'format' => 'int64', 'example' => '1745806839720', 'title' => ''],
+ 'updated' => ['description' => 'The update time.', 'type' => 'integer', 'format' => 'int64', 'example' => '1729684154', 'title' => ''],
+ 'contentType' => ['description' => 'The file type.'."\n"
+ ."\n"
+ .'- pdf'."\n"
+ .'- text'."\n"
+ .'- html'."\n"
+ .'- doc.', 'type' => 'string', 'example' => 'text', 'title' => ''],
+ ],
+ 'title' => '',
+ 'example' => '',
+ ],
+ ],
+ 'example' => '',
+ ],
+ ],
+ '5XX' => [
+ 'schema' => [
+ 'type' => 'object',
+ 'properties' => [
+ 'code' => ['type' => 'string', 'description' => '', 'title' => '', 'example' => ''],
+ 'requestId' => ['type' => 'string', 'description' => '', 'title' => '', 'example' => ''],
+ 'message' => ['type' => 'string', 'description' => '', 'title' => '', 'example' => ''],
+ 'httpCode' => ['type' => 'integer', 'format' => 'int32', 'description' => '', 'title' => '', 'example' => ''],
+ ],
+ 'description' => '',
+ 'title' => '',
+ 'example' => '',
+ ],
+ ],
+ ],
+ 'staticInfo' => ['returnType' => 'synchronous'],
+ 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"requestId\\": \\"5950143C-B8F0-5758-A08A-66F302FD587F\\",\\n \\"result\\": {\\n \\"id\\": 1877,\\n \\"serviceType\\": \\"document-analyze\\",\\n \\"dataType\\": \\"file\\",\\n \\"name\\": \\"a.pdf\\",\\n \\"dataValue\\": \\"http://xxx\\",\\n \\"dataSize\\": 100,\\n \\"created\\": 1745806839720,\\n \\"updated\\": 1729684154,\\n \\"contentType\\": \\"text\\"\\n }\\n}","type":"json"}]',
+ 'title' => 'Retrieve experience data details',
+ 'changeSet' => [],
+ 'ramActions' => [
+ [
+ 'operationType' => 'get',
+ 'ramAction' => [
+ 'action' => 'searchplat:DescribeExperienceData',
+ 'authLevel' => 'resource',
+ 'actionConditions' => [],
+ 'resources' => [
+ ['validationType' => 'always', 'product' => 'SearchPlat', 'resourceType' => 'ExperienceData', 'arn' => 'acs:searchplat:{#regionId}:{#accountId}:workspaces/{#workspaceName}'],
+ ],
+ ],
+ ],
+ ],
+ ],
+ 'GetFunctionInstance' => [
+ 'summary' => 'Queries the details of a specific feature instance in a specified workspace.',
+ 'path' => '/openapi/platform/workspaces/{workspaceName}/functions/{functionName}/instances/{instanceName}',
+ 'methods' => ['get'],
+ 'schemes' => ['https'],
+ 'security' => [
+ [
+ 'AK' => [],
+ ],
+ ],
+ 'operationType' => 'read',
+ 'deprecated' => false,
+ 'systemTags' => [
+ 'operationType' => 'get',
+ 'riskType' => 'none',
+ 'chargeType' => 'free',
+ 'abilityTreeCode' => '239784',
+ 'abilityTreeNodes' => ['FEATUREopensearchJK5SO0'],
+ 'autoTest' => true,
+ 'tenantRelevance' => 'publicInformation',
+ ],
+ 'parameters' => [
+ [
+ 'name' => 'workspaceName',
+ 'in' => 'path',
+ 'schema' => ['description' => 'The workspace name.', 'type' => 'string', 'required' => false, 'example' => 'default', 'title' => ''],
+ ],
+ [
+ 'name' => 'functionName',
+ 'in' => 'path',
+ 'schema' => ['description' => 'The service type. Valid values:'."\n"
+ .'- nl2sql: NL2SQL model type.'."\n"
+ .'- embedding-tuning: Embedding tuning.'."\n"
+ .'- deployment: Custom model deployment.'."\n"
+ .'- notebook: Service development notebook.', 'type' => 'string', 'required' => false, 'example' => 'nl2sql', 'title' => ''],
+ ],
+ [
+ 'name' => 'instanceName',
+ 'in' => 'path',
+ 'schema' => ['description' => 'The configuration name, model name, custom model deployment configuration name, or notebook instance name.', 'type' => 'string', 'required' => true, 'example' => 'test', 'title' => ''],
+ ],
+ [
+ 'name' => 'output',
+ 'in' => 'query',
+ 'schema' => ['description' => 'Controls the richness of the returned information. Valid values:'."\n"
+ .'- simple: displays only basic information.'."\n"
+ .'- normal: displays information such as createParameters and cron. This is the default value.'."\n"
+ .'- detail: returns training task information.', 'type' => 'string', 'required' => false, 'example' => 'normal', 'title' => ''],
+ ],
+ ],
+ 'responses' => [
+ 200 => [
+ 'schema' => [
+ 'description' => 'The response body.',
+ 'type' => 'object',
+ 'properties' => [
+ 'code' => ['description' => 'The error code.', 'type' => 'string', 'example' => 'not found', 'title' => ''],
+ 'httpCode' => ['description' => 'The HTTP status code.', 'type' => 'integer', 'format' => 'int64', 'example' => '200', 'title' => ''],
+ 'latency' => ['description' => 'The time consumed.', 'type' => 'integer', 'format' => 'int64', 'example' => '11.627', 'title' => ''],
+ 'message' => ['description' => 'The error message.', 'type' => 'string', 'example' => '"xx not found"', 'title' => ''],
+ 'requestId' => ['description' => 'The request ID.', 'type' => 'string', 'example' => 'C56462F4-CCB3-10BF-A3D8-FEE53C72B65C', 'title' => ''],
+ 'result' => [
+ 'description' => 'The returned result.',
+ 'type' => 'object',
+ 'properties' => [
+ 'belongs' => [
+ 'description' => 'The ownership information.',
+ 'type' => 'object',
+ 'properties' => [
+ 'category' => ['description' => 'The category.', 'type' => 'string', 'example' => '""', 'title' => ''],
+ 'domain' => ['description' => 'The industry type.', 'type' => 'string', 'example' => '""', 'title' => ''],
+ 'language' => ['description' => 'The language.', 'type' => 'string', 'example' => 'zh', 'title' => ''],
+ ],
+ 'title' => '',
+ 'example' => '',
+ ],
+ 'createParameters' => [
+ 'description' => 'The specific configuration items.',
+ 'type' => 'array',
+ 'items' => [
+ 'description' => 'The creation parameter body.',
+ 'type' => 'object',
+ 'properties' => [
+ 'name' => ['description' => 'The parameter name.', 'type' => 'string', 'example' => 'name', 'title' => ''],
+ 'value' => ['description' => 'The parameter value.', 'type' => 'string', 'example' => 'value', 'title' => ''],
+ ],
+ 'title' => '',
+ 'example' => '',
+ ],
+ 'title' => '',
+ 'example' => '',
+ ],
+ 'createTime' => ['description' => 'The creation time.', 'type' => 'integer', 'format' => 'int64', 'example' => '1724998630466', 'title' => ''],
+ 'cron' => ['description' => 'The cron expression for the timed scheduling task.', 'type' => 'string', 'example' => '""', 'title' => ''],
+ 'description' => ['description' => 'The description.', 'type' => 'string', 'example' => '描述', 'title' => ''],
+ 'extendInfo' => ['description' => 'The extended information.', 'type' => 'string', 'example' => '""', 'title' => ''],
+ 'functionName' => ['description' => 'The configuration type. Valid values:'."\n"
+ .'- nl2sql'."\n"
+ .'- embedding-tuning'."\n"
+ .'- deployment'."\n"
+ .'- notebook.', 'type' => 'string', 'example' => 'nl2sql', 'title' => ''],
+ 'functionType' => ['description' => 'The configuration type. PAAS (default): requires training before use.', 'type' => 'string', 'example' => 'PAAS', 'title' => ''],
+ 'instanceName' => ['description' => 'The configuration name.', 'type' => 'string', 'example' => 'test', 'title' => ''],
+ 'modelType' => ['description' => 'The model type. The valid values vary based on the configuration type (functionName):'."\n"
+ ."\n"
+ .'- ops-query-analyze-nl2sql-001 (nl2sql)'."\n"
+ .'- ops-embedding-dim-reduction-001 (embedding-tuning)'."\n"
+ .'- native (deployment)'."\n"
+ .'- dsw (notebook).', 'type' => 'string', 'example' => 'dsw', 'title' => ''],
+ 'source' => ['description' => 'The source.', 'type' => 'string', 'example' => 'user', 'title' => ''],
+ 'status' => ['description' => 'The status. Valid values:'."\n"
+ .'- available'."\n"
+ .'- unavailable.', 'type' => 'string', 'example' => 'available', 'title' => ''],
+ 'task' => [
+ 'description' => 'The task information.',
+ 'type' => 'object',
+ 'properties' => [
+ 'dagStatus' => ['description' => 'The task status. Valid values:'."\n"
+ .'- success: Succeeded.'."\n"
+ .'- failed: Failed.'."\n"
+ .'- untrained: Pending training.'."\n"
+ .'- pending: Scheduling.'."\n"
+ .'- running: Training in progress.', 'type' => 'string', 'example' => 'success', 'title' => ''],
+ 'lastRunTime' => ['description' => 'The last training time.', 'type' => 'integer', 'format' => 'int64', 'example' => '1724998630466', 'title' => ''],
+ ],
+ 'title' => '',
+ 'example' => '',
+ ],
+ 'versionId' => ['description' => 'The training version ID.', 'type' => 'integer', 'format' => 'int64', 'example' => '21', 'title' => ''],
+ ],
+ 'title' => '',
+ 'example' => '',
+ ],
+ 'status' => ['description' => 'The request status.', 'type' => 'string', 'example' => 'OK', 'title' => ''],
+ ],
+ 'title' => '',
+ 'example' => '',
+ ],
+ ],
+ ],
+ 'staticInfo' => ['returnType' => 'synchronous'],
+ 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"code\\": \\"not found\\",\\n \\"httpCode\\": 200,\\n \\"latency\\": 11.627,\\n \\"message\\": \\"\\\\\\"xx not found\\\\\\"\\",\\n \\"requestId\\": \\"C56462F4-CCB3-10BF-A3D8-FEE53C72B65C\\",\\n \\"result\\": {\\n \\"belongs\\": {\\n \\"category\\": \\"\\\\\\"\\\\\\"\\",\\n \\"domain\\": \\"\\\\\\"\\\\\\"\\",\\n \\"language\\": \\"zh\\"\\n },\\n \\"createParameters\\": [\\n {\\n \\"name\\": \\"name\\",\\n \\"value\\": \\"value\\"\\n }\\n ],\\n \\"createTime\\": 1724998630466,\\n \\"cron\\": \\"\\\\\\"\\\\\\"\\",\\n \\"description\\": \\"描述\\",\\n \\"extendInfo\\": \\"\\\\\\"\\\\\\"\\",\\n \\"functionName\\": \\"nl2sql\\",\\n \\"functionType\\": \\"PAAS\\",\\n \\"instanceName\\": \\"test\\",\\n \\"modelType\\": \\"dsw\\",\\n \\"source\\": \\"user\\",\\n \\"status\\": \\"available\\",\\n \\"task\\": {\\n \\"dagStatus\\": \\"success\\",\\n \\"lastRunTime\\": 1724998630466\\n },\\n \\"versionId\\": 21\\n },\\n \\"status\\": \\"OK\\"\\n}","type":"json"}]',
+ 'title' => 'Get service or model configuration details',
+ 'changeSet' => [],
+ 'ramActions' => [
+ [
+ 'operationType' => 'get',
+ 'ramAction' => [
+ 'action' => 'searchplat:DescribeFunction',
+ 'authLevel' => 'resource',
+ 'actionConditions' => [],
+ 'resources' => [
+ ['validationType' => 'always', 'product' => 'SearchPlat', 'resourceType' => 'FunctionInstance', 'arn' => 'acs:searchplat:{#regionId}:{#accountId}:workspaces/{#workspaceName}'],
+ ],
+ ],
+ ],
+ ],
+ ],
+ 'GetOfflineTask' => [
+ 'summary' => 'Retrieves information about an offline node.',
+ 'path' => '/openapi/platform/workspaces/{workspaceName}/offline-tasks/{type}/{taskName}',
+ 'methods' => ['get'],
+ 'schemes' => ['https'],
+ 'security' => [
+ [
+ 'AK' => [],
+ ],
+ ],
+ 'consumes' => ['application/json'],
+ 'produces' => ['application/json'],
+ 'operationType' => 'read',
+ 'deprecated' => false,
+ 'systemTags' => [
+ 'operationType' => 'get',
+ 'riskType' => 'none',
+ 'chargeType' => 'free',
+ 'abilityTreeNodes' => ['FEATUREopensearch8B42ZS'],
+ 'tenantRelevance' => 'tenant',
+ ],
+ 'parameters' => [
+ [
+ 'name' => 'workspaceName',
+ 'in' => 'path',
+ 'schema' => ['description' => 'The workspace name.', 'type' => 'string', 'required' => false, 'example' => 'default', 'title' => ''],
+ ],
+ [
+ 'name' => 'type',
+ 'in' => 'path',
+ 'schema' => ['description' => 'The type.', 'type' => 'string', 'required' => false, 'example' => 'video', 'title' => ''],
+ ],
+ [
+ 'name' => 'taskName',
+ 'in' => 'path',
+ 'schema' => ['description' => 'The node name.', 'type' => 'string', 'required' => false, 'example' => 'taskName', 'title' => ''],
+ ],
+ [
+ 'name' => 'regionId',
+ 'in' => 'query',
+ 'schema' => ['title' => '', 'description' => 'The region ID.', 'type' => 'string', 'example' => 'cn-shanghai', 'required' => false],
+ ],
+ ],
+ 'responses' => [
+ 200 => [
+ 'schema' => [
+ 'title' => '',
+ 'description' => 'Schema of Response',
+ 'type' => 'object',
+ 'properties' => [
+ 'requestId' => ['title' => '', 'description' => 'Id of the request', 'type' => 'string', 'example' => '5950143C-B8F0-5758-A08A-66F302FD587F'],
+ 'result' => [
+ 'description' => 'The returned result.',
+ 'type' => 'object',
+ 'properties' => [
+ 'meta' => [
+ 'description' => 'The node metadata.',
+ 'type' => 'object',
+ 'properties' => [
+ 'computeResource' => ['description' => 'The billing specification.', 'type' => 'string', 'example' => 'small', 'title' => ''],
+ 'taskName' => ['description' => 'The node name.', 'type' => 'string', 'example' => 'test', 'title' => ''],
+ ],
+ 'title' => '',
+ 'example' => '',
+ ],
+ 'parameters' => ['description' => 'The node processing parameters.', 'type' => 'object', 'example' => '{'."\n"
+ .' "parameter1": {'."\n"
+ .' "key": "value"'."\n"
+ .' },'."\n"
+ .' "parameter2": {'."\n"
+ .' "key": "value"'."\n"
+ .' }'."\n"
+ .'}', 'title' => ''],
+ 'processors' => [
+ 'description' => 'The processing flow operators.',
+ 'type' => 'array',
+ 'items' => [
+ 'description' => 'The processing flow operators.',
+ 'type' => 'object',
+ 'properties' => [
+ 'input' => ['description' => 'The input parameters.', 'type' => 'object', 'example' => '{'."\n"
+ .' "key": "content"'."\n"
+ .'}'."\n", 'title' => ''],
+ 'name' => ['description' => 'The name.', 'type' => 'string', 'example' => 'processor1', 'title' => ''],
+ 'parameters' => ['description' => 'The processor processing parameters.', 'type' => 'object', 'example' => '{'."\n"
+ .' "service_id": "xxx"'."\n"
+ .'}', 'title' => ''],
+ 'type' => ['description' => 'The type.', 'type' => 'string', 'example' => 'document-analyze'."\n", 'title' => ''],
+ ],
+ 'title' => '',
+ 'example' => '',
+ ],
+ 'title' => '',
+ 'example' => '',
+ ],
+ 'sink' => [
+ 'description' => 'The data sink information.',
+ 'type' => 'array',
+ 'items' => [
+ 'description' => 'The data sink information.',
+ 'type' => 'object',
+ 'properties' => [
+ 'name' => ['description' => 'The data sink name.', 'type' => 'string', 'example' => 'table2', 'title' => ''],
+ 'parameters' => [
+ 'description' => 'The data sink configuration parameters, which are determined by the type.',
+ 'type' => 'object',
+ 'additionalProperties' => ['description' => 'key为String类型', 'type' => 'string', 'example' => '{'."\n"
+ .' "key1": "value1",'."\n"
+ .' "key2": "value2"'."\n"
+ .'}', 'title' => ''],
+ 'title' => '',
+ 'example' => '',
+ ],
+ 'primaryKey' => ['description' => 'The primary key field of the data sink.', 'type' => 'string', 'example' => 'id', 'title' => ''],
+ 'schema' => [
+ 'description' => 'The data sink schema.',
+ 'type' => 'array',
+ 'items' => [
+ 'description' => 'Schema',
+ 'type' => 'object',
+ 'additionalProperties' => ['description' => 'key为String类型', 'type' => 'string', 'example' => '{'."\n"
+ .' "name": "id",'."\n"
+ .' "type": "string",'."\n"
+ .' "source": "table1.id"'."\n"
+ .'}'."\n", 'title' => ''],
+ 'title' => '',
+ 'example' => '',
+ ],
+ 'title' => '',
+ 'example' => '',
+ ],
+ 'type' => ['description' => 'The data sink type.', 'type' => 'string', 'example' => 'swift', 'title' => ''],
+ ],
+ 'title' => '',
+ 'example' => '',
+ ],
+ 'title' => '',
+ 'example' => '',
+ ],
+ 'source' => [
+ 'description' => 'The data source information.',
+ 'type' => 'array',
+ 'items' => [
+ 'type' => 'object',
+ 'properties' => [
+ 'name' => ['description' => 'The data source name.', 'type' => 'string', 'example' => 'table1'."\n", 'title' => ''],
+ 'parameters' => [
+ 'description' => 'The datasource config parameters, which are determined by the type.',
+ 'type' => 'object',
+ 'additionalProperties' => ['description' => 'key为String类型', 'type' => 'string', 'example' => '{'."\n"
+ .' "key1": "value1",'."\n"
+ .' "key2": "value2"'."\n"
+ .'}', 'title' => ''],
+ 'title' => '',
+ 'example' => '',
+ ],
+ 'primaryKey' => ['description' => 'The primary key field of the data source.', 'type' => 'string', 'example' => 'id', 'title' => ''],
+ 'schema' => [
+ 'description' => 'The data source schema.',
+ 'type' => 'array',
+ 'items' => [
+ 'type' => 'object',
+ 'additionalProperties' => ['description' => 'key为String类型', 'type' => 'string', 'example' => ' {'."\n"
+ .' "name": "id",'."\n"
+ .' "type": "string"'."\n"
+ .'}', 'title' => ''],
+ 'description' => '',
+ 'title' => '',
+ 'example' => '',
+ ],
+ 'title' => '',
+ 'example' => '',
+ ],
+ 'type' => ['description' => 'The data source type.', 'type' => 'string', 'example' => 'swift', 'title' => ''],
+ ],
+ 'description' => '',
+ 'title' => '',
+ 'example' => '',
+ ],
+ 'title' => '',
+ 'example' => '',
+ ],
+ 'status' => [
+ 'description' => 'The node status.',
+ 'type' => 'object',
+ 'properties' => [
+ 'createTime' => ['description' => 'The time when the node was started.', 'type' => 'integer', 'format' => 'int64', 'example' => '1744941600000', 'title' => ''],
+ 'deleteTime' => ['description' => 'The time when the node was stopped.', 'type' => 'integer', 'format' => 'int64', 'example' => '1744941600000', 'title' => ''],
+ 'errorMessage' => ['description' => 'The error message.', 'type' => 'string', 'example' => '“”', 'title' => ''],
+ 'status' => ['description' => 'The node status.', 'type' => 'string', 'example' => 'RUNNING', 'title' => ''],
+ ],
+ 'title' => '',
+ 'example' => '',
+ ],
+ ],
+ 'title' => '',
+ 'example' => '',
+ ],
+ ],
+ 'example' => '',
+ ],
+ ],
+ ],
+ 'staticInfo' => ['returnType' => 'synchronous'],
+ 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"requestId\\": \\"5950143C-B8F0-5758-A08A-66F302FD587F\\",\\n \\"result\\": {\\n \\"meta\\": {\\n \\"computeResource\\": \\"small\\",\\n \\"taskName\\": \\"test\\"\\n },\\n \\"parameters\\": {\\n \\"parameter1\\": {\\n \\"key\\": \\"value\\"\\n },\\n \\"parameter2\\": {\\n \\"key\\": \\"value\\"\\n }\\n },\\n \\"processors\\": [\\n {\\n \\"input\\": {\\n \\"key\\": \\"content\\"\\n },\\n \\"name\\": \\"processor1\\",\\n \\"parameters\\": {\\n \\"service_id\\": \\"xxx\\"\\n },\\n \\"type\\": \\"document-analyze\\\\n\\"\\n }\\n ],\\n \\"sink\\": [\\n {\\n \\"name\\": \\"table2\\",\\n \\"parameters\\": {\\n \\"key\\": \\"{\\\\n \\\\\\"key1\\\\\\": \\\\\\"value1\\\\\\",\\\\n \\\\\\"key2\\\\\\": \\\\\\"value2\\\\\\"\\\\n}\\"\\n },\\n \\"primaryKey\\": \\"id\\",\\n \\"schema\\": [\\n {\\n \\"key\\": \\"{\\\\n \\\\\\"name\\\\\\": \\\\\\"id\\\\\\",\\\\n \\\\\\"type\\\\\\": \\\\\\"string\\\\\\",\\\\n \\\\\\"source\\\\\\": \\\\\\"table1.id\\\\\\"\\\\n}\\\\n\\"\\n }\\n ],\\n \\"type\\": \\"swift\\"\\n }\\n ],\\n \\"source\\": [\\n {\\n \\"name\\": \\"table1\\\\n\\",\\n \\"parameters\\": {\\n \\"key\\": \\"{\\\\n \\\\\\"key1\\\\\\": \\\\\\"value1\\\\\\",\\\\n \\\\\\"key2\\\\\\": \\\\\\"value2\\\\\\"\\\\n}\\"\\n },\\n \\"primaryKey\\": \\"id\\",\\n \\"schema\\": [\\n {\\n \\"key\\": \\" {\\\\n \\\\\\"name\\\\\\": \\\\\\"id\\\\\\",\\\\n \\\\\\"type\\\\\\": \\\\\\"string\\\\\\"\\\\n}\\"\\n }\\n ],\\n \\"type\\": \\"swift\\"\\n }\\n ],\\n \\"status\\": {\\n \\"createTime\\": 1744941600000,\\n \\"deleteTime\\": 1744941600000,\\n \\"errorMessage\\": \\"“”\\",\\n \\"status\\": \\"RUNNING\\"\\n }\\n }\\n}","type":"json"}]',
+ 'title' => 'Retrieve offline node information',
+ 'changeSet' => [
+ ['createdAt' => '2025-12-02T07:12:30.000Z', 'description' => 'Request parameters changed'],
+ ],
+ 'ramActions' => [
+ [
+ 'operationType' => 'get',
+ 'ramAction' => [
+ 'action' => 'searchplat:GetOfflineTask',
+ 'authLevel' => 'operate',
+ 'actionConditions' => [],
+ 'resources' => [
+ ['validationType' => 'always', 'product' => 'SearchPlat', 'resourceType' => 'All Resource', 'arn' => '*'],
+ ],
+ ],
+ ],
+ ],
+ ],
+ 'GetRagEvaluatorTask' => [
+ 'summary' => 'Retrieves a RAG evaluation task.',
+ 'path' => '/openapi/platform/workspaces/{workspaceName}/rag-evaluator/v1/api/task/{task_id}',
+ 'methods' => ['get'],
+ 'schemes' => ['http', 'https'],
+ 'security' => [
+ [
+ 'AK' => [],
+ ],
+ ],
+ 'consumes' => ['application/json'],
+ 'produces' => ['application/json'],
+ 'operationType' => 'read',
+ 'deprecated' => false,
+ 'systemTags' => [
+ 'operationType' => 'get',
+ 'riskType' => 'none',
+ 'chargeType' => 'free',
+ 'abilityTreeCode' => '228521',
+ 'abilityTreeNodes' => ['FEATUREopensearchWAC9DF'],
+ ],
+ 'parameters' => [
+ [
+ 'name' => 'workspaceName',
+ 'in' => 'path',
+ 'schema' => ['description' => 'The workspace name.', 'type' => 'string', 'required' => false, 'example' => 'default', 'title' => ''],
+ ],
+ [
+ 'name' => 'task_id',
+ 'in' => 'path',
+ 'schema' => ['description' => 'The task ID.', 'type' => 'string', 'required' => false, 'example' => 'de591cbcea6745e0b846ed051c5c3462', 'title' => ''],
+ ],
+ ],
+ 'responses' => [
+ 200 => [
+ 'schema' => [
+ 'title' => '',
+ 'description' => 'Schema of Response',
+ 'type' => 'object',
+ 'properties' => [
+ 'requestId' => ['title' => '', 'description' => 'Id of the request', 'type' => 'string', 'example' => '1CC93E65-6734-5060-BEF7-0EB0A4862BCF'],
+ 'code' => ['description' => 'The status code.', 'type' => 'string', 'example' => 'not found', 'title' => ''],
+ 'message' => ['description' => 'The error message.', 'type' => 'string', 'example' => '"xx not found"', 'title' => ''],
+ 'result' => ['description' => 'The response result.', 'type' => 'object', 'example' => '{'."\n"
+ .' "odps_task_id": 224525243, '."\n"
+ .' "usage" : {'."\n"
+ .' "cu" : 0.000'."\n"
+ .' }', 'title' => ''],
+ ],
+ 'example' => '',
+ ],
+ ],
+ ],
+ 'staticInfo' => ['returnType' => 'synchronous'],
+ 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"requestId\\": \\"1CC93E65-6734-5060-BEF7-0EB0A4862BCF\\",\\n \\"code\\": \\"not found\\",\\n \\"message\\": \\"\\\\\\"xx not found\\\\\\"\\",\\n \\"result\\": {\\n \\"test\\": \\"test\\",\\n \\"test2\\": 1\\n }\\n}","type":"json"}]',
+ 'title' => 'Retrieve a RAG evaluation task',
+ 'changeSet' => [],
+ 'ramActions' => [
+ [
+ 'operationType' => 'get',
+ 'ramAction' => [
+ 'action' => 'searchplat:DescribeEvaluation',
+ 'authLevel' => 'operate',
+ 'actionConditions' => [],
+ 'resources' => [
+ ['validationType' => 'always', 'product' => 'SearchPlat', 'resourceType' => 'All Resource', 'arn' => '*'],
+ ],
+ ],
+ ],
+ ],
+ ],
+ 'GetTableColumns' => [
+ 'summary' => 'Retrieves data table field information.',
+ 'path' => '/openapi/platform/workspaces/{workspaceName}/data-sources/{dataSourceType}/columns',
+ 'methods' => ['get'],
+ 'schemes' => ['https'],
+ 'security' => [
+ [
+ 'AK' => [],
+ ],
+ ],
+ 'consumes' => ['application/json'],
+ 'produces' => ['application/json'],
+ 'operationType' => 'read',
+ 'deprecated' => false,
+ 'systemTags' => [
+ 'operationType' => 'get',
+ 'riskType' => 'none',
+ 'chargeType' => 'free',
+ 'abilityTreeCode' => '241066',
+ 'abilityTreeNodes' => ['FEATUREopensearchJK5SO0'],
+ 'autoTest' => true,
+ 'tenantRelevance' => 'tenant',
+ ],
+ 'parameters' => [
+ [
+ 'name' => 'workspaceName',
+ 'in' => 'path',
+ 'schema' => ['description' => 'The workspace name.', 'type' => 'string', 'required' => true, 'example' => 'default', 'title' => ''],
+ ],
+ [
+ 'name' => 'dataSourceType',
+ 'in' => 'path',
+ 'schema' => ['description' => 'The data source type. Valid values:'."\n"
+ ."\n"
+ .'- rds'."\n"
+ .'- odps.', 'type' => 'string', 'required' => true, 'docRequired' => true, 'example' => 'rds', 'title' => ''],
+ ],
+ [
+ 'name' => 'params',
+ 'in' => 'query',
+ 'schema' => ['description' => 'The configuration parameters for accessing the data source.', 'type' => 'string', 'required' => true, 'docRequired' => true, 'example' => 'rds:'."\n"
+ .'{'."\n"
+ .' "instanceId": "instance_id",'."\n"
+ .' "dbName": "db_name",'."\n"
+ .' "dbUser": "db_user",'."\n"
+ .' "dbPassword": "passwoed"'."\n"
+ .'}'."\n"
+ .'odps:'."\n"
+ .'{'."\n"
+ .' "accessKeySecret": "sk",'."\n"
+ .' "accessKey": "ak",'."\n"
+ .' "projectName": "test_name"'."\n"
+ .'}', 'title' => ''],
+ ],
+ [
+ 'name' => 'regionId',
+ 'in' => 'query',
+ 'schema' => ['title' => '', 'description' => 'The region ID.', 'type' => 'string', 'example' => 'cn-shanghai', 'required' => false],
+ ],
+ ],
+ 'responses' => [
+ 200 => [
+ 'schema' => [
+ 'title' => '',
+ 'description' => 'Schema of Response',
+ 'type' => 'object',
+ 'properties' => [
+ 'result' => [
+ 'description' => 'The returned result.',
+ 'type' => 'array',
+ 'items' => [
+ 'description' => 'The returned result.',
+ 'type' => 'object',
+ 'properties' => [
+ 'name' => ['description' => 'The field name.', 'type' => 'string', 'example' => 'id', 'title' => ''],
+ 'type' => ['description' => 'The field type.', 'type' => 'string', 'example' => 'BIGINT', 'title' => ''],
+ 'comment' => ['description' => 'The field description.', 'type' => 'string', 'example' => '主键字段', 'title' => ''],
+ 'primary' => ['description' => 'Indicates whether the field is a primary key.', 'type' => 'boolean', 'example' => 'true', 'title' => ''],
+ ],
+ 'title' => '',
+ 'example' => '',
+ ],
+ 'title' => '',
+ 'example' => '',
+ ],
+ 'requestId' => ['description' => 'The request ID.', 'type' => 'string', 'example' => '1CC93E65-6734-5060-BEF7-0EB0A4862BCF', 'title' => ''],
+ ],
+ 'example' => '',
+ ],
+ ],
+ '5XX' => [
+ 'schema' => [
+ 'type' => 'object',
+ 'properties' => [
+ 'code' => ['type' => 'string', 'description' => '', 'title' => '', 'example' => ''],
+ 'message' => ['type' => 'string', 'description' => '', 'title' => '', 'example' => ''],
+ 'requestId' => ['type' => 'string', 'description' => '', 'title' => '', 'example' => ''],
+ 'httpCode' => ['type' => 'integer', 'format' => 'int32', 'description' => '', 'title' => '', 'example' => ''],
+ ],
+ 'description' => '',
+ 'title' => '',
+ 'example' => '',
+ ],
+ ],
+ ],
+ 'staticInfo' => ['returnType' => 'synchronous'],
+ 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"result\\": [\\n {\\n \\"name\\": \\"id\\",\\n \\"type\\": \\"BIGINT\\",\\n \\"comment\\": \\"主键字段\\",\\n \\"primary\\": true\\n }\\n ],\\n \\"requestId\\": \\"1CC93E65-6734-5060-BEF7-0EB0A4862BCF\\"\\n}","type":"json"}]',
+ 'title' => 'Retrieve data table field information',
+ 'changeSet' => [
+ ['createdAt' => '2025-12-02T07:12:30.000Z', 'description' => 'Request parameters changed'],
+ ],
+ 'ramActions' => [
+ [
+ 'operationType' => 'get',
+ 'ramAction' => [
+ 'action' => 'searchplat:GetTableColumns',
+ 'authLevel' => 'operate',
+ 'actionConditions' => [],
+ 'resources' => [
+ ['validationType' => 'always', 'product' => 'SearchPlat', 'resourceType' => 'All Resource', 'arn' => '*'],
+ ],
+ ],
+ ],
+ ],
+ ],
+ 'GetTableFields' => [
+ 'path' => '/openapi/platform/workspaces/{workspaceName}/data-sources/{dataSourceType}/fields',
+ 'methods' => ['get'],
+ 'schemes' => ['https'],
+ 'security' => [
+ [
+ 'AK' => [],
+ ],
+ ],
+ 'operationType' => 'read',
+ 'deprecated' => false,
+ 'systemTags' => [
+ 'operationType' => 'get',
+ 'abilityTreeCode' => '241066',
+ 'abilityTreeNodes' => ['FEATUREopensearchJK5SO0'],
+ 'autoTest' => false,
+ 'notSupportAutoTestReason' => '无法关联资源',
+ 'tenantRelevance' => 'publicInformation',
+ ],
+ 'parameters' => [
+ [
+ 'name' => 'workspaceName',
+ 'in' => 'path',
+ 'schema' => ['description' => 'The workspace name.', 'type' => 'string', 'required' => true, 'example' => 'default', 'title' => ''],
+ ],
+ [
+ 'name' => 'dataSourceType',
+ 'in' => 'path',
+ 'schema' => ['description' => 'The data source type. Valid values:'."\n"
+ .'- odps.', 'type' => 'string', 'required' => true, 'docRequired' => true, 'example' => 'odps', 'title' => ''],
+ ],
+ [
+ 'name' => 'params',
+ 'in' => 'query',
+ 'schema' => ['description' => 'The data source parameters.', 'type' => 'string', 'required' => true, 'docRequired' => true, 'example' => '{'."\n"
+ .'"accessKeySecret": "sk",'."\n"
+ .'"accessKey": "ak",'."\n"
+ .'"projectName": "test_name",'."\n"
+ .'"tableName": "test_table",'."\n"
+ .'"partition": "20240904"'."\n"
+ .'}', 'title' => ''],
+ ],
+ [
+ 'name' => 'rawType',
+ 'in' => 'query',
+ 'schema' => ['description' => 'Specifies whether to return the original field types of the data source.', 'type' => 'boolean', 'required' => false, 'example' => 'false', 'title' => ''],
+ ],
+ [
+ 'name' => 'regionId',
+ 'in' => 'query',
+ 'schema' => ['description' => 'The region ID.', 'type' => 'string', 'required' => false, 'example' => 'cn-shanghai', 'title' => ''],
+ ],
+ ],
+ 'responses' => [
+ 200 => [
+ 'schema' => [
+ 'type' => 'object',
+ 'properties' => [
+ 'result' => ['description' => 'The returned result.', 'type' => 'object', 'example' => '{'."\n"
+ .' "classic": "VARCHAR",'."\n"
+ .' "address": "CHAR",'."\n"
+ .' "string": "STRING",'."\n"
+ .' "price": "DECIMAL",'."\n"
+ .' "name": "STRING",'."\n"
+ .' "id": "INT",'."\n"
+ .' "tint": "TINYINT",'."\n"
+ .' "home": "DECIMAL"'."\n"
+ .' }', 'title' => ''],
+ 'requestId' => ['description' => 'The request ID.', 'type' => 'string', 'example' => '58113A95-1858-5674-87E5-192AEE6FD9DD', 'title' => ''],
+ ],
+ 'description' => '',
+ 'title' => '',
+ 'example' => '',
+ ],
+ ],
+ '5XX' => [
+ 'schema' => [
+ 'type' => 'object',
+ 'properties' => [
+ 'code' => ['type' => 'string', 'description' => '', 'title' => '', 'example' => ''],
+ 'message' => ['type' => 'string', 'description' => '', 'title' => '', 'example' => ''],
+ 'requestId' => ['type' => 'string', 'description' => '', 'title' => '', 'example' => ''],
+ 'httpCode' => ['type' => 'integer', 'format' => 'int32', 'description' => '', 'title' => '', 'example' => ''],
+ ],
+ 'description' => '',
+ 'title' => '',
+ 'example' => '',
+ ],
+ ],
+ ],
+ 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"result\\": {\\n \\"classic\\": \\"VARCHAR\\",\\n \\"address\\": \\"CHAR\\",\\n \\"string\\": \\"STRING\\",\\n \\"price\\": \\"DECIMAL\\",\\n \\"name\\": \\"STRING\\",\\n \\"id\\": \\"INT\\",\\n \\"tint\\": \\"TINYINT\\",\\n \\"home\\": \\"DECIMAL\\"\\n },\\n \\"requestId\\": \\"58113A95-1858-5674-87E5-192AEE6FD9DD\\"\\n}","type":"json"}]',
+ 'title' => 'Retrieve data table fields',
+ 'changeSet' => [],
+ 'ramActions' => [
+ [
+ 'operationType' => 'get',
+ 'ramAction' => [
+ 'action' => 'searchplat:GetTableFields',
+ 'authLevel' => 'resource',
+ 'actionConditions' => [],
+ 'resources' => [
+ ['validationType' => 'always', 'product' => 'SearchPlat', 'resourceType' => 'All Resource', 'arn' => '*'],
+ ],
+ ],
+ ],
+ ],
+ 'summary' => '',
+ ],
+ 'GetTables' => [
+ 'summary' => 'Retrieves data tables.',
+ 'path' => '/openapi/platform/workspaces/{workspaceName}/data-sources/{dataSourceType}/tables',
+ 'methods' => ['get'],
+ 'schemes' => ['https'],
+ 'security' => [
+ [
+ 'AK' => [],
+ ],
+ ],
+ 'consumes' => ['application/json'],
+ 'produces' => ['application/json'],
+ 'operationType' => 'read',
+ 'deprecated' => false,
+ 'systemTags' => [
+ 'operationType' => 'get',
+ 'riskType' => 'none',
+ 'chargeType' => 'free',
+ 'abilityTreeCode' => '241066',
+ 'abilityTreeNodes' => ['FEATUREopensearchJK5SO0'],
+ 'autoTest' => true,
+ 'tenantRelevance' => 'tenant',
+ ],
+ 'parameters' => [
+ [
+ 'name' => 'workspaceName',
+ 'in' => 'path',
+ 'schema' => ['description' => 'The workspace name.', 'type' => 'string', 'required' => true, 'example' => 'default', 'title' => ''],
+ ],
+ [
+ 'name' => 'dataSourceType',
+ 'in' => 'path',
+ 'schema' => ['description' => 'The data source type. Valid values:'."\n"
+ ."\n"
+ .'- rds'."\n"
+ .'- odps.', 'type' => 'string', 'required' => true, 'docRequired' => true, 'example' => 'rds', 'title' => ''],
+ ],
+ [
+ 'name' => 'params',
+ 'in' => 'query',
+ 'schema' => ['description' => 'The data source parameters.', 'type' => 'string', 'required' => true, 'docRequired' => true, 'example' => '{'."\n"
+ .' "instanceId": "instance_id",'."\n"
+ .' "dbName": "db_name",'."\n"
+ .' "dbUser": "db_user",'."\n"
+ .' "dbPassword": "passwoed"'."\n"
+ .'}'."\n", 'title' => ''],
+ ],
+ [
+ 'name' => 'regionId',
+ 'in' => 'query',
+ 'schema' => ['title' => '', 'description' => 'The region ID.', 'type' => 'string', 'example' => 'cn-shanghai', 'required' => false],
+ ],
+ ],
+ 'responses' => [
+ 200 => [
+ 'schema' => [
+ 'type' => 'object',
+ 'properties' => [
+ 'result' => [
+ 'description' => 'The returned result.',
+ 'type' => 'array',
+ 'items' => ['description' => 'The table name.', 'type' => 'string', 'example' => 'main', 'title' => ''],
+ 'title' => '',
+ 'example' => '',
+ ],
+ 'requestId' => ['description' => 'The request ID.', 'type' => 'string', 'example' => '33E4F0CA-F766-5803-B11C-70DC57A5A6E4', 'title' => ''],
+ ],
+ 'description' => '',
+ 'title' => '',
+ 'example' => '',
+ ],
+ ],
+ '5XX' => [
+ 'schema' => [
+ 'type' => 'object',
+ 'properties' => [
+ 'code' => ['type' => 'string', 'description' => '', 'title' => '', 'example' => ''],
+ 'message' => ['type' => 'string', 'description' => '', 'title' => '', 'example' => ''],
+ 'requestId' => ['type' => 'string', 'description' => '', 'title' => '', 'example' => ''],
+ 'httpCode' => ['type' => 'integer', 'format' => 'int32', 'description' => '', 'title' => '', 'example' => ''],
+ ],
+ 'description' => '',
+ 'title' => '',
+ 'example' => '',
+ ],
+ ],
+ ],
+ 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"result\\": [\\n \\"main\\"\\n ],\\n \\"requestId\\": \\"33E4F0CA-F766-5803-B11C-70DC57A5A6E4\\"\\n}","type":"json"}]',
+ 'title' => 'Retrieve data tables',
+ 'changeSet' => [
+ ['createdAt' => '2025-12-02T07:12:30.000Z', 'description' => 'Request parameters changed'],
+ ],
+ 'ramActions' => [
+ [
+ 'operationType' => 'get',
+ 'ramAction' => [
+ 'action' => 'searchplat:GetTables',
+ 'authLevel' => 'operate',
+ 'actionConditions' => [],
+ 'resources' => [
+ ['validationType' => 'always', 'product' => 'SearchPlat', 'resourceType' => 'All Resource', 'arn' => '*'],
+ ],
+ ],
+ ],
+ ],
+ ],
+ 'GetWorkspace' => [
+ 'summary' => 'Retrieves a workspace.',
+ 'path' => '/openapi/platform/workspaces/{workspaceName}',
+ 'methods' => ['get'],
+ 'schemes' => ['http', 'https'],
+ 'security' => [
+ [
+ 'AK' => [],
+ ],
+ ],
+ 'operationType' => 'read',
+ 'deprecated' => false,
+ 'systemTags' => [
+ 'operationType' => 'none',
+ 'riskType' => 'none',
+ 'chargeType' => 'free',
+ 'abilityTreeCode' => '218193',
+ 'abilityTreeNodes' => ['FEATUREopensearchGVH0IN'],
+ ],
+ 'parameters' => [
+ [
+ 'name' => 'workspaceName',
+ 'in' => 'path',
+ 'schema' => ['title' => '', 'description' => 'The workspace name.', 'type' => 'string', 'required' => true, 'example' => 'default'],
+ ],
+ ],
+ 'responses' => [
+ 200 => [
+ 'schema' => [
+ 'title' => '',
+ 'description' => 'Schema of Response',
+ 'type' => 'object',
+ 'properties' => [
+ 'requestId' => ['title' => '', 'description' => 'Id of the request', 'type' => 'string', 'example' => '58113A95-1858-5674-87E5-192AEE6FD9DD'],
+ 'result' => [
+ 'description' => 'The returned result.',
+ 'type' => 'object',
+ 'properties' => [
+ 'apiToken' => ['description' => 'apiToken', 'type' => 'string', 'example' => 'apiToken', 'title' => ''],
+ 'chargeType' => ['description' => 'The billing type. Valid values:'."\n"
+ .'- POSTPAY: pay-as-you-go.', 'type' => 'string', 'example' => 'POSTPAY', 'title' => ''],
+ 'commodityCode' => ['description' => 'The commodity code.', 'type' => 'string', 'example' => 'commodityCode', 'title' => ''],
+ 'description' => ['description' => 'The description.', 'type' => 'string', 'example' => '描述', 'title' => ''],
+ 'domainName' => ['description' => 'The custom domain name prefix.', 'type' => 'string', 'example' => 'default-xxx', 'title' => ''],
+ 'engineType' => ['description' => 'The engine type.', 'type' => 'string', 'example' => 'rag', 'title' => ''],
+ 'id' => ['description' => 'The workspace ID.', 'type' => 'string', 'example' => '1222212', 'title' => ''],
+ 'instanceId' => ['description' => 'The instance ID.', 'type' => 'string', 'example' => 'ops-cn-em93wcq0s001', 'title' => ''],
+ 'name' => ['description' => 'The workspace name.', 'type' => 'string', 'example' => 'default', 'title' => ''],
+ 'quota' => [
+ 'description' => 'The quota.',
+ 'type' => 'object',
+ 'properties' => [
+ 'computeResource' => ['description' => 'The compute resource.', 'type' => 'integer', 'format' => 'int32', 'example' => '0', 'title' => ''],
+ 'docSize' => ['description' => 'The storage capacity.', 'type' => 'integer', 'format' => 'int32', 'example' => '0', 'title' => ''],
+ 'spec' => ['description' => 'The specifications.', 'type' => 'string', 'example' => 'rag.share.common', 'title' => ''],
+ ],
+ 'title' => '',
+ 'example' => '',
+ ],
+ 'resourceGroupId' => ['description' => 'The resource group ID.', 'type' => 'string', 'example' => 'rg-aekzaowqymbb4ki', 'title' => ''],
+ 'status' => ['description' => 'The status.', 'type' => 'string', 'example' => '""', 'title' => ''],
+ 'tags' => [
+ 'description' => 'The tags.',
+ 'type' => 'array',
+ 'items' => [
+ 'description' => 'The tags.',
+ 'type' => 'object',
+ 'properties' => [
+ 'tagKey' => ['description' => 'The tag key.', 'type' => 'string', 'example' => 'a', 'title' => ''],
+ 'tagValue' => ['description' => 'The tag value.', 'type' => 'string', 'example' => 'x', 'title' => ''],
+ ],
+ 'title' => '',
+ 'example' => '',
+ ],
+ 'title' => '',
+ 'example' => '',
+ ],
+ 'type' => ['description' => 'The type.', 'type' => 'string', 'example' => 'standard', 'title' => ''],
+ ],
+ 'title' => '',
+ 'example' => '',
+ ],
+ ],
+ 'example' => '',
+ ],
+ ],
+ ],
+ 'staticInfo' => ['returnType' => 'synchronous'],
+ 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"requestId\\": \\"58113A95-1858-5674-87E5-192AEE6FD9DD\\",\\n \\"result\\": {\\n \\"apiToken\\": \\"apiToken\\",\\n \\"chargeType\\": \\"POSTPAY\\",\\n \\"commodityCode\\": \\"commodityCode\\",\\n \\"description\\": \\"描述\\",\\n \\"domainName\\": \\"default-xxx\\",\\n \\"engineType\\": \\"rag\\",\\n \\"id\\": \\"1222212\\",\\n \\"instanceId\\": \\"ops-cn-em93wcq0s001\\",\\n \\"name\\": \\"default\\",\\n \\"quota\\": {\\n \\"computeResource\\": 0,\\n \\"docSize\\": 0,\\n \\"spec\\": \\"rag.share.common\\"\\n },\\n \\"resourceGroupId\\": \\"rg-aekzaowqymbb4ki\\",\\n \\"status\\": \\"\\\\\\"\\\\\\"\\",\\n \\"tags\\": [\\n {\\n \\"tagKey\\": \\"a\\",\\n \\"tagValue\\": \\"x\\"\\n }\\n ],\\n \\"type\\": \\"standard\\"\\n }\\n}","type":"json"}]',
+ 'title' => 'View workspace details',
+ 'changeSet' => [],
+ 'ramActions' => [
+ [
+ 'operationType' => 'none',
+ 'ramAction' => [
+ 'action' => 'searchplat:DescribeWorkspace',
+ 'authLevel' => 'resource',
+ 'actionConditions' => [],
+ 'resources' => [
+ ['validationType' => 'always', 'product' => 'SearchPlat', 'resourceType' => 'Workspace', 'arn' => 'acs:searchplat:{#regionId}:{#accountId}:workspaces/{#workspaceName}'],
+ ],
+ ],
+ ],
+ ],
+ ],
+ 'ListAsyncTasks' => [
+ 'summary' => 'Retrieves a list of asynchronous tasks.',
+ 'path' => '/openapi/platform/workspaces/{workspaceName}/async-tasks',
+ 'methods' => ['get'],
+ 'schemes' => ['http', 'https'],
+ 'security' => [
+ [
+ 'AK' => [],
+ ],
+ ],
+ 'operationType' => 'read',
+ 'deprecated' => false,
+ 'systemTags' => [
+ 'operationType' => 'list',
+ 'riskType' => 'none',
+ 'chargeType' => 'free',
+ 'abilityTreeCode' => '225788',
+ 'abilityTreeNodes' => ['FEATUREopensearch1AJKH0'],
+ ],
+ 'parameters' => [
+ [
+ 'name' => 'dryRun',
+ 'in' => 'query',
+ 'schema' => ['description' => 'Specifies whether to validate the request parameters without performing the actual operation. Default value: false.'."\n"
+ ."\n"
+ .'Valid values:'."\n"
+ ."\n"
+ .'- **true**'."\n"
+ ."\n"
+ .'- **false**.', 'type' => 'boolean', 'required' => false, 'example' => 'true', 'title' => ''],
+ ],
+ [
+ 'name' => 'workspaceName',
+ 'in' => 'path',
+ 'schema' => ['description' => 'The workspace name.', 'type' => 'string', 'required' => true, 'example' => 'default', 'title' => ''],
+ ],
+ [
+ 'name' => 'serviceType',
+ 'in' => 'query',
+ 'schema' => ['description' => 'The service type.'."\n"
+ ."\n"
+ .'- document-analyze.', 'type' => 'string', 'required' => false, 'example' => 'document-analyze'."\n", 'title' => ''],
+ ],
+ [
+ 'name' => 'dataId',
+ 'in' => 'query',
+ 'schema' => ['description' => 'The trial data ID.', 'type' => 'integer', 'format' => 'int32', 'required' => false, 'example' => '1231', 'title' => ''],
+ ],
+ ],
+ 'responses' => [
+ 200 => [
+ 'schema' => [
+ 'title' => '',
+ 'description' => 'Schema of Response',
+ 'type' => 'object',
+ 'properties' => [
+ 'requestId' => ['title' => '', 'description' => 'Id of the request', 'type' => 'string', 'example' => '2BA0504F-B179-586D-8210-A7C7C09A9907'],
+ 'result' => [
+ 'description' => 'The returned result.',
+ 'type' => 'array',
+ 'items' => [
+ 'description' => 'The returned result.',
+ 'type' => 'object',
+ 'properties' => [
+ 'id' => ['description' => 'The asynchronous task ID.', 'type' => 'string', 'example' => 'ae1cea6dc680b98b908a757050c406c9', 'title' => ''],
+ 'serviceType' => ['description' => 'The service type.'."\n"
+ ."\n"
+ .'- document-analyze.', 'type' => 'string', 'example' => 'document-analyze'."\n", 'title' => ''],
+ 'serviceId' => ['description' => 'The service ID.', 'type' => 'string', 'example' => 'ops-document-analyze-001', 'title' => ''],
+ 'name' => ['description' => 'The file name.', 'type' => 'string', 'example' => 'test', 'title' => ''],
+ 'dataId' => ['description' => 'The trial data ID.', 'type' => 'integer', 'format' => 'int32', 'example' => '1232', 'title' => ''],
+ 'status' => ['description' => 'The task status. Valid values:'."\n"
+ .'- PENDING: in progress.'."\n"
+ .'- SUCCESS: parsing succeeded.'."\n"
+ .'- FAILED: parsing failed.', 'type' => 'string', 'example' => 'SUCCESS', 'title' => ''],
+ 'result' => ['description' => 'The task execution result.', 'type' => 'string', 'example' => 'xxxxx', 'title' => ''],
+ 'created' => ['description' => 'The creation timestamp.', 'type' => 'integer', 'format' => 'int64', 'example' => '1745893195510', 'title' => ''],
+ 'updated' => ['description' => 'The update time.', 'type' => 'integer', 'format' => 'int64', 'example' => '1729665694', 'title' => ''],
+ ],
+ 'title' => '',
+ 'example' => '',
+ ],
+ 'title' => '',
+ 'example' => '',
+ ],
+ ],
+ 'example' => '',
+ ],
+ ],
+ ],
+ 'staticInfo' => ['returnType' => 'synchronous'],
+ 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"requestId\\": \\"2BA0504F-B179-586D-8210-A7C7C09A9907\\",\\n \\"result\\": [\\n {\\n \\"id\\": \\"ae1cea6dc680b98b908a757050c406c9\\",\\n \\"serviceType\\": \\"document-analyze\\\\n\\",\\n \\"serviceId\\": \\"ops-document-analyze-001\\",\\n \\"name\\": \\"test\\",\\n \\"dataId\\": 1232,\\n \\"status\\": \\"SUCCESS\\",\\n \\"result\\": \\"xxxxx\\",\\n \\"created\\": 1745893195510,\\n \\"updated\\": 1729665694\\n }\\n ]\\n}","type":"json"}]',
+ 'title' => 'Retrieve asynchronous task list',
+ 'changeSet' => [],
+ 'ramActions' => [
+ [
+ 'operationType' => 'list',
+ 'ramAction' => [
+ 'action' => 'searchplat:DescribeAsyncTask',
+ 'authLevel' => 'resource',
+ 'actionConditions' => [],
+ 'resources' => [
+ ['validationType' => 'always', 'product' => 'SearchPlat', 'resourceType' => 'AsyncTasks', 'arn' => 'acs:searchplat:{#regionId}:{#accountId}:workspaces/{#workspaceName}'],
+ ],
+ ],
+ ],
+ ],
+ ],
+ 'ListCapabilities' => [
+ 'summary' => 'Queries the list of configuration items of a specific category in a specified workspace.',
+ 'path' => '/openapi/platform/workspaces/{workspaceName}/capabilities/{itemCategory}/items',
+ 'methods' => ['get'],
+ 'schemes' => ['https'],
+ 'security' => [
+ [
+ 'AK' => [],
+ ],
+ ],
+ 'consumes' => ['application/json'],
+ 'produces' => ['application/json'],
+ 'operationType' => 'read',
+ 'deprecated' => false,
+ 'systemTags' => [
+ 'operationType' => 'list',
+ 'riskType' => 'none',
+ 'chargeType' => 'free',
+ 'abilityTreeNodes' => ['FEATUREopensearch8B42ZS'],
+ 'tenantRelevance' => 'tenant',
+ ],
+ 'parameters' => [
+ [
+ 'name' => 'workspaceName',
+ 'in' => 'path',
+ 'schema' => ['description' => 'The workspace name.', 'type' => 'string', 'required' => true, 'example' => 'default', 'title' => ''],
+ ],
+ [
+ 'name' => 'itemCategory',
+ 'in' => 'path',
+ 'schema' => ['description' => 'The configuration category.', 'type' => 'string', 'required' => true, 'example' => 'ai_search_agent', 'title' => ''],
+ ],
+ [
+ 'name' => 'pageNumber',
+ 'in' => 'query',
+ 'schema' => ['description' => 'The page number.', 'type' => 'string', 'required' => false, 'example' => '1', 'title' => ''],
+ ],
+ [
+ 'name' => 'pageSize',
+ 'in' => 'query',
+ 'schema' => ['description' => 'The number of entries per page.', 'type' => 'string', 'required' => false, 'example' => '10', 'title' => ''],
+ ],
+ [
+ 'name' => 'nextToken',
+ 'in' => 'query',
+ 'schema' => ['description' => 'The pagination token.', 'type' => 'string', 'required' => false, 'example' => 'tMEiGtggHs0=', 'title' => ''],
+ ],
+ [
+ 'name' => 'maxResults',
+ 'in' => 'query',
+ 'schema' => ['description' => 'The maximum number of entries per page for a paged query.', 'type' => 'integer', 'format' => 'int32', 'required' => false, 'example' => '10', 'title' => ''],
+ ],
+ ],
+ 'responses' => [
+ 200 => [
+ 'schema' => [
+ 'title' => '',
+ 'description' => 'Schema of Response',
+ 'type' => 'object',
+ 'properties' => [
+ 'requestId' => ['title' => '', 'description' => 'Id of the request', 'type' => 'string', 'example' => '5950143C-B8F0-5758-A08A-66F302FD587F'],
+ 'status' => ['description' => 'The request status.', 'type' => 'string', 'example' => 'OK', 'title' => ''],
+ 'httpCode' => ['description' => 'The HTTP status code.', 'type' => 'integer', 'format' => 'int64', 'example' => '200', 'title' => ''],
+ 'totalCount' => ['description' => 'The total number of entries.', 'type' => 'integer', 'format' => 'int64', 'example' => '4', 'title' => ''],
+ 'result' => [
+ 'description' => 'The returned result.',
+ 'type' => 'array',
+ 'items' => [
+ 'description' => 'The returned result.',
+ 'type' => 'object',
+ 'properties' => [
+ 'created' => ['description' => 'The creation time.', 'type' => 'integer', 'format' => 'int64', 'example' => '1729665694', 'title' => ''],
+ 'isDefault' => ['description' => 'Indicates whether the configuration is the default configuration.', 'type' => 'boolean', 'example' => 'false', 'title' => ''],
+ 'itemCategory' => ['description' => 'The configuration category.', 'type' => 'string', 'example' => 'ai_search_agent', 'title' => ''],
+ 'itemDesc' => ['description' => 'The configuration description.', 'type' => 'string', 'example' => '描述'."\n"
+ ."\n", 'title' => ''],
+ 'itemName' => ['description' => 'The configuration name.', 'type' => 'string', 'example' => 'es_knowledge_base', 'title' => ''],
+ 'itemValue' => ['description' => 'itemValue'."\n", 'type' => 'object', 'title' => '', 'example' => ''],
+ 'status' => ['description' => 'status'."\n", 'type' => 'string', 'example' => 'available', 'title' => ''],
+ 'updated' => ['description' => 'updated'."\n", 'type' => 'integer', 'format' => 'int64', 'example' => '1729665694', 'title' => ''],
+ ],
+ 'title' => '',
+ 'example' => '',
+ ],
+ 'title' => '',
+ 'example' => '',
+ ],
+ 'nextToken' => ['description' => 'The token for the next query.', 'type' => 'string', 'example' => 'G5FG/nXfNOQ=', 'title' => ''],
+ 'maxResults' => ['description' => 'The number of returned entries.', 'type' => 'integer', 'format' => 'int32', 'example' => '1000', 'title' => ''],
+ ],
+ 'example' => '',
+ ],
+ ],
+ ],
+ 'staticInfo' => ['returnType' => 'synchronous'],
+ 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"requestId\\": \\"5950143C-B8F0-5758-A08A-66F302FD587F\\",\\n \\"status\\": \\"OK\\",\\n \\"httpCode\\": 200,\\n \\"totalCount\\": 4,\\n \\"result\\": [\\n {\\n \\"created\\": 1729665694,\\n \\"isDefault\\": false,\\n \\"itemCategory\\": \\"ai_search_agent\\",\\n \\"itemDesc\\": \\"描述\\\\n\\\\n\\",\\n \\"itemName\\": \\"es_knowledge_base\\",\\n \\"itemValue\\": {\\n \\"test\\": \\"test\\",\\n \\"test2\\": 1\\n },\\n \\"status\\": \\"available\\",\\n \\"updated\\": 1729665694\\n }\\n ],\\n \\"nextToken\\": \\"G5FG/nXfNOQ=\\",\\n \\"maxResults\\": 1000\\n}","type":"json"}]',
+ 'title' => 'Query configuration item list',
+ 'description' => '## Operation description'."\n"
+ .'You can use this API operation to retrieve the list of configuration items based on the specified workspace name and configuration category. Paged query is supported. Use the `pageNumber` and `pageSize` parameters to control the number of results and the page number. The `nextToken` and `maxResults` parameters are also provided for paged query when handling large amounts of data.',
+ 'changeSet' => [],
+ 'ramActions' => [
+ [
+ 'operationType' => 'list',
+ 'ramAction' => [
+ 'action' => 'searchplat:ListCapabilities',
+ 'authLevel' => 'operate',
+ 'actionConditions' => [],
+ 'resources' => [
+ ['validationType' => 'always', 'product' => 'SearchPlat', 'resourceType' => 'All Resource', 'arn' => '*'],
+ ],
+ ],
+ ],
+ ],
+ ],
+ 'ListCredentials' => [
+ 'path' => '/openapi/platform/workspaces/{workspaceName}/credentials',
+ 'methods' => ['get'],
+ 'schemes' => ['http', 'https'],
+ 'security' => [
+ [
+ 'AK' => [],
+ ],
+ ],
+ 'operationType' => 'read',
+ 'deprecated' => false,
+ 'systemTags' => [
+ 'operationType' => 'list',
+ 'abilityTreeCode' => '220525',
+ 'abilityTreeNodes' => ['FEATUREopensearch1AJKH0'],
+ ],
+ 'parameters' => [
+ [
+ 'name' => 'pageSize',
+ 'in' => 'query',
+ 'schema' => ['description' => 'The number of entries per page. Default value: 10.', 'type' => 'integer', 'format' => 'int32', 'maximum' => '100', 'minimum' => '10', 'required' => false, 'example' => '10', 'title' => ''],
+ ],
+ [
+ 'name' => 'pageNumber',
+ 'in' => 'query',
+ 'schema' => ['description' => 'The page number. Default value: 1.', 'type' => 'integer', 'format' => 'int32', 'required' => false, 'example' => '1', 'title' => ''],
+ ],
+ [
+ 'name' => 'keyword',
+ 'in' => 'query',
+ 'schema' => ['description' => 'The keyword used to search for credential values.', 'type' => 'string', 'required' => false, 'example' => 'OS-**', 'title' => ''],
+ ],
+ [
+ 'name' => 'workspaceName',
+ 'in' => 'path',
+ 'schema' => ['description' => 'The workspace name.', 'type' => 'string', 'required' => true, 'example' => 'myWorkspace', 'title' => ''],
+ ],
+ ],
+ 'responses' => [
+ 200 => [
+ 'schema' => [
+ 'title' => '',
+ 'description' => 'Schema of Response',
+ 'type' => 'object',
+ 'properties' => [
+ 'requestId' => ['title' => '', 'description' => 'Id of the request', 'type' => 'string', 'example' => '33E4F0CA-F766-5803-B11C-70DC57A5A6E4'],
+ 'result' => [
+ 'description' => 'The returned result.',
+ 'type' => 'array',
+ 'items' => [
+ 'description' => 'The returned result.',
+ 'type' => 'object',
+ 'properties' => [
+ 'token' => ['description' => 'The access credential token.', 'type' => 'string', 'example' => 'OS-****', 'title' => ''],
+ 'enabled' => ['description' => 'Indicates whether the credential is enabled. Valid values:'."\n"
+ ."\n"
+ .'- true: Enabled.'."\n"
+ .'- false: Disabled.', 'type' => 'boolean', 'example' => 'true', 'title' => ''],
+ 'type' => ['description' => 'The credential type.'."\n"
+ ."\n"
+ .'- api-token.', 'type' => 'string', 'example' => 'api-token'."\n", 'title' => ''],
+ 'appGroupId' => ['description' => 'The workspace ID.', 'type' => 'integer', 'format' => 'int64', 'example' => '123123', 'title' => ''],
+ ],
+ 'title' => '',
+ 'example' => '',
+ ],
+ 'title' => '',
+ 'example' => '',
+ ],
+ 'totalCount' => ['description' => 'The total number of entries.', 'type' => 'integer', 'format' => 'int64', 'example' => '1', 'title' => ''],
+ ],
+ 'example' => '',
+ ],
+ ],
+ ],
+ 'staticInfo' => ['returnType' => 'synchronous'],
+ 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"requestId\\": \\"33E4F0CA-F766-5803-B11C-70DC57A5A6E4\\",\\n \\"result\\": [\\n {\\n \\"token\\": \\"OS-****\\",\\n \\"enabled\\": true,\\n \\"type\\": \\"api-token\\\\n\\",\\n \\"appGroupId\\": 123123\\n }\\n ],\\n \\"totalCount\\": 1\\n}","type":"json"}]',
+ 'title' => 'Query access credentials',
+ 'summary' => 'Retrieves a list of access credentials.',
+ 'changeSet' => [],
+ 'ramActions' => [
+ [
+ 'operationType' => 'list',
+ 'ramAction' => [
+ 'action' => 'searchplat:DescribeCredentials',
+ 'authLevel' => 'resource',
+ 'actionConditions' => [],
+ 'resources' => [
+ ['validationType' => 'always', 'product' => 'SearchPlat', 'resourceType' => 'Credentials', 'arn' => 'acs:searchplat:{#regionId}:{#accountId}:workspaces/{#workspaceName}'],
+ ],
+ ],
+ ],
+ ],
+ ],
+ 'ListExperienceData' => [
+ 'summary' => 'Retrieves all experience data in a specified workspace, with support for filtering by service type and data type.',
+ 'path' => '/openapi/platform/workspaces/{workspaceName}/experience-data',
+ 'methods' => ['get'],
+ 'schemes' => ['http', 'https'],
+ 'security' => [
+ [
+ 'AK' => [],
+ ],
+ ],
+ 'operationType' => 'read',
+ 'deprecated' => false,
+ 'systemTags' => [
+ 'operationType' => 'list',
+ 'riskType' => 'none',
+ 'chargeType' => 'free',
+ 'abilityTreeCode' => '225365',
+ 'abilityTreeNodes' => ['FEATUREopensearch1AJKH0'],
+ ],
+ 'parameters' => [
+ [
+ 'name' => 'dryRun',
+ 'in' => 'query',
+ 'schema' => ['description' => '- true'."\n"
+ .'- false.', 'type' => 'boolean', 'required' => false, 'example' => 'true', 'title' => ''],
+ ],
+ [
+ 'name' => 'serviceType',
+ 'in' => 'query',
+ 'schema' => ['description' => 'The service type.', 'type' => 'string', 'required' => false, 'example' => 'document-analyze', 'title' => ''],
+ ],
+ [
+ 'name' => 'workspaceName',
+ 'in' => 'path',
+ 'schema' => ['description' => 'The workspace name.', 'type' => 'string', 'required' => true, 'example' => 'default', 'title' => ''],
+ ],
+ [
+ 'name' => 'dataType',
+ 'in' => 'query',
+ 'schema' => ['description' => 'The data type.', 'type' => 'string', 'required' => false, 'example' => 'file', 'title' => ''],
+ ],
+ ],
+ 'responses' => [
+ 200 => [
+ 'schema' => [
+ 'title' => '',
+ 'description' => 'Schema of Response',
+ 'type' => 'object',
+ 'properties' => [
+ 'requestId' => ['title' => '', 'description' => 'The request ID.', 'type' => 'string', 'example' => 'FDSS_1232'],
+ 'result' => [
+ 'description' => 'The returned result.',
+ 'type' => 'array',
+ 'items' => [
+ 'description' => 'The returned result.',
+ 'type' => 'object',
+ 'properties' => [
+ 'id' => ['description' => 'ID'."\n", 'type' => 'integer', 'format' => 'int64', 'example' => '9bd21be8', 'title' => ''],
+ 'serviceType' => ['description' => 'The service type.', 'type' => 'string', 'example' => 'document-analyze', 'title' => ''],
+ 'dataType' => ['description' => 'The data type. Valid values:'."\n"
+ ."\n"
+ .'- file'."\n"
+ .'- url.', 'type' => 'string', 'example' => 'file', 'title' => ''],
+ 'name' => ['description' => 'The name.', 'type' => 'string', 'example' => 'xxx.pdf', 'title' => ''],
+ 'dataValue' => ['description' => 'The data value.', 'type' => 'string', 'example' => 'oss://bucket/xxx.pdf', 'title' => ''],
+ 'dataSize' => ['description' => '**The data size.**.', 'type' => 'integer', 'format' => 'int64', 'example' => '100', 'title' => ''],
+ 'created' => ['description' => '**The creation time.**.', 'type' => 'integer', 'format' => 'int64', 'example' => '12313123123', 'title' => ''],
+ 'updated' => ['description' => 'The update time.', 'type' => 'integer', 'format' => 'int64', 'example' => '1232131231', 'title' => ''],
+ 'contentType' => ['description' => '**The content type.**.', 'type' => 'string', 'example' => 'pdf', 'title' => ''],
+ ],
+ 'title' => '',
+ 'example' => '',
+ ],
+ 'title' => '',
+ 'example' => '',
+ ],
+ ],
+ 'example' => '',
+ ],
+ ],
+ ],
+ 'staticInfo' => ['returnType' => 'synchronous'],
+ 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"requestId\\": \\"FDSS_1232\\",\\n \\"result\\": [\\n {\\n \\"id\\": 0,\\n \\"serviceType\\": \\"document-analyze\\",\\n \\"dataType\\": \\"file\\",\\n \\"name\\": \\"xxx.pdf\\",\\n \\"dataValue\\": \\"oss://bucket/xxx.pdf\\",\\n \\"dataSize\\": 100,\\n \\"created\\": 12313123123,\\n \\"updated\\": 1232131231,\\n \\"contentType\\": \\"pdf\\"\\n }\\n ]\\n}","type":"json"}]',
+ 'title' => 'Get experience data list',
+ 'description' => '## Operation description'."\n"
+ .'- This API operation queries all experience data of a user in a specific workspace. The results are sorted by creation time in descending order by default.'."\n"
+ .'- Pagination is not supported. However, you can filter data by using the serviceType and dataType parameters.'."\n"
+ .'- workspaceName is a path parameter and must be specified to indicate the workspace to query.',
+ 'changeSet' => [],
+ 'ramActions' => [
+ [
+ 'operationType' => 'list',
+ 'ramAction' => [
+ 'action' => 'searchplat:DescribeExperienceData',
+ 'authLevel' => 'resource',
+ 'actionConditions' => [],
+ 'resources' => [
+ ['validationType' => 'always', 'product' => 'SearchPlat', 'resourceType' => 'ExperienceData', 'arn' => 'acs:searchplat:{#regionId}:{#accountId}:workspaces/{#workspaceName}'],
+ ],
+ ],
+ ],
+ ],
+ ],
+ 'ListFunctionInstances' => [
+ 'summary' => 'Retrieves a list of service configurations.',
+ 'path' => '/openapi/platform/workspaces/{workspaceName}/functions/{functionName}/instances',
+ 'methods' => ['get'],
+ 'schemes' => ['https'],
+ 'security' => [
+ [
+ 'AK' => [],
+ ],
+ ],
+ 'operationType' => 'read',
+ 'deprecated' => false,
+ 'systemTags' => [
+ 'operationType' => 'list',
+ 'riskType' => 'none',
+ 'chargeType' => 'free',
+ 'abilityTreeCode' => '239787',
+ 'abilityTreeNodes' => ['FEATUREopensearchJK5SO0'],
+ 'autoTest' => true,
+ 'tenantRelevance' => 'publicInformation',
+ ],
+ 'parameters' => [
+ [
+ 'name' => 'workspaceName',
+ 'in' => 'path',
+ 'schema' => ['title' => '', 'description' => 'The workspace name.', 'type' => 'string', 'required' => false, 'example' => 'default'],
+ ],
+ [
+ 'name' => 'functionName',
+ 'in' => 'path',
+ 'schema' => ['title' => '', 'description' => 'The feature name.', 'type' => 'string', 'required' => false, 'example' => 'deployment'],
+ ],
+ [
+ 'name' => 'modelType',
+ 'in' => 'query',
+ 'schema' => ['title' => '', 'description' => 'The model type.', 'type' => 'string', 'required' => false, 'example' => 'ai_search'],
+ ],
+ [
+ 'name' => 'functionType',
+ 'in' => 'query',
+ 'schema' => ['title' => '', 'description' => 'The feature type.', 'type' => 'string', 'required' => false, 'example' => 'PAAS'],
+ ],
+ [
+ 'name' => 'source',
+ 'in' => 'query',
+ 'schema' => ['title' => '', 'description' => 'The instance source. Valid values:'."\n"
+ .'- builtin: system instance'."\n"
+ .'- user: user instance (default)'."\n"
+ .'- all: all instances.', 'type' => 'string', 'required' => false, 'example' => 'user'],
+ ],
+ [
+ 'name' => 'pageNumber',
+ 'in' => 'query',
+ 'schema' => ['title' => '', 'description' => 'The page number.', 'type' => 'integer', 'format' => 'int32', 'required' => false, 'example' => '1'],
+ ],
+ [
+ 'name' => 'pageSize',
+ 'in' => 'query',
+ 'schema' => ['title' => '', 'description' => 'The number of entries per page.', 'type' => 'integer', 'format' => 'int32', 'required' => false, 'example' => '10'],
+ ],
+ [
+ 'name' => 'output',
+ 'in' => 'query',
+ 'schema' => ['title' => '', 'description' => 'The level of detail in the response. Valid values:'."\n"
+ .'- simple: displays only basic information'."\n"
+ .'- normal: displays information such as createParameters and cron (default)'."\n"
+ .'- detail: returns training task information.', 'type' => 'string', 'required' => false, 'example' => 'simple'],
+ ],
+ ],
+ 'responses' => [
+ 200 => [
+ 'schema' => [
+ 'type' => 'object',
+ 'properties' => [
+ 'code' => ['description' => 'The error code.', 'type' => 'string', 'example' => 'not found', 'title' => ''],
+ 'httpCode' => ['description' => 'The HTTP status code.', 'type' => 'integer', 'format' => 'int64', 'example' => '200', 'title' => ''],
+ 'latency' => ['description' => 'The elapsed time.', 'type' => 'integer', 'format' => 'int64', 'example' => '39.108', 'title' => ''],
+ 'message' => ['description' => 'The error message.', 'type' => 'string', 'example' => '"xx not found"', 'title' => ''],
+ 'requestId' => ['description' => 'The request ID.', 'type' => 'string', 'example' => '33E4F0CA-F766-5803-B11C-70DC57A5A6E4', 'title' => ''],
+ 'result' => [
+ 'description' => 'The returned results.',
+ 'type' => 'array',
+ 'items' => [
+ 'description' => 'The returned results.',
+ 'type' => 'object',
+ 'properties' => [
+ 'belongs' => [
+ 'description' => 'The ownership information.',
+ 'type' => 'object',
+ 'properties' => [
+ 'category' => ['description' => 'The category.', 'type' => 'string', 'example' => '""', 'title' => ''],
+ 'domain' => ['description' => 'The industry type.', 'type' => 'string', 'example' => '""', 'title' => ''],
+ 'language' => ['description' => 'The language. Valid values:'."\n"
+ ."\n"
+ .'- zh_CN: Chinese (default)'."\n"
+ .'- en_US: English.', 'type' => 'string', 'example' => 'zh_CN', 'title' => ''],
+ ],
+ 'title' => '',
+ 'example' => '',
+ ],
+ 'createParameters' => [
+ 'description' => 'The creation parameter body.',
+ 'type' => 'array',
+ 'items' => [
+ 'description' => 'The creation parameter body.',
+ 'type' => 'object',
+ 'properties' => [
+ 'name' => ['description' => 'The parameter name.', 'type' => 'string', 'example' => 'name', 'title' => ''],
+ 'value' => ['description' => 'The parameter value.', 'type' => 'string', 'example' => 'value', 'title' => ''],
+ ],
+ 'title' => '',
+ 'example' => '',
+ ],
+ 'title' => '',
+ 'example' => '',
+ ],
+ 'createTime' => ['description' => 'The creation time.', 'type' => 'integer', 'format' => 'int64', 'example' => '1713352442039', 'title' => ''],
+ 'cron' => ['description' => 'The cron expression for the timed scheduling node.', 'type' => 'string', 'example' => '""', 'title' => ''],
+ 'description' => ['description' => 'The description.', 'type' => 'string', 'example' => '描述', 'title' => ''],
+ 'extendInfo' => ['description' => 'The extended information.', 'type' => 'string', 'example' => '""', 'title' => ''],
+ 'functionName' => ['description' => 'The configuration item.', 'type' => 'string', 'example' => 'nl2sql', 'title' => ''],
+ 'functionType' => ['description' => 'The configuration type.', 'type' => 'string', 'example' => 'PAAS', 'title' => ''],
+ 'instanceName' => ['description' => 'The configuration name.', 'type' => 'string', 'example' => 'a_test', 'title' => ''],
+ 'modelType' => ['description' => 'The model type.', 'type' => 'string', 'example' => 'ops-query-analyze-001', 'title' => ''],
+ 'source' => ['description' => 'The instance source. Valid values:'."\n"
+ .'- builtin: system instance'."\n"
+ .'- user: user instance (default)'."\n"
+ .'- all: all instances.', 'type' => 'string', 'example' => 'all ', 'title' => ''],
+ 'status' => ['description' => 'The status. Valid values:'."\n"
+ ."\n"
+ .'- available'."\n"
+ .'- unavailable.', 'type' => 'string', 'example' => 'available', 'title' => ''],
+ 'usageParameters' => [
+ 'description' => 'usageParameters',
+ 'type' => 'array',
+ 'items' => ['description' => 'usageParameters', 'type' => 'object', 'example' => '{}', 'title' => ''],
+ 'title' => '',
+ 'example' => '',
+ ],
+ 'versionId' => ['description' => 'The version ID.', 'type' => 'integer', 'format' => 'int64', 'example' => '1', 'title' => ''],
+ ],
+ 'title' => '',
+ 'example' => '',
+ ],
+ 'title' => '',
+ 'example' => '',
+ ],
+ 'status' => ['description' => 'The request status.', 'type' => 'string', 'example' => 'OK', 'title' => ''],
+ 'totalCount' => ['description' => 'The total number of entries.', 'type' => 'integer', 'format' => 'int64', 'example' => '1', 'title' => ''],
+ ],
+ 'description' => '',
+ 'title' => '',
+ 'example' => '',
+ ],
+ ],
+ ],
+ 'staticInfo' => ['returnType' => 'synchronous'],
+ 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"code\\": \\"not found\\",\\n \\"httpCode\\": 200,\\n \\"latency\\": 39.108,\\n \\"message\\": \\"\\\\\\"xx not found\\\\\\"\\",\\n \\"requestId\\": \\"33E4F0CA-F766-5803-B11C-70DC57A5A6E4\\",\\n \\"result\\": [\\n {\\n \\"belongs\\": {\\n \\"category\\": \\"\\\\\\"\\\\\\"\\",\\n \\"domain\\": \\"\\\\\\"\\\\\\"\\",\\n \\"language\\": \\"zh_CN\\"\\n },\\n \\"createParameters\\": [\\n {\\n \\"name\\": \\"name\\",\\n \\"value\\": \\"value\\"\\n }\\n ],\\n \\"createTime\\": 1713352442039,\\n \\"cron\\": \\"\\\\\\"\\\\\\"\\",\\n \\"description\\": \\"描述\\",\\n \\"extendInfo\\": \\"\\\\\\"\\\\\\"\\",\\n \\"functionName\\": \\"nl2sql\\",\\n \\"functionType\\": \\"PAAS\\",\\n \\"instanceName\\": \\"a_test\\",\\n \\"modelType\\": \\"ops-query-analyze-001\\",\\n \\"source\\": \\"all \\",\\n \\"status\\": \\"available\\",\\n \\"usageParameters\\": [\\n {}\\n ],\\n \\"versionId\\": 1\\n }\\n ],\\n \\"status\\": \\"OK\\",\\n \\"totalCount\\": 1\\n}","type":"json"}]',
+ 'title' => 'Retrieve service or model configuration details list',
+ 'changeSet' => [],
+ 'ramActions' => [
+ [
+ 'operationType' => 'list',
+ 'ramAction' => [
+ 'action' => 'searchplat:DescribeFunction',
+ 'authLevel' => 'resource',
+ 'actionConditions' => [],
+ 'resources' => [
+ ['validationType' => 'always', 'product' => 'SearchPlat', 'resourceType' => 'FunctionInstance', 'arn' => 'acs:searchplat:{#regionId}:{#accountId}:workspaces/{#workspaceName}'],
+ ],
+ ],
+ ],
+ ],
+ ],
+ 'ListFunctionRestrictions' => [
+ 'summary' => 'Retrieves the restriction items of a feature.',
+ 'path' => '/openapi/platform/workspaces/{workspaceName}/functions/{functionName}/restrictions/{restrictionName}',
+ 'methods' => ['get'],
+ 'schemes' => ['https'],
+ 'security' => [
+ [
+ 'AK' => [],
+ ],
+ ],
+ 'consumes' => ['application/json'],
+ 'produces' => ['application/json'],
+ 'operationType' => 'read',
+ 'deprecated' => false,
+ 'systemTags' => [
+ 'operationType' => 'get',
+ 'riskType' => 'none',
+ 'chargeType' => 'free',
+ 'abilityTreeNodes' => ['FEATUREopensearchLIKVQB'],
+ ],
+ 'parameters' => [
+ [
+ 'name' => 'workspaceName',
+ 'in' => 'path',
+ 'schema' => ['description' => 'The workspace name.', 'type' => 'string', 'required' => false, 'example' => 'default', 'title' => ''],
+ ],
+ [
+ 'name' => 'functionName',
+ 'in' => 'path',
+ 'schema' => ['description' => 'The configuration type.'."\n"
+ ."\n"
+ .'- deployment.', 'type' => 'string', 'required' => false, 'example' => 'deployment', 'title' => ''],
+ ],
+ [
+ 'name' => 'restrictionName',
+ 'in' => 'path',
+ 'schema' => ['description' => 'The restriction name. Valid values:'."\n"
+ .'- model: model names supported by the platform'."\n"
+ .'- instance_type: resource types supported by the platform.', 'type' => 'string', 'required' => false, 'example' => 'model', 'title' => ''],
+ ],
+ [
+ 'name' => 'modelType',
+ 'in' => 'query',
+ 'schema' => ['description' => 'The model type.', 'type' => 'string', 'required' => false, 'example' => 'native', 'title' => ''],
+ ],
+ [
+ 'name' => 'region',
+ 'in' => 'query',
+ 'schema' => ['description' => 'The region ID.', 'type' => 'string', 'required' => false, 'example' => 'cn-hangzhou', 'title' => ''],
+ ],
+ [
+ 'name' => 'source',
+ 'in' => 'query',
+ 'schema' => ['description' => 'The source.', 'type' => 'string', 'required' => false, 'example' => 'user', 'title' => ''],
+ ],
+ ],
+ 'responses' => [
+ 200 => [
+ 'schema' => [
+ 'title' => '',
+ 'description' => 'Schema of Response',
+ 'type' => 'object',
+ 'properties' => [
+ 'status' => ['description' => 'The request status.', 'type' => 'string', 'example' => 'OK', 'title' => ''],
+ 'requestId' => ['description' => 'The request ID.', 'type' => 'string', 'example' => '2423C841-91C4-5E51-B296-590D367967FC', 'title' => ''],
+ 'code' => ['description' => 'The error code.', 'type' => 'string', 'example' => 'not found', 'title' => ''],
+ 'message' => ['description' => 'The error message.', 'type' => 'string', 'example' => '"xx not found"', 'title' => ''],
+ 'totalCount' => ['description' => 'The total number of entries.', 'type' => 'integer', 'format' => 'int64', 'example' => '1', 'title' => ''],
+ 'result' => [
+ 'description' => 'The returned result.',
+ 'type' => 'array',
+ 'items' => [
+ 'description' => 'The returned result.',
+ 'type' => 'object',
+ 'properties' => [
+ 'name' => ['description' => 'The rule name.', 'type' => 'string', 'example' => 'test', 'title' => ''],
+ 'meta' => ['description' => 'The metadata.', 'type' => 'object', 'example' => '{'."\n"
+ .' "taskType":"text-embedding",'."\n"
+ .' "modelSource":['."\n"
+ .' "ai_search"'."\n"
+ .' ],'."\n"
+ .' "regionId":['."\n"
+ .' "cn-hangzhou",'."\n"
+ .' "cn-zhangjiakou"'."\n"
+ .' ],'."\n"
+ .' "instanceType":['."\n"
+ .' "gpu.v100.16g.x1",'."\n"
+ .' "gpu.t4.16g.x1",'."\n"
+ .' "gpu.a10.24g.x1"'."\n"
+ .' ]'."\n"
+ .' }', 'title' => ''],
+ ],
+ 'title' => '',
+ 'example' => '',
+ ],
+ 'title' => '',
+ 'example' => '',
+ ],
+ 'httpCode' => ['description' => 'The HTTP status code.', 'type' => 'integer', 'format' => 'int64', 'example' => '200', 'title' => ''],
+ 'latency' => ['description' => 'The execution duration.', 'type' => 'number', 'format' => 'double', 'example' => '10.444', 'title' => ''],
+ ],
+ 'example' => '',
+ ],
+ ],
+ ],
+ 'staticInfo' => ['returnType' => 'synchronous'],
+ 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"status\\": \\"OK\\",\\n \\"requestId\\": \\"2423C841-91C4-5E51-B296-590D367967FC\\",\\n \\"code\\": \\"not found\\",\\n \\"message\\": \\"\\\\\\"xx not found\\\\\\"\\",\\n \\"totalCount\\": 1,\\n \\"result\\": [\\n {\\n \\"name\\": \\"test\\",\\n \\"meta\\": {\\n \\"taskType\\": \\"text-embedding\\",\\n \\"modelSource\\": [\\n \\"ai_search\\"\\n ],\\n \\"regionId\\": [\\n \\"cn-hangzhou\\",\\n \\"cn-zhangjiakou\\"\\n ],\\n \\"instanceType\\": [\\n \\"gpu.v100.16g.x1\\",\\n \\"gpu.t4.16g.x1\\",\\n \\"gpu.a10.24g.x1\\"\\n ]\\n }\\n }\\n ],\\n \\"httpCode\\": 200,\\n \\"latency\\": 10.444\\n}","type":"json"}]',
+ 'title' => 'Retrieve restriction items of a feature',
+ 'changeSet' => [],
+ 'ramActions' => [
+ [
+ 'operationType' => 'get',
+ 'ramAction' => [
+ 'action' => 'searchplat:ListFunctionRestrictions',
+ 'authLevel' => 'operate',
+ 'actionConditions' => [],
+ 'resources' => [
+ ['validationType' => 'always', 'product' => 'SearchPlat', 'resourceType' => 'All Resource', 'arn' => '*'],
+ ],
+ ],
+ ],
+ ],
+ ],
+ 'ListOfflineTask' => [
+ 'summary' => 'Get Offline Task Information List',
+ 'path' => '/openapi/platform/workspaces/{workspaceName}/offline-tasks/{type}',
+ 'methods' => ['get'],
+ 'schemes' => ['https'],
+ 'security' => [
+ [
+ 'AK' => [],
+ ],
+ ],
+ 'consumes' => ['application/json'],
+ 'produces' => ['application/json'],
+ 'operationType' => 'read',
+ 'deprecated' => false,
+ 'systemTags' => [
+ 'operationType' => 'none',
+ 'riskType' => 'none',
+ 'chargeType' => 'free',
+ 'abilityTreeNodes' => ['FEATUREopensearchJK5SO0'],
+ ],
+ 'parameters' => [
+ [
+ 'name' => 'workspaceName',
+ 'in' => 'path',
+ 'schema' => ['description' => 'The workspace name.', 'type' => 'string', 'required' => false, 'example' => 'default', 'title' => ''],
+ ],
+ [
+ 'name' => 'type',
+ 'in' => 'path',
+ 'schema' => ['description' => 'The task type.', 'type' => 'string', 'required' => false, 'example' => 'video', 'title' => ''],
+ ],
+ [
+ 'name' => 'taskName',
+ 'in' => 'query',
+ 'schema' => ['description' => 'The task name.', 'type' => 'string', 'required' => false, 'example' => 'syh', 'title' => ''],
+ ],
+ [
+ 'name' => 'taskStatus',
+ 'in' => 'query',
+ 'style' => 'json',
+ 'schema' => [
+ 'description' => 'The task status.',
+ 'type' => 'array',
+ 'items' => ['description' => 'The task status.', 'type' => 'string', 'required' => false, 'example' => 'RUNNING', 'title' => ''],
+ 'required' => false,
+ 'title' => '',
+ 'example' => '',
+ ],
+ ],
+ [
+ 'name' => 'labels',
+ 'in' => 'query',
+ 'style' => 'json',
+ 'schema' => [
+ 'description' => 'The list of task labels.',
+ 'type' => 'array',
+ 'items' => ['description' => 'The label value.', 'type' => 'string', 'required' => false, 'example' => 'abc', 'title' => ''],
+ 'required' => false,
+ 'title' => '',
+ 'example' => '',
+ ],
+ ],
+ [
+ 'name' => 'pageNumber',
+ 'in' => 'query',
+ 'schema' => ['description' => 'The page number. Default value: 1.'."\n", 'type' => 'integer', 'format' => 'int32', 'required' => false, 'example' => '0', 'title' => ''],
+ ],
+ [
+ 'name' => 'pageSize',
+ 'in' => 'query',
+ 'schema' => ['description' => 'The number of entries per page.', 'type' => 'integer', 'format' => 'int32', 'required' => false, 'example' => '10', 'title' => ''],
+ ],
+ [
+ 'name' => 'regionId',
+ 'in' => 'query',
+ 'schema' => ['title' => '', 'description' => 'The region ID.', 'type' => 'string', 'example' => 'cn-shanghai', 'required' => false],
+ ],
+ ],
+ 'responses' => [
+ 200 => [
+ 'schema' => [
+ 'title' => '',
+ 'description' => 'Schema of Response',
+ 'type' => 'object',
+ 'properties' => [
+ 'TotalCount' => ['description' => 'The total number of records.', 'type' => 'integer', 'format' => 'int64', 'example' => '7', 'title' => ''],
+ 'RequestId' => ['description' => 'The request ID.', 'type' => 'string', 'example' => '786CC01F-0F1D-5FB5-8BFF-B0F3DB289772', 'title' => ''],
+ 'Result' => [
+ 'description' => 'The returned results.',
+ 'type' => 'array',
+ 'items' => [
+ 'description' => 'The returned results.',
+ 'type' => 'object',
+ 'properties' => [
+ 'Meta' => [
+ 'description' => 'The task metadata.',
+ 'type' => 'object',
+ 'properties' => [
+ 'Labels' => [
+ 'description' => 'The list of labels.',
+ 'type' => 'array',
+ 'items' => ['description' => 'The label value.', 'type' => 'string', 'example' => 'test', 'title' => ''],
+ 'title' => '',
+ 'example' => '',
+ ],
+ 'RegionId' => ['description' => 'The region ID of the task.', 'type' => 'string', 'example' => 'cn-shanghai', 'title' => ''],
+ 'TaskName' => ['description' => 'The task name.', 'type' => 'string', 'example' => 'jly-fesOffline-172.16.8.133-20912', 'title' => ''],
+ 'WorkspaceId' => ['description' => 'The workspace ID.', 'type' => 'string', 'example' => '2192861158', 'title' => ''],
+ ],
+ 'title' => '',
+ 'example' => '',
+ ],
+ 'Processors' => [
+ 'description' => 'The processing pipeline operators.',
+ 'type' => 'array',
+ 'items' => [
+ 'description' => 'The processing pipeline operators.',
+ 'type' => 'object',
+ 'properties' => [
+ 'Input' => [
+ 'description' => 'The input parameters.',
+ 'type' => 'object',
+ 'additionalProperties' => ['description' => 'The input parameters.', 'type' => 'string', 'example' => '{'."\n"
+ .' "key": "content"'."\n"
+ .'}', 'title' => ''],
+ 'title' => '',
+ 'example' => '',
+ ],
+ 'Name' => ['description' => 'The name.', 'type' => 'string', 'example' => 'processor1', 'title' => ''],
+ 'Output' => [
+ 'description' => 'The output parameters.',
+ 'type' => 'object',
+ 'additionalProperties' => ['description' => 'The output parameters.', 'type' => 'string', 'example' => '{'."\n"
+ .'"vector": "syh_image_uri_multi-modal-embedding"'."\n"
+ .'}', 'title' => ''],
+ 'title' => '',
+ 'example' => '',
+ ],
+ 'Parameters' => [
+ 'description' => 'The processor parameters.',
+ 'type' => 'object',
+ 'additionalProperties' => ['description' => 'The processor parameters.', 'type' => 'string', 'example' => '{'."\n"
+ .' "service_id": "xxx"'."\n"
+ .'}', 'title' => ''],
+ 'title' => '',
+ 'example' => '',
+ ],
+ 'Type' => ['description' => 'The type.', 'type' => 'string', 'example' => 'document-analyze'."\n", 'title' => ''],
+ ],
+ 'title' => '',
+ 'example' => '',
+ ],
+ 'title' => '',
+ 'example' => '',
+ ],
+ 'Sink' => [
+ 'description' => 'The data sink information.',
+ 'type' => 'array',
+ 'items' => [
+ 'description' => 'The data sink.',
+ 'type' => 'object',
+ 'properties' => [
+ 'Name' => ['description' => 'The data sink name.', 'type' => 'string', 'example' => 'table2', 'title' => ''],
+ 'Parameters' => [
+ 'description' => 'The data sink configuration parameters, which are determined by the type.',
+ 'type' => 'object',
+ 'additionalProperties' => ['description' => 'The data sink configuration parameter name.', 'type' => 'string', 'example' => 'instanceId', 'title' => ''],
+ 'title' => '',
+ 'example' => '',
+ ],
+ 'PrimaryKey' => ['description' => 'The primary key field of the data sink.', 'type' => 'string', 'example' => 'id', 'title' => ''],
+ 'Schema' => [
+ 'description' => 'The data sink schema.',
+ 'type' => 'array',
+ 'items' => [
+ 'description' => 'The data sink schema.',
+ 'type' => 'object',
+ 'additionalProperties' => ['description' => 'The field name of the data sink schema.', 'type' => 'string', 'example' => 'name'."\n", 'title' => ''],
+ 'title' => '',
+ 'example' => '',
+ ],
+ 'title' => '',
+ 'example' => '',
+ ],
+ 'Type' => ['description' => 'The data sink type.', 'type' => 'string', 'example' => 'swift', 'title' => ''],
+ ],
+ 'title' => '',
+ 'example' => '',
+ ],
+ 'title' => '',
+ 'example' => '',
+ ],
+ 'Source' => [
+ 'description' => 'The data source information.',
+ 'type' => 'array',
+ 'items' => [
+ 'description' => 'The data source.',
+ 'type' => 'object',
+ 'properties' => [
+ 'Name' => ['description' => 'The data source name.', 'type' => 'string', 'example' => 'table', 'title' => ''],
+ 'Parameters' => [
+ 'description' => 'The data source configuration parameters.',
+ 'type' => 'object',
+ 'additionalProperties' => ['description' => 'The data source configuration name.', 'type' => 'string', 'example' => 'name', 'title' => ''],
+ 'title' => '',
+ 'example' => '',
+ ],
+ 'PrimaryKey' => ['description' => 'The primary key field of the data source.', 'type' => 'string', 'example' => 'id', 'title' => ''],
+ 'Schema' => [
+ 'description' => 'The data source schema.',
+ 'type' => 'array',
+ 'items' => [
+ 'description' => 'The data source schema.',
+ 'type' => 'object',
+ 'additionalProperties' => ['description' => 'The field name of the data source schema.', 'type' => 'string', 'example' => 'name', 'title' => ''],
+ 'title' => '',
+ 'example' => '',
+ ],
+ 'title' => '',
+ 'example' => '',
+ ],
+ 'Type' => ['description' => 'The data source type.', 'type' => 'string', 'example' => 'rds', 'title' => ''],
+ ],
+ 'title' => '',
+ 'example' => '',
+ ],
+ 'title' => '',
+ 'example' => '',
+ ],
+ 'Status' => [
+ 'description' => 'The task status.',
+ 'type' => 'object',
+ 'properties' => [
+ 'CreateTime' => ['description' => 'The time when the task was created.', 'type' => 'integer', 'format' => 'int64', 'example' => '1744941600000', 'title' => ''],
+ 'MetricData' => [
+ 'description' => 'The monitoring information.',
+ 'type' => 'object',
+ 'additionalProperties' => ['description' => 'The monitoring information field.', 'type' => 'string', 'example' => '- CurrentEmitEventTimeLag'."\n"
+ .'- CurrentFetchEventTimeLag'."\n"
+ .'- NumOfRecordsInFromSource'."\n"
+ .'- NumOfRecordsOutToSink', 'title' => ''],
+ 'title' => '',
+ 'example' => '',
+ ],
+ 'Status' => ['description' => 'The task status.', 'type' => 'string', 'example' => 'RUNNING'."\n", 'title' => ''],
+ 'UpdateTime' => ['description' => 'The time when the task was last modified.', 'type' => 'integer', 'format' => 'int64', 'example' => '1744941600000', 'title' => ''],
+ ],
+ 'title' => '',
+ 'example' => '',
+ ],
+ ],
+ 'title' => '',
+ 'example' => '',
+ ],
+ 'title' => '',
+ 'example' => '',
+ ],
+ ],
+ 'example' => '',
+ ],
+ ],
+ ],
+ 'staticInfo' => ['returnType' => 'synchronous'],
+ 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"TotalCount\\": 7,\\n \\"RequestId\\": \\"786CC01F-0F1D-5FB5-8BFF-B0F3DB289772\\",\\n \\"Result\\": [\\n {\\n \\"Meta\\": {\\n \\"Labels\\": [\\n \\"test\\"\\n ],\\n \\"RegionId\\": \\"cn-shanghai\\",\\n \\"TaskName\\": \\"jly-fesOffline-172.16.8.133-20912\\",\\n \\"WorkspaceId\\": \\"2192861158\\"\\n },\\n \\"Processors\\": [\\n {\\n \\"Input\\": {\\n \\"key\\": \\"{\\\\n \\\\\\"key\\\\\\": \\\\\\"content\\\\\\"\\\\n}\\"\\n },\\n \\"Name\\": \\"processor1\\",\\n \\"Output\\": {\\n \\"key\\": \\"{\\\\n\\\\\\"vector\\\\\\": \\\\\\"syh_image_uri_multi-modal-embedding\\\\\\"\\\\n}\\"\\n },\\n \\"Parameters\\": {\\n \\"key\\": \\"{\\\\n \\\\\\"service_id\\\\\\": \\\\\\"xxx\\\\\\"\\\\n}\\"\\n },\\n \\"Type\\": \\"document-analyze\\\\n\\"\\n }\\n ],\\n \\"Sink\\": [\\n {\\n \\"Name\\": \\"table2\\",\\n \\"Parameters\\": {\\n \\"key\\": \\"instanceId\\"\\n },\\n \\"PrimaryKey\\": \\"id\\",\\n \\"Schema\\": [\\n {\\n \\"key\\": \\"name\\\\n\\"\\n }\\n ],\\n \\"Type\\": \\"swift\\"\\n }\\n ],\\n \\"Source\\": [\\n {\\n \\"Name\\": \\"table\\",\\n \\"Parameters\\": {\\n \\"key\\": \\"name\\"\\n },\\n \\"PrimaryKey\\": \\"id\\",\\n \\"Schema\\": [\\n {\\n \\"key\\": \\"name\\"\\n }\\n ],\\n \\"Type\\": \\"rds\\"\\n }\\n ],\\n \\"Status\\": {\\n \\"CreateTime\\": 1744941600000,\\n \\"MetricData\\": {\\n \\"key\\": \\"- CurrentEmitEventTimeLag\\\\n- CurrentFetchEventTimeLag\\\\n- NumOfRecordsInFromSource\\\\n- NumOfRecordsOutToSink\\"\\n },\\n \\"Status\\": \\"RUNNING\\\\n\\",\\n \\"UpdateTime\\": 1744941600000\\n }\\n }\\n ]\\n}","type":"json"}]',
+ 'title' => 'Get Offline Task List',
+ 'changeSet' => [
+ ['createdAt' => '2025-12-02T07:12:30.000Z', 'description' => 'Request parameters changed'],
+ ],
+ 'ramActions' => [
+ [
+ 'operationType' => 'none',
+ 'ramAction' => [
+ 'action' => 'searchplat:ListOfflineTask',
+ 'authLevel' => 'operate',
+ 'actionConditions' => [],
+ 'resources' => [
+ ['validationType' => 'always', 'product' => 'SearchPlat', 'resourceType' => 'All Resource', 'arn' => '*'],
+ ],
+ ],
+ ],
+ ],
+ ],
+ 'ListRagEvaluatorTasks' => [
+ 'summary' => 'Retrieves the list of RAG evaluation tasks.',
+ 'path' => '/openapi/platform/workspaces/{workspaceName}/rag-evaluator/v1/api/tasks',
+ 'methods' => ['get'],
+ 'schemes' => ['http', 'https'],
+ 'security' => [
+ [
+ 'AK' => [],
+ ],
+ ],
+ 'consumes' => ['application/json'],
+ 'produces' => ['application/json'],
+ 'operationType' => 'read',
+ 'deprecated' => false,
+ 'systemTags' => [
+ 'operationType' => 'get',
+ 'riskType' => 'none',
+ 'chargeType' => 'free',
+ 'abilityTreeCode' => '226077',
+ 'abilityTreeNodes' => ['FEATUREopensearchWAC9DF'],
+ ],
+ 'parameters' => [
+ [
+ 'name' => 'workspaceName',
+ 'in' => 'path',
+ 'schema' => ['description' => 'The workspace name.', 'type' => 'string', 'required' => false, 'example' => 'default', 'title' => ''],
+ ],
+ [
+ 'name' => 'pageNumber',
+ 'in' => 'query',
+ 'schema' => ['description' => 'The page number. Default value: 1.', 'type' => 'string', 'required' => false, 'example' => '1', 'title' => ''],
+ ],
+ [
+ 'name' => 'pageSize',
+ 'in' => 'query',
+ 'schema' => ['description' => 'The number of entries per page.', 'type' => 'string', 'required' => false, 'example' => '10', 'title' => ''],
+ ],
+ ],
+ 'responses' => [
+ 200 => [
+ 'schema' => [
+ 'title' => '',
+ 'description' => 'Schema of Response',
+ 'type' => 'object',
+ 'properties' => [
+ 'requestId' => ['title' => '', 'description' => 'Id of the request', 'type' => 'string', 'example' => '1CC93E65-6734-5060-BEF7-0EB0A4862BCF'],
+ 'code' => ['description' => 'The error code.', 'type' => 'string', 'example' => 'not found', 'title' => ''],
+ 'message' => ['description' => 'The error message.', 'type' => 'string', 'example' => '"xx not found"', 'title' => ''],
+ 'result' => ['description' => 'The returned result.', 'type' => 'object', 'example' => '{'."\n"
+ .' "odps_task_id": 224525243, '."\n"
+ .' "usage" : {'."\n"
+ .' "cu" : 0.000'."\n"
+ .' }', 'title' => ''],
+ 'totalCount' => ['description' => 'The total number of entries.', 'type' => 'integer', 'format' => 'int32', 'example' => '1', 'title' => ''],
+ ],
+ 'example' => '',
+ ],
+ ],
+ ],
+ 'staticInfo' => ['returnType' => 'synchronous'],
+ 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"requestId\\": \\"1CC93E65-6734-5060-BEF7-0EB0A4862BCF\\",\\n \\"code\\": \\"not found\\",\\n \\"message\\": \\"\\\\\\"xx not found\\\\\\"\\",\\n \\"result\\": {\\n \\"test\\": \\"test\\",\\n \\"test2\\": 1\\n },\\n \\"totalCount\\": 1\\n}","type":"json"}]',
+ 'title' => 'Retrieve RAG evaluation task list',
+ 'changeSet' => [],
+ 'ramActions' => [
+ [
+ 'operationType' => 'get',
+ 'ramAction' => [
+ 'action' => 'searchplat:DescribeEvaluation',
+ 'authLevel' => 'operate',
+ 'actionConditions' => [],
+ 'resources' => [
+ ['validationType' => 'always', 'product' => 'SearchPlat', 'resourceType' => 'All Resource', 'arn' => '*'],
+ ],
+ ],
+ ],
+ ],
+ ],
+ 'ListServices' => [
+ 'summary' => 'Retrieves the list of services.',
+ 'path' => '/openapi/platform/workspaces/{workspaceName}/services',
+ 'methods' => ['get'],
+ 'schemes' => ['https'],
+ 'security' => [
+ [
+ 'AK' => [],
+ ],
+ ],
+ 'consumes' => ['application/json'],
+ 'produces' => ['application/json'],
+ 'operationType' => 'read',
+ 'deprecated' => false,
+ 'systemTags' => [
+ 'operationType' => 'none',
+ 'riskType' => 'none',
+ 'chargeType' => 'free',
+ 'abilityTreeNodes' => ['FEATUREopensearchLIKVQB'],
+ 'autoTest' => true,
+ 'tenantRelevance' => 'tenant',
+ ],
+ 'parameters' => [
+ [
+ 'name' => 'workspaceName',
+ 'in' => 'path',
+ 'schema' => ['description' => 'The workspace name.', 'type' => 'string', 'required' => false, 'example' => 'default', 'title' => ''],
+ ],
+ [
+ 'name' => 'modelType',
+ 'in' => 'query',
+ 'schema' => ['description' => 'The model type. Valid values:'."\n"
+ ."\n"
+ .'- system: built-in model'."\n"
+ .'- deployment: custom deployment model.', 'type' => 'string', 'required' => false, 'example' => 'system', 'title' => ''],
+ ],
+ [
+ 'name' => 'serviceType',
+ 'in' => 'query',
+ 'schema' => ['description' => 'The service type.', 'type' => 'string', 'required' => false, 'example' => 'text-embedding', 'title' => ''],
+ ],
+ [
+ 'name' => 'serviceId',
+ 'in' => 'query',
+ 'schema' => ['description' => 'The service ID.', 'type' => 'string', 'required' => false, 'example' => 'ops-text-embedding-001', 'title' => ''],
+ ],
+ [
+ 'name' => 'name',
+ 'in' => 'query',
+ 'schema' => ['description' => 'The service name.', 'type' => 'string', 'required' => false, 'example' => '文本向量化', 'title' => ''],
+ ],
+ ],
+ 'responses' => [
+ 200 => [
+ 'schema' => [
+ 'title' => '',
+ 'description' => 'Schema of Response',
+ 'type' => 'object',
+ 'properties' => [
+ 'requestId' => ['title' => '', 'description' => 'Id of the request', 'type' => 'string', 'example' => '2423C841-91C4-5E51-B296-590D367967FC'],
+ 'result' => [
+ 'description' => 'The task execution result.',
+ 'type' => 'array',
+ 'items' => [
+ 'description' => 'The task execution result.',
+ 'type' => 'object',
+ 'properties' => [
+ 'description' => ['description' => 'The description.', 'type' => 'string', 'example' => '33', 'title' => ''],
+ 'meta' => ['description' => 'The metadata.', 'type' => 'object', 'example' => ' {'."\n"
+ .' "maxTokens": 512'."\n"
+ .' }', 'title' => ''],
+ 'modelType' => ['description' => 'The model type.', 'type' => 'string', 'example' => 'deployment', 'title' => ''],
+ 'name' => ['description' => 'The service name.', 'type' => 'string', 'example' => '文本向量化'."\n", 'title' => ''],
+ 'serviceId' => ['description' => 'The service ID.', 'type' => 'string', 'example' => 'ops-text-embedding-001'."\n", 'title' => ''],
+ 'serviceType' => ['description' => 'The service type.', 'type' => 'string', 'example' => 'text-embedding', 'title' => ''],
+ 'chargeWay' => [
+ 'description' => 'The billing method.',
+ 'type' => 'array',
+ 'items' => ['description' => 'The billing type.', 'type' => 'string', 'example' => 'token-used', 'title' => ''],
+ 'title' => '',
+ 'example' => '',
+ ],
+ ],
+ 'title' => '',
+ 'example' => '',
+ ],
+ 'title' => '',
+ 'example' => '',
+ ],
+ ],
+ 'example' => '',
+ ],
+ ],
+ ],
+ 'staticInfo' => ['returnType' => 'synchronous'],
+ 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"requestId\\": \\"2423C841-91C4-5E51-B296-590D367967FC\\",\\n \\"result\\": [\\n {\\n \\"description\\": \\"33\\",\\n \\"meta\\": {\\n \\"maxTokens\\": 512\\n },\\n \\"modelType\\": \\"deployment\\",\\n \\"name\\": \\"文本向量化\\\\n\\",\\n \\"serviceId\\": \\"ops-text-embedding-001\\\\n\\",\\n \\"serviceType\\": \\"text-embedding\\",\\n \\"chargeWay\\": [\\n \\"token-used\\"\\n ]\\n }\\n ]\\n}","type":"json"}]',
+ 'title' => 'Retrieve all services',
+ 'changeSet' => [],
+ 'ramActions' => [
+ [
+ 'operationType' => 'none',
+ 'ramAction' => [
+ 'action' => 'searchplat:ListServices',
+ 'authLevel' => 'operate',
+ 'actionConditions' => [],
+ 'resources' => [
+ ['validationType' => 'always', 'product' => 'SearchPlat', 'resourceType' => 'All Resource', 'arn' => '*'],
+ ],
+ ],
+ ],
+ ],
+ ],
+ 'ListWorkspaces' => [
+ 'summary' => 'Retrieves a list of workspaces.',
+ 'path' => '/openapi/platform/workspaces',
+ 'methods' => ['get'],
+ 'schemes' => ['http', 'https'],
+ 'security' => [
+ [
+ 'AK' => [],
+ ],
+ ],
+ 'operationType' => 'read',
+ 'deprecated' => false,
+ 'systemTags' => [
+ 'operationType' => 'list',
+ 'riskType' => 'none',
+ 'chargeType' => 'free',
+ 'abilityTreeCode' => '218194',
+ 'abilityTreeNodes' => ['FEATUREopensearchGVH0IN'],
+ ],
+ 'parameters' => [
+ [
+ 'name' => 'pageNumber',
+ 'in' => 'query',
+ 'schema' => ['description' => 'The page number. Default value: 1.', 'type' => 'integer', 'format' => 'int32', 'required' => false, 'example' => '1', 'title' => ''],
+ ],
+ [
+ 'name' => 'pageSize',
+ 'in' => 'query',
+ 'schema' => ['description' => 'The number of entries per page.', 'type' => 'integer', 'format' => 'int32', 'required' => false, 'example' => '10', 'title' => ''],
+ ],
+ [
+ 'name' => 'instanceId',
+ 'in' => 'query',
+ 'schema' => ['description' => 'The instance ID.', 'type' => 'string', 'required' => false, 'example' => 'ops-cn-jte49bevd04', 'title' => ''],
+ ],
+ [
+ 'name' => 'name',
+ 'in' => 'query',
+ 'schema' => ['description' => 'The workspace name.', 'type' => 'string', 'required' => false, 'example' => 'default', 'title' => ''],
+ ],
+ [
+ 'name' => 'type',
+ 'in' => 'query',
+ 'schema' => ['description' => 'The type.', 'type' => 'string', 'required' => false, 'example' => 'standard', 'title' => ''],
+ ],
+ [
+ 'name' => 'sortBy',
+ 'in' => 'query',
+ 'schema' => ['description' => 'The sort order. Valid values:'."\n"
+ ."\n"
+ .'- 0: sorted by creation time in descending order.'."\n"
+ .'- 1: sorted by modification time in descending order.'."\n"
+ ."\n"
+ .'Default value: 0.', 'type' => 'integer', 'format' => 'int32', 'required' => false, 'example' => '1', 'title' => ''],
+ ],
+ [
+ 'name' => 'resourceGroupId',
+ 'in' => 'query',
+ 'schema' => ['description' => 'The resource group ID.', 'type' => 'string', 'required' => false, 'example' => 'rg-aekzivjfrlpyn3y', 'title' => ''],
+ ],
+ ],
+ 'responses' => [
+ 200 => [
+ 'schema' => [
+ 'title' => '',
+ 'description' => 'Schema of Response',
+ 'type' => 'object',
+ 'properties' => [
+ 'requestId' => ['title' => '', 'description' => 'Id of the request', 'type' => 'string', 'example' => '33E4F0CA-F766-5803-B11C-70DC57A5A6E4'],
+ 'totalCount' => ['description' => 'The total number of entries.', 'type' => 'integer', 'format' => 'int32', 'example' => '1', 'title' => ''],
+ 'result' => [
+ 'description' => 'The returned results.',
+ 'type' => 'array',
+ 'items' => [
+ 'description' => 'The returned results.',
+ 'type' => 'object',
+ 'properties' => [
+ 'chargeType' => ['description' => 'The billing type. Valid values:'."\n"
+ .'- POSTPAY: pay-as-you-go.', 'type' => 'string', 'example' => 'POSTPAY', 'title' => ''],
+ 'description' => ['description' => 'The description.', 'type' => 'string', 'example' => '22222', 'title' => ''],
+ 'domainName' => ['description' => 'The custom domain name prefix.', 'type' => 'string', 'example' => 'default-xxx', 'title' => ''],
+ 'engineType' => ['description' => 'The engine type.', 'type' => 'string', 'example' => 'rag', 'title' => ''],
+ 'id' => ['description' => 'The workspace ID.', 'type' => 'string', 'example' => '1222212', 'title' => ''],
+ 'instanceId' => ['description' => 'The instance ID.', 'type' => 'string', 'example' => 'ops-cn-em93wcq0s001', 'title' => ''],
+ 'name' => ['description' => 'The workspace name.', 'type' => 'string', 'example' => 'test', 'title' => ''],
+ 'quota' => [
+ 'description' => 'The quota information.',
+ 'type' => 'object',
+ 'properties' => [
+ 'computeResource' => ['description' => 'The compute resource.', 'type' => 'integer', 'format' => 'int32', 'example' => '0', 'title' => ''],
+ 'docSize' => ['description' => 'The storage capacity.', 'type' => 'integer', 'format' => 'int32', 'example' => '0', 'title' => ''],
+ 'spec' => ['description' => 'The specifications.', 'type' => 'string', 'example' => 'rag.share.compute', 'title' => ''],
+ ],
+ 'title' => '',
+ 'example' => '',
+ ],
+ 'resourceGroupId' => ['description' => 'The resource group ID.', 'type' => 'string', 'example' => 'rg-aekzvlxzgo5b4si', 'title' => ''],
+ 'tags' => [
+ 'description' => 'The tags.',
+ 'type' => 'array',
+ 'items' => [
+ 'description' => 'The tags.',
+ 'type' => 'object',
+ 'properties' => [
+ 'tagKey' => ['description' => 'The tag key.', 'type' => 'string', 'example' => 'a', 'title' => ''],
+ 'tagValue' => ['description' => 'The tag value.', 'type' => 'string', 'example' => 'c', 'title' => ''],
+ ],
+ 'title' => '',
+ 'example' => '',
+ ],
+ 'title' => '',
+ 'example' => '',
+ ],
+ 'type' => ['description' => 'The type.', 'type' => 'string', 'example' => 'standard', 'title' => ''],
+ 'apiToken' => ['description' => 'apiToken', 'type' => 'string', 'example' => 'apiToken', 'title' => ''],
+ ],
+ 'title' => '',
+ 'example' => '',
+ ],
+ 'title' => '',
+ 'example' => '',
+ ],
+ ],
+ 'example' => '',
+ ],
+ ],
+ ],
+ 'staticInfo' => ['returnType' => 'synchronous'],
+ 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"requestId\\": \\"33E4F0CA-F766-5803-B11C-70DC57A5A6E4\\",\\n \\"totalCount\\": 1,\\n \\"result\\": [\\n {\\n \\"chargeType\\": \\"POSTPAY\\",\\n \\"description\\": \\"22222\\",\\n \\"domainName\\": \\"default-xxx\\",\\n \\"engineType\\": \\"rag\\",\\n \\"id\\": \\"1222212\\",\\n \\"instanceId\\": \\"ops-cn-em93wcq0s001\\",\\n \\"name\\": \\"test\\",\\n \\"quota\\": {\\n \\"computeResource\\": 0,\\n \\"docSize\\": 0,\\n \\"spec\\": \\"rag.share.compute\\"\\n },\\n \\"resourceGroupId\\": \\"rg-aekzvlxzgo5b4si\\",\\n \\"tags\\": [\\n {\\n \\"tagKey\\": \\"a\\",\\n \\"tagValue\\": \\"c\\"\\n }\\n ],\\n \\"type\\": \\"standard\\",\\n \\"apiToken\\": \\"apiToken\\"\\n }\\n ]\\n}","type":"json"}]',
+ 'title' => 'Retrieve workspace list',
+ 'changeSet' => [],
+ 'ramActions' => [
+ [
+ 'operationType' => 'list',
+ 'ramAction' => [
+ 'action' => 'searchplat:ListWorkspaces',
+ 'authLevel' => 'resource',
+ 'actionConditions' => [],
+ 'resources' => [
+ ['validationType' => 'always', 'product' => 'SearchPlat', 'resourceType' => 'Workspace', 'arn' => 'acs:searchplat:{#regionId}:{#accountId}:workspaces/*'],
+ ],
+ ],
+ ],
+ ],
+ ],
+ 'ModifyOfflineTask' => [
+ 'summary' => 'Updates a batch task.',
+ 'path' => '/openapi/platform/workspaces/{workspaceName}/offline-tasks/{type}/{taskName}',
+ 'methods' => ['put'],
+ 'schemes' => ['https'],
+ 'security' => [
+ [
+ 'AK' => [],
+ ],
+ ],
+ 'consumes' => ['application/json'],
+ 'produces' => ['application/json'],
+ 'operationType' => 'write',
+ 'deprecated' => false,
+ 'systemTags' => [
+ 'operationType' => 'update',
+ 'riskType' => 'none',
+ 'chargeType' => 'free',
+ 'abilityTreeNodes' => ['FEATUREopensearch8B42ZS'],
+ 'tenantRelevance' => 'tenant',
+ ],
+ 'parameters' => [
+ [
+ 'name' => 'workspaceName',
+ 'in' => 'path',
+ 'schema' => ['description' => 'The workspace name.', 'type' => 'string', 'required' => false, 'example' => 'myWorkspace', 'title' => ''],
+ ],
+ [
+ 'name' => 'type',
+ 'in' => 'path',
+ 'schema' => ['description' => 'The task type.', 'type' => 'string', 'required' => false, 'example' => 'video', 'title' => ''],
+ ],
+ [
+ 'name' => 'taskName',
+ 'in' => 'path',
+ 'schema' => ['description' => 'The task name.', 'type' => 'string', 'required' => false, 'example' => 'syh', 'title' => ''],
+ ],
+ [
+ 'name' => 'dryRun',
+ 'in' => 'query',
+ 'schema' => ['description' => 'Specifies whether to validate the request parameters without performing the actual operation. Default value: false.'."\n"
+ ."\n"
+ .'Valid values:'."\n"
+ ."\n"
+ .'- **true**'."\n"
+ ."\n"
+ .'- **false**.', 'type' => 'boolean', 'required' => false, 'example' => 'true', 'title' => ''],
+ ],
+ [
+ 'name' => 'regionId',
+ 'in' => 'query',
+ 'schema' => ['title' => '', 'description' => 'The region ID.', 'type' => 'string', 'example' => 'cn-shanghai', 'required' => false],
+ ],
+ [
+ 'name' => 'body',
+ 'in' => 'body',
+ 'style' => 'json',
+ 'schema' => [
+ 'description' => 'The request body.',
+ 'type' => 'object',
+ 'properties' => [
+ 'meta' => [
+ 'description' => 'The task metadata.',
+ 'type' => 'object',
+ 'properties' => [
+ 'apiKey' => ['description' => 'The access credential.', 'type' => 'string', 'required' => false, 'example' => 'OS-xxx'."\n", 'title' => ''],
+ 'regionId' => ['description' => 'The region ID.', 'type' => 'string', 'required' => false, 'example' => 'cn-shanghai', 'title' => ''],
+ 'taskName' => ['description' => 'The task name.', 'type' => 'string', 'required' => false, 'example' => 'syh', 'title' => ''],
+ 'computeResource' => ['description' => 'The billing specification.', 'type' => 'string', 'required' => false, 'example' => 'small', 'title' => ''],
+ 'labels' => [
+ 'description' => 'The list of task labels.',
+ 'type' => 'array',
+ 'items' => ['description' => 'The label.', 'type' => 'string', 'required' => false, 'example' => 'aa', 'title' => ''],
+ 'required' => false,
+ 'title' => '',
+ 'example' => '',
+ ],
+ ],
+ 'required' => false,
+ 'title' => '',
+ 'example' => '',
+ ],
+ 'source' => [
+ 'description' => 'The data source information.',
+ 'type' => 'array',
+ 'items' => [
+ 'description' => 'The data source information.',
+ 'type' => 'object',
+ 'properties' => [
+ 'name' => ['description' => 'The data source name.', 'type' => 'string', 'required' => false, 'example' => 'tmp-exec-pop-eTcMpC', 'title' => ''],
+ 'type' => ['description' => 'The data source type.', 'type' => 'string', 'required' => false, 'example' => 'swift', 'title' => ''],
+ 'parameters' => [
+ 'description' => 'The datasource config parameters, which are determined by the type.',
+ 'type' => 'object',
+ 'required' => false,
+ 'additionalProperties' => ['type' => 'string', 'description' => '', 'title' => '', 'example' => ''],
+ 'title' => '',
+ 'example' => '',
+ ],
+ 'schema' => [
+ 'description' => 'The data source schema.',
+ 'type' => 'array',
+ 'items' => [
+ 'description' => 'The data source schema.',
+ 'type' => 'object',
+ 'required' => false,
+ 'additionalProperties' => ['type' => 'string', 'description' => '', 'title' => '', 'example' => ''],
+ 'title' => '',
+ 'example' => '',
+ ],
+ 'required' => false,
+ 'title' => '',
+ 'example' => '',
+ ],
+ 'primaryKey' => ['description' => 'The primary key field of the data source.', 'type' => 'string', 'required' => false, 'example' => 'id', 'title' => ''],
+ ],
+ 'required' => false,
+ 'title' => '',
+ 'example' => '',
+ ],
+ 'required' => false,
+ 'title' => '',
+ 'example' => '',
+ ],
+ 'sink' => [
+ 'description' => 'The data sink information.',
+ 'type' => 'array',
+ 'items' => [
+ 'description' => 'The data sink information.',
+ 'type' => 'object',
+ 'properties' => [
+ 'name' => ['description' => 'The data sink name.', 'type' => 'string', 'required' => false, 'example' => 'default', 'title' => ''],
+ 'type' => ['description' => 'The data sink type.', 'type' => 'string', 'required' => false, 'example' => 'swift', 'title' => ''],
+ 'parameters' => [
+ 'description' => 'The data sink configuration parameters, which are determined by the type.',
+ 'type' => 'object',
+ 'required' => false,
+ 'additionalProperties' => ['type' => 'string', 'description' => '', 'title' => '', 'example' => ''],
+ 'title' => '',
+ 'example' => '',
+ ],
+ 'schema' => [
+ 'description' => 'The data sink schema.',
+ 'type' => 'array',
+ 'items' => [
+ 'description' => 'The data sink schema.',
+ 'type' => 'object',
+ 'required' => false,
+ 'additionalProperties' => ['type' => 'string', 'description' => '', 'title' => '', 'example' => ''],
+ 'title' => '',
+ 'example' => '',
+ ],
+ 'required' => false,
+ 'title' => '',
+ 'example' => '',
+ ],
+ 'primaryKey' => ['description' => 'The primary key field of the data sink.', 'type' => 'string', 'required' => false, 'example' => 'id', 'title' => ''],
+ ],
+ 'required' => false,
+ 'title' => '',
+ 'example' => '',
+ ],
+ 'required' => false,
+ 'title' => '',
+ 'example' => '',
+ ],
+ 'processors' => [
+ 'description' => 'The processing flow operators.',
+ 'type' => 'array',
+ 'items' => [
+ 'description' => 'The processing flow operators.',
+ 'type' => 'object',
+ 'properties' => [
+ 'name' => ['description' => 'The name.', 'type' => 'string', 'required' => false, 'example' => 'processor1', 'title' => ''],
+ 'type' => ['description' => 'The type.', 'type' => 'string', 'required' => false, 'example' => 'document-analyze'."\n", 'title' => ''],
+ 'input' => ['description' => 'The input parameters.', 'type' => 'object', 'required' => false, 'title' => '', 'example' => ''],
+ 'parameters' => ['description' => 'The processor parameters.', 'type' => 'object', 'required' => false, 'example' => '{'."\n"
+ .' "service_id": "xxx"'."\n"
+ .'}', 'title' => ''],
+ 'output' => ['description' => 'The output parameters.', 'type' => 'object', 'required' => false, 'example' => '{'."\n"
+ .'"vector": "syh_image_uri_multi-modal-embedding"'."\n"
+ .'}', 'title' => ''],
+ ],
+ 'required' => false,
+ 'title' => '',
+ 'example' => '',
+ ],
+ 'required' => false,
+ 'title' => '',
+ 'example' => '',
+ ],
+ 'parameters' => ['description' => 'The task processing parameters.', 'type' => 'object', 'required' => false, 'example' => '{'."\n"
+ .' "parameter1": {'."\n"
+ .' "key": "value"'."\n"
+ .' },'."\n"
+ .' "parameter2": {'."\n"
+ .' "key": "value"'."\n"
+ .' }'."\n"
+ .'}', 'title' => ''],
+ 'status' => [
+ 'description' => 'The task status.',
+ 'type' => 'object',
+ 'properties' => [
+ 'status' => ['description' => 'The task status.', 'type' => 'string', 'required' => false, 'example' => 'RUNNING', 'title' => ''],
+ 'errorMessage' => ['description' => 'The error message.', 'type' => 'string', 'required' => false, 'example' => '“”', 'title' => ''],
+ 'createTime' => ['description' => 'The task start time.', 'type' => 'integer', 'format' => 'int64', 'required' => false, 'example' => '1744941600000', 'title' => ''],
+ 'deleteTime' => ['description' => 'The task stop time.', 'type' => 'integer', 'format' => 'int64', 'required' => false, 'example' => '1744941600000', 'title' => ''],
+ ],
+ 'required' => false,
+ 'title' => '',
+ 'example' => '',
+ ],
+ ],
+ 'required' => false,
+ 'example' => 'cn-shanghai',
+ 'title' => '',
+ ],
+ ],
+ ],
+ 'responses' => [
+ 200 => [
+ 'schema' => [
+ 'title' => '',
+ 'description' => 'Schema of Response',
+ 'type' => 'object',
+ 'properties' => [
+ 'requestId' => ['title' => '', 'description' => 'Id of the request', 'type' => 'string', 'example' => '0abb793917165176014887584e28d9'],
+ 'result' => [
+ 'description' => 'The returned result.',
+ 'type' => 'object',
+ 'properties' => [
+ 'meta' => [
+ 'description' => 'The metadata.',
+ 'type' => 'object',
+ 'properties' => [
+ 'taskName' => ['description' => 'The task name.', 'type' => 'string', 'example' => 'test', 'title' => ''],
+ 'computeResource' => ['description' => 'The billing specification.', 'type' => 'string', 'example' => 'small', 'title' => ''],
+ ],
+ 'title' => '',
+ 'example' => '',
+ ],
+ 'source' => [
+ 'description' => 'The data source information.',
+ 'type' => 'array',
+ 'items' => [
+ 'description' => 'The data source information.',
+ 'type' => 'object',
+ 'properties' => [
+ 'name' => ['description' => 'The data source name.', 'type' => 'string', 'example' => 'table1'."\n", 'title' => ''],
+ 'type' => ['description' => 'The data source type.', 'type' => 'string', 'example' => 'swift', 'title' => ''],
+ 'parameters' => [
+ 'description' => 'The datasource config parameters, which are determined by the type.',
+ 'type' => 'object',
+ 'additionalProperties' => ['description' => '数据源配置参数名称', 'type' => 'string', 'example' => 'name', 'title' => ''],
+ 'title' => '',
+ 'example' => '',
+ ],
+ 'schema' => [
+ 'description' => 'The data source schema.',
+ 'type' => 'array',
+ 'items' => [
+ 'description' => 'The data source schema.',
+ 'type' => 'object',
+ 'additionalProperties' => ['description' => '数据源Schema字段名称', 'type' => 'string', 'example' => 'name', 'title' => ''],
+ 'title' => '',
+ 'example' => '',
+ ],
+ 'title' => '',
+ 'example' => '',
+ ],
+ 'primaryKey' => ['description' => 'The primary key field of the data source.', 'type' => 'string', 'example' => 'id', 'title' => ''],
+ ],
+ 'title' => '',
+ 'example' => '',
+ ],
+ 'title' => '',
+ 'example' => '',
+ ],
+ 'sink' => [
+ 'description' => 'The data sink information.',
+ 'type' => 'array',
+ 'items' => [
+ 'description' => 'The data sink information.',
+ 'type' => 'object',
+ 'properties' => [
+ 'name' => ['description' => 'The data sink name.', 'type' => 'string', 'example' => 'table2', 'title' => ''],
+ 'type' => ['description' => 'The data sink type.', 'type' => 'string', 'example' => 'swift', 'title' => ''],
+ 'parameters' => [
+ 'description' => 'The data sink configuration parameters, which are determined by the type.',
+ 'type' => 'object',
+ 'additionalProperties' => ['description' => '数据汇配置参数名称', 'type' => 'string', 'example' => 'key1', 'title' => ''],
+ 'title' => '',
+ 'example' => '',
+ ],
+ 'schema' => [
+ 'description' => 'The data sink schema.',
+ 'type' => 'array',
+ 'items' => [
+ 'description' => 'The data sink schema.',
+ 'type' => 'object',
+ 'additionalProperties' => ['description' => '数据汇Schema字段名称', 'type' => 'string', 'example' => 'name', 'title' => ''],
+ 'title' => '',
+ 'example' => '',
+ ],
+ 'title' => '',
+ 'example' => '',
+ ],
+ 'primaryKey' => ['description' => 'The primary key field of the data sink.', 'type' => 'string', 'example' => 'id', 'title' => ''],
+ ],
+ 'title' => '',
+ 'example' => '',
+ ],
+ 'title' => '',
+ 'example' => '',
+ ],
+ 'processors' => [
+ 'description' => 'The processing flow operators.',
+ 'type' => 'array',
+ 'items' => [
+ 'description' => 'The processing flow operators.',
+ 'type' => 'object',
+ 'properties' => [
+ 'name' => ['description' => 'The name.', 'type' => 'string', 'example' => 'processor1', 'title' => ''],
+ 'type' => ['description' => 'The type.', 'type' => 'string', 'example' => 'document-analyze'."\n", 'title' => ''],
+ 'input' => ['description' => 'The input parameters.', 'type' => 'object', 'example' => '{'."\n"
+ .' "key": "content"'."\n"
+ .'}'."\n", 'title' => ''],
+ 'parameters' => ['description' => 'The processor parameters.', 'type' => 'object', 'example' => '{'."\n"
+ .'"parameter1": {'."\n"
+ .'"key": "value"'."\n"
+ .'},'."\n"
+ .'"parameter2": {'."\n"
+ .'"key": "value"'."\n"
+ .'}'."\n"
+ .'}', 'title' => ''],
+ ],
+ 'title' => '',
+ 'example' => '',
+ ],
+ 'title' => '',
+ 'example' => '',
+ ],
+ 'parameters' => ['description' => 'The task processing parameters.', 'type' => 'object', 'example' => '{'."\n"
+ .'"parameter1": {'."\n"
+ .'"key": "value"'."\n"
+ .'},'."\n"
+ .'"parameter2": {'."\n"
+ .'"key": "value"'."\n"
+ .'}'."\n"
+ .'}', 'title' => ''],
+ 'status' => [
+ 'description' => 'The task status.',
+ 'type' => 'object',
+ 'properties' => [
+ 'status' => ['description' => 'The task status.', 'type' => 'string', 'example' => 'RUNNING', 'title' => ''],
+ 'createTime' => ['description' => 'The task start time.', 'type' => 'string', 'example' => '1744941600000', 'title' => ''],
+ 'deleteTime' => ['description' => 'The task stop time.', 'type' => 'string', 'example' => '1744941600000', 'title' => ''],
+ 'errorMessage' => ['description' => 'The error message.', 'type' => 'string', 'example' => '""', 'title' => ''],
+ ],
+ 'title' => '',
+ 'example' => '',
+ ],
+ ],
+ 'title' => '',
+ 'example' => '',
+ ],
+ ],
+ 'example' => '',
+ ],
+ ],
+ ],
+ 'staticInfo' => ['returnType' => 'synchronous'],
+ 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"requestId\\": \\"0abb793917165176014887584e28d9\\",\\n \\"result\\": {\\n \\"meta\\": {\\n \\"taskName\\": \\"test\\",\\n \\"computeResource\\": \\"small\\"\\n },\\n \\"source\\": [\\n {\\n \\"name\\": \\"table1\\\\n\\",\\n \\"type\\": \\"swift\\",\\n \\"parameters\\": {\\n \\"key\\": \\"name\\"\\n },\\n \\"schema\\": [\\n {\\n \\"key\\": \\"name\\"\\n }\\n ],\\n \\"primaryKey\\": \\"id\\"\\n }\\n ],\\n \\"sink\\": [\\n {\\n \\"name\\": \\"table2\\",\\n \\"type\\": \\"swift\\",\\n \\"parameters\\": {\\n \\"key\\": \\"key1\\"\\n },\\n \\"schema\\": [\\n {\\n \\"key\\": \\"name\\"\\n }\\n ],\\n \\"primaryKey\\": \\"id\\"\\n }\\n ],\\n \\"processors\\": [\\n {\\n \\"name\\": \\"processor1\\",\\n \\"type\\": \\"document-analyze\\\\n\\",\\n \\"input\\": {\\n \\"key\\": \\"content\\"\\n },\\n \\"parameters\\": {\\n \\"parameter1\\": {\\n \\"key\\": \\"value\\"\\n },\\n \\"parameter2\\": {\\n \\"key\\": \\"value\\"\\n }\\n }\\n }\\n ],\\n \\"parameters\\": {\\n \\"parameter1\\": {\\n \\"key\\": \\"value\\"\\n },\\n \\"parameter2\\": {\\n \\"key\\": \\"value\\"\\n }\\n },\\n \\"status\\": {\\n \\"status\\": \\"RUNNING\\",\\n \\"createTime\\": \\"1744941600000\\",\\n \\"deleteTime\\": \\"1744941600000\\",\\n \\"errorMessage\\": \\"\\\\\\"\\\\\\"\\"\\n }\\n }\\n}","type":"json"}]',
+ 'title' => 'Update a batch task',
+ 'changeSet' => [
+ ['createdAt' => '2025-12-02T07:12:30.000Z', 'description' => 'Request parameters changed'],
+ ],
+ 'ramActions' => [
+ [
+ 'operationType' => 'update',
+ 'ramAction' => [
+ 'action' => 'searchplat:ModifyOfflineTask',
+ 'authLevel' => 'operate',
+ 'actionConditions' => [],
+ 'resources' => [
+ ['validationType' => 'always', 'product' => 'SearchPlat', 'resourceType' => 'All Resource', 'arn' => '*'],
+ ],
+ ],
+ ],
+ ],
+ ],
+ 'ResumeFunctionInstance' => [
+ 'summary' => 'Restarts the service.',
+ 'path' => '/openapi/platform/workspaces/{workspaceName}/functions/{functionName}/instances/{instanceName}/actions/resume',
+ 'methods' => ['post'],
+ 'schemes' => ['https'],
+ 'security' => [
+ [
+ 'AK' => [],
+ ],
+ ],
+ 'consumes' => ['application/json'],
+ 'produces' => ['application/json'],
+ 'operationType' => 'write',
+ 'deprecated' => false,
+ 'systemTags' => [
+ 'operationType' => 'none',
+ 'riskType' => 'none',
+ 'chargeType' => 'free',
+ 'abilityTreeCode' => '239782',
+ 'abilityTreeNodes' => ['FEATUREopensearchJK5SO0'],
+ 'autoTest' => true,
+ 'tenantRelevance' => 'tenant',
+ ],
+ 'parameters' => [
+ [
+ 'name' => 'workspaceName',
+ 'in' => 'path',
+ 'schema' => ['title' => '', 'description' => 'The workspace name.', 'type' => 'string', 'required' => true, 'example' => 'default'],
+ ],
+ [
+ 'name' => 'functionName',
+ 'in' => 'path',
+ 'schema' => ['title' => '', 'description' => 'The service type.', 'type' => 'string', 'required' => true, 'example' => 'notebook'],
+ ],
+ [
+ 'name' => 'instanceName',
+ 'in' => 'path',
+ 'schema' => ['title' => '', 'description' => 'The notebook name.', 'type' => 'string', 'required' => true, 'example' => 'test_notebook'],
+ ],
+ ],
+ 'responses' => [
+ 200 => [
+ 'schema' => [
+ 'title' => '',
+ 'description' => 'Schema of Response',
+ 'type' => 'object',
+ 'properties' => [
+ 'status' => ['description' => 'The request status.', 'type' => 'string', 'example' => 'OK', 'title' => ''],
+ 'httpCode' => ['description' => 'The HTTP status code.', 'type' => 'integer', 'format' => 'int64', 'example' => '200', 'title' => ''],
+ 'requestId' => ['description' => 'The request ID.', 'type' => 'string', 'example' => '5950143C-B8F0-5758-A08A-66F302FD587F', 'title' => ''],
+ 'message' => ['title' => '', 'description' => 'The error message.', 'type' => 'string', 'example' => '"xx not found"'],
+ 'code' => ['title' => '', 'description' => 'The error code.', 'type' => 'string', 'example' => 'not found'],
+ 'latency' => ['title' => '', 'description' => 'The time consumed, in milliseconds.', 'type' => 'integer', 'format' => 'int64', 'example' => '145.411'],
+ ],
+ 'example' => '',
+ ],
+ ],
+ ],
+ 'staticInfo' => ['returnType' => 'synchronous'],
+ 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"status\\": \\"OK\\",\\n \\"httpCode\\": 200,\\n \\"requestId\\": \\"5950143C-B8F0-5758-A08A-66F302FD587F\\",\\n \\"message\\": \\"\\\\\\"xx not found\\\\\\"\\",\\n \\"code\\": \\"not found\\",\\n \\"latency\\": 145.411\\n}","type":"json"}]',
+ 'title' => 'Start notebook service',
+ 'changeSet' => [],
+ 'ramActions' => [
+ [
+ 'operationType' => 'none',
+ 'ramAction' => [
+ 'action' => 'searchplat:ResumeFunctionInstance',
+ 'authLevel' => 'operate',
+ 'actionConditions' => [],
+ 'resources' => [
+ ['validationType' => 'always', 'product' => 'SearchPlat', 'resourceType' => 'All Resource', 'arn' => '*'],
+ ],
+ ],
+ ],
+ ],
+ ],
+ 'StartOfflineTask' => [
+ 'summary' => 'Starts a batch task.',
+ 'path' => '/openapi/platform/workspaces/{workspaceName}/offline-tasks/{type}/{taskName}/actions/start',
+ 'methods' => ['post'],
+ 'schemes' => ['https'],
+ 'security' => [
+ [
+ 'AK' => [],
+ ],
+ ],
+ 'consumes' => ['application/json'],
+ 'produces' => ['application/json'],
+ 'operationType' => 'write',
+ 'deprecated' => false,
+ 'systemTags' => [
+ 'operationType' => 'none',
+ 'riskType' => 'none',
+ 'chargeType' => 'free',
+ 'abilityTreeNodes' => ['FEATUREopensearch8B42ZS'],
+ 'tenantRelevance' => 'tenant',
+ ],
+ 'parameters' => [
+ [
+ 'name' => 'workspaceName',
+ 'in' => 'path',
+ 'schema' => ['description' => 'The workspace name.', 'type' => 'string', 'required' => false, 'example' => 'myWorkspace', 'title' => ''],
+ ],
+ [
+ 'name' => 'type',
+ 'in' => 'path',
+ 'schema' => ['description' => 'The type.', 'type' => 'string', 'required' => false, 'example' => 'video', 'title' => ''],
+ ],
+ [
+ 'name' => 'taskName',
+ 'in' => 'path',
+ 'schema' => ['description' => 'The task name.', 'type' => 'string', 'required' => false, 'example' => 'taskName', 'title' => ''],
+ ],
+ [
+ 'name' => 'regionId',
+ 'in' => 'query',
+ 'schema' => ['title' => '', 'description' => 'The region ID.', 'type' => 'string', 'example' => 'cn-shanghai', 'required' => false],
+ ],
+ [
+ 'name' => 'body',
+ 'in' => 'body',
+ 'style' => 'json',
+ 'schema' => [
+ 'description' => 'The request body.',
+ 'type' => 'object',
+ 'properties' => [
+ 'timestamp' => ['description' => 'The start offset.', 'type' => 'integer', 'format' => 'int64', 'required' => false, 'example' => '1747900639', 'title' => ''],
+ 'parallelism' => ['description' => 'The degree of task parallelism.', 'type' => 'integer', 'format' => 'int32', 'required' => false, 'example' => '4', 'title' => ''],
+ ],
+ 'required' => false,
+ 'example' => 'cn-shanghai',
+ 'title' => '',
+ ],
+ ],
+ ],
+ 'responses' => [
+ 200 => [
+ 'schema' => [
+ 'title' => '',
+ 'description' => 'Schema of Response',
+ 'type' => 'object',
+ 'properties' => [
+ 'requestId' => ['title' => '', 'description' => 'Id of the request', 'type' => 'string', 'example' => '1CC93E65-6734-5060-BEF7-0EB0A4862BCF'],
+ 'result' => [
+ 'description' => 'The returned result.',
+ 'type' => 'object',
+ 'properties' => [
+ 'meta' => [
+ 'description' => 'The metadata.',
+ 'type' => 'object',
+ 'properties' => [
+ 'computeResource' => ['description' => 'The billing specification.', 'type' => 'string', 'example' => 'small', 'title' => ''],
+ 'taskName' => ['description' => 'The task name.', 'type' => 'string', 'example' => 'taskName', 'title' => ''],
+ ],
+ 'title' => '',
+ 'example' => '',
+ ],
+ 'parameters' => ['description' => 'The task processing parameters.', 'type' => 'object', 'example' => '{'."\n"
+ .' "parameter1": {'."\n"
+ .' "key": "value"'."\n"
+ .' },'."\n"
+ .' "parameter2": {'."\n"
+ .' "key": "value"'."\n"
+ .' }'."\n"
+ .'}', 'title' => ''],
+ 'processors' => [
+ 'description' => 'The processing operators.',
+ 'type' => 'array',
+ 'items' => [
+ 'description' => 'The processing operators.',
+ 'type' => 'object',
+ 'properties' => [
+ 'input' => ['description' => 'The input parameters.', 'type' => 'object', 'example' => '{'."\n"
+ .' "key": "content"'."\n"
+ .'}', 'title' => ''],
+ 'name' => ['description' => 'The data source name.', 'type' => 'string', 'example' => 'processor1', 'title' => ''],
+ 'parameters' => ['description' => 'The processor processing parameters.', 'type' => 'object', 'example' => '{'."\n"
+ .' "service_id": "xxx"'."\n"
+ .'}', 'title' => ''],
+ 'type' => ['description' => 'The data sink type.', 'type' => 'string', 'example' => 'document-analyze'."\n", 'title' => ''],
+ ],
+ 'title' => '',
+ 'example' => '',
+ ],
+ 'title' => '',
+ 'example' => '',
+ ],
+ 'sink' => [
+ 'description' => 'The data sink information.',
+ 'type' => 'array',
+ 'items' => [
+ 'description' => 'The data sink information.',
+ 'type' => 'object',
+ 'properties' => [
+ 'name' => ['description' => 'The task name.', 'type' => 'string', 'example' => 'milvus-ali-cn-hangzhou-1', 'title' => ''],
+ 'parameters' => [
+ 'description' => 'The data sink configuration parameters, which are determined by the type.',
+ 'type' => 'object',
+ 'additionalProperties' => ['description' => 'The key is of the String type.', 'type' => 'string', 'example' => '{'."\n"
+ .' "key1": "value1",'."\n"
+ .' "key2": "value2"'."\n"
+ .'}', 'title' => ''],
+ 'title' => '',
+ 'example' => '',
+ ],
+ 'primaryKey' => ['description' => 'The primary key field of the data sink.', 'type' => 'string', 'example' => 'id', 'title' => ''],
+ 'schema' => [
+ 'description' => 'The data sink schema.',
+ 'type' => 'array',
+ 'items' => [
+ 'description' => 'The data source schema.',
+ 'type' => 'object',
+ 'additionalProperties' => ['description' => 'The key is of the String type.', 'type' => 'string', 'example' => ' {'."\n"
+ .' "name": "id",'."\n"
+ .' "type": "string"'."\n"
+ .'}'."\n", 'title' => ''],
+ 'title' => '',
+ 'example' => '',
+ ],
+ 'title' => '',
+ 'example' => '',
+ ],
+ 'type' => ['description' => 'The type. Valid values:'."\n"
+ .'- standard.', 'type' => 'string', 'example' => 'ModuleRelation', 'title' => ''],
+ ],
+ 'title' => '',
+ 'example' => '',
+ ],
+ 'title' => '',
+ 'example' => '',
+ ],
+ 'source' => [
+ 'description' => 'The source.',
+ 'type' => 'array',
+ 'items' => [
+ 'description' => 'The source.',
+ 'type' => 'object',
+ 'properties' => [
+ 'name' => ['description' => 'The data source name.', 'type' => 'string', 'example' => 'table1', 'title' => ''],
+ 'parameters' => [
+ 'description' => 'The datasource config parameters, which are determined by the type.',
+ 'type' => 'object',
+ 'additionalProperties' => ['description' => 'The key is of the String type.', 'type' => 'string', 'example' => '{'."\n"
+ .' "key1": "value1",'."\n"
+ .' "key2": "value2"'."\n"
+ .'}', 'title' => ''],
+ 'title' => '',
+ 'example' => '',
+ ],
+ 'primaryKey' => ['description' => 'The primary key field of the data source.', 'type' => 'string', 'example' => 'id', 'title' => ''],
+ 'schema' => [
+ 'description' => 'The data source schema.',
+ 'type' => 'array',
+ 'items' => [
+ 'description' => 'The data source schema.',
+ 'type' => 'object',
+ 'additionalProperties' => ['description' => 'The key is of the String type.', 'type' => 'string', 'example' => ' {'."\n"
+ .' "name": "id",'."\n"
+ .' "type": "string"'."\n"
+ .'}', 'title' => ''],
+ 'title' => '',
+ 'example' => '',
+ ],
+ 'title' => '',
+ 'example' => '',
+ ],
+ 'type' => ['description' => 'The data source type.', 'type' => 'string', 'example' => 'swift', 'title' => ''],
+ ],
+ 'title' => '',
+ 'example' => '',
+ ],
+ 'title' => '',
+ 'example' => '',
+ ],
+ 'status' => [
+ 'description' => 'The task status. Valid values:'."\n"
+ .'- PENDING: In progress.'."\n"
+ .'- SUCCESS: Parsing succeeded.'."\n"
+ .'- FAILED: Parsing failed.',
+ 'type' => 'object',
+ 'properties' => [
+ 'createTime' => ['description' => 'The task start time.', 'type' => 'integer', 'format' => 'int64', 'example' => '1744941600000', 'title' => ''],
+ 'deleteTime' => ['description' => 'The task stop time.', 'type' => 'integer', 'format' => 'int64', 'example' => '1744941600000', 'title' => ''],
+ 'errorMessage' => ['description' => 'The error message.', 'type' => 'string', 'example' => '""', 'title' => ''],
+ 'status' => ['description' => 'The request status.', 'type' => 'string', 'example' => 'OK', 'title' => ''],
+ ],
+ 'title' => '',
+ 'example' => '',
+ ],
+ ],
+ 'title' => '',
+ 'example' => '',
+ ],
+ ],
+ 'example' => '',
+ ],
+ ],
+ ],
+ 'staticInfo' => ['returnType' => 'synchronous'],
+ 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"requestId\\": \\"1CC93E65-6734-5060-BEF7-0EB0A4862BCF\\",\\n \\"result\\": {\\n \\"meta\\": {\\n \\"computeResource\\": \\"small\\",\\n \\"taskName\\": \\"taskName\\"\\n },\\n \\"parameters\\": {\\n \\"parameter1\\": {\\n \\"key\\": \\"value\\"\\n },\\n \\"parameter2\\": {\\n \\"key\\": \\"value\\"\\n }\\n },\\n \\"processors\\": [\\n {\\n \\"input\\": {\\n \\"key\\": \\"content\\"\\n },\\n \\"name\\": \\"processor1\\",\\n \\"parameters\\": {\\n \\"service_id\\": \\"xxx\\"\\n },\\n \\"type\\": \\"document-analyze\\\\n\\"\\n }\\n ],\\n \\"sink\\": [\\n {\\n \\"name\\": \\"milvus-ali-cn-hangzhou-1\\",\\n \\"parameters\\": {\\n \\"key\\": \\"{\\\\n \\\\\\"key1\\\\\\": \\\\\\"value1\\\\\\",\\\\n \\\\\\"key2\\\\\\": \\\\\\"value2\\\\\\"\\\\n}\\"\\n },\\n \\"primaryKey\\": \\"id\\",\\n \\"schema\\": [\\n {\\n \\"key\\": \\" {\\\\n \\\\\\"name\\\\\\": \\\\\\"id\\\\\\",\\\\n \\\\\\"type\\\\\\": \\\\\\"string\\\\\\"\\\\n}\\\\n\\"\\n }\\n ],\\n \\"type\\": \\"ModuleRelation\\"\\n }\\n ],\\n \\"source\\": [\\n {\\n \\"name\\": \\"table1\\",\\n \\"parameters\\": {\\n \\"key\\": \\"{\\\\n \\\\\\"key1\\\\\\": \\\\\\"value1\\\\\\",\\\\n \\\\\\"key2\\\\\\": \\\\\\"value2\\\\\\"\\\\n}\\"\\n },\\n \\"primaryKey\\": \\"id\\",\\n \\"schema\\": [\\n {\\n \\"key\\": \\" {\\\\n \\\\\\"name\\\\\\": \\\\\\"id\\\\\\",\\\\n \\\\\\"type\\\\\\": \\\\\\"string\\\\\\"\\\\n}\\"\\n }\\n ],\\n \\"type\\": \\"swift\\"\\n }\\n ],\\n \\"status\\": {\\n \\"createTime\\": 1744941600000,\\n \\"deleteTime\\": 1744941600000,\\n \\"errorMessage\\": \\"\\\\\\"\\\\\\"\\",\\n \\"status\\": \\"OK\\"\\n }\\n }\\n}","type":"json"}]',
+ 'title' => 'Start a batch task',
+ 'description' => '## Operation description.',
+ 'changeSet' => [
+ ['createdAt' => '2025-12-02T07:12:30.000Z', 'description' => 'Request parameters changed'],
+ ],
+ 'ramActions' => [
+ [
+ 'operationType' => 'none',
+ 'ramAction' => [
+ 'action' => 'searchplat:StartOfflineTask',
+ 'authLevel' => 'operate',
+ 'actionConditions' => [],
+ 'resources' => [
+ ['validationType' => 'always', 'product' => 'SearchPlat', 'resourceType' => 'All Resource', 'arn' => '*'],
+ ],
+ ],
+ ],
+ ],
+ ],
+ 'StopOfflineTask' => [
+ 'summary' => 'Stops a batch task.',
+ 'path' => '/openapi/platform/workspaces/{workspaceName}/offline-tasks/{type}/{taskName}/actions/stop',
+ 'methods' => ['post'],
+ 'schemes' => ['https'],
+ 'security' => [
+ [
+ 'AK' => [],
+ ],
+ ],
+ 'consumes' => ['application/json'],
+ 'produces' => ['application/json'],
+ 'operationType' => 'write',
+ 'deprecated' => false,
+ 'systemTags' => [
+ 'operationType' => 'none',
+ 'riskType' => 'none',
+ 'chargeType' => 'free',
+ 'abilityTreeNodes' => ['FEATUREopensearch8B42ZS'],
+ 'tenantRelevance' => 'tenant',
+ ],
+ 'parameters' => [
+ [
+ 'name' => 'workspaceName',
+ 'in' => 'path',
+ 'schema' => ['description' => 'The name of the workspace.', 'type' => 'string', 'required' => false, 'example' => 'default', 'title' => ''],
+ ],
+ [
+ 'name' => 'type',
+ 'in' => 'path',
+ 'schema' => ['description' => 'The type of the node.', 'type' => 'string', 'required' => false, 'example' => 'video', 'title' => ''],
+ ],
+ [
+ 'name' => 'taskName',
+ 'in' => 'path',
+ 'schema' => ['description' => 'The name of the node.', 'type' => 'string', 'required' => false, 'example' => 'taskName'."\n", 'title' => ''],
+ ],
+ [
+ 'name' => 'regionId',
+ 'in' => 'query',
+ 'schema' => ['title' => '', 'description' => 'The region ID.', 'type' => 'string', 'example' => 'cn-shanghai', 'required' => false],
+ ],
+ [
+ 'name' => 'body',
+ 'in' => 'body',
+ 'style' => 'json',
+ 'schema' => [
+ 'description' => 'The request body.',
+ 'type' => 'object',
+ 'properties' => [
+ 'timestamp' => ['description' => 'The start offset.', 'type' => 'integer', 'format' => 'int64', 'required' => false, 'example' => '1747900639', 'title' => ''],
+ 'parallelism' => ['description' => 'The parallelism of the node.', 'type' => 'integer', 'format' => 'int32', 'required' => false, 'example' => '2', 'title' => ''],
+ ],
+ 'required' => false,
+ 'example' => 'cn-shanghai',
+ 'title' => '',
+ ],
+ ],
+ ],
+ 'responses' => [
+ 200 => [
+ 'schema' => [
+ 'title' => '',
+ 'description' => 'Schema of Response',
+ 'type' => 'object',
+ 'properties' => [
+ 'requestId' => ['title' => '', 'description' => 'Id of the request', 'type' => 'string', 'example' => '5D56E988-A189-53A4-A0A6-C8D744B59775'],
+ 'result' => [
+ 'description' => 'The returned result.',
+ 'type' => 'object',
+ 'properties' => [
+ 'meta' => [
+ 'description' => 'The metadata.',
+ 'type' => 'object',
+ 'properties' => [
+ 'computeResource' => ['description' => 'The billing specification.', 'type' => 'string', 'example' => 'small', 'title' => ''],
+ 'taskName' => ['description' => 'The name of the node.', 'type' => 'string', 'example' => 'test', 'title' => ''],
+ ],
+ 'title' => '',
+ 'example' => '',
+ ],
+ 'parameters' => ['description' => 'The node processing parameters.', 'type' => 'object', 'example' => '{'."\n"
+ .'"parameter1": {'."\n"
+ .'"key": "value"'."\n"
+ .'},'."\n"
+ .'"parameter2": {'."\n"
+ .'"key": "value"'."\n"
+ .'}'."\n"
+ .'}', 'title' => ''],
+ 'processors' => [
+ 'description' => 'The processing flow operators.',
+ 'type' => 'array',
+ 'items' => [
+ 'description' => 'The processing flow operators.',
+ 'type' => 'object',
+ 'properties' => [
+ 'input' => ['description' => 'The input parameters.', 'type' => 'object', 'example' => '{'."\n"
+ .' "key": "content"'."\n"
+ .'}'."\n", 'title' => ''],
+ 'name' => ['description' => 'The name.', 'type' => 'string', 'example' => '"processor1"', 'title' => ''],
+ 'parameters' => ['description' => 'The processor processing parameters.', 'type' => 'object', 'example' => '{'."\n"
+ .' "service_id": "xxx"'."\n"
+ .'}', 'title' => ''],
+ 'type' => ['description' => 'The type.', 'type' => 'string', 'example' => 'document-analyze'."\n", 'title' => ''],
+ ],
+ 'title' => '',
+ 'example' => '',
+ ],
+ 'title' => '',
+ 'example' => '',
+ ],
+ 'sink' => [
+ 'description' => 'The data sink information.',
+ 'type' => 'array',
+ 'items' => [
+ 'description' => 'The data sink information.',
+ 'type' => 'object',
+ 'properties' => [
+ 'name' => ['description' => 'The name of the data sink.', 'type' => 'string', 'example' => 'table2', 'title' => ''],
+ 'parameters' => [
+ 'description' => 'The configuration parameters of the data sink.',
+ 'type' => 'object',
+ 'additionalProperties' => ['description' => '数据汇配置参数字段名称', 'type' => 'string', 'example' => '{\'region\': \'cn-hangzhou\', \'vpcId\': \'vpc-bp12kyzi7pekju2vplskx\', \'functionName\': \'filemgr-cn-hangzhou-002a94807f\', \'mountPointsServerAddr\': \'002a94807f-xrh81.cn-hangzhou.nas.aliyuncs.com\'}', 'title' => ''],
+ 'title' => '',
+ 'example' => '',
+ ],
+ 'primaryKey' => ['description' => 'The primary key field of the data sink.', 'type' => 'string', 'example' => 'id', 'title' => ''],
+ 'schema' => [
+ 'description' => 'The schema of the data sink.',
+ 'type' => 'array',
+ 'items' => [
+ 'description' => 'The schema of the data sink.',
+ 'type' => 'object',
+ 'additionalProperties' => ['description' => '数据汇Schema字段', 'type' => 'string', 'example' => 'id', 'title' => ''],
+ 'title' => '',
+ 'example' => '',
+ ],
+ 'title' => '',
+ 'example' => '',
+ ],
+ 'type' => ['description' => 'The type of the data sink.', 'type' => 'string', 'example' => 'swift', 'title' => ''],
+ ],
+ 'title' => '',
+ 'example' => '',
+ ],
+ 'title' => '',
+ 'example' => '',
+ ],
+ 'source' => [
+ 'description' => 'The data source information.',
+ 'type' => 'array',
+ 'items' => [
+ 'description' => 'The data source information.',
+ 'type' => 'object',
+ 'properties' => [
+ 'name' => ['description' => 'The name of the data source.', 'type' => 'string', 'example' => 'table1'."\n", 'title' => ''],
+ 'parameters' => [
+ 'description' => 'The datasource config parameters.',
+ 'type' => 'object',
+ 'additionalProperties' => ['description' => '数据源配置参数字段名称', 'type' => 'string', 'example' => 'key1', 'title' => ''],
+ 'title' => '',
+ 'example' => '',
+ ],
+ 'primaryKey' => ['description' => 'The primary key field of the data source.', 'type' => 'string', 'example' => 'id', 'title' => ''],
+ 'schema' => [
+ 'description' => 'The schema of the data source.',
+ 'type' => 'array',
+ 'items' => [
+ 'description' => 'The schema of the data source.',
+ 'type' => 'object',
+ 'additionalProperties' => ['description' => '数据源Schema字段', 'type' => 'string', 'example' => 'tableName', 'title' => ''],
+ 'title' => '',
+ 'example' => '',
+ ],
+ 'title' => '',
+ 'example' => '',
+ ],
+ 'type' => ['description' => 'The type of the data source.', 'type' => 'string', 'example' => 'swift', 'title' => ''],
+ ],
+ 'title' => '',
+ 'example' => '',
+ ],
+ 'title' => '',
+ 'example' => '',
+ ],
+ 'status' => [
+ 'description' => 'The node status.',
+ 'type' => 'object',
+ 'properties' => [
+ 'createTime' => ['description' => 'The time when the node was started.', 'type' => 'integer', 'format' => 'int64', 'example' => '1744941600000', 'title' => ''],
+ 'deleteTime' => ['description' => 'The time when the node was stopped.', 'type' => 'integer', 'format' => 'int64', 'example' => '1744941600000', 'title' => ''],
+ 'errorMessage' => ['description' => 'The error message.', 'type' => 'string', 'example' => '""', 'title' => ''],
+ 'status' => ['description' => 'The node status.', 'type' => 'string', 'example' => 'RUNNING', 'title' => ''],
+ ],
+ 'title' => '',
+ 'example' => '',
+ ],
+ ],
+ 'title' => '',
+ 'example' => '',
+ ],
+ ],
+ 'example' => '',
+ ],
+ ],
+ ],
+ 'staticInfo' => ['returnType' => 'synchronous'],
+ 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"requestId\\": \\"5D56E988-A189-53A4-A0A6-C8D744B59775\\",\\n \\"result\\": {\\n \\"meta\\": {\\n \\"computeResource\\": \\"small\\",\\n \\"taskName\\": \\"test\\"\\n },\\n \\"parameters\\": {\\n \\"parameter1\\": {\\n \\"key\\": \\"value\\"\\n },\\n \\"parameter2\\": {\\n \\"key\\": \\"value\\"\\n }\\n },\\n \\"processors\\": [\\n {\\n \\"input\\": {\\n \\"key\\": \\"content\\"\\n },\\n \\"name\\": \\"\\\\\\"processor1\\\\\\"\\",\\n \\"parameters\\": {\\n \\"service_id\\": \\"xxx\\"\\n },\\n \\"type\\": \\"document-analyze\\\\n\\"\\n }\\n ],\\n \\"sink\\": [\\n {\\n \\"name\\": \\"table2\\",\\n \\"parameters\\": {\\n \\"key\\": \\"{\'region\': \'cn-hangzhou\', \'vpcId\': \'vpc-bp12kyzi7pekju2vplskx\', \'functionName\': \'filemgr-cn-hangzhou-002a94807f\', \'mountPointsServerAddr\': \'002a94807f-xrh81.cn-hangzhou.nas.aliyuncs.com\'}\\"\\n },\\n \\"primaryKey\\": \\"id\\",\\n \\"schema\\": [\\n {\\n \\"key\\": \\"id\\"\\n }\\n ],\\n \\"type\\": \\"swift\\"\\n }\\n ],\\n \\"source\\": [\\n {\\n \\"name\\": \\"table1\\\\n\\",\\n \\"parameters\\": {\\n \\"key\\": \\"key1\\"\\n },\\n \\"primaryKey\\": \\"id\\",\\n \\"schema\\": [\\n {\\n \\"key\\": \\"tableName\\"\\n }\\n ],\\n \\"type\\": \\"swift\\"\\n }\\n ],\\n \\"status\\": {\\n \\"createTime\\": 1744941600000,\\n \\"deleteTime\\": 1744941600000,\\n \\"errorMessage\\": \\"\\\\\\"\\\\\\"\\",\\n \\"status\\": \\"RUNNING\\"\\n }\\n }\\n}","type":"json"}]',
+ 'title' => 'Stop a batch task',
+ 'changeSet' => [
+ ['createdAt' => '2025-12-02T07:12:30.000Z', 'description' => 'Request parameters changed'],
+ ],
+ 'ramActions' => [
+ [
+ 'operationType' => 'none',
+ 'ramAction' => [
+ 'action' => 'searchplat:StopOfflineTask',
+ 'authLevel' => 'operate',
+ 'actionConditions' => [],
+ 'resources' => [
+ ['validationType' => 'always', 'product' => 'SearchPlat', 'resourceType' => 'All Resource', 'arn' => '*'],
+ ],
+ ],
+ ],
+ ],
+ ],
+ 'UpdateCapability' => [
+ 'summary' => 'Updates a specific configuration item in a specified workspace.',
+ 'path' => '/openapi/platform/workspaces/{workspaceName}/capabilities/{itemCategory}/items/{itemName}',
+ 'methods' => ['put'],
+ 'schemes' => ['https'],
+ 'security' => [
+ [
+ 'AK' => [],
+ ],
+ ],
+ 'consumes' => ['application/json'],
+ 'produces' => ['application/json'],
+ 'operationType' => 'read',
+ 'deprecated' => false,
+ 'systemTags' => [
+ 'operationType' => 'update',
+ 'riskType' => 'none',
+ 'chargeType' => 'free',
+ 'abilityTreeNodes' => ['FEATUREopensearch8B42ZS'],
+ 'tenantRelevance' => 'tenant',
+ ],
+ 'parameters' => [
+ [
+ 'name' => 'workspaceName',
+ 'in' => 'path',
+ 'schema' => ['description' => 'The workspace name.', 'type' => 'string', 'required' => true, 'example' => 'default', 'title' => ''],
+ ],
+ [
+ 'name' => 'itemCategory',
+ 'in' => 'path',
+ 'schema' => ['description' => 'The configuration category.', 'type' => 'string', 'required' => true, 'example' => 'ai_search_agent', 'title' => ''],
+ ],
+ [
+ 'name' => 'itemName',
+ 'in' => 'path',
+ 'schema' => ['description' => 'The configuration name.', 'type' => 'string', 'required' => true, 'example' => 'es_knowledge_base', 'title' => ''],
+ ],
+ [
+ 'name' => 'dryRun',
+ 'in' => 'query',
+ 'schema' => ['description' => 'Specifies whether to validate the request parameters without applying the changes. Default value: false.'."\n"
+ ."\n"
+ .'Valid values:'."\n"
+ ."\n"
+ .'- **true**'."\n"
+ ."\n"
+ .'- **false**.', 'type' => 'boolean', 'required' => false, 'example' => 'true', 'title' => ''],
+ ],
+ [
+ 'name' => 'body',
+ 'in' => 'body',
+ 'style' => 'json',
+ 'schema' => [
+ 'description' => 'The request body.',
+ 'type' => 'object',
+ 'properties' => [
+ 'itemDesc' => ['description' => 'The configuration description.', 'type' => 'string', 'required' => false, 'example' => '描述', 'title' => ''],
+ 'itemValue' => ['description' => 'The configuration item.', 'type' => 'object', 'required' => false, 'example' => '{'."\n"
+ .' "name": "知识库名称",'."\n"
+ .' "type": "aliyun-es",'."\n"
+ .' "endpoint": {'."\n"
+ .' "address": "http://xxxxx.es-serverless.aliyuncs.com:9200",'."\n"
+ .' "authorization": "xxx:ABCDxxxx",'."\n"
+ .' "network": {'."\n"
+ .' "type": "public"'."\n"
+ .' },'."\n"
+ .' "region": ""'."\n"
+ .' },'."\n"
+ .' "function": {'."\n"
+ .' "indexName": "product_info",'."\n"
+ .' "queryType": "hybrid-search",'."\n"
+ .' "description": "金融理财产品知识库,理财产品名称列表及详细描述",'."\n"
+ .' "parameters": {'."\n"
+ .' "properties": {'."\n"
+ .' "query": {'."\n"
+ .' "defaultValue": "",'."\n"
+ .' "description": "理财产品名称或详细描述",'."\n"
+ .' "type": "string"'."\n"
+ .' }'."\n"
+ .' },'."\n"
+ .' "required": ['."\n"
+ .' "query"'."\n"
+ .' ]'."\n"
+ .' },'."\n"
+ .' "template": "{\\"query\\":{\\"multi_match\\":{\\"query\\":\\"${parameters.query}\\",\\"fields\\": [\\"*\\"]}}}",'."\n"
+ .' "type": "dsl",'."\n"
+ .' "embedding": {'."\n"
+ .' "denseModel": "dense",'."\n"
+ .' "sparseModel": "sparse",'."\n"
+ .' "address": "address",'."\n"
+ .' "authorization": "authorization"'."\n"
+ .' },'."\n"
+ .' "filter": "es或os语句",'."\n"
+ .' "size": 10'."\n"
+ .' }'."\n"
+ .' }', 'title' => ''],
+ ],
+ 'required' => false,
+ 'title' => '',
+ 'example' => '',
+ ],
+ ],
+ ],
+ 'responses' => [
+ 200 => [
+ 'schema' => [
+ 'title' => '',
+ 'description' => 'Schema of Response',
+ 'type' => 'object',
+ 'properties' => [
+ 'requestId' => ['title' => '', 'description' => 'Id of the request', 'type' => 'string', 'example' => '5950143C-B8F0-5758-A08A-66F302FD587F'],
+ 'httpCode' => ['description' => 'The HTTP status code.', 'type' => 'integer', 'format' => 'int64', 'example' => '200', 'title' => ''],
+ 'status' => ['description' => 'The request status.', 'type' => 'string', 'example' => 'OK', 'title' => ''],
+ ],
+ 'example' => '',
+ ],
+ ],
+ ],
+ 'staticInfo' => ['returnType' => 'synchronous'],
+ 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"requestId\\": \\"5950143C-B8F0-5758-A08A-66F302FD587F\\",\\n \\"httpCode\\": 200,\\n \\"status\\": \\"OK\\"\\n}","type":"json"}]',
+ 'title' => 'Update configuration',
+ 'description' => '## Request description'."\n"
+ .'This API operation allows you to update a specific configuration item (`itemName`) under a category (`itemCategory`) in a specified workspace (`workspaceName`). By setting the `dryRun` parameter, you can preview changes without actually applying them. The request body can contain a new configuration description (`itemDesc`) and configuration content (`itemValue`). The structure of `itemValue` must conform to the requirements of the target configuration item.',
+ 'changeSet' => [],
+ 'ramActions' => [
+ [
+ 'operationType' => 'update',
+ 'ramAction' => [
+ 'action' => 'searchplat:UpdateCapability',
+ 'authLevel' => 'operate',
+ 'actionConditions' => [],
+ 'resources' => [
+ ['validationType' => 'always', 'product' => 'SearchPlat', 'resourceType' => 'All Resource', 'arn' => '*'],
+ ],
+ ],
+ ],
+ ],
+ ],
+ 'UpdateCredentials' => [
+ 'path' => '/openapi/platform/workspaces/{workspaceName}/credentials/{token}',
+ 'methods' => ['put'],
+ 'schemes' => ['http', 'https'],
+ 'security' => [
+ [
+ 'AK' => [],
+ ],
+ ],
+ 'operationType' => 'readAndWrite',
+ 'deprecated' => false,
+ 'systemTags' => [
+ 'operationType' => 'none',
+ 'abilityTreeCode' => '220526',
+ 'abilityTreeNodes' => ['FEATUREopensearch1AJKH0'],
+ ],
+ 'parameters' => [
+ [
+ 'name' => 'token',
+ 'in' => 'path',
+ 'schema' => ['description' => 'The access credential token.', 'type' => 'string', 'required' => true, 'example' => 'OS-****', 'title' => ''],
+ ],
+ [
+ 'name' => 'dryRun',
+ 'in' => 'query',
+ 'schema' => ['description' => 'Specifies whether to perform a dry run.', 'type' => 'boolean', 'required' => false, 'example' => 'true', 'title' => ''],
+ ],
+ [
+ 'name' => 'body',
+ 'in' => 'body',
+ 'style' => 'json',
+ 'schema' => [
+ 'description' => 'The request body.',
+ 'type' => 'object',
+ 'properties' => [
+ 'enabled' => ['description' => 'Specifies whether the credential is enabled. Valid values:'."\n"
+ ."\n"
+ .'- true: Enabled.'."\n"
+ .'- false: Disabled.', 'type' => 'boolean', 'required' => false, 'title' => '', 'example' => ''],
+ ],
+ 'required' => false,
+ 'title' => '',
+ 'example' => '',
+ ],
+ ],
+ [
+ 'name' => 'workspaceName',
+ 'in' => 'path',
+ 'schema' => ['description' => 'The workspace name.', 'type' => 'string', 'required' => true, 'example' => 'myWorkspace', 'title' => ''],
+ ],
+ ],
+ 'responses' => [
+ 200 => [
+ 'schema' => [
+ 'title' => '',
+ 'description' => 'Schema of Response',
+ 'type' => 'object',
+ 'properties' => [
+ 'requestId' => ['title' => '', 'description' => 'Id of the request', 'type' => 'string', 'example' => '1CC93E65-6734-5060-BEF7-0EB0A4862BCF'],
+ 'result' => [
+ 'description' => 'The returned result.',
+ 'type' => 'object',
+ 'properties' => [
+ 'token' => ['description' => 'The access credential token.', 'type' => 'string', 'example' => 'OS-****', 'title' => ''],
+ 'appGroupId' => ['description' => 'The workspace ID.', 'type' => 'integer', 'format' => 'int64', 'example' => '12321321', 'title' => ''],
+ 'type' => ['description' => 'The credential type. Valid values:'."\n"
+ .'- api-token.', 'type' => 'string', 'example' => 'api-token', 'title' => ''],
+ 'enabled' => ['description' => 'Specifies whether the credential is enabled. Valid values:'."\n"
+ ."\n"
+ .'- true: Enabled.'."\n"
+ .'- false: Disabled.', 'type' => 'boolean', 'example' => 'false', 'title' => ''],
+ ],
+ 'title' => '',
+ 'example' => '',
+ ],
+ ],
+ 'example' => '',
+ ],
+ ],
+ ],
+ 'staticInfo' => ['returnType' => 'synchronous'],
+ 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"requestId\\": \\"1CC93E65-6734-5060-BEF7-0EB0A4862BCF\\",\\n \\"result\\": {\\n \\"token\\": \\"OS-****\\",\\n \\"appGroupId\\": 12321321,\\n \\"type\\": \\"api-token\\",\\n \\"enabled\\": false\\n }\\n}","type":"json"}]',
+ 'title' => 'Update an access credential',
+ 'summary' => 'Modifies an access credential.',
+ 'changeSet' => [],
+ 'ramActions' => [
+ [
+ 'operationType' => 'none',
+ 'ramAction' => [
+ 'action' => 'searchplat:WriteCredentials',
+ 'authLevel' => 'resource',
+ 'actionConditions' => [],
+ 'resources' => [
+ ['validationType' => 'always', 'product' => 'SearchPlat', 'resourceType' => 'Credentials', 'arn' => 'acs:searchplat:{#regionId}:{#accountId}:workspaces/{#workspaceName}'],
+ ],
+ ],
+ ],
+ ],
+ ],
+ 'UpdateFunctionInstance' => [
+ 'summary' => 'Updates the service configuration.',
+ 'path' => '/openapi/platform/workspaces/{workspaceName}/functions/{functionName}/instances/{instanceName}',
+ 'methods' => ['put'],
+ 'schemes' => ['https'],
+ 'security' => [
+ [
+ 'AK' => [],
+ ],
+ ],
+ 'deprecated' => false,
+ 'systemTags' => [
+ 'operationType' => 'none',
+ 'riskType' => 'none',
+ 'chargeType' => 'free',
+ 'abilityTreeCode' => '239782',
+ 'abilityTreeNodes' => ['FEATUREopensearchJK5SO0'],
+ 'autoTest' => true,
+ 'tenantRelevance' => 'publicInformation',
+ ],
+ 'parameters' => [
+ [
+ 'name' => 'workspaceName',
+ 'in' => 'path',
+ 'schema' => ['title' => '', 'description' => 'The workspace name.', 'type' => 'string', 'required' => true, 'example' => 'default'],
+ ],
+ [
+ 'name' => 'functionName',
+ 'in' => 'path',
+ 'schema' => ['title' => '', 'description' => 'The function name.', 'type' => 'string', 'required' => true, 'example' => 'deployment'],
+ ],
+ [
+ 'name' => 'instanceName',
+ 'in' => 'path',
+ 'schema' => ['title' => '', 'description' => 'The instance name.', 'type' => 'string', 'required' => true, 'example' => 'test'],
+ ],
+ [
+ 'name' => 'Body',
+ 'in' => 'body',
+ 'style' => 'json',
+ 'schema' => [
+ 'title' => '',
+ 'description' => 'The body parameters.',
+ 'type' => 'object',
+ 'properties' => [
+ 'createParameters' => [
+ 'title' => '',
+ 'description' => 'The creation parameters.',
+ 'type' => 'array',
+ 'items' => [
+ 'description' => 'The parameter body.',
+ 'type' => 'object',
+ 'properties' => [
+ 'name' => ['title' => '', 'description' => 'The parameter name.', 'type' => 'string', 'required' => false, 'example' => 'name'],
+ 'value' => ['title' => '', 'description' => 'The parameter value.', 'type' => 'string', 'required' => false, 'example' => 'value'],
+ ],
+ 'required' => false,
+ 'title' => '',
+ 'example' => '',
+ ],
+ 'required' => false,
+ 'example' => '',
+ ],
+ 'description' => ['title' => '', 'description' => 'The description.', 'type' => 'string', 'required' => false, 'example' => '描述'],
+ ],
+ 'required' => false,
+ 'example' => '',
+ ],
+ ],
+ ],
+ 'responses' => [
+ 200 => [
+ 'schema' => [
+ 'title' => '',
+ 'description' => 'Schema of Response',
+ 'type' => 'object',
+ 'properties' => [
+ 'status' => ['description' => 'The request status.', 'type' => 'string', 'example' => 'OK', 'title' => ''],
+ 'httpCode' => ['description' => 'The HTTP status code.', 'type' => 'integer', 'format' => 'int64', 'example' => '200', 'title' => ''],
+ 'requestId' => ['description' => 'The request ID.', 'type' => 'string', 'example' => '5950143C-B8F0-5758-A08A-66F302FD587F', 'title' => ''],
+ 'message' => ['title' => '', 'description' => 'The error message.', 'type' => 'string', 'example' => '"xx not found"'],
+ 'code' => ['title' => '', 'description' => 'The error code.', 'type' => 'string', 'example' => 'not found'],
+ 'latency' => ['title' => '', 'description' => 'The latency.', 'type' => 'integer', 'format' => 'int64', 'example' => '34.946'],
+ ],
+ 'example' => '',
+ ],
+ ],
+ ],
+ 'staticInfo' => ['returnType' => 'synchronous'],
+ 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"status\\": \\"OK\\",\\n \\"httpCode\\": 200,\\n \\"requestId\\": \\"5950143C-B8F0-5758-A08A-66F302FD587F\\",\\n \\"message\\": \\"\\\\\\"xx not found\\\\\\"\\",\\n \\"code\\": \\"not found\\",\\n \\"latency\\": 34.946\\n}","type":"json"}]',
+ 'title' => 'Update service or model configuration',
+ 'changeSet' => [],
+ 'ramActions' => [
+ [
+ 'operationType' => 'none',
+ 'ramAction' => [
+ 'action' => 'searchplat:WriteFunction',
+ 'authLevel' => 'resource',
+ 'actionConditions' => [],
+ 'resources' => [
+ ['validationType' => 'always', 'product' => 'SearchPlat', 'resourceType' => 'FunctionInstance', 'arn' => 'acs:searchplat:{#regionId}:{#accountId}:workspaces/{#workspaceName}'],
+ ],
+ ],
+ ],
+ ],
+ ],
+ 'UpdateWorkspace' => [
+ 'summary' => 'Updates a workspace.',
+ 'path' => '/openapi/platform/workspaces/{workspaceName}',
+ 'methods' => ['put'],
+ 'schemes' => ['http', 'https'],
+ 'security' => [
+ [
+ 'AK' => [],
+ ],
+ ],
+ 'operationType' => 'write',
+ 'deprecated' => false,
+ 'systemTags' => [
+ 'operationType' => 'none',
+ 'riskType' => 'none',
+ 'chargeType' => 'free',
+ 'abilityTreeCode' => '218191',
+ 'abilityTreeNodes' => ['FEATUREopensearch8B42ZS'],
+ ],
+ 'parameters' => [
+ [
+ 'name' => 'workspaceName',
+ 'in' => 'path',
+ 'schema' => ['description' => 'The workspace name.', 'type' => 'string', 'required' => true, 'example' => 'default', 'title' => ''],
+ ],
+ [
+ 'name' => 'body',
+ 'in' => 'body',
+ 'style' => 'json',
+ 'schema' => [
+ 'description' => 'The request struct.',
+ 'type' => 'object',
+ 'properties' => [
+ 'description' => ['description' => 'The description.', 'type' => 'string', 'required' => false, 'example' => 'test2024106271022', 'title' => ''],
+ 'resourceGroupId' => ['description' => 'The resource group ID.', 'type' => 'string', 'required' => false, 'example' => 'rg-aekzivjfrlpyn3y', 'title' => ''],
+ ],
+ 'required' => false,
+ 'title' => '',
+ 'example' => '',
+ ],
+ ],
+ ],
+ 'responses' => [
+ 200 => [
+ 'schema' => [
+ 'title' => '',
+ 'description' => 'Schema of Response',
+ 'type' => 'object',
+ 'properties' => [
+ 'requestId' => ['title' => '', 'description' => 'Id of the request', 'type' => 'string', 'example' => 'B7C901ED-2BC1-5CFB-BE23-242DE5E3BA5C'],
+ 'result' => [
+ 'description' => 'The returned result.',
+ 'type' => 'object',
+ 'properties' => [
+ 'chargeType' => ['description' => 'The billing type. Valid values:'."\n"
+ .'- POSTPAY: pay-as-you-go.', 'type' => 'string', 'example' => 'POSTPAY', 'title' => ''],
+ 'description' => ['description' => 'The description.', 'type' => 'string', 'example' => '描述', 'title' => ''],
+ 'engineType' => ['description' => 'The engine type.', 'type' => 'string', 'example' => 'rag', 'title' => ''],
+ 'id' => ['description' => 'The workspace ID.', 'type' => 'string', 'example' => '1222212', 'title' => ''],
+ 'instanceId' => ['description' => 'The instance ID.', 'type' => 'string', 'example' => 'ops-cn-em93wcq0s001', 'title' => ''],
+ 'name' => ['description' => 'The workspace name.', 'type' => 'string', 'example' => 'default', 'title' => ''],
+ 'produced' => ['description' => 'Indicates whether the production is complete. Valid values:'."\n"
+ .'- 0: In production.'."\n"
+ .'- 1: Production complete.', 'type' => 'integer', 'format' => 'int32', 'example' => '1', 'title' => ''],
+ 'quota' => [
+ 'description' => 'The quota.',
+ 'type' => 'object',
+ 'properties' => [
+ 'computeResource' => ['description' => 'The compute resource.', 'type' => 'integer', 'format' => 'int32', 'example' => '0', 'title' => ''],
+ 'docSize' => ['description' => 'The storage capacity.', 'type' => 'integer', 'format' => 'int32', 'example' => '0', 'title' => ''],
+ 'spec' => ['description' => 'The specifications.', 'type' => 'string', 'example' => 'rag.share.common', 'title' => ''],
+ ],
+ 'title' => '',
+ 'example' => '',
+ ],
+ 'resourceGroupId' => ['description' => 'The resource group ID.', 'type' => 'string', 'example' => 'rg-aeky6pyhbh6j3dy', 'title' => ''],
+ 'tags' => [
+ 'description' => 'The tags.',
+ 'type' => 'array',
+ 'items' => [
+ 'description' => 'The tags.',
+ 'type' => 'object',
+ 'properties' => [
+ 'tagKey' => ['description' => 'The tag key.', 'type' => 'string', 'example' => 'a', 'title' => ''],
+ 'tagValue' => ['description' => 'The tag value.', 'type' => 'string', 'example' => 'v', 'title' => ''],
+ ],
+ 'title' => '',
+ 'example' => '',
+ ],
+ 'title' => '',
+ 'example' => '',
+ ],
+ 'type' => ['description' => 'The type.', 'type' => 'string', 'example' => 'standard', 'title' => ''],
+ 'domainName' => ['description' => 'The custom domain name prefix.', 'type' => 'string', 'example' => 'default-xxx', 'title' => ''],
+ ],
+ 'title' => '',
+ 'example' => '',
+ ],
+ ],
+ 'example' => '',
+ ],
+ ],
+ ],
+ 'staticInfo' => ['returnType' => 'synchronous'],
+ 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"requestId\\": \\"B7C901ED-2BC1-5CFB-BE23-242DE5E3BA5C\\",\\n \\"result\\": {\\n \\"chargeType\\": \\"POSTPAY\\",\\n \\"description\\": \\"描述\\",\\n \\"engineType\\": \\"rag\\",\\n \\"id\\": \\"1222212\\",\\n \\"instanceId\\": \\"ops-cn-em93wcq0s001\\",\\n \\"name\\": \\"default\\",\\n \\"produced\\": 1,\\n \\"quota\\": {\\n \\"computeResource\\": 0,\\n \\"docSize\\": 0,\\n \\"spec\\": \\"rag.share.common\\"\\n },\\n \\"resourceGroupId\\": \\"rg-aeky6pyhbh6j3dy\\",\\n \\"tags\\": [\\n {\\n \\"tagKey\\": \\"a\\",\\n \\"tagValue\\": \\"v\\"\\n }\\n ],\\n \\"type\\": \\"standard\\",\\n \\"domainName\\": \\"default-xxx\\"\\n }\\n}","type":"json"}]',
+ 'title' => 'Update a workspace',
+ 'changeSet' => [],
+ 'ramActions' => [
+ [
+ 'operationType' => 'none',
+ 'ramAction' => [
+ 'action' => 'searchplat:WriteWorkspace',
+ 'authLevel' => 'resource',
+ 'actionConditions' => [],
+ 'resources' => [
+ ['validationType' => 'always', 'product' => 'SearchPlat', 'resourceType' => 'Workspace', 'arn' => 'acs:searchplat:{#regionId}:{#accountId}:workspaces/{#workspaceName}'],
+ ],
+ ],
+ ],
+ ],
+ ],
+ ],
+ 'endpoints' => [
+ ['regionId' => 'cn-shanghai', 'regionName' => 'China (Shanghai)', 'areaId' => 'asiaPacific', 'areaName' => 'Asia Pacific', 'public' => 'searchplat.cn-shanghai.aliyuncs.com', 'endpoint' => 'searchplat.cn-shanghai.aliyuncs.com', 'vpc' => ''],
+ ['regionId' => 'eu-central-1', 'regionName' => 'Germany (Frankfurt)', 'areaId' => 'europeAmerica', 'areaName' => 'Europe & Americas', 'public' => 'searchplat.eu-central-1.aliyuncs.com', 'endpoint' => 'searchplat.eu-central-1.aliyuncs.com', 'vpc' => ''],
+ ],
+ 'errorCodes' => [],
+ 'changeSet' => [
+ [
+ 'apis' => [
+ ['description' => 'Request parameters changed', 'api' => 'CreateOfflineTask'],
+ ['description' => 'Request parameters changed', 'api' => 'DeleteOfflineTask'],
+ ['description' => 'Request parameters changed', 'api' => 'GetOfflineTask'],
+ ['description' => 'Request parameters changed', 'api' => 'GetTableColumns'],
+ ['description' => 'Request parameters changed', 'api' => 'GetTables'],
+ ['description' => 'Request parameters changed', 'api' => 'ListOfflineTask'],
+ ['description' => 'Request parameters changed', 'api' => 'ModifyOfflineTask'],
+ ['description' => 'Request parameters changed', 'api' => 'StartOfflineTask'],
+ ['description' => 'Request parameters changed', 'api' => 'StopOfflineTask'],
+ ],
+ 'createdAt' => '2025-12-02T07:12:42.000Z',
+ 'description' => '',
+ ],
+ ],
+ 'ram' => [
+ 'productCode' => 'SearchPlat',
+ 'productName' => 'Open Search',
+ 'ramCodes' => ['searchplat'],
+ 'ramLevel' => 'RESOURCE',
+ 'ramConditions' => [],
+ 'ramActions' => [
+ [
+ 'apiName' => 'DeleteExperienceData',
+ 'description' => '',
+ 'operationType' => 'delete',
+ 'ramAction' => [
+ 'action' => 'searchplat:WriteExperienceData',
+ 'authLevel' => 'resource',
+ 'actionConditions' => [],
+ 'resources' => [
+ ['validationType' => 'always', 'product' => 'SearchPlat', 'resourceType' => 'ExperienceData', 'arn' => 'acs:searchplat:{#regionId}:{#accountId}:workspaces/{#workspaceName}'],
+ ],
+ ],
+ ],
+ [
+ 'apiName' => 'ListAsyncTasks',
+ 'description' => '',
+ 'operationType' => 'list',
+ 'ramAction' => [
+ 'action' => 'searchplat:DescribeAsyncTask',
+ 'authLevel' => 'resource',
+ 'actionConditions' => [],
+ 'resources' => [
+ ['validationType' => 'always', 'product' => 'SearchPlat', 'resourceType' => 'AsyncTasks', 'arn' => 'acs:searchplat:{#regionId}:{#accountId}:workspaces/{#workspaceName}'],
+ ],
+ ],
+ ],
+ [
+ 'apiName' => 'GetTableColumns',
+ 'description' => '',
+ 'operationType' => 'get',
+ 'ramAction' => [
+ 'action' => 'searchplat:GetTableColumns',
+ 'authLevel' => 'operate',
+ 'actionConditions' => [],
+ 'resources' => [
+ ['validationType' => 'always', 'product' => 'SearchPlat', 'resourceType' => 'All Resource', 'arn' => '*'],
+ ],
+ ],
+ ],
+ [
+ 'apiName' => 'ListCapabilities',
+ 'description' => '',
+ 'operationType' => 'list',
+ 'ramAction' => [
+ 'action' => 'searchplat:ListCapabilities',
+ 'authLevel' => 'operate',
+ 'actionConditions' => [],
+ 'resources' => [
+ ['validationType' => 'always', 'product' => 'SearchPlat', 'resourceType' => 'All Resource', 'arn' => '*'],
+ ],
+ ],
+ ],
+ [
+ 'apiName' => 'GetOfflineTask',
+ 'description' => '',
+ 'operationType' => 'get',
+ 'ramAction' => [
+ 'action' => 'searchplat:GetOfflineTask',
+ 'authLevel' => 'operate',
+ 'actionConditions' => [],
+ 'resources' => [
+ ['validationType' => 'always', 'product' => 'SearchPlat', 'resourceType' => 'All Resource', 'arn' => '*'],
+ ],
+ ],
+ ],
+ [
+ 'apiName' => 'ModifyOfflineTask',
+ 'description' => '',
+ 'operationType' => 'update',
+ 'ramAction' => [
+ 'action' => 'searchplat:ModifyOfflineTask',
+ 'authLevel' => 'operate',
+ 'actionConditions' => [],
+ 'resources' => [
+ ['validationType' => 'always', 'product' => 'SearchPlat', 'resourceType' => 'All Resource', 'arn' => '*'],
+ ],
+ ],
+ ],
+ [
+ 'apiName' => 'CreateFunctionInstance',
+ 'description' => '',
+ 'operationType' => 'create',
+ 'ramAction' => [
+ 'action' => 'searchplat:WriteFunction',
+ 'authLevel' => 'resource',
+ 'actionConditions' => [],
+ 'resources' => [
+ ['validationType' => 'always', 'product' => 'SearchPlat', 'resourceType' => 'FunctionInstance', 'arn' => 'acs:searchplat:{#regionId}:{#accountId}:workspaces/{#workspaceName}'],
+ ],
+ ],
+ ],
+ [
+ 'apiName' => 'ListFunctionRestrictions',
+ 'description' => '',
+ 'operationType' => 'get',
+ 'ramAction' => [
+ 'action' => 'searchplat:ListFunctionRestrictions',
+ 'authLevel' => 'operate',
+ 'actionConditions' => [],
+ 'resources' => [
+ ['validationType' => 'always', 'product' => 'SearchPlat', 'resourceType' => 'All Resource', 'arn' => '*'],
+ ],
+ ],
+ ],
+ [
+ 'apiName' => 'CreateCapability',
+ 'description' => '',
+ 'operationType' => 'create',
+ 'ramAction' => [
+ 'action' => 'searchplat:CreateCapability',
+ 'authLevel' => 'operate',
+ 'actionConditions' => [],
+ 'resources' => [
+ ['validationType' => 'always', 'product' => 'SearchPlat', 'resourceType' => 'All Resource', 'arn' => '*'],
+ ],
+ ],
+ ],
+ [
+ 'apiName' => 'DeleteFunctionInstance',
+ 'description' => '',
+ 'operationType' => 'delete',
+ 'ramAction' => [
+ 'action' => 'searchplat:WriteFunction',
+ 'authLevel' => 'resource',
+ 'actionConditions' => [],
+ 'resources' => [
+ ['validationType' => 'always', 'product' => 'SearchPlat', 'resourceType' => 'FunctionInstance', 'arn' => 'acs:searchplat:{#regionId}:{#accountId}:workspaces/{#workspaceName}'],
+ ],
+ ],
+ ],
+ [
+ 'apiName' => 'GetExperienceData',
+ 'description' => '',
+ 'operationType' => 'get',
+ 'ramAction' => [
+ 'action' => 'searchplat:DescribeExperienceData',
+ 'authLevel' => 'resource',
+ 'actionConditions' => [],
+ 'resources' => [
+ ['validationType' => 'always', 'product' => 'SearchPlat', 'resourceType' => 'ExperienceData', 'arn' => 'acs:searchplat:{#regionId}:{#accountId}:workspaces/{#workspaceName}'],
+ ],
+ ],
+ ],
+ [
+ 'apiName' => 'DeleteOfflineTask',
+ 'description' => '',
+ 'operationType' => 'delete',
+ 'ramAction' => [
+ 'action' => 'searchplat:DeleteOfflineTask',
+ 'authLevel' => 'operate',
+ 'actionConditions' => [],
+ 'resources' => [
+ ['validationType' => 'always', 'product' => 'SearchPlat', 'resourceType' => 'All Resource', 'arn' => '*'],
+ ],
+ ],
+ ],
+ [
+ 'apiName' => 'GetRagEvaluatorTask',
+ 'description' => '',
+ 'operationType' => 'get',
+ 'ramAction' => [
+ 'action' => 'searchplat:DescribeEvaluation',
+ 'authLevel' => 'operate',
+ 'actionConditions' => [],
+ 'resources' => [
+ ['validationType' => 'always', 'product' => 'SearchPlat', 'resourceType' => 'All Resource', 'arn' => '*'],
+ ],
+ ],
+ ],
+ [
+ 'apiName' => 'DeleteRagEvaluatorTask',
+ 'description' => '',
+ 'operationType' => 'delete',
+ 'ramAction' => [
+ 'action' => 'searchplat:WriteEvaluation',
+ 'authLevel' => 'operate',
+ 'actionConditions' => [],
+ 'resources' => [
+ ['validationType' => 'always', 'product' => 'SearchPlat', 'resourceType' => 'All Resource', 'arn' => '*'],
+ ],
+ ],
+ ],
+ [
+ 'apiName' => 'ListFunctionInstances',
+ 'description' => '',
+ 'operationType' => 'list',
+ 'ramAction' => [
+ 'action' => 'searchplat:DescribeFunction',
+ 'authLevel' => 'resource',
+ 'actionConditions' => [],
+ 'resources' => [
+ ['validationType' => 'always', 'product' => 'SearchPlat', 'resourceType' => 'FunctionInstance', 'arn' => 'acs:searchplat:{#regionId}:{#accountId}:workspaces/{#workspaceName}'],
+ ],
+ ],
+ ],
+ [
+ 'apiName' => 'GetWorkspace',
+ 'description' => '',
+ 'operationType' => 'none',
+ 'ramAction' => [
+ 'action' => 'searchplat:DescribeWorkspace',
+ 'authLevel' => 'resource',
+ 'actionConditions' => [],
+ 'resources' => [
+ ['validationType' => 'always', 'product' => 'SearchPlat', 'resourceType' => 'Workspace', 'arn' => 'acs:searchplat:{#regionId}:{#accountId}:workspaces/{#workspaceName}'],
+ ],
+ ],
+ ],
+ [
+ 'apiName' => 'UpdateWorkspace',
+ 'description' => '',
+ 'operationType' => 'none',
+ 'ramAction' => [
+ 'action' => 'searchplat:WriteWorkspace',
+ 'authLevel' => 'resource',
+ 'actionConditions' => [],
+ 'resources' => [
+ ['validationType' => 'always', 'product' => 'SearchPlat', 'resourceType' => 'Workspace', 'arn' => 'acs:searchplat:{#regionId}:{#accountId}:workspaces/{#workspaceName}'],
+ ],
+ ],
+ ],
+ [
+ 'apiName' => 'CreateExperienceData',
+ 'description' => '',
+ 'operationType' => 'create',
+ 'ramAction' => [
+ 'action' => 'searchplat:WriteExperienceData',
+ 'authLevel' => 'resource',
+ 'actionConditions' => [],
+ 'resources' => [
+ ['validationType' => 'always', 'product' => 'SearchPlat', 'resourceType' => 'ExperienceData', 'arn' => 'acs:searchplat:{#regionId}:{#accountId}:workspaces/{#workspaceName}'],
+ ],
+ ],
+ ],
+ [
+ 'apiName' => 'DescribeCapability',
+ 'description' => '',
+ 'operationType' => 'get',
+ 'ramAction' => [
+ 'action' => 'searchplat:DescribeCapability',
+ 'authLevel' => 'operate',
+ 'actionConditions' => [],
+ 'resources' => [
+ ['validationType' => 'always', 'product' => 'SearchPlat', 'resourceType' => 'All Resource', 'arn' => '*'],
+ ],
+ ],
+ ],
+ [
+ 'apiName' => 'DeleteCredentials',
+ 'description' => '',
+ 'operationType' => 'delete',
+ 'ramAction' => [
+ 'action' => 'searchplat:WriteCredentials',
+ 'authLevel' => 'resource',
+ 'actionConditions' => [],
+ 'resources' => [
+ ['validationType' => 'always', 'product' => 'SearchPlat', 'resourceType' => 'Credentials', 'arn' => 'acs:searchplat:{#regionId}:{#accountId}:workspaces/{#workspaceName}'],
+ ],
+ ],
+ ],
+ [
+ 'apiName' => 'ListRagEvaluatorTasks',
+ 'description' => '',
+ 'operationType' => 'get',
+ 'ramAction' => [
+ 'action' => 'searchplat:DescribeEvaluation',
+ 'authLevel' => 'operate',
+ 'actionConditions' => [],
+ 'resources' => [
+ ['validationType' => 'always', 'product' => 'SearchPlat', 'resourceType' => 'All Resource', 'arn' => '*'],
+ ],
+ ],
+ ],
+ [
+ 'apiName' => 'UpdateCapability',
+ 'description' => '',
+ 'operationType' => 'update',
+ 'ramAction' => [
+ 'action' => 'searchplat:UpdateCapability',
+ 'authLevel' => 'operate',
+ 'actionConditions' => [],
+ 'resources' => [
+ ['validationType' => 'always', 'product' => 'SearchPlat', 'resourceType' => 'All Resource', 'arn' => '*'],
+ ],
+ ],
+ ],
+ [
+ 'apiName' => 'DeleteCapability',
+ 'description' => '',
+ 'operationType' => 'delete',
+ 'ramAction' => [
+ 'action' => 'searchplat:DeleteCapability',
+ 'authLevel' => 'operate',
+ 'actionConditions' => [],
+ 'resources' => [
+ ['validationType' => 'always', 'product' => 'SearchPlat', 'resourceType' => 'All Resource', 'arn' => '*'],
+ ],
+ ],
+ ],
+ [
+ 'apiName' => 'StopOfflineTask',
+ 'description' => '',
+ 'operationType' => 'none',
+ 'ramAction' => [
+ 'action' => 'searchplat:StopOfflineTask',
+ 'authLevel' => 'operate',
+ 'actionConditions' => [],
+ 'resources' => [
+ ['validationType' => 'always', 'product' => 'SearchPlat', 'resourceType' => 'All Resource', 'arn' => '*'],
+ ],
+ ],
+ ],
+ [
+ 'apiName' => 'StartOfflineTask',
+ 'description' => '',
+ 'operationType' => 'none',
+ 'ramAction' => [
+ 'action' => 'searchplat:StartOfflineTask',
+ 'authLevel' => 'operate',
+ 'actionConditions' => [],
+ 'resources' => [
+ ['validationType' => 'always', 'product' => 'SearchPlat', 'resourceType' => 'All Resource', 'arn' => '*'],
+ ],
+ ],
+ ],
+ [
+ 'apiName' => 'ListCredentials',
+ 'description' => '',
+ 'operationType' => 'list',
+ 'ramAction' => [
+ 'action' => 'searchplat:DescribeCredentials',
+ 'authLevel' => 'resource',
+ 'actionConditions' => [],
+ 'resources' => [
+ ['validationType' => 'always', 'product' => 'SearchPlat', 'resourceType' => 'Credentials', 'arn' => 'acs:searchplat:{#regionId}:{#accountId}:workspaces/{#workspaceName}'],
+ ],
+ ],
+ ],
+ [
+ 'apiName' => 'CreateCredentials',
+ 'description' => '',
+ 'operationType' => 'create',
+ 'ramAction' => [
+ 'action' => 'searchplat:WriteCredentials',
+ 'authLevel' => 'resource',
+ 'actionConditions' => [],
+ 'resources' => [
+ ['validationType' => 'always', 'product' => 'SearchPlat', 'resourceType' => 'Credentials', 'arn' => 'acs:searchplat:{#regionId}:{#accountId}:workspaces/{#workspaceName}'],
+ ],
+ ],
+ ],
+ [
+ 'apiName' => 'CeaseFunctionInstance',
+ 'description' => '',
+ 'operationType' => 'none',
+ 'ramAction' => [
+ 'action' => 'searchplat:CeaseFunctionInstance',
+ 'authLevel' => 'operate',
+ 'actionConditions' => [],
+ 'resources' => [
+ ['validationType' => 'always', 'product' => 'SearchPlat', 'resourceType' => 'All Resource', 'arn' => '*'],
+ ],
+ ],
+ ],
+ [
+ 'apiName' => 'UpdateCredentials',
+ 'description' => '',
+ 'operationType' => 'none',
+ 'ramAction' => [
+ 'action' => 'searchplat:WriteCredentials',
+ 'authLevel' => 'resource',
+ 'actionConditions' => [],
+ 'resources' => [
+ ['validationType' => 'always', 'product' => 'SearchPlat', 'resourceType' => 'Credentials', 'arn' => 'acs:searchplat:{#regionId}:{#accountId}:workspaces/{#workspaceName}'],
+ ],
+ ],
+ ],
+ [
+ 'apiName' => 'ResumeFunctionInstance',
+ 'description' => '',
+ 'operationType' => 'none',
+ 'ramAction' => [
+ 'action' => 'searchplat:ResumeFunctionInstance',
+ 'authLevel' => 'operate',
+ 'actionConditions' => [],
+ 'resources' => [
+ ['validationType' => 'always', 'product' => 'SearchPlat', 'resourceType' => 'All Resource', 'arn' => '*'],
+ ],
+ ],
+ ],
+ [
+ 'apiName' => 'ListServices',
+ 'description' => '',
+ 'operationType' => 'none',
+ 'ramAction' => [
+ 'action' => 'searchplat:ListServices',
+ 'authLevel' => 'operate',
+ 'actionConditions' => [],
+ 'resources' => [
+ ['validationType' => 'always', 'product' => 'SearchPlat', 'resourceType' => 'All Resource', 'arn' => '*'],
+ ],
+ ],
+ ],
+ [
+ 'apiName' => 'GetTables',
+ 'description' => '',
+ 'operationType' => 'get',
+ 'ramAction' => [
+ 'action' => 'searchplat:GetTables',
+ 'authLevel' => 'operate',
+ 'actionConditions' => [],
+ 'resources' => [
+ ['validationType' => 'always', 'product' => 'SearchPlat', 'resourceType' => 'All Resource', 'arn' => '*'],
+ ],
+ ],
+ ],
+ [
+ 'apiName' => 'GetAsyncTask',
+ 'description' => '',
+ 'operationType' => 'get',
+ 'ramAction' => [
+ 'action' => 'searchplat:DescribeAsyncTask',
+ 'authLevel' => 'resource',
+ 'actionConditions' => [],
+ 'resources' => [
+ ['validationType' => 'always', 'product' => 'SearchPlat', 'resourceType' => 'AsyncTasks', 'arn' => 'acs:searchplat:{#regionId}:{#accountId}:workspaces/{#workspaceName}'],
+ ],
+ ],
+ ],
+ [
+ 'apiName' => 'DeleteWorkspace',
+ 'description' => '',
+ 'operationType' => 'none',
+ 'ramAction' => [
+ 'action' => 'searchplat:WriteWorkspace',
+ 'authLevel' => 'resource',
+ 'actionConditions' => [],
+ 'resources' => [
+ ['validationType' => 'always', 'product' => 'SearchPlat', 'resourceType' => 'Workspace', 'arn' => 'acs:searchplat:{#regionId}:{#accountId}:workspaces/{#workspaceName}'],
+ ],
+ ],
+ ],
+ [
+ 'apiName' => 'GetFunctionInstance',
+ 'description' => '',
+ 'operationType' => 'get',
+ 'ramAction' => [
+ 'action' => 'searchplat:DescribeFunction',
+ 'authLevel' => 'resource',
+ 'actionConditions' => [],
+ 'resources' => [
+ ['validationType' => 'always', 'product' => 'SearchPlat', 'resourceType' => 'FunctionInstance', 'arn' => 'acs:searchplat:{#regionId}:{#accountId}:workspaces/{#workspaceName}'],
+ ],
+ ],
+ ],
+ [
+ 'apiName' => 'CreateAsyncTask',
+ 'description' => '',
+ 'operationType' => 'create',
+ 'ramAction' => [
+ 'action' => 'searchplat:WriteAsyncTask',
+ 'authLevel' => 'resource',
+ 'actionConditions' => [],
+ 'resources' => [
+ ['validationType' => 'always', 'product' => 'SearchPlat', 'resourceType' => 'AsyncTasks', 'arn' => 'acs:searchplat:{#regionId}:{#accountId}:workspaces/{#workspaceName}'],
+ ],
+ ],
+ ],
+ [
+ 'apiName' => 'GetCredentials',
+ 'description' => '',
+ 'operationType' => 'get',
+ 'ramAction' => [
+ 'action' => 'searchplat:DescribeCredentials',
+ 'authLevel' => 'resource',
+ 'actionConditions' => [],
+ 'resources' => [
+ ['validationType' => 'always', 'product' => 'SearchPlat', 'resourceType' => 'Credentials', 'arn' => 'acs:searchplat:{#regionId}:{#accountId}:workspaces/{#workspaceName}'],
+ ],
+ ],
+ ],
+ [
+ 'apiName' => 'CreateWorkspace',
+ 'description' => '',
+ 'operationType' => 'none',
+ 'ramAction' => [
+ 'action' => 'searchplat:WriteWorkspace',
+ 'authLevel' => 'resource',
+ 'actionConditions' => [],
+ 'resources' => [
+ ['validationType' => 'always', 'product' => 'SearchPlat', 'resourceType' => 'All Resource', 'arn' => '*'],
+ ],
+ ],
+ ],
+ [
+ 'apiName' => 'UpdateFunctionInstance',
+ 'description' => '',
+ 'operationType' => 'none',
+ 'ramAction' => [
+ 'action' => 'searchplat:WriteFunction',
+ 'authLevel' => 'resource',
+ 'actionConditions' => [],
+ 'resources' => [
+ ['validationType' => 'always', 'product' => 'SearchPlat', 'resourceType' => 'FunctionInstance', 'arn' => 'acs:searchplat:{#regionId}:{#accountId}:workspaces/{#workspaceName}'],
+ ],
+ ],
+ ],
+ [
+ 'apiName' => 'ListExperienceData',
+ 'description' => '',
+ 'operationType' => 'list',
+ 'ramAction' => [
+ 'action' => 'searchplat:DescribeExperienceData',
+ 'authLevel' => 'resource',
+ 'actionConditions' => [],
+ 'resources' => [
+ ['validationType' => 'always', 'product' => 'SearchPlat', 'resourceType' => 'ExperienceData', 'arn' => 'acs:searchplat:{#regionId}:{#accountId}:workspaces/{#workspaceName}'],
+ ],
+ ],
+ ],
+ [
+ 'apiName' => 'CreateOfflineTask',
+ 'description' => '',
+ 'operationType' => 'create',
+ 'ramAction' => [
+ 'action' => 'searchplat:CreateOfflineTask',
+ 'authLevel' => 'operate',
+ 'actionConditions' => [],
+ 'resources' => [
+ ['validationType' => 'always', 'product' => 'SearchPlat', 'resourceType' => 'All Resource', 'arn' => '*'],
+ ],
+ ],
+ ],
+ [
+ 'apiName' => 'ListOfflineTask',
+ 'description' => '',
+ 'operationType' => 'none',
+ 'ramAction' => [
+ 'action' => 'searchplat:ListOfflineTask',
+ 'authLevel' => 'operate',
+ 'actionConditions' => [],
+ 'resources' => [
+ ['validationType' => 'always', 'product' => 'SearchPlat', 'resourceType' => 'All Resource', 'arn' => '*'],
+ ],
+ ],
+ ],
+ [
+ 'apiName' => 'CreateFunctionTask',
+ 'description' => '',
+ 'operationType' => 'create',
+ 'ramAction' => [
+ 'action' => 'searchplat:WriteFunction',
+ 'authLevel' => 'operate',
+ 'actionConditions' => [],
+ 'resources' => [
+ ['validationType' => 'always', 'product' => 'SearchPlat', 'resourceType' => 'All Resource', 'arn' => '*'],
+ ],
+ ],
+ ],
+ [
+ 'apiName' => 'CreateRagEvaluatorTask',
+ 'description' => '',
+ 'operationType' => 'create',
+ 'ramAction' => [
+ 'action' => 'searchplat:WriteEvaluation',
+ 'authLevel' => 'operate',
+ 'actionConditions' => [],
+ 'resources' => [
+ ['validationType' => 'always', 'product' => 'SearchPlat', 'resourceType' => 'All Resource', 'arn' => '*'],
+ ],
+ ],
+ ],
+ [
+ 'apiName' => 'ListWorkspaces',
+ 'description' => '',
+ 'operationType' => 'list',
+ 'ramAction' => [
+ 'action' => 'searchplat:ListWorkspaces',
+ 'authLevel' => 'resource',
+ 'actionConditions' => [],
+ 'resources' => [
+ ['validationType' => 'always', 'product' => 'SearchPlat', 'resourceType' => 'Workspace', 'arn' => 'acs:searchplat:{#regionId}:{#accountId}:workspaces/*'],
+ ],
+ ],
+ ],
+ [
+ 'apiName' => 'GetTableFields',
+ 'description' => '',
+ 'operationType' => 'get',
+ 'ramAction' => [
+ 'action' => 'searchplat:GetTableFields',
+ 'authLevel' => 'resource',
+ 'actionConditions' => [],
+ 'resources' => [
+ ['validationType' => 'always', 'product' => 'SearchPlat', 'resourceType' => 'All Resource', 'arn' => '*'],
+ ],
+ ],
+ ],
+ ],
+ 'resourceTypes' => [
+ ['validationType' => 'always', 'resourceType' => 'ExperienceData', 'arn' => 'acs:searchplat:{#regionId}:{#accountId}:workspaces/{#workspaceName}'],
+ ['validationType' => 'always', 'resourceType' => 'AsyncTasks', 'arn' => 'acs:searchplat:{#regionId}:{#accountId}:workspaces/{#workspaceName}'],
+ ['validationType' => 'always', 'resourceType' => 'FunctionInstance', 'arn' => 'acs:searchplat:{#regionId}:{#accountId}:workspaces/{#workspaceName}'],
+ ['validationType' => 'always', 'resourceType' => 'Workspace', 'arn' => 'acs:searchplat:{#regionId}:{#accountId}:workspaces/{#workspaceName}'],
+ ['validationType' => 'always', 'resourceType' => 'Credentials', 'arn' => 'acs:searchplat:{#regionId}:{#accountId}:workspaces/{#workspaceName}'],
+ ['validationType' => 'always', 'resourceType' => 'Workspace', 'arn' => 'acs:searchplat:{#regionId}:{#accountId}:workspaces/*'],
+ ['validationType' => 'always', 'resourceType' => 'Workspace', 'arn' => 'acs:searchplat:{#regionId}:{#accountId}:workspace/{#WorkspaceName}'],
+ ],
+ ],
];