summaryrefslogtreecommitdiff
path: root/data/zh_cn/searchplat
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/zh_cn/searchplat
parent7347bac4ab7e136157fc94777e6cf87ef9e08599 (diff)
downloadafterglow-metadata-full-1c7f908ce09f98fdcbf79ed2a8ae21be60eaa634.tar.gz
afterglow-metadata-full-1c7f908ce09f98fdcbf79ed2a8ae21be60eaa634.zip
update APIs 20260712
Diffstat (limited to 'data/zh_cn/searchplat')
-rw-r--r--data/zh_cn/searchplat/2024-04-01/api-docs.php10527
-rw-r--r--data/zh_cn/searchplat/2024-05-29/api-docs.php2794
2 files changed, 5955 insertions, 7366 deletions
diff --git a/data/zh_cn/searchplat/2024-04-01/api-docs.php b/data/zh_cn/searchplat/2024-04-01/api-docs.php
index 58d9b3e..9cb8b17 100644
--- a/data/zh_cn/searchplat/2024-04-01/api-docs.php
+++ b/data/zh_cn/searchplat/2024-04-01/api-docs.php
@@ -1,224 +1,171 @@
<?php return [
'version' => '1.0',
- 'info' => [
- 'style' => 'ROA',
- 'product' => 'Searchplat',
- 'version' => '2024-04-01',
- ],
+ 'info' => ['style' => 'ROA', 'product' => 'Searchplat', 'version' => '2024-04-01'],
'directories' => [
[
- 'id' => 209161,
- 'title' => '工作空间',
+ 'children' => ['UpdateCredentials', 'CreateCredentials', 'DeleteCredentials', 'GetCredentials'],
'type' => 'directory',
- 'children' => [
- 'CreateWorkspace',
- 'UpdateWorkspace',
- 'GetWorkspace',
- 'ListWorkspaces',
- 'DeleteWorkspace',
- ],
- ],
- [
- 'id' => 209167,
'title' => '访问凭证',
- 'type' => 'directory',
- 'children' => [
- 'UpdateCredentials',
- 'CreateCredentials',
- 'DeleteCredentials',
- 'GetCredentials',
- 'ListCredentials',
- ],
+ 'id' => 303149,
],
[
- 'id' => 209142,
- 'title' => '体验数据',
+ 'children' => ['GetExperienceData', 'DeleteExperienceData', 'CreateExperienceData', 'ListExperienceData'],
'type' => 'directory',
- 'children' => [
- 'GetExperienceData',
- 'DeleteExperienceData',
- 'CreateExperienceData',
- 'ListExperienceData',
- ],
+ 'title' => '体验数据',
+ 'id' => 303124,
],
[
- 'id' => 209147,
- 'title' => '异步任务',
+ 'children' => ['CreateAsyncTask'],
'type' => 'directory',
- 'children' => [
- 'ListAsyncTasks',
- 'GetAsyncTask',
- 'CreateAsyncTask',
- ],
+ 'title' => '异步任务',
+ 'id' => 303129,
],
[
- 'id' => 209151,
- 'title' => '模型服务',
+ 'children' => ['ResumeFunctionInstance', 'UpdateFunctionInstance', 'ListFunctionInstances', 'CeaseFunctionInstance', 'CreateFunctionInstance', 'CreateFunctionTask', 'DeleteFunctionInstance', 'GetFunctionInstance', 'ListFunctionRestrictions'],
'type' => 'directory',
- 'children' => [
- 'ResumeFunctionInstance',
- 'UpdateFunctionInstance',
- 'ListFunctionInstances',
- 'CeaseFunctionInstance',
- 'CreateFunctionInstance',
- 'CreateFunctionTask',
- 'DeleteFunctionInstance',
- 'GetFunctionInstance',
- 'ListFunctionRestrictions',
- ],
+ 'title' => '模型服务',
+ 'id' => 303133,
],
[
- 'id' => 209137,
- 'title' => '评测服务',
+ 'children' => ['DeleteRagEvaluatorTask', 'CreateRagEvaluatorTask', 'GetRagEvaluatorTask', 'ListRagEvaluatorTasks'],
'type' => 'directory',
- 'children' => [
- 'DeleteRagEvaluatorTask',
- 'CreateRagEvaluatorTask',
- 'CreateRagEvaluatorTask',
- 'GetRagEvaluatorTask',
- 'ListRagEvaluatorTasks',
- ],
+ 'title' => '评测服务',
+ 'id' => 303119,
],
[
- 'id' => 220397,
- 'title' => '离线任务',
+ 'children' => ['StopOfflineTask', 'StartOfflineTask', 'ListOfflineTask', 'ModifyOfflineTask', 'CreateOfflineTask', 'GetOfflineTask', 'DeleteOfflineTask'],
'type' => 'directory',
- 'children' => [
- 'StopOfflineTask',
- 'StartOfflineTask',
- 'ListOfflineTask',
- 'ModifyOfflineTask',
- 'CreateOfflineTask',
- 'GetOfflineTask',
- 'DeleteOfflineTask',
- ],
+ 'title' => '离线任务',
+ 'id' => 303160,
],
[
- 'id' => 344252,
- 'title' => '知识库配置',
+ 'children' => ['UpdateCapability', 'ListCapabilities', 'DescribeCapability', 'DeleteCapability', 'CreateCapability'],
'type' => 'directory',
- 'children' => [
- 'UpdateCapability',
- 'ListCapabilities',
- 'DescribeCapability',
- 'DeleteCapability',
- 'CreateCapability',
- ],
+ 'title' => '知识库配置',
+ 'id' => 303170,
],
[
- 'id' => 278727,
- 'title' => '数据源',
+ 'children' => ['GetTableFields'],
'type' => 'directory',
- 'children' => [
- 'GetTableFields',
- ],
+ 'title' => '数据源',
+ 'id' => 303168,
],
[
- 'id' => 209173,
- 'title' => '其他',
+ 'children' => ['GetTables', 'CreateWorkspace', 'DeleteWorkspace', 'DescribeRegions', 'GetAsyncTask', 'GetTableColumns', 'GetWorkspace', 'ListAsyncTasks', 'ListCredentials', 'ListServices', 'ListWorkspaces', 'UpdateWorkspace'],
'type' => 'directory',
- 'children' => [
- 'DescribeRegions',
- 'ListServices',
- 'GetTables',
- 'GetTableColumns',
- ],
+ 'title' => '其他',
+ 'id' => 303155,
],
],
'components' => [
'schemas' => [],
],
'apis' => [
- 'CreateWorkspace' => [
- 'summary' => '创建工作空间',
- 'path' => '/openapi/platform/workspaces',
- 'methods' => [
- 'post',
- ],
- 'schemes' => [
- 'http',
- 'https',
- ],
+ 'CeaseFunctionInstance' => [
+ 'summary' => '停止服务',
+ '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' => '218195',
- 'abilityTreeNodes' => [
- 'FEATUREopensearch2ESE2N',
+ 'abilityTreeCode' => '239777',
+ 'abilityTreeNodes' => ['FEATUREopensearchJK5SO0'],
+ 'autoTest' => true,
+ 'tenantRelevance' => 'tenant',
+ ],
+ 'parameters' => [
+ [
+ 'name' => 'workspaceName',
+ 'in' => 'path',
+ 'schema' => ['title' => 'opensearch应用名', 'description' => 'opensearch应用名', 'type' => 'string', 'required' => false, 'example' => 'default'],
+ ],
+ [
+ 'name' => 'functionName',
+ 'in' => 'path',
+ 'schema' => ['title' => '功能名称', 'description' => '功能名称', 'type' => 'string', 'required' => false, 'example' => 'notebook'],
+ ],
+ [
+ 'name' => 'instanceName',
+ 'in' => 'path',
+ 'schema' => ['title' => '实例名称', 'description' => '实例名称', 'type' => 'string', 'required' => true, 'example' => 'test_notebook'],
],
],
+ 'responses' => [
+ 200 => [
+ 'schema' => [
+ 'type' => 'object',
+ 'properties' => [
+ 'code' => ['description' => '错误码。', 'type' => 'string', 'example' => 'not found'],
+ 'httpCode' => ['description' => 'http状态码', 'type' => 'integer', 'format' => 'int64', 'example' => '200'],
+ 'latency' => ['description' => '延时分', 'type' => 'integer', 'format' => 'int64', 'example' => '34.946'],
+ 'message' => ['description' => '错误信息。', 'type' => 'string', 'example' => '"xx not found"'],
+ 'requestId' => ['description' => '请求ID', 'type' => 'string', 'example' => '2423C841-91C4-5E51-B296-590D367967FC'],
+ 'status' => ['description' => '请求状态', 'type' => 'string', 'example' => 'OK'],
+ ],
+ 'description' => '',
+ ],
+ ],
+ ],
+ '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' => '停止notebook服务',
+ 'changeSet' => [],
+ 'ramActions' => [],
+ ],
+ 'CreateAsyncTask' => [
+ 'summary' => '创建异步任务',
+ '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' => '是否为空运行请求', 'type' => 'boolean', 'required' => false, 'example' => 'true'],
+ ],
+ [
+ 'name' => 'workspaceName',
+ 'in' => 'path',
+ 'schema' => ['description' => '工作空间名称。', 'type' => 'string', 'required' => true, 'example' => 'myWorkspace'],
+ ],
+ [
'name' => 'body',
'in' => 'body',
'style' => 'json',
'schema' => [
- 'description' => '请求body。',
+ 'description' => '请求体。',
'type' => 'object',
'properties' => [
- 'chargeType' => [
- 'description' => '付费类型'."\n"
- .'- POSTPAY 后付费（按量付费）',
- 'type' => 'string',
- 'required' => false,
- 'example' => 'POSTPAY',
- ],
- 'engineType' => [
- 'description' => '引擎类型'."\n"
- .'- rag',
- 'type' => 'string',
- 'required' => false,
- 'example' => 'rag',
- ],
- 'name' => [
- 'description' => '工作空间名称',
- 'type' => 'string',
- 'required' => false,
- 'example' => 'default',
- ],
- 'quota' => [
- 'description' => '配额',
- 'type' => 'object',
- 'properties' => [
- 'computeResource' => [
- 'description' => '计算资源（单位：LCU）',
- 'type' => 'integer',
- 'format' => 'int32',
- 'required' => false,
- 'example' => '0',
- ],
- 'docSize' => [
- 'description' => '存储容量（单位：GB）',
- 'type' => 'integer',
- 'format' => 'int32',
- 'required' => false,
- 'example' => '0',
- ],
- 'spec' => [
- 'description' => '规格'."\n"
- .'- rag.share.common',
- 'type' => 'string',
- 'required' => false,
- 'example' => 'rag.share.common'."\n",
- ],
- ],
- 'required' => false,
- ],
- 'type' => [
- 'description' => '类型'."\n"
- .'- standard',
- 'type' => 'string',
- 'required' => false,
- 'example' => 'standard',
- ],
+ 'id' => ['description' => '异步任务id', 'type' => 'string', 'required' => false, 'example' => 'fae9bcc5-949f-4c31-b9b7-a273bf891699'],
+ 'serviceType' => ['description' => '服务类型', 'type' => 'string', 'required' => false, 'example' => 'document-analyze'],
+ 'serviceId' => ['description' => '服务ID', 'type' => 'string', 'required' => false, 'example' => 'ops-document-analyze-001'],
+ 'dataId' => ['description' => '体验数据ID。', 'type' => 'integer', 'format' => 'int64', 'required' => false, 'example' => '12323'],
+ 'name' => ['description' => '任务名称', 'type' => 'string', 'required' => false, 'example' => '文档解析任务'],
],
'required' => false,
],
@@ -231,108 +178,26 @@
'description' => 'Schema of Response',
'type' => 'object',
'properties' => [
- 'requestId' => [
- 'title' => 'Id of the request',
- 'description' => 'Id of the request',
- 'type' => 'string',
- 'example' => '2BA0504F-B179-586D-8210-A7C7C09A9907',
- ],
+ 'requestId' => ['title' => 'Id of the request', 'description' => 'Id of the request', 'type' => 'string', 'example' => '1CC93E65-6734-5060-BEF7-0EB0A4862BCF'],
'result' => [
'description' => '返回结果',
- 'type' => 'object',
- 'properties' => [
- 'chargeType' => [
- 'description' => '付费类型'."\n"
- .'- POSTPAY 后付费（按量付费）',
- 'type' => 'string',
- 'example' => 'POSTPAY',
- ],
- 'commodityCode' => [
- 'description' => '商品CODE',
- 'type' => 'string',
- 'example' => 'opensearch_platform_public_cn',
- ],
- 'description' => [
- 'description' => '工作空间描述',
- 'type' => 'string',
- 'example' => '描述',
- ],
- 'domainName' => [
- 'description' => '个性域名前缀',
- 'type' => 'string',
- 'example' => 'defalult-xxxx',
- ],
- 'engineType' => [
- 'description' => '引擎类型',
- 'type' => 'string',
- 'example' => 'rag',
- ],
- 'id' => [
- 'description' => '工作空间id',
- 'type' => 'string',
- 'example' => '120142804',
- ],
- 'instanceId' => [
- 'description' => '工作空间实例id',
- 'type' => 'string',
- 'example' => 'ops-xxxxx',
- ],
- 'name' => [
- 'description' => '工作空间名称',
- 'type' => 'string',
- 'example' => 'default',
- ],
- 'quota' => [
- 'description' => '配额',
- 'type' => 'object',
- 'properties' => [
- 'computeResource' => [
- 'description' => '计算资源',
- 'type' => 'integer',
- 'format' => 'int32',
- 'example' => '0',
- ],
- 'docSize' => [
- 'description' => '存储容量',
- 'type' => 'integer',
- 'format' => 'int32',
- 'example' => '0',
- ],
- 'spec' => [
- 'description' => '规格',
- 'type' => 'string',
- 'example' => 'rag.share.common',
- ],
- ],
- ],
- 'resourceGroupId' => [
- 'description' => '资源组ID',
- 'type' => 'string',
- 'example' => 'rg-xxxxxx',
- ],
- 'tags' => [
- 'description' => '标签',
- 'type' => 'array',
- 'items' => [
- 'type' => 'object',
- 'properties' => [
- 'tagKey' => [
- 'description' => '标签键',
- 'type' => 'string',
- 'example' => 'a',
- ],
- 'tagValue' => [
- 'description' => '标签值',
- 'type' => 'string',
- 'example' => 'c',
- ],
- ],
- ],
- ],
- 'type' => [
- 'description' => '类型',
- 'type' => 'string',
- 'example' => 'standard',
+ 'type' => 'array',
+ 'items' => [
+ 'description' => '返回结果',
+ 'type' => 'object',
+ 'properties' => [
+ 'id' => ['description' => '任务ID', 'type' => 'string', 'example' => 'fae9bcc5-949f-4c31-b9b7-a273bf891699'],
+ 'serviceType' => ['description' => '服务类型', 'type' => 'string', 'example' => 'document-analyze'],
+ 'serviceId' => ['description' => '服务ID。', 'type' => 'string', 'example' => 'ops-document-analyze-001'],
+ 'name' => ['description' => '任务名称', 'type' => 'string', 'example' => '文档解析任务'],
+ 'dataId' => ['description' => '数据ID。', 'type' => 'integer', 'format' => 'int32', 'example' => '1232'],
+ 'status' => ['description' => '任务状态'."\n"
+ .'- PENDING 进行中'."\n"
+ .'- SUCCESS 解析成功'."\n"
+ .'- FAILED 解析失败', 'type' => 'string', 'example' => 'SUCCESS'],
+ 'result' => ['description' => '解析结果。', 'type' => 'string', 'example' => 'xx'],
+ 'created' => ['description' => '创建时间', 'type' => 'integer', 'format' => 'int64', 'example' => '1729669284'],
+ 'updated' => ['description' => '更新时间', 'type' => 'integer', 'format' => 'int64', 'example' => '1729669284'],
],
],
],
@@ -340,73 +205,202 @@
],
],
],
- 'staticInfo' => [
- 'returnType' => 'synchronous',
+ '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' => '创建异步任务',
+ '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}'],
+ ],
+ ],
+ ],
],
- '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' => '创建工作空间',
],
- 'UpdateWorkspace' => [
- 'summary' => '更新工作空间。',
- 'path' => '/openapi/platform/workspaces/{workspaceName}',
- 'methods' => [
- 'put',
- ],
- 'schemes' => [
- 'http',
- 'https',
- ],
+ 'CreateCapability' => [
+ 'summary' => '创建知识库相关配置',
+ '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' => 'none',
+ 'operationType' => 'create',
'riskType' => 'none',
'chargeType' => 'free',
- 'abilityTreeCode' => '218191',
- 'abilityTreeNodes' => [
- 'FEATUREopensearch8B42ZS',
- ],
+ 'abilityTreeNodes' => ['FEATUREopensearch8B42ZS'],
+ 'tenantRelevance' => 'tenant',
],
'parameters' => [
[
'name' => 'workspaceName',
'in' => 'path',
+ 'schema' => ['description' => '工作空间名称', 'type' => 'string', 'required' => true, 'example' => 'default'],
+ ],
+ [
+ 'name' => 'itemCategory',
+ 'in' => 'path',
+ 'schema' => ['description' => '配置类别'."\n"
+ ."\n"
+ .'- ai_search_agent', 'type' => 'string', 'required' => true, 'example' => 'ai_search_agent'],
+ ],
+ [
+ 'name' => 'dryRun',
+ 'in' => 'query',
+ 'schema' => ['description' => '是否校验入参数据合法性，默认false。'."\n"
+ ."\n"
+ .'取值：'."\n"
+ ."\n"
+ .'- **true**'."\n"
+ ."\n"
+ .'- **false**', 'type' => 'boolean', 'required' => false, 'example' => 'false'],
+ ],
+ [
+ 'name' => 'body',
+ 'in' => 'body',
+ 'style' => 'json',
+ 'schema' => [
+ 'description' => '请求体',
+ 'type' => 'object',
+ 'properties' => [
+ 'itemName' => ['description' => '配置名称', 'type' => 'string', 'required' => false, 'example' => 'es_knowledge_base'],
+ 'itemDesc' => ['description' => '配置描述', 'type' => 'string', 'required' => false, 'example' => '描述'],
+ 'itemValue' => ['description' => '配置项', '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"
+ .' }'],
+ ],
+ 'required' => false,
+ ],
+ ],
+ ],
+ 'responses' => [
+ 200 => [
'schema' => [
- 'description' => '工作空间名称',
- 'type' => 'string',
- 'required' => true,
- 'example' => 'default',
+ 'title' => 'Schema of Response',
+ 'description' => 'Schema of Response',
+ 'type' => 'object',
+ 'properties' => [
+ 'requestId' => ['title' => 'Id of the request', 'description' => 'Id of the request', 'type' => 'string', 'example' => '1CC93E65-6734-5060-BEF7-0EB0A4862BCF'],
+ 'httpCode' => ['description' => 'HTTP状态码。', 'type' => 'integer', 'format' => 'int64', 'example' => '200'],
+ 'status' => ['description' => '请求状态', 'type' => 'string', 'example' => 'OK'],
+ ],
+ ],
+ ],
+ ],
+ 'staticInfo' => ['returnType' => 'synchronous'],
+ 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"requestId\\": \\"1CC93E65-6734-5060-BEF7-0EB0A4862BCF\\",\\n \\"httpCode\\": 200,\\n \\"status\\": \\"OK\\"\\n}","type":"json"}]',
+ 'title' => '创建配置',
+ 'changeSet' => [],
+ 'ramActions' => [
+ [
+ 'operationType' => 'create',
+ 'ramAction' => [
+ 'action' => 'searchplat:CreateCapability',
+ 'authLevel' => 'operate',
+ 'actionConditions' => [],
+ 'resources' => [
+ ['validationType' => 'always', 'product' => 'SearchPlat', 'resourceType' => '全部资源', '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' => '是否校验入参数据合法性，默认false。'."\n"
+ ."\n"
+ .'取值：'."\n"
+ ."\n"
+ .'- **true**：只校验参数合法性。'."\n"
+ ."\n"
+ .'- **false**：校验参数合法性，创建归因配置。', 'type' => 'boolean', 'required' => false, 'example' => 'true'],
+ ],
[
'name' => 'body',
'in' => 'body',
'style' => 'json',
'schema' => [
- 'description' => '请求结构体。',
+ 'description' => '请求Body。',
'type' => 'object',
'properties' => [
- 'description' => [
- 'description' => '描述',
- 'type' => 'string',
- 'required' => false,
- 'example' => 'test2024106271022',
- ],
- 'resourceGroupId' => [
- 'description' => '资源组ID',
- 'type' => 'string',
- 'required' => false,
- 'example' => 'rg-aekzivjfrlpyn3y',
- ],
+ 'type' => ['description' => '凭证类型。可传类型有：'."\n"
+ .'- api-token', 'type' => 'string', 'required' => false, 'example' => 'api-token'],
],
'required' => false,
],
],
+ [
+ 'name' => 'workspaceName',
+ 'in' => 'path',
+ 'schema' => ['description' => '工作空间名称。', 'type' => 'string', 'required' => true, 'example' => 'myWorkspace'],
+ ],
],
'responses' => [
200 => [
@@ -415,163 +409,102 @@
'description' => 'Schema of Response',
'type' => 'object',
'properties' => [
- 'requestId' => [
- 'title' => 'Id of the request',
- 'description' => 'Id of the request',
- 'type' => 'string',
- 'example' => 'B7C901ED-2BC1-5CFB-BE23-242DE5E3BA5C',
- ],
+ 'requestId' => ['title' => 'Id of the request', 'description' => 'Id of the request', 'type' => 'string', 'example' => '2E37A447-C010-5A49-9F31-DE12E97710A3'],
'result' => [
- 'description' => '返回结果。',
+ 'description' => '返回结果',
'type' => 'object',
'properties' => [
- 'chargeType' => [
- 'description' => '付费类型'."\n"
- .'- POSTPAY 后付费（按量付费）',
- 'type' => 'string',
- 'example' => 'POSTPAY',
- ],
- 'description' => [
- 'description' => '描述',
- 'type' => 'string',
- 'example' => '描述',
- ],
- 'engineType' => [
- 'description' => '引擎类型',
- 'type' => 'string',
- 'example' => 'rag',
- ],
- 'id' => [
- 'description' => '工作空间ID',
- 'type' => 'string',
- 'example' => '1222212',
- ],
- 'instanceId' => [
- 'description' => '实例ID',
- 'type' => 'string',
- 'example' => 'ops-cn-em93wcq0s001',
- ],
- 'name' => [
- 'description' => '工作空间名称',
- 'type' => 'string',
- 'example' => 'default',
- ],
- 'produced' => [
- 'description' => '是否生产完成'."\n"
- .'- 0：生产中'."\n"
- .'- 1：生产完成',
- 'type' => 'integer',
- 'format' => 'int32',
- 'example' => '1',
- ],
- 'quota' => [
- 'description' => '配额',
- 'type' => 'object',
- 'properties' => [
- 'computeResource' => [
- 'description' => '计算资源',
- 'type' => 'integer',
- 'format' => 'int32',
- 'example' => '0',
- ],
- 'docSize' => [
- 'description' => '存储容量',
- 'type' => 'integer',
- 'format' => 'int32',
- 'example' => '0',
- ],
- 'spec' => [
- 'description' => '规格',
- 'type' => 'string',
- 'example' => 'rag.share.common',
- ],
- ],
- ],
- 'resourceGroupId' => [
- 'description' => '资源组ID',
- 'type' => 'string',
- 'example' => 'rg-aeky6pyhbh6j3dy',
- ],
- 'tags' => [
- 'description' => '标签',
- 'type' => 'array',
- 'items' => [
- 'description' => '标签',
- 'type' => 'object',
- 'properties' => [
- 'tagKey' => [
- 'description' => '标签键',
- 'type' => 'string',
- 'example' => 'a',
- ],
- 'tagValue' => [
- 'description' => '标签值',
- 'type' => 'string',
- 'example' => 'v',
- ],
- ],
- ],
- ],
- 'type' => [
- 'description' => '类型',
- 'type' => 'string',
- 'example' => 'standard',
- ],
- 'domainName' => [
- 'description' => '个性域名前缀',
- 'type' => 'string',
- 'example' => 'default-xxx',
- ],
+ 'appGroupId' => ['description' => '工作空间ID。', 'type' => 'integer', 'format' => 'int64', 'example' => '12323'],
+ 'type' => ['description' => '凭证类型。'."\n"
+ ."\n"
+ .'- api-token', 'type' => 'string', 'example' => 'api-token'."\n"],
+ 'enabled' => ['description' => '凭据是否启用。'."\n"
+ .'取值：'."\n"
+ ."\n"
+ .'- true：启用。 '."\n"
+ .'- false：禁用。', 'type' => 'boolean', 'example' => 'false'],
+ 'token' => ['description' => '生成的凭据令牌。', 'type' => 'string', 'example' => 'OS-********'],
],
],
],
],
],
],
- 'staticInfo' => [
- 'returnType' => 'synchronous',
+ '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' => '创建访问凭证',
+ 'summary' => '创建访问凭证',
+ '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}'],
+ ],
+ ],
+ ],
],
- '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' => '修改工作空间',
],
- 'GetWorkspace' => [
- 'summary' => '获取工作空间',
- 'path' => '/openapi/platform/workspaces/{workspaceName}',
- 'methods' => [
- 'get',
- ],
- 'schemes' => [
- 'http',
- 'https',
- ],
+ 'CreateExperienceData' => [
+ 'summary' => '创建体验数据',
+ 'path' => '/openapi/platform/workspaces/{workspaceName}/experience-data',
+ 'methods' => ['post'],
+ 'schemes' => ['http', 'https'],
'security' => [
[
'AK' => [],
],
],
- 'operationType' => 'read',
+ 'operationType' => 'readAndWrite',
'deprecated' => false,
'systemTags' => [
- 'operationType' => 'none',
+ 'operationType' => 'create',
'riskType' => 'none',
'chargeType' => 'free',
- 'abilityTreeCode' => '218193',
- 'abilityTreeNodes' => [
- 'FEATUREopensearchGVH0IN',
- ],
+ 'abilityTreeCode' => '225360',
+ 'abilityTreeNodes' => ['FEATUREopensearch8B42ZS'],
],
'parameters' => [
[
- 'name' => 'workspaceName',
- 'in' => 'path',
+ 'name' => 'dryRun',
+ 'in' => 'query',
+ 'schema' => ['description' => '是否为空运行请求', 'type' => 'boolean', 'required' => false, 'example' => 'true'],
+ ],
+ [
+ 'name' => 'body',
+ 'in' => 'body',
+ 'style' => 'json',
'schema' => [
- 'title' => 'A short description of struct',
- 'description' => '工作空间名称',
- 'type' => 'string',
- 'required' => true,
- 'example' => 'default',
+ 'description' => '请求体',
+ 'type' => 'object',
+ 'properties' => [
+ 'serviceType' => ['description' => '服务类型', 'type' => 'string', 'required' => false, 'example' => 'document-analyze '],
+ 'dataType' => ['description' => '数据类型'."\n"
+ .'- file 文件'."\n"
+ .'- url 网址', 'type' => 'string', 'required' => false, 'example' => 'file'],
+ 'name' => ['description' => '数据名称（dataType=file时, name不能为空）', 'type' => 'string', 'required' => false, 'example' => 'test'],
+ 'dataValue' => ['description' => '数据内容'."\n"
+ .'- dataType=file时，该字段为文件oss地址'."\n"
+ .'- dataType=url时，该字段为数据http链接地址', 'type' => 'string', 'required' => false, 'example' => 'https://xxx'],
+ 'dataSize' => ['description' => '数据大小', 'type' => 'integer', 'format' => 'int64', 'required' => false, 'example' => '100'],
+ 'contentType' => ['description' => '数据内容类型，支持：'."\n"
+ .'- pdf'."\n"
+ .'- text'."\n"
+ .'- html'."\n"
+ .'- doc', 'type' => 'string', 'required' => false, 'example' => 'text'],
+ ],
+ 'required' => false,
],
],
+ [
+ 'name' => 'workspaceName',
+ 'in' => 'path',
+ 'schema' => ['description' => '工作空间名称。', 'type' => 'string', 'required' => true, 'example' => 'myWorkspace'],
+ ],
],
'responses' => [
200 => [
@@ -580,235 +513,408 @@
'description' => 'Schema of Response',
'type' => 'object',
'properties' => [
- 'requestId' => [
- 'title' => 'Id of the request',
- 'description' => 'Id of the request',
- 'type' => 'string',
- 'example' => '58113A95-1858-5674-87E5-192AEE6FD9DD',
- ],
+ 'requestId' => ['title' => 'Id of the request', 'description' => 'Id of the request', 'type' => 'string', 'example' => '7ACFD0C5-61E4-5DEA-A995-8279BB99C7E4'],
'result' => [
'description' => '返回结果',
'type' => 'object',
'properties' => [
- 'apiToken' => [
- 'description' => 'apiToken',
- 'type' => 'string',
- 'example' => 'apiToken',
- ],
- 'chargeType' => [
- 'description' => '付费类型'."\n"
- .'- POSTPAY 后付费（按量付费）',
- 'type' => 'string',
- 'example' => 'POSTPAY',
- ],
- 'commodityCode' => [
- 'description' => '商品CODE',
- 'type' => 'string',
- 'example' => 'commodityCode',
- ],
- 'description' => [
- 'description' => '描述',
- 'type' => 'string',
- 'example' => '描述',
- ],
- 'domainName' => [
- 'description' => '个性域名前缀',
- 'type' => 'string',
- 'example' => 'default-xxx',
- ],
- 'engineType' => [
- 'description' => '引擎类型',
- 'type' => 'string',
- 'example' => 'rag',
- ],
- 'id' => [
- 'description' => '工作空间ID',
- 'type' => 'string',
- 'example' => '1222212',
- ],
- 'instanceId' => [
- 'description' => '实例ID',
- 'type' => 'string',
- 'example' => 'ops-cn-em93wcq0s001',
- ],
- 'name' => [
- 'description' => '工作空间名称',
- 'type' => 'string',
- 'example' => 'default',
- ],
- 'quota' => [
- 'description' => '配额',
- 'type' => 'object',
- 'properties' => [
- 'computeResource' => [
- 'description' => '计算资源',
- 'type' => 'integer',
- 'format' => 'int32',
- 'example' => '0',
- ],
- 'docSize' => [
- 'description' => '存储容量',
- 'type' => 'integer',
- 'format' => 'int32',
- 'example' => '0',
- ],
- 'spec' => [
- 'description' => '规格',
- 'type' => 'string',
- 'example' => 'rag.share.common',
- ],
- ],
- ],
- 'resourceGroupId' => [
- 'description' => '资源组ID',
- 'type' => 'string',
- 'example' => 'rg-aekzaowqymbb4ki',
- ],
- 'status' => [
- 'description' => '状态',
- 'type' => 'string',
- 'example' => '""',
- ],
- 'tags' => [
- 'description' => '标签',
- 'type' => 'array',
- 'items' => [
- 'description' => '标签',
- 'type' => 'object',
- 'properties' => [
- 'tagKey' => [
- 'description' => '标签键',
- 'type' => 'string',
- 'example' => 'a',
- ],
- 'tagValue' => [
- 'description' => '标签值',
- 'type' => 'string',
- 'example' => 'x',
- ],
- ],
- ],
- ],
- 'type' => [
- 'description' => '类型',
- 'type' => 'string',
- 'example' => 'standard',
- ],
+ 'id' => ['description' => '数据id', 'type' => 'integer', 'format' => 'int64', 'example' => '1222212'],
+ 'serviceType' => ['description' => '服务类型', 'type' => 'string', 'example' => 'document-analyze'],
+ 'dataType' => ['description' => '数据类型', 'type' => 'boolean', 'example' => 'file'],
+ 'name' => ['description' => '数据名称', 'type' => 'string', 'example' => 'test'],
+ 'dataValue' => ['description' => '数据内容', 'type' => 'string', 'example' => 'http://xxx'],
+ 'dataSize' => ['description' => '数据大小', 'type' => 'integer', 'format' => 'int64', 'example' => '100'],
+ 'created' => ['description' => '创建时间', 'type' => 'integer', 'format' => 'int64', 'example' => '1729665694'],
+ 'updated' => ['description' => '更新时间', 'type' => 'integer', 'format' => 'int64', 'example' => '1729665694'],
+ 'contentType' => ['description' => '数据内容类型', 'type' => 'string', 'example' => 'text'],
],
],
],
],
],
],
- 'staticInfo' => [
- 'returnType' => 'synchronous',
+ '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' => '创建体验数据',
+ '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}'],
+ ],
+ ],
+ ],
],
- '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' => '查看一个工作空间详情',
],
- 'ListWorkspaces' => [
- 'summary' => '获取工作空间列表。',
- 'path' => '/openapi/platform/workspaces',
- 'methods' => [
- 'get',
- ],
- 'schemes' => [
- 'http',
- 'https',
- ],
+ 'CreateFunctionInstance' => [
+ 'summary' => '创建服务配置',
+ 'path' => '/openapi/platform/workspaces/{workspaceName}/functions/{functionName}/instances',
+ 'methods' => ['post'],
+ 'schemes' => ['https'],
'security' => [
[
'AK' => [],
],
],
- 'operationType' => 'read',
+ 'consumes' => ['application/json'],
+ 'operationType' => 'readAndWrite',
'deprecated' => false,
'systemTags' => [
- 'operationType' => 'list',
+ 'operationType' => 'create',
'riskType' => 'none',
'chargeType' => 'free',
- 'abilityTreeCode' => '218194',
- 'abilityTreeNodes' => [
- 'FEATUREopensearchGVH0IN',
- ],
+ 'abilityTreeCode' => '239769',
+ 'abilityTreeNodes' => ['FEATUREopensearchJK5SO0'],
+ 'autoTest' => true,
+ 'tenantRelevance' => 'publicInformation',
],
'parameters' => [
[
- 'name' => 'pageNumber',
- 'in' => 'query',
- 'schema' => [
- 'description' => '页码，默认 pageNumber=1',
- 'type' => 'integer',
- 'format' => 'int32',
- 'required' => false,
- 'example' => '1',
- ],
+ 'name' => 'workspaceName',
+ 'in' => 'path',
+ 'schema' => ['description' => '工作空间名称。', 'type' => 'string', 'required' => true, 'example' => 'myWorkspace'],
],
[
- 'name' => 'pageSize',
- 'in' => 'query',
+ 'name' => 'functionName',
+ 'in' => 'path',
+ 'schema' => ['description' => '服务、模型类型'."\n"
+ .'- nl2sql 服务'."\n"
+ .'- embedding-tuning 模型', 'type' => 'string', 'required' => true, 'example' => 'nl2sql'],
+ ],
+ [
+ 'name' => 'Body',
+ 'in' => 'body',
+ 'style' => 'json',
'schema' => [
- 'description' => '分页条数。',
- 'type' => 'integer',
- 'format' => 'int32',
+ 'title' => 'body参数',
+ 'description' => 'body参数',
+ 'type' => 'object',
+ 'properties' => [
+ 'instanceName' => ['title' => '实例名称', 'description' => '配置、模型名称', 'type' => 'string', 'required' => true, 'example' => 'test'],
+ 'modelType' => ['title' => '模型类型', 'description' => '服务ID'."\n"
+ .'- ops-query-analyze-nl2sql-001'."\n"
+ .'- ops-embedding-dim-reduction-001 向量降维', 'type' => 'string', 'required' => true, 'example' => 'ops-query-analyze-nl2sql-001'],
+ 'functionType' => ['title' => '功能类型', 'description' => '配置类型'."\n"
+ .'- PAAS'."\n"
+ .'- SAAS', 'type' => 'string', 'required' => false, 'example' => 'PAAS'],
+ 'description' => ['title' => '实例描述', 'description' => '实例描述', 'type' => 'string', 'required' => false, 'example' => 'desc'],
+ 'createParameters' => [
+ 'title' => '创建参数',
+ 'description' => '创建参数',
+ 'type' => 'array',
+ 'items' => [
+ 'type' => 'object',
+ 'properties' => [
+ 'name' => ['title' => '参数名称', 'description' => '参数名称', 'type' => 'string', 'required' => false, 'example' => 'config'],
+ 'value' => ['title' => '参数值', 'description' => '参数值', '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' => '参数项',
+ ],
+ 'required' => false,
+ ],
+ ],
'required' => false,
- 'example' => '10',
+ 'docRequired' => true,
],
],
- [
- 'name' => 'instanceId',
- 'in' => 'query',
+ ],
+ 'responses' => [
+ 200 => [
'schema' => [
- 'description' => '实例id',
- 'type' => 'string',
- 'required' => false,
- 'example' => 'ops-cn-jte49bevd04',
+ 'type' => 'object',
+ 'properties' => [
+ 'status' => ['description' => '请求状态', 'type' => 'string', 'example' => 'OK'],
+ 'httpCode' => ['description' => '业务成功与否。如果非空且不是200，那么表示业务处理失败。', 'type' => 'integer', 'format' => 'int64', 'example' => '200'],
+ 'requestId' => ['description' => '请求ID。', 'type' => 'string', 'example' => '2BA0504F-B179-586D-8210-A7C7C09A9907'],
+ 'message' => ['description' => '错误信息。', 'type' => 'string', 'example' => 'ok'],
+ 'code' => ['description' => '错误码。', 'type' => 'string', 'example' => 'not found'],
+ 'latency' => ['description' => '延时分', 'type' => 'integer', 'format' => 'int64', 'example' => '145.411'],
+ ],
+ 'description' => '',
],
],
+ ],
+ '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' => '创建服务/模型配置',
+ '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' => '创建服务配置任务',
+ 'path' => '/openapi/platform/workspaces/{workspaceName}/functions/{functionName}/instances/{instanceName}/tasks',
+ 'methods' => ['post'],
+ 'schemes' => ['https'],
+ 'security' => [
[
- 'name' => 'name',
- 'in' => 'query',
+ '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' => '工作空间名称。', 'type' => 'string', 'required' => true, 'example' => 'myWorkspace'],
+ ],
+ [
+ 'name' => 'functionName',
+ 'in' => 'path',
+ 'schema' => ['description' => '服务配置', 'type' => 'string', 'required' => true, 'example' => 'nl2sql'],
+ ],
+ [
+ 'name' => 'instanceName',
+ 'in' => 'path',
+ 'schema' => ['description' => '配置名称', 'type' => 'string', 'required' => true, 'example' => 'test'],
+ ],
+ ],
+ 'responses' => [
+ 200 => [
'schema' => [
- 'description' => '工作空间名称',
- 'type' => 'string',
- 'required' => false,
- 'example' => 'default',
+ 'type' => 'object',
+ 'properties' => [
+ 'code' => ['description' => '错误码。', 'type' => 'string', 'example' => 'not found'],
+ 'httpCode' => ['description' => 'http状态码', 'type' => 'integer', 'format' => 'int64', 'example' => '200'],
+ 'latency' => ['description' => '延时分', 'type' => 'integer', 'format' => 'int64', 'example' => '145.411'],
+ 'message' => ['description' => '错误信息', 'type' => 'string', 'example' => '"xx not found"'],
+ 'requestId' => ['description' => '请求ID', 'type' => 'string', 'example' => '58113A95-1858-5674-87E5-192AEE6FD9DD'],
+ 'status' => ['description' => '请求状态', 'type' => 'string', 'example' => 'OK'],
+ ],
+ 'description' => '',
+ ],
+ ],
+ ],
+ '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' => '激活配置',
+ 'changeSet' => [],
+ 'ramActions' => [
+ [
+ 'operationType' => 'create',
+ 'ramAction' => [
+ 'action' => 'searchplat:WriteFunction',
+ 'authLevel' => 'operate',
+ 'actionConditions' => [],
+ 'resources' => [
+ ['validationType' => 'always', 'product' => 'SearchPlat', 'resourceType' => '全部资源', 'arn' => '*'],
+ ],
],
],
+ ],
+ ],
+ 'CreateOfflineTask' => [
+ 'summary' => '用于创建视频检索的离线处理任务，支持配置数据源、处理参数及输出目标。',
+ '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' => '工作空间名称', 'type' => 'string', 'required' => false, 'example' => 'default'],
+ ],
[
'name' => 'type',
+ 'in' => 'path',
+ 'schema' => ['description' => '任务类型', 'type' => 'string', 'required' => false, 'example' => 'video'],
+ ],
+ [
+ 'name' => 'draft',
'in' => 'query',
- 'schema' => [
- 'description' => '类型',
- 'type' => 'string',
- 'required' => false,
- 'example' => 'standard',
- ],
+ 'schema' => ['description' => '是否为草稿', 'type' => 'boolean', 'required' => false, 'example' => 'false'],
],
[
- 'name' => 'sortBy',
+ 'name' => 'dryRun',
'in' => 'query',
- 'schema' => [
- 'description' => '排列顺序'."\n"
- ."\n"
- .'- 0：按创建时间降序排列'."\n"
- .'- 1：按修改时间降序排列'."\n"
- ."\n"
- .'默认 sortBy=0',
- 'type' => 'integer',
- 'format' => 'int32',
- 'required' => false,
- 'example' => '1',
- ],
+ 'schema' => ['description' => '校验参数是否正确', 'type' => 'boolean', 'required' => false, 'example' => 'false'],
],
[
- 'name' => 'resourceGroupId',
+ 'name' => 'regionId',
'in' => 'query',
+ 'schema' => ['title' => '区域标识符', 'description' => '区域标识符', 'type' => 'string', 'required' => false, 'example' => 'cn-shanghai'],
+ ],
+ [
+ 'name' => 'body',
+ 'in' => 'body',
+ 'style' => 'json',
'schema' => [
- 'description' => '资源组ID',
- 'type' => 'string',
+ 'description' => '请求体',
+ 'type' => 'object',
+ 'properties' => [
+ 'meta' => [
+ 'description' => '任务元数据',
+ 'type' => 'object',
+ 'properties' => [
+ 'apiKey' => ['description' => '访问凭证', 'type' => 'string', 'required' => false, 'example' => 'OS-xxx'],
+ 'regionId' => ['description' => '地域ID', 'type' => 'string', 'required' => false, 'example' => 'cn-shanghai'],
+ 'taskName' => ['description' => '任务名称'."\n", 'type' => 'string', 'required' => false, 'example' => 'test'],
+ 'computeResource' => ['description' => '计费规格'."\n", 'type' => 'string', 'required' => false, 'example' => 'small'],
+ 'labels' => [
+ 'description' => '标签列表',
+ 'type' => 'array',
+ 'items' => ['description' => '列表值', 'type' => 'string', 'required' => false, 'example' => 'name'],
+ 'required' => false,
+ ],
+ ],
+ 'required' => false,
+ ],
+ 'source' => [
+ 'description' => '数据源信息',
+ 'type' => 'array',
+ 'items' => [
+ 'description' => '数据源',
+ 'type' => 'object',
+ 'properties' => [
+ 'name' => ['description' => '**数据源名**', 'type' => 'string', 'required' => false, 'example' => 'table1'],
+ 'type' => ['description' => '**数据源类型**', 'type' => 'string', 'required' => false, 'example' => 'swift'],
+ 'parameters' => [
+ 'description' => '**数据源配置参数，由type决定**',
+ 'type' => 'object',
+ 'required' => false,
+ 'additionalProperties' => ['type' => 'string', 'description' => ''],
+ 'example' => '{'."\n"
+ .' "key1": "value1",'."\n"
+ .' "key2": "value2"'."\n"
+ .'}',
+ ],
+ 'schema' => [
+ 'description' => '**数据源Schema**',
+ 'type' => 'array',
+ 'items' => [
+ 'description' => '数据源schema名称',
+ 'type' => 'object',
+ 'required' => false,
+ 'additionalProperties' => ['type' => 'string', 'description' => ''],
+ ],
+ 'required' => false,
+ ],
+ 'primaryKey' => ['description' => '数据源主键字段'."\n", 'type' => 'string', 'required' => false, 'example' => 'id'],
+ ],
+ 'required' => false,
+ ],
+ 'required' => false,
+ ],
+ 'sink' => [
+ 'description' => '数据汇信息'."\n",
+ 'type' => 'array',
+ 'items' => [
+ 'description' => '数据汇',
+ 'type' => 'object',
+ 'properties' => [
+ 'name' => ['description' => '数据汇名'."\n", 'type' => 'string', 'required' => false, 'example' => 'table2'],
+ 'type' => ['description' => '数据汇类型', 'type' => 'string', 'required' => false, 'example' => 'swift'],
+ 'parameters' => [
+ 'description' => '数据汇配置参数，由type决定'."\n",
+ 'type' => 'object',
+ 'required' => false,
+ 'additionalProperties' => ['type' => 'string', 'description' => ''],
+ ],
+ 'schema' => [
+ 'description' => '数据汇Schema'."\n",
+ 'type' => 'array',
+ 'items' => [
+ 'description' => '数据汇Schema',
+ 'type' => 'object',
+ 'required' => false,
+ 'additionalProperties' => ['type' => 'string', 'description' => ''],
+ ],
+ 'required' => false,
+ ],
+ 'primaryKey' => ['description' => '数据汇主键字段', 'type' => 'string', 'required' => false, 'example' => 'id'],
+ ],
+ 'required' => false,
+ ],
+ 'required' => false,
+ ],
+ 'processors' => [
+ 'description' => '处理流程算子',
+ 'type' => 'array',
+ 'items' => [
+ 'description' => '处理流程算子',
+ 'type' => 'object',
+ 'properties' => [
+ 'name' => ['description' => '名称', 'type' => 'string', 'required' => false, 'example' => 'processor1'],
+ 'type' => ['description' => '类型', 'type' => 'string', 'required' => false, 'example' => 'document-analyze'],
+ 'input' => ['description' => '输入参数', 'type' => 'object', 'required' => false, 'example' => '{'."\n"
+ .' "key": "content"'."\n"
+ .'}'],
+ 'parameters' => ['description' => 'processor处理参数', 'type' => 'object', 'required' => false, 'example' => '{'."\n"
+ .' "service_id": "xxx"'."\n"
+ .'}'],
+ 'output' => ['description' => '输出参数', 'type' => 'object', 'required' => false, 'example' => '{'."\n"
+ .'"vector": "syh_image_uri_multi-modal-embedding"'."\n"
+ .'}'],
+ ],
+ 'required' => false,
+ ],
+ 'required' => false,
+ ],
+ 'parameters' => ['description' => '任务处理参数', 'type' => 'object', 'required' => false, 'example' => '{'."\n"
+ .' "parameter1": {'."\n"
+ .' "key": "value"'."\n"
+ .' },'."\n"
+ .' "parameter2": {'."\n"
+ .' "key": "value"'."\n"
+ .' }'."\n"
+ .'}'],
+ 'status' => [
+ 'description' => '任务状态',
+ 'type' => 'object',
+ 'properties' => [
+ 'status' => ['description' => '任务状态'."\n", 'type' => 'string', 'required' => false, 'example' => 'RUNNING'],
+ 'errorMessage' => ['description' => '错误信息'."\n", 'type' => 'string', 'required' => false, 'example' => '""'],
+ 'createTime' => ['description' => '任务启动时间'."\n", 'type' => 'integer', 'format' => 'int64', 'required' => false, 'example' => '1744941600000'],
+ 'deleteTime' => ['description' => '任务停止时间', 'type' => 'integer', 'format' => 'int64', 'required' => false, 'example' => '1744941600000'],
+ ],
+ 'required' => false,
+ ],
+ ],
'required' => false,
- 'example' => 'rg-aekzivjfrlpyn3y',
+ 'example' => 'cn-shanghai',
],
],
],
@@ -819,118 +925,106 @@
'description' => 'Schema of Response',
'type' => 'object',
'properties' => [
- 'requestId' => [
- 'title' => 'Id of the request',
- 'description' => 'Id of the request',
- 'type' => 'string',
- 'example' => '33E4F0CA-F766-5803-B11C-70DC57A5A6E4',
- ],
- 'totalCount' => [
- 'description' => '总条数。',
- 'type' => 'integer',
- 'format' => 'int32',
- 'example' => '1',
- ],
+ 'requestId' => ['title' => 'Id of the request', 'description' => 'Id of the request', 'type' => 'string', 'example' => 'B7C901ED-2BC1-5CFB-BE23-242DE5E3BA5C'],
'result' => [
'description' => '返回结果',
- 'type' => 'array',
- 'items' => [
- 'description' => '返回结果',
- 'type' => 'object',
- 'properties' => [
- 'chargeType' => [
- 'description' => '付费类型'."\n"
- .'- POSTPAY 后付费（按量付费）',
- 'type' => 'string',
- 'example' => 'POSTPAY',
- ],
- 'description' => [
- 'description' => '描述',
- 'type' => 'string',
- 'example' => '22222',
- ],
- 'domainName' => [
- 'description' => '个性域名前缀',
- 'type' => 'string',
- 'example' => 'default-xxx',
- ],
- 'engineType' => [
- 'description' => '引擎类型',
- 'type' => 'string',
- 'example' => 'rag',
- ],
- 'id' => [
- 'description' => '工作空间ID',
- 'type' => 'string',
- 'example' => '1222212',
- ],
- 'instanceId' => [
- 'description' => '实例ID',
- 'type' => 'string',
- 'example' => 'ops-cn-em93wcq0s001',
- ],
- 'name' => [
- 'description' => '工作空间名称',
- 'type' => 'string',
- 'example' => 'test',
+ 'type' => 'object',
+ 'properties' => [
+ 'meta' => [
+ 'description' => '任务元数据',
+ 'type' => 'object',
+ 'properties' => [
+ 'taskName' => ['description' => '任务名称', 'type' => 'string', 'example' => 'test'],
+ 'computeResource' => ['description' => '计费规格', 'type' => 'string', 'example' => 'small'],
],
- 'quota' => [
- 'description' => '配额',
+ ],
+ 'source' => [
+ 'description' => '数据源信息'."\n",
+ 'type' => 'array',
+ 'items' => [
+ 'description' => '数据源信息',
'type' => 'object',
'properties' => [
- 'computeResource' => [
- 'description' => '计算资源',
- 'type' => 'integer',
- 'format' => 'int32',
- 'example' => '0',
- ],
- 'docSize' => [
- 'description' => '存储容量',
- 'type' => 'integer',
- 'format' => 'int32',
- 'example' => '0',
+ 'name' => ['description' => '数据源名'."\n", 'type' => 'string', 'example' => 'table1'],
+ 'type' => ['description' => '数据源类型'."\n", 'type' => 'string', 'example' => 'swift'],
+ 'parameters' => [
+ 'description' => '数据源配置参数，由type决定'."\n",
+ 'type' => 'object',
+ 'additionalProperties' => ['type' => 'string', 'description' => 'key为String类型', 'example' => 'key'],
],
- 'spec' => [
- 'description' => '规格',
- 'type' => 'string',
- 'example' => 'rag.share.compute',
+ 'schema' => [
+ 'description' => '数据源Schema',
+ 'type' => 'array',
+ 'items' => [
+ 'description' => 'Schema',
+ 'type' => 'object',
+ 'additionalProperties' => ['type' => 'string', 'example' => '""', 'description' => 'key为String类型'],
+ ],
],
+ 'primaryKey' => ['description' => '数据源主键字段', 'type' => 'string', 'example' => 'id'],
],
],
- 'resourceGroupId' => [
- 'description' => '资源组ID',
- 'type' => 'string',
- 'example' => 'rg-aekzvlxzgo5b4si',
- ],
- 'tags' => [
- 'description' => '标签',
- 'type' => 'array',
- 'items' => [
- 'description' => '标签',
- 'type' => 'object',
- 'properties' => [
- 'tagKey' => [
- 'description' => '标签键',
- 'type' => 'string',
- 'example' => 'a',
- ],
- 'tagValue' => [
- 'description' => '标签值',
- 'type' => 'string',
- 'example' => 'c',
+ ],
+ 'sink' => [
+ 'description' => '输出端信息',
+ 'type' => 'array',
+ 'items' => [
+ 'description' => '输出端信息',
+ 'type' => 'object',
+ 'properties' => [
+ 'name' => ['description' => '数据汇名'."\n", 'type' => 'string', 'example' => 'table2'],
+ 'type' => ['description' => '数据汇类型'."\n", 'type' => 'string', 'example' => 'swift'],
+ 'parameters' => [
+ 'description' => '数据汇配置参数，由type决定'."\n",
+ 'type' => 'object',
+ 'additionalProperties' => ['type' => 'string', 'description' => 'key为String类型', 'example' => 'key1'],
+ ],
+ 'schema' => [
+ 'description' => '数据汇Schema'."\n",
+ 'type' => 'array',
+ 'items' => [
+ 'description' => '数据汇Schema',
+ 'type' => 'object',
+ 'additionalProperties' => ['type' => 'string', 'description' => 'key为String类型', 'example' => '"name"'],
],
],
+ 'primaryKey' => ['description' => '数据汇主键字段 ', 'type' => 'string', 'example' => 'id'],
],
],
- 'type' => [
- 'description' => '类型',
- 'type' => 'string',
- 'example' => 'standard',
+ ],
+ 'processors' => [
+ 'description' => '处理流程算子',
+ 'type' => 'array',
+ 'items' => [
+ 'description' => '处理流程算子',
+ 'type' => 'object',
+ 'properties' => [
+ 'name' => ['description' => '名称', 'type' => 'string', 'example' => '"processor1"'],
+ 'type' => ['description' => '类型', 'type' => 'string', 'example' => '"document-analyze"'],
+ 'input' => ['description' => '输入参数', 'type' => 'object'],
+ 'parameters' => ['description' => 'processor处理参数', 'type' => 'object', 'example' => '{'."\n"
+ .'"service_id": "xxx"'."\n"
+ .'}'],
+ ],
],
- 'apiToken' => [
- 'description' => 'apiToken',
- 'type' => 'string',
- 'example' => 'apiToken',
+ ],
+ 'parameters' => ['description' => '任务处理参数', 'type' => 'object', 'example' => '{'."\n"
+ .'"parameter1": {'."\n"
+ .'"key": "value"'."\n"
+ .'},'."\n"
+ .'"parameter2": {'."\n"
+ .'"key": "value"'."\n"
+ .'}'."\n"
+ .'}'],
+ 'status' => [
+ 'description' => '任务状态',
+ 'type' => 'object',
+ 'properties' => [
+ 'status' => ['description' => '任务状态', 'type' => 'string', 'example' => 'RUNNING'],
+ 'createTime' => ['description' => '任务启动时间'."\n"
+ ."\n", 'type' => 'string', 'example' => '1744941600000'],
+ 'deleteTime' => ['description' => '任务停止时间'."\n", 'type' => 'string', 'example' => '1744941600000'],
+ 'errorMessage' => ['description' => '错误信息', 'type' => 'string', 'example' => '""'],
],
],
],
@@ -939,48 +1033,120 @@
],
],
],
- 'staticInfo' => [
- 'returnType' => 'synchronous',
+ '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' => '创建离线任务',
+ 'description' => '## 请求说明'."\n",
+ 'changeSet' => [
+ ['createdAt' => '2025-12-02T07:12:30.000Z', 'description' => '请求参数发生变更'],
+ ],
+ 'ramActions' => [
+ [
+ 'operationType' => 'create',
+ 'ramAction' => [
+ 'action' => 'searchplat:CreateOfflineTask',
+ 'authLevel' => 'operate',
+ 'actionConditions' => [],
+ 'resources' => [
+ ['validationType' => 'always', 'product' => 'SearchPlat', 'resourceType' => '全部资源', 'arn' => '*'],
+ ],
+ ],
+ ],
],
- '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' => '获取工作空间列表',
],
- 'DeleteWorkspace' => [
- 'summary' => '删除工作空间',
- 'path' => '/openapi/platform/workspaces/{workspaceName}',
- 'methods' => [
- 'delete',
- ],
- 'schemes' => [
- 'http',
- 'https',
- ],
+ 'CreateRagEvaluatorTask' => [
+ 'summary' => 'rag版评测任务创建。',
+ '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' => 'none',
+ 'operationType' => 'create',
'riskType' => 'none',
'chargeType' => 'free',
- 'abilityTreeCode' => '218190',
- 'abilityTreeNodes' => [
- 'FEATUREopensearch2ESE2N',
- ],
+ 'abilityTreeCode' => '226065',
+ 'abilityTreeNodes' => ['FEATUREopensearchWAC9DF'],
],
'parameters' => [
[
'name' => 'workspaceName',
'in' => 'path',
+ 'schema' => ['description' => '工作空间名称。', 'type' => 'string', 'required' => false, 'example' => 'myWorkspace'],
+ ],
+ [
+ 'name' => 'body',
+ 'in' => 'body',
+ 'style' => 'json',
'schema' => [
- 'title' => 'A short description of struct',
- 'description' => '工作空间名称。',
- 'type' => 'string',
- 'required' => true,
- 'example' => 'myWorkspace',
+ 'description' => '请求体',
+ 'type' => 'object',
+ 'properties' => [
+ 'app_name' => ['description' => 'app_name', 'type' => 'string', 'required' => false, 'example' => '空'],
+ 'task_name' => ['description' => '评测任务名称', 'type' => 'string', 'required' => false, 'example' => 'taskName'],
+ 'data' => [
+ 'description' => '评测数据列表',
+ 'type' => 'array',
+ 'items' => [
+ 'description' => '评测数据',
+ 'type' => 'object',
+ 'properties' => [
+ 'question' => ['description' => 'question', 'type' => 'string', 'required' => false, 'example' => '空'],
+ 'standard_answer' => ['description' => 'standard_answer', 'type' => 'string', 'required' => false, 'example' => '空'],
+ 'recall_docs' => [
+ 'description' => 'recall_docs',
+ 'type' => 'array',
+ 'items' => ['description' => 'recall_doc', 'type' => 'string', 'required' => false, 'example' => '空'],
+ 'required' => false,
+ ],
+ 'model_answer' => ['description' => 'model_answer', 'type' => 'string', 'required' => false, 'example' => '空'],
+ ],
+ 'required' => false,
+ ],
+ 'required' => false,
+ ],
+ 'evaluate_config' => [
+ 'description' => '评测配置',
+ 'type' => 'object',
+ 'properties' => [
+ 'model' => ['description' => '使用模型', 'type' => 'string', 'required' => false, 'example' => 'qwen-72b'],
+ 'prompt' => ['description' => 'prompt', 'type' => 'string', 'required' => false, 'example' => '空'],
+ 'run_all_step' => ['description' => 'run_all_step', 'type' => 'boolean', 'required' => false, 'example' => 'false'],
+ ],
+ 'required' => false,
+ ],
+ 'metrics' => [
+ 'description' => '指标值。'."\n"
+ .'- context_recall'."\n"
+ .'- context_precision'."\n"
+ .'- faithfulness'."\n"
+ .'- satisfaction'."\n"
+ .'- comprehensive_score',
+ 'type' => 'array',
+ 'items' => ['description' => '指标值。', 'type' => 'any', 'required' => false, 'example' => 'context_recall'],
+ 'required' => false,
+ ],
+ 'emails' => [
+ 'description' => 'emails',
+ 'type' => 'array',
+ 'items' => ['description' => 'email', 'type' => 'string', 'required' => false, 'example' => '空'],
+ 'required' => false,
+ ],
+ 'has_data_source' => ['description' => 'has_data_source', 'type' => 'boolean', 'required' => false, 'example' => '空'],
+ 'data_source_config' => ['description' => '配置数据源配置', 'type' => 'any', 'required' => false, 'example' => '{'."\n"
+ .'"data_source_type": "oss",'."\n"
+ .'"file_path": "oss://xxx.",'."\n"
+ .'"file_name": "04837719-default-zz.xlsx"'."\n"
+ .'}'],
+ ],
+ 'required' => false,
],
],
],
@@ -991,108 +1157,88 @@
'description' => 'Schema of Response',
'type' => 'object',
'properties' => [
- 'requestId' => [
- 'title' => 'Id of the request',
- 'description' => 'Id of the request',
- 'type' => 'string',
- 'example' => '5950143C-B8F0-5758-A08A-66F302FD587F',
- ],
+ 'requestId' => ['title' => 'Id of the request', 'description' => 'Id of the request', 'type' => 'string', 'example' => '0abb793917165176014887584e28d9'],
+ 'code' => ['description' => '错误码'."\n", 'type' => 'string', 'example' => 'not found'],
+ 'message' => ['description' => '错误信息。', 'type' => 'string', 'example' => '"xx not found"'],
'result' => [
'description' => '返回结果',
'type' => 'object',
'properties' => [
- 'instanceId' => [
- 'description' => '实例ID',
- 'type' => 'string',
- 'example' => 'ops-cn-em93wcq0s001',
- ],
+ 'taskId' => ['description' => '任务id', 'type' => 'string', 'example' => '1846389386674049024'],
],
],
],
],
],
],
- 'staticInfo' => [
- 'returnType' => 'synchronous',
+ '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' => '创建评测任务',
+ 'changeSet' => [],
+ 'ramActions' => [
+ [
+ 'operationType' => 'create',
+ 'ramAction' => [
+ 'action' => 'searchplat:WriteEvaluation',
+ 'authLevel' => 'operate',
+ 'actionConditions' => [],
+ 'resources' => [
+ ['validationType' => 'always', 'product' => 'SearchPlat', 'resourceType' => '全部资源', 'arn' => '*'],
+ ],
+ ],
+ ],
],
- 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"requestId\\": \\"5950143C-B8F0-5758-A08A-66F302FD587F\\",\\n \\"result\\": {\\n \\"instanceId\\": \\"ops-cn-em93wcq0s001\\"\\n }\\n}","type":"json"}]',
- 'title' => '删除工作空间',
],
- 'UpdateCredentials' => [
- 'path' => '/openapi/platform/workspaces/{workspaceName}/credentials/{token}',
- 'methods' => [
- 'put',
- ],
- 'schemes' => [
- 'http',
- 'https',
- ],
+ 'CreateWorkspace' => [
+ 'summary' => '创建工作空间',
+ 'path' => '/openapi/platform/workspaces',
+ 'methods' => ['post'],
+ 'schemes' => ['http', 'https'],
'security' => [
[
'AK' => [],
],
],
- 'operationType' => 'readAndWrite',
+ 'operationType' => 'write',
'deprecated' => false,
'systemTags' => [
'operationType' => 'none',
- 'abilityTreeCode' => '220526',
- 'abilityTreeNodes' => [
- 'FEATUREopensearch1AJKH0',
- ],
+ 'riskType' => 'none',
+ 'chargeType' => 'free',
+ 'abilityTreeCode' => '218195',
+ 'abilityTreeNodes' => ['FEATUREopensearch2ESE2N'],
],
'parameters' => [
[
- 'name' => 'token',
- 'in' => 'path',
- 'schema' => [
- 'description' => '访问凭证token。',
- 'type' => 'string',
- 'required' => true,
- 'example' => 'OS-****',
- ],
- ],
- [
- 'name' => 'dryRun',
- 'in' => 'query',
- 'schema' => [
- 'description' => '是否为空运行请求',
- 'type' => 'boolean',
- 'required' => false,
- 'example' => 'true',
- ],
- ],
- [
'name' => 'body',
'in' => 'body',
'style' => 'json',
'schema' => [
- 'description' => '请求Body。',
+ 'description' => '请求body。',
'type' => 'object',
'properties' => [
- 'enabled' => [
- 'description' => '凭据是否启用。'."\n"
- .'取值：'."\n"
- ."\n"
- .'- true：启用。 '."\n"
- .'- false：禁用。',
- 'type' => 'boolean',
+ 'chargeType' => ['description' => '付费类型'."\n"
+ .'- POSTPAY 后付费（按量付费）', 'type' => 'string', 'required' => false, 'example' => 'POSTPAY'],
+ 'engineType' => ['description' => '引擎类型'."\n"
+ .'- rag', 'type' => 'string', 'required' => false, 'example' => 'rag'],
+ 'name' => ['description' => '工作空间名称', 'type' => 'string', 'required' => false, 'example' => 'default'],
+ 'quota' => [
+ 'description' => '配额',
+ 'type' => 'object',
+ 'properties' => [
+ 'computeResource' => ['description' => '计算资源（单位：LCU）', 'type' => 'integer', 'format' => 'int32', 'required' => false, 'example' => '0'],
+ 'docSize' => ['description' => '存储容量（单位：GB）', 'type' => 'integer', 'format' => 'int32', 'required' => false, 'example' => '0'],
+ 'spec' => ['description' => '规格'."\n"
+ .'- rag.share.common', 'type' => 'string', 'required' => false, 'example' => 'rag.share.common'."\n"],
+ ],
'required' => false,
],
+ 'type' => ['description' => '类型'."\n"
+ .'- standard', 'type' => 'string', 'required' => false, 'example' => 'standard'],
],
'required' => false,
],
],
- [
- 'name' => 'workspaceName',
- 'in' => 'path',
- 'schema' => [
- 'description' => '工作空间名称。',
- 'type' => 'string',
- 'required' => true,
- 'example' => 'myWorkspace',
- ],
- ],
],
'responses' => [
200 => [
@@ -1101,122 +1247,103 @@
'description' => 'Schema of Response',
'type' => 'object',
'properties' => [
- 'requestId' => [
- 'title' => 'Id of the request',
- 'description' => 'Id of the request',
- 'type' => 'string',
- 'example' => '1CC93E65-6734-5060-BEF7-0EB0A4862BCF',
- ],
+ 'requestId' => ['title' => 'Id of the request', 'description' => 'Id of the request', 'type' => 'string', 'example' => '2BA0504F-B179-586D-8210-A7C7C09A9907'],
'result' => [
- 'description' => '返回结果。',
+ 'description' => '返回结果',
'type' => 'object',
'properties' => [
- 'token' => [
- 'description' => '访问凭证token。',
- 'type' => 'string',
- 'example' => 'OS-****',
- ],
- 'appGroupId' => [
- 'description' => '工作空间ID。',
- 'type' => 'integer',
- 'format' => 'int64',
- 'example' => '12321321',
- ],
- 'type' => [
- 'description' => '凭证类型。可传类型有：'."\n"
- .'- api-token',
- 'type' => 'string',
- 'example' => 'api-token',
+ 'chargeType' => ['description' => '付费类型'."\n"
+ .'- POSTPAY 后付费（按量付费）', 'type' => 'string', 'example' => 'POSTPAY'],
+ 'commodityCode' => ['description' => '商品CODE', 'type' => 'string', 'example' => 'opensearch_platform_public_cn'],
+ 'description' => ['description' => '工作空间描述', 'type' => 'string', 'example' => '描述'],
+ 'domainName' => ['description' => '个性域名前缀', 'type' => 'string', 'example' => 'defalult-xxxx'],
+ 'engineType' => ['description' => '引擎类型', 'type' => 'string', 'example' => 'rag'],
+ 'id' => ['description' => '工作空间id', 'type' => 'string', 'example' => '120142804'],
+ 'instanceId' => ['description' => '工作空间实例id', 'type' => 'string', 'example' => 'ops-xxxxx'],
+ 'name' => ['description' => '工作空间名称', 'type' => 'string', 'example' => 'default'],
+ 'quota' => [
+ 'description' => '配额',
+ 'type' => 'object',
+ 'properties' => [
+ 'computeResource' => ['description' => '计算资源', 'type' => 'integer', 'format' => 'int32', 'example' => '0'],
+ 'docSize' => ['description' => '存储容量', 'type' => 'integer', 'format' => 'int32', 'example' => '0'],
+ 'spec' => ['description' => '规格', 'type' => 'string', 'example' => 'rag.share.common'],
+ ],
],
- 'enabled' => [
- 'description' => '凭据是否启用。'."\n"
- .'取值：'."\n"
- ."\n"
- .'- true：启用。 '."\n"
- .'- false：禁用。',
- 'type' => 'boolean',
- 'example' => 'false',
+ 'resourceGroupId' => ['description' => '资源组ID', 'type' => 'string', 'example' => 'rg-xxxxxx'],
+ 'tags' => [
+ 'description' => '标签',
+ 'type' => 'array',
+ 'items' => [
+ 'type' => 'object',
+ 'properties' => [
+ 'tagKey' => ['description' => '标签键', 'type' => 'string', 'example' => 'a'],
+ 'tagValue' => ['description' => '标签值', 'type' => 'string', 'example' => 'c'],
+ ],
+ 'description' => '',
+ ],
],
+ 'type' => ['description' => '类型', 'type' => 'string', 'example' => 'standard'],
],
],
],
],
],
],
- 'staticInfo' => [
- 'returnType' => 'synchronous',
+ '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' => '创建工作空间',
+ 'changeSet' => [],
+ 'ramActions' => [
+ [
+ 'operationType' => 'none',
+ 'ramAction' => [
+ 'action' => 'searchplat:WriteWorkspace',
+ 'authLevel' => 'resource',
+ 'actionConditions' => [],
+ 'resources' => [
+ ['validationType' => 'always', 'product' => 'SearchPlat', 'resourceType' => '全部资源', 'arn' => '*'],
+ ],
+ ],
+ ],
],
- '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' => '更新访问凭证',
],
- 'CreateCredentials' => [
- 'path' => '/openapi/platform/workspaces/{workspaceName}/credentials',
- 'methods' => [
- 'post',
- ],
- 'schemes' => [
- 'http',
- 'https',
- ],
+ 'DeleteCapability' => [
+ 'summary' => '用于从指定工作空间中删除特定类别的配置项。',
+ 'path' => '/openapi/platform/workspaces/{workspaceName}/capabilities/{itemCategory}/items/{itemName}',
+ 'methods' => ['delete'],
+ 'schemes' => ['https'],
'security' => [
[
'AK' => [],
],
],
- 'operationType' => 'readAndWrite',
+ 'consumes' => ['application/json'],
+ 'produces' => ['application/json'],
+ 'operationType' => 'write',
'deprecated' => false,
'systemTags' => [
- 'operationType' => 'create',
- 'abilityTreeCode' => '220521',
- 'abilityTreeNodes' => [
- 'FEATUREopensearch1AJKH0',
- ],
+ 'operationType' => 'delete',
+ 'riskType' => 'none',
+ 'chargeType' => 'free',
+ 'abilityTreeNodes' => ['FEATUREopensearch8B42ZS'],
+ 'tenantRelevance' => 'tenant',
],
'parameters' => [
[
- 'name' => 'dryRun',
- 'in' => 'query',
- 'schema' => [
- 'description' => '是否校验入参数据合法性，默认false。'."\n"
- ."\n"
- .'取值：'."\n"
- ."\n"
- .'- **true**：只校验参数合法性。'."\n"
- ."\n"
- .'- **false**：校验参数合法性，创建归因配置。',
- 'type' => 'boolean',
- 'required' => false,
- 'example' => 'true',
- ],
+ 'name' => 'workspaceName',
+ 'in' => 'path',
+ 'schema' => ['description' => '**工作空间名称**'."\n", 'type' => 'string', 'required' => true, 'example' => 'default'],
],
[
- 'name' => 'body',
- 'in' => 'body',
- 'style' => 'json',
- 'schema' => [
- 'description' => '请求Body。',
- 'type' => 'object',
- 'properties' => [
- 'type' => [
- 'description' => '凭证类型。可传类型有：'."\n"
- .'- api-token',
- 'type' => 'string',
- 'required' => false,
- 'example' => 'api-token',
- ],
- ],
- 'required' => false,
- ],
+ 'name' => 'itemCategory',
+ 'in' => 'path',
+ 'schema' => ['description' => '**配置类别ai_search_agent**'."\n", 'type' => 'string', 'required' => true, 'example' => 'ai_search_agent'],
],
[
- 'name' => 'workspaceName',
+ 'name' => 'itemName',
'in' => 'path',
- 'schema' => [
- 'description' => '工作空间名称。',
- 'type' => 'string',
- 'required' => true,
- 'example' => 'myWorkspace',
- ],
+ 'schema' => ['description' => '**配置名称**'."\n", 'type' => 'string', 'required' => true, 'example' => 'es_knowledge_base'],
],
],
'responses' => [
@@ -1226,64 +1353,37 @@
'description' => 'Schema of Response',
'type' => 'object',
'properties' => [
- 'requestId' => [
- 'title' => 'Id of the request',
- 'description' => 'Id of the request',
- 'type' => 'string',
- 'example' => '2E37A447-C010-5A49-9F31-DE12E97710A3',
- ],
- 'result' => [
- 'description' => '返回结果',
- 'type' => 'object',
- 'properties' => [
- 'appGroupId' => [
- 'description' => '工作空间ID。',
- 'type' => 'integer',
- 'format' => 'int64',
- 'example' => '12323',
- ],
- 'type' => [
- 'description' => '凭证类型。'."\n"
- ."\n"
- .'- api-token',
- 'type' => 'string',
- 'example' => 'api-token'."\n",
- ],
- 'enabled' => [
- 'description' => '凭据是否启用。'."\n"
- .'取值：'."\n"
- ."\n"
- .'- true：启用。 '."\n"
- .'- false：禁用。',
- 'type' => 'boolean',
- 'example' => 'false',
- ],
- 'token' => [
- 'description' => '生成的凭据令牌。',
- 'type' => 'string',
- 'example' => 'OS-********',
- ],
- ],
- ],
+ 'requestId' => ['title' => 'Id of the request', 'description' => '请求ID'."\n", 'type' => 'string', 'example' => '7CC54C38-D721-4C55-A410-2A94B5A6BE0F'],
+ 'httpCode' => ['description' => '**HTTP状态码**'."\n", 'type' => 'integer', 'format' => 'int64', 'example' => '200'],
+ 'status' => ['description' => '**状态**'."\n", 'type' => 'string', 'example' => 'OK'],
],
],
],
],
- 'staticInfo' => [
- 'returnType' => 'synchronous',
+ 'staticInfo' => ['returnType' => 'synchronous'],
+ 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"requestId\\": \\"7CC54C38-D721-4C55-A410-2A94B5A6BE0F\\",\\n \\"httpCode\\": 200,\\n \\"status\\": \\"OK\\"\\n}","type":"json"}]',
+ 'title' => '删除配置项',
+ 'description' => '## 请求说明'."\n"
+ .'该 API 允许用户通过指定的工作空间名称、配置类别以及配置名称来删除一个具体的配置项。请确保在调用此接口前，您已经获得了足够的权限（如RAM Policy中的`DeleteCapability`动作）。此外，请注意，一旦某个配置被删除，与之相关的所有数据和服务可能也会受到影响。'."\n",
+ 'changeSet' => [],
+ 'ramActions' => [
+ [
+ 'operationType' => 'delete',
+ 'ramAction' => [
+ 'action' => 'searchplat:DeleteCapability',
+ 'authLevel' => 'operate',
+ 'actionConditions' => [],
+ 'resources' => [
+ ['validationType' => 'always', 'product' => 'SearchPlat', 'resourceType' => '全部资源', 'arn' => '*'],
+ ],
+ ],
+ ],
],
- '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' => '创建访问凭证',
],
'DeleteCredentials' => [
'path' => '/openapi/platform/workspaces/{workspaceName}/credentials/{token}',
- 'methods' => [
- 'delete',
- ],
- 'schemes' => [
- 'http',
- 'https',
- ],
+ 'methods' => ['delete'],
+ 'schemes' => ['http', 'https'],
'security' => [
[
'AK' => [],
@@ -1293,30 +1393,18 @@
'systemTags' => [
'operationType' => 'delete',
'abilityTreeCode' => '220523',
- 'abilityTreeNodes' => [
- 'FEATUREopensearch1AJKH0',
- ],
+ 'abilityTreeNodes' => ['FEATUREopensearch1AJKH0'],
],
'parameters' => [
[
'name' => 'token',
'in' => 'path',
- 'schema' => [
- 'description' => '访问凭证token。',
- 'type' => 'string',
- 'required' => true,
- 'example' => 'OS-********',
- ],
+ 'schema' => ['description' => '访问凭证token。', 'type' => 'string', 'required' => true, 'example' => 'OS-********'],
],
[
'name' => 'workspaceName',
'in' => 'path',
- 'schema' => [
- 'description' => '工作空间名称。',
- 'type' => 'string',
- 'required' => true,
- 'example' => 'myWorkspace',
- ],
+ 'schema' => ['description' => '工作空间名称。', 'type' => 'string', 'required' => true, 'example' => 'myWorkspace'],
],
],
'responses' => [
@@ -1324,83 +1412,74 @@
'schema' => [
'type' => 'object',
'properties' => [
- 'requestId' => [
- 'description' => '请求id',
- 'type' => 'string',
- 'example' => '2423C841-91C4-5E51-B296-590D367967FC',
- ],
+ 'requestId' => ['description' => '请求id', 'type' => 'string', 'example' => '2423C841-91C4-5E51-B296-590D367967FC'],
],
+ 'description' => '',
],
],
'5XX' => [
'schema' => [
'type' => 'object',
'properties' => [
- 'code' => [
- 'type' => 'string',
- ],
- 'requestId' => [
- 'type' => 'string',
- ],
- 'message' => [
- 'type' => 'string',
- ],
- 'httpCode' => [
- 'type' => 'integer',
- 'format' => 'int32',
- ],
+ 'code' => ['type' => 'string', 'description' => ''],
+ 'requestId' => ['type' => 'string', 'description' => ''],
+ 'message' => ['type' => 'string', 'description' => ''],
+ 'httpCode' => ['type' => 'integer', 'format' => 'int32', 'description' => ''],
],
+ 'description' => '',
],
],
],
- 'staticInfo' => [
- 'returnType' => 'synchronous',
- ],
+ 'staticInfo' => ['returnType' => 'synchronous'],
'responseDemo' => '[{"errorExample":"","example":"{\\n \\"requestId\\": \\"2423C841-91C4-5E51-B296-590D367967FC\\"\\n}","type":"json"}]',
'title' => '删除访问凭证',
- ],
- 'GetCredentials' => [
- 'path' => '/openapi/platform/workspaces/{workspaceName}/credentials/{token}',
- 'methods' => [
- 'get',
- ],
- 'schemes' => [
- 'http',
- 'https',
+ 'summary' => '删除访问凭证',
+ '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' => 'read',
+ 'operationType' => 'readAndWrite',
+ 'deprecated' => false,
'systemTags' => [
- 'operationType' => 'get',
- 'abilityTreeCode' => '220524',
- 'abilityTreeNodes' => [
- 'FEATUREopensearch1AJKH0',
- ],
+ 'operationType' => 'delete',
+ 'abilityTreeCode' => '225361',
+ 'abilityTreeNodes' => ['FEATUREopensearch1AJKH0'],
],
'parameters' => [
[
- 'name' => 'token',
+ 'name' => 'dryRun',
+ 'in' => 'query',
+ 'schema' => ['description' => '是否为空运行请求', 'type' => 'boolean', 'required' => false, 'example' => 'false'],
+ ],
+ [
+ 'name' => 'id',
'in' => 'path',
- 'schema' => [
- 'description' => '访问凭证token。',
- 'type' => 'string',
- 'required' => true,
- 'example' => 'OS-********',
- ],
+ 'schema' => ['description' => '数据id', 'type' => 'integer', 'format' => 'int64', 'required' => true, 'example' => '1956'],
],
[
'name' => 'workspaceName',
'in' => 'path',
- 'schema' => [
- 'description' => '工作空间名称。',
- 'type' => 'string',
- 'required' => true,
- 'example' => 'myWorkspace',
- ],
+ 'schema' => ['description' => '工作空间名称。', 'type' => 'string', 'required' => true, 'example' => 'myWorkspace'],
],
],
'responses' => [
@@ -1410,254 +1489,143 @@
'description' => 'Schema of Response',
'type' => 'object',
'properties' => [
- 'requestId' => [
- 'title' => 'Id of the request',
- 'description' => 'Id of the request',
- 'type' => 'string',
- 'example' => 'B7C901ED-2BC1-5CFB-BE23-242DE5E3BA5C',
- ],
- 'result' => [
- 'description' => '查询结果'."\n",
- 'type' => 'object',
- 'properties' => [
- 'appGroupId' => [
- 'description' => '工作空间ID。',
- 'type' => 'integer',
- 'format' => 'int64',
- 'example' => '111111',
- ],
- 'type' => [
- 'description' => '凭证类型。'."\n"
- ."\n"
- .'- api-token',
- 'type' => 'string',
- 'example' => 'api-token'."\n",
- ],
- 'enabled' => [
- 'description' => '凭据是否启用。'."\n"
- .'取值：'."\n"
- ."\n"
- .'true：启用。'."\n"
- ."\n"
- .'false：禁用。',
- 'type' => 'boolean',
- 'example' => 'true',
- ],
- 'token' => [
- 'description' => '访问凭证token。',
- 'type' => 'string',
- 'example' => 'OS-********'."\n",
- ],
- ],
- ],
+ 'requestId' => ['title' => 'Id of the request', 'description' => 'Id of the request', 'type' => 'string', 'example' => '65C620DA-D6BE-5F56-BBCD-6F2282BB7BAD'],
],
],
],
],
- 'staticInfo' => [
- 'returnType' => 'synchronous',
+ 'staticInfo' => ['returnType' => 'synchronous'],
+ 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"requestId\\": \\"65C620DA-D6BE-5F56-BBCD-6F2282BB7BAD\\"\\n}","type":"json"}]',
+ 'title' => '删除体验数据',
+ 'summary' => '删除体验数据',
+ '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}'],
+ ],
+ ],
+ ],
],
- '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' => '获取访问凭证详情',
],
- 'ListCredentials' => [
- 'path' => '/openapi/platform/workspaces/{workspaceName}/credentials',
- 'methods' => [
- 'get',
- ],
- 'schemes' => [
- 'http',
- 'https',
- ],
+ 'DeleteFunctionInstance' => [
+ 'summary' => '删除服务配置',
+ 'path' => '/openapi/platform/workspaces/{workspaceName}/functions/{functionName}/instances/{instanceName}',
+ 'methods' => ['delete'],
+ 'schemes' => ['https'],
'security' => [
[
'AK' => [],
],
],
- 'operationType' => 'read',
+ 'operationType' => 'write',
'deprecated' => false,
'systemTags' => [
- 'operationType' => 'list',
- 'abilityTreeCode' => '220525',
- 'abilityTreeNodes' => [
- 'FEATUREopensearch1AJKH0',
- ],
+ 'operationType' => 'delete',
+ 'riskType' => 'none',
+ 'chargeType' => 'free',
+ 'abilityTreeCode' => '239777',
+ 'abilityTreeNodes' => ['FEATUREopensearchJK5SO0'],
+ 'autoTest' => true,
+ 'tenantRelevance' => 'publicInformation',
],
'parameters' => [
[
- 'name' => 'pageSize',
- 'in' => 'query',
- 'schema' => [
- 'description' => '每页大小，默认值为10',
- 'type' => 'integer',
- 'format' => 'int32',
- 'required' => false,
- 'maximum' => '100',
- 'minimum' => '10',
- 'example' => '10',
- ],
- ],
- [
- 'name' => 'pageNumber',
- 'in' => 'query',
- 'schema' => [
- 'description' => '页码，默认 pageNumber = 1',
- 'type' => 'integer',
- 'format' => 'int32',
- 'required' => false,
- 'example' => '1',
- ],
+ 'name' => 'workspaceName',
+ 'in' => 'path',
+ 'schema' => ['title' => 'opensearch应用名', 'description' => '工作空间名称。', 'type' => 'string', 'required' => false, 'example' => 'myWorkspace'],
],
[
- 'name' => 'keyword',
- 'in' => 'query',
- 'schema' => [
- 'description' => '凭证值搜索关键词',
- 'type' => 'string',
- 'required' => false,
- 'example' => 'OS-**',
- ],
+ 'name' => 'functionName',
+ 'in' => 'path',
+ 'schema' => ['title' => '功能名称', 'description' => '服务/模型配置', 'type' => 'string', 'required' => false, 'example' => 'nl2sql'],
],
[
- 'name' => 'workspaceName',
+ 'name' => 'instanceName',
'in' => 'path',
- 'schema' => [
- 'description' => '工作空间名称。',
- 'type' => 'string',
- 'required' => true,
- 'example' => 'myWorkspace',
- ],
+ 'schema' => ['title' => '实例名称', 'description' => '配置名称', 'type' => 'string', 'required' => true, 'example' => 'test'],
],
],
'responses' => [
200 => [
'schema' => [
- 'title' => 'Schema of Response',
- 'description' => 'Schema of Response',
'type' => 'object',
'properties' => [
- 'requestId' => [
- 'title' => 'Id of the request',
- 'description' => 'Id of the request',
- 'type' => 'string',
- 'example' => '33E4F0CA-F766-5803-B11C-70DC57A5A6E4',
- ],
- 'result' => [
- 'description' => '返回结果',
- 'type' => 'array',
- 'items' => [
- 'description' => '返回结果',
- 'type' => 'object',
- 'properties' => [
- 'token' => [
- 'description' => '访问凭证token。',
- 'type' => 'string',
- 'example' => 'OS-****',
- ],
- 'enabled' => [
- 'description' => '凭据是否启用。'."\n"
- .'取值：'."\n"
- ."\n"
- .'- true：启用。 '."\n"
- .'- false：禁用。',
- 'type' => 'boolean',
- 'example' => 'true',
- ],
- 'type' => [
- 'description' => '凭证类型。'."\n"
- ."\n"
- .'- api-token',
- 'type' => 'string',
- 'example' => 'api-token'."\n",
- ],
- 'appGroupId' => [
- 'description' => '工作空间ID。',
- 'type' => 'integer',
- 'format' => 'int64',
- 'example' => '123123',
- ],
- ],
- ],
- ],
- 'totalCount' => [
- 'description' => '总条数。',
- 'type' => 'integer',
- 'format' => 'int64',
- 'example' => '1',
- ],
+ 'Code' => ['description' => '错误码。仅当返回异常时显示。', 'type' => 'string', 'example' => 'iot.common.RamActionPermissionDeny'],
+ 'HttpCode' => ['description' => 'http状态码', 'type' => 'integer', 'format' => 'int64', 'example' => '200'],
+ 'Latency' => ['description' => '请求耗时，单位ms', 'type' => 'integer', 'format' => 'int64', 'example' => '12'],
+ 'Message' => ['description' => '错误信息。仅当返回异常时显示。', 'type' => 'string', 'example' => 'Managed id is empty'],
+ 'RequestId' => ['description' => '请求ID。', 'type' => 'string', 'example' => '786CC01F-0F1D-5FB5-8BFF-B0F3DB289772'],
+ 'Status' => ['description' => '请求状态。', 'type' => 'string', 'example' => 'OK'],
],
+ 'description' => '',
],
],
],
- 'staticInfo' => [
- 'returnType' => 'synchronous',
+ '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' => '删除服务/模型配置',
+ '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}'],
+ ],
+ ],
+ ],
],
- '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' => '查询访问凭证列表',
],
- 'GetExperienceData' => [
- 'summary' => '获取体验数据详情。',
- 'path' => '/openapi/platform/workspaces/{workspaceName}/experience-data/{id}',
- 'methods' => [
- 'get',
- ],
- 'schemes' => [
- 'http',
- 'https',
- ],
+ 'DeleteOfflineTask' => [
+ 'summary' => '删除离线任务',
+ 'path' => '/openapi/platform/workspaces/{workspaceName}/offline-tasks/{type}/{taskName}',
+ 'methods' => ['delete'],
+ 'schemes' => ['https'],
'security' => [
[
'AK' => [],
],
],
- 'operationType' => 'readAndWrite',
+ 'consumes' => ['application/json'],
+ 'produces' => ['application/json'],
+ 'operationType' => 'read',
'deprecated' => false,
'systemTags' => [
- 'operationType' => 'get',
+ 'operationType' => 'delete',
'riskType' => 'none',
'chargeType' => 'free',
- 'abilityTreeCode' => '225363',
- 'abilityTreeNodes' => [
- 'FEATUREopensearch1AJKH0',
- ],
+ 'abilityTreeNodes' => ['FEATUREopensearch8B42ZS'],
+ 'tenantRelevance' => 'tenant',
],
'parameters' => [
[
- 'name' => 'dryRun',
- 'in' => 'query',
- 'schema' => [
- 'description' => '是否校验入参数据合法性，默认false。'."\n"
- ."\n"
- .'取值：'."\n"
- ."\n"
- .'- **true**'."\n"
- ."\n"
- .'- **false**',
- 'type' => 'boolean',
- 'required' => false,
- 'example' => 'false',
- ],
+ 'name' => 'workspaceName',
+ 'in' => 'path',
+ 'schema' => ['description' => '工作空间名称', 'type' => 'string', 'required' => false, 'example' => 'default'],
],
[
- 'name' => 'workspaceName',
+ 'name' => 'type',
'in' => 'path',
- 'schema' => [
- 'description' => '工作空间名称',
- 'type' => 'string',
- 'required' => true,
- 'example' => 'default',
- ],
+ 'schema' => ['description' => '类型', 'type' => 'string', 'required' => false, 'example' => 'video'],
],
[
- 'name' => 'id',
+ 'name' => 'taskName',
'in' => 'path',
- 'schema' => [
- 'description' => '体验数据ID',
- 'type' => 'integer',
- 'format' => 'int64',
- 'required' => true,
- 'example' => '1878',
- ],
+ 'schema' => ['description' => '任务名称', 'type' => 'string', 'required' => false, 'example' => 'taskName'],
+ ],
+ [
+ 'name' => 'regionId',
+ 'in' => 'query',
+ 'schema' => ['title' => '区域标识符', 'description' => '区域标识符', 'type' => 'string', 'required' => false, 'example' => 'cn-shanghai'],
],
],
'responses' => [
@@ -1667,164 +1635,63 @@
'description' => 'Schema of Response',
'type' => 'object',
'properties' => [
- 'requestId' => [
- 'title' => 'Id of the request',
- 'description' => 'Id of the request',
- 'type' => 'string',
- 'example' => '5950143C-B8F0-5758-A08A-66F302FD587F',
- ],
- 'result' => [
- 'description' => '返回结果',
- 'type' => 'object',
- 'properties' => [
- 'id' => [
- 'description' => '数据id',
- 'type' => 'integer',
- 'format' => 'int64',
- 'example' => '1877',
- ],
- 'serviceType' => [
- 'description' => '服务类型。'."\n"
- ."\n"
- .'- document-analyze',
- 'type' => 'string',
- 'example' => 'document-analyze',
- ],
- 'dataType' => [
- 'description' => '数据类型'."\n"
- ."\n"
- .'- file'."\n"
- .'- url',
- 'type' => 'string',
- 'example' => 'file',
- ],
- 'name' => [
- 'description' => '数据名称(dataType=file时, name不能为空)',
- 'type' => 'string',
- 'example' => 'a.pdf',
- ],
- 'dataValue' => [
- 'description' => '数据内容'."\n"
- ."\n"
- .'- dataType=file时，该字段为文件oss地址'."\n"
- .'- dataType=url时，该字段为数据http链接地址',
- 'type' => 'string',
- 'example' => 'http://xxx',
- ],
- 'dataSize' => [
- 'description' => '数据大小',
- 'type' => 'integer',
- 'format' => 'int64',
- 'example' => '100',
- ],
- 'created' => [
- 'description' => '创建时间',
- 'type' => 'integer',
- 'format' => 'int64',
- 'example' => '1745806839720',
- ],
- 'updated' => [
- 'description' => '更新时间',
- 'type' => 'integer',
- 'format' => 'int64',
- 'example' => '1729684154',
- ],
- 'contentType' => [
- 'description' => '文件类型'."\n"
- ."\n"
- .'- pdf'."\n"
- .'- text'."\n"
- .'- html'."\n"
- .'- doc',
- 'type' => 'string',
- 'example' => 'text',
- ],
- ],
- ],
+ 'requestId' => ['title' => 'Id of the request', 'description' => 'Id of the request', 'type' => 'string', 'example' => '2423C841-91C4-5E51-B296-590D367967FC'],
+ 'result' => ['description' => '返回结果', 'type' => 'boolean', 'example' => 'true'],
],
],
],
- '5XX' => [
- 'schema' => [
- 'type' => 'object',
- 'properties' => [
- 'code' => [
- 'type' => 'string',
- ],
- 'requestId' => [
- 'type' => 'string',
- ],
- 'message' => [
- 'type' => 'string',
- ],
- 'httpCode' => [
- 'type' => 'integer',
- 'format' => 'int32',
- ],
+ ],
+ 'staticInfo' => ['returnType' => 'synchronous'],
+ 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"requestId\\": \\"2423C841-91C4-5E51-B296-590D367967FC\\",\\n \\"result\\": true\\n}","type":"json"}]',
+ 'title' => '删除离线任务',
+ 'changeSet' => [
+ ['createdAt' => '2025-12-02T07:12:30.000Z', 'description' => '请求参数发生变更'],
+ ],
+ 'ramActions' => [
+ [
+ 'operationType' => 'delete',
+ 'ramAction' => [
+ 'action' => 'searchplat:DeleteOfflineTask',
+ 'authLevel' => 'operate',
+ 'actionConditions' => [],
+ 'resources' => [
+ ['validationType' => 'always', 'product' => 'SearchPlat', 'resourceType' => '全部资源', 'arn' => '*'],
],
],
],
],
- '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' => '获取体验数据详情',
],
- 'DeleteExperienceData' => [
- 'path' => '/openapi/platform/workspaces/{workspaceName}/experience-data/{id}',
- 'methods' => [
- 'delete',
- ],
- 'schemes' => [
- 'http',
- 'https',
- ],
+ 'DeleteRagEvaluatorTask' => [
+ 'summary' => 'rag版评测任务删除。',
+ 'path' => '/openapi/platform/workspaces/{workspaceName}/rag-evaluator/v1/api/task/{task_id}',
+ 'methods' => ['delete'],
+ 'schemes' => ['http', 'https'],
'security' => [
[
'AK' => [],
],
],
- 'operationType' => 'readAndWrite',
+ 'consumes' => ['application/json'],
+ 'produces' => ['application/json'],
+ 'operationType' => 'write',
'deprecated' => false,
'systemTags' => [
'operationType' => 'delete',
- 'abilityTreeCode' => '225361',
- 'abilityTreeNodes' => [
- 'FEATUREopensearch1AJKH0',
- ],
+ 'riskType' => 'none',
+ 'chargeType' => 'free',
+ 'abilityTreeCode' => '226069',
+ 'abilityTreeNodes' => ['FEATUREopensearchWAC9DF'],
],
'parameters' => [
[
- 'name' => 'dryRun',
- 'in' => 'query',
- 'schema' => [
- 'description' => '是否为空运行请求',
- 'type' => 'boolean',
- 'required' => false,
- 'example' => 'false',
- ],
- ],
- [
- 'name' => 'id',
+ 'name' => 'workspaceName',
'in' => 'path',
- 'schema' => [
- 'description' => '数据id',
- 'type' => 'integer',
- 'format' => 'int64',
- 'required' => true,
- 'example' => '1956',
- ],
+ 'schema' => ['description' => '工作空间名称。', 'type' => 'string', 'required' => false, 'example' => 'myWorkspace'],
],
[
- 'name' => 'workspaceName',
+ 'name' => 'task_id',
'in' => 'path',
- 'schema' => [
- 'description' => '工作空间名称。',
- 'type' => 'string',
- 'required' => true,
- 'example' => 'myWorkspace',
- ],
+ 'schema' => ['description' => '任务 id', 'type' => 'string', 'required' => false, 'example' => 'T-6684b38a48bc8e012d00052c'],
],
],
'responses' => [
@@ -1834,125 +1701,55 @@
'description' => 'Schema of Response',
'type' => 'object',
'properties' => [
- 'requestId' => [
- 'title' => 'Id of the request',
- 'description' => 'Id of the request',
- 'type' => 'string',
- 'example' => '65C620DA-D6BE-5F56-BBCD-6F2282BB7BAD',
- ],
+ 'requestId' => ['title' => 'Id of the request', 'description' => 'Id of the request', 'type' => 'string', 'example' => '0B66A850-506C-56B7-B001-EA09411CCD69'],
+ 'code' => ['description' => '状态码'."\n", 'type' => 'string', 'example' => 'not found'],
+ 'message' => ['description' => '错误信息', 'type' => 'string', 'example' => '"xx not found"'],
],
],
],
],
- 'staticInfo' => [
- 'returnType' => 'synchronous',
+ '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' => '删除评测任务',
+ 'changeSet' => [],
+ 'ramActions' => [
+ [
+ 'operationType' => 'delete',
+ 'ramAction' => [
+ 'action' => 'searchplat:WriteEvaluation',
+ 'authLevel' => 'operate',
+ 'actionConditions' => [],
+ 'resources' => [
+ ['validationType' => 'always', 'product' => 'SearchPlat', 'resourceType' => '全部资源', 'arn' => '*'],
+ ],
+ ],
+ ],
],
- 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"requestId\\": \\"65C620DA-D6BE-5F56-BBCD-6F2282BB7BAD\\"\\n}","type":"json"}]',
- 'title' => '删除体验数据',
],
- 'CreateExperienceData' => [
- 'summary' => '创建体验数据',
- 'path' => '/openapi/platform/workspaces/{workspaceName}/experience-data',
- 'methods' => [
- 'post',
- ],
- 'schemes' => [
- 'http',
- 'https',
- ],
+ 'DeleteWorkspace' => [
+ 'summary' => '删除工作空间',
+ 'path' => '/openapi/platform/workspaces/{workspaceName}',
+ 'methods' => ['delete'],
+ 'schemes' => ['http', 'https'],
'security' => [
[
'AK' => [],
],
],
- 'operationType' => 'readAndWrite',
+ 'operationType' => 'write',
'deprecated' => false,
'systemTags' => [
- 'operationType' => 'create',
+ 'operationType' => 'none',
'riskType' => 'none',
'chargeType' => 'free',
- 'abilityTreeCode' => '225360',
- 'abilityTreeNodes' => [
- 'FEATUREopensearch8B42ZS',
- ],
+ 'abilityTreeCode' => '218190',
+ 'abilityTreeNodes' => ['FEATUREopensearch2ESE2N'],
],
'parameters' => [
[
- 'name' => 'dryRun',
- 'in' => 'query',
- 'schema' => [
- 'description' => '是否为空运行请求',
- 'type' => 'boolean',
- 'required' => false,
- 'example' => 'true',
- ],
- ],
- [
- 'name' => 'body',
- 'in' => 'body',
- 'style' => 'json',
- 'schema' => [
- 'description' => '请求体',
- 'type' => 'object',
- 'properties' => [
- 'serviceType' => [
- 'description' => '服务类型',
- 'type' => 'string',
- 'required' => false,
- 'example' => 'document-analyze ',
- ],
- 'dataType' => [
- 'description' => '数据类型'."\n"
- .'- file 文件'."\n"
- .'- url 网址',
- 'type' => 'string',
- 'required' => false,
- 'example' => 'file',
- ],
- 'name' => [
- 'description' => '数据名称（dataType=file时, name不能为空）',
- 'type' => 'string',
- 'required' => false,
- 'example' => 'test',
- ],
- 'dataValue' => [
- 'description' => '数据内容'."\n"
- .'- dataType=file时，该字段为文件oss地址'."\n"
- .'- dataType=url时，该字段为数据http链接地址',
- 'type' => 'string',
- 'required' => false,
- 'example' => 'https://xxx',
- ],
- 'dataSize' => [
- 'description' => '数据大小',
- 'type' => 'integer',
- 'format' => 'int64',
- 'required' => false,
- 'example' => '100',
- ],
- 'contentType' => [
- 'description' => '数据内容类型，支持：'."\n"
- .'- pdf'."\n"
- .'- text'."\n"
- .'- html'."\n"
- .'- doc',
- 'type' => 'string',
- 'required' => false,
- 'example' => 'text',
- ],
- ],
- 'required' => false,
- ],
- ],
- [
'name' => 'workspaceName',
'in' => 'path',
- 'schema' => [
- 'description' => '工作空间名称。',
- 'type' => 'string',
- 'required' => true,
- 'example' => 'myWorkspace',
- ],
+ 'schema' => ['title' => 'A short description of struct', 'description' => '工作空间名称。', 'type' => 'string', 'required' => true, 'example' => 'myWorkspace'],
],
],
'responses' => [
@@ -1962,144 +1759,72 @@
'description' => 'Schema of Response',
'type' => 'object',
'properties' => [
- 'requestId' => [
- 'title' => 'Id of the request',
- 'description' => 'Id of the request',
- 'type' => 'string',
- 'example' => '7ACFD0C5-61E4-5DEA-A995-8279BB99C7E4',
- ],
+ 'requestId' => ['title' => 'Id of the request', 'description' => 'Id of the request', 'type' => 'string', 'example' => '5950143C-B8F0-5758-A08A-66F302FD587F'],
'result' => [
'description' => '返回结果',
'type' => 'object',
'properties' => [
- 'id' => [
- 'description' => '数据id',
- 'type' => 'integer',
- 'format' => 'int64',
- 'example' => '1222212',
- ],
- 'serviceType' => [
- 'description' => '服务类型',
- 'type' => 'string',
- 'example' => 'document-analyze',
- ],
- 'dataType' => [
- 'description' => '数据类型',
- 'type' => 'boolean',
- 'example' => 'file',
- ],
- 'name' => [
- 'description' => '数据名称',
- 'type' => 'string',
- 'example' => 'test',
- ],
- 'dataValue' => [
- 'description' => '数据内容',
- 'type' => 'string',
- 'example' => 'http://xxx',
- ],
- 'dataSize' => [
- 'description' => '数据大小',
- 'type' => 'integer',
- 'format' => 'int64',
- 'example' => '100',
- ],
- 'created' => [
- 'description' => '创建时间',
- 'type' => 'integer',
- 'format' => 'int64',
- 'example' => '1729665694',
- ],
- 'updated' => [
- 'description' => '更新时间',
- 'type' => 'integer',
- 'format' => 'int64',
- 'example' => '1729665694',
- ],
- 'contentType' => [
- 'description' => '数据内容类型',
- 'type' => 'string',
- 'example' => 'text',
- ],
+ 'instanceId' => ['description' => '实例ID', 'type' => 'string', 'example' => 'ops-cn-em93wcq0s001'],
],
],
],
],
],
],
- 'staticInfo' => [
- 'returnType' => 'synchronous',
+ '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' => '删除工作空间',
+ '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}'],
+ ],
+ ],
+ ],
],
- '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' => '创建体验数据',
],
- 'ListExperienceData' => [
- 'summary' => '获取指定工作空间下的所有体验数据，支持按服务类型和数据类型筛选。',
- 'path' => '/openapi/platform/workspaces/{workspaceName}/experience-data',
- 'methods' => [
- 'get',
- ],
- 'schemes' => [
- 'http',
- 'https',
- ],
+ 'DescribeCapability' => [
+ 'summary' => '查询指定工作空间内特定类别的配置项详情。',
+ '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' => 'list',
+ 'operationType' => 'get',
'riskType' => 'none',
'chargeType' => 'free',
- 'abilityTreeCode' => '225365',
- 'abilityTreeNodes' => [
- 'FEATUREopensearch1AJKH0',
- ],
+ 'abilityTreeNodes' => ['FEATUREopensearch8B42ZS'],
+ 'tenantRelevance' => 'tenant',
],
'parameters' => [
[
- 'name' => 'dryRun',
- 'in' => 'query',
- 'schema' => [
- 'description' => '- true'."\n"
- .'- false',
- 'type' => 'boolean',
- 'required' => false,
- 'example' => 'true',
- ],
- ],
- [
- 'name' => 'serviceType',
- 'in' => 'query',
- 'schema' => [
- 'description' => '服务类型'."\n",
- 'type' => 'string',
- 'required' => false,
- 'example' => 'document-analyze',
- ],
+ 'name' => 'workspaceName',
+ 'in' => 'path',
+ 'schema' => ['description' => '**工作空间名称**'."\n", 'type' => 'string', 'required' => true, 'example' => 'default'],
],
[
- 'name' => 'workspaceName',
+ 'name' => 'itemCategory',
'in' => 'path',
- 'schema' => [
- 'description' => '工作空间名称',
- 'type' => 'string',
- 'required' => true,
- 'example' => 'default',
- ],
+ 'schema' => ['description' => '**配置类别ai_search_agent**'."\n", 'type' => 'string', 'required' => true, 'example' => 'ai_search_agent'],
],
[
- 'name' => 'dataType',
- 'in' => 'query',
- 'schema' => [
- 'description' => '数据类型'."\n",
- 'type' => 'string',
- 'required' => false,
- 'example' => 'file',
- ],
+ 'name' => 'itemName',
+ 'in' => 'path',
+ 'schema' => ['description' => '**配置名称**'."\n", 'type' => 'string', 'required' => true, 'example' => 'es_knowledge_base'],
],
],
'responses' => [
@@ -2109,98 +1834,52 @@
'description' => 'Schema of Response',
'type' => 'object',
'properties' => [
- 'requestId' => [
- 'title' => 'Id of the request',
- 'description' => '请求ID'."\n",
- 'type' => 'string',
- 'example' => 'FDSS_1232',
- ],
+ 'requestId' => ['description' => '请求ID', 'type' => 'string', 'example' => '0E3D5E2B-B63A-4445-B359-329CC07255EA'],
+ 'status' => ['description' => '请求状态', 'type' => 'string', 'example' => 'OK'],
+ 'httpCode' => ['description' => 'HTTP状态码'."\n", 'type' => 'integer', 'format' => 'int64', 'example' => '200'],
'result' => [
'description' => '返回结果',
- 'type' => 'array',
- 'items' => [
- 'description' => '返回结果',
- 'type' => 'object',
- 'properties' => [
- 'id' => [
- 'description' => 'ID'."\n",
- 'type' => 'integer',
- 'format' => 'int64',
- 'example' => '9bd21be8',
- ],
- 'serviceType' => [
- 'description' => '服务类型'."\n",
- 'type' => 'string',
- 'example' => 'document-analyze',
- ],
- 'dataType' => [
- 'description' => '数据类型'."\n"
- ."\n"
- .'- file'."\n"
- .'- url',
- 'type' => 'string',
- 'example' => 'file',
- ],
- 'name' => [
- 'description' => '名称'."\n",
- 'type' => 'string',
- 'example' => 'xxx.pdf',
- ],
- 'dataValue' => [
- 'description' => '数据值'."\n",
- 'type' => 'string',
- 'example' => 'oss://bucket/xxx.pdf',
- ],
- 'dataSize' => [
- 'description' => '**数据大小**'."\n",
- 'type' => 'integer',
- 'format' => 'int64',
- 'example' => '100',
- ],
- 'created' => [
- 'description' => '**创建时间**'."\n",
- 'type' => 'integer',
- 'format' => 'int64',
- 'example' => '12313123123',
- ],
- 'updated' => [
- 'description' => '更新时间',
- 'type' => 'integer',
- 'format' => 'int64',
- 'example' => '1232131231',
- ],
- 'contentType' => [
- 'description' => '**内容类型**'."\n",
- 'type' => 'string',
- 'example' => 'pdf',
- ],
- ],
+ 'type' => 'object',
+ 'properties' => [
+ 'created' => ['description' => '创建时间的时间戳'."\n", 'type' => 'integer', 'format' => 'int64', 'example' => '1745893195510'],
+ 'isDefault' => ['description' => '是否为默认配置'."\n", 'type' => 'boolean', 'example' => 'false'],
+ 'itemCategory' => ['description' => '配置类别'."\n", 'type' => 'string', 'example' => 'ai_search_agent'],
+ 'itemDesc' => ['description' => '配置描述'."\n", 'type' => 'string', 'example' => '描述'."\n"
+ ."\n"],
+ 'itemName' => ['description' => '配置名称'."\n", 'type' => 'string', 'example' => 'es_knowledge_base'],
+ 'itemValue' => ['description' => '包含endpoint、function等信息的对象，具体描述了知识库的详细配置。'."\n", 'type' => 'object'],
+ 'status' => ['description' => '状态'."\n", 'type' => 'string', 'example' => 'available'],
+ 'updated' => ['description' => '更新时间戳'."\n", 'type' => 'integer', 'format' => 'int64', 'example' => '1729665694'],
],
],
],
],
],
],
- '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' => '获取体验数据列表',
+ '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' => '获取配置详情',
'description' => '## 请求说明'."\n"
- .'- 该API用于查询用户在特定工作空间内的所有体验数据，默认按照创建时间降序排列。'."\n"
- .'- 不支持分页功能，但可以通过`serviceType`（服务类型）和`dataType`（数据类型）参数进行数据筛选。'."\n"
- .'- `workspaceName`是路径参数，必须提供以指定查询的工作空间。'."\n",
- ],
- 'ListAsyncTasks' => [
- 'summary' => '获取异步任务列表。',
- 'path' => '/openapi/platform/workspaces/{workspaceName}/async-tasks',
- 'methods' => [
- 'get',
- ],
- 'schemes' => [
- 'http',
- 'https',
+ .'本接口用于根据提供的工作空间名称、配置类别以及配置名称来获取具体的配置信息。请确保请求路径中的参数准确无误，特别是`workspaceName`、`itemCategory`和`itemName`这三个必填字段。此外，请注意`itemCategory`当前仅支持`ai_search_agent`这一类别。'."\n",
+ 'changeSet' => [],
+ 'ramActions' => [
+ [
+ 'operationType' => 'get',
+ 'ramAction' => [
+ 'action' => 'searchplat:DescribeCapability',
+ 'authLevel' => 'operate',
+ 'actionConditions' => [],
+ 'resources' => [
+ ['validationType' => 'always', 'product' => 'SearchPlat', 'resourceType' => '全部资源', 'arn' => '*'],
+ ],
+ ],
+ ],
],
+ ],
+ 'DescribeRegions' => [
+ 'path' => '/openapi/platform/regions',
+ 'methods' => ['get'],
+ 'schemes' => ['http', 'https'],
'security' => [
[
'AK' => [],
@@ -2209,65 +1888,11 @@
'operationType' => 'read',
'deprecated' => false,
'systemTags' => [
- 'operationType' => 'list',
- 'riskType' => 'none',
- 'chargeType' => 'free',
- 'abilityTreeCode' => '225788',
- 'abilityTreeNodes' => [
- 'FEATUREopensearch1AJKH0',
- ],
- ],
- 'parameters' => [
- [
- 'name' => 'dryRun',
- 'in' => 'query',
- 'schema' => [
- 'description' => '是否校验入参数据合法性，默认false。'."\n"
- ."\n"
- .'取值：'."\n"
- ."\n"
- .'- **true**'."\n"
- ."\n"
- .'- **false**',
- 'type' => 'boolean',
- 'required' => false,
- 'example' => 'true',
- ],
- ],
- [
- 'name' => 'workspaceName',
- 'in' => 'path',
- 'schema' => [
- 'description' => '工作空间名称',
- 'type' => 'string',
- 'required' => true,
- 'example' => 'default',
- ],
- ],
- [
- 'name' => 'serviceType',
- 'in' => 'query',
- 'schema' => [
- 'description' => '服务类型。'."\n"
- ."\n"
- .'- document-analyze',
- 'type' => 'string',
- 'required' => false,
- 'example' => 'document-analyze'."\n",
- ],
- ],
- [
- 'name' => 'dataId',
- 'in' => 'query',
- 'schema' => [
- 'description' => '体验数据ID。',
- 'type' => 'integer',
- 'format' => 'int32',
- 'required' => false,
- 'example' => '1231',
- ],
- ],
+ 'operationType' => 'get',
+ 'abilityTreeCode' => '218714',
+ 'abilityTreeNodes' => ['FEATUREopensearchJK5SO0'],
],
+ 'parameters' => [],
'responses' => [
200 => [
'schema' => [
@@ -2275,95 +1900,23 @@
'description' => 'Schema of Response',
'type' => 'object',
'properties' => [
- 'requestId' => [
- 'title' => 'Id of the request',
- 'description' => 'Id of the request',
- 'type' => 'string',
- 'example' => '2BA0504F-B179-586D-8210-A7C7C09A9907',
- ],
- 'result' => [
- 'description' => '返回结果',
- 'type' => 'array',
- 'items' => [
- 'description' => '返回结果',
- 'type' => 'object',
- 'properties' => [
- 'id' => [
- 'description' => '异步任务id',
- 'type' => 'string',
- 'example' => 'ae1cea6dc680b98b908a757050c406c9',
- ],
- 'serviceType' => [
- 'description' => '服务类型。'."\n"
- ."\n"
- .'- document-analyze',
- 'type' => 'string',
- 'example' => 'document-analyze'."\n",
- ],
- 'serviceId' => [
- 'description' => '服务ID。',
- 'type' => 'string',
- 'example' => 'ops-document-analyze-001',
- ],
- 'name' => [
- 'description' => '文件名称',
- 'type' => 'string',
- 'example' => 'test',
- ],
- 'dataId' => [
- 'description' => '体验数据ID。',
- 'type' => 'integer',
- 'format' => 'int32',
- 'example' => '1232',
- ],
- 'status' => [
- 'description' => '任务状态'."\n"
- .'- PENDING 进行中'."\n"
- .'- SUCCESS 解析成功'."\n"
- .'- FAILED 解析失败',
- 'type' => 'string',
- 'example' => 'SUCCESS',
- ],
- 'result' => [
- 'description' => '任务执行结果',
- 'type' => 'string',
- 'example' => 'xxxxx',
- ],
- 'created' => [
- 'description' => '创建时间戳',
- 'type' => 'integer',
- 'format' => 'int64',
- 'example' => '1745893195510',
- ],
- 'updated' => [
- 'description' => '更新时间',
- 'type' => 'integer',
- 'format' => 'int64',
- 'example' => '1729665694',
- ],
- ],
- ],
- ],
+ 'requestId' => ['title' => 'Id of the request', 'description' => 'Id of the request', 'type' => 'string', 'example' => 'AE3554F3-313D-5712-919C-A334615C5DE5'],
],
],
],
],
- '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' => '获取异步任务列表',
+ 'staticInfo' => ['returnType' => 'synchronous'],
+ 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"requestId\\": \\"AE3554F3-313D-5712-919C-A334615C5DE5\\"\\n}","type":"json"}]',
+ 'title' => '查询支持区域列表',
+ 'summary' => 'DescribeRegions',
+ 'changeSet' => [],
+ 'ramActions' => [],
],
'GetAsyncTask' => [
'summary' => '获取异步任务详情。',
'path' => '/openapi/platform/workspaces/{workspaceName}/async-tasks/{id}',
- 'methods' => [
- 'get',
- ],
- 'schemes' => [
- 'http',
- 'https',
- ],
+ 'methods' => ['get'],
+ 'schemes' => ['http', 'https'],
'security' => [
[
'AK' => [],
@@ -2376,40 +1929,23 @@
'riskType' => 'none',
'chargeType' => 'free',
'abilityTreeCode' => '225787',
- 'abilityTreeNodes' => [
- 'FEATUREopensearch1AJKH0',
- ],
+ 'abilityTreeNodes' => ['FEATUREopensearch1AJKH0'],
],
'parameters' => [
[
'name' => 'dryRun',
'in' => 'query',
- 'schema' => [
- 'description' => '是否为空运行请求',
- 'type' => 'boolean',
- 'required' => false,
- 'example' => 'false',
- ],
+ 'schema' => ['description' => '是否为空运行请求', 'type' => 'boolean', 'required' => false, 'example' => 'false'],
],
[
'name' => 'workspaceName',
'in' => 'path',
- 'schema' => [
- 'description' => '工作空间名称。',
- 'type' => 'string',
- 'required' => true,
- 'example' => 'myWorkspace',
- ],
+ 'schema' => ['description' => '工作空间名称。', 'type' => 'string', 'required' => true, 'example' => 'myWorkspace'],
],
[
'name' => 'id',
'in' => 'path',
- 'schema' => [
- 'description' => '异步任务id',
- 'type' => 'string',
- 'required' => true,
- 'example' => 'addf-dfd-faa',
- ],
+ 'schema' => ['description' => '异步任务id', 'type' => 'string', 'required' => true, 'example' => 'addf-dfd-faa'],
],
],
'responses' => [
@@ -2419,168 +1955,72 @@
'description' => 'Schema of Response',
'type' => 'object',
'properties' => [
- 'requestId' => [
- 'title' => 'Id of the request',
- 'description' => 'Id of the request',
- 'type' => 'string',
- 'example' => '58113A95-1858-5674-87E5-192AEE6FD9DD',
- ],
+ 'requestId' => ['title' => 'Id of the request', 'description' => 'Id of the request', 'type' => 'string', 'example' => '58113A95-1858-5674-87E5-192AEE6FD9DD'],
'result' => [
'description' => '返回结果',
'type' => 'object',
'properties' => [
- 'id' => [
- 'description' => '异步任务id',
- 'type' => 'string',
- 'example' => 'taskf90b77d481c47b05c18266a31b6cdbdd',
- ],
- 'serviceType' => [
- 'description' => '服务类型',
- 'type' => 'string',
- 'example' => 'document-analyze',
- ],
- 'serviceId' => [
- 'description' => '服务ID。',
- 'type' => 'string',
- 'example' => 'ops-document-analyze-001',
- ],
- 'name' => [
- 'description' => '任务名称',
- 'type' => 'string',
- 'example' => '文档解析任务',
- ],
- 'dataId' => [
- 'description' => '体验数据ID。',
- 'type' => 'integer',
- 'format' => 'int32',
- 'example' => '123',
- ],
- 'status' => [
- 'description' => '任务状态'."\n"
- .'- PENDING 进行中'."\n"
- .'- SUCCESS 解析成功'."\n"
- .'- FAILED 解析失败',
- 'type' => 'string',
- 'example' => 'PENDING',
- ],
- 'result' => [
- 'description' => '解析结果。',
- 'type' => 'string',
- 'example' => '{}',
- ],
- 'created' => [
- 'description' => '创建时间',
- 'type' => 'integer',
- 'format' => 'int64',
- 'example' => '1729684154',
- ],
- 'updated' => [
- 'description' => '更新时间',
- 'type' => 'integer',
- 'format' => 'int64',
- 'example' => '1729684154',
- ],
+ 'id' => ['description' => '异步任务id', 'type' => 'string', 'example' => 'taskf90b77d481c47b05c18266a31b6cdbdd'],
+ 'serviceType' => ['description' => '服务类型', 'type' => 'string', 'example' => 'document-analyze'],
+ 'serviceId' => ['description' => '服务ID。', 'type' => 'string', 'example' => 'ops-document-analyze-001'],
+ 'name' => ['description' => '任务名称', 'type' => 'string', 'example' => '文档解析任务'],
+ 'dataId' => ['description' => '体验数据ID。', 'type' => 'integer', 'format' => 'int32', 'example' => '123'],
+ 'status' => ['description' => '任务状态'."\n"
+ .'- PENDING 进行中'."\n"
+ .'- SUCCESS 解析成功'."\n"
+ .'- FAILED 解析失败', 'type' => 'string', 'example' => 'PENDING'],
+ 'result' => ['description' => '解析结果。', 'type' => 'string', 'example' => '{}'],
+ 'created' => ['description' => '创建时间', 'type' => 'integer', 'format' => 'int64', 'example' => '1729684154'],
+ 'updated' => ['description' => '更新时间', 'type' => 'integer', 'format' => 'int64', 'example' => '1729684154'],
],
],
],
],
],
],
- 'staticInfo' => [
- 'returnType' => 'synchronous',
- ],
+ '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' => '获取任务详情',
- ],
- 'CreateAsyncTask' => [
- 'summary' => '创建异步任务',
- 'path' => '/openapi/platform/workspaces/{workspaceName}/async-tasks',
- 'methods' => [
- 'post',
- ],
- 'schemes' => [
- 'http',
- 'https',
+ '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' => 'readAndWrite',
- 'deprecated' => false,
+ 'operationType' => 'read',
'systemTags' => [
- 'operationType' => 'create',
- 'riskType' => 'none',
- 'chargeType' => 'free',
- 'abilityTreeCode' => '225786',
- 'abilityTreeNodes' => [
- 'FEATUREopensearch1AJKH0',
- ],
+ 'operationType' => 'get',
+ 'abilityTreeCode' => '220524',
+ 'abilityTreeNodes' => ['FEATUREopensearch1AJKH0'],
],
'parameters' => [
[
- 'name' => 'dryRun',
- 'in' => 'query',
- 'schema' => [
- 'description' => '是否为空运行请求',
- 'type' => 'boolean',
- 'required' => false,
- 'example' => 'true',
- ],
+ 'name' => 'token',
+ 'in' => 'path',
+ 'schema' => ['description' => '访问凭证token。', 'type' => 'string', 'required' => true, 'example' => 'OS-********'],
],
[
'name' => 'workspaceName',
'in' => 'path',
- 'schema' => [
- 'description' => '工作空间名称。',
- 'type' => 'string',
- 'required' => true,
- 'example' => 'myWorkspace',
- ],
- ],
- [
- 'name' => 'body',
- 'in' => 'body',
- 'style' => 'json',
- 'schema' => [
- 'description' => '请求体。',
- 'type' => 'object',
- 'properties' => [
- 'id' => [
- 'description' => '异步任务id',
- 'type' => 'string',
- 'required' => false,
- 'example' => 'fae9bcc5-949f-4c31-b9b7-a273bf891699',
- ],
- 'serviceType' => [
- 'description' => '服务类型',
- 'type' => 'string',
- 'required' => false,
- 'example' => 'document-analyze',
- ],
- 'serviceId' => [
- 'description' => '服务ID',
- 'type' => 'string',
- 'required' => false,
- 'example' => 'ops-document-analyze-001',
- ],
- 'dataId' => [
- 'description' => '体验数据ID。',
- 'type' => 'integer',
- 'format' => 'int64',
- 'required' => false,
- 'example' => '12323',
- ],
- 'name' => [
- 'description' => '任务名称',
- 'type' => 'string',
- 'required' => false,
- 'example' => '文档解析任务',
- ],
- ],
- 'required' => false,
- ],
+ 'schema' => ['description' => '工作空间名称。', 'type' => 'string', 'required' => true, 'example' => 'myWorkspace'],
],
],
'responses' => [
@@ -2590,149 +2030,87 @@
'description' => 'Schema of Response',
'type' => 'object',
'properties' => [
- 'requestId' => [
- 'title' => 'Id of the request',
- 'description' => 'Id of the request',
- 'type' => 'string',
- 'example' => '1CC93E65-6734-5060-BEF7-0EB0A4862BCF',
- ],
+ 'requestId' => ['title' => 'Id of the request', 'description' => 'Id of the request', 'type' => 'string', 'example' => 'B7C901ED-2BC1-5CFB-BE23-242DE5E3BA5C'],
'result' => [
- 'description' => '返回结果',
- 'type' => 'array',
- 'items' => [
- 'description' => '返回结果',
- 'type' => 'object',
- 'properties' => [
- 'id' => [
- 'description' => '任务ID',
- 'type' => 'string',
- 'example' => 'fae9bcc5-949f-4c31-b9b7-a273bf891699',
- ],
- 'serviceType' => [
- 'description' => '服务类型',
- 'type' => 'string',
- 'example' => 'document-analyze',
- ],
- 'serviceId' => [
- 'description' => '服务ID。',
- 'type' => 'string',
- 'example' => 'ops-document-analyze-001',
- ],
- 'name' => [
- 'description' => '任务名称',
- 'type' => 'string',
- 'example' => '文档解析任务',
- ],
- 'dataId' => [
- 'description' => '数据ID。',
- 'type' => 'integer',
- 'format' => 'int32',
- 'example' => '1232',
- ],
- 'status' => [
- 'description' => '任务状态'."\n"
- .'- PENDING 进行中'."\n"
- .'- SUCCESS 解析成功'."\n"
- .'- FAILED 解析失败',
- 'type' => 'string',
- 'example' => 'SUCCESS',
- ],
- 'result' => [
- 'description' => '解析结果。',
- 'type' => 'string',
- 'example' => 'xx',
- ],
- 'created' => [
- 'description' => '创建时间',
- 'type' => 'integer',
- 'format' => 'int64',
- 'example' => '1729669284',
- ],
- 'updated' => [
- 'description' => '更新时间',
- 'type' => 'integer',
- 'format' => 'int64',
- 'example' => '1729669284',
- ],
- ],
+ 'description' => '查询结果'."\n",
+ 'type' => 'object',
+ 'properties' => [
+ 'appGroupId' => ['description' => '工作空间ID。', 'type' => 'integer', 'format' => 'int64', 'example' => '111111'],
+ 'type' => ['description' => '凭证类型。'."\n"
+ ."\n"
+ .'- api-token', 'type' => 'string', 'example' => 'api-token'."\n"],
+ 'enabled' => ['description' => '凭据是否启用。'."\n"
+ .'取值：'."\n"
+ ."\n"
+ .'true：启用。'."\n"
+ ."\n"
+ .'false：禁用。', 'type' => 'boolean', 'example' => 'true'],
+ 'token' => ['description' => '访问凭证token。', 'type' => 'string', 'example' => 'OS-********'."\n"],
],
],
],
],
],
],
- 'staticInfo' => [
- 'returnType' => 'synchronous',
+ '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' => '获取访问凭证详情',
+ 'summary' => '获取访问凭证详情',
+ '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}'],
+ ],
+ ],
+ ],
],
- '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' => '创建异步任务',
],
- 'ResumeFunctionInstance' => [
- 'summary' => 'Restart the service',
- 'path' => '/openapi/platform/workspaces/{workspaceName}/functions/{functionName}/instances/{instanceName}/actions/resume',
- 'methods' => [
- 'post',
- ],
- 'schemes' => [
- 'https',
- ],
+ 'GetExperienceData' => [
+ 'summary' => '获取体验数据详情。',
+ 'path' => '/openapi/platform/workspaces/{workspaceName}/experience-data/{id}',
+ 'methods' => ['get'],
+ 'schemes' => ['http', 'https'],
'security' => [
[
'AK' => [],
],
],
- 'consumes' => [
- 'application/json',
- ],
- 'produces' => [
- 'application/json',
- ],
- 'operationType' => 'write',
+ 'operationType' => 'readAndWrite',
'deprecated' => false,
'systemTags' => [
- 'operationType' => 'none',
+ 'operationType' => 'get',
'riskType' => 'none',
'chargeType' => 'free',
- 'abilityTreeCode' => '239782',
- 'abilityTreeNodes' => [
- 'FEATUREopensearchJK5SO0',
- ],
- 'autoTest' => true,
- 'tenantRelevance' => 'tenant',
+ 'abilityTreeCode' => '225363',
+ 'abilityTreeNodes' => ['FEATUREopensearch1AJKH0'],
],
'parameters' => [
[
- 'name' => 'workspaceName',
- 'in' => 'path',
- 'schema' => [
- 'title' => 'opensearch应用名',
- 'description' => '工作空间名',
- 'type' => 'string',
- 'required' => true,
- 'example' => 'default',
- ],
+ 'name' => 'dryRun',
+ 'in' => 'query',
+ 'schema' => ['description' => '是否校验入参数据合法性，默认false。'."\n"
+ ."\n"
+ .'取值：'."\n"
+ ."\n"
+ .'- **true**'."\n"
+ ."\n"
+ .'- **false**', 'type' => 'boolean', 'required' => false, 'example' => 'false'],
],
[
- 'name' => 'functionName',
+ 'name' => 'workspaceName',
'in' => 'path',
- 'schema' => [
- 'title' => '功能名称',
- 'description' => '服务类型',
- 'type' => 'string',
- 'required' => true,
- 'example' => 'notebook',
- ],
+ 'schema' => ['description' => '工作空间名称', 'type' => 'string', 'required' => true, 'example' => 'default'],
],
[
- 'name' => 'instanceName',
+ 'name' => 'id',
'in' => 'path',
- 'schema' => [
- 'title' => '实例名称',
- 'description' => 'notebook名称',
- 'type' => 'string',
- 'required' => true,
- 'example' => 'test_notebook',
- ],
+ 'schema' => ['description' => '体验数据ID', 'type' => 'integer', 'format' => 'int64', 'required' => true, 'example' => '1878'],
],
],
'responses' => [
@@ -2742,74 +2120,87 @@
'description' => 'Schema of Response',
'type' => 'object',
'properties' => [
- 'status' => [
- 'description' => '请求状态',
- 'type' => 'string',
- 'example' => 'OK',
- ],
- 'httpCode' => [
- 'description' => 'http状态码',
- 'type' => 'integer',
- 'format' => 'int64',
- 'example' => '200',
- ],
- 'requestId' => [
- 'description' => '请求ID',
- 'type' => 'string',
- 'example' => '5950143C-B8F0-5758-A08A-66F302FD587F',
- ],
- 'message' => [
- 'title' => '错误信息',
- 'description' => '错误信息',
- 'type' => 'string',
- 'example' => '"xx not found"',
- ],
- 'code' => [
- 'title' => '错误码',
- 'description' => '错误码',
- 'type' => 'string',
- 'example' => 'not found',
- ],
- 'latency' => [
- 'title' => '耗时',
- 'description' => '耗时',
- 'type' => 'integer',
- 'format' => 'int64',
- 'example' => '145.411',
+ 'requestId' => ['title' => 'Id of the request', 'description' => 'Id of the request', 'type' => 'string', 'example' => '5950143C-B8F0-5758-A08A-66F302FD587F'],
+ 'result' => [
+ 'description' => '返回结果',
+ 'type' => 'object',
+ 'properties' => [
+ 'id' => ['description' => '数据id', 'type' => 'integer', 'format' => 'int64', 'example' => '1877'],
+ 'serviceType' => ['description' => '服务类型。'."\n"
+ ."\n"
+ .'- document-analyze', 'type' => 'string', 'example' => 'document-analyze'],
+ 'dataType' => ['description' => '数据类型'."\n"
+ ."\n"
+ .'- file'."\n"
+ .'- url', 'type' => 'string', 'example' => 'file'],
+ 'name' => ['description' => '数据名称(dataType=file时, name不能为空)', 'type' => 'string', 'example' => 'a.pdf'],
+ 'dataValue' => ['description' => '数据内容'."\n"
+ ."\n"
+ .'- dataType=file时，该字段为文件oss地址'."\n"
+ .'- dataType=url时，该字段为数据http链接地址', 'type' => 'string', 'example' => 'http://xxx'],
+ 'dataSize' => ['description' => '数据大小', 'type' => 'integer', 'format' => 'int64', 'example' => '100'],
+ 'created' => ['description' => '创建时间', 'type' => 'integer', 'format' => 'int64', 'example' => '1745806839720'],
+ 'updated' => ['description' => '更新时间', 'type' => 'integer', 'format' => 'int64', 'example' => '1729684154'],
+ 'contentType' => ['description' => '文件类型'."\n"
+ ."\n"
+ .'- pdf'."\n"
+ .'- text'."\n"
+ .'- html'."\n"
+ .'- doc', 'type' => 'string', 'example' => 'text'],
+ ],
],
],
],
],
+ '5XX' => [
+ 'schema' => [
+ 'type' => 'object',
+ 'properties' => [
+ 'code' => ['type' => 'string', 'description' => ''],
+ 'requestId' => ['type' => 'string', 'description' => ''],
+ 'message' => ['type' => 'string', 'description' => ''],
+ 'httpCode' => ['type' => 'integer', 'format' => 'int32', 'description' => ''],
+ ],
+ 'description' => '',
+ ],
+ ],
],
- 'staticInfo' => [
- 'returnType' => 'synchronous',
+ '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' => '获取体验数据详情',
+ '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}'],
+ ],
+ ],
+ ],
],
- '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',
],
- 'UpdateFunctionInstance' => [
- 'summary' => '更新服务配置',
+ 'GetFunctionInstance' => [
+ 'summary' => '查询指定工作空间中特定功能实例的详细信息。',
'path' => '/openapi/platform/workspaces/{workspaceName}/functions/{functionName}/instances/{instanceName}',
- 'methods' => [
- 'put',
- ],
- 'schemes' => [
- 'https',
- ],
+ 'methods' => ['get'],
+ 'schemes' => ['https'],
'security' => [
[
'AK' => [],
],
],
+ 'operationType' => 'read',
'deprecated' => false,
'systemTags' => [
- 'operationType' => 'none',
+ 'operationType' => 'get',
'riskType' => 'none',
'chargeType' => 'free',
- 'abilityTreeCode' => '239782',
- 'abilityTreeNodes' => [
- 'FEATUREopensearchJK5SO0',
- ],
+ 'abilityTreeCode' => '239784',
+ 'abilityTreeNodes' => ['FEATUREopensearchJK5SO0'],
'autoTest' => true,
'tenantRelevance' => 'publicInformation',
],
@@ -2817,786 +2208,557 @@
[
'name' => 'workspaceName',
'in' => 'path',
- 'schema' => [
- 'title' => 'opensearch应用名',
- 'description' => '工作空间名称',
- 'type' => 'string',
- 'required' => true,
- 'example' => 'default',
- ],
+ 'schema' => ['description' => '工作空间名称'."\n", 'type' => 'string', 'required' => false, 'example' => 'default'],
],
[
'name' => 'functionName',
'in' => 'path',
- 'schema' => [
- 'title' => '功能名称',
- 'description' => '功能名称',
- 'type' => 'string',
- 'required' => true,
- 'example' => 'deployment',
- ],
+ 'schema' => ['description' => '服务类型nl2sql模型类型embedding-tuning自定义模型部署deployment服务开发notebook'."\n", 'type' => 'string', 'required' => false, 'example' => 'nl2sql'],
],
[
'name' => 'instanceName',
'in' => 'path',
- 'schema' => [
- 'title' => '实例名称',
- 'description' => '实例名称',
- 'type' => 'string',
- 'required' => true,
- 'example' => 'test',
- ],
+ 'schema' => ['description' => '配置/模型/自定义模型部署配置名称/notebook实例名称'."\n", 'type' => 'string', 'required' => true, 'example' => 'test'],
],
[
- 'name' => 'Body',
- 'in' => 'body',
- 'style' => 'json',
+ 'name' => 'output',
+ 'in' => 'query',
+ 'schema' => ['description' => '控制返回信息的丰富度'."\n"
+ .'- simple：只显示基本信息'."\n"
+ .'- normal：显示createParameters, cron等信息（默认）'."\n"
+ .'- detail: 返回训练任务信息'."\n", 'type' => 'string', 'required' => false, 'example' => 'normal'],
+ ],
+ ],
+ 'responses' => [
+ 200 => [
'schema' => [
- 'title' => 'body参数',
- 'description' => 'body参数',
+ 'description' => '响应体示例'."\n",
'type' => 'object',
'properties' => [
- 'createParameters' => [
- 'title' => '创建参数',
- 'description' => '创建参数',
- 'type' => 'array',
- 'items' => [
- 'description' => '参数体',
- 'type' => 'object',
- 'properties' => [
- 'name' => [
- 'title' => '参数名称',
- 'description' => '参数名称',
- 'type' => 'string',
- 'required' => false,
- 'example' => 'name',
+ 'code' => ['description' => '错误码。', 'type' => 'string', 'example' => 'not found'],
+ 'httpCode' => ['description' => 'http状态码', 'type' => 'integer', 'format' => 'int64', 'example' => '200'],
+ 'latency' => ['description' => '耗时', 'type' => 'integer', 'format' => 'int64', 'example' => '11.627'],
+ 'message' => ['description' => '错误信息。', 'type' => 'string', 'example' => '"xx not found"'],
+ 'requestId' => ['description' => '请求ID', 'type' => 'string', 'example' => 'C56462F4-CCB3-10BF-A3D8-FEE53C72B65C'],
+ 'result' => [
+ 'description' => '返回结果',
+ 'type' => 'object',
+ 'properties' => [
+ 'belongs' => [
+ 'description' => '归属信息',
+ 'type' => 'object',
+ 'properties' => [
+ 'category' => ['description' => '类别', 'type' => 'string', 'example' => '""'],
+ 'domain' => ['description' => '行业类型', 'type' => 'string', 'example' => '""'],
+ 'language' => ['description' => '语言', 'type' => 'string', 'example' => 'zh'],
],
- 'value' => [
- 'title' => '参数值',
- 'description' => '参数值',
- 'type' => 'string',
- 'required' => false,
- 'example' => 'value',
+ ],
+ 'createParameters' => [
+ 'description' => '具体配置项'."\n",
+ 'type' => 'array',
+ 'items' => [
+ 'description' => '创建参数体',
+ 'type' => 'object',
+ 'properties' => [
+ 'name' => ['description' => '参数名称。', 'type' => 'string', 'example' => 'name'],
+ 'value' => ['description' => '参数值。', 'type' => 'string', 'example' => 'value'],
+ ],
],
],
- 'required' => false,
+ 'createTime' => ['description' => '创建时间', 'type' => 'integer', 'format' => 'int64', 'example' => '1724998630466'],
+ 'cron' => ['description' => '定时调度任务Cron。', 'type' => 'string', 'example' => '""'],
+ 'description' => ['description' => '描述', 'type' => 'string', 'example' => '描述'],
+ 'extendInfo' => ['description' => '拓展信息', 'type' => 'string', 'example' => '""'],
+ 'functionName' => ['description' => '配置类型'."\n"
+ ."\n"
+ .'- nl2sql '."\n"
+ .'- embedding-tuning '."\n"
+ .'- deployment '."\n"
+ .'- notebook', 'type' => 'string', 'example' => 'nl2sql'],
+ 'functionType' => ['description' => '配置类型PAAS：（默认）需要训练后才能使用'."\n", 'type' => 'string', 'example' => 'PAAS'],
+ 'instanceName' => ['description' => '配置名称', 'type' => 'string', 'example' => 'test'],
+ 'modelType' => ['description' => '模型类型，不同配置类型（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'],
+ 'source' => ['description' => '来源', 'type' => 'string', 'example' => 'user'],
+ 'status' => ['description' => '状态。'."\n"
+ ."\n"
+ .'- available'."\n"
+ .'- unavailable', 'type' => 'string', 'example' => 'available'],
+ 'task' => [
+ 'description' => '任务信息。',
+ 'type' => 'object',
+ 'properties' => [
+ 'dagStatus' => ['description' => '任务状态'."\n"
+ ."\n"
+ .'- success：成功'."\n"
+ .'- failed：失败'."\n"
+ .'- untrained: 待训练'."\n"
+ .'- pending: 调度中'."\n"
+ .'- running：训练中', 'type' => 'string', 'example' => 'success'],
+ 'lastRunTime' => ['description' => '最后训练时间', 'type' => 'integer', 'format' => 'int64', 'example' => '1724998630466'],
+ ],
+ ],
+ 'versionId' => ['description' => '训练版本ID', 'type' => 'integer', 'format' => 'int64', 'example' => '21'],
],
- 'required' => false,
- ],
- 'description' => [
- 'title' => '实例描述',
- 'description' => '描述',
- 'type' => 'string',
- 'required' => false,
- 'example' => '描述',
],
+ 'status' => ['description' => '请求状态', 'type' => 'string', 'example' => 'OK'],
],
- 'required' => false,
],
],
],
- 'responses' => [
- 200 => [
- 'schema' => [
- 'title' => 'Schema of Response',
- 'description' => 'Schema of Response',
- 'type' => 'object',
- 'properties' => [
- 'status' => [
- 'description' => '请求状态',
- 'type' => 'string',
- 'example' => 'OK',
- ],
- 'httpCode' => [
- 'description' => 'http状态码',
- 'type' => 'integer',
- 'format' => 'int64',
- 'example' => '200',
- ],
- 'requestId' => [
- 'description' => '请求ID',
- 'type' => 'string',
- 'example' => '5950143C-B8F0-5758-A08A-66F302FD587F',
- ],
- 'message' => [
- 'title' => '错误信息',
- 'description' => '错误信息',
- 'type' => 'string',
- 'example' => '"xx not found"',
- ],
- 'code' => [
- 'title' => '错误码',
- 'description' => '错误码',
- 'type' => 'string',
- 'example' => 'not found',
- ],
- 'latency' => [
- 'title' => '耗时',
- 'description' => '耗时',
- 'type' => 'integer',
- 'format' => 'int64',
- 'example' => '34.946',
- ],
+ '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' => '获取服务/模型配置详情',
+ '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}'],
],
],
],
],
- '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' => '更改服务/模型配置',
],
- 'ListFunctionInstances' => [
- 'summary' => '获取服务配置列表',
- 'path' => '/openapi/platform/workspaces/{workspaceName}/functions/{functionName}/instances',
- 'methods' => [
- 'get',
- ],
- 'schemes' => [
- 'https',
- ],
+ 'GetOfflineTask' => [
+ 'summary' => '获取离线任务信息',
+ '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' => 'list',
+ 'operationType' => 'get',
'riskType' => 'none',
'chargeType' => 'free',
- 'abilityTreeCode' => '239787',
- 'abilityTreeNodes' => [
- 'FEATUREopensearchJK5SO0',
- ],
- 'autoTest' => true,
- 'tenantRelevance' => 'publicInformation',
+ 'abilityTreeNodes' => ['FEATUREopensearch8B42ZS'],
+ 'tenantRelevance' => 'tenant',
],
'parameters' => [
[
'name' => 'workspaceName',
'in' => 'path',
- 'schema' => [
- 'title' => '实例名称',
- 'description' => '工作空间名称',
- 'type' => 'string',
- 'required' => false,
- 'example' => 'default',
- ],
+ 'schema' => ['description' => '工作空间名称', 'type' => 'string', 'required' => false, 'example' => 'default'],
],
[
- 'name' => 'functionName',
+ 'name' => 'type',
'in' => 'path',
- 'schema' => [
- 'title' => '功能名称',
- 'description' => '功能名称',
- 'type' => 'string',
- 'required' => false,
- 'example' => 'deployment',
- ],
- ],
- [
- 'name' => 'modelType',
- 'in' => 'query',
- 'schema' => [
- 'title' => '模型类型',
- 'description' => '模型类型',
- 'type' => 'string',
- 'required' => false,
- 'example' => 'ai_search',
- ],
+ 'schema' => ['description' => '类型', 'type' => 'string', 'required' => false, 'example' => 'video'],
],
[
- 'name' => 'functionType',
- 'in' => 'query',
- 'schema' => [
- 'title' => '功能类型',
- 'description' => '功能类型',
- 'type' => 'string',
- 'required' => false,
- 'example' => 'PAAS',
- ],
- ],
- [
- 'name' => 'source',
- 'in' => 'query',
- 'schema' => [
- 'title' => '实例来源',
- 'description' => '实例来源'."\n"
- .'- builtin 系统实例'."\n"
- .'- user 用户实例 （默认）'."\n"
- .'- all 全部实例',
- 'type' => 'string',
- 'required' => false,
- 'example' => 'user',
- ],
- ],
- [
- 'name' => 'pageNumber',
- 'in' => 'query',
- 'schema' => [
- 'title' => '页码',
- 'description' => '页码',
- 'type' => 'integer',
- 'format' => 'int32',
- 'required' => false,
- 'example' => '1',
- ],
- ],
- [
- 'name' => 'pageSize',
- 'in' => 'query',
- 'schema' => [
- 'title' => '每页大小',
- 'description' => '每页大小',
- 'type' => 'integer',
- 'format' => 'int32',
- 'required' => false,
- 'example' => '10',
- ],
+ 'name' => 'taskName',
+ 'in' => 'path',
+ 'schema' => ['description' => '任务名称', 'type' => 'string', 'required' => false, 'example' => 'taskName'],
],
[
- 'name' => 'output',
+ 'name' => 'regionId',
'in' => 'query',
- 'schema' => [
- 'title' => '返回信息的丰富度',
- 'description' => '控制返回信息的丰富度'."\n"
- .'- simple：只显示基本信息'."\n"
- .'- normal：显示createParameters, cron等信息（默认）'."\n"
- .'- detail: 返回训练任务信息',
- 'type' => 'string',
- 'required' => false,
- 'example' => 'simple',
- ],
+ 'schema' => ['title' => '区域标识符', 'description' => '区域标识符', 'type' => 'string', 'required' => false, 'example' => 'cn-shanghai'],
],
],
'responses' => [
200 => [
'schema' => [
+ 'title' => 'Schema of Response',
+ 'description' => 'Schema of Response',
'type' => 'object',
'properties' => [
- 'code' => [
- 'description' => '错误码',
- 'type' => 'string',
- 'example' => 'not found',
- ],
- 'httpCode' => [
- 'description' => 'http状态码',
- 'type' => 'integer',
- 'format' => 'int64',
- 'example' => '200',
- ],
- 'latency' => [
- 'description' => '耗时',
- 'type' => 'integer',
- 'format' => 'int64',
- 'example' => '39.108',
- ],
- 'message' => [
- 'description' => '错误信息',
- 'type' => 'string',
- 'example' => '"xx not found"',
- ],
- 'requestId' => [
- 'description' => '请求ID',
- 'type' => 'string',
- 'example' => '33E4F0CA-F766-5803-B11C-70DC57A5A6E4',
- ],
+ 'requestId' => ['title' => 'Id of the request', 'description' => 'Id of the request', 'type' => 'string', 'example' => '5950143C-B8F0-5758-A08A-66F302FD587F'],
'result' => [
'description' => '返回结果',
- 'type' => 'array',
- 'items' => [
- 'description' => '返回结果',
- 'type' => 'object',
- 'properties' => [
- 'belongs' => [
- 'description' => '归属信息',
+ 'type' => 'object',
+ 'properties' => [
+ 'meta' => [
+ 'description' => '任务元数据',
+ 'type' => 'object',
+ 'properties' => [
+ 'computeResource' => ['description' => '计费规格', 'type' => 'string', 'example' => 'small'],
+ 'taskName' => ['description' => '任务名称', 'type' => 'string', 'example' => 'test'],
+ ],
+ ],
+ 'parameters' => ['description' => '任务处理参数', 'type' => 'object', 'example' => '{'."\n"
+ .' "parameter1": {'."\n"
+ .' "key": "value"'."\n"
+ .' },'."\n"
+ .' "parameter2": {'."\n"
+ .' "key": "value"'."\n"
+ .' }'."\n"
+ .'}'],
+ 'processors' => [
+ 'description' => '处理流程算子',
+ 'type' => 'array',
+ 'items' => [
+ 'description' => '处理流程算子',
'type' => 'object',
'properties' => [
- 'category' => [
- 'description' => '类别',
- 'type' => 'string',
- 'example' => '""',
- ],
- 'domain' => [
- 'description' => '行业类型',
- 'type' => 'string',
- 'example' => '""',
- ],
- 'language' => [
- 'description' => '语言，取值：'."\n"
- ."\n"
- .'- zh_CN：中文（默认值）'."\n"
- .'- en_US：英文',
- 'type' => 'string',
- 'example' => 'zh_CN',
- ],
+ 'input' => ['description' => '输入参数', 'type' => 'object', 'example' => '{'."\n"
+ .' "key": "content"'."\n"
+ .'}'."\n"],
+ 'name' => ['description' => '名称', 'type' => 'string', 'example' => 'processor1'],
+ 'parameters' => ['description' => 'processor处理参数', 'type' => 'object', 'example' => '{'."\n"
+ .' "service_id": "xxx"'."\n"
+ .'}'],
+ 'type' => ['description' => '类型', 'type' => 'string', 'example' => 'document-analyze'."\n"],
],
],
- 'createParameters' => [
- 'description' => '创建参数体',
- 'type' => 'array',
- 'items' => [
- 'description' => '创建参数体',
- 'type' => 'object',
- 'properties' => [
- 'name' => [
- 'description' => '参数名称。',
- 'type' => 'string',
- 'example' => 'name',
- ],
- 'value' => [
- 'description' => '参数值。',
- 'type' => 'string',
- 'example' => 'value',
+ ],
+ 'sink' => [
+ 'description' => '数据汇信息',
+ 'type' => 'array',
+ 'items' => [
+ 'description' => '数据汇信息',
+ 'type' => 'object',
+ 'properties' => [
+ 'name' => ['description' => '数据汇名', 'type' => 'string', 'example' => 'table2'],
+ 'parameters' => [
+ 'description' => '数据汇配置参数，由type决定',
+ 'type' => 'object',
+ 'additionalProperties' => ['type' => 'string', 'description' => 'key为String类型', 'example' => '{'."\n"
+ .' "key1": "value1",'."\n"
+ .' "key2": "value2"'."\n"
+ .'}'],
+ ],
+ 'primaryKey' => ['description' => '数据汇主键字段', 'type' => 'string', 'example' => 'id'],
+ 'schema' => [
+ 'description' => '数据汇Schema',
+ 'type' => 'array',
+ 'items' => [
+ 'description' => 'Schema',
+ 'type' => 'object',
+ 'additionalProperties' => ['type' => 'string', 'example' => '{'."\n"
+ .' "name": "id",'."\n"
+ .' "type": "string",'."\n"
+ .' "source": "table1.id"'."\n"
+ .'}'."\n", 'description' => 'key为String类型'],
],
],
+ 'type' => ['description' => '数据汇类型', 'type' => 'string', 'example' => 'swift'],
],
],
- 'createTime' => [
- 'description' => '创建时间',
- 'type' => 'integer',
- 'format' => 'int64',
- 'example' => '1713352442039',
- ],
- 'cron' => [
- 'description' => '定时调度任务Cron。',
- 'type' => 'string',
- 'example' => '""',
- ],
- 'description' => [
- 'description' => '描述',
- 'type' => 'string',
- 'example' => '描述',
- ],
- 'extendInfo' => [
- 'description' => '拓展信息',
- 'type' => 'string',
- 'example' => '""',
- ],
- 'functionName' => [
- 'description' => '配置项',
- 'type' => 'string',
- 'example' => 'nl2sql',
- ],
- 'functionType' => [
- 'description' => '配置类型',
- 'type' => 'string',
- 'example' => 'PAAS',
- ],
- 'instanceName' => [
- 'description' => '配置名称',
- 'type' => 'string',
- 'example' => 'a_test',
- ],
- 'modelType' => [
- 'description' => '模型类型',
- 'type' => 'string',
- 'example' => 'ops-query-analyze-001',
- ],
- 'source' => [
- 'description' => '实例来源'."\n"
- .'- builtin 系统实例'."\n"
- .'- user 用户实例 （默认）'."\n"
- .'- all 全部实例',
- 'type' => 'string',
- 'example' => 'all ',
- ],
- 'status' => [
- 'description' => '状态。'."\n"
- ."\n"
- .'- available'."\n"
- .'- unavailable',
- 'type' => 'string',
- 'example' => 'available',
- ],
- 'usageParameters' => [
- 'description' => 'usageParameters',
- 'type' => 'array',
- 'items' => [
- 'description' => 'usageParameters',
- 'type' => 'object',
- 'example' => '{}',
+ ],
+ 'source' => [
+ 'description' => '数据源信息',
+ 'type' => 'array',
+ 'items' => [
+ 'type' => 'object',
+ 'properties' => [
+ 'name' => ['description' => '数据源名', 'type' => 'string', 'example' => 'table1'."\n"],
+ 'parameters' => [
+ 'description' => '数据源配置参数，由type决定',
+ 'type' => 'object',
+ 'additionalProperties' => ['type' => 'string', 'example' => '{'."\n"
+ .' "key1": "value1",'."\n"
+ .' "key2": "value2"'."\n"
+ .'}', 'description' => 'key为String类型'],
+ ],
+ 'primaryKey' => ['description' => '数据源主键字段', 'type' => 'string', 'example' => 'id'],
+ 'schema' => [
+ 'description' => '数据源Schema',
+ 'type' => 'array',
+ 'items' => [
+ 'type' => 'object',
+ 'additionalProperties' => ['type' => 'string', 'example' => ' {'."\n"
+ .' "name": "id",'."\n"
+ .' "type": "string"'."\n"
+ .'}', 'description' => 'key为String类型'],
+ 'description' => '',
+ ],
+ ],
+ 'type' => ['description' => '数据源类型', 'type' => 'string', 'example' => 'swift'],
],
+ 'description' => '',
],
- 'versionId' => [
- 'description' => '版本ID',
- 'type' => 'integer',
- 'format' => 'int64',
- 'example' => '1',
+ ],
+ 'status' => [
+ 'description' => '任务状态',
+ 'type' => 'object',
+ 'properties' => [
+ 'createTime' => ['description' => '任务启动时间', 'type' => 'integer', 'format' => 'int64', 'example' => '1744941600000'],
+ 'deleteTime' => ['description' => '任务停止时间', 'type' => 'integer', 'format' => 'int64', 'example' => '1744941600000'],
+ 'errorMessage' => ['description' => '错误信息', 'type' => 'string', 'example' => '“”'],
+ 'status' => ['description' => '任务状态', 'type' => 'string', 'example' => 'RUNNING'],
],
],
],
],
- 'status' => [
- 'description' => '请求状态',
- 'type' => 'string',
- 'example' => 'OK',
- ],
- 'totalCount' => [
- 'description' => '总条数。',
- 'type' => 'integer',
- 'format' => 'int64',
- 'example' => '1',
- ],
],
],
],
],
- 'staticInfo' => [
- 'returnType' => 'synchronous',
+ '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' => '获取离线任务信息',
+ 'changeSet' => [
+ ['createdAt' => '2025-12-02T07:12:30.000Z', 'description' => '请求参数发生变更'],
+ ],
+ 'ramActions' => [
+ [
+ 'operationType' => 'get',
+ 'ramAction' => [
+ 'action' => 'searchplat:GetOfflineTask',
+ 'authLevel' => 'operate',
+ 'actionConditions' => [],
+ 'resources' => [
+ ['validationType' => 'always', 'product' => 'SearchPlat', 'resourceType' => '全部资源', 'arn' => '*'],
+ ],
+ ],
+ ],
],
- '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' => '获取服务/模型配置详情列表',
],
- 'CeaseFunctionInstance' => [
- 'summary' => '停止服务',
- 'path' => '/openapi/platform/workspaces/{workspaceName}/functions/{functionName}/instances/{instanceName}/actions/cease',
- 'methods' => [
- 'post',
- ],
- 'schemes' => [
- 'https',
- ],
+ 'GetRagEvaluatorTask' => [
+ 'summary' => '获取rag版评测任务。',
+ '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' => 'write',
+ 'consumes' => ['application/json'],
+ 'produces' => ['application/json'],
+ 'operationType' => 'read',
'deprecated' => false,
'systemTags' => [
- 'operationType' => 'none',
+ 'operationType' => 'get',
'riskType' => 'none',
'chargeType' => 'free',
- 'abilityTreeCode' => '239777',
- 'abilityTreeNodes' => [
- 'FEATUREopensearchJK5SO0',
- ],
- 'autoTest' => true,
- 'tenantRelevance' => 'tenant',
+ 'abilityTreeCode' => '228521',
+ 'abilityTreeNodes' => ['FEATUREopensearchWAC9DF'],
],
'parameters' => [
[
'name' => 'workspaceName',
'in' => 'path',
- 'schema' => [
- 'title' => 'opensearch应用名',
- 'description' => 'opensearch应用名',
- 'type' => 'string',
- 'required' => false,
- 'example' => 'default',
- ],
+ 'schema' => ['description' => '工作空间名称', 'type' => 'string', 'required' => false, 'example' => 'default'],
],
[
- 'name' => 'functionName',
- 'in' => 'path',
- 'schema' => [
- 'title' => '功能名称',
- 'description' => '功能名称',
- 'type' => 'string',
- 'required' => false,
- 'example' => 'notebook',
- ],
- ],
- [
- 'name' => 'instanceName',
+ 'name' => 'task_id',
'in' => 'path',
- 'schema' => [
- 'title' => '实例名称',
- 'description' => '实例名称',
- 'type' => 'string',
- 'required' => true,
- 'example' => 'test_notebook',
- ],
+ 'schema' => ['description' => '任务ID。', 'type' => 'string', 'required' => false, 'example' => 'de591cbcea6745e0b846ed051c5c3462'],
],
],
'responses' => [
200 => [
'schema' => [
+ 'title' => 'Schema of Response',
+ 'description' => 'Schema of Response',
'type' => 'object',
'properties' => [
- 'code' => [
- 'description' => '错误码。',
- 'type' => 'string',
- 'example' => 'not found',
- ],
- 'httpCode' => [
- 'description' => 'http状态码',
- 'type' => 'integer',
- 'format' => 'int64',
- 'example' => '200',
- ],
- 'latency' => [
- 'description' => '延时分',
- 'type' => 'integer',
- 'format' => 'int64',
- 'example' => '34.946',
- ],
- 'message' => [
- 'description' => '错误信息。',
- 'type' => 'string',
- 'example' => '"xx not found"',
- ],
- 'requestId' => [
- 'description' => '请求ID',
- 'type' => 'string',
- 'example' => '2423C841-91C4-5E51-B296-590D367967FC',
- ],
- 'status' => [
- 'description' => '请求状态',
- 'type' => 'string',
- 'example' => 'OK',
- ],
+ 'requestId' => ['title' => 'Id of the request', 'description' => 'Id of the request', 'type' => 'string', 'example' => '1CC93E65-6734-5060-BEF7-0EB0A4862BCF'],
+ 'code' => ['description' => '状态码'."\n", 'type' => 'string', 'example' => 'not found'],
+ 'message' => ['description' => '错误信息', 'type' => 'string', 'example' => '"xx not found"'],
+ 'result' => ['description' => '返回结果', 'type' => 'object', 'example' => '{'."\n"
+ .' "odps_task_id": 224525243, '."\n"
+ .' "usage" : {'."\n"
+ .' "cu" : 0.000'."\n"
+ .' }'],
],
],
],
],
- 'staticInfo' => [
- 'returnType' => 'synchronous',
+ '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' => '获取rag版评测任务',
+ 'changeSet' => [],
+ 'ramActions' => [
+ [
+ 'operationType' => 'get',
+ 'ramAction' => [
+ 'action' => 'searchplat:DescribeEvaluation',
+ 'authLevel' => 'operate',
+ 'actionConditions' => [],
+ 'resources' => [
+ ['validationType' => 'always', 'product' => 'SearchPlat', 'resourceType' => '全部资源', 'arn' => '*'],
+ ],
+ ],
+ ],
],
- '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' => '停止notebook服务',
],
- 'CreateFunctionInstance' => [
- 'summary' => '创建服务配置',
- 'path' => '/openapi/platform/workspaces/{workspaceName}/functions/{functionName}/instances',
- 'methods' => [
- 'post',
- ],
- 'schemes' => [
- 'https',
- ],
+ 'GetTableColumns' => [
+ 'summary' => '获取数据表',
+ 'path' => '/openapi/platform/workspaces/{workspaceName}/data-sources/{dataSourceType}/columns',
+ 'methods' => ['get'],
+ 'schemes' => ['https'],
'security' => [
[
'AK' => [],
],
],
- 'consumes' => [
- 'application/json',
- ],
- 'operationType' => 'readAndWrite',
+ 'consumes' => ['application/json'],
+ 'produces' => ['application/json'],
+ 'operationType' => 'read',
'deprecated' => false,
'systemTags' => [
- 'operationType' => 'create',
+ 'operationType' => 'get',
'riskType' => 'none',
'chargeType' => 'free',
- 'abilityTreeCode' => '239769',
- 'abilityTreeNodes' => [
- 'FEATUREopensearchJK5SO0',
- ],
+ 'abilityTreeCode' => '241066',
+ 'abilityTreeNodes' => ['FEATUREopensearchJK5SO0'],
'autoTest' => true,
- 'tenantRelevance' => 'publicInformation',
+ 'tenantRelevance' => 'tenant',
],
'parameters' => [
[
'name' => 'workspaceName',
'in' => 'path',
- 'schema' => [
- 'description' => '工作空间名称。',
- 'type' => 'string',
- 'required' => true,
- 'example' => 'myWorkspace',
- ],
+ 'schema' => ['description' => '工作空间名称', 'type' => 'string', 'required' => true, 'example' => 'default'],
],
[
- 'name' => 'functionName',
+ 'name' => 'dataSourceType',
'in' => 'path',
- 'schema' => [
- 'description' => '服务、模型类型'."\n"
- .'- nl2sql 服务'."\n"
- .'- embedding-tuning 模型',
- 'type' => 'string',
- 'required' => true,
- 'example' => 'nl2sql',
- ],
+ 'schema' => ['description' => '数据源类型'."\n"
+ ."\n"
+ .'- rds'."\n"
+ .'- odps', 'type' => 'string', 'required' => true, 'docRequired' => true, 'example' => 'rds'],
],
[
- 'name' => 'Body',
- 'in' => 'body',
- 'style' => 'json',
+ 'name' => 'params',
+ 'in' => 'query',
+ 'schema' => ['description' => '访问数据源的配置参数', '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"
+ .'}'],
+ ],
+ [
+ 'name' => 'regionId',
+ 'in' => 'query',
+ 'schema' => ['title' => '区域标识符', 'description' => '区域标识符', 'type' => 'string', 'required' => false, 'example' => 'cn-shanghai'],
+ ],
+ ],
+ 'responses' => [
+ 200 => [
'schema' => [
- 'title' => 'body参数',
- 'description' => 'body参数',
+ 'title' => 'Schema of Response',
+ 'description' => 'Schema of Response',
'type' => 'object',
'properties' => [
- 'instanceName' => [
- 'title' => '实例名称',
- 'description' => '配置、模型名称',
- 'type' => 'string',
- 'required' => true,
- 'example' => 'test',
- ],
- 'modelType' => [
- 'title' => '模型类型',
- 'description' => '服务ID'."\n"
- .'- ops-query-analyze-nl2sql-001'."\n"
- .'- ops-embedding-dim-reduction-001 向量降维',
- 'type' => 'string',
- 'required' => true,
- 'example' => 'ops-query-analyze-nl2sql-001',
- ],
- 'functionType' => [
- 'title' => '功能类型',
- 'description' => '配置类型'."\n"
- .'- PAAS'."\n"
- .'- SAAS',
- 'type' => 'string',
- 'required' => false,
- 'example' => 'PAAS',
- ],
- 'description' => [
- 'title' => '实例描述',
- 'description' => '实例描述',
- 'type' => 'string',
- 'required' => false,
- 'example' => 'desc',
- ],
- 'createParameters' => [
- 'title' => '创建参数',
- 'description' => '创建参数',
+ 'result' => [
+ 'description' => '返回结果',
'type' => 'array',
'items' => [
+ 'description' => '返回结果',
'type' => 'object',
'properties' => [
- 'name' => [
- 'title' => '参数名称',
- 'description' => '参数名称',
- 'type' => 'string',
- 'required' => false,
- 'example' => 'config',
- ],
- 'value' => [
- 'title' => '参数值',
- 'description' => '参数值',
- '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\\"}]}',
- ],
+ 'name' => ['description' => '字段名称', 'type' => 'string', 'example' => 'id'],
+ 'type' => ['description' => '字段类型', 'type' => 'string', 'example' => 'BIGINT'],
+ 'comment' => ['description' => '字段描述', 'type' => 'string', 'example' => '主键字段'],
+ 'primary' => ['description' => '是否为主键', 'type' => 'boolean', 'example' => 'true'],
],
- 'required' => false,
- 'description' => '参数项',
],
- 'required' => false,
],
+ 'requestId' => ['description' => '请求ID', 'type' => 'string', 'example' => '1CC93E65-6734-5060-BEF7-0EB0A4862BCF'],
],
- 'required' => false,
- 'docRequired' => true,
],
],
- ],
- 'responses' => [
- 200 => [
+ '5XX' => [
'schema' => [
'type' => 'object',
'properties' => [
- 'status' => [
- 'description' => '请求状态',
- 'type' => 'string',
- 'example' => 'OK',
- ],
- 'httpCode' => [
- 'description' => '业务成功与否。如果非空且不是200，那么表示业务处理失败。',
- 'type' => 'integer',
- 'format' => 'int64',
- 'example' => '200',
- ],
- 'requestId' => [
- 'description' => '请求ID。',
- 'type' => 'string',
- 'example' => '2BA0504F-B179-586D-8210-A7C7C09A9907',
- ],
- 'message' => [
- 'description' => '错误信息。',
- 'type' => 'string',
- 'example' => 'ok',
- ],
- 'code' => [
- 'description' => '错误码。',
- 'type' => 'string',
- 'example' => 'not found',
- ],
- 'latency' => [
- 'description' => '延时分',
- 'type' => 'integer',
- 'format' => 'int64',
- 'example' => '145.411',
- ],
+ 'code' => ['type' => 'string', 'description' => ''],
+ 'message' => ['type' => 'string', 'description' => ''],
+ 'requestId' => ['type' => 'string', 'description' => ''],
+ 'httpCode' => ['type' => 'integer', 'format' => 'int32', 'description' => ''],
],
+ 'description' => '',
],
],
],
- 'staticInfo' => [
- 'returnType' => 'synchronous',
+ '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' => '获取数据表字段信息',
+ 'changeSet' => [
+ ['createdAt' => '2025-12-02T07:12:30.000Z', 'description' => '请求参数发生变更'],
+ ],
+ 'ramActions' => [
+ [
+ 'operationType' => 'get',
+ 'ramAction' => [
+ 'action' => 'searchplat:GetTableColumns',
+ 'authLevel' => 'operate',
+ 'actionConditions' => [],
+ 'resources' => [
+ ['validationType' => 'always', 'product' => 'SearchPlat', 'resourceType' => '全部资源', 'arn' => '*'],
+ ],
+ ],
+ ],
],
- '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' => '创建服务/模型配置',
],
- 'CreateFunctionTask' => [
- 'summary' => '创建服务配置任务',
- 'path' => '/openapi/platform/workspaces/{workspaceName}/functions/{functionName}/instances/{instanceName}/tasks',
- 'methods' => [
- 'post',
- ],
- 'schemes' => [
- 'https',
- ],
+ 'GetTableFields' => [
+ 'path' => '/openapi/platform/workspaces/{workspaceName}/data-sources/{dataSourceType}/fields',
+ 'methods' => ['get'],
+ 'schemes' => ['https'],
'security' => [
[
'AK' => [],
],
],
- 'operationType' => 'write',
+ 'operationType' => 'read',
'deprecated' => false,
'systemTags' => [
- 'operationType' => 'create',
- 'riskType' => 'none',
- 'chargeType' => 'paid',
- 'abilityTreeCode' => '239788',
- 'abilityTreeNodes' => [
- 'FEATUREopensearchJK5SO0',
- ],
- 'autoTest' => true,
+ 'operationType' => 'get',
+ 'abilityTreeCode' => '241066',
+ 'abilityTreeNodes' => ['FEATUREopensearchJK5SO0'],
+ 'autoTest' => false,
+ 'notSupportAutoTestReason' => '无法关联资源',
'tenantRelevance' => 'publicInformation',
],
'parameters' => [
[
'name' => 'workspaceName',
'in' => 'path',
- 'schema' => [
- 'description' => '工作空间名称。',
- 'type' => 'string',
- 'required' => true,
- 'example' => 'myWorkspace',
- ],
+ 'schema' => ['description' => '工作空间名称', 'type' => 'string', 'required' => true, 'example' => 'default'],
],
[
- 'name' => 'functionName',
+ 'name' => 'dataSourceType',
'in' => 'path',
- 'schema' => [
- 'description' => '服务配置',
- 'type' => 'string',
- 'required' => true,
- 'example' => 'nl2sql',
- ],
+ 'schema' => ['description' => '数据源类型'."\n"
+ .'- odps', 'type' => 'string', 'required' => true, 'docRequired' => true, 'example' => 'odps'],
],
[
- 'name' => 'instanceName',
- 'in' => 'path',
- 'schema' => [
- 'description' => '配置名称',
- 'type' => 'string',
- 'required' => true,
- 'example' => 'test',
- ],
+ 'name' => 'params',
+ 'in' => 'query',
+ 'schema' => ['description' => '数据源参数', '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"
+ .'}'],
+ ],
+ [
+ 'name' => 'rawType',
+ 'in' => 'query',
+ 'schema' => ['description' => '是否返回数据源原始字段类型', 'type' => 'boolean', 'required' => false, 'example' => 'false'],
+ ],
+ [
+ 'name' => 'regionId',
+ 'in' => 'query',
+ 'schema' => ['description' => '地域ID', 'type' => 'string', 'required' => false, 'example' => 'cn-shanghai'],
],
],
'responses' => [
@@ -3604,108 +2766,102 @@
'schema' => [
'type' => 'object',
'properties' => [
- 'code' => [
- 'description' => '错误码。',
- 'type' => 'string',
- 'example' => 'not found',
- ],
- 'httpCode' => [
- 'description' => 'http状态码',
- 'type' => 'integer',
- 'format' => 'int64',
- 'example' => '200',
- ],
- 'latency' => [
- 'description' => '延时分',
- 'type' => 'integer',
- 'format' => 'int64',
- 'example' => '145.411',
- ],
- 'message' => [
- 'description' => '错误信息',
- 'type' => 'string',
- 'example' => '"xx not found"',
- ],
- 'requestId' => [
- 'description' => '请求ID',
- 'type' => 'string',
- 'example' => '58113A95-1858-5674-87E5-192AEE6FD9DD',
- ],
- 'status' => [
- 'description' => '请求状态',
- 'type' => 'string',
- 'example' => 'OK',
- ],
+ 'result' => ['description' => '返回结果', '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"
+ .' }'],
+ 'requestId' => ['description' => '请求ID', 'type' => 'string', 'example' => '58113A95-1858-5674-87E5-192AEE6FD9DD'],
],
+ 'description' => '',
+ ],
+ ],
+ '5XX' => [
+ 'schema' => [
+ 'type' => 'object',
+ 'properties' => [
+ 'code' => ['type' => 'string', 'description' => ''],
+ 'message' => ['type' => 'string', 'description' => ''],
+ 'requestId' => ['type' => 'string', 'description' => ''],
+ 'httpCode' => ['type' => 'integer', 'format' => 'int32', 'description' => ''],
+ ],
+ 'description' => '',
],
],
],
- 'staticInfo' => [
- 'returnType' => 'synchronous',
+ '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' => '获取数据表字段',
+ 'changeSet' => [],
+ 'ramActions' => [
+ [
+ 'operationType' => 'get',
+ 'ramAction' => [
+ 'action' => 'searchplat:GetTableFields',
+ 'authLevel' => 'resource',
+ 'actionConditions' => [],
+ 'resources' => [
+ ['validationType' => 'always', 'product' => 'SearchPlat', 'resourceType' => '全部资源', 'arn' => '*'],
+ ],
+ ],
+ ],
],
- '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' => '激活配置',
],
- 'DeleteFunctionInstance' => [
- 'summary' => '删除服务配置',
- 'path' => '/openapi/platform/workspaces/{workspaceName}/functions/{functionName}/instances/{instanceName}',
- 'methods' => [
- 'delete',
- ],
- 'schemes' => [
- 'https',
- ],
+ 'GetTables' => [
+ 'summary' => '获取数据表',
+ 'path' => '/openapi/platform/workspaces/{workspaceName}/data-sources/{dataSourceType}/tables',
+ 'methods' => ['get'],
+ 'schemes' => ['https'],
'security' => [
[
'AK' => [],
],
],
- 'operationType' => 'write',
+ 'consumes' => ['application/json'],
+ 'produces' => ['application/json'],
+ 'operationType' => 'read',
'deprecated' => false,
'systemTags' => [
- 'operationType' => 'delete',
+ 'operationType' => 'get',
'riskType' => 'none',
'chargeType' => 'free',
- 'abilityTreeCode' => '239777',
- 'abilityTreeNodes' => [
- 'FEATUREopensearchJK5SO0',
- ],
+ 'abilityTreeCode' => '241066',
+ 'abilityTreeNodes' => ['FEATUREopensearchJK5SO0'],
'autoTest' => true,
- 'tenantRelevance' => 'publicInformation',
+ 'tenantRelevance' => 'tenant',
],
'parameters' => [
[
'name' => 'workspaceName',
'in' => 'path',
- 'schema' => [
- 'title' => 'opensearch应用名',
- 'description' => '工作空间名称。',
- 'type' => 'string',
- 'required' => false,
- 'example' => 'myWorkspace',
- ],
+ 'schema' => ['description' => '工作空间名称', 'type' => 'string', 'required' => true, 'example' => 'default'],
],
[
- 'name' => 'functionName',
+ 'name' => 'dataSourceType',
'in' => 'path',
- 'schema' => [
- 'title' => '功能名称',
- 'description' => '服务/模型配置',
- 'type' => 'string',
- 'required' => false,
- 'example' => 'nl2sql',
- ],
+ 'schema' => ['description' => '数据源类型'."\n"
+ ."\n"
+ .'- rds'."\n"
+ .'- odps', 'type' => 'string', 'required' => true, 'docRequired' => true, 'example' => 'rds'],
],
[
- 'name' => 'instanceName',
- 'in' => 'path',
- 'schema' => [
- 'title' => '实例名称',
- 'description' => '配置名称',
- 'type' => 'string',
- 'required' => true,
- 'example' => 'test',
- ],
+ 'name' => 'params',
+ 'in' => 'query',
+ 'schema' => ['description' => '数据源参数', 'type' => 'string', 'required' => true, 'docRequired' => true, 'example' => '{'."\n"
+ .' "instanceId": "instance_id",'."\n"
+ .' "dbName": "db_name",'."\n"
+ .' "dbUser": "db_user",'."\n"
+ .' "dbPassword": "passwoed"'."\n"
+ .'}'."\n"],
+ ],
+ [
+ 'name' => 'regionId',
+ 'in' => 'query',
+ 'schema' => ['title' => '区域标识符', 'description' => '区域标识符', 'type' => 'string', 'required' => false, 'example' => 'cn-shanghai'],
],
],
'responses' => [
@@ -3713,57 +2869,53 @@
'schema' => [
'type' => 'object',
'properties' => [
- 'Code' => [
- 'description' => '错误码。仅当返回异常时显示。',
- 'type' => 'string',
- 'example' => 'iot.common.RamActionPermissionDeny',
- ],
- 'HttpCode' => [
- 'description' => 'http状态码',
- 'type' => 'integer',
- 'format' => 'int64',
- 'example' => '200',
- ],
- 'Latency' => [
- 'description' => '请求耗时，单位ms',
- 'type' => 'integer',
- 'format' => 'int64',
- 'example' => '12',
- ],
- 'Message' => [
- 'description' => '错误信息。仅当返回异常时显示。',
- 'type' => 'string',
- 'example' => 'Managed id is empty',
- ],
- 'RequestId' => [
- 'description' => '请求ID。',
- 'type' => 'string',
- 'example' => '786CC01F-0F1D-5FB5-8BFF-B0F3DB289772',
- ],
- 'Status' => [
- 'description' => '请求状态。',
- 'type' => 'string',
- 'example' => 'OK',
+ 'result' => [
+ 'description' => '返回结果',
+ 'type' => 'array',
+ 'items' => ['description' => '表名称', 'type' => 'string', 'example' => 'main'],
],
+ 'requestId' => ['description' => '请求ID', 'type' => 'string', 'example' => '33E4F0CA-F766-5803-B11C-70DC57A5A6E4'],
+ ],
+ 'description' => '',
+ ],
+ ],
+ '5XX' => [
+ 'schema' => [
+ 'type' => 'object',
+ 'properties' => [
+ 'code' => ['type' => 'string', 'description' => ''],
+ 'message' => ['type' => 'string', 'description' => ''],
+ 'requestId' => ['type' => 'string', 'description' => ''],
+ 'httpCode' => ['type' => 'integer', 'format' => 'int32', 'description' => ''],
],
+ 'description' => '',
],
],
],
- 'staticInfo' => [
- 'returnType' => 'synchronous',
+ 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"result\\": [\\n \\"main\\"\\n ],\\n \\"requestId\\": \\"33E4F0CA-F766-5803-B11C-70DC57A5A6E4\\"\\n}","type":"json"}]',
+ 'title' => '获取数据表',
+ 'changeSet' => [
+ ['createdAt' => '2025-12-02T07:12:30.000Z', 'description' => '请求参数发生变更'],
+ ],
+ 'ramActions' => [
+ [
+ 'operationType' => 'get',
+ 'ramAction' => [
+ 'action' => 'searchplat:GetTables',
+ 'authLevel' => 'operate',
+ 'actionConditions' => [],
+ 'resources' => [
+ ['validationType' => 'always', 'product' => 'SearchPlat', 'resourceType' => '全部资源', 'arn' => '*'],
+ ],
+ ],
+ ],
],
- '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' => '删除服务/模型配置',
],
- 'GetFunctionInstance' => [
- 'summary' => '查询指定工作空间中特定功能实例的详细信息。',
- 'path' => '/openapi/platform/workspaces/{workspaceName}/functions/{functionName}/instances/{instanceName}',
- 'methods' => [
- 'get',
- ],
- 'schemes' => [
- 'https',
- ],
+ 'GetWorkspace' => [
+ 'summary' => '获取工作空间',
+ 'path' => '/openapi/platform/workspaces/{workspaceName}',
+ 'methods' => ['get'],
+ 'schemes' => ['http', 'https'],
'security' => [
[
'AK' => [],
@@ -3772,343 +2924,136 @@
'operationType' => 'read',
'deprecated' => false,
'systemTags' => [
- 'operationType' => 'get',
+ 'operationType' => 'none',
'riskType' => 'none',
'chargeType' => 'free',
- 'abilityTreeCode' => '239784',
- 'abilityTreeNodes' => [
- 'FEATUREopensearchJK5SO0',
- ],
- 'autoTest' => true,
- 'tenantRelevance' => 'publicInformation',
+ 'abilityTreeCode' => '218193',
+ 'abilityTreeNodes' => ['FEATUREopensearchGVH0IN'],
],
'parameters' => [
[
'name' => 'workspaceName',
'in' => 'path',
- 'schema' => [
- 'description' => '工作空间名称'."\n",
- 'type' => 'string',
- 'required' => false,
- 'example' => 'default',
- ],
- ],
- [
- 'name' => 'functionName',
- 'in' => 'path',
- 'schema' => [
- 'description' => '服务类型nl2sql模型类型embedding-tuning自定义模型部署deployment服务开发notebook'."\n",
- 'type' => 'string',
- 'required' => false,
- 'example' => 'nl2sql',
- ],
- ],
- [
- 'name' => 'instanceName',
- 'in' => 'path',
- 'schema' => [
- 'description' => '配置/模型/自定义模型部署配置名称/notebook实例名称'."\n",
- 'type' => 'string',
- 'required' => true,
- 'example' => 'test',
- ],
- ],
- [
- 'name' => 'output',
- 'in' => 'query',
- 'schema' => [
- 'description' => '控制返回信息的丰富度'."\n"
- .'- simple：只显示基本信息'."\n"
- .'- normal：显示createParameters, cron等信息（默认）'."\n"
- .'- detail: 返回训练任务信息'."\n",
- 'type' => 'string',
- 'required' => false,
- 'example' => 'normal',
- ],
+ 'schema' => ['title' => 'A short description of struct', 'description' => '工作空间名称', 'type' => 'string', 'required' => true, 'example' => 'default'],
],
],
'responses' => [
200 => [
'schema' => [
- 'description' => '响应体示例'."\n",
+ 'title' => 'Schema of Response',
+ 'description' => 'Schema of Response',
'type' => 'object',
'properties' => [
- 'code' => [
- 'description' => '错误码。',
- 'type' => 'string',
- 'example' => 'not found',
- ],
- 'httpCode' => [
- 'description' => 'http状态码',
- 'type' => 'integer',
- 'format' => 'int64',
- 'example' => '200',
- ],
- 'latency' => [
- 'description' => '耗时',
- 'type' => 'integer',
- 'format' => 'int64',
- 'example' => '11.627',
- ],
- 'message' => [
- 'description' => '错误信息。',
- 'type' => 'string',
- 'example' => '"xx not found"',
- ],
- 'requestId' => [
- 'description' => '请求ID',
- 'type' => 'string',
- 'example' => 'C56462F4-CCB3-10BF-A3D8-FEE53C72B65C',
- ],
+ 'requestId' => ['title' => 'Id of the request', 'description' => 'Id of the request', 'type' => 'string', 'example' => '58113A95-1858-5674-87E5-192AEE6FD9DD'],
'result' => [
'description' => '返回结果',
'type' => 'object',
'properties' => [
- 'belongs' => [
- 'description' => '归属信息',
+ 'apiToken' => ['description' => 'apiToken', 'type' => 'string', 'example' => 'apiToken'],
+ 'chargeType' => ['description' => '付费类型'."\n"
+ .'- POSTPAY 后付费（按量付费）', 'type' => 'string', 'example' => 'POSTPAY'],
+ 'commodityCode' => ['description' => '商品CODE', 'type' => 'string', 'example' => 'commodityCode'],
+ 'description' => ['description' => '描述', 'type' => 'string', 'example' => '描述'],
+ 'domainName' => ['description' => '个性域名前缀', 'type' => 'string', 'example' => 'default-xxx'],
+ 'engineType' => ['description' => '引擎类型', 'type' => 'string', 'example' => 'rag'],
+ 'id' => ['description' => '工作空间ID', 'type' => 'string', 'example' => '1222212'],
+ 'instanceId' => ['description' => '实例ID', 'type' => 'string', 'example' => 'ops-cn-em93wcq0s001'],
+ 'name' => ['description' => '工作空间名称', 'type' => 'string', 'example' => 'default'],
+ 'quota' => [
+ 'description' => '配额',
'type' => 'object',
'properties' => [
- 'category' => [
- 'description' => '类别',
- 'type' => 'string',
- 'example' => '""',
- ],
- 'domain' => [
- 'description' => '行业类型',
- 'type' => 'string',
- 'example' => '""',
- ],
- 'language' => [
- 'description' => '语言',
- 'type' => 'string',
- 'example' => 'zh',
- ],
+ 'computeResource' => ['description' => '计算资源', 'type' => 'integer', 'format' => 'int32', 'example' => '0'],
+ 'docSize' => ['description' => '存储容量', 'type' => 'integer', 'format' => 'int32', 'example' => '0'],
+ 'spec' => ['description' => '规格', 'type' => 'string', 'example' => 'rag.share.common'],
],
],
- 'createParameters' => [
- 'description' => '具体配置项'."\n",
+ 'resourceGroupId' => ['description' => '资源组ID', 'type' => 'string', 'example' => 'rg-aekzaowqymbb4ki'],
+ 'status' => ['description' => '状态', 'type' => 'string', 'example' => '""'],
+ 'tags' => [
+ 'description' => '标签',
'type' => 'array',
'items' => [
- 'description' => '创建参数体',
+ 'description' => '标签',
'type' => 'object',
'properties' => [
- 'name' => [
- 'description' => '参数名称。',
- 'type' => 'string',
- 'example' => 'name',
- ],
- 'value' => [
- 'description' => '参数值。',
- 'type' => 'string',
- 'example' => 'value',
- ],
- ],
- ],
- ],
- 'createTime' => [
- 'description' => '创建时间',
- 'type' => 'integer',
- 'format' => 'int64',
- 'example' => '1724998630466',
- ],
- 'cron' => [
- 'description' => '定时调度任务Cron。',
- 'type' => 'string',
- 'example' => '""',
- ],
- 'description' => [
- 'description' => '描述',
- 'type' => 'string',
- 'example' => '描述',
- ],
- 'extendInfo' => [
- 'description' => '拓展信息',
- 'type' => 'string',
- 'example' => '""',
- ],
- 'functionName' => [
- 'description' => '配置类型'."\n"
- ."\n"
- .'- nl2sql '."\n"
- .'- embedding-tuning '."\n"
- .'- deployment '."\n"
- .'- notebook',
- 'type' => 'string',
- 'example' => 'nl2sql',
- ],
- 'functionType' => [
- 'description' => '配置类型PAAS：（默认）需要训练后才能使用'."\n",
- 'type' => 'string',
- 'example' => 'PAAS',
- ],
- 'instanceName' => [
- 'description' => '配置名称',
- 'type' => 'string',
- 'example' => 'test',
- ],
- 'modelType' => [
- 'description' => '模型类型，不同配置类型（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',
- ],
- 'source' => [
- 'description' => '来源',
- 'type' => 'string',
- 'example' => 'user',
- ],
- 'status' => [
- 'description' => '状态。'."\n"
- ."\n"
- .'- available'."\n"
- .'- unavailable',
- 'type' => 'string',
- 'example' => 'available',
- ],
- 'task' => [
- 'description' => '任务信息。',
- 'type' => 'object',
- 'properties' => [
- 'dagStatus' => [
- 'description' => '任务状态'."\n"
- ."\n"
- .'- success：成功'."\n"
- .'- failed：失败'."\n"
- .'- untrained: 待训练'."\n"
- .'- pending: 调度中'."\n"
- .'- running：训练中',
- 'type' => 'string',
- 'example' => 'success',
- ],
- 'lastRunTime' => [
- 'description' => '最后训练时间',
- 'type' => 'integer',
- 'format' => 'int64',
- 'example' => '1724998630466',
+ 'tagKey' => ['description' => '标签键', 'type' => 'string', 'example' => 'a'],
+ 'tagValue' => ['description' => '标签值', 'type' => 'string', 'example' => 'x'],
],
],
],
- 'versionId' => [
- 'description' => '训练版本ID',
- 'type' => 'integer',
- 'format' => 'int64',
- 'example' => '21',
- ],
+ 'type' => ['description' => '类型', 'type' => 'string', 'example' => 'standard'],
],
],
- 'status' => [
- 'description' => '请求状态',
- 'type' => 'string',
- 'example' => 'OK',
- ],
],
],
],
],
- 'staticInfo' => [
- 'returnType' => 'synchronous',
+ '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' => '查看一个工作空间详情',
+ '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}'],
+ ],
+ ],
+ ],
],
- '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' => '获取服务/模型配置详情',
],
- 'ListFunctionRestrictions' => [
- 'summary' => '获取功能的限制项',
- 'path' => '/openapi/platform/workspaces/{workspaceName}/functions/{functionName}/restrictions/{restrictionName}',
- 'methods' => [
- 'get',
- ],
- 'schemes' => [
- 'https',
- ],
+ 'ListAsyncTasks' => [
+ 'summary' => '获取异步任务列表。',
+ 'path' => '/openapi/platform/workspaces/{workspaceName}/async-tasks',
+ 'methods' => ['get'],
+ 'schemes' => ['http', 'https'],
'security' => [
[
'AK' => [],
],
],
- 'consumes' => [
- 'application/json',
- ],
- 'produces' => [
- 'application/json',
- ],
'operationType' => 'read',
'deprecated' => false,
'systemTags' => [
- 'operationType' => 'get',
+ 'operationType' => 'list',
'riskType' => 'none',
'chargeType' => 'free',
- 'abilityTreeNodes' => [
- 'FEATUREopensearchLIKVQB',
- ],
+ 'abilityTreeCode' => '225788',
+ 'abilityTreeNodes' => ['FEATUREopensearch1AJKH0'],
],
'parameters' => [
[
- 'name' => 'workspaceName',
- 'in' => 'path',
- 'schema' => [
- 'description' => '工作空间名称',
- 'type' => 'string',
- 'required' => false,
- 'example' => 'default',
- ],
- ],
- [
- 'name' => 'functionName',
- 'in' => 'path',
- 'schema' => [
- 'description' => '配置类型'."\n"
- ."\n"
- .'- deployment',
- 'type' => 'string',
- 'required' => false,
- 'example' => 'deployment',
- ],
+ 'name' => 'dryRun',
+ 'in' => 'query',
+ 'schema' => ['description' => '是否校验入参数据合法性，默认false。'."\n"
+ ."\n"
+ .'取值：'."\n"
+ ."\n"
+ .'- **true**'."\n"
+ ."\n"
+ .'- **false**', 'type' => 'boolean', 'required' => false, 'example' => 'true'],
],
[
- 'name' => 'restrictionName',
+ 'name' => 'workspaceName',
'in' => 'path',
- 'schema' => [
- 'description' => '限制名称'."\n"
- .'- model: 平台支持的模型名称'."\n"
- .'- instance_type: 平台支持的资源类型',
- 'type' => 'string',
- 'required' => false,
- 'example' => 'model',
- ],
+ 'schema' => ['description' => '工作空间名称', 'type' => 'string', 'required' => true, 'example' => 'default'],
],
[
- 'name' => 'modelType',
- 'in' => 'query',
- 'schema' => [
- 'description' => '模型类型',
- 'type' => 'string',
- 'required' => false,
- 'example' => 'native',
- ],
- ],
- [
- 'name' => 'region',
+ 'name' => 'serviceType',
'in' => 'query',
- 'schema' => [
- 'description' => '地域ID。',
- 'type' => 'string',
- 'required' => false,
- 'example' => 'cn-hangzhou',
- ],
+ 'schema' => ['description' => '服务类型。'."\n"
+ ."\n"
+ .'- document-analyze', 'type' => 'string', 'required' => false, 'example' => 'document-analyze'."\n"],
],
[
- 'name' => 'source',
+ 'name' => 'dataId',
'in' => 'query',
- 'schema' => [
- 'description' => '来源',
- 'type' => 'string',
- 'required' => false,
- 'example' => 'user',
- ],
+ 'schema' => ['description' => '体验数据ID。', 'type' => 'integer', 'format' => 'int32', 'required' => false, 'example' => '1231'],
],
],
'responses' => [
@@ -4118,32 +3063,7 @@
'description' => 'Schema of Response',
'type' => 'object',
'properties' => [
- 'status' => [
- 'description' => '请求状态',
- 'type' => 'string',
- 'example' => 'OK',
- ],
- 'requestId' => [
- 'description' => '请求id',
- 'type' => 'string',
- 'example' => '2423C841-91C4-5E51-B296-590D367967FC',
- ],
- 'code' => [
- 'description' => '错误码',
- 'type' => 'string',
- 'example' => 'not found',
- ],
- 'message' => [
- 'description' => '错误信息',
- 'type' => 'string',
- 'example' => '"xx not found"',
- ],
- 'totalCount' => [
- 'description' => '总条数',
- 'type' => 'integer',
- 'format' => 'int64',
- 'example' => '1',
- ],
+ 'requestId' => ['title' => 'Id of the request', 'description' => 'Id of the request', 'type' => 'string', 'example' => '2BA0504F-B179-586D-8210-A7C7C09A9907'],
'result' => [
'description' => '返回结果',
'type' => 'array',
@@ -4151,317 +3071,96 @@
'description' => '返回结果',
'type' => 'object',
'properties' => [
- 'name' => [
- 'description' => '规则名称',
- 'type' => 'string',
- 'example' => 'test',
- ],
- 'meta' => [
- 'description' => '元信息',
- '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"
- .' }',
- ],
+ 'id' => ['description' => '异步任务id', 'type' => 'string', 'example' => 'ae1cea6dc680b98b908a757050c406c9'],
+ 'serviceType' => ['description' => '服务类型。'."\n"
+ ."\n"
+ .'- document-analyze', 'type' => 'string', 'example' => 'document-analyze'."\n"],
+ 'serviceId' => ['description' => '服务ID。', 'type' => 'string', 'example' => 'ops-document-analyze-001'],
+ 'name' => ['description' => '文件名称', 'type' => 'string', 'example' => 'test'],
+ 'dataId' => ['description' => '体验数据ID。', 'type' => 'integer', 'format' => 'int32', 'example' => '1232'],
+ 'status' => ['description' => '任务状态'."\n"
+ .'- PENDING 进行中'."\n"
+ .'- SUCCESS 解析成功'."\n"
+ .'- FAILED 解析失败', 'type' => 'string', 'example' => 'SUCCESS'],
+ 'result' => ['description' => '任务执行结果', 'type' => 'string', 'example' => 'xxxxx'],
+ 'created' => ['description' => '创建时间戳', 'type' => 'integer', 'format' => 'int64', 'example' => '1745893195510'],
+ 'updated' => ['description' => '更新时间', 'type' => 'integer', 'format' => 'int64', 'example' => '1729665694'],
],
],
],
- 'httpCode' => [
- 'description' => 'http状态码',
- 'type' => 'integer',
- 'format' => 'int64',
- 'example' => '200',
- ],
- 'latency' => [
- 'description' => '耗时',
- 'type' => 'number',
- 'format' => 'double',
- 'example' => '10.444',
- ],
],
],
],
],
- 'staticInfo' => [
- 'returnType' => 'synchronous',
+ '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' => '获取异步任务列表',
+ '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}'],
+ ],
+ ],
+ ],
],
- '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' => '获取功能的限制项',
],
- 'DeleteRagEvaluatorTask' => [
- 'summary' => 'rag版评测任务删除。',
- 'path' => '/openapi/platform/workspaces/{workspaceName}/rag-evaluator/v1/api/task/{task_id}',
- 'methods' => [
- 'delete',
- ],
- 'schemes' => [
- 'http',
- 'https',
- ],
+ 'ListCapabilities' => [
+ 'summary' => '查询指定工作空间下的特定类别配置项列表。',
+ 'path' => '/openapi/platform/workspaces/{workspaceName}/capabilities/{itemCategory}/items',
+ 'methods' => ['get'],
+ 'schemes' => ['https'],
'security' => [
[
'AK' => [],
],
],
- 'consumes' => [
- 'application/json',
- ],
- 'produces' => [
- 'application/json',
- ],
- 'operationType' => 'write',
+ 'consumes' => ['application/json'],
+ 'produces' => ['application/json'],
+ 'operationType' => 'read',
'deprecated' => false,
'systemTags' => [
- 'operationType' => 'delete',
+ 'operationType' => 'list',
'riskType' => 'none',
'chargeType' => 'free',
- 'abilityTreeCode' => '226069',
- 'abilityTreeNodes' => [
- 'FEATUREopensearchWAC9DF',
- ],
+ 'abilityTreeNodes' => ['FEATUREopensearch8B42ZS'],
+ 'tenantRelevance' => 'tenant',
],
'parameters' => [
[
'name' => 'workspaceName',
'in' => 'path',
- 'schema' => [
- 'description' => '工作空间名称。',
- 'type' => 'string',
- 'required' => false,
- 'example' => 'myWorkspace',
- ],
+ 'schema' => ['description' => '工作空间名称'."\n", 'type' => 'string', 'required' => true, 'example' => 'default'],
],
[
- 'name' => 'task_id',
+ 'name' => 'itemCategory',
'in' => 'path',
- 'schema' => [
- 'description' => '任务 id',
- 'type' => 'string',
- 'required' => false,
- 'example' => 'T-6684b38a48bc8e012d00052c',
- ],
+ 'schema' => ['description' => '配置类别', 'type' => 'string', 'required' => true, 'example' => 'ai_search_agent'],
],
- ],
- 'responses' => [
- 200 => [
- 'schema' => [
- 'title' => 'Schema of Response',
- 'description' => 'Schema of Response',
- 'type' => 'object',
- 'properties' => [
- 'requestId' => [
- 'title' => 'Id of the request',
- 'description' => 'Id of the request',
- 'type' => 'string',
- 'example' => '0B66A850-506C-56B7-B001-EA09411CCD69',
- ],
- 'code' => [
- 'description' => '状态码'."\n",
- 'type' => 'string',
- 'example' => 'not found',
- ],
- 'message' => [
- 'description' => '错误信息',
- 'type' => 'string',
- 'example' => '"xx not found"',
- ],
- ],
- ],
- ],
- ],
- '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' => '删除评测任务',
- ],
- 'CreateRagEvaluatorTask' => [
- 'summary' => 'rag版评测任务创建。',
- 'path' => '/openapi/platform/workspaces/{workspaceName}/rag-evaluator/v1/api/task',
- 'methods' => [
- 'post',
- ],
- 'schemes' => [
- 'http',
- 'https',
- ],
- 'security' => [
[
- 'AK' => [],
+ 'name' => 'pageNumber',
+ 'in' => 'query',
+ 'schema' => ['description' => '页码', 'type' => 'string', 'required' => false, 'example' => '1'],
],
- ],
- 'consumes' => [
- 'application/json',
- ],
- 'produces' => [
- 'application/json',
- ],
- 'operationType' => 'write',
- 'deprecated' => false,
- 'systemTags' => [
- 'operationType' => 'create',
- 'riskType' => 'none',
- 'chargeType' => 'free',
- 'abilityTreeCode' => '226065',
- 'abilityTreeNodes' => [
- 'FEATUREopensearchWAC9DF',
+ [
+ 'name' => 'pageSize',
+ 'in' => 'query',
+ 'schema' => ['description' => '分页size', 'type' => 'string', 'required' => false, 'example' => '10'],
],
- ],
- 'parameters' => [
[
- 'name' => 'workspaceName',
- 'in' => 'path',
- 'schema' => [
- 'description' => '工作空间名称。',
- 'type' => 'string',
- 'required' => false,
- 'example' => 'myWorkspace',
- ],
+ 'name' => 'nextToken',
+ 'in' => 'query',
+ 'schema' => ['description' => '分页Token', 'type' => 'string', 'required' => false, 'example' => 'tMEiGtggHs0='],
],
[
- 'name' => 'body',
- 'in' => 'body',
- 'style' => 'json',
- 'schema' => [
- 'description' => '请求体',
- 'type' => 'object',
- 'properties' => [
- 'app_name' => [
- 'description' => 'app_name',
- 'type' => 'string',
- 'required' => false,
- 'example' => '空',
- ],
- 'task_name' => [
- 'description' => '评测任务名称',
- 'type' => 'string',
- 'required' => false,
- 'example' => 'taskName',
- ],
- 'data' => [
- 'description' => '评测数据列表',
- 'type' => 'array',
- 'items' => [
- 'description' => '评测数据',
- 'type' => 'object',
- 'properties' => [
- 'question' => [
- 'description' => 'question',
- 'type' => 'string',
- 'required' => false,
- 'example' => '空',
- ],
- 'standard_answer' => [
- 'description' => 'standard_answer',
- 'type' => 'string',
- 'required' => false,
- 'example' => '空',
- ],
- 'recall_docs' => [
- 'description' => 'recall_docs',
- 'type' => 'array',
- 'items' => [
- 'description' => 'recall_doc',
- 'type' => 'string',
- 'required' => false,
- 'example' => '空',
- ],
- 'required' => false,
- ],
- 'model_answer' => [
- 'description' => 'model_answer',
- 'type' => 'string',
- 'required' => false,
- 'example' => '空',
- ],
- ],
- 'required' => false,
- ],
- 'required' => false,
- ],
- 'evaluate_config' => [
- 'description' => '评测配置',
- 'type' => 'object',
- 'properties' => [
- 'model' => [
- 'description' => '使用模型',
- 'type' => 'string',
- 'required' => false,
- 'example' => 'qwen-72b',
- ],
- 'prompt' => [
- 'description' => 'prompt',
- 'type' => 'string',
- 'required' => false,
- 'example' => '空',
- ],
- 'run_all_step' => [
- 'description' => 'run_all_step',
- 'type' => 'boolean',
- 'required' => false,
- 'example' => 'false',
- ],
- ],
- 'required' => false,
- ],
- 'metrics' => [
- 'description' => '指标值。'."\n"
- .'- context_recall'."\n"
- .'- context_precision'."\n"
- .'- faithfulness'."\n"
- .'- satisfaction'."\n"
- .'- comprehensive_score',
- 'type' => 'array',
- 'items' => [
- 'description' => '指标值。',
- 'type' => 'any',
- 'required' => false,
- 'example' => 'context_recall',
- ],
- 'required' => false,
- ],
- 'emails' => [
- 'description' => 'emails',
- 'type' => 'array',
- 'items' => [
- 'description' => 'email',
- 'type' => 'string',
- 'required' => false,
- 'example' => '空',
- ],
- 'required' => false,
- ],
- 'has_data_source' => [
- 'description' => 'has_data_source',
- 'type' => 'boolean',
- 'required' => false,
- 'example' => '空',
- ],
- 'data_source_config' => [
- 'description' => '配置数据源配置',
- 'type' => 'any',
- 'required' => false,
- 'example' => '{'."\n"
- .'"data_source_type": "oss",'."\n"
- .'"file_path": "oss://xxx.",'."\n"
- .'"file_name": "04837719-default-zz.xlsx"'."\n"
- .'}',
- ],
- ],
- 'required' => false,
- ],
+ 'name' => 'maxResults',
+ 'in' => 'query',
+ 'schema' => ['description' => '分页查询时每页行数', 'type' => 'integer', 'format' => 'int32', 'required' => false, 'example' => '10'],
],
],
'responses' => [
@@ -4471,95 +3170,91 @@
'description' => 'Schema of Response',
'type' => 'object',
'properties' => [
- 'requestId' => [
- 'title' => 'Id of the request',
- 'description' => 'Id of the request',
- 'type' => 'string',
- 'example' => '0abb793917165176014887584e28d9',
- ],
- 'code' => [
- 'description' => '错误码'."\n",
- 'type' => 'string',
- 'example' => 'not found',
- ],
- 'message' => [
- 'description' => '错误信息。',
- 'type' => 'string',
- 'example' => '"xx not found"',
- ],
+ 'requestId' => ['title' => 'Id of the request', 'description' => 'Id of the request', 'type' => 'string', 'example' => '5950143C-B8F0-5758-A08A-66F302FD587F'],
+ 'status' => ['description' => '请求状态', 'type' => 'string', 'example' => 'OK'],
+ 'httpCode' => ['description' => 'http状态码', 'type' => 'integer', 'format' => 'int64', 'example' => '200'],
+ 'totalCount' => ['description' => '总条数。', 'type' => 'integer', 'format' => 'int64', 'example' => '4'],
'result' => [
'description' => '返回结果',
- 'type' => 'object',
- 'properties' => [
- 'taskId' => [
- 'description' => '任务id',
- 'type' => 'string',
- 'example' => '1846389386674049024',
+ 'type' => 'array',
+ 'items' => [
+ 'description' => '返回结果',
+ 'type' => 'object',
+ 'properties' => [
+ 'created' => ['description' => '创建时间'."\n", 'type' => 'integer', 'format' => 'int64', 'example' => '1729665694'],
+ 'isDefault' => ['description' => '是否为默认配置'."\n", 'type' => 'boolean', 'example' => 'false'],
+ 'itemCategory' => ['description' => '配置类别'."\n", 'type' => 'string', 'example' => 'ai_search_agent'],
+ 'itemDesc' => ['description' => '配置描述'."\n", 'type' => 'string', 'example' => '描述'."\n"
+ ."\n"],
+ 'itemName' => ['description' => '配置名称'."\n", 'type' => 'string', 'example' => 'es_knowledge_base'],
+ 'itemValue' => ['description' => 'itemValue'."\n", 'type' => 'object'],
+ 'status' => ['description' => 'status'."\n", 'type' => 'string', 'example' => 'available'],
+ 'updated' => ['description' => 'updated'."\n", 'type' => 'integer', 'format' => 'int64', 'example' => '1729665694'],
],
],
],
+ 'nextToken' => ['description' => '下一个查询开始Token', 'type' => 'string', 'example' => 'G5FG/nXfNOQ='],
+ 'maxResults' => ['description' => '结果返回个数', 'type' => 'integer', 'format' => 'int32', 'example' => '1000'],
],
],
],
],
- 'staticInfo' => [
- 'returnType' => 'synchronous',
+ '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' => '获取配置列表',
+ 'description' => '## 请求说明'."\n"
+ .'通过此 API，您可以根据提供的工作空间名称和配置类别来获取相应的配置项列表。支持分页查询，可以通过 `pageNumber` 和 `pageSize` 参数控制返回结果的数量及页码。此外，还提供了 `nextToken` 和 `maxResults` 参数用于处理大量数据时的分页逻辑。'."\n",
+ 'changeSet' => [],
+ 'ramActions' => [
+ [
+ 'operationType' => 'list',
+ 'ramAction' => [
+ 'action' => 'searchplat:ListCapabilities',
+ 'authLevel' => 'operate',
+ 'actionConditions' => [],
+ 'resources' => [
+ ['validationType' => 'always', 'product' => 'SearchPlat', 'resourceType' => '全部资源', 'arn' => '*'],
+ ],
+ ],
+ ],
],
- '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' => '创建评测任务',
],
- 'GetRagEvaluatorTask' => [
- 'summary' => '获取rag版评测任务。',
- 'path' => '/openapi/platform/workspaces/{workspaceName}/rag-evaluator/v1/api/task/{task_id}',
- 'methods' => [
- 'get',
- ],
- 'schemes' => [
- 'http',
- 'https',
- ],
+ 'ListCredentials' => [
+ 'path' => '/openapi/platform/workspaces/{workspaceName}/credentials',
+ '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',
- ],
+ 'operationType' => 'list',
+ 'abilityTreeCode' => '220525',
+ 'abilityTreeNodes' => ['FEATUREopensearch1AJKH0'],
],
'parameters' => [
[
- 'name' => 'workspaceName',
- 'in' => 'path',
- 'schema' => [
- 'description' => '工作空间名称',
- 'type' => 'string',
- 'required' => false,
- 'example' => 'default',
- ],
+ 'name' => 'pageSize',
+ 'in' => 'query',
+ 'schema' => ['description' => '每页大小，默认值为10', 'type' => 'integer', 'format' => 'int32', 'required' => false, 'maximum' => '100', 'minimum' => '10', 'example' => '10'],
],
[
- 'name' => 'task_id',
+ 'name' => 'pageNumber',
+ 'in' => 'query',
+ 'schema' => ['description' => '页码，默认 pageNumber = 1', 'type' => 'integer', 'format' => 'int32', 'required' => false, 'example' => '1'],
+ ],
+ [
+ 'name' => 'keyword',
+ 'in' => 'query',
+ 'schema' => ['description' => '凭证值搜索关键词', 'type' => 'string', 'required' => false, 'example' => 'OS-**'],
+ ],
+ [
+ 'name' => 'workspaceName',
'in' => 'path',
- 'schema' => [
- 'description' => '任务ID。',
- 'type' => 'string',
- 'required' => false,
- 'example' => 'de591cbcea6745e0b846ed051c5c3462',
- ],
+ 'schema' => ['description' => '工作空间名称。', 'type' => 'string', 'required' => true, 'example' => 'myWorkspace'],
],
],
'responses' => [
@@ -4569,103 +3264,91 @@
'description' => 'Schema of Response',
'type' => 'object',
'properties' => [
- 'requestId' => [
- 'title' => 'Id of the request',
- 'description' => 'Id of the request',
- 'type' => 'string',
- 'example' => '1CC93E65-6734-5060-BEF7-0EB0A4862BCF',
- ],
- 'code' => [
- 'description' => '状态码'."\n",
- 'type' => 'string',
- 'example' => 'not found',
- ],
- 'message' => [
- 'description' => '错误信息',
- 'type' => 'string',
- 'example' => '"xx not found"',
- ],
+ 'requestId' => ['title' => 'Id of the request', 'description' => 'Id of the request', 'type' => 'string', 'example' => '33E4F0CA-F766-5803-B11C-70DC57A5A6E4'],
'result' => [
'description' => '返回结果',
- 'type' => 'object',
- 'example' => '{'."\n"
- .' "odps_task_id": 224525243, '."\n"
- .' "usage" : {'."\n"
- .' "cu" : 0.000'."\n"
- .' }',
+ 'type' => 'array',
+ 'items' => [
+ 'description' => '返回结果',
+ 'type' => 'object',
+ 'properties' => [
+ 'token' => ['description' => '访问凭证token。', 'type' => 'string', 'example' => 'OS-****'],
+ 'enabled' => ['description' => '凭据是否启用。'."\n"
+ .'取值：'."\n"
+ ."\n"
+ .'- true：启用。 '."\n"
+ .'- false：禁用。', 'type' => 'boolean', 'example' => 'true'],
+ 'type' => ['description' => '凭证类型。'."\n"
+ ."\n"
+ .'- api-token', 'type' => 'string', 'example' => 'api-token'."\n"],
+ 'appGroupId' => ['description' => '工作空间ID。', 'type' => 'integer', 'format' => 'int64', 'example' => '123123'],
+ ],
+ ],
],
+ 'totalCount' => ['description' => '总条数。', 'type' => 'integer', 'format' => 'int64', 'example' => '1'],
],
],
],
],
- 'staticInfo' => [
- 'returnType' => 'synchronous',
+ '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' => '查询访问凭证列表',
+ 'summary' => '获取访问凭证列表',
+ '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}'],
+ ],
+ ],
+ ],
],
- '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' => '获取rag版评测任务',
],
- 'ListRagEvaluatorTasks' => [
- 'summary' => '获取rag版评测任务列表',
- 'path' => '/openapi/platform/workspaces/{workspaceName}/rag-evaluator/v1/api/tasks',
- 'methods' => [
- 'get',
- ],
- 'schemes' => [
- 'http',
- 'https',
- ],
+ 'ListExperienceData' => [
+ 'summary' => '获取指定工作空间下的所有体验数据，支持按服务类型和数据类型筛选。',
+ 'path' => '/openapi/platform/workspaces/{workspaceName}/experience-data',
+ 'methods' => ['get'],
+ 'schemes' => ['http', 'https'],
'security' => [
[
'AK' => [],
],
],
- 'consumes' => [
- 'application/json',
- ],
- 'produces' => [
- 'application/json',
- ],
'operationType' => 'read',
'deprecated' => false,
'systemTags' => [
- 'operationType' => 'get',
+ 'operationType' => 'list',
'riskType' => 'none',
'chargeType' => 'free',
- 'abilityTreeCode' => '226077',
- 'abilityTreeNodes' => [
- 'FEATUREopensearchWAC9DF',
- ],
+ 'abilityTreeCode' => '225365',
+ 'abilityTreeNodes' => ['FEATUREopensearch1AJKH0'],
],
'parameters' => [
[
- 'name' => 'workspaceName',
- 'in' => 'path',
- 'schema' => [
- 'description' => '工作空间名称',
- 'type' => 'string',
- 'required' => false,
- 'example' => 'default',
- ],
+ 'name' => 'dryRun',
+ 'in' => 'query',
+ 'schema' => ['description' => '- true'."\n"
+ .'- false', 'type' => 'boolean', 'required' => false, 'example' => 'true'],
],
[
- 'name' => 'pageNumber',
+ 'name' => 'serviceType',
'in' => 'query',
- 'schema' => [
- 'description' => '页数，默认为1'."\n",
- 'type' => 'string',
- 'required' => false,
- 'example' => '1',
- ],
+ 'schema' => ['description' => '服务类型'."\n", 'type' => 'string', 'required' => false, 'example' => 'document-analyze'],
],
[
- 'name' => 'pageSize',
+ 'name' => 'workspaceName',
+ 'in' => 'path',
+ 'schema' => ['description' => '工作空间名称', 'type' => 'string', 'required' => true, 'example' => 'default'],
+ ],
+ [
+ 'name' => 'dataType',
'in' => 'query',
- 'schema' => [
- 'description' => '分页大小',
- 'type' => 'string',
- 'required' => false,
- 'example' => '10',
- ],
+ 'schema' => ['description' => '数据类型'."\n", 'type' => 'string', 'required' => false, 'example' => 'file'],
],
],
'responses' => [
@@ -4675,460 +3358,269 @@
'description' => 'Schema of Response',
'type' => 'object',
'properties' => [
- 'requestId' => [
- 'title' => 'Id of the request',
- 'description' => 'Id of the request',
- 'type' => 'string',
- 'example' => '1CC93E65-6734-5060-BEF7-0EB0A4862BCF',
- ],
- 'code' => [
- 'description' => '错误码'."\n",
- 'type' => 'string',
- 'example' => 'not found',
- ],
- 'message' => [
- 'description' => '错误信息。',
- 'type' => 'string',
- 'example' => '"xx not found"',
- ],
+ 'requestId' => ['title' => 'Id of the request', 'description' => '请求ID'."\n", 'type' => 'string', 'example' => 'FDSS_1232'],
'result' => [
'description' => '返回结果',
- 'type' => 'object',
- 'example' => '{'."\n"
- .' "odps_task_id": 224525243, '."\n"
- .' "usage" : {'."\n"
- .' "cu" : 0.000'."\n"
- .' }',
- ],
- 'totalCount' => [
- 'description' => '总条数。',
- 'type' => 'integer',
- 'format' => 'int32',
- 'example' => '1',
+ 'type' => 'array',
+ 'items' => [
+ 'description' => '返回结果',
+ 'type' => 'object',
+ 'properties' => [
+ 'id' => ['description' => 'ID'."\n", 'type' => 'integer', 'format' => 'int64', 'example' => '9bd21be8'],
+ 'serviceType' => ['description' => '服务类型'."\n", 'type' => 'string', 'example' => 'document-analyze'],
+ 'dataType' => ['description' => '数据类型'."\n"
+ ."\n"
+ .'- file'."\n"
+ .'- url', 'type' => 'string', 'example' => 'file'],
+ 'name' => ['description' => '名称'."\n", 'type' => 'string', 'example' => 'xxx.pdf'],
+ 'dataValue' => ['description' => '数据值'."\n", 'type' => 'string', 'example' => 'oss://bucket/xxx.pdf'],
+ 'dataSize' => ['description' => '**数据大小**'."\n", 'type' => 'integer', 'format' => 'int64', 'example' => '100'],
+ 'created' => ['description' => '**创建时间**'."\n", 'type' => 'integer', 'format' => 'int64', 'example' => '12313123123'],
+ 'updated' => ['description' => '更新时间', 'type' => 'integer', 'format' => 'int64', 'example' => '1232131231'],
+ 'contentType' => ['description' => '**内容类型**'."\n", 'type' => 'string', 'example' => 'pdf'],
+ ],
+ ],
],
],
],
],
],
- 'staticInfo' => [
- 'returnType' => 'synchronous',
+ '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' => '获取体验数据列表',
+ 'description' => '## 请求说明'."\n"
+ .'- 该API用于查询用户在特定工作空间内的所有体验数据，默认按照创建时间降序排列。'."\n"
+ .'- 不支持分页功能，但可以通过`serviceType`（服务类型）和`dataType`（数据类型）参数进行数据筛选。'."\n"
+ .'- `workspaceName`是路径参数，必须提供以指定查询的工作空间。'."\n",
+ '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}'],
+ ],
+ ],
+ ],
],
- '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' => '获取rag版评测任务列表',
],
- 'StopOfflineTask' => [
- 'summary' => '停止离线任务',
- 'path' => '/openapi/platform/workspaces/{workspaceName}/offline-tasks/{type}/{taskName}/actions/stop',
- 'methods' => [
- 'post',
- ],
- 'schemes' => [
- 'https',
- ],
+ 'ListFunctionInstances' => [
+ 'summary' => '获取服务配置列表',
+ 'path' => '/openapi/platform/workspaces/{workspaceName}/functions/{functionName}/instances',
+ 'methods' => ['get'],
+ 'schemes' => ['https'],
'security' => [
[
'AK' => [],
],
],
- 'consumes' => [
- 'application/json',
- ],
- 'produces' => [
- 'application/json',
- ],
- 'operationType' => 'write',
+ 'operationType' => 'read',
'deprecated' => false,
'systemTags' => [
- 'operationType' => 'none',
+ 'operationType' => 'list',
'riskType' => 'none',
'chargeType' => 'free',
- 'abilityTreeNodes' => [
- 'FEATUREopensearch8B42ZS',
- ],
- 'tenantRelevance' => 'tenant',
+ 'abilityTreeCode' => '239787',
+ 'abilityTreeNodes' => ['FEATUREopensearchJK5SO0'],
+ 'autoTest' => true,
+ 'tenantRelevance' => 'publicInformation',
],
'parameters' => [
[
'name' => 'workspaceName',
'in' => 'path',
- 'schema' => [
- 'description' => '工作空间名称',
- 'type' => 'string',
- 'required' => false,
- 'example' => 'default',
- ],
+ 'schema' => ['title' => '实例名称', 'description' => '工作空间名称', 'type' => 'string', 'required' => false, 'example' => 'default'],
],
[
- 'name' => 'type',
+ 'name' => 'functionName',
'in' => 'path',
- 'schema' => [
- 'description' => '任务类型',
- 'type' => 'string',
- 'required' => false,
- 'example' => 'video',
- ],
+ 'schema' => ['title' => '功能名称', 'description' => '功能名称', 'type' => 'string', 'required' => false, 'example' => 'deployment'],
],
[
- 'name' => 'taskName',
- 'in' => 'path',
- 'schema' => [
- 'description' => '任务名称',
- 'type' => 'string',
- 'required' => false,
- 'example' => 'taskName'."\n",
- ],
+ 'name' => 'modelType',
+ 'in' => 'query',
+ 'schema' => ['title' => '模型类型', 'description' => '模型类型', 'type' => 'string', 'required' => false, 'example' => 'ai_search'],
],
[
- 'name' => 'regionId',
+ 'name' => 'functionType',
'in' => 'query',
- 'schema' => [
- 'title' => '区域标识符',
- 'description' => '区域标识符',
- 'type' => 'string',
- 'required' => false,
- 'example' => 'cn-shanghai',
- ],
+ 'schema' => ['title' => '功能类型', 'description' => '功能类型', 'type' => 'string', 'required' => false, 'example' => 'PAAS'],
],
[
- 'name' => 'body',
- 'in' => 'body',
- 'style' => 'json',
- 'schema' => [
- 'description' => '请求体',
- 'type' => 'object',
- 'properties' => [
- 'timestamp' => [
- 'description' => '启动位点',
- 'type' => 'integer',
- 'format' => 'int64',
- 'required' => false,
- 'example' => '1747900639',
- ],
- 'parallelism' => [
- 'description' => '任务并行度',
- 'type' => 'integer',
- 'format' => 'int32',
- 'required' => false,
- 'example' => '2',
- ],
- ],
- 'required' => false,
- 'example' => 'cn-shanghai',
- ],
+ 'name' => 'source',
+ 'in' => 'query',
+ 'schema' => ['title' => '实例来源', 'description' => '实例来源'."\n"
+ .'- builtin 系统实例'."\n"
+ .'- user 用户实例 （默认）'."\n"
+ .'- all 全部实例', 'type' => 'string', 'required' => false, 'example' => 'user'],
+ ],
+ [
+ 'name' => 'pageNumber',
+ 'in' => 'query',
+ 'schema' => ['title' => '页码', 'description' => '页码', 'type' => 'integer', 'format' => 'int32', 'required' => false, 'example' => '1'],
+ ],
+ [
+ 'name' => 'pageSize',
+ 'in' => 'query',
+ 'schema' => ['title' => '每页大小', 'description' => '每页大小', 'type' => 'integer', 'format' => 'int32', 'required' => false, 'example' => '10'],
+ ],
+ [
+ 'name' => 'output',
+ 'in' => 'query',
+ 'schema' => ['title' => '返回信息的丰富度', 'description' => '控制返回信息的丰富度'."\n"
+ .'- simple：只显示基本信息'."\n"
+ .'- normal：显示createParameters, cron等信息（默认）'."\n"
+ .'- detail: 返回训练任务信息', 'type' => 'string', 'required' => false, 'example' => 'simple'],
],
],
'responses' => [
200 => [
'schema' => [
- 'title' => 'Schema of Response',
- 'description' => 'Schema of Response',
'type' => 'object',
'properties' => [
- 'requestId' => [
- 'title' => 'Id of the request',
- 'description' => 'Id of the request',
- 'type' => 'string',
- 'example' => '5D56E988-A189-53A4-A0A6-C8D744B59775',
- ],
+ 'code' => ['description' => '错误码', 'type' => 'string', 'example' => 'not found'],
+ 'httpCode' => ['description' => 'http状态码', 'type' => 'integer', 'format' => 'int64', 'example' => '200'],
+ 'latency' => ['description' => '耗时', 'type' => 'integer', 'format' => 'int64', 'example' => '39.108'],
+ 'message' => ['description' => '错误信息', 'type' => 'string', 'example' => '"xx not found"'],
+ 'requestId' => ['description' => '请求ID', 'type' => 'string', 'example' => '33E4F0CA-F766-5803-B11C-70DC57A5A6E4'],
'result' => [
'description' => '返回结果',
- 'type' => 'object',
- 'properties' => [
- 'meta' => [
- 'description' => '元信息',
- 'type' => 'object',
- 'properties' => [
- 'computeResource' => [
- 'description' => '计费规格',
- 'type' => 'string',
- 'example' => 'small',
- ],
- 'taskName' => [
- 'description' => '任务名称',
- 'type' => 'string',
- 'example' => 'test',
- ],
- ],
- ],
- 'parameters' => [
- 'description' => '任务处理参数',
- 'type' => 'object',
- 'example' => '{'."\n"
- .'"parameter1": {'."\n"
- .'"key": "value"'."\n"
- .'},'."\n"
- .'"parameter2": {'."\n"
- .'"key": "value"'."\n"
- .'}'."\n"
- .'}',
- ],
- 'processors' => [
- 'description' => '处理流程算子',
- 'type' => 'array',
- 'items' => [
- 'description' => '处理流程算子',
- 'type' => 'object',
- 'properties' => [
- 'input' => [
- 'description' => '输入参数',
- 'type' => 'object',
- 'example' => '{'."\n"
- .' "key": "content"'."\n"
- .'}'."\n",
- ],
- 'name' => [
- 'description' => '名称',
- 'type' => 'string',
- 'example' => '"processor1"',
- ],
- 'parameters' => [
- 'description' => 'processor处理参数',
- 'type' => 'object',
- 'example' => '{'."\n"
- .' "service_id": "xxx"'."\n"
- .'}',
- ],
- 'type' => [
- 'description' => '类型',
- 'type' => 'string',
- 'example' => 'document-analyze'."\n",
- ],
- ],
- ],
- ],
- 'sink' => [
- 'description' => '数据汇信息',
- 'type' => 'array',
- 'items' => [
- 'description' => '数据汇信息',
+ 'type' => 'array',
+ 'items' => [
+ 'description' => '返回结果',
+ 'type' => 'object',
+ 'properties' => [
+ 'belongs' => [
+ 'description' => '归属信息',
'type' => 'object',
'properties' => [
- 'name' => [
- 'description' => '数据汇名',
- 'type' => 'string',
- 'example' => 'table2',
- ],
- 'parameters' => [
- 'description' => '数据汇配置参数',
- 'type' => 'object',
- 'additionalProperties' => [
- 'type' => 'string',
- 'description' => '数据汇配置参数字段名称',
- 'example' => '{\'region\': \'cn-hangzhou\', \'vpcId\': \'vpc-bp12kyzi7pekju2vplskx\', \'functionName\': \'filemgr-cn-hangzhou-002a94807f\', \'mountPointsServerAddr\': \'002a94807f-xrh81.cn-hangzhou.nas.aliyuncs.com\'}',
- ],
- ],
- 'primaryKey' => [
- 'description' => '数据汇主键字段',
- 'type' => 'string',
- 'example' => 'id',
- ],
- 'schema' => [
- 'description' => '数据汇Schema',
- 'type' => 'array',
- 'items' => [
- 'description' => '数据汇Schema',
- 'type' => 'object',
- 'additionalProperties' => [
- 'type' => 'string',
- 'example' => 'id',
- 'description' => '数据汇Schema字段',
- ],
- ],
- ],
- 'type' => [
- 'description' => '数据汇类型'."\n",
- 'type' => 'string',
- 'example' => 'swift',
- ],
+ 'category' => ['description' => '类别', 'type' => 'string', 'example' => '""'],
+ 'domain' => ['description' => '行业类型', 'type' => 'string', 'example' => '""'],
+ 'language' => ['description' => '语言，取值：'."\n"
+ ."\n"
+ .'- zh_CN：中文（默认值）'."\n"
+ .'- en_US：英文', 'type' => 'string', 'example' => 'zh_CN'],
],
],
- ],
- 'source' => [
- 'description' => '数据源信息',
- 'type' => 'array',
- 'items' => [
- 'description' => '数据源信息',
- 'type' => 'object',
- 'properties' => [
- 'name' => [
- 'description' => '数据源名',
- 'type' => 'string',
- 'example' => 'table1'."\n",
- ],
- 'parameters' => [
- 'description' => '数据源配置参数',
- 'type' => 'object',
- 'additionalProperties' => [
- 'type' => 'string',
- 'example' => 'key1',
- 'description' => '数据源配置参数字段名称',
- ],
- ],
- 'primaryKey' => [
- 'description' => '数据源主键字段',
- 'type' => 'string',
- 'example' => 'id',
- ],
- 'schema' => [
- 'description' => '数据源Schema',
- 'type' => 'array',
- 'items' => [
- 'description' => '数据源Schema',
- 'type' => 'object',
- 'additionalProperties' => [
- 'type' => 'string',
- 'example' => 'tableName',
- 'description' => '数据源Schema字段',
- ],
- ],
- ],
- 'type' => [
- 'description' => '数据源类型',
- 'type' => 'string',
- 'example' => 'swift',
+ 'createParameters' => [
+ 'description' => '创建参数体',
+ 'type' => 'array',
+ 'items' => [
+ 'description' => '创建参数体',
+ 'type' => 'object',
+ 'properties' => [
+ 'name' => ['description' => '参数名称。', 'type' => 'string', 'example' => 'name'],
+ 'value' => ['description' => '参数值。', 'type' => 'string', 'example' => 'value'],
],
],
],
- ],
- 'status' => [
- 'description' => '任务状态',
- 'type' => 'object',
- 'properties' => [
- 'createTime' => [
- 'description' => '任务启动时间',
- 'type' => 'integer',
- 'format' => 'int64',
- 'example' => '1744941600000',
- ],
- 'deleteTime' => [
- 'description' => '任务停止时间',
- 'type' => 'integer',
- 'format' => 'int64',
- 'example' => '1744941600000',
- ],
- 'errorMessage' => [
- 'description' => '错误信息',
- 'type' => 'string',
- 'example' => '""',
- ],
- 'status' => [
- 'description' => '任务状态',
- 'type' => 'string',
- 'example' => 'RUNNING',
- ],
+ 'createTime' => ['description' => '创建时间', 'type' => 'integer', 'format' => 'int64', 'example' => '1713352442039'],
+ 'cron' => ['description' => '定时调度任务Cron。', 'type' => 'string', 'example' => '""'],
+ 'description' => ['description' => '描述', 'type' => 'string', 'example' => '描述'],
+ 'extendInfo' => ['description' => '拓展信息', 'type' => 'string', 'example' => '""'],
+ 'functionName' => ['description' => '配置项', 'type' => 'string', 'example' => 'nl2sql'],
+ 'functionType' => ['description' => '配置类型', 'type' => 'string', 'example' => 'PAAS'],
+ 'instanceName' => ['description' => '配置名称', 'type' => 'string', 'example' => 'a_test'],
+ 'modelType' => ['description' => '模型类型', 'type' => 'string', 'example' => 'ops-query-analyze-001'],
+ 'source' => ['description' => '实例来源'."\n"
+ .'- builtin 系统实例'."\n"
+ .'- user 用户实例 （默认）'."\n"
+ .'- all 全部实例', 'type' => 'string', 'example' => 'all '],
+ 'status' => ['description' => '状态。'."\n"
+ ."\n"
+ .'- available'."\n"
+ .'- unavailable', 'type' => 'string', 'example' => 'available'],
+ 'usageParameters' => [
+ 'description' => 'usageParameters',
+ 'type' => 'array',
+ 'items' => ['description' => 'usageParameters', 'type' => 'object', 'example' => '{}'],
],
+ 'versionId' => ['description' => '版本ID', 'type' => 'integer', 'format' => 'int64', 'example' => '1'],
],
],
],
+ 'status' => ['description' => '请求状态', 'type' => 'string', 'example' => 'OK'],
+ 'totalCount' => ['description' => '总条数。', 'type' => 'integer', 'format' => 'int64', 'example' => '1'],
],
+ 'description' => '',
],
],
],
- 'staticInfo' => [
- 'returnType' => 'synchronous',
+ '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' => '获取服务/模型配置详情列表',
+ '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}'],
+ ],
+ ],
+ ],
],
- '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' => '停止离线任务',
],
- 'StartOfflineTask' => [
- 'summary' => '开启离线任务',
- 'path' => '/openapi/platform/workspaces/{workspaceName}/offline-tasks/{type}/{taskName}/actions/start',
- 'methods' => [
- 'post',
- ],
- 'schemes' => [
- 'https',
- ],
+ 'ListFunctionRestrictions' => [
+ 'summary' => '获取功能的限制项',
+ 'path' => '/openapi/platform/workspaces/{workspaceName}/functions/{functionName}/restrictions/{restrictionName}',
+ 'methods' => ['get'],
+ 'schemes' => ['https'],
'security' => [
[
'AK' => [],
],
],
- 'consumes' => [
- 'application/json',
- ],
- 'produces' => [
- 'application/json',
- ],
- 'operationType' => 'write',
+ 'consumes' => ['application/json'],
+ 'produces' => ['application/json'],
+ 'operationType' => 'read',
'deprecated' => false,
'systemTags' => [
- 'operationType' => 'none',
+ 'operationType' => 'get',
'riskType' => 'none',
'chargeType' => 'free',
- 'abilityTreeNodes' => [
- 'FEATUREopensearch8B42ZS',
- ],
- 'tenantRelevance' => 'tenant',
+ 'abilityTreeNodes' => ['FEATUREopensearchLIKVQB'],
],
'parameters' => [
[
'name' => 'workspaceName',
'in' => 'path',
- 'schema' => [
- 'description' => '工作空间名称',
- 'type' => 'string',
- 'required' => false,
- 'example' => 'myWorkspace',
- ],
+ 'schema' => ['description' => '工作空间名称', 'type' => 'string', 'required' => false, 'example' => 'default'],
],
[
- 'name' => 'type',
+ 'name' => 'functionName',
'in' => 'path',
- 'schema' => [
- 'description' => '类型',
- 'type' => 'string',
- 'required' => false,
- 'example' => 'video',
- ],
+ 'schema' => ['description' => '配置类型'."\n"
+ ."\n"
+ .'- deployment', 'type' => 'string', 'required' => false, 'example' => 'deployment'],
],
[
- 'name' => 'taskName',
+ 'name' => 'restrictionName',
'in' => 'path',
- 'schema' => [
- 'description' => '任务名称',
- 'type' => 'string',
- 'required' => false,
- 'example' => 'taskName',
- ],
+ 'schema' => ['description' => '限制名称'."\n"
+ .'- model: 平台支持的模型名称'."\n"
+ .'- instance_type: 平台支持的资源类型', 'type' => 'string', 'required' => false, 'example' => 'model'],
],
[
- 'name' => 'regionId',
+ 'name' => 'modelType',
'in' => 'query',
- 'schema' => [
- 'title' => '区域标识符',
- 'description' => '区域标识符',
- 'type' => 'string',
- 'required' => false,
- 'example' => 'cn-shanghai',
- ],
+ 'schema' => ['description' => '模型类型', 'type' => 'string', 'required' => false, 'example' => 'native'],
],
[
- 'name' => 'body',
- 'in' => 'body',
- 'style' => 'json',
- 'schema' => [
- 'description' => '请求体。',
- 'type' => 'object',
- 'properties' => [
- 'timestamp' => [
- 'description' => '启动位点',
- 'type' => 'integer',
- 'format' => 'int64',
- 'required' => false,
- 'example' => '1747900639',
- ],
- 'parallelism' => [
- 'description' => '任务并行度',
- 'type' => 'integer',
- 'format' => 'int32',
- 'required' => false,
- 'example' => '4',
- ],
- ],
- 'required' => false,
- 'example' => 'cn-shanghai',
- ],
+ 'name' => 'region',
+ 'in' => 'query',
+ 'schema' => ['description' => '地域ID。', 'type' => 'string', 'required' => false, 'example' => 'cn-hangzhou'],
+ ],
+ [
+ 'name' => 'source',
+ 'in' => 'query',
+ 'schema' => ['description' => '来源', 'type' => 'string', 'required' => false, 'example' => 'user'],
],
],
'responses' => [
@@ -5138,289 +3630,96 @@
'description' => 'Schema of Response',
'type' => 'object',
'properties' => [
- 'requestId' => [
- 'title' => 'Id of the request',
- 'description' => 'Id of the request',
- 'type' => 'string',
- 'example' => '1CC93E65-6734-5060-BEF7-0EB0A4862BCF',
- ],
+ 'status' => ['description' => '请求状态', 'type' => 'string', 'example' => 'OK'],
+ 'requestId' => ['description' => '请求id', 'type' => 'string', 'example' => '2423C841-91C4-5E51-B296-590D367967FC'],
+ 'code' => ['description' => '错误码', 'type' => 'string', 'example' => 'not found'],
+ 'message' => ['description' => '错误信息', 'type' => 'string', 'example' => '"xx not found"'],
+ 'totalCount' => ['description' => '总条数', 'type' => 'integer', 'format' => 'int64', 'example' => '1'],
'result' => [
'description' => '返回结果',
- 'type' => 'object',
- 'properties' => [
- 'meta' => [
- 'description' => '元信息',
- 'type' => 'object',
- 'properties' => [
- 'computeResource' => [
- 'description' => '计费规格',
- 'type' => 'string',
- 'example' => 'small',
- ],
- 'taskName' => [
- 'description' => '任务名称',
- 'type' => 'string',
- 'example' => 'taskName',
- ],
- ],
- ],
- 'parameters' => [
- 'description' => '任务处理参数',
- 'type' => 'object',
- 'example' => '{'."\n"
- .' "parameter1": {'."\n"
- .' "key": "value"'."\n"
- .' },'."\n"
- .' "parameter2": {'."\n"
- .' "key": "value"'."\n"
- .' }'."\n"
- .'}',
- ],
- 'processors' => [
- 'description' => '处理流程算子',
- 'type' => 'array',
- 'items' => [
- 'description' => '处理流程算子',
- 'type' => 'object',
- 'properties' => [
- 'input' => [
- 'description' => '输入参数',
- 'type' => 'object',
- 'example' => '{'."\n"
- .' "key": "content"'."\n"
- .'}',
- ],
- 'name' => [
- 'description' => '数据源名',
- 'type' => 'string',
- 'example' => 'processor1',
- ],
- 'parameters' => [
- 'description' => 'processor处理参数',
- 'type' => 'object',
- 'example' => '{'."\n"
- .' "service_id": "xxx"'."\n"
- .'}',
- ],
- 'type' => [
- 'description' => '数据汇类型',
- 'type' => 'string',
- 'example' => 'document-analyze'."\n",
- ],
- ],
- ],
- ],
- 'sink' => [
- 'description' => '数据汇信息',
- 'type' => 'array',
- 'items' => [
- 'description' => '数据汇信息',
- 'type' => 'object',
- 'properties' => [
- 'name' => [
- 'description' => '任务名称',
- 'type' => 'string',
- 'example' => 'milvus-ali-cn-hangzhou-1',
- ],
- 'parameters' => [
- 'description' => '数据汇配置参数，由type决定',
- 'type' => 'object',
- 'additionalProperties' => [
- 'type' => 'string',
- 'description' => 'key为String类型',
- 'example' => '{'."\n"
- .' "key1": "value1",'."\n"
- .' "key2": "value2"'."\n"
- .'}',
- ],
- ],
- 'primaryKey' => [
- 'description' => '数据汇主键字段',
- 'type' => 'string',
- 'example' => 'id',
- ],
- 'schema' => [
- 'description' => '数据汇Schema',
- 'type' => 'array',
- 'items' => [
- 'description' => '数据源Schema',
- 'type' => 'object',
- 'additionalProperties' => [
- 'type' => 'string',
- 'example' => ' {'."\n"
- .' "name": "id",'."\n"
- .' "type": "string"'."\n"
- .'}'."\n",
- 'description' => 'key为String类型',
- ],
- ],
- ],
- 'type' => [
- 'description' => '类型'."\n"
- .'- standard',
- 'type' => 'string',
- 'example' => 'ModuleRelation',
- ],
- ],
- ],
- ],
- 'source' => [
- 'description' => '来源',
- 'type' => 'array',
- 'items' => [
- 'description' => '来源',
- 'type' => 'object',
- 'properties' => [
- 'name' => [
- 'description' => '数据源名称',
- 'type' => 'string',
- 'example' => 'table1',
- ],
- 'parameters' => [
- 'description' => '数据源配置参数，由type决定',
- 'type' => 'object',
- 'additionalProperties' => [
- 'type' => 'string',
- 'example' => '{'."\n"
- .' "key1": "value1",'."\n"
- .' "key2": "value2"'."\n"
- .'}',
- 'description' => 'key为String类型',
- ],
- ],
- 'primaryKey' => [
- 'description' => '数据源主键字段',
- 'type' => 'string',
- 'example' => 'id',
- ],
- 'schema' => [
- 'description' => '数据源Schema',
- 'type' => 'array',
- 'items' => [
- 'description' => '数据源Schema',
- 'type' => 'object',
- 'additionalProperties' => [
- 'type' => 'string',
- 'example' => ' {'."\n"
- .' "name": "id",'."\n"
- .' "type": "string"'."\n"
- .'}',
- 'description' => 'key为String类型',
- ],
- ],
- ],
- 'type' => [
- 'description' => '数据源类型',
- 'type' => 'string',
- 'example' => 'swift',
- ],
- ],
- ],
- ],
- 'status' => [
- 'description' => '任务状态'."\n"
- .'- PENDING 进行中'."\n"
- .'- SUCCESS 解析成功'."\n"
- .'- FAILED 解析失败',
- 'type' => 'object',
- 'properties' => [
- 'createTime' => [
- 'description' => '任务启动时间',
- 'type' => 'integer',
- 'format' => 'int64',
- 'example' => '1744941600000',
- ],
- 'deleteTime' => [
- 'description' => '任务停止时间',
- 'type' => 'integer',
- 'format' => 'int64',
- 'example' => '1744941600000',
- ],
- 'errorMessage' => [
- 'description' => '错误信息',
- 'type' => 'string',
- 'example' => '""',
- ],
- 'status' => [
- 'description' => '请求状态',
- 'type' => 'string',
- 'example' => 'OK',
- ],
- ],
+ 'type' => 'array',
+ 'items' => [
+ 'description' => '返回结果',
+ 'type' => 'object',
+ 'properties' => [
+ 'name' => ['description' => '规则名称', 'type' => 'string', 'example' => 'test'],
+ 'meta' => ['description' => '元信息', '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"
+ .' }'],
],
],
],
+ 'httpCode' => ['description' => 'http状态码', 'type' => 'integer', 'format' => 'int64', 'example' => '200'],
+ 'latency' => ['description' => '耗时', 'type' => 'number', 'format' => 'double', 'example' => '10.444'],
],
],
],
],
- 'staticInfo' => [
- 'returnType' => 'synchronous',
+ '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' => '获取功能的限制项',
+ 'changeSet' => [],
+ 'ramActions' => [
+ [
+ 'operationType' => 'get',
+ 'ramAction' => [
+ 'action' => 'searchplat:ListFunctionRestrictions',
+ 'authLevel' => 'operate',
+ 'actionConditions' => [],
+ 'resources' => [
+ ['validationType' => 'always', 'product' => 'SearchPlat', 'resourceType' => '全部资源', 'arn' => '*'],
+ ],
+ ],
+ ],
],
- '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' => '开启离线任务',
- 'description' => '## 请求说明'."\n",
],
'ListOfflineTask' => [
'summary' => '获取离线任务信息列表',
'path' => '/openapi/platform/workspaces/{workspaceName}/offline-tasks/{type}',
- 'methods' => [
- 'get',
- ],
- 'schemes' => [
- 'https',
- ],
+ 'methods' => ['get'],
+ 'schemes' => ['https'],
'security' => [
[
'AK' => [],
],
],
- 'consumes' => [
- 'application/json',
- ],
- 'produces' => [
- 'application/json',
- ],
+ 'consumes' => ['application/json'],
+ 'produces' => ['application/json'],
'operationType' => 'read',
'deprecated' => false,
'systemTags' => [
'operationType' => 'none',
'riskType' => 'none',
'chargeType' => 'free',
- 'abilityTreeNodes' => [
- 'FEATUREopensearchJK5SO0',
- ],
+ 'abilityTreeNodes' => ['FEATUREopensearchJK5SO0'],
],
'parameters' => [
[
'name' => 'workspaceName',
'in' => 'path',
- 'schema' => [
- 'description' => '工作空间名称',
- 'type' => 'string',
- 'required' => false,
- 'example' => 'default',
- ],
+ 'schema' => ['description' => '工作空间名称', 'type' => 'string', 'required' => false, 'example' => 'default'],
],
[
'name' => 'type',
'in' => 'path',
- 'schema' => [
- 'description' => '任务类型',
- 'type' => 'string',
- 'required' => false,
- 'example' => 'video',
- ],
+ 'schema' => ['description' => '任务类型', 'type' => 'string', 'required' => false, 'example' => 'video'],
],
[
'name' => 'taskName',
'in' => 'query',
- 'schema' => [
- 'description' => '任务名称',
- 'type' => 'string',
- 'required' => false,
- 'example' => 'syh',
- ],
+ 'schema' => ['description' => '任务名称', 'type' => 'string', 'required' => false, 'example' => 'syh'],
],
[
'name' => 'taskStatus',
@@ -5429,12 +3728,7 @@
'schema' => [
'description' => '任务状态',
'type' => 'array',
- 'items' => [
- 'description' => '任务状态',
- 'type' => 'string',
- 'required' => false,
- 'example' => 'RUNNING',
- ],
+ 'items' => ['description' => '任务状态', 'type' => 'string', 'required' => false, 'example' => 'RUNNING'],
'required' => false,
],
],
@@ -5445,47 +3739,24 @@
'schema' => [
'description' => '任务标签列表',
'type' => 'array',
- 'items' => [
- 'description' => '标签值',
- 'type' => 'string',
- 'required' => false,
- 'example' => 'abc',
- ],
+ 'items' => ['description' => '标签值', 'type' => 'string', 'required' => false, 'example' => 'abc'],
'required' => false,
],
],
[
'name' => 'pageNumber',
'in' => 'query',
- 'schema' => [
- 'description' => '页数，默认为1'."\n",
- 'type' => 'integer',
- 'format' => 'int32',
- 'required' => false,
- 'example' => '0',
- ],
+ 'schema' => ['description' => '页数，默认为1'."\n", 'type' => 'integer', 'format' => 'int32', 'required' => false, 'example' => '0'],
],
[
'name' => 'pageSize',
'in' => 'query',
- 'schema' => [
- 'description' => '分页大小',
- 'type' => 'integer',
- 'format' => 'int32',
- 'required' => false,
- 'example' => '10',
- ],
+ 'schema' => ['description' => '分页大小', 'type' => 'integer', 'format' => 'int32', 'required' => false, 'example' => '10'],
],
[
'name' => 'regionId',
'in' => 'query',
- 'schema' => [
- 'title' => '区域标识符',
- 'description' => '区域标识符',
- 'type' => 'string',
- 'required' => false,
- 'example' => 'cn-shanghai',
- ],
+ 'schema' => ['title' => '区域标识符', 'description' => '区域标识符', 'type' => 'string', 'required' => false, 'example' => 'cn-shanghai'],
],
],
'responses' => [
@@ -5495,17 +3766,8 @@
'description' => 'Schema of Response',
'type' => 'object',
'properties' => [
- 'TotalCount' => [
- 'description' => '记录总条数。',
- 'type' => 'integer',
- 'format' => 'int64',
- 'example' => '7',
- ],
- 'RequestId' => [
- 'description' => '请求ID。',
- 'type' => 'string',
- 'example' => '786CC01F-0F1D-5FB5-8BFF-B0F3DB289772',
- ],
+ 'TotalCount' => ['description' => '记录总条数。', 'type' => 'integer', 'format' => 'int64', 'example' => '7'],
+ 'RequestId' => ['description' => '请求ID。', 'type' => 'string', 'example' => '786CC01F-0F1D-5FB5-8BFF-B0F3DB289772'],
'Result' => [
'description' => '返回结果。',
'type' => 'array',
@@ -5520,27 +3782,11 @@
'Labels' => [
'description' => '标签列表',
'type' => 'array',
- 'items' => [
- 'description' => '标签值。',
- 'type' => 'string',
- 'example' => 'test',
- ],
- ],
- 'RegionId' => [
- 'description' => '任务所在区域id',
- 'type' => 'string',
- 'example' => 'cn-shanghai',
- ],
- 'TaskName' => [
- 'description' => '任务名称',
- 'type' => 'string',
- 'example' => 'jly-fesOffline-172.16.8.133-20912',
- ],
- 'WorkspaceId' => [
- 'description' => '工作空间ID',
- 'type' => 'string',
- 'example' => '2192861158',
+ 'items' => ['description' => '标签值。', 'type' => 'string', 'example' => 'test'],
],
+ 'RegionId' => ['description' => '任务所在区域id', 'type' => 'string', 'example' => 'cn-shanghai'],
+ 'TaskName' => ['description' => '任务名称', 'type' => 'string', 'example' => 'jly-fesOffline-172.16.8.133-20912'],
+ 'WorkspaceId' => ['description' => '工作空间ID', 'type' => 'string', 'example' => '2192861158'],
],
],
'Processors' => [
@@ -5553,46 +3799,26 @@
'Input' => [
'description' => '输入参数',
'type' => 'object',
- 'additionalProperties' => [
- 'type' => 'string',
- 'example' => '{'."\n"
- .' "key": "content"'."\n"
- .'}',
- 'description' => '输入参数',
- ],
- ],
- 'Name' => [
- 'description' => '名称',
- 'type' => 'string',
- 'example' => 'processor1',
+ 'additionalProperties' => ['type' => 'string', 'example' => '{'."\n"
+ .' "key": "content"'."\n"
+ .'}', 'description' => '输入参数'],
],
+ 'Name' => ['description' => '名称', 'type' => 'string', 'example' => 'processor1'],
'Output' => [
'description' => '输出参数',
'type' => 'object',
- 'additionalProperties' => [
- 'type' => 'string',
- 'description' => '输出参数',
- 'example' => '{'."\n"
- .'"vector": "syh_image_uri_multi-modal-embedding"'."\n"
- .'}',
- ],
+ 'additionalProperties' => ['type' => 'string', 'description' => '输出参数', 'example' => '{'."\n"
+ .'"vector": "syh_image_uri_multi-modal-embedding"'."\n"
+ .'}'],
],
'Parameters' => [
'description' => 'processor处理参数',
'type' => 'object',
- 'additionalProperties' => [
- 'type' => 'string',
- 'description' => 'processor处理参数',
- 'example' => '{'."\n"
- .' "service_id": "xxx"'."\n"
- .'}',
- ],
- ],
- 'Type' => [
- 'description' => '类型',
- 'type' => 'string',
- 'example' => 'document-analyze'."\n",
+ 'additionalProperties' => ['type' => 'string', 'description' => 'processor处理参数', 'example' => '{'."\n"
+ .' "service_id": "xxx"'."\n"
+ .'}'],
],
+ 'Type' => ['description' => '类型', 'type' => 'string', 'example' => 'document-analyze'."\n"],
],
],
],
@@ -5603,43 +3829,23 @@
'description' => '数据汇',
'type' => 'object',
'properties' => [
- 'Name' => [
- 'description' => '数据汇名称',
- 'type' => 'string',
- 'example' => 'table2',
- ],
+ 'Name' => ['description' => '数据汇名称', 'type' => 'string', 'example' => 'table2'],
'Parameters' => [
'description' => '数据汇配置参数，由type决定',
'type' => 'object',
- 'additionalProperties' => [
- 'type' => 'string',
- 'description' => '数据汇配置参数名称',
- 'example' => 'instanceId',
- ],
- ],
- 'PrimaryKey' => [
- 'description' => '数据汇主键字段',
- 'type' => 'string',
- 'example' => 'id',
+ 'additionalProperties' => ['type' => 'string', 'description' => '数据汇配置参数名称', 'example' => 'instanceId'],
],
+ 'PrimaryKey' => ['description' => '数据汇主键字段', 'type' => 'string', 'example' => 'id'],
'Schema' => [
'description' => '数据汇Schema',
'type' => 'array',
'items' => [
'description' => '数据汇Schema',
'type' => 'object',
- 'additionalProperties' => [
- 'type' => 'string',
- 'example' => 'name'."\n",
- 'description' => '数据汇Schema字段名称',
- ],
+ 'additionalProperties' => ['type' => 'string', 'example' => 'name'."\n", 'description' => '数据汇Schema字段名称'],
],
],
- 'Type' => [
- 'description' => '数据汇类型',
- 'type' => 'string',
- 'example' => 'swift',
- ],
+ 'Type' => ['description' => '数据汇类型', 'type' => 'string', 'example' => 'swift'],
],
],
],
@@ -5650,43 +3856,23 @@
'description' => '数据源',
'type' => 'object',
'properties' => [
- 'Name' => [
- 'description' => '数据源名称',
- 'type' => 'string',
- 'example' => 'table',
- ],
+ 'Name' => ['description' => '数据源名称', 'type' => 'string', 'example' => 'table'],
'Parameters' => [
'description' => '数据源配置参数',
'type' => 'object',
- 'additionalProperties' => [
- 'type' => 'string',
- 'description' => '数据源配置名称',
- 'example' => 'name',
- ],
- ],
- 'PrimaryKey' => [
- 'description' => '数据源主键字段',
- 'type' => 'string',
- 'example' => 'id',
+ 'additionalProperties' => ['type' => 'string', 'description' => '数据源配置名称', 'example' => 'name'],
],
+ 'PrimaryKey' => ['description' => '数据源主键字段', 'type' => 'string', 'example' => 'id'],
'Schema' => [
'description' => '数据源schema',
'type' => 'array',
'items' => [
'description' => '数据源schema',
'type' => 'object',
- 'additionalProperties' => [
- 'type' => 'string',
- 'example' => 'name',
- 'description' => '数据源schema字段名称',
- ],
+ 'additionalProperties' => ['type' => 'string', 'example' => 'name', 'description' => '数据源schema字段名称'],
],
],
- 'Type' => [
- 'description' => '数据源类型',
- 'type' => 'string',
- 'example' => 'rds',
- ],
+ 'Type' => ['description' => '数据源类型', 'type' => 'string', 'example' => 'rds'],
],
],
],
@@ -5694,35 +3880,17 @@
'description' => '任务状态',
'type' => 'object',
'properties' => [
- 'CreateTime' => [
- 'description' => '创建时间',
- 'type' => 'integer',
- 'format' => 'int64',
- 'example' => '1744941600000',
- ],
+ 'CreateTime' => ['description' => '创建时间', 'type' => 'integer', 'format' => 'int64', 'example' => '1744941600000'],
'MetricData' => [
'description' => '监控信息',
'type' => 'object',
- 'additionalProperties' => [
- 'type' => 'string',
- 'description' => '监控信息字段',
- 'example' => '- CurrentEmitEventTimeLag'."\n"
- .'- CurrentFetchEventTimeLag'."\n"
- .'- NumOfRecordsInFromSource'."\n"
- .'- NumOfRecordsOutToSink',
- ],
- ],
- 'Status' => [
- 'description' => '任务状态',
- 'type' => 'string',
- 'example' => 'RUNNING'."\n",
- ],
- 'UpdateTime' => [
- 'description' => '修改时间',
- 'type' => 'integer',
- 'format' => 'int64',
- 'example' => '1744941600000',
+ 'additionalProperties' => ['type' => 'string', 'description' => '监控信息字段', 'example' => '- CurrentEmitEventTimeLag'."\n"
+ .'- CurrentFetchEventTimeLag'."\n"
+ .'- NumOfRecordsInFromSource'."\n"
+ .'- NumOfRecordsOutToSink'],
],
+ 'Status' => ['description' => '任务状态', 'type' => 'string', 'example' => 'RUNNING'."\n"],
+ 'UpdateTime' => ['description' => '修改时间', 'type' => 'integer', 'format' => 'int64', 'example' => '1744941600000'],
],
],
],
@@ -5732,100 +3900,393 @@
],
],
],
- 'staticInfo' => [
- 'returnType' => 'synchronous',
- ],
+ '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' => '获取离线任务列表',
+ 'changeSet' => [
+ ['createdAt' => '2025-12-02T07:12:30.000Z', 'description' => '请求参数发生变更'],
+ ],
+ 'ramActions' => [
+ [
+ 'operationType' => 'none',
+ 'ramAction' => [
+ 'action' => 'searchplat:ListOfflineTask',
+ 'authLevel' => 'operate',
+ 'actionConditions' => [],
+ 'resources' => [
+ ['validationType' => 'always', 'product' => 'SearchPlat', 'resourceType' => '全部资源', 'arn' => '*'],
+ ],
+ ],
+ ],
+ ],
],
- 'ModifyOfflineTask' => [
- 'summary' => '修改离线任务',
- 'path' => '/openapi/platform/workspaces/{workspaceName}/offline-tasks/{type}/{taskName}',
- 'methods' => [
- 'put',
+ 'ListRagEvaluatorTasks' => [
+ 'summary' => '获取rag版评测任务列表',
+ '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' => '工作空间名称', 'type' => 'string', 'required' => false, 'example' => 'default'],
+ ],
+ [
+ 'name' => 'pageNumber',
+ 'in' => 'query',
+ 'schema' => ['description' => '页数，默认为1'."\n", 'type' => 'string', 'required' => false, 'example' => '1'],
+ ],
+ [
+ 'name' => 'pageSize',
+ 'in' => 'query',
+ 'schema' => ['description' => '分页大小', 'type' => 'string', 'required' => false, 'example' => '10'],
+ ],
+ ],
+ 'responses' => [
+ 200 => [
+ 'schema' => [
+ 'title' => 'Schema of Response',
+ 'description' => 'Schema of Response',
+ 'type' => 'object',
+ 'properties' => [
+ 'requestId' => ['title' => 'Id of the request', 'description' => 'Id of the request', 'type' => 'string', 'example' => '1CC93E65-6734-5060-BEF7-0EB0A4862BCF'],
+ 'code' => ['description' => '错误码'."\n", 'type' => 'string', 'example' => 'not found'],
+ 'message' => ['description' => '错误信息。', 'type' => 'string', 'example' => '"xx not found"'],
+ 'result' => ['description' => '返回结果', 'type' => 'object', 'example' => '{'."\n"
+ .' "odps_task_id": 224525243, '."\n"
+ .' "usage" : {'."\n"
+ .' "cu" : 0.000'."\n"
+ .' }'],
+ 'totalCount' => ['description' => '总条数。', 'type' => 'integer', 'format' => 'int32', 'example' => '1'],
+ ],
+ ],
+ ],
+ ],
+ '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' => '获取rag版评测任务列表',
+ 'changeSet' => [],
+ 'ramActions' => [
+ [
+ 'operationType' => 'get',
+ 'ramAction' => [
+ 'action' => 'searchplat:DescribeEvaluation',
+ 'authLevel' => 'operate',
+ 'actionConditions' => [],
+ 'resources' => [
+ ['validationType' => 'always', 'product' => 'SearchPlat', 'resourceType' => '全部资源', 'arn' => '*'],
+ ],
+ ],
+ ],
+ ],
+ ],
+ 'ListServices' => [
+ 'summary' => '获取服务列表。',
+ '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' => '工作空间名称', 'type' => 'string', 'required' => false, 'example' => 'default'],
+ ],
+ [
+ 'name' => 'modelType',
+ 'in' => 'query',
+ 'schema' => ['description' => '模型类型'."\n"
+ ."\n"
+ .'- system 系统内置模型'."\n"
+ .'- deployment 自定义部署模型', 'type' => 'string', 'required' => false, 'example' => 'system'],
+ ],
+ [
+ 'name' => 'serviceType',
+ 'in' => 'query',
+ 'schema' => ['description' => '服务类型', 'type' => 'string', 'required' => false, 'example' => 'text-embedding'],
+ ],
+ [
+ 'name' => 'serviceId',
+ 'in' => 'query',
+ 'schema' => ['description' => '服务ID', 'type' => 'string', 'required' => false, 'example' => 'ops-text-embedding-001'],
+ ],
+ [
+ 'name' => 'name',
+ 'in' => 'query',
+ 'schema' => ['description' => '服务名称', 'type' => 'string', 'required' => false, 'example' => '文本向量化'],
+ ],
+ ],
+ 'responses' => [
+ 200 => [
+ 'schema' => [
+ 'title' => 'Schema of Response',
+ 'description' => 'Schema of Response',
+ 'type' => 'object',
+ 'properties' => [
+ 'requestId' => ['title' => 'Id of the request', 'description' => 'Id of the request', 'type' => 'string', 'example' => '2423C841-91C4-5E51-B296-590D367967FC'],
+ 'result' => [
+ 'description' => '任务执行结果',
+ 'type' => 'array',
+ 'items' => [
+ 'description' => '任务执行结果',
+ 'type' => 'object',
+ 'properties' => [
+ 'description' => ['description' => '描述', 'type' => 'string', 'example' => '33'],
+ 'meta' => ['description' => '信息体', 'type' => 'object', 'example' => ' {'."\n"
+ .' "maxTokens": 512'."\n"
+ .' }'],
+ 'modelType' => ['description' => '模型类型', 'type' => 'string', 'example' => 'deployment'],
+ 'name' => ['description' => '服务名称', 'type' => 'string', 'example' => '文本向量化'."\n"],
+ 'serviceId' => ['description' => '服务ID。', 'type' => 'string', 'example' => 'ops-text-embedding-001'."\n"],
+ 'serviceType' => ['description' => '服务类型', 'type' => 'string', 'example' => 'text-embedding'],
+ 'chargeWay' => [
+ 'description' => '计费方式',
+ 'type' => 'array',
+ 'items' => ['description' => '计费类型', 'type' => 'string', 'example' => 'token-used'],
+ ],
+ ],
+ ],
+ ],
+ ],
+ ],
+ ],
],
- 'schemes' => [
- 'https',
+ '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' => '获取所有服务列表',
+ 'changeSet' => [],
+ 'ramActions' => [
+ [
+ 'operationType' => 'none',
+ 'ramAction' => [
+ 'action' => 'searchplat:ListServices',
+ 'authLevel' => 'operate',
+ 'actionConditions' => [],
+ 'resources' => [
+ ['validationType' => 'always', 'product' => 'SearchPlat', 'resourceType' => '全部资源', 'arn' => '*'],
+ ],
+ ],
+ ],
],
+ ],
+ 'ListWorkspaces' => [
+ 'summary' => '获取工作空间列表。',
+ 'path' => '/openapi/platform/workspaces',
+ 'methods' => ['get'],
+ 'schemes' => ['http', 'https'],
'security' => [
[
'AK' => [],
],
],
- 'consumes' => [
- 'application/json',
+ 'operationType' => 'read',
+ 'deprecated' => false,
+ 'systemTags' => [
+ 'operationType' => 'list',
+ 'riskType' => 'none',
+ 'chargeType' => 'free',
+ 'abilityTreeCode' => '218194',
+ 'abilityTreeNodes' => ['FEATUREopensearchGVH0IN'],
+ ],
+ 'parameters' => [
+ [
+ 'name' => 'pageNumber',
+ 'in' => 'query',
+ 'schema' => ['description' => '页码，默认 pageNumber=1', 'type' => 'integer', 'format' => 'int32', 'required' => false, 'example' => '1'],
+ ],
+ [
+ 'name' => 'pageSize',
+ 'in' => 'query',
+ 'schema' => ['description' => '分页条数。', 'type' => 'integer', 'format' => 'int32', 'required' => false, 'example' => '10'],
+ ],
+ [
+ 'name' => 'instanceId',
+ 'in' => 'query',
+ 'schema' => ['description' => '实例id', 'type' => 'string', 'required' => false, 'example' => 'ops-cn-jte49bevd04'],
+ ],
+ [
+ 'name' => 'name',
+ 'in' => 'query',
+ 'schema' => ['description' => '工作空间名称', 'type' => 'string', 'required' => false, 'example' => 'default'],
+ ],
+ [
+ 'name' => 'type',
+ 'in' => 'query',
+ 'schema' => ['description' => '类型', 'type' => 'string', 'required' => false, 'example' => 'standard'],
+ ],
+ [
+ 'name' => 'sortBy',
+ 'in' => 'query',
+ 'schema' => ['description' => '排列顺序'."\n"
+ ."\n"
+ .'- 0：按创建时间降序排列'."\n"
+ .'- 1：按修改时间降序排列'."\n"
+ ."\n"
+ .'默认 sortBy=0', 'type' => 'integer', 'format' => 'int32', 'required' => false, 'example' => '1'],
+ ],
+ [
+ 'name' => 'resourceGroupId',
+ 'in' => 'query',
+ 'schema' => ['description' => '资源组ID', 'type' => 'string', 'required' => false, 'example' => 'rg-aekzivjfrlpyn3y'],
+ ],
+ ],
+ 'responses' => [
+ 200 => [
+ 'schema' => [
+ 'title' => 'Schema of Response',
+ 'description' => 'Schema of Response',
+ 'type' => 'object',
+ 'properties' => [
+ 'requestId' => ['title' => 'Id of the request', 'description' => 'Id of the request', 'type' => 'string', 'example' => '33E4F0CA-F766-5803-B11C-70DC57A5A6E4'],
+ 'totalCount' => ['description' => '总条数。', 'type' => 'integer', 'format' => 'int32', 'example' => '1'],
+ 'result' => [
+ 'description' => '返回结果',
+ 'type' => 'array',
+ 'items' => [
+ 'description' => '返回结果',
+ 'type' => 'object',
+ 'properties' => [
+ 'chargeType' => ['description' => '付费类型'."\n"
+ .'- POSTPAY 后付费（按量付费）', 'type' => 'string', 'example' => 'POSTPAY'],
+ 'description' => ['description' => '描述', 'type' => 'string', 'example' => '22222'],
+ 'domainName' => ['description' => '个性域名前缀', 'type' => 'string', 'example' => 'default-xxx'],
+ 'engineType' => ['description' => '引擎类型', 'type' => 'string', 'example' => 'rag'],
+ 'id' => ['description' => '工作空间ID', 'type' => 'string', 'example' => '1222212'],
+ 'instanceId' => ['description' => '实例ID', 'type' => 'string', 'example' => 'ops-cn-em93wcq0s001'],
+ 'name' => ['description' => '工作空间名称', 'type' => 'string', 'example' => 'test'],
+ 'quota' => [
+ 'description' => '配额',
+ 'type' => 'object',
+ 'properties' => [
+ 'computeResource' => ['description' => '计算资源', 'type' => 'integer', 'format' => 'int32', 'example' => '0'],
+ 'docSize' => ['description' => '存储容量', 'type' => 'integer', 'format' => 'int32', 'example' => '0'],
+ 'spec' => ['description' => '规格', 'type' => 'string', 'example' => 'rag.share.compute'],
+ ],
+ ],
+ 'resourceGroupId' => ['description' => '资源组ID', 'type' => 'string', 'example' => 'rg-aekzvlxzgo5b4si'],
+ 'tags' => [
+ 'description' => '标签',
+ 'type' => 'array',
+ 'items' => [
+ 'description' => '标签',
+ 'type' => 'object',
+ 'properties' => [
+ 'tagKey' => ['description' => '标签键', 'type' => 'string', 'example' => 'a'],
+ 'tagValue' => ['description' => '标签值', 'type' => 'string', 'example' => 'c'],
+ ],
+ ],
+ ],
+ 'type' => ['description' => '类型', 'type' => 'string', 'example' => 'standard'],
+ 'apiToken' => ['description' => 'apiToken', 'type' => 'string', 'example' => 'apiToken'],
+ ],
+ ],
+ ],
+ ],
+ ],
+ ],
+ ],
+ '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' => '获取工作空间列表',
+ 'changeSet' => [],
+ 'ramActions' => [
+ [
+ 'operationType' => 'list',
+ 'ramAction' => [
+ 'action' => 'searchplat:ListWorkspaces',
+ 'authLevel' => 'resource',
+ 'actionConditions' => [],
+ 'resources' => [
+ ['validationType' => 'always', 'product' => 'SearchPlat', 'resourceType' => 'Workspace', 'arn' => 'acs:searchplat:{#regionId}:{#accountId}:workspaces/*'],
+ ],
+ ],
+ ],
],
- 'produces' => [
- 'application/json',
+ ],
+ 'ModifyOfflineTask' => [
+ 'summary' => '修改离线任务',
+ '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',
- ],
+ 'abilityTreeNodes' => ['FEATUREopensearch8B42ZS'],
'tenantRelevance' => 'tenant',
],
'parameters' => [
[
'name' => 'workspaceName',
'in' => 'path',
- 'schema' => [
- 'description' => '工作空间名称',
- 'type' => 'string',
- 'required' => false,
- 'example' => 'myWorkspace',
- ],
+ 'schema' => ['description' => '工作空间名称', 'type' => 'string', 'required' => false, 'example' => 'myWorkspace'],
],
[
'name' => 'type',
'in' => 'path',
- 'schema' => [
- 'description' => '任务类型',
- 'type' => 'string',
- 'required' => false,
- 'example' => 'video',
- ],
+ 'schema' => ['description' => '任务类型', 'type' => 'string', 'required' => false, 'example' => 'video'],
],
[
'name' => 'taskName',
'in' => 'path',
- 'schema' => [
- 'description' => '任务名称',
- 'type' => 'string',
- 'required' => false,
- 'example' => 'syh',
- ],
+ 'schema' => ['description' => '任务名称', 'type' => 'string', 'required' => false, 'example' => 'syh'],
],
[
'name' => 'dryRun',
'in' => 'query',
- 'schema' => [
- 'description' => '是否校验入参数据合法性，默认false。'."\n"
- ."\n"
- .'取值：'."\n"
- ."\n"
- .'- **true**'."\n"
- ."\n"
- .'- **false**',
- 'type' => 'boolean',
- 'required' => false,
- 'example' => 'true',
- ],
+ 'schema' => ['description' => '是否校验入参数据合法性，默认false。'."\n"
+ ."\n"
+ .'取值：'."\n"
+ ."\n"
+ .'- **true**'."\n"
+ ."\n"
+ .'- **false**', 'type' => 'boolean', 'required' => false, 'example' => 'true'],
],
[
'name' => 'regionId',
'in' => 'query',
- 'schema' => [
- 'title' => '区域标识符',
- 'description' => '区域标识符',
- 'type' => 'string',
- 'required' => false,
- 'example' => 'cn-shanghai',
- ],
+ 'schema' => ['title' => '区域标识符', 'description' => '区域标识符', 'type' => 'string', 'required' => false, 'example' => 'cn-shanghai'],
],
[
'name' => 'body',
@@ -5839,39 +4300,14 @@
'description' => '任务元数据',
'type' => 'object',
'properties' => [
- 'apiKey' => [
- 'description' => '访问凭证',
- 'type' => 'string',
- 'required' => false,
- 'example' => 'OS-xxx'."\n",
- ],
- 'regionId' => [
- 'description' => '地域ID',
- 'type' => 'string',
- 'required' => false,
- 'example' => 'cn-shanghai',
- ],
- 'taskName' => [
- 'description' => '任务名称',
- 'type' => 'string',
- 'required' => false,
- 'example' => 'syh',
- ],
- 'computeResource' => [
- 'description' => '计费规格',
- 'type' => 'string',
- 'required' => false,
- 'example' => 'small',
- ],
+ 'apiKey' => ['description' => '访问凭证', 'type' => 'string', 'required' => false, 'example' => 'OS-xxx'."\n"],
+ 'regionId' => ['description' => '地域ID', 'type' => 'string', 'required' => false, 'example' => 'cn-shanghai'],
+ 'taskName' => ['description' => '任务名称', 'type' => 'string', 'required' => false, 'example' => 'syh'],
+ 'computeResource' => ['description' => '计费规格', 'type' => 'string', 'required' => false, 'example' => 'small'],
'labels' => [
'description' => '任务标签列表',
'type' => 'array',
- 'items' => [
- 'description' => '标签',
- 'type' => 'string',
- 'required' => false,
- 'example' => 'aa',
- ],
+ 'items' => ['description' => '标签', 'type' => 'string', 'required' => false, 'example' => 'aa'],
'required' => false,
],
],
@@ -5884,25 +4320,13 @@
'description' => '数据源信息',
'type' => 'object',
'properties' => [
- 'name' => [
- 'description' => '数据源名',
- 'type' => 'string',
- 'required' => false,
- 'example' => 'tmp-exec-pop-eTcMpC',
- ],
- 'type' => [
- 'description' => '数据源类型',
- 'type' => 'string',
- 'required' => false,
- 'example' => 'swift',
- ],
+ 'name' => ['description' => '数据源名', 'type' => 'string', 'required' => false, 'example' => 'tmp-exec-pop-eTcMpC'],
+ 'type' => ['description' => '数据源类型', 'type' => 'string', 'required' => false, 'example' => 'swift'],
'parameters' => [
'description' => '数据源配置参数，由type决定',
'type' => 'object',
'required' => false,
- 'additionalProperties' => [
- 'type' => 'string',
- ],
+ 'additionalProperties' => ['type' => 'string', 'description' => ''],
],
'schema' => [
'description' => '数据源Schema',
@@ -5911,18 +4335,11 @@
'description' => '数据源Schema',
'type' => 'object',
'required' => false,
- 'additionalProperties' => [
- 'type' => 'string',
- ],
+ 'additionalProperties' => ['type' => 'string', 'description' => ''],
],
'required' => false,
],
- 'primaryKey' => [
- 'description' => '数据源主键字段',
- 'type' => 'string',
- 'required' => false,
- 'example' => 'id',
- ],
+ 'primaryKey' => ['description' => '数据源主键字段', 'type' => 'string', 'required' => false, 'example' => 'id'],
],
'required' => false,
],
@@ -5935,25 +4352,13 @@
'description' => '数据汇信息',
'type' => 'object',
'properties' => [
- 'name' => [
- 'description' => '数据汇名'."\n",
- 'type' => 'string',
- 'required' => false,
- 'example' => 'default',
- ],
- 'type' => [
- 'description' => '数据汇类型',
- 'type' => 'string',
- 'required' => false,
- 'example' => 'swift',
- ],
+ 'name' => ['description' => '数据汇名'."\n", 'type' => 'string', 'required' => false, 'example' => 'default'],
+ 'type' => ['description' => '数据汇类型', 'type' => 'string', 'required' => false, 'example' => 'swift'],
'parameters' => [
'description' => '数据汇配置参数，由type决定',
'type' => 'object',
'required' => false,
- 'additionalProperties' => [
- 'type' => 'string',
- ],
+ 'additionalProperties' => ['type' => 'string', 'description' => ''],
],
'schema' => [
'description' => '数据汇Schema',
@@ -5962,18 +4367,11 @@
'description' => '数据汇Schema',
'type' => 'object',
'required' => false,
- 'additionalProperties' => [
- 'type' => 'string',
- ],
+ 'additionalProperties' => ['type' => 'string', 'description' => ''],
],
'required' => false,
],
- 'primaryKey' => [
- 'description' => '数据汇主键字段',
- 'type' => 'string',
- 'required' => false,
- 'example' => 'id',
- ],
+ 'primaryKey' => ['description' => '数据汇主键字段', 'type' => 'string', 'required' => false, 'example' => 'id'],
],
'required' => false,
],
@@ -5986,87 +4384,36 @@
'description' => '处理流程算子',
'type' => 'object',
'properties' => [
- 'name' => [
- 'description' => '名称',
- 'type' => 'string',
- 'required' => false,
- 'example' => 'processor1',
- ],
- 'type' => [
- 'description' => '类型',
- 'type' => 'string',
- 'required' => false,
- 'example' => 'document-analyze'."\n",
- ],
- 'input' => [
- 'description' => '输入参数',
- 'type' => 'object',
- 'required' => false,
- ],
- 'parameters' => [
- 'description' => 'processor处理参数',
- 'type' => 'object',
- 'required' => false,
- 'example' => '{'."\n"
- .' "service_id": "xxx"'."\n"
- .'}',
- ],
- 'output' => [
- 'description' => '输出参数',
- 'type' => 'object',
- 'required' => false,
- 'example' => '{'."\n"
- .'"vector": "syh_image_uri_multi-modal-embedding"'."\n"
- .'}',
- ],
+ 'name' => ['description' => '名称', 'type' => 'string', 'required' => false, 'example' => 'processor1'],
+ 'type' => ['description' => '类型', 'type' => 'string', 'required' => false, 'example' => 'document-analyze'."\n"],
+ 'input' => ['description' => '输入参数', 'type' => 'object', 'required' => false],
+ 'parameters' => ['description' => 'processor处理参数', 'type' => 'object', 'required' => false, 'example' => '{'."\n"
+ .' "service_id": "xxx"'."\n"
+ .'}'],
+ 'output' => ['description' => '输出参数', 'type' => 'object', 'required' => false, 'example' => '{'."\n"
+ .'"vector": "syh_image_uri_multi-modal-embedding"'."\n"
+ .'}'],
],
'required' => false,
],
'required' => false,
],
- 'parameters' => [
- 'description' => '任务处理参数',
- 'type' => 'object',
- 'required' => false,
- 'example' => '{'."\n"
- .' "parameter1": {'."\n"
- .' "key": "value"'."\n"
- .' },'."\n"
- .' "parameter2": {'."\n"
- .' "key": "value"'."\n"
- .' }'."\n"
- .'}',
- ],
+ 'parameters' => ['description' => '任务处理参数', 'type' => 'object', 'required' => false, 'example' => '{'."\n"
+ .' "parameter1": {'."\n"
+ .' "key": "value"'."\n"
+ .' },'."\n"
+ .' "parameter2": {'."\n"
+ .' "key": "value"'."\n"
+ .' }'."\n"
+ .'}'],
'status' => [
'description' => '任务状态',
'type' => 'object',
'properties' => [
- 'status' => [
- 'description' => '任务状态',
- 'type' => 'string',
- 'required' => false,
- 'example' => 'RUNNING',
- ],
- 'errorMessage' => [
- 'description' => '错误信息',
- 'type' => 'string',
- 'required' => false,
- 'example' => '“”',
- ],
- 'createTime' => [
- 'description' => '任务启动时间',
- 'type' => 'integer',
- 'format' => 'int64',
- 'required' => false,
- 'example' => '1744941600000',
- ],
- 'deleteTime' => [
- 'description' => '任务停止时间',
- 'type' => 'integer',
- 'format' => 'int64',
- 'required' => false,
- 'example' => '1744941600000',
- ],
+ 'status' => ['description' => '任务状态', 'type' => 'string', 'required' => false, 'example' => 'RUNNING'],
+ 'errorMessage' => ['description' => '错误信息', 'type' => 'string', 'required' => false, 'example' => '“”'],
+ 'createTime' => ['description' => '任务启动时间', 'type' => 'integer', 'format' => 'int64', 'required' => false, 'example' => '1744941600000'],
+ 'deleteTime' => ['description' => '任务停止时间', 'type' => 'integer', 'format' => 'int64', 'required' => false, 'example' => '1744941600000'],
],
'required' => false,
],
@@ -6083,12 +4430,7 @@
'description' => 'Schema of Response',
'type' => 'object',
'properties' => [
- 'requestId' => [
- 'title' => 'Id of the request',
- 'description' => 'Id of the request',
- 'type' => 'string',
- 'example' => '0abb793917165176014887584e28d9',
- ],
+ 'requestId' => ['title' => 'Id of the request', 'description' => 'Id of the request', 'type' => 'string', 'example' => '0abb793917165176014887584e28d9'],
'result' => [
'description' => '返回结果',
'type' => 'object',
@@ -6097,16 +4439,8 @@
'description' => '元信息',
'type' => 'object',
'properties' => [
- 'taskName' => [
- 'description' => '任务名称',
- 'type' => 'string',
- 'example' => 'test',
- ],
- 'computeResource' => [
- 'description' => '计费规格',
- 'type' => 'string',
- 'example' => 'small',
- ],
+ 'taskName' => ['description' => '任务名称', 'type' => 'string', 'example' => 'test'],
+ 'computeResource' => ['description' => '计费规格', 'type' => 'string', 'example' => 'small'],
],
],
'source' => [
@@ -6116,24 +4450,12 @@
'description' => '数据源信息',
'type' => 'object',
'properties' => [
- 'name' => [
- 'description' => '数据源名',
- 'type' => 'string',
- 'example' => 'table1'."\n",
- ],
- 'type' => [
- 'description' => '数据源类型',
- 'type' => 'string',
- 'example' => 'swift',
- ],
+ 'name' => ['description' => '数据源名', 'type' => 'string', 'example' => 'table1'."\n"],
+ 'type' => ['description' => '数据源类型', 'type' => 'string', 'example' => 'swift'],
'parameters' => [
'description' => '数据源配置参数，由type决定',
'type' => 'object',
- 'additionalProperties' => [
- 'type' => 'string',
- 'description' => '数据源配置参数名称',
- 'example' => 'name',
- ],
+ 'additionalProperties' => ['type' => 'string', 'description' => '数据源配置参数名称', 'example' => 'name'],
],
'schema' => [
'description' => '数据源Schema',
@@ -6141,18 +4463,10 @@
'items' => [
'description' => '数据源Schema',
'type' => 'object',
- 'additionalProperties' => [
- 'type' => 'string',
- 'example' => 'name',
- 'description' => '数据源Schema字段名称',
- ],
+ 'additionalProperties' => ['type' => 'string', 'example' => 'name', 'description' => '数据源Schema字段名称'],
],
],
- 'primaryKey' => [
- 'description' => '数据源主键字段',
- 'type' => 'string',
- 'example' => 'id',
- ],
+ 'primaryKey' => ['description' => '数据源主键字段', 'type' => 'string', 'example' => 'id'],
],
],
],
@@ -6163,24 +4477,12 @@
'description' => '数据汇信息',
'type' => 'object',
'properties' => [
- 'name' => [
- 'description' => '数据汇名',
- 'type' => 'string',
- 'example' => 'table2',
- ],
- 'type' => [
- 'description' => '数据汇类型',
- 'type' => 'string',
- 'example' => 'swift',
- ],
+ 'name' => ['description' => '数据汇名', 'type' => 'string', 'example' => 'table2'],
+ 'type' => ['description' => '数据汇类型', 'type' => 'string', 'example' => 'swift'],
'parameters' => [
'description' => '数据汇配置参数，由type决定',
'type' => 'object',
- 'additionalProperties' => [
- 'type' => 'string',
- 'description' => '数据汇配置参数名称',
- 'example' => 'key1',
- ],
+ 'additionalProperties' => ['type' => 'string', 'description' => '数据汇配置参数名称', 'example' => 'key1'],
],
'schema' => [
'description' => '数据汇Schema',
@@ -6188,18 +4490,10 @@
'items' => [
'description' => '数据汇Schema',
'type' => 'object',
- 'additionalProperties' => [
- 'type' => 'string',
- 'description' => '数据汇Schema字段名称',
- 'example' => 'name',
- ],
+ 'additionalProperties' => ['type' => 'string', 'description' => '数据汇Schema字段名称', 'example' => 'name'],
],
],
- 'primaryKey' => [
- 'description' => '数据汇主键字段',
- 'type' => 'string',
- 'example' => 'id',
- ],
+ 'primaryKey' => ['description' => '数据汇主键字段', 'type' => 'string', 'example' => 'id'],
],
],
],
@@ -6210,74 +4504,38 @@
'description' => '处理流程算子',
'type' => 'object',
'properties' => [
- 'name' => [
- 'description' => '名称',
- 'type' => 'string',
- 'example' => 'processor1',
- ],
- 'type' => [
- 'description' => '类型',
- 'type' => 'string',
- 'example' => 'document-analyze'."\n",
- ],
- 'input' => [
- 'description' => '输入参数',
- 'type' => 'object',
- 'example' => '{'."\n"
- .' "key": "content"'."\n"
- .'}'."\n",
- ],
- 'parameters' => [
- 'description' => 'processor处理参数',
- 'type' => 'object',
- 'example' => '{'."\n"
- .'"parameter1": {'."\n"
- .'"key": "value"'."\n"
- .'},'."\n"
- .'"parameter2": {'."\n"
- .'"key": "value"'."\n"
- .'}'."\n"
- .'}',
- ],
+ 'name' => ['description' => '名称', 'type' => 'string', 'example' => 'processor1'],
+ 'type' => ['description' => '类型', 'type' => 'string', 'example' => 'document-analyze'."\n"],
+ 'input' => ['description' => '输入参数', 'type' => 'object', 'example' => '{'."\n"
+ .' "key": "content"'."\n"
+ .'}'."\n"],
+ 'parameters' => ['description' => 'processor处理参数', 'type' => 'object', 'example' => '{'."\n"
+ .'"parameter1": {'."\n"
+ .'"key": "value"'."\n"
+ .'},'."\n"
+ .'"parameter2": {'."\n"
+ .'"key": "value"'."\n"
+ .'}'."\n"
+ .'}'],
],
],
],
- 'parameters' => [
- 'description' => '任务处理参数',
- 'type' => 'object',
- 'example' => '{'."\n"
- .'"parameter1": {'."\n"
- .'"key": "value"'."\n"
- .'},'."\n"
- .'"parameter2": {'."\n"
- .'"key": "value"'."\n"
- .'}'."\n"
- .'}',
- ],
+ 'parameters' => ['description' => '任务处理参数', 'type' => 'object', 'example' => '{'."\n"
+ .'"parameter1": {'."\n"
+ .'"key": "value"'."\n"
+ .'},'."\n"
+ .'"parameter2": {'."\n"
+ .'"key": "value"'."\n"
+ .'}'."\n"
+ .'}'],
'status' => [
'description' => '任务状态',
'type' => 'object',
'properties' => [
- 'status' => [
- 'description' => '任务状态',
- 'type' => 'string',
- 'example' => 'RUNNING',
- ],
- 'createTime' => [
- 'description' => '任务启动时间',
- 'type' => 'string',
- 'example' => '1744941600000',
- ],
- 'deleteTime' => [
- 'description' => '任务停止时间',
- 'type' => 'string',
- 'example' => '1744941600000',
- ],
- 'errorMessage' => [
- 'description' => '错误信息',
- 'type' => 'string',
- 'example' => '""',
- ],
+ 'status' => ['description' => '任务状态', 'type' => 'string', 'example' => 'RUNNING'],
+ 'createTime' => ['description' => '任务启动时间', 'type' => 'string', 'example' => '1744941600000'],
+ 'deleteTime' => ['description' => '任务停止时间', 'type' => 'string', 'example' => '1744941600000'],
+ 'errorMessage' => ['description' => '错误信息', 'type' => 'string', 'example' => '""'],
],
],
],
@@ -6286,345 +4544,153 @@
],
],
],
- 'staticInfo' => [
- 'returnType' => 'synchronous',
- ],
+ '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' => '修改离线任务',
- ],
- 'CreateOfflineTask' => [
- 'summary' => '用于创建视频检索的离线处理任务，支持配置数据源、处理参数及输出目标。',
- 'path' => '/openapi/platform/workspaces/{workspaceName}/offline-tasks/{type}',
- 'methods' => [
- 'post',
- ],
- 'schemes' => [
- 'https',
+ 'changeSet' => [
+ ['createdAt' => '2025-12-02T07:12:30.000Z', 'description' => '请求参数发生变更'],
+ ],
+ 'ramActions' => [
+ [
+ 'operationType' => 'update',
+ 'ramAction' => [
+ 'action' => 'searchplat:ModifyOfflineTask',
+ 'authLevel' => 'operate',
+ 'actionConditions' => [],
+ 'resources' => [
+ ['validationType' => 'always', 'product' => 'SearchPlat', 'resourceType' => '全部资源', 'arn' => '*'],
+ ],
+ ],
+ ],
],
+ ],
+ 'ResumeFunctionInstance' => [
+ 'summary' => 'Restart 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',
- ],
+ 'consumes' => ['application/json'],
+ 'produces' => ['application/json'],
'operationType' => 'write',
'deprecated' => false,
'systemTags' => [
- 'operationType' => 'create',
+ 'operationType' => 'none',
'riskType' => 'none',
'chargeType' => 'free',
- 'abilityTreeNodes' => [
- 'FEATUREopensearch8B42ZS',
- ],
+ 'abilityTreeCode' => '239782',
+ 'abilityTreeNodes' => ['FEATUREopensearchJK5SO0'],
+ 'autoTest' => true,
'tenantRelevance' => 'tenant',
],
'parameters' => [
[
'name' => 'workspaceName',
'in' => 'path',
- 'schema' => [
- 'description' => '工作空间名称',
- 'type' => 'string',
- 'required' => false,
- 'example' => 'default',
- ],
+ 'schema' => ['title' => 'opensearch应用名', 'description' => '工作空间名', 'type' => 'string', 'required' => true, 'example' => 'default'],
],
[
- 'name' => 'type',
+ 'name' => 'functionName',
'in' => 'path',
- 'schema' => [
- 'description' => '任务类型',
- 'type' => 'string',
- 'required' => false,
- 'example' => 'video',
- ],
+ 'schema' => ['title' => '功能名称', 'description' => '服务类型', 'type' => 'string', 'required' => true, 'example' => 'notebook'],
],
[
- 'name' => 'draft',
- 'in' => 'query',
+ 'name' => 'instanceName',
+ 'in' => 'path',
+ 'schema' => ['title' => '实例名称', 'description' => 'notebook名称', 'type' => 'string', 'required' => true, 'example' => 'test_notebook'],
+ ],
+ ],
+ 'responses' => [
+ 200 => [
'schema' => [
- 'description' => '是否为草稿',
- 'type' => 'boolean',
- 'required' => false,
- 'example' => 'false',
+ 'title' => 'Schema of Response',
+ 'description' => 'Schema of Response',
+ 'type' => 'object',
+ 'properties' => [
+ 'status' => ['description' => '请求状态', 'type' => 'string', 'example' => 'OK'],
+ 'httpCode' => ['description' => 'http状态码', 'type' => 'integer', 'format' => 'int64', 'example' => '200'],
+ 'requestId' => ['description' => '请求ID', 'type' => 'string', 'example' => '5950143C-B8F0-5758-A08A-66F302FD587F'],
+ 'message' => ['title' => '错误信息', 'description' => '错误信息', 'type' => 'string', 'example' => '"xx not found"'],
+ 'code' => ['title' => '错误码', 'description' => '错误码', 'type' => 'string', 'example' => 'not found'],
+ 'latency' => ['title' => '耗时', 'description' => '耗时', 'type' => 'integer', 'format' => 'int64', 'example' => '145.411'],
+ ],
],
],
- [
- 'name' => 'dryRun',
- 'in' => 'query',
- 'schema' => [
- 'description' => '校验参数是否正确',
- 'type' => 'boolean',
- 'required' => false,
- 'example' => 'false',
+ ],
+ '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' => '全部资源', 'arn' => '*'],
+ ],
],
],
+ ],
+ ],
+ 'StartOfflineTask' => [
+ 'summary' => '开启离线任务',
+ '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' => '工作空间名称', 'type' => 'string', 'required' => false, 'example' => 'myWorkspace'],
+ ],
+ [
+ 'name' => 'type',
+ 'in' => 'path',
+ 'schema' => ['description' => '类型', 'type' => 'string', 'required' => false, 'example' => 'video'],
+ ],
+ [
+ 'name' => 'taskName',
+ 'in' => 'path',
+ 'schema' => ['description' => '任务名称', 'type' => 'string', 'required' => false, 'example' => 'taskName'],
+ ],
[
'name' => 'regionId',
'in' => 'query',
- 'schema' => [
- 'title' => '区域标识符',
- 'description' => '区域标识符',
- 'type' => 'string',
- 'required' => false,
- 'example' => 'cn-shanghai',
- ],
+ 'schema' => ['title' => '区域标识符', 'description' => '区域标识符', 'type' => 'string', 'required' => false, 'example' => 'cn-shanghai'],
],
[
'name' => 'body',
'in' => 'body',
'style' => 'json',
'schema' => [
- 'description' => '请求体',
+ 'description' => '请求体。',
'type' => 'object',
'properties' => [
- 'meta' => [
- 'description' => '任务元数据',
- 'type' => 'object',
- 'properties' => [
- 'apiKey' => [
- 'description' => '访问凭证',
- 'type' => 'string',
- 'required' => false,
- 'example' => 'OS-xxx',
- ],
- 'regionId' => [
- 'description' => '地域ID',
- 'type' => 'string',
- 'required' => false,
- 'example' => 'cn-shanghai',
- ],
- 'taskName' => [
- 'description' => '任务名称'."\n",
- 'type' => 'string',
- 'required' => false,
- 'example' => 'test',
- ],
- 'computeResource' => [
- 'description' => '计费规格'."\n",
- 'type' => 'string',
- 'required' => false,
- 'example' => 'small',
- ],
- 'labels' => [
- 'description' => '标签列表',
- 'type' => 'array',
- 'items' => [
- 'description' => '列表值',
- 'type' => 'string',
- 'required' => false,
- 'example' => 'name',
- ],
- 'required' => false,
- ],
- ],
- 'required' => false,
- ],
- 'source' => [
- 'description' => '数据源信息',
- 'type' => 'array',
- 'items' => [
- 'description' => '数据源',
- 'type' => 'object',
- 'properties' => [
- 'name' => [
- 'description' => '**数据源名**',
- 'type' => 'string',
- 'required' => false,
- 'example' => 'table1',
- ],
- 'type' => [
- 'description' => '**数据源类型**',
- 'type' => 'string',
- 'required' => false,
- 'example' => 'swift',
- ],
- 'parameters' => [
- 'description' => '**数据源配置参数，由type决定**',
- 'type' => 'object',
- 'required' => false,
- 'additionalProperties' => [
- 'type' => 'string',
- ],
- 'example' => '{'."\n"
- .' "key1": "value1",'."\n"
- .' "key2": "value2"'."\n"
- .'}',
- ],
- 'schema' => [
- 'description' => '**数据源Schema**',
- 'type' => 'array',
- 'items' => [
- 'description' => '数据源schema名称',
- 'type' => 'object',
- 'required' => false,
- 'additionalProperties' => [
- 'type' => 'string',
- ],
- ],
- 'required' => false,
- ],
- 'primaryKey' => [
- 'description' => '数据源主键字段'."\n",
- 'type' => 'string',
- 'required' => false,
- 'example' => 'id',
- ],
- ],
- 'required' => false,
- ],
- 'required' => false,
- ],
- 'sink' => [
- 'description' => '数据汇信息'."\n",
- 'type' => 'array',
- 'items' => [
- 'description' => '数据汇',
- 'type' => 'object',
- 'properties' => [
- 'name' => [
- 'description' => '数据汇名'."\n",
- 'type' => 'string',
- 'required' => false,
- 'example' => 'table2',
- ],
- 'type' => [
- 'description' => '数据汇类型',
- 'type' => 'string',
- 'required' => false,
- 'example' => 'swift',
- ],
- 'parameters' => [
- 'description' => '数据汇配置参数，由type决定'."\n",
- 'type' => 'object',
- 'required' => false,
- 'additionalProperties' => [
- 'type' => 'string',
- ],
- ],
- 'schema' => [
- 'description' => '数据汇Schema'."\n",
- 'type' => 'array',
- 'items' => [
- 'description' => '数据汇Schema',
- 'type' => 'object',
- 'required' => false,
- 'additionalProperties' => [
- 'type' => 'string',
- ],
- ],
- 'required' => false,
- ],
- 'primaryKey' => [
- 'description' => '数据汇主键字段',
- 'type' => 'string',
- 'required' => false,
- 'example' => 'id',
- ],
- ],
- 'required' => false,
- ],
- 'required' => false,
- ],
- 'processors' => [
- 'description' => '处理流程算子',
- 'type' => 'array',
- 'items' => [
- 'description' => '处理流程算子',
- 'type' => 'object',
- 'properties' => [
- 'name' => [
- 'description' => '名称',
- 'type' => 'string',
- 'required' => false,
- 'example' => 'processor1',
- ],
- 'type' => [
- 'description' => '类型',
- 'type' => 'string',
- 'required' => false,
- 'example' => 'document-analyze',
- ],
- 'input' => [
- 'description' => '输入参数',
- 'type' => 'object',
- 'required' => false,
- 'example' => '{'."\n"
- .' "key": "content"'."\n"
- .'}',
- ],
- 'parameters' => [
- 'description' => 'processor处理参数',
- 'type' => 'object',
- 'required' => false,
- 'example' => '{'."\n"
- .' "service_id": "xxx"'."\n"
- .'}',
- ],
- 'output' => [
- 'description' => '输出参数',
- 'type' => 'object',
- 'required' => false,
- 'example' => '{'."\n"
- .'"vector": "syh_image_uri_multi-modal-embedding"'."\n"
- .'}',
- ],
- ],
- 'required' => false,
- ],
- 'required' => false,
- ],
- 'parameters' => [
- 'description' => '任务处理参数',
- 'type' => 'object',
- 'required' => false,
- 'example' => '{'."\n"
- .' "parameter1": {'."\n"
- .' "key": "value"'."\n"
- .' },'."\n"
- .' "parameter2": {'."\n"
- .' "key": "value"'."\n"
- .' }'."\n"
- .'}',
- ],
- 'status' => [
- 'description' => '任务状态',
- 'type' => 'object',
- 'properties' => [
- 'status' => [
- 'description' => '任务状态'."\n",
- 'type' => 'string',
- 'required' => false,
- 'example' => 'RUNNING',
- ],
- 'errorMessage' => [
- 'description' => '错误信息'."\n",
- 'type' => 'string',
- 'required' => false,
- 'example' => '""',
- ],
- 'createTime' => [
- 'description' => '任务启动时间'."\n",
- 'type' => 'integer',
- 'format' => 'int64',
- 'required' => false,
- 'example' => '1744941600000',
- ],
- 'deleteTime' => [
- 'description' => '任务停止时间',
- 'type' => 'integer',
- 'format' => 'int64',
- 'required' => false,
- 'example' => '1744941600000',
- ],
- ],
- 'required' => false,
- ],
+ 'timestamp' => ['description' => '启动位点', 'type' => 'integer', 'format' => 'int64', 'required' => false, 'example' => '1747900639'],
+ 'parallelism' => ['description' => '任务并行度', 'type' => 'integer', 'format' => 'int32', 'required' => false, 'example' => '4'],
],
'required' => false,
'example' => 'cn-shanghai',
@@ -6638,194 +4704,123 @@
'description' => 'Schema of Response',
'type' => 'object',
'properties' => [
- 'requestId' => [
- 'title' => 'Id of the request',
- 'description' => 'Id of the request',
- 'type' => 'string',
- 'example' => 'B7C901ED-2BC1-5CFB-BE23-242DE5E3BA5C',
- ],
+ 'requestId' => ['title' => 'Id of the request', 'description' => 'Id of the request', 'type' => 'string', 'example' => '1CC93E65-6734-5060-BEF7-0EB0A4862BCF'],
'result' => [
'description' => '返回结果',
'type' => 'object',
'properties' => [
'meta' => [
- 'description' => '任务元数据',
+ 'description' => '元信息',
'type' => 'object',
'properties' => [
- 'taskName' => [
- 'description' => '任务名称',
- 'type' => 'string',
- 'example' => 'test',
- ],
- 'computeResource' => [
- 'description' => '计费规格',
- 'type' => 'string',
- 'example' => 'small',
+ 'computeResource' => ['description' => '计费规格', 'type' => 'string', 'example' => 'small'],
+ 'taskName' => ['description' => '任务名称', 'type' => 'string', 'example' => 'taskName'],
+ ],
+ ],
+ 'parameters' => ['description' => '任务处理参数', 'type' => 'object', 'example' => '{'."\n"
+ .' "parameter1": {'."\n"
+ .' "key": "value"'."\n"
+ .' },'."\n"
+ .' "parameter2": {'."\n"
+ .' "key": "value"'."\n"
+ .' }'."\n"
+ .'}'],
+ 'processors' => [
+ 'description' => '处理流程算子',
+ 'type' => 'array',
+ 'items' => [
+ 'description' => '处理流程算子',
+ 'type' => 'object',
+ 'properties' => [
+ 'input' => ['description' => '输入参数', 'type' => 'object', 'example' => '{'."\n"
+ .' "key": "content"'."\n"
+ .'}'],
+ 'name' => ['description' => '数据源名', 'type' => 'string', 'example' => 'processor1'],
+ 'parameters' => ['description' => 'processor处理参数', 'type' => 'object', 'example' => '{'."\n"
+ .' "service_id": "xxx"'."\n"
+ .'}'],
+ 'type' => ['description' => '数据汇类型', 'type' => 'string', 'example' => 'document-analyze'."\n"],
],
],
],
- 'source' => [
- 'description' => '数据源信息'."\n",
+ 'sink' => [
+ 'description' => '数据汇信息',
'type' => 'array',
'items' => [
- 'description' => '数据源信息',
+ 'description' => '数据汇信息',
'type' => 'object',
'properties' => [
- 'name' => [
- 'description' => '数据源名'."\n",
- 'type' => 'string',
- 'example' => 'table1',
- ],
- 'type' => [
- 'description' => '数据源类型'."\n",
- 'type' => 'string',
- 'example' => 'swift',
- ],
+ 'name' => ['description' => '任务名称', 'type' => 'string', 'example' => 'milvus-ali-cn-hangzhou-1'],
'parameters' => [
- 'description' => '数据源配置参数，由type决定'."\n",
+ 'description' => '数据汇配置参数，由type决定',
'type' => 'object',
- 'additionalProperties' => [
- 'type' => 'string',
- 'description' => 'key为String类型',
- 'example' => 'key',
- ],
+ 'additionalProperties' => ['type' => 'string', 'description' => 'key为String类型', 'example' => '{'."\n"
+ .' "key1": "value1",'."\n"
+ .' "key2": "value2"'."\n"
+ .'}'],
],
+ 'primaryKey' => ['description' => '数据汇主键字段', 'type' => 'string', 'example' => 'id'],
'schema' => [
- 'description' => '数据源Schema',
+ 'description' => '数据汇Schema',
'type' => 'array',
'items' => [
- 'description' => 'Schema',
+ 'description' => '数据源Schema',
'type' => 'object',
- 'additionalProperties' => [
- 'type' => 'string',
- 'example' => '""',
- 'description' => 'key为String类型',
- ],
+ 'additionalProperties' => ['type' => 'string', 'example' => ' {'."\n"
+ .' "name": "id",'."\n"
+ .' "type": "string"'."\n"
+ .'}'."\n", 'description' => 'key为String类型'],
],
],
- 'primaryKey' => [
- 'description' => '数据源主键字段',
- 'type' => 'string',
- 'example' => 'id',
- ],
+ 'type' => ['description' => '类型'."\n"
+ .'- standard', 'type' => 'string', 'example' => 'ModuleRelation'],
],
],
],
- 'sink' => [
- 'description' => '输出端信息',
+ 'source' => [
+ 'description' => '来源',
'type' => 'array',
'items' => [
- 'description' => '输出端信息',
+ 'description' => '来源',
'type' => 'object',
'properties' => [
- 'name' => [
- 'description' => '数据汇名'."\n",
- 'type' => 'string',
- 'example' => 'table2',
- ],
- 'type' => [
- 'description' => '数据汇类型'."\n",
- 'type' => 'string',
- 'example' => 'swift',
- ],
+ 'name' => ['description' => '数据源名称', 'type' => 'string', 'example' => 'table1'],
'parameters' => [
- 'description' => '数据汇配置参数，由type决定'."\n",
+ 'description' => '数据源配置参数，由type决定',
'type' => 'object',
- 'additionalProperties' => [
- 'type' => 'string',
- 'description' => 'key为String类型',
- 'example' => 'key1',
- ],
+ 'additionalProperties' => ['type' => 'string', 'example' => '{'."\n"
+ .' "key1": "value1",'."\n"
+ .' "key2": "value2"'."\n"
+ .'}', 'description' => 'key为String类型'],
],
+ 'primaryKey' => ['description' => '数据源主键字段', 'type' => 'string', 'example' => 'id'],
'schema' => [
- 'description' => '数据汇Schema'."\n",
+ 'description' => '数据源Schema',
'type' => 'array',
'items' => [
- 'description' => '数据汇Schema',
+ 'description' => '数据源Schema',
'type' => 'object',
- 'additionalProperties' => [
- 'type' => 'string',
- 'description' => 'key为String类型',
- 'example' => '"name"',
- ],
+ 'additionalProperties' => ['type' => 'string', 'example' => ' {'."\n"
+ .' "name": "id",'."\n"
+ .' "type": "string"'."\n"
+ .'}', 'description' => 'key为String类型'],
],
],
- 'primaryKey' => [
- 'description' => '数据汇主键字段 ',
- 'type' => 'string',
- 'example' => 'id',
- ],
- ],
- ],
- ],
- 'processors' => [
- 'description' => '处理流程算子',
- 'type' => 'array',
- 'items' => [
- 'description' => '处理流程算子',
- 'type' => 'object',
- 'properties' => [
- 'name' => [
- 'description' => '名称',
- 'type' => 'string',
- 'example' => '"processor1"',
- ],
- 'type' => [
- 'description' => '类型',
- 'type' => 'string',
- 'example' => '"document-analyze"',
- ],
- 'input' => [
- 'description' => '输入参数',
- 'type' => 'object',
- ],
- 'parameters' => [
- 'description' => 'processor处理参数',
- 'type' => 'object',
- 'example' => '{'."\n"
- .'"service_id": "xxx"'."\n"
- .'}',
- ],
+ 'type' => ['description' => '数据源类型', 'type' => 'string', 'example' => 'swift'],
],
],
],
- 'parameters' => [
- 'description' => '任务处理参数',
- 'type' => 'object',
- 'example' => '{'."\n"
- .'"parameter1": {'."\n"
- .'"key": "value"'."\n"
- .'},'."\n"
- .'"parameter2": {'."\n"
- .'"key": "value"'."\n"
- .'}'."\n"
- .'}',
- ],
'status' => [
- 'description' => '任务状态',
+ 'description' => '任务状态'."\n"
+ .'- PENDING 进行中'."\n"
+ .'- SUCCESS 解析成功'."\n"
+ .'- FAILED 解析失败',
'type' => 'object',
'properties' => [
- 'status' => [
- 'description' => '任务状态',
- 'type' => 'string',
- 'example' => 'RUNNING',
- ],
- 'createTime' => [
- 'description' => '任务启动时间'."\n"
- ."\n",
- 'type' => 'string',
- 'example' => '1744941600000',
- ],
- 'deleteTime' => [
- 'description' => '任务停止时间'."\n",
- 'type' => 'string',
- 'example' => '1744941600000',
- ],
- 'errorMessage' => [
- 'description' => '错误信息',
- 'type' => 'string',
- 'example' => '""',
- ],
+ 'createTime' => ['description' => '任务启动时间', 'type' => 'integer', 'format' => 'int64', 'example' => '1744941600000'],
+ 'deleteTime' => ['description' => '任务停止时间', 'type' => 'integer', 'format' => 'int64', 'example' => '1744941600000'],
+ 'errorMessage' => ['description' => '错误信息', 'type' => 'string', 'example' => '""'],
+ 'status' => ['description' => '请求状态', 'type' => 'string', 'example' => 'OK'],
],
],
],
@@ -6834,82 +4829,80 @@
],
],
],
- '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' => '创建离线任务',
+ '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' => '开启离线任务',
'description' => '## 请求说明'."\n",
- ],
- 'GetOfflineTask' => [
- 'summary' => '获取离线任务信息',
- 'path' => '/openapi/platform/workspaces/{workspaceName}/offline-tasks/{type}/{taskName}',
- 'methods' => [
- 'get',
- ],
- 'schemes' => [
- 'https',
+ 'changeSet' => [
+ ['createdAt' => '2025-12-02T07:12:30.000Z', 'description' => '请求参数发生变更'],
+ ],
+ 'ramActions' => [
+ [
+ 'operationType' => 'none',
+ 'ramAction' => [
+ 'action' => 'searchplat:StartOfflineTask',
+ 'authLevel' => 'operate',
+ 'actionConditions' => [],
+ 'resources' => [
+ ['validationType' => 'always', 'product' => 'SearchPlat', 'resourceType' => '全部资源', 'arn' => '*'],
+ ],
+ ],
+ ],
],
+ ],
+ 'StopOfflineTask' => [
+ 'summary' => '停止离线任务',
+ 'path' => '/openapi/platform/workspaces/{workspaceName}/offline-tasks/{type}/{taskName}/actions/stop',
+ 'methods' => ['post'],
+ 'schemes' => ['https'],
'security' => [
[
'AK' => [],
],
],
- 'consumes' => [
- 'application/json',
- ],
- 'produces' => [
- 'application/json',
- ],
- 'operationType' => 'read',
+ 'consumes' => ['application/json'],
+ 'produces' => ['application/json'],
+ 'operationType' => 'write',
'deprecated' => false,
'systemTags' => [
- 'operationType' => 'get',
+ 'operationType' => 'none',
'riskType' => 'none',
'chargeType' => 'free',
- 'abilityTreeNodes' => [
- 'FEATUREopensearch8B42ZS',
- ],
+ 'abilityTreeNodes' => ['FEATUREopensearch8B42ZS'],
'tenantRelevance' => 'tenant',
],
'parameters' => [
[
'name' => 'workspaceName',
'in' => 'path',
- 'schema' => [
- 'description' => '工作空间名称',
- 'type' => 'string',
- 'required' => false,
- 'example' => 'default',
- ],
+ 'schema' => ['description' => '工作空间名称', 'type' => 'string', 'required' => false, 'example' => 'default'],
],
[
'name' => 'type',
'in' => 'path',
- 'schema' => [
- 'description' => '类型',
- 'type' => 'string',
- 'required' => false,
- 'example' => 'video',
- ],
+ 'schema' => ['description' => '任务类型', 'type' => 'string', 'required' => false, 'example' => 'video'],
],
[
'name' => 'taskName',
'in' => 'path',
- 'schema' => [
- 'description' => '任务名称',
- 'type' => 'string',
- 'required' => false,
- 'example' => 'taskName',
- ],
+ 'schema' => ['description' => '任务名称', 'type' => 'string', 'required' => false, 'example' => 'taskName'."\n"],
],
[
'name' => 'regionId',
'in' => 'query',
+ 'schema' => ['title' => '区域标识符', 'description' => '区域标识符', 'type' => 'string', 'required' => false, 'example' => 'cn-shanghai'],
+ ],
+ [
+ 'name' => 'body',
+ 'in' => 'body',
+ 'style' => 'json',
'schema' => [
- 'title' => '区域标识符',
- 'description' => '区域标识符',
- 'type' => 'string',
+ 'description' => '请求体',
+ 'type' => 'object',
+ 'properties' => [
+ 'timestamp' => ['description' => '启动位点', 'type' => 'integer', 'format' => 'int64', 'required' => false, 'example' => '1747900639'],
+ 'parallelism' => ['description' => '任务并行度', 'type' => 'integer', 'format' => 'int32', 'required' => false, 'example' => '2'],
+ ],
'required' => false,
'example' => 'cn-shanghai',
],
@@ -6922,44 +4915,27 @@
'description' => 'Schema of Response',
'type' => 'object',
'properties' => [
- 'requestId' => [
- 'title' => 'Id of the request',
- 'description' => 'Id of the request',
- 'type' => 'string',
- 'example' => '5950143C-B8F0-5758-A08A-66F302FD587F',
- ],
+ 'requestId' => ['title' => 'Id of the request', 'description' => 'Id of the request', 'type' => 'string', 'example' => '5D56E988-A189-53A4-A0A6-C8D744B59775'],
'result' => [
'description' => '返回结果',
'type' => 'object',
'properties' => [
'meta' => [
- 'description' => '任务元数据',
+ 'description' => '元信息',
'type' => 'object',
'properties' => [
- 'computeResource' => [
- 'description' => '计费规格',
- 'type' => 'string',
- 'example' => 'small',
- ],
- 'taskName' => [
- 'description' => '任务名称',
- 'type' => 'string',
- 'example' => 'test',
- ],
- ],
- ],
- 'parameters' => [
- 'description' => '任务处理参数',
- 'type' => 'object',
- 'example' => '{'."\n"
- .' "parameter1": {'."\n"
- .' "key": "value"'."\n"
- .' },'."\n"
- .' "parameter2": {'."\n"
- .' "key": "value"'."\n"
- .' }'."\n"
- .'}',
- ],
+ 'computeResource' => ['description' => '计费规格', 'type' => 'string', 'example' => 'small'],
+ 'taskName' => ['description' => '任务名称', 'type' => 'string', 'example' => 'test'],
+ ],
+ ],
+ 'parameters' => ['description' => '任务处理参数', 'type' => 'object', 'example' => '{'."\n"
+ .'"parameter1": {'."\n"
+ .'"key": "value"'."\n"
+ .'},'."\n"
+ .'"parameter2": {'."\n"
+ .'"key": "value"'."\n"
+ .'}'."\n"
+ .'}'],
'processors' => [
'description' => '处理流程算子',
'type' => 'array',
@@ -6967,30 +4943,14 @@
'description' => '处理流程算子',
'type' => 'object',
'properties' => [
- 'input' => [
- 'description' => '输入参数',
- 'type' => 'object',
- 'example' => '{'."\n"
- .' "key": "content"'."\n"
- .'}'."\n",
- ],
- 'name' => [
- 'description' => '名称',
- 'type' => 'string',
- 'example' => 'processor1',
- ],
- 'parameters' => [
- 'description' => 'processor处理参数',
- 'type' => 'object',
- 'example' => '{'."\n"
- .' "service_id": "xxx"'."\n"
- .'}',
- ],
- 'type' => [
- 'description' => '类型',
- 'type' => 'string',
- 'example' => 'document-analyze'."\n",
- ],
+ 'input' => ['description' => '输入参数', 'type' => 'object', 'example' => '{'."\n"
+ .' "key": "content"'."\n"
+ .'}'."\n"],
+ 'name' => ['description' => '名称', 'type' => 'string', 'example' => '"processor1"'],
+ 'parameters' => ['description' => 'processor处理参数', 'type' => 'object', 'example' => '{'."\n"
+ .' "service_id": "xxx"'."\n"
+ .'}'],
+ 'type' => ['description' => '类型', 'type' => 'string', 'example' => 'document-analyze'."\n"],
],
],
],
@@ -7001,50 +4961,23 @@
'description' => '数据汇信息',
'type' => 'object',
'properties' => [
- 'name' => [
- 'description' => '数据汇名',
- 'type' => 'string',
- 'example' => 'table2',
- ],
+ 'name' => ['description' => '数据汇名', 'type' => 'string', 'example' => 'table2'],
'parameters' => [
- 'description' => '数据汇配置参数，由type决定',
+ 'description' => '数据汇配置参数',
'type' => 'object',
- 'additionalProperties' => [
- 'type' => 'string',
- 'description' => 'key为String类型',
- 'example' => '{'."\n"
- .' "key1": "value1",'."\n"
- .' "key2": "value2"'."\n"
- .'}',
- ],
- ],
- 'primaryKey' => [
- 'description' => '数据汇主键字段',
- 'type' => 'string',
- 'example' => 'id',
+ 'additionalProperties' => ['type' => 'string', 'description' => '数据汇配置参数字段名称', 'example' => '{\'region\': \'cn-hangzhou\', \'vpcId\': \'vpc-bp12kyzi7pekju2vplskx\', \'functionName\': \'filemgr-cn-hangzhou-002a94807f\', \'mountPointsServerAddr\': \'002a94807f-xrh81.cn-hangzhou.nas.aliyuncs.com\'}'],
],
+ 'primaryKey' => ['description' => '数据汇主键字段', 'type' => 'string', 'example' => 'id'],
'schema' => [
'description' => '数据汇Schema',
'type' => 'array',
'items' => [
- 'description' => 'Schema',
+ 'description' => '数据汇Schema',
'type' => 'object',
- 'additionalProperties' => [
- 'type' => 'string',
- 'example' => '{'."\n"
- .' "name": "id",'."\n"
- .' "type": "string",'."\n"
- .' "source": "table1.id"'."\n"
- .'}'."\n",
- 'description' => 'key为String类型',
- ],
+ 'additionalProperties' => ['type' => 'string', 'example' => 'id', 'description' => '数据汇Schema字段'],
],
],
- 'type' => [
- 'description' => '数据汇类型',
- 'type' => 'string',
- 'example' => 'swift',
- ],
+ 'type' => ['description' => '数据汇类型'."\n", 'type' => 'string', 'example' => 'swift'],
],
],
],
@@ -7052,50 +4985,26 @@
'description' => '数据源信息',
'type' => 'array',
'items' => [
+ 'description' => '数据源信息',
'type' => 'object',
'properties' => [
- 'name' => [
- 'description' => '数据源名',
- 'type' => 'string',
- 'example' => 'table1'."\n",
- ],
+ 'name' => ['description' => '数据源名', 'type' => 'string', 'example' => 'table1'."\n"],
'parameters' => [
- 'description' => '数据源配置参数，由type决定',
+ 'description' => '数据源配置参数',
'type' => 'object',
- 'additionalProperties' => [
- 'type' => 'string',
- 'example' => '{'."\n"
- .' "key1": "value1",'."\n"
- .' "key2": "value2"'."\n"
- .'}',
- 'description' => 'key为String类型',
- ],
- ],
- 'primaryKey' => [
- 'description' => '数据源主键字段',
- 'type' => 'string',
- 'example' => 'id',
+ 'additionalProperties' => ['type' => 'string', 'example' => 'key1', 'description' => '数据源配置参数字段名称'],
],
+ 'primaryKey' => ['description' => '数据源主键字段', 'type' => 'string', 'example' => 'id'],
'schema' => [
'description' => '数据源Schema',
'type' => 'array',
'items' => [
+ 'description' => '数据源Schema',
'type' => 'object',
- 'additionalProperties' => [
- 'type' => 'string',
- 'example' => ' {'."\n"
- .' "name": "id",'."\n"
- .' "type": "string"'."\n"
- .'}',
- 'description' => 'key为String类型',
- ],
+ 'additionalProperties' => ['type' => 'string', 'example' => 'tableName', 'description' => '数据源Schema字段'],
],
],
- 'type' => [
- 'description' => '数据源类型',
- 'type' => 'string',
- 'example' => 'swift',
- ],
+ 'type' => ['description' => '数据源类型', 'type' => 'string', 'example' => 'swift'],
],
],
],
@@ -7103,28 +5012,10 @@
'description' => '任务状态',
'type' => 'object',
'properties' => [
- 'createTime' => [
- 'description' => '任务启动时间',
- 'type' => 'integer',
- 'format' => 'int64',
- 'example' => '1744941600000',
- ],
- 'deleteTime' => [
- 'description' => '任务停止时间',
- 'type' => 'integer',
- 'format' => 'int64',
- 'example' => '1744941600000',
- ],
- 'errorMessage' => [
- 'description' => '错误信息',
- 'type' => 'string',
- 'example' => '“”',
- ],
- 'status' => [
- 'description' => '任务状态',
- 'type' => 'string',
- 'example' => 'RUNNING',
- ],
+ 'createTime' => ['description' => '任务启动时间', 'type' => 'integer', 'format' => 'int64', 'example' => '1744941600000'],
+ 'deleteTime' => ['description' => '任务停止时间', 'type' => 'integer', 'format' => 'int64', 'example' => '1744941600000'],
+ 'errorMessage' => ['description' => '错误信息', 'type' => 'string', 'example' => '""'],
+ 'status' => ['description' => '任务状态', 'type' => 'string', 'example' => 'RUNNING'],
],
],
],
@@ -7133,191 +5024,73 @@
],
],
],
- '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' => '获取离线任务信息',
- ],
- 'DeleteOfflineTask' => [
- 'summary' => '删除离线任务',
- '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' => '工作空间名称',
- 'type' => 'string',
- 'required' => false,
- 'example' => 'default',
- ],
- ],
- [
- 'name' => 'type',
- 'in' => 'path',
- 'schema' => [
- 'description' => '类型',
- 'type' => 'string',
- 'required' => false,
- 'example' => 'video',
- ],
- ],
- [
- 'name' => 'taskName',
- 'in' => 'path',
- 'schema' => [
- 'description' => '任务名称',
- 'type' => 'string',
- 'required' => false,
- 'example' => 'taskName',
- ],
- ],
- [
- 'name' => 'regionId',
- 'in' => 'query',
- 'schema' => [
- 'title' => '区域标识符',
- 'description' => '区域标识符',
- 'type' => 'string',
- 'required' => false,
- 'example' => 'cn-shanghai',
- ],
- ],
- ],
- 'responses' => [
- 200 => [
- 'schema' => [
- 'title' => 'Schema of Response',
- 'description' => 'Schema of Response',
- 'type' => 'object',
- 'properties' => [
- 'requestId' => [
- 'title' => 'Id of the request',
- 'description' => 'Id of the request',
- 'type' => 'string',
- 'example' => '2423C841-91C4-5E51-B296-590D367967FC',
- ],
- 'result' => [
- 'description' => '返回结果',
- 'type' => 'boolean',
- 'example' => 'true',
- ],
+ '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' => '停止离线任务',
+ 'changeSet' => [
+ ['createdAt' => '2025-12-02T07:12:30.000Z', 'description' => '请求参数发生变更'],
+ ],
+ 'ramActions' => [
+ [
+ 'operationType' => 'none',
+ 'ramAction' => [
+ 'action' => 'searchplat:StopOfflineTask',
+ 'authLevel' => 'operate',
+ 'actionConditions' => [],
+ 'resources' => [
+ ['validationType' => 'always', 'product' => 'SearchPlat', 'resourceType' => '全部资源', 'arn' => '*'],
],
],
],
],
- 'staticInfo' => [
- 'returnType' => 'synchronous',
- ],
- 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"requestId\\": \\"2423C841-91C4-5E51-B296-590D367967FC\\",\\n \\"result\\": true\\n}","type":"json"}]',
- 'title' => '删除离线任务',
],
'UpdateCapability' => [
'summary' => '用于更新指定工作空间中的特定配置项。',
'path' => '/openapi/platform/workspaces/{workspaceName}/capabilities/{itemCategory}/items/{itemName}',
- 'methods' => [
- 'put',
- ],
- 'schemes' => [
- 'https',
- ],
+ 'methods' => ['put'],
+ 'schemes' => ['https'],
'security' => [
[
'AK' => [],
],
],
- 'consumes' => [
- 'application/json',
- ],
- 'produces' => [
- 'application/json',
- ],
+ 'consumes' => ['application/json'],
+ 'produces' => ['application/json'],
'operationType' => 'read',
'deprecated' => false,
'systemTags' => [
'operationType' => 'update',
'riskType' => 'none',
'chargeType' => 'free',
- 'abilityTreeNodes' => [
- 'FEATUREopensearch8B42ZS',
- ],
+ 'abilityTreeNodes' => ['FEATUREopensearch8B42ZS'],
'tenantRelevance' => 'tenant',
],
'parameters' => [
[
'name' => 'workspaceName',
'in' => 'path',
- 'schema' => [
- 'description' => '工作空间名称'."\n",
- 'type' => 'string',
- 'required' => true,
- 'example' => 'default',
- ],
+ 'schema' => ['description' => '工作空间名称'."\n", 'type' => 'string', 'required' => true, 'example' => 'default'],
],
[
'name' => 'itemCategory',
'in' => 'path',
- 'schema' => [
- 'description' => '配置类别',
- 'type' => 'string',
- 'required' => true,
- 'example' => 'ai_search_agent',
- ],
+ 'schema' => ['description' => '配置类别', 'type' => 'string', 'required' => true, 'example' => 'ai_search_agent'],
],
[
'name' => 'itemName',
'in' => 'path',
- 'schema' => [
- 'description' => '配置名称',
- 'type' => 'string',
- 'required' => true,
- 'example' => 'es_knowledge_base',
- ],
+ 'schema' => ['description' => '配置名称', 'type' => 'string', 'required' => true, 'example' => 'es_knowledge_base'],
],
[
'name' => 'dryRun',
'in' => 'query',
- 'schema' => [
- 'description' => '是否校验入参数据合法性，默认false。'."\n"
- ."\n"
- .'取值：'."\n"
- ."\n"
- .'- **true**'."\n"
- ."\n"
- .'- **false**',
- 'type' => 'boolean',
- 'required' => false,
- 'example' => 'true',
- ],
+ 'schema' => ['description' => '是否校验入参数据合法性，默认false。'."\n"
+ ."\n"
+ .'取值：'."\n"
+ ."\n"
+ .'- **true**'."\n"
+ ."\n"
+ .'- **false**', 'type' => 'boolean', 'required' => false, 'example' => 'true'],
],
[
'name' => 'body',
@@ -7327,56 +5100,46 @@
'description' => '请求Body。',
'type' => 'object',
'properties' => [
- 'itemDesc' => [
- 'description' => '配置描述',
- 'type' => 'string',
- 'required' => false,
- 'example' => '描述',
- ],
- 'itemValue' => [
- 'description' => '配置项',
- '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"
- .' }',
- ],
+ 'itemDesc' => ['description' => '配置描述', 'type' => 'string', 'required' => false, 'example' => '描述'],
+ 'itemValue' => ['description' => '配置项', '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"
+ .' }'],
],
'required' => false,
],
@@ -7389,127 +5152,81 @@
'description' => 'Schema of Response',
'type' => 'object',
'properties' => [
- 'requestId' => [
- 'title' => 'Id of the request',
- 'description' => 'Id of the request',
- 'type' => 'string',
- 'example' => '5950143C-B8F0-5758-A08A-66F302FD587F',
- ],
- 'httpCode' => [
- 'description' => 'HTTP状态码。',
- 'type' => 'integer',
- 'format' => 'int64',
- 'example' => '200',
- ],
- 'status' => [
- 'description' => '请求状态',
- 'type' => 'string',
- 'example' => 'OK',
- ],
+ 'requestId' => ['title' => 'Id of the request', 'description' => 'Id of the request', 'type' => 'string', 'example' => '5950143C-B8F0-5758-A08A-66F302FD587F'],
+ 'httpCode' => ['description' => 'HTTP状态码。', 'type' => 'integer', 'format' => 'int64', 'example' => '200'],
+ 'status' => ['description' => '请求状态', 'type' => 'string', 'example' => 'OK'],
],
],
],
],
- 'staticInfo' => [
- 'returnType' => 'synchronous',
- ],
+ 'staticInfo' => ['returnType' => 'synchronous'],
'responseDemo' => '[{"errorExample":"","example":"{\\n \\"requestId\\": \\"5950143C-B8F0-5758-A08A-66F302FD587F\\",\\n \\"httpCode\\": 200,\\n \\"status\\": \\"OK\\"\\n}","type":"json"}]',
'title' => '更新配置',
'description' => '## 请求说明'."\n"
.'本API允许用户更新指定工作空间（`workspaceName`）内某一类别（`itemCategory`）下的具体配置项（`itemName`）。通过设置`dryRun`参数，可以预览更改而不实际应用。请求体中可包含新的配置描述(`itemDesc`)和配置内容(`itemValue`)。请注意，`itemValue`的结构需符合目标配置项的要求。'."\n",
- ],
- 'ListCapabilities' => [
- 'summary' => '查询指定工作空间下的特定类别配置项列表。',
- 'path' => '/openapi/platform/workspaces/{workspaceName}/capabilities/{itemCategory}/items',
- 'methods' => [
- 'get',
- ],
- 'schemes' => [
- 'https',
+ 'changeSet' => [],
+ 'ramActions' => [
+ [
+ 'operationType' => 'update',
+ 'ramAction' => [
+ 'action' => 'searchplat:UpdateCapability',
+ 'authLevel' => 'operate',
+ 'actionConditions' => [],
+ 'resources' => [
+ ['validationType' => 'always', 'product' => 'SearchPlat', 'resourceType' => '全部资源', 'arn' => '*'],
+ ],
+ ],
+ ],
],
+ ],
+ 'UpdateCredentials' => [
+ 'path' => '/openapi/platform/workspaces/{workspaceName}/credentials/{token}',
+ 'methods' => ['put'],
+ 'schemes' => ['http', 'https'],
'security' => [
[
'AK' => [],
],
],
- 'consumes' => [
- 'application/json',
- ],
- 'produces' => [
- 'application/json',
- ],
- 'operationType' => 'read',
+ 'operationType' => 'readAndWrite',
'deprecated' => false,
'systemTags' => [
- 'operationType' => 'list',
- 'riskType' => 'none',
- 'chargeType' => 'free',
- 'abilityTreeNodes' => [
- 'FEATUREopensearch8B42ZS',
- ],
- 'tenantRelevance' => 'tenant',
+ 'operationType' => 'none',
+ 'abilityTreeCode' => '220526',
+ 'abilityTreeNodes' => ['FEATUREopensearch1AJKH0'],
],
'parameters' => [
[
- 'name' => 'workspaceName',
- 'in' => 'path',
- 'schema' => [
- 'description' => '工作空间名称'."\n",
- 'type' => 'string',
- 'required' => true,
- 'example' => 'default',
- ],
- ],
- [
- 'name' => 'itemCategory',
+ 'name' => 'token',
'in' => 'path',
- 'schema' => [
- 'description' => '配置类别',
- 'type' => 'string',
- 'required' => true,
- 'example' => 'ai_search_agent',
- ],
+ 'schema' => ['description' => '访问凭证token。', 'type' => 'string', 'required' => true, 'example' => 'OS-****'],
],
[
- 'name' => 'pageNumber',
- 'in' => 'query',
- 'schema' => [
- 'description' => '页码',
- 'type' => 'string',
- 'required' => false,
- 'example' => '1',
- ],
- ],
- [
- 'name' => 'pageSize',
+ 'name' => 'dryRun',
'in' => 'query',
- 'schema' => [
- 'description' => '分页size',
- 'type' => 'string',
- 'required' => false,
- 'example' => '10',
- ],
+ 'schema' => ['description' => '是否为空运行请求', 'type' => 'boolean', 'required' => false, 'example' => 'true'],
],
[
- 'name' => 'nextToken',
- 'in' => 'query',
+ 'name' => 'body',
+ 'in' => 'body',
+ 'style' => 'json',
'schema' => [
- 'description' => '分页Token',
- 'type' => 'string',
+ 'description' => '请求Body。',
+ 'type' => 'object',
+ 'properties' => [
+ 'enabled' => ['description' => '凭据是否启用。'."\n"
+ .'取值：'."\n"
+ ."\n"
+ .'- true：启用。 '."\n"
+ .'- false：禁用。', 'type' => 'boolean', 'required' => false],
+ ],
'required' => false,
- 'example' => 'tMEiGtggHs0=',
],
],
[
- 'name' => 'maxResults',
- 'in' => 'query',
- 'schema' => [
- 'description' => '分页查询时每页行数',
- 'type' => 'integer',
- 'format' => 'int32',
- 'required' => false,
- 'example' => '10',
- ],
+ 'name' => 'workspaceName',
+ 'in' => 'path',
+ 'schema' => ['description' => '工作空间名称。', 'type' => 'string', 'required' => true, 'example' => 'myWorkspace'],
],
],
'responses' => [
@@ -7519,310 +5236,108 @@
'description' => 'Schema of Response',
'type' => 'object',
'properties' => [
- 'requestId' => [
- 'title' => 'Id of the request',
- 'description' => 'Id of the request',
- 'type' => 'string',
- 'example' => '5950143C-B8F0-5758-A08A-66F302FD587F',
- ],
- 'status' => [
- 'description' => '请求状态',
- 'type' => 'string',
- 'example' => 'OK',
- ],
- 'httpCode' => [
- 'description' => 'http状态码',
- 'type' => 'integer',
- 'format' => 'int64',
- 'example' => '200',
- ],
- 'totalCount' => [
- 'description' => '总条数。',
- 'type' => 'integer',
- 'format' => 'int64',
- 'example' => '4',
- ],
+ 'requestId' => ['title' => 'Id of the request', 'description' => 'Id of the request', 'type' => 'string', 'example' => '1CC93E65-6734-5060-BEF7-0EB0A4862BCF'],
'result' => [
- 'description' => '返回结果',
- 'type' => 'array',
- 'items' => [
- 'description' => '返回结果',
- 'type' => 'object',
- 'properties' => [
- 'created' => [
- 'description' => '创建时间'."\n",
- 'type' => 'integer',
- 'format' => 'int64',
- 'example' => '1729665694',
- ],
- 'isDefault' => [
- 'description' => '是否为默认配置'."\n",
- 'type' => 'boolean',
- 'example' => 'false',
- ],
- 'itemCategory' => [
- 'description' => '配置类别'."\n",
- 'type' => 'string',
- 'example' => 'ai_search_agent',
- ],
- 'itemDesc' => [
- 'description' => '配置描述'."\n",
- 'type' => 'string',
- 'example' => '描述'."\n"
- ."\n",
- ],
- 'itemName' => [
- 'description' => '配置名称'."\n",
- 'type' => 'string',
- 'example' => 'es_knowledge_base',
- ],
- 'itemValue' => [
- 'description' => 'itemValue'."\n",
- 'type' => 'object',
- ],
- 'status' => [
- 'description' => 'status'."\n",
- 'type' => 'string',
- 'example' => 'available',
- ],
- 'updated' => [
- 'description' => 'updated'."\n",
- 'type' => 'integer',
- 'format' => 'int64',
- 'example' => '1729665694',
- ],
- ],
+ 'description' => '返回结果。',
+ 'type' => 'object',
+ 'properties' => [
+ 'token' => ['description' => '访问凭证token。', 'type' => 'string', 'example' => 'OS-****'],
+ 'appGroupId' => ['description' => '工作空间ID。', 'type' => 'integer', 'format' => 'int64', 'example' => '12321321'],
+ 'type' => ['description' => '凭证类型。可传类型有：'."\n"
+ .'- api-token', 'type' => 'string', 'example' => 'api-token'],
+ 'enabled' => ['description' => '凭据是否启用。'."\n"
+ .'取值：'."\n"
+ ."\n"
+ .'- true：启用。 '."\n"
+ .'- false：禁用。', 'type' => 'boolean', 'example' => 'false'],
],
],
- 'nextToken' => [
- 'description' => '下一个查询开始Token',
- 'type' => 'string',
- 'example' => 'G5FG/nXfNOQ=',
- ],
- 'maxResults' => [
- 'description' => '结果返回个数',
- 'type' => 'integer',
- 'format' => 'int32',
- 'example' => '1000',
- ],
],
],
],
],
- 'staticInfo' => [
- 'returnType' => 'synchronous',
+ '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' => '更新访问凭证',
+ 'summary' => '修改访问凭证',
+ '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}'],
+ ],
+ ],
+ ],
],
- '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' => '获取配置列表',
- 'description' => '## 请求说明'."\n"
- .'通过此 API，您可以根据提供的工作空间名称和配置类别来获取相应的配置项列表。支持分页查询，可以通过 `pageNumber` 和 `pageSize` 参数控制返回结果的数量及页码。此外，还提供了 `nextToken` 和 `maxResults` 参数用于处理大量数据时的分页逻辑。'."\n",
],
- 'DescribeCapability' => [
- 'summary' => '查询指定工作空间内特定类别的配置项详情。',
- 'path' => '/openapi/platform/workspaces/{workspaceName}/capabilities/{itemCategory}/items/{itemName}',
- 'methods' => [
- 'get',
- ],
- 'schemes' => [
- 'https',
- ],
+ 'UpdateFunctionInstance' => [
+ 'summary' => '更新服务配置',
+ 'path' => '/openapi/platform/workspaces/{workspaceName}/functions/{functionName}/instances/{instanceName}',
+ 'methods' => ['put'],
+ 'schemes' => ['https'],
'security' => [
[
'AK' => [],
],
],
- 'consumes' => [
- 'application/json',
- ],
- 'produces' => [
- 'application/json',
- ],
- 'operationType' => 'read',
'deprecated' => false,
'systemTags' => [
- 'operationType' => 'get',
+ 'operationType' => 'none',
'riskType' => 'none',
'chargeType' => 'free',
- 'abilityTreeNodes' => [
- 'FEATUREopensearch8B42ZS',
- ],
- 'tenantRelevance' => 'tenant',
+ 'abilityTreeCode' => '239782',
+ 'abilityTreeNodes' => ['FEATUREopensearchJK5SO0'],
+ 'autoTest' => true,
+ 'tenantRelevance' => 'publicInformation',
],
'parameters' => [
[
'name' => 'workspaceName',
'in' => 'path',
- 'schema' => [
- 'description' => '**工作空间名称**'."\n",
- 'type' => 'string',
- 'required' => true,
- 'example' => 'default',
- ],
+ 'schema' => ['title' => 'opensearch应用名', 'description' => '工作空间名称', 'type' => 'string', 'required' => true, 'example' => 'default'],
],
[
- 'name' => 'itemCategory',
+ 'name' => 'functionName',
'in' => 'path',
- 'schema' => [
- 'description' => '**配置类别ai_search_agent**'."\n",
- 'type' => 'string',
- 'required' => true,
- 'example' => 'ai_search_agent',
- ],
+ 'schema' => ['title' => '功能名称', 'description' => '功能名称', 'type' => 'string', 'required' => true, 'example' => 'deployment'],
],
[
- 'name' => 'itemName',
+ 'name' => 'instanceName',
'in' => 'path',
- 'schema' => [
- 'description' => '**配置名称**'."\n",
- 'type' => 'string',
- 'required' => true,
- 'example' => 'es_knowledge_base',
- ],
+ 'schema' => ['title' => '实例名称', 'description' => '实例名称', 'type' => 'string', 'required' => true, 'example' => 'test'],
],
- ],
- 'responses' => [
- 200 => [
+ [
+ 'name' => 'Body',
+ 'in' => 'body',
+ 'style' => 'json',
'schema' => [
- 'title' => 'Schema of Response',
- 'description' => 'Schema of Response',
+ 'title' => 'body参数',
+ 'description' => 'body参数',
'type' => 'object',
'properties' => [
- 'requestId' => [
- 'description' => '请求ID',
- 'type' => 'string',
- 'example' => '0E3D5E2B-B63A-4445-B359-329CC07255EA',
- ],
- 'status' => [
- 'description' => '请求状态',
- 'type' => 'string',
- 'example' => 'OK',
- ],
- 'httpCode' => [
- 'description' => 'HTTP状态码'."\n",
- 'type' => 'integer',
- 'format' => 'int64',
- 'example' => '200',
- ],
- 'result' => [
- 'description' => '返回结果',
- 'type' => 'object',
- 'properties' => [
- 'created' => [
- 'description' => '创建时间的时间戳'."\n",
- 'type' => 'integer',
- 'format' => 'int64',
- 'example' => '1745893195510',
- ],
- 'isDefault' => [
- 'description' => '是否为默认配置'."\n",
- 'type' => 'boolean',
- 'example' => 'false',
- ],
- 'itemCategory' => [
- 'description' => '配置类别'."\n",
- 'type' => 'string',
- 'example' => 'ai_search_agent',
- ],
- 'itemDesc' => [
- 'description' => '配置描述'."\n",
- 'type' => 'string',
- 'example' => '描述'."\n"
- ."\n",
- ],
- 'itemName' => [
- 'description' => '配置名称'."\n",
- 'type' => 'string',
- 'example' => 'es_knowledge_base',
- ],
- 'itemValue' => [
- 'description' => '包含endpoint、function等信息的对象，具体描述了知识库的详细配置。'."\n",
- 'type' => 'object',
- ],
- 'status' => [
- 'description' => '状态'."\n",
- 'type' => 'string',
- 'example' => 'available',
- ],
- 'updated' => [
- 'description' => '更新时间戳'."\n",
- 'type' => 'integer',
- 'format' => 'int64',
- 'example' => '1729665694',
+ 'createParameters' => [
+ 'title' => '创建参数',
+ 'description' => '创建参数',
+ 'type' => 'array',
+ 'items' => [
+ 'description' => '参数体',
+ 'type' => 'object',
+ 'properties' => [
+ 'name' => ['title' => '参数名称', 'description' => '参数名称', 'type' => 'string', 'required' => false, 'example' => 'name'],
+ 'value' => ['title' => '参数值', 'description' => '参数值', 'type' => 'string', 'required' => false, 'example' => 'value'],
],
+ 'required' => false,
],
+ 'required' => false,
],
+ 'description' => ['title' => '实例描述', 'description' => '描述', 'type' => 'string', 'required' => false, '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' => '获取配置详情',
- 'description' => '## 请求说明'."\n"
- .'本接口用于根据提供的工作空间名称、配置类别以及配置名称来获取具体的配置信息。请确保请求路径中的参数准确无误，特别是`workspaceName`、`itemCategory`和`itemName`这三个必填字段。此外，请注意`itemCategory`当前仅支持`ai_search_agent`这一类别。'."\n",
- ],
- 'DeleteCapability' => [
- 'summary' => '用于从指定工作空间中删除特定类别的配置项。',
- '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' => '**工作空间名称**'."\n",
- 'type' => 'string',
- 'required' => true,
- 'example' => 'default',
- ],
- ],
- [
- 'name' => 'itemCategory',
- 'in' => 'path',
- 'schema' => [
- 'description' => '**配置类别ai_search_agent**'."\n",
- 'type' => 'string',
- 'required' => true,
- 'example' => 'ai_search_agent',
- ],
- ],
- [
- 'name' => 'itemName',
- 'in' => 'path',
- 'schema' => [
- 'description' => '**配置名称**'."\n",
- 'type' => 'string',
- 'required' => true,
- 'example' => 'es_knowledge_base',
+ 'required' => false,
],
],
],
@@ -7833,169 +5348,69 @@
'description' => 'Schema of Response',
'type' => 'object',
'properties' => [
- 'requestId' => [
- 'title' => 'Id of the request',
- 'description' => '请求ID'."\n",
- 'type' => 'string',
- 'example' => '7CC54C38-D721-4C55-A410-2A94B5A6BE0F',
- ],
- 'httpCode' => [
- 'description' => '**HTTP状态码**'."\n",
- 'type' => 'integer',
- 'format' => 'int64',
- 'example' => '200',
- ],
- 'status' => [
- 'description' => '**状态**'."\n",
- 'type' => 'string',
- 'example' => 'OK',
- ],
+ 'status' => ['description' => '请求状态', 'type' => 'string', 'example' => 'OK'],
+ 'httpCode' => ['description' => 'http状态码', 'type' => 'integer', 'format' => 'int64', 'example' => '200'],
+ 'requestId' => ['description' => '请求ID', 'type' => 'string', 'example' => '5950143C-B8F0-5758-A08A-66F302FD587F'],
+ 'message' => ['title' => '错误信息', 'description' => '错误信息', 'type' => 'string', 'example' => '"xx not found"'],
+ 'code' => ['title' => '错误码', 'description' => '错误码', 'type' => 'string', 'example' => 'not found'],
+ 'latency' => ['title' => '耗时', 'description' => '耗时', 'type' => 'integer', 'format' => 'int64', 'example' => '34.946'],
],
],
],
],
- 'staticInfo' => [
- 'returnType' => 'synchronous',
+ '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' => '更改服务/模型配置',
+ '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}'],
+ ],
+ ],
+ ],
],
- 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"requestId\\": \\"7CC54C38-D721-4C55-A410-2A94B5A6BE0F\\",\\n \\"httpCode\\": 200,\\n \\"status\\": \\"OK\\"\\n}","type":"json"}]',
- 'title' => '删除配置项',
- 'description' => '## 请求说明'."\n"
- .'该 API 允许用户通过指定的工作空间名称、配置类别以及配置名称来删除一个具体的配置项。请确保在调用此接口前，您已经获得了足够的权限（如RAM Policy中的`DeleteCapability`动作）。此外，请注意，一旦某个配置被删除，与之相关的所有数据和服务可能也会受到影响。'."\n",
],
- 'CreateCapability' => [
- 'summary' => '创建知识库相关配置',
- 'path' => '/openapi/platform/workspaces/{workspaceName}/capabilities/{itemCategory}/items',
- 'methods' => [
- 'post',
- ],
- 'schemes' => [
- 'https',
- ],
+ 'UpdateWorkspace' => [
+ 'summary' => '更新工作空间。',
+ 'path' => '/openapi/platform/workspaces/{workspaceName}',
+ 'methods' => ['put'],
+ 'schemes' => ['http', 'https'],
'security' => [
[
'AK' => [],
],
],
- 'consumes' => [
- 'application/json',
- ],
- 'produces' => [
- 'application/json',
- ],
'operationType' => 'write',
'deprecated' => false,
'systemTags' => [
- 'operationType' => 'create',
+ 'operationType' => 'none',
'riskType' => 'none',
'chargeType' => 'free',
- 'abilityTreeNodes' => [
- 'FEATUREopensearch8B42ZS',
- ],
- 'tenantRelevance' => 'tenant',
+ 'abilityTreeCode' => '218191',
+ 'abilityTreeNodes' => ['FEATUREopensearch8B42ZS'],
],
'parameters' => [
[
'name' => 'workspaceName',
'in' => 'path',
- 'schema' => [
- 'description' => '工作空间名称',
- 'type' => 'string',
- 'required' => true,
- 'example' => 'default',
- ],
- ],
- [
- 'name' => 'itemCategory',
- 'in' => 'path',
- 'schema' => [
- 'description' => '配置类别'."\n"
- ."\n"
- .'- ai_search_agent',
- 'type' => 'string',
- 'required' => true,
- 'example' => 'ai_search_agent',
- ],
- ],
- [
- 'name' => 'dryRun',
- 'in' => 'query',
- 'schema' => [
- 'description' => '是否校验入参数据合法性，默认false。'."\n"
- ."\n"
- .'取值：'."\n"
- ."\n"
- .'- **true**'."\n"
- ."\n"
- .'- **false**',
- 'type' => 'boolean',
- 'required' => false,
- 'example' => 'false',
- ],
+ 'schema' => ['description' => '工作空间名称', 'type' => 'string', 'required' => true, 'example' => 'default'],
],
[
'name' => 'body',
'in' => 'body',
'style' => 'json',
'schema' => [
- 'description' => '请求体',
+ 'description' => '请求结构体。',
'type' => 'object',
'properties' => [
- 'itemName' => [
- 'description' => '配置名称',
- 'type' => 'string',
- 'required' => false,
- 'example' => 'es_knowledge_base',
- ],
- 'itemDesc' => [
- 'description' => '配置描述',
- 'type' => 'string',
- 'required' => false,
- 'example' => '描述',
- ],
- 'itemValue' => [
- 'description' => '配置项',
- '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"
- .' }',
- ],
+ 'description' => ['description' => '描述', 'type' => 'string', 'required' => false, 'example' => 'test2024106271022'],
+ 'resourceGroupId' => ['description' => '资源组ID', 'type' => 'string', 'required' => false, 'example' => 'rg-aekzivjfrlpyn3y'],
],
'required' => false,
],
@@ -8008,684 +5423,706 @@
'description' => 'Schema of Response',
'type' => 'object',
'properties' => [
- 'requestId' => [
- 'title' => 'Id of the request',
- 'description' => 'Id of the request',
- 'type' => 'string',
- 'example' => '1CC93E65-6734-5060-BEF7-0EB0A4862BCF',
- ],
- 'httpCode' => [
- 'description' => 'HTTP状态码。',
- 'type' => 'integer',
- 'format' => 'int64',
- 'example' => '200',
- ],
- 'status' => [
- 'description' => '请求状态',
- 'type' => 'string',
- 'example' => 'OK',
+ 'requestId' => ['title' => 'Id of the request', 'description' => 'Id of the request', 'type' => 'string', 'example' => 'B7C901ED-2BC1-5CFB-BE23-242DE5E3BA5C'],
+ 'result' => [
+ 'description' => '返回结果。',
+ 'type' => 'object',
+ 'properties' => [
+ 'chargeType' => ['description' => '付费类型'."\n"
+ .'- POSTPAY 后付费（按量付费）', 'type' => 'string', 'example' => 'POSTPAY'],
+ 'description' => ['description' => '描述', 'type' => 'string', 'example' => '描述'],
+ 'engineType' => ['description' => '引擎类型', 'type' => 'string', 'example' => 'rag'],
+ 'id' => ['description' => '工作空间ID', 'type' => 'string', 'example' => '1222212'],
+ 'instanceId' => ['description' => '实例ID', 'type' => 'string', 'example' => 'ops-cn-em93wcq0s001'],
+ 'name' => ['description' => '工作空间名称', 'type' => 'string', 'example' => 'default'],
+ 'produced' => ['description' => '是否生产完成'."\n"
+ .'- 0：生产中'."\n"
+ .'- 1：生产完成', 'type' => 'integer', 'format' => 'int32', 'example' => '1'],
+ 'quota' => [
+ 'description' => '配额',
+ 'type' => 'object',
+ 'properties' => [
+ 'computeResource' => ['description' => '计算资源', 'type' => 'integer', 'format' => 'int32', 'example' => '0'],
+ 'docSize' => ['description' => '存储容量', 'type' => 'integer', 'format' => 'int32', 'example' => '0'],
+ 'spec' => ['description' => '规格', 'type' => 'string', 'example' => 'rag.share.common'],
+ ],
+ ],
+ 'resourceGroupId' => ['description' => '资源组ID', 'type' => 'string', 'example' => 'rg-aeky6pyhbh6j3dy'],
+ 'tags' => [
+ 'description' => '标签',
+ 'type' => 'array',
+ 'items' => [
+ 'description' => '标签',
+ 'type' => 'object',
+ 'properties' => [
+ 'tagKey' => ['description' => '标签键', 'type' => 'string', 'example' => 'a'],
+ 'tagValue' => ['description' => '标签值', 'type' => 'string', 'example' => 'v'],
+ ],
+ ],
+ ],
+ 'type' => ['description' => '类型', 'type' => 'string', 'example' => 'standard'],
+ 'domainName' => ['description' => '个性域名前缀', 'type' => 'string', 'example' => 'default-xxx'],
+ ],
],
],
],
],
],
- 'staticInfo' => [
- 'returnType' => 'synchronous',
+ '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' => '修改工作空间',
+ '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}'],
+ ],
+ ],
+ ],
],
- 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"requestId\\": \\"1CC93E65-6734-5060-BEF7-0EB0A4862BCF\\",\\n \\"httpCode\\": 200,\\n \\"status\\": \\"OK\\"\\n}","type":"json"}]',
- 'title' => '创建配置',
],
- 'GetTableFields' => [
- 'path' => '/openapi/platform/workspaces/{workspaceName}/data-sources/{dataSourceType}/fields',
- 'methods' => [
- 'get',
- ],
- 'schemes' => [
- 'https',
+ ],
+ 'endpoints' => [
+ ['regionId' => 'cn-shanghai', 'regionName' => '华东2（上海）', 'areaId' => 'asiaPacific', 'areaName' => '亚太', 'public' => 'searchplat.cn-shanghai.aliyuncs.com', 'endpoint' => 'searchplat.cn-shanghai.aliyuncs.com', 'vpc' => ''],
+ ['regionId' => 'eu-central-1', 'regionName' => '德国（法兰克福）', 'areaId' => 'europeAmerica', 'areaName' => '欧洲与美洲', 'public' => 'searchplat.eu-central-1.aliyuncs.com', 'endpoint' => 'searchplat.eu-central-1.aliyuncs.com', 'vpc' => ''],
+ ],
+ 'errorCodes' => [],
+ 'changeSet' => [
+ [
+ 'apis' => [
+ ['description' => '请求参数发生变更', 'api' => 'CreateOfflineTask'],
+ ['description' => '请求参数发生变更', 'api' => 'DeleteOfflineTask'],
+ ['description' => '请求参数发生变更', 'api' => 'GetOfflineTask'],
+ ['description' => '请求参数发生变更', 'api' => 'GetTableColumns'],
+ ['description' => '请求参数发生变更', 'api' => 'GetTables'],
+ ['description' => '请求参数发生变更', 'api' => 'ListOfflineTask'],
+ ['description' => '请求参数发生变更', 'api' => 'ModifyOfflineTask'],
+ ['description' => '请求参数发生变更', 'api' => 'StartOfflineTask'],
+ ['description' => '请求参数发生变更', 'api' => 'StopOfflineTask'],
+ ],
+ 'createdAt' => '2025-12-02T07:12:42.000Z',
+ 'description' => '',
+ ],
+ ],
+ 'ram' => [
+ 'productCode' => 'SearchPlat',
+ 'productName' => '智能开放搜索 OpenSearch',
+ 'ramCodes' => ['searchplat'],
+ 'ramLevel' => '资源级',
+ '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}'],
+ ],
+ ],
],
- 'security' => [
- [
- 'AK' => [],
+ [
+ '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}'],
+ ],
],
],
- 'operationType' => 'read',
- 'deprecated' => false,
- 'systemTags' => [
+ [
+ 'apiName' => 'GetTableColumns',
+ 'description' => '获取数据表字段信息',
'operationType' => 'get',
- 'abilityTreeCode' => '241066',
- 'abilityTreeNodes' => [
- 'FEATUREopensearchJK5SO0',
+ 'ramAction' => [
+ 'action' => 'searchplat:GetTableColumns',
+ 'authLevel' => 'operate',
+ 'actionConditions' => [],
+ 'resources' => [
+ ['validationType' => 'always', 'product' => 'SearchPlat', 'resourceType' => '全部资源', 'arn' => '*'],
+ ],
],
- 'autoTest' => false,
- 'notSupportAutoTestReason' => '无法关联资源',
- 'tenantRelevance' => 'publicInformation',
],
- 'parameters' => [
- [
- 'name' => 'workspaceName',
- 'in' => 'path',
- 'schema' => [
- 'description' => '工作空间名称',
- 'type' => 'string',
- 'required' => true,
- 'example' => 'default',
+ [
+ 'apiName' => 'ListCapabilities',
+ 'description' => '获取配置列表',
+ 'operationType' => 'list',
+ 'ramAction' => [
+ 'action' => 'searchplat:ListCapabilities',
+ 'authLevel' => 'operate',
+ 'actionConditions' => [],
+ 'resources' => [
+ ['validationType' => 'always', 'product' => 'SearchPlat', 'resourceType' => '全部资源', 'arn' => '*'],
],
],
- [
- 'name' => 'dataSourceType',
- 'in' => 'path',
- 'schema' => [
- 'description' => '数据源类型'."\n"
- .'- odps',
- 'type' => 'string',
- 'required' => true,
- 'docRequired' => true,
- 'example' => 'odps',
+ ],
+ [
+ 'apiName' => 'GetOfflineTask',
+ 'description' => '获取离线任务信息',
+ 'operationType' => 'get',
+ 'ramAction' => [
+ 'action' => 'searchplat:GetOfflineTask',
+ 'authLevel' => 'operate',
+ 'actionConditions' => [],
+ 'resources' => [
+ ['validationType' => 'always', 'product' => 'SearchPlat', 'resourceType' => '全部资源', 'arn' => '*'],
],
],
- [
- 'name' => 'params',
- 'in' => 'query',
- 'schema' => [
- 'description' => '数据源参数',
- '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"
- .'}',
+ ],
+ [
+ 'apiName' => 'ModifyOfflineTask',
+ 'description' => '修改离线任务',
+ 'operationType' => 'update',
+ 'ramAction' => [
+ 'action' => 'searchplat:ModifyOfflineTask',
+ 'authLevel' => 'operate',
+ 'actionConditions' => [],
+ 'resources' => [
+ ['validationType' => 'always', 'product' => 'SearchPlat', 'resourceType' => '全部资源', 'arn' => '*'],
],
],
- [
- 'name' => 'rawType',
- 'in' => 'query',
- 'schema' => [
- 'description' => '是否返回数据源原始字段类型',
- 'type' => 'boolean',
- 'required' => false,
- 'example' => 'false',
+ ],
+ [
+ '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}'],
],
],
- [
- 'name' => 'regionId',
- 'in' => 'query',
- 'schema' => [
- 'description' => '地域ID',
- 'type' => 'string',
- 'required' => false,
- 'example' => 'cn-shanghai',
+ ],
+ [
+ 'apiName' => 'ListFunctionRestrictions',
+ 'description' => '获取功能的限制项',
+ 'operationType' => 'get',
+ 'ramAction' => [
+ 'action' => 'searchplat:ListFunctionRestrictions',
+ 'authLevel' => 'operate',
+ 'actionConditions' => [],
+ 'resources' => [
+ ['validationType' => 'always', 'product' => 'SearchPlat', 'resourceType' => '全部资源', 'arn' => '*'],
],
],
],
- 'responses' => [
- 200 => [
- 'schema' => [
- 'type' => 'object',
- 'properties' => [
- 'result' => [
- 'description' => '返回结果',
- '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"
- .' }',
- ],
- 'requestId' => [
- 'description' => '请求ID',
- 'type' => 'string',
- 'example' => '58113A95-1858-5674-87E5-192AEE6FD9DD',
- ],
- ],
+ [
+ 'apiName' => 'CreateCapability',
+ 'description' => '创建配置',
+ 'operationType' => 'create',
+ 'ramAction' => [
+ 'action' => 'searchplat:CreateCapability',
+ 'authLevel' => 'operate',
+ 'actionConditions' => [],
+ 'resources' => [
+ ['validationType' => 'always', 'product' => 'SearchPlat', 'resourceType' => '全部资源', 'arn' => '*'],
],
],
- '5XX' => [
- 'schema' => [
- 'type' => 'object',
- 'properties' => [
- 'code' => [
- 'type' => 'string',
- ],
- 'message' => [
- 'type' => 'string',
- ],
- 'requestId' => [
- 'type' => 'string',
- ],
- 'httpCode' => [
- 'type' => 'integer',
- 'format' => 'int32',
- ],
- ],
+ ],
+ [
+ '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}'],
],
],
],
- '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' => '获取数据表字段',
- ],
- 'DescribeRegions' => [
- 'path' => '/openapi/platform/regions',
- 'methods' => [
- 'get',
- ],
- 'schemes' => [
- 'http',
- 'https',
+ [
+ '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}'],
+ ],
+ ],
],
- 'security' => [
- [
- 'AK' => [],
+ [
+ 'apiName' => 'DeleteOfflineTask',
+ 'description' => '删除离线任务',
+ 'operationType' => 'delete',
+ 'ramAction' => [
+ 'action' => 'searchplat:DeleteOfflineTask',
+ 'authLevel' => 'operate',
+ 'actionConditions' => [],
+ 'resources' => [
+ ['validationType' => 'always', 'product' => 'SearchPlat', 'resourceType' => '全部资源', 'arn' => '*'],
+ ],
],
],
- 'operationType' => 'read',
- 'deprecated' => false,
- 'systemTags' => [
+ [
+ 'apiName' => 'GetRagEvaluatorTask',
+ 'description' => '获取rag版评测任务',
'operationType' => 'get',
- 'abilityTreeCode' => '218714',
- 'abilityTreeNodes' => [
- 'FEATUREopensearchJK5SO0',
+ 'ramAction' => [
+ 'action' => 'searchplat:DescribeEvaluation',
+ 'authLevel' => 'operate',
+ 'actionConditions' => [],
+ 'resources' => [
+ ['validationType' => 'always', 'product' => 'SearchPlat', 'resourceType' => '全部资源', 'arn' => '*'],
+ ],
],
],
- 'parameters' => [],
- 'responses' => [
- 200 => [
- 'schema' => [
- 'title' => 'Schema of Response',
- 'description' => 'Schema of Response',
- 'type' => 'object',
- 'properties' => [
- 'requestId' => [
- 'title' => 'Id of the request',
- 'description' => 'Id of the request',
- 'type' => 'string',
- 'example' => 'AE3554F3-313D-5712-919C-A334615C5DE5',
- ],
- ],
+ [
+ 'apiName' => 'DeleteRagEvaluatorTask',
+ 'description' => '删除评测任务',
+ 'operationType' => 'delete',
+ 'ramAction' => [
+ 'action' => 'searchplat:WriteEvaluation',
+ 'authLevel' => 'operate',
+ 'actionConditions' => [],
+ 'resources' => [
+ ['validationType' => 'always', 'product' => 'SearchPlat', 'resourceType' => '全部资源', 'arn' => '*'],
],
],
],
- 'staticInfo' => [
- 'returnType' => 'synchronous',
- ],
- 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"requestId\\": \\"AE3554F3-313D-5712-919C-A334615C5DE5\\"\\n}","type":"json"}]',
- 'title' => '查询支持区域列表',
- ],
- 'ListServices' => [
- 'summary' => '获取服务列表。',
- 'path' => '/openapi/platform/workspaces/{workspaceName}/services',
- 'methods' => [
- 'get',
- ],
- 'schemes' => [
- 'https',
- ],
- 'security' => [
- [
- 'AK' => [],
+ [
+ '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}'],
+ ],
],
],
- 'consumes' => [
- 'application/json',
- ],
- 'produces' => [
- 'application/json',
- ],
- 'operationType' => 'read',
- 'deprecated' => false,
- 'systemTags' => [
+ [
+ 'apiName' => 'GetWorkspace',
+ 'description' => '查看一个工作空间详情',
'operationType' => 'none',
- 'riskType' => 'none',
- 'chargeType' => 'free',
- 'abilityTreeNodes' => [
- 'FEATUREopensearchLIKVQB',
+ 'ramAction' => [
+ 'action' => 'searchplat:DescribeWorkspace',
+ 'authLevel' => 'resource',
+ 'actionConditions' => [],
+ 'resources' => [
+ ['validationType' => 'always', 'product' => 'SearchPlat', 'resourceType' => 'Workspace', 'arn' => 'acs:searchplat:{#regionId}:{#accountId}:workspaces/{#workspaceName}'],
+ ],
],
- 'autoTest' => true,
- 'tenantRelevance' => 'tenant',
],
- 'parameters' => [
- [
- 'name' => 'workspaceName',
- 'in' => 'path',
- 'schema' => [
- 'description' => '工作空间名称',
- 'type' => 'string',
- 'required' => false,
- 'example' => 'default',
+ [
+ '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}'],
],
],
- [
- 'name' => 'modelType',
- 'in' => 'query',
- 'schema' => [
- 'description' => '模型类型'."\n"
- ."\n"
- .'- system 系统内置模型'."\n"
- .'- deployment 自定义部署模型',
- 'type' => 'string',
- 'required' => false,
- 'example' => 'system',
+ ],
+ [
+ '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}'],
],
],
- [
- 'name' => 'serviceType',
- 'in' => 'query',
- 'schema' => [
- 'description' => '服务类型',
- 'type' => 'string',
- 'required' => false,
- 'example' => 'text-embedding',
+ ],
+ [
+ 'apiName' => 'DescribeCapability',
+ 'description' => '获取配置详情',
+ 'operationType' => 'get',
+ 'ramAction' => [
+ 'action' => 'searchplat:DescribeCapability',
+ 'authLevel' => 'operate',
+ 'actionConditions' => [],
+ 'resources' => [
+ ['validationType' => 'always', 'product' => 'SearchPlat', 'resourceType' => '全部资源', 'arn' => '*'],
],
],
- [
- 'name' => 'serviceId',
- 'in' => 'query',
- 'schema' => [
- 'description' => '服务ID',
- 'type' => 'string',
- 'required' => false,
- 'example' => 'ops-text-embedding-001',
+ ],
+ [
+ '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}'],
],
],
- [
- 'name' => 'name',
- 'in' => 'query',
- 'schema' => [
- 'description' => '服务名称',
- 'type' => 'string',
- 'required' => false,
- 'example' => '文本向量化',
+ ],
+ [
+ 'apiName' => 'ListRagEvaluatorTasks',
+ 'description' => '获取rag版评测任务列表',
+ 'operationType' => 'get',
+ 'ramAction' => [
+ 'action' => 'searchplat:DescribeEvaluation',
+ 'authLevel' => 'operate',
+ 'actionConditions' => [],
+ 'resources' => [
+ ['validationType' => 'always', 'product' => 'SearchPlat', 'resourceType' => '全部资源', 'arn' => '*'],
],
],
],
- 'responses' => [
- 200 => [
- 'schema' => [
- 'title' => 'Schema of Response',
- 'description' => 'Schema of Response',
- 'type' => 'object',
- 'properties' => [
- 'requestId' => [
- 'title' => 'Id of the request',
- 'description' => 'Id of the request',
- 'type' => 'string',
- 'example' => '2423C841-91C4-5E51-B296-590D367967FC',
- ],
- 'result' => [
- 'description' => '任务执行结果',
- 'type' => 'array',
- 'items' => [
- 'description' => '任务执行结果',
- 'type' => 'object',
- 'properties' => [
- 'description' => [
- 'description' => '描述',
- 'type' => 'string',
- 'example' => '33',
- ],
- 'meta' => [
- 'description' => '信息体',
- 'type' => 'object',
- 'example' => ' {'."\n"
- .' "maxTokens": 512'."\n"
- .' }',
- ],
- 'modelType' => [
- 'description' => '模型类型',
- 'type' => 'string',
- 'example' => 'deployment',
- ],
- 'name' => [
- 'description' => '服务名称',
- 'type' => 'string',
- 'example' => '文本向量化'."\n",
- ],
- 'serviceId' => [
- 'description' => '服务ID。',
- 'type' => 'string',
- 'example' => 'ops-text-embedding-001'."\n",
- ],
- 'serviceType' => [
- 'description' => '服务类型',
- 'type' => 'string',
- 'example' => 'text-embedding',
- ],
- 'chargeWay' => [
- 'description' => '计费方式',
- 'type' => 'array',
- 'items' => [
- 'description' => '计费类型',
- 'type' => 'string',
- 'example' => 'token-used',
- ],
- ],
- ],
- ],
- ],
- ],
+ [
+ 'apiName' => 'UpdateCapability',
+ 'description' => '更新配置',
+ 'operationType' => 'update',
+ 'ramAction' => [
+ 'action' => 'searchplat:UpdateCapability',
+ 'authLevel' => 'operate',
+ 'actionConditions' => [],
+ 'resources' => [
+ ['validationType' => 'always', 'product' => 'SearchPlat', 'resourceType' => '全部资源', 'arn' => '*'],
],
],
],
- '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' => '获取所有服务列表',
- ],
- 'GetTables' => [
- 'summary' => '获取数据表',
- 'path' => '/openapi/platform/workspaces/{workspaceName}/data-sources/{dataSourceType}/tables',
- 'methods' => [
- 'get',
- ],
- 'schemes' => [
- 'https',
+ [
+ 'apiName' => 'DeleteCapability',
+ 'description' => '删除配置项',
+ 'operationType' => 'delete',
+ 'ramAction' => [
+ 'action' => 'searchplat:DeleteCapability',
+ 'authLevel' => 'operate',
+ 'actionConditions' => [],
+ 'resources' => [
+ ['validationType' => 'always', 'product' => 'SearchPlat', 'resourceType' => '全部资源', 'arn' => '*'],
+ ],
+ ],
],
- 'security' => [
- [
- 'AK' => [],
+ [
+ 'apiName' => 'StopOfflineTask',
+ 'description' => '停止离线任务',
+ 'operationType' => 'none',
+ 'ramAction' => [
+ 'action' => 'searchplat:StopOfflineTask',
+ 'authLevel' => 'operate',
+ 'actionConditions' => [],
+ 'resources' => [
+ ['validationType' => 'always', 'product' => 'SearchPlat', 'resourceType' => '全部资源', 'arn' => '*'],
+ ],
],
],
- 'consumes' => [
- 'application/json',
+ [
+ 'apiName' => 'StartOfflineTask',
+ 'description' => '开启离线任务',
+ 'operationType' => 'none',
+ 'ramAction' => [
+ 'action' => 'searchplat:StartOfflineTask',
+ 'authLevel' => 'operate',
+ 'actionConditions' => [],
+ 'resources' => [
+ ['validationType' => 'always', 'product' => 'SearchPlat', 'resourceType' => '全部资源', 'arn' => '*'],
+ ],
+ ],
],
- 'produces' => [
- 'application/json',
+ [
+ '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}'],
+ ],
+ ],
],
- 'operationType' => 'read',
- 'deprecated' => false,
- 'systemTags' => [
- 'operationType' => 'get',
- 'riskType' => 'none',
- 'chargeType' => 'free',
- 'abilityTreeCode' => '241066',
- 'abilityTreeNodes' => [
- 'FEATUREopensearchJK5SO0',
+ [
+ '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}'],
+ ],
],
- 'autoTest' => true,
- 'tenantRelevance' => 'tenant',
],
- 'parameters' => [
- [
- 'name' => 'workspaceName',
- 'in' => 'path',
- 'schema' => [
- 'description' => '工作空间名称',
- 'type' => 'string',
- 'required' => true,
- 'example' => 'default',
+ [
+ 'apiName' => 'CeaseFunctionInstance',
+ 'description' => '停止notebook服务',
+ 'operationType' => 'none',
+ 'ramAction' => [
+ 'action' => 'searchplat:CeaseFunctionInstance',
+ 'authLevel' => 'operate',
+ 'actionConditions' => [],
+ 'resources' => [
+ ['validationType' => 'always', 'product' => 'SearchPlat', 'resourceType' => '全部资源', 'arn' => '*'],
],
],
- [
- 'name' => 'dataSourceType',
- 'in' => 'path',
- 'schema' => [
- 'description' => '数据源类型'."\n"
- ."\n"
- .'- rds'."\n"
- .'- odps',
- 'type' => 'string',
- 'required' => true,
- 'docRequired' => true,
- 'example' => 'rds',
+ ],
+ [
+ '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}'],
],
],
- [
- 'name' => 'params',
- 'in' => 'query',
- 'schema' => [
- 'description' => '数据源参数',
- 'type' => 'string',
- 'required' => true,
- 'docRequired' => true,
- 'example' => '{'."\n"
- .' "instanceId": "instance_id",'."\n"
- .' "dbName": "db_name",'."\n"
- .' "dbUser": "db_user",'."\n"
- .' "dbPassword": "passwoed"'."\n"
- .'}'."\n",
+ ],
+ [
+ 'apiName' => 'ResumeFunctionInstance',
+ 'description' => '启动notebook服务',
+ 'operationType' => 'none',
+ 'ramAction' => [
+ 'action' => 'searchplat:ResumeFunctionInstance',
+ 'authLevel' => 'operate',
+ 'actionConditions' => [],
+ 'resources' => [
+ ['validationType' => 'always', 'product' => 'SearchPlat', 'resourceType' => '全部资源', 'arn' => '*'],
],
],
- [
- 'name' => 'regionId',
- 'in' => 'query',
- 'schema' => [
- 'title' => '区域标识符',
- 'description' => '区域标识符',
- 'type' => 'string',
- 'required' => false,
- 'example' => 'cn-shanghai',
+ ],
+ [
+ 'apiName' => 'ListServices',
+ 'description' => '获取所有服务列表',
+ 'operationType' => 'none',
+ 'ramAction' => [
+ 'action' => 'searchplat:ListServices',
+ 'authLevel' => 'operate',
+ 'actionConditions' => [],
+ 'resources' => [
+ ['validationType' => 'always', 'product' => 'SearchPlat', 'resourceType' => '全部资源', 'arn' => '*'],
],
],
],
- 'responses' => [
- 200 => [
- 'schema' => [
- 'type' => 'object',
- 'properties' => [
- 'result' => [
- 'description' => '返回结果',
- 'type' => 'array',
- 'items' => [
- 'description' => '表名称',
- 'type' => 'string',
- 'example' => 'main',
- ],
- ],
- 'requestId' => [
- 'description' => '请求ID',
- 'type' => 'string',
- 'example' => '33E4F0CA-F766-5803-B11C-70DC57A5A6E4',
- ],
- ],
+ [
+ 'apiName' => 'GetTables',
+ 'description' => '获取数据表',
+ 'operationType' => 'get',
+ 'ramAction' => [
+ 'action' => 'searchplat:GetTables',
+ 'authLevel' => 'operate',
+ 'actionConditions' => [],
+ 'resources' => [
+ ['validationType' => 'always', 'product' => 'SearchPlat', 'resourceType' => '全部资源', 'arn' => '*'],
],
],
- '5XX' => [
- 'schema' => [
- 'type' => 'object',
- 'properties' => [
- 'code' => [
- 'type' => 'string',
- ],
- 'message' => [
- 'type' => 'string',
- ],
- 'requestId' => [
- 'type' => 'string',
- ],
- 'httpCode' => [
- 'type' => 'integer',
- 'format' => 'int32',
- ],
- ],
+ ],
+ [
+ '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}'],
],
],
],
- 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"result\\": [\\n \\"main\\"\\n ],\\n \\"requestId\\": \\"33E4F0CA-F766-5803-B11C-70DC57A5A6E4\\"\\n}","type":"json"}]',
- 'title' => '获取数据表',
- ],
- 'GetTableColumns' => [
- 'summary' => '获取数据表',
- 'path' => '/openapi/platform/workspaces/{workspaceName}/data-sources/{dataSourceType}/columns',
- 'methods' => [
- 'get',
+ [
+ '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}'],
+ ],
+ ],
],
- 'schemes' => [
- 'https',
+ [
+ '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}'],
+ ],
+ ],
],
- 'security' => [
- [
- 'AK' => [],
+ [
+ '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}'],
+ ],
],
],
- 'consumes' => [
- 'application/json',
+ [
+ '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}'],
+ ],
+ ],
],
- 'produces' => [
- 'application/json',
+ [
+ 'apiName' => 'CreateWorkspace',
+ 'description' => '创建工作空间',
+ 'operationType' => 'none',
+ 'ramAction' => [
+ 'action' => 'searchplat:WriteWorkspace',
+ 'authLevel' => 'resource',
+ 'actionConditions' => [],
+ 'resources' => [
+ ['validationType' => 'always', 'product' => 'SearchPlat', 'resourceType' => '全部资源', 'arn' => '*'],
+ ],
+ ],
],
- 'operationType' => 'read',
- 'deprecated' => false,
- 'systemTags' => [
- 'operationType' => 'get',
- 'riskType' => 'none',
- 'chargeType' => 'free',
- 'abilityTreeCode' => '241066',
- 'abilityTreeNodes' => [
- 'FEATUREopensearchJK5SO0',
+ [
+ '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}'],
+ ],
],
- 'autoTest' => true,
- 'tenantRelevance' => 'tenant',
],
- 'parameters' => [
- [
- 'name' => 'workspaceName',
- 'in' => 'path',
- 'schema' => [
- 'description' => '工作空间名称',
- 'type' => 'string',
- 'required' => true,
- 'example' => 'default',
+ [
+ '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}'],
],
],
- [
- 'name' => 'dataSourceType',
- 'in' => 'path',
- 'schema' => [
- 'description' => '数据源类型'."\n"
- ."\n"
- .'- rds'."\n"
- .'- odps',
- 'type' => 'string',
- 'required' => true,
- 'docRequired' => true,
- 'example' => 'rds',
+ ],
+ [
+ 'apiName' => 'CreateOfflineTask',
+ 'description' => '创建离线任务',
+ 'operationType' => 'create',
+ 'ramAction' => [
+ 'action' => 'searchplat:CreateOfflineTask',
+ 'authLevel' => 'operate',
+ 'actionConditions' => [],
+ 'resources' => [
+ ['validationType' => 'always', 'product' => 'SearchPlat', 'resourceType' => '全部资源', 'arn' => '*'],
],
],
- [
- 'name' => 'params',
- 'in' => 'query',
- 'schema' => [
- 'description' => '访问数据源的配置参数',
- '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"
- .'}',
+ ],
+ [
+ 'apiName' => 'ListOfflineTask',
+ 'description' => '获取离线任务列表',
+ 'operationType' => 'none',
+ 'ramAction' => [
+ 'action' => 'searchplat:ListOfflineTask',
+ 'authLevel' => 'operate',
+ 'actionConditions' => [],
+ 'resources' => [
+ ['validationType' => 'always', 'product' => 'SearchPlat', 'resourceType' => '全部资源', 'arn' => '*'],
],
],
- [
- 'name' => 'regionId',
- 'in' => 'query',
- 'schema' => [
- 'title' => '区域标识符',
- 'description' => '区域标识符',
- 'type' => 'string',
- 'required' => false,
- 'example' => 'cn-shanghai',
+ ],
+ [
+ 'apiName' => 'CreateFunctionTask',
+ 'description' => '激活配置',
+ 'operationType' => 'create',
+ 'ramAction' => [
+ 'action' => 'searchplat:WriteFunction',
+ 'authLevel' => 'operate',
+ 'actionConditions' => [],
+ 'resources' => [
+ ['validationType' => 'always', 'product' => 'SearchPlat', 'resourceType' => '全部资源', 'arn' => '*'],
],
],
],
- 'responses' => [
- 200 => [
- 'schema' => [
- 'title' => 'Schema of Response',
- 'description' => 'Schema of Response',
- 'type' => 'object',
- 'properties' => [
- 'result' => [
- 'description' => '返回结果',
- 'type' => 'array',
- 'items' => [
- 'description' => '返回结果',
- 'type' => 'object',
- 'properties' => [
- 'name' => [
- 'description' => '字段名称',
- 'type' => 'string',
- 'example' => 'id',
- ],
- 'type' => [
- 'description' => '字段类型',
- 'type' => 'string',
- 'example' => 'BIGINT',
- ],
- 'comment' => [
- 'description' => '字段描述',
- 'type' => 'string',
- 'example' => '主键字段',
- ],
- 'primary' => [
- 'description' => '是否为主键',
- 'type' => 'boolean',
- 'example' => 'true',
- ],
- ],
- ],
- ],
- 'requestId' => [
- 'description' => '请求ID',
- 'type' => 'string',
- 'example' => '1CC93E65-6734-5060-BEF7-0EB0A4862BCF',
- ],
- ],
+ [
+ 'apiName' => 'CreateRagEvaluatorTask',
+ 'description' => '创建评测任务',
+ 'operationType' => 'create',
+ 'ramAction' => [
+ 'action' => 'searchplat:WriteEvaluation',
+ 'authLevel' => 'operate',
+ 'actionConditions' => [],
+ 'resources' => [
+ ['validationType' => 'always', 'product' => 'SearchPlat', 'resourceType' => '全部资源', 'arn' => '*'],
],
],
- '5XX' => [
- 'schema' => [
- 'type' => 'object',
- 'properties' => [
- 'code' => [
- 'type' => 'string',
- ],
- 'message' => [
- 'type' => 'string',
- ],
- 'requestId' => [
- 'type' => 'string',
- ],
- 'httpCode' => [
- 'type' => 'integer',
- 'format' => 'int32',
- ],
- ],
+ ],
+ [
+ '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/*'],
],
],
],
- 'staticInfo' => [
- 'returnType' => 'synchronous',
+ [
+ 'apiName' => 'GetTableFields',
+ 'description' => '获取数据表字段',
+ 'operationType' => 'get',
+ 'ramAction' => [
+ 'action' => 'searchplat:GetTableFields',
+ 'authLevel' => 'resource',
+ 'actionConditions' => [],
+ 'resources' => [
+ ['validationType' => 'always', 'product' => 'SearchPlat', 'resourceType' => '全部资源', 'arn' => '*'],
+ ],
+ ],
],
- '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' => '获取数据表字段信息',
- ],
- ],
- 'endpoints' => [
- [
- 'regionId' => 'cn-shanghai',
- 'endpoint' => 'searchplat.cn-shanghai.aliyuncs.com',
],
- [
- 'regionId' => 'eu-central-1',
- 'endpoint' => 'searchplat.eu-central-1.aliyuncs.com',
+ '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}'],
],
],
];
diff --git a/data/zh_cn/searchplat/2024-05-29/api-docs.php b/data/zh_cn/searchplat/2024-05-29/api-docs.php
index a5511f6..ee45e64 100644
--- a/data/zh_cn/searchplat/2024-05-29/api-docs.php
+++ b/data/zh_cn/searchplat/2024-05-29/api-docs.php
@@ -1,29 +1,32 @@
<?php return [
'version' => '1.0',
- 'info' => [
- 'product' => 'Searchplat',
- 'version' => '2024-05-29',
- ],
+ 'info' => ['product' => 'Searchplat', 'version' => '2024-05-29'],
'directories' => [
+ 'GetTextGeneration',
+ 'GetDocumentAnalyzeTaskStatus',
+ 'GetDocumentRank',
+ 'GetDocumentSplit',
+ 'CreateDocumentAnalyzeTask',
+ 'GetTextSparseEmbedding',
+ 'GetQueryAnalysis',
+ 'CreateImageAnalyzeTask',
+ 'GetImageAnalyzeTaskStatus',
+ 'GetTextEmbedding',
+ 'GetWebSearch',
+ 'GetEmbeddingTuning',
+ 'GetPrediction',
+ 'CreateAudioAsrTask',
+ 'CreateVideoSnapshotTask',
+ 'GetAudioAsrTaskStatus',
+ 'GetImageObjectDetection',
+ 'GetMultiModalEmbedding',
+ 'GetMultiModalReranker',
+ 'GetVideoSnapshotTaskStatus',
[
'id' => 0,
'title' => '其它',
'type' => 'directory',
- 'children' => [
- 'GetTextGeneration',
- 'GetDocumentAnalyzeTaskStatus',
- 'GetDocumentRank',
- 'GetDocumentSplit',
- 'CreateDocumentAnalyzeTask',
- 'GetTextSparseEmbedding',
- 'GetQueryAnalysis',
- 'CreateImageAnalyzeTask',
- 'GetImageAnalyzeTaskStatus',
- 'GetTextEmbedding',
- 'GetWebSearch',
- 'GetEmbeddingTuning',
- 'GetPrediction',
- ],
+ 'children' => ['GetVideoSegmentationTaskStatus', 'GetVideoSummarizationTaskStatus', 'CreateVideoSegmentationTask', 'CreateVideoSummarizationTask', 'UpdateMemorySkill', 'CreateMemorySkill', 'SearchMemory', 'DeleteMemory', 'GetMemory', 'GetMemoryTask', 'GetMemoryHealth', 'CreateMemory', 'UpdateMemory', 'GetMemorySkill', 'DeleteMemorySkill', 'GetJinaAiReader'],
],
],
'components' => [
@@ -33,47 +36,28 @@
'GetTextGeneration' => [
'summary' => '大模型问答',
'path' => '/v3/openapi/workspaces/{workspace_name}/text-generation/{service_id}',
- 'methods' => [
- 'post',
- ],
- 'schemes' => [
- 'http',
- 'https',
- ],
+ 'methods' => ['post'],
+ 'schemes' => ['http', 'https'],
'security' => [
[
'BearerToken' => [],
],
],
- 'consumes' => [
- 'application/json',
- ],
- 'produces' => [
- 'application/json',
- ],
+ 'consumes' => ['application/json'],
+ 'produces' => ['application/json'],
'operationType' => 'read',
'deprecated' => false,
- 'systemTags' => [
- 'operationType' => 'none',
- 'riskType' => 'none',
- 'chargeType' => 'paid',
- ],
+ 'systemTags' => ['operationType' => 'none', 'riskType' => 'none', 'chargeType' => 'paid'],
'parameters' => [
[
'name' => 'workspace_name',
'in' => 'path',
- 'schema' => [
- 'type' => 'string',
- 'required' => true,
- ],
+ 'schema' => ['type' => 'string', 'required' => true],
],
[
'name' => 'service_id',
'in' => 'path',
- 'schema' => [
- 'type' => 'string',
- 'required' => true,
- ],
+ 'schema' => ['type' => 'string', 'required' => true],
],
[
'name' => 'body',
@@ -87,28 +71,16 @@
'items' => [
'type' => 'object',
'properties' => [
- 'content' => [
- 'type' => 'string',
- ],
- 'role' => [
- 'type' => 'string',
- ],
+ 'content' => ['type' => 'string'],
+ 'role' => ['type' => 'string'],
],
],
'required' => true,
],
- 'stream' => [
- 'type' => 'boolean',
- ],
- 'csi_level' => [
- 'type' => 'string',
- ],
- 'parameters' => [
- 'type' => 'object',
- ],
- 'enable_search' => [
- 'type' => 'boolean',
- ],
+ 'stream' => ['type' => 'boolean'],
+ 'csi_level' => ['type' => 'string'],
+ 'parameters' => ['type' => 'object'],
+ 'enable_search' => ['type' => 'boolean'],
],
],
],
@@ -118,47 +90,27 @@
'schema' => [
'type' => 'object',
'properties' => [
- 'request_id' => [
- 'type' => 'string',
- ],
- 'latency' => [
- 'type' => 'integer',
- 'format' => 'int32',
- ],
+ 'request_id' => ['type' => 'string'],
+ 'latency' => ['type' => 'integer', 'format' => 'int32'],
'usage' => [
'type' => 'object',
'properties' => [
- 'output_tokens' => [
- 'type' => 'integer',
- 'format' => 'int64',
- ],
- 'input_tokens' => [
- 'type' => 'integer',
- 'format' => 'int64',
- ],
- 'total_tokens' => [
- 'type' => 'integer',
- 'format' => 'int64',
- ],
+ 'output_tokens' => ['type' => 'integer', 'format' => 'int64'],
+ 'input_tokens' => ['type' => 'integer', 'format' => 'int64'],
+ 'total_tokens' => ['type' => 'integer', 'format' => 'int64'],
],
],
'result' => [
'type' => 'object',
'properties' => [
- 'text' => [
- 'type' => 'string',
- ],
+ 'text' => ['type' => 'string'],
'search_results' => [
'type' => 'array',
'items' => [
'type' => 'object',
'properties' => [
- 'title' => [
- 'type' => 'string',
- ],
- 'url' => [
- 'type' => 'string',
- ],
+ 'title' => ['type' => 'string'],
+ 'url' => ['type' => 'string'],
],
],
],
@@ -173,55 +125,33 @@
'GetDocumentAnalyzeTaskStatus' => [
'summary' => '获取文档解析异步提取任务状态',
'path' => '/v3/openapi/workspaces/{workspace_name}/document-analyze/{service_id}/async/task-status',
- 'methods' => [
- 'get',
- ],
- 'schemes' => [
- 'http',
- 'https',
- ],
+ 'methods' => ['get'],
+ 'schemes' => ['http', 'https'],
'security' => [
[
'BearerToken' => [],
],
],
- 'consumes' => [
- 'application/json',
- ],
- 'produces' => [
- 'application/json',
- ],
+ 'consumes' => ['application/json'],
+ 'produces' => ['application/json'],
'operationType' => 'write',
'deprecated' => false,
- 'systemTags' => [
- 'operationType' => 'none',
- 'riskType' => 'none',
- 'chargeType' => 'paid',
- ],
+ 'systemTags' => ['operationType' => 'none', 'riskType' => 'none', 'chargeType' => 'paid'],
'parameters' => [
[
'name' => 'workspace_name',
'in' => 'path',
- 'schema' => [
- 'type' => 'string',
- 'required' => true,
- ],
+ 'schema' => ['type' => 'string', 'required' => true],
],
[
'name' => 'service_id',
'in' => 'path',
- 'schema' => [
- 'type' => 'string',
- 'required' => true,
- ],
+ 'schema' => ['type' => 'string', 'required' => true],
],
[
'name' => 'task_id',
'in' => 'query',
- 'schema' => [
- 'type' => 'string',
- 'required' => true,
- ],
+ 'schema' => ['type' => 'string', 'required' => true],
],
],
'responses' => [
@@ -229,28 +159,15 @@
'schema' => [
'type' => 'object',
'properties' => [
- 'request_id' => [
- 'type' => 'string',
- ],
- 'latency' => [
- 'type' => 'integer',
- 'format' => 'int32',
- ],
+ 'request_id' => ['type' => 'string'],
+ 'latency' => ['type' => 'integer', 'format' => 'int32'],
'usage' => [
'type' => 'object',
'properties' => [
- 'image_count' => [
- 'type' => 'integer',
- 'format' => 'int64',
- ],
- 'table_count' => [
- 'type' => 'integer',
- 'format' => 'int64',
- ],
- 'token_count' => [
- 'type' => 'integer',
- 'format' => 'int64',
- ],
+ 'image_count' => ['type' => 'integer', 'format' => 'int64'],
+ 'table_count' => ['type' => 'integer', 'format' => 'int64'],
+ 'token_count' => ['type' => 'integer', 'format' => 'int64'],
+ 'semantic_token_count' => ['type' => 'integer', 'format' => 'int64'],
],
],
'result' => [
@@ -259,82 +176,52 @@
'data' => [
'type' => 'object',
'properties' => [
- 'content' => [
- 'type' => 'string',
- ],
- 'content_type' => [
- 'type' => 'string',
- ],
- 'page_num' => [
- 'type' => 'integer',
- 'format' => 'int32',
+ 'content' => ['type' => 'string'],
+ 'content_type' => ['type' => 'string'],
+ 'page_num' => ['type' => 'integer', 'format' => 'int32'],
+ 'pages' => [
+ 'type' => 'array',
+ 'items' => ['type' => 'string'],
],
],
],
- 'status' => [
- 'type' => 'string',
- ],
- 'task_id' => [
- 'type' => 'string',
- ],
- 'error' => [
- 'type' => 'string',
- ],
+ 'status' => ['type' => 'string'],
+ 'task_id' => ['type' => 'string'],
+ 'error' => ['type' => 'string'],
],
],
],
],
],
],
- 'staticInfo' => [
- 'returnType' => 'synchronous',
- ],
+ 'staticInfo' => ['returnType' => 'synchronous'],
'responseDemo' => '',
],
'GetDocumentRank' => [
'summary' => '文档相关性打分',
'path' => '/v3/openapi/workspaces/{workspace_name}/ranker/{service_id}',
- 'methods' => [
- 'post',
- ],
- 'schemes' => [
- 'http',
- 'https',
- ],
+ 'methods' => ['post'],
+ 'schemes' => ['http', 'https'],
'security' => [
[
'BearerToken' => [],
],
],
- 'consumes' => [
- 'application/json',
- ],
- 'produces' => [
- 'application/json',
- ],
+ 'consumes' => ['application/json'],
+ 'produces' => ['application/json'],
'operationType' => 'read',
'deprecated' => false,
- 'systemTags' => [
- 'operationType' => 'none',
- 'riskType' => 'none',
- 'chargeType' => 'paid',
- ],
+ 'systemTags' => ['operationType' => 'none', 'riskType' => 'none', 'chargeType' => 'paid'],
'parameters' => [
[
'name' => 'workspace_name',
'in' => 'path',
- 'schema' => [
- 'type' => 'string',
- 'required' => true,
- ],
+ 'schema' => ['type' => 'string', 'required' => true],
],
[
'name' => 'service_id',
'in' => 'path',
- 'schema' => [
- 'type' => 'string',
- 'required' => true,
- ],
+ 'schema' => ['type' => 'string', 'required' => true],
],
[
'name' => 'body',
@@ -345,16 +232,10 @@
'properties' => [
'docs' => [
'type' => 'array',
- 'items' => [
- 'type' => 'string',
- 'required' => true,
- ],
- 'required' => true,
- ],
- 'query' => [
- 'type' => 'string',
+ 'items' => ['type' => 'string', 'required' => true],
'required' => true,
],
+ 'query' => ['type' => 'string', 'required' => true],
],
],
],
@@ -364,20 +245,12 @@
'schema' => [
'type' => 'object',
'properties' => [
- 'request_id' => [
- 'type' => 'string',
- ],
- 'latency' => [
- 'type' => 'integer',
- 'format' => 'int32',
- ],
+ 'request_id' => ['type' => 'string'],
+ 'latency' => ['type' => 'integer', 'format' => 'int32'],
'usage' => [
'type' => 'object',
'properties' => [
- 'doc_count' => [
- 'type' => 'integer',
- 'format' => 'int64',
- ],
+ 'doc_count' => ['type' => 'integer', 'format' => 'int64'],
],
],
'result' => [
@@ -388,14 +261,8 @@
'items' => [
'type' => 'object',
'properties' => [
- 'index' => [
- 'type' => 'integer',
- 'format' => 'int32',
- ],
- 'score' => [
- 'type' => 'number',
- 'format' => 'double',
- ],
+ 'index' => ['type' => 'integer', 'format' => 'int32'],
+ 'score' => ['type' => 'number', 'format' => 'double'],
],
],
],
@@ -405,54 +272,33 @@
],
],
],
- 'staticInfo' => [
- 'returnType' => 'synchronous',
- ],
+ 'staticInfo' => ['returnType' => 'synchronous'],
],
'GetDocumentSplit' => [
'summary' => '文档切片',
'path' => '/v3/openapi/workspaces/{workspace_name}/document-split/{service_id}',
- 'methods' => [
- 'post',
- ],
- 'schemes' => [
- 'http',
- 'https',
- ],
+ 'methods' => ['post'],
+ 'schemes' => ['http', 'https'],
'security' => [
[
'BearerToken' => [],
],
],
- 'consumes' => [
- 'application/json',
- ],
- 'produces' => [
- 'application/json',
- ],
+ 'consumes' => ['application/json'],
+ 'produces' => ['application/json'],
'operationType' => 'read',
'deprecated' => false,
- 'systemTags' => [
- 'operationType' => 'none',
- 'riskType' => 'none',
- 'chargeType' => 'paid',
- ],
+ 'systemTags' => ['operationType' => 'none', 'riskType' => 'none', 'chargeType' => 'paid'],
'parameters' => [
[
'name' => 'workspace_name',
'in' => 'path',
- 'schema' => [
- 'type' => 'string',
- 'required' => true,
- ],
+ 'schema' => ['type' => 'string', 'required' => true],
],
[
'name' => 'service_id',
'in' => 'path',
- 'schema' => [
- 'type' => 'string',
- 'required' => true,
- ],
+ 'schema' => ['type' => 'string', 'required' => true],
],
[
'name' => 'body',
@@ -464,31 +310,18 @@
'document' => [
'type' => 'object',
'properties' => [
- 'content' => [
- 'type' => 'string',
- ],
- 'content_encoding' => [
- 'type' => 'string',
- ],
- 'content_type' => [
- 'type' => 'string',
- ],
+ 'content' => ['type' => 'string'],
+ 'content_encoding' => ['type' => 'string'],
+ 'content_type' => ['type' => 'string'],
],
'required' => true,
],
'strategy' => [
'type' => 'object',
'properties' => [
- 'max_chunk_size' => [
- 'type' => 'integer',
- 'format' => 'int64',
- ],
- 'compute_type' => [
- 'type' => 'string',
- ],
- 'need_sentence' => [
- 'type' => 'boolean',
- ],
+ 'max_chunk_size' => ['type' => 'integer', 'format' => 'int64'],
+ 'compute_type' => ['type' => 'string'],
+ 'need_sentence' => ['type' => 'boolean'],
],
],
],
@@ -500,20 +333,12 @@
'schema' => [
'type' => 'object',
'properties' => [
- 'request_id' => [
- 'type' => 'string',
- ],
- 'latency' => [
- 'type' => 'integer',
- 'format' => 'int32',
- ],
+ 'request_id' => ['type' => 'string'],
+ 'latency' => ['type' => 'integer', 'format' => 'int32'],
'usage' => [
'type' => 'object',
'properties' => [
- 'token_count' => [
- 'type' => 'integer',
- 'format' => 'int64',
- ],
+ 'token_count' => ['type' => 'integer', 'format' => 'int64'],
],
],
'result' => [
@@ -524,14 +349,10 @@
'items' => [
'type' => 'object',
'properties' => [
- 'content' => [
- 'type' => 'string',
- ],
+ 'content' => ['type' => 'string'],
'meta' => [
'type' => 'object',
- 'additionalProperties' => [
- 'type' => 'string',
- ],
+ 'additionalProperties' => ['type' => 'string'],
],
],
],
@@ -541,14 +362,10 @@
'items' => [
'type' => 'object',
'properties' => [
- 'content' => [
- 'type' => 'string',
- ],
+ 'content' => ['type' => 'string'],
'meta' => [
'type' => 'object',
- 'additionalProperties' => [
- 'type' => 'string',
- ],
+ 'additionalProperties' => ['type' => 'string'],
],
],
],
@@ -557,9 +374,7 @@
'type' => 'array',
'items' => [
'type' => 'object',
- 'additionalProperties' => [
- 'type' => 'string',
- ],
+ 'additionalProperties' => ['type' => 'string'],
],
],
'sentences' => [
@@ -567,14 +382,10 @@
'items' => [
'type' => 'object',
'properties' => [
- 'content' => [
- 'type' => 'string',
- ],
+ 'content' => ['type' => 'string'],
'meta' => [
'type' => 'object',
- 'additionalProperties' => [
- 'type' => 'string',
- ],
+ 'additionalProperties' => ['type' => 'string'],
],
],
],
@@ -585,55 +396,34 @@
],
],
],
- 'staticInfo' => [
- 'returnType' => 'synchronous',
- ],
+ 'staticInfo' => ['returnType' => 'synchronous'],
'responseDemo' => '',
],
'CreateDocumentAnalyzeTask' => [
'summary' => '创建文档解析异步提取任务',
'path' => '/v3/openapi/workspaces/{workspace_name}/document-analyze/{service_id}/async',
- 'methods' => [
- 'post',
- ],
- 'schemes' => [
- 'http',
- 'https',
- ],
+ 'methods' => ['post'],
+ 'schemes' => ['http', 'https'],
'security' => [
[
'BearerToken' => [],
],
],
- 'consumes' => [
- 'application/json',
- ],
- 'produces' => [
- 'application/json',
- ],
+ 'consumes' => ['application/json'],
+ 'produces' => ['application/json'],
'operationType' => 'write',
'deprecated' => false,
- 'systemTags' => [
- 'operationType' => 'none',
- 'riskType' => 'none',
- 'chargeType' => 'paid',
- ],
+ 'systemTags' => ['operationType' => 'none', 'riskType' => 'none', 'chargeType' => 'paid'],
'parameters' => [
[
'name' => 'workspace_name',
'in' => 'path',
- 'schema' => [
- 'type' => 'string',
- 'required' => true,
- ],
+ 'schema' => ['type' => 'string', 'required' => true],
],
[
'name' => 'service_id',
'in' => 'path',
- 'schema' => [
- 'type' => 'string',
- 'required' => true,
- ],
+ 'schema' => ['type' => 'string', 'required' => true],
],
[
'name' => 'body',
@@ -645,26 +435,22 @@
'document' => [
'type' => 'object',
'properties' => [
- 'url' => [
- 'type' => 'string',
- ],
- 'content' => [
- 'type' => 'string',
- ],
- 'file_name' => [
- 'type' => 'string',
- ],
- 'file_type' => [
- 'type' => 'string',
- ],
+ 'url' => ['type' => 'string'],
+ 'content' => ['type' => 'string'],
+ 'file_name' => ['type' => 'string'],
+ 'file_type' => ['type' => 'string'],
],
],
'output' => [
'type' => 'object',
'properties' => [
- 'image_storage' => [
- 'type' => 'string',
- ],
+ 'image_storage' => ['type' => 'string'],
+ ],
+ ],
+ 'strategy' => [
+ 'type' => 'object',
+ 'properties' => [
+ 'enable_semantic' => ['type' => 'boolean'],
],
],
],
@@ -676,74 +462,46 @@
'schema' => [
'type' => 'object',
'properties' => [
- 'request_id' => [
- 'type' => 'string',
- ],
- 'latency' => [
- 'type' => 'integer',
- 'format' => 'int32',
- ],
+ 'request_id' => ['type' => 'string'],
+ 'latency' => ['type' => 'integer', 'format' => 'int32'],
'result' => [
'type' => 'object',
'properties' => [
- 'task_id' => [
- 'type' => 'string',
- ],
+ 'task_id' => ['type' => 'string'],
],
],
],
],
],
],
- 'staticInfo' => [
- 'returnType' => 'synchronous',
- ],
+ 'staticInfo' => ['returnType' => 'synchronous'],
'responseDemo' => '',
],
'GetTextSparseEmbedding' => [
'summary' => '文本稀疏向量化',
'path' => '/v3/openapi/workspaces/{workspace_name}/text-sparse-embedding/{service_id}',
- 'methods' => [
- 'post',
- ],
- 'schemes' => [
- 'http',
- 'https',
- ],
+ 'methods' => ['post'],
+ 'schemes' => ['http', 'https'],
'security' => [
[
'BearerToken' => [],
],
],
- 'consumes' => [
- 'application/json',
- ],
- 'produces' => [
- 'application/json',
- ],
+ 'consumes' => ['application/json'],
+ 'produces' => ['application/json'],
'operationType' => 'read',
'deprecated' => false,
- 'systemTags' => [
- 'operationType' => 'none',
- 'riskType' => 'none',
- 'chargeType' => 'paid',
- ],
+ 'systemTags' => ['operationType' => 'none', 'riskType' => 'none', 'chargeType' => 'paid'],
'parameters' => [
[
'name' => 'workspace_name',
'in' => 'path',
- 'schema' => [
- 'type' => 'string',
- 'required' => true,
- ],
+ 'schema' => ['type' => 'string', 'required' => true],
],
[
'name' => 'service_id',
'in' => 'path',
- 'schema' => [
- 'type' => 'string',
- 'required' => true,
- ],
+ 'schema' => ['type' => 'string', 'required' => true],
],
[
'name' => 'body',
@@ -754,9 +512,7 @@
'properties' => [
'input' => [
'type' => 'array',
- 'items' => [
- 'type' => 'string',
- ],
+ 'items' => ['type' => 'string'],
'required' => true,
],
'input_type' => [
@@ -764,14 +520,9 @@
'required' => false,
'example' => 'document',
'default' => 'document',
- 'enum' => [
- 'document',
- 'query',
- ],
- ],
- 'return_token' => [
- 'type' => 'boolean',
+ 'enum' => ['document', 'query'],
],
+ 'return_token' => ['type' => 'boolean'],
],
],
],
@@ -781,20 +532,12 @@
'schema' => [
'type' => 'object',
'properties' => [
- 'request_id' => [
- 'type' => 'string',
- ],
- 'latency' => [
- 'type' => 'integer',
- 'format' => 'int32',
- ],
+ 'request_id' => ['type' => 'string'],
+ 'latency' => ['type' => 'integer', 'format' => 'int32'],
'usage' => [
'type' => 'object',
'properties' => [
- 'token_count' => [
- 'type' => 'integer',
- 'format' => 'int64',
- ],
+ 'token_count' => ['type' => 'integer', 'format' => 'int64'],
],
],
'result' => [
@@ -810,24 +553,13 @@
'items' => [
'type' => 'object',
'properties' => [
- 'token' => [
- 'type' => 'string',
- ],
- 'token_id' => [
- 'type' => 'integer',
- 'format' => 'int32',
- ],
- 'weight' => [
- 'type' => 'number',
- 'format' => 'float',
- ],
+ 'token' => ['type' => 'string'],
+ 'token_id' => ['type' => 'integer', 'format' => 'int32'],
+ 'weight' => ['type' => 'number', 'format' => 'float'],
],
],
],
- 'index' => [
- 'type' => 'integer',
- 'format' => 'int32',
- ],
+ 'index' => ['type' => 'integer', 'format' => 'int32'],
],
],
],
@@ -837,55 +569,34 @@
],
],
],
- 'staticInfo' => [
- 'returnType' => 'synchronous',
- ],
+ 'staticInfo' => ['returnType' => 'synchronous'],
'responseDemo' => '',
],
'GetQueryAnalysis' => [
'summary' => '获取query分析结果',
'path' => '/v3/openapi/workspaces/{workspace_name}/query-analyze/{service_id}',
- 'methods' => [
- 'post',
- ],
- 'schemes' => [
- 'http',
- 'https',
- ],
+ 'methods' => ['post'],
+ 'schemes' => ['http', 'https'],
'security' => [
[
'BearerToken' => [],
],
],
- 'consumes' => [
- 'application/json',
- ],
- 'produces' => [
- 'application/json',
- ],
+ 'consumes' => ['application/json'],
+ 'produces' => ['application/json'],
'operationType' => 'read',
'deprecated' => false,
- 'systemTags' => [
- 'operationType' => 'none',
- 'riskType' => 'none',
- 'chargeType' => 'paid',
- ],
+ 'systemTags' => ['operationType' => 'none', 'riskType' => 'none', 'chargeType' => 'paid'],
'parameters' => [
[
'name' => 'workspace_name',
'in' => 'path',
- 'schema' => [
- 'type' => 'string',
- 'required' => true,
- ],
+ 'schema' => ['type' => 'string', 'required' => true],
],
[
'name' => 'service_id',
'in' => 'path',
- 'schema' => [
- 'type' => 'string',
- 'required' => true,
- ],
+ 'schema' => ['type' => 'string', 'required' => true],
],
[
'name' => 'body',
@@ -899,31 +610,20 @@
'items' => [
'type' => 'object',
'properties' => [
- 'content' => [
- 'type' => 'string',
- ],
- 'role' => [
- 'type' => 'string',
- ],
+ 'content' => ['type' => 'string'],
+ 'role' => ['type' => 'string'],
],
],
'required' => false,
],
- 'query' => [
- 'type' => 'string',
- 'required' => true,
- ],
+ 'query' => ['type' => 'string', 'required' => true],
'functions' => [
'type' => 'array',
'items' => [
'type' => 'object',
'properties' => [
- 'name' => [
- 'type' => 'string',
- ],
- 'parameters' => [
- 'type' => 'object',
- ],
+ 'name' => ['type' => 'string'],
+ 'parameters' => ['type' => 'object'],
],
],
],
@@ -936,102 +636,59 @@
'schema' => [
'type' => 'object',
'properties' => [
- 'request_id' => [
- 'type' => 'string',
- ],
- 'latency' => [
- 'type' => 'integer',
- 'format' => 'int32',
- ],
+ 'request_id' => ['type' => 'string'],
+ 'latency' => ['type' => 'integer', 'format' => 'int32'],
'usage' => [
'type' => 'object',
'properties' => [
- 'output_tokens' => [
- 'type' => 'integer',
- 'format' => 'int64',
- ],
- 'input_tokens' => [
- 'type' => 'integer',
- 'format' => 'int64',
- ],
- 'total_tokens' => [
- 'type' => 'integer',
- 'format' => 'int64',
- ],
+ 'output_tokens' => ['type' => 'integer', 'format' => 'int64'],
+ 'input_tokens' => ['type' => 'integer', 'format' => 'int64'],
+ 'total_tokens' => ['type' => 'integer', 'format' => 'int64'],
],
],
'result' => [
'type' => 'object',
'properties' => [
- 'query' => [
- 'type' => 'string',
- ],
+ 'query' => ['type' => 'string'],
'queries' => [
'type' => 'array',
- 'items' => [
- 'type' => 'string',
- ],
- ],
- 'intent' => [
- 'type' => 'string',
- ],
- 'sql' => [
- 'type' => 'object',
+ 'items' => ['type' => 'string'],
],
+ 'intent' => ['type' => 'string'],
+ 'sql' => ['type' => 'object'],
],
],
],
],
],
],
- 'staticInfo' => [
- 'returnType' => 'synchronous',
- ],
+ 'staticInfo' => ['returnType' => 'synchronous'],
],
'CreateImageAnalyzeTask' => [
'summary' => '创建图片解析异步提取任务',
'path' => '/v3/openapi/workspaces/{workspace_name}/image-analyze/{service_id}/async',
- 'methods' => [
- 'post',
- ],
- 'schemes' => [
- 'http',
- 'https',
- ],
+ 'methods' => ['post'],
+ 'schemes' => ['http', 'https'],
'security' => [
[
'BearerToken' => [],
],
],
- 'consumes' => [
- 'application/json',
- ],
- 'produces' => [
- 'application/json',
- ],
+ 'consumes' => ['application/json'],
+ 'produces' => ['application/json'],
'operationType' => 'write',
'deprecated' => false,
- 'systemTags' => [
- 'operationType' => 'none',
- 'riskType' => 'none',
- 'chargeType' => 'paid',
- ],
+ 'systemTags' => ['operationType' => 'none', 'riskType' => 'none', 'chargeType' => 'paid'],
'parameters' => [
[
'name' => 'workspace_name',
'in' => 'path',
- 'schema' => [
- 'type' => 'string',
- 'required' => true,
- ],
+ 'schema' => ['type' => 'string', 'required' => true],
],
[
'name' => 'service_id',
'in' => 'path',
- 'schema' => [
- 'type' => 'string',
- 'required' => true,
- ],
+ 'schema' => ['type' => 'string', 'required' => true],
],
[
'name' => 'body',
@@ -1043,18 +700,10 @@
'document' => [
'type' => 'object',
'properties' => [
- 'url' => [
- 'type' => 'string',
- ],
- 'content' => [
- 'type' => 'string',
- ],
- 'file_name' => [
- 'type' => 'string',
- ],
- 'file_type' => [
- 'type' => 'string',
- ],
+ 'url' => ['type' => 'string'],
+ 'content' => ['type' => 'string'],
+ 'file_name' => ['type' => 'string'],
+ 'file_type' => ['type' => 'string'],
],
],
],
@@ -1066,81 +715,50 @@
'schema' => [
'type' => 'object',
'properties' => [
- 'request_id' => [
- 'type' => 'string',
- ],
- 'latency' => [
- 'type' => 'integer',
- 'format' => 'int32',
- ],
+ 'request_id' => ['type' => 'string'],
+ 'latency' => ['type' => 'integer', 'format' => 'int32'],
'result' => [
'type' => 'object',
'properties' => [
- 'task_id' => [
- 'type' => 'string',
- ],
+ 'task_id' => ['type' => 'string'],
],
],
],
],
],
],
- 'staticInfo' => [
- 'returnType' => 'synchronous',
- ],
+ 'staticInfo' => ['returnType' => 'synchronous'],
],
'GetImageAnalyzeTaskStatus' => [
'summary' => '获取图片解析异步提取任务状态',
'path' => '/v3/openapi/workspaces/{workspace_name}/image-analyze/{service_id}/async/task-status',
- 'methods' => [
- 'get',
- ],
- 'schemes' => [
- 'http',
- 'https',
- ],
+ 'methods' => ['get'],
+ 'schemes' => ['http', 'https'],
'security' => [
[
'BearerToken' => [],
],
],
- 'consumes' => [
- 'application/json',
- ],
- 'produces' => [
- 'application/json',
- ],
+ 'consumes' => ['application/json'],
+ 'produces' => ['application/json'],
'operationType' => 'write',
'deprecated' => false,
- 'systemTags' => [
- 'operationType' => 'none',
- 'riskType' => 'none',
- 'chargeType' => 'paid',
- ],
+ 'systemTags' => ['operationType' => 'none', 'riskType' => 'none', 'chargeType' => 'paid'],
'parameters' => [
[
'name' => 'workspace_name',
'in' => 'path',
- 'schema' => [
- 'type' => 'string',
- 'required' => true,
- ],
+ 'schema' => ['type' => 'string', 'required' => true],
],
[
'name' => 'service_id',
'in' => 'path',
- 'schema' => [
- 'type' => 'string',
- 'required' => true,
- ],
+ 'schema' => ['type' => 'string', 'required' => true],
],
[
'name' => 'task_id',
'in' => 'query',
- 'schema' => [
- 'type' => 'string',
- 'required' => true,
- ],
+ 'schema' => ['type' => 'string', 'required' => true],
],
],
'responses' => [
@@ -1148,24 +766,13 @@
'schema' => [
'type' => 'object',
'properties' => [
- 'request_id' => [
- 'type' => 'string',
- ],
- 'latency' => [
- 'type' => 'integer',
- 'format' => 'int32',
- ],
+ 'request_id' => ['type' => 'string'],
+ 'latency' => ['type' => 'integer', 'format' => 'int32'],
'usage' => [
'type' => 'object',
'properties' => [
- 'pv_count' => [
- 'type' => 'integer',
- 'format' => 'int64',
- ],
- 'token_count' => [
- 'type' => 'integer',
- 'format' => 'int64',
- ],
+ 'pv_count' => ['type' => 'integer', 'format' => 'int64'],
+ 'token_count' => ['type' => 'integer', 'format' => 'int64'],
],
],
'result' => [
@@ -1174,81 +781,47 @@
'data' => [
'type' => 'object',
'properties' => [
- 'content' => [
- 'type' => 'string',
- ],
- 'content_type' => [
- 'type' => 'string',
- ],
- 'page_num' => [
- 'type' => 'integer',
- 'format' => 'int32',
- ],
+ 'content' => ['type' => 'string'],
+ 'content_type' => ['type' => 'string'],
+ 'page_num' => ['type' => 'integer', 'format' => 'int32'],
],
],
- 'status' => [
- 'type' => 'string',
- ],
- 'task_id' => [
- 'type' => 'string',
- ],
- 'error' => [
- 'type' => 'string',
- ],
+ 'status' => ['type' => 'string'],
+ 'task_id' => ['type' => 'string'],
+ 'error' => ['type' => 'string'],
],
],
],
],
],
],
- 'staticInfo' => [
- 'returnType' => 'synchronous',
- ],
+ 'staticInfo' => ['returnType' => 'synchronous'],
],
'GetTextEmbedding' => [
'summary' => '文本向量化',
'path' => '/v3/openapi/workspaces/{workspace_name}/text-embedding/{service_id}',
- 'methods' => [
- 'post',
- ],
- 'schemes' => [
- 'http',
- 'https',
- ],
+ 'methods' => ['post'],
+ 'schemes' => ['http', 'https'],
'security' => [
[
'BearerToken' => [],
],
],
- 'consumes' => [
- 'application/json',
- ],
- 'produces' => [
- 'application/json',
- ],
+ 'consumes' => ['application/json'],
+ 'produces' => ['application/json'],
'operationType' => 'read',
'deprecated' => false,
- 'systemTags' => [
- 'operationType' => 'none',
- 'riskType' => 'none',
- 'chargeType' => 'paid',
- ],
+ 'systemTags' => ['operationType' => 'none', 'riskType' => 'none', 'chargeType' => 'paid'],
'parameters' => [
[
'name' => 'workspace_name',
'in' => 'path',
- 'schema' => [
- 'type' => 'string',
- 'required' => true,
- ],
+ 'schema' => ['type' => 'string', 'required' => true],
],
[
'name' => 'service_id',
'in' => 'path',
- 'schema' => [
- 'type' => 'string',
- 'required' => true,
- ],
+ 'schema' => ['type' => 'string', 'required' => true],
],
[
'name' => 'body',
@@ -1259,9 +832,7 @@
'properties' => [
'input' => [
'type' => 'array',
- 'items' => [
- 'type' => 'string',
- ],
+ 'items' => ['type' => 'string'],
'required' => true,
],
'input_type' => [
@@ -1269,10 +840,7 @@
'required' => false,
'example' => 'document',
'default' => 'document',
- 'enum' => [
- 'document',
- 'query',
- ],
+ 'enum' => ['document', 'query'],
],
],
],
@@ -1283,20 +851,12 @@
'schema' => [
'type' => 'object',
'properties' => [
- 'request_id' => [
- 'type' => 'string',
- ],
- 'latency' => [
- 'type' => 'integer',
- 'format' => 'int32',
- ],
+ 'request_id' => ['type' => 'string'],
+ 'latency' => ['type' => 'integer', 'format' => 'int32'],
'usage' => [
'type' => 'object',
'properties' => [
- 'token_count' => [
- 'type' => 'integer',
- 'format' => 'int64',
- ],
+ 'token_count' => ['type' => 'integer', 'format' => 'int64'],
],
],
'result' => [
@@ -1307,16 +867,10 @@
'items' => [
'type' => 'object',
'properties' => [
- 'index' => [
- 'type' => 'integer',
- 'format' => 'int32',
- ],
+ 'index' => ['type' => 'integer', 'format' => 'int32'],
'embedding' => [
'type' => 'array',
- 'items' => [
- 'type' => 'number',
- 'format' => 'double',
- ],
+ 'items' => ['type' => 'number', 'format' => 'double'],
],
],
],
@@ -1327,55 +881,322 @@
],
],
],
- 'staticInfo' => [
- 'returnType' => 'synchronous',
- ],
+ 'staticInfo' => ['returnType' => 'synchronous'],
],
'GetWebSearch' => [
'summary' => '联网搜索',
'path' => '/v3/openapi/workspaces/{workspace_name}/web-search/{service_id}',
- 'methods' => [
- 'post',
+ 'methods' => ['post'],
+ 'schemes' => ['http', 'https'],
+ 'security' => [
+ [
+ 'BearerToken' => [],
+ ],
+ ],
+ 'consumes' => ['application/json'],
+ 'produces' => ['application/json'],
+ 'operationType' => 'read',
+ 'deprecated' => false,
+ 'systemTags' => ['operationType' => 'none', 'riskType' => 'none', 'chargeType' => 'paid'],
+ 'parameters' => [
+ [
+ 'name' => 'workspace_name',
+ 'in' => 'path',
+ 'schema' => ['type' => 'string', 'required' => true],
+ ],
+ [
+ 'name' => 'service_id',
+ 'in' => 'path',
+ 'schema' => ['type' => 'string', 'required' => true],
+ ],
+ [
+ 'name' => 'body',
+ 'in' => 'body',
+ 'style' => 'json',
+ 'schema' => [
+ 'type' => 'object',
+ 'properties' => [
+ 'query' => ['type' => 'string', 'required' => true],
+ 'way' => ['type' => 'string'],
+ 'top_k' => ['type' => 'integer', 'format' => 'int64'],
+ 'query_rewrite' => ['type' => 'boolean'],
+ 'content_type' => ['type' => 'string'],
+ 'history' => [
+ 'type' => 'array',
+ 'items' => [
+ 'type' => 'object',
+ 'properties' => [
+ 'role' => ['type' => 'string'],
+ 'content' => ['type' => 'string'],
+ ],
+ ],
+ ],
+ ],
+ ],
+ ],
],
- 'schemes' => [
- 'http',
- 'https',
+ 'responses' => [
+ 200 => [
+ 'schema' => [
+ 'type' => 'object',
+ 'properties' => [
+ 'request_id' => ['type' => 'string'],
+ 'latency' => ['type' => 'integer', 'format' => 'int32'],
+ 'usage' => [
+ 'type' => 'object',
+ 'properties' => [
+ 'search_count' => ['type' => 'integer', 'format' => 'int64'],
+ 'rewrite_model.input_tokens' => ['type' => 'integer', 'format' => 'int64'],
+ 'rewrite_model.output_tokens' => ['type' => 'integer', 'format' => 'int64'],
+ 'rewrite_model.total_tokens' => ['type' => 'integer', 'format' => 'int64'],
+ 'filter_model.input_tokens' => ['type' => 'integer', 'format' => 'int64'],
+ 'filter_model.output_tokens' => ['type' => 'integer', 'format' => 'int64'],
+ 'filter_model.total_tokens' => ['type' => 'integer', 'format' => 'int64'],
+ ],
+ ],
+ 'result' => [
+ 'type' => 'object',
+ 'properties' => [
+ 'search_result' => [
+ 'type' => 'array',
+ 'items' => [
+ 'type' => 'object',
+ 'properties' => [
+ 'tilte' => ['type' => 'string'],
+ 'link' => ['type' => 'string'],
+ 'snippet' => ['type' => 'string'],
+ 'content' => ['type' => 'string'],
+ 'position' => ['type' => 'integer', 'format' => 'int64'],
+ 'meta_info' => ['type' => 'object'],
+ ],
+ ],
+ ],
+ ],
+ ],
+ ],
+ ],
+ ],
],
+ ],
+ 'GetEmbeddingTuning' => [
+ 'summary' => '向量微调',
+ 'path' => '/v3/openapi/workspaces/{workspace_name}/embedding-tuning/{service_id}',
+ 'methods' => ['post'],
+ 'schemes' => ['http', 'https'],
'security' => [
[
'BearerToken' => [],
],
],
- 'consumes' => [
- 'application/json',
+ 'consumes' => ['application/json'],
+ 'produces' => ['application/json'],
+ 'operationType' => 'read',
+ 'deprecated' => false,
+ 'systemTags' => ['operationType' => 'none', 'riskType' => 'none', 'chargeType' => 'paid'],
+ 'parameters' => [
+ [
+ 'name' => 'workspace_name',
+ 'in' => 'path',
+ 'schema' => ['title' => 'A short description of struct', 'type' => 'string'],
+ ],
+ [
+ 'name' => 'service_id',
+ 'in' => 'path',
+ 'schema' => ['type' => 'string'],
+ ],
+ [
+ 'name' => 'body',
+ 'in' => 'body',
+ 'style' => 'json',
+ 'schema' => [
+ 'type' => 'object',
+ 'properties' => [
+ 'input' => [
+ 'type' => 'array',
+ 'items' => [
+ 'type' => 'array',
+ 'items' => ['type' => 'number', 'format' => 'float'],
+ ],
+ ],
+ 'parameters' => ['type' => 'object'],
+ ],
+ ],
+ ],
],
- 'produces' => [
- 'application/json',
+ 'responses' => [
+ 200 => [
+ 'schema' => [
+ 'title' => 'Schema of Response',
+ 'type' => 'object',
+ 'properties' => [
+ 'request_id' => ['title' => 'Id of the request', 'type' => 'string'],
+ 'latency' => ['type' => 'integer', 'format' => 'int32'],
+ 'usage' => [
+ 'type' => 'object',
+ 'properties' => [
+ 'doc_count' => ['type' => 'integer', 'format' => 'int32'],
+ ],
+ ],
+ 'result' => [
+ 'type' => 'object',
+ 'properties' => [
+ 'output' => [
+ 'type' => 'array',
+ 'items' => [
+ 'type' => 'array',
+ 'items' => ['type' => 'number', 'format' => 'float'],
+ ],
+ ],
+ ],
+ ],
+ ],
+ ],
+ ],
],
+ 'staticInfo' => ['returnType' => 'synchronous'],
+ 'eventInfo' => [
+ 'enable' => false,
+ 'eventNames' => [],
+ ],
+ ],
+ 'GetPrediction' => [
+ 'summary' => '获取推理结果',
+ 'path' => '/v3/openapi/deployments/{deployment_id}/predict',
+ 'methods' => ['post'],
+ 'schemes' => ['http', 'https'],
+ 'security' => [
+ [
+ 'BearerToken' => [],
+ ],
+ ],
+ 'consumes' => ['application/json'],
+ 'produces' => [],
'operationType' => 'read',
'deprecated' => false,
- 'systemTags' => [
- 'operationType' => 'none',
- 'riskType' => 'none',
- 'chargeType' => 'paid',
+ 'systemTags' => ['operationType' => 'none', 'riskType' => 'none', 'chargeType' => 'paid'],
+ 'parameters' => [
+ [
+ 'name' => 'deployment_id',
+ 'in' => 'path',
+ 'schema' => ['type' => 'string', 'required' => true],
+ ],
+ [
+ 'name' => 'body',
+ 'in' => 'body',
+ 'schema' => ['type' => 'string'],
+ ],
+ [
+ 'name' => 'Token',
+ 'in' => 'header',
+ 'schema' => ['type' => 'string'],
+ ],
+ ],
+ 'responses' => [
+ 200 => [
+ 'schema' => ['type' => 'string'],
+ ],
+ ],
+ 'staticInfo' => ['returnType' => 'synchronous'],
+ ],
+ 'CreateAudioAsrTask' => [
+ 'summary' => '创建语音转录异步任务',
+ 'path' => '/v3/openapi/workspaces/{workspace_name}/audio-asr/{service_id}/async',
+ 'methods' => ['post'],
+ 'schemes' => ['http', 'https'],
+ 'security' => [
+ [
+ 'BearerToken' => [],
+ ],
],
+ 'consumes' => ['application/json'],
+ 'produces' => ['application/json'],
+ 'operationType' => 'write',
+ 'deprecated' => false,
+ 'systemTags' => ['operationType' => 'none', 'riskType' => 'none', 'chargeType' => 'paid'],
'parameters' => [
[
'name' => 'workspace_name',
'in' => 'path',
- 'schema' => [
- 'type' => 'string',
- 'required' => true,
- ],
+ 'schema' => ['type' => 'string', 'required' => true],
],
[
'name' => 'service_id',
'in' => 'path',
+ 'schema' => ['type' => 'string', 'required' => true],
+ ],
+ [
+ 'name' => 'body',
+ 'in' => 'body',
+ 'style' => 'json',
'schema' => [
- 'type' => 'string',
- 'required' => true,
+ 'type' => 'object',
+ 'properties' => [
+ 'input' => [
+ 'type' => 'object',
+ 'properties' => [
+ 'content' => ['type' => 'string'],
+ 'file_name' => ['type' => 'string'],
+ 'oss' => ['type' => 'string'],
+ 'url' => ['type' => 'string'],
+ ],
+ ],
+ 'output' => [
+ 'type' => 'object',
+ 'properties' => [
+ 'type' => ['type' => 'string'],
+ 'oss' => ['type' => 'string'],
+ ],
+ ],
+ 'parameters' => ['type' => 'object'],
+ ],
+ ],
+ ],
+ ],
+ 'responses' => [
+ 200 => [
+ 'schema' => [
+ 'type' => 'object',
+ 'properties' => [
+ 'request_id' => ['type' => 'string'],
+ 'latency' => ['type' => 'integer', 'format' => 'int32'],
+ 'result' => [
+ 'type' => 'object',
+ 'properties' => [
+ 'task_id' => ['type' => 'string'],
+ ],
+ ],
+ ],
],
],
+ ],
+ 'staticInfo' => ['returnType' => 'synchronous'],
+ ],
+ 'CreateVideoSnapshotTask' => [
+ 'summary' => '创建语音转录异步任务',
+ 'path' => '/v3/openapi/workspaces/{workspace_name}/video-snapshot/{service_id}/async',
+ 'methods' => ['post'],
+ 'schemes' => ['http', 'https'],
+ 'security' => [
+ [
+ 'BearerToken' => [],
+ ],
+ ],
+ 'consumes' => ['application/json'],
+ 'produces' => ['application/json'],
+ 'operationType' => 'write',
+ 'deprecated' => false,
+ 'systemTags' => ['operationType' => 'none', 'riskType' => 'none', 'chargeType' => 'paid'],
+ 'parameters' => [
+ [
+ 'name' => 'workspace_name',
+ 'in' => 'path',
+ 'schema' => ['type' => 'string', 'required' => true],
+ ],
+ [
+ 'name' => 'service_id',
+ 'in' => 'path',
+ 'schema' => ['type' => 'string', 'required' => true],
+ ],
[
'name' => 'body',
'in' => 'body',
@@ -1383,89 +1204,280 @@
'schema' => [
'type' => 'object',
'properties' => [
- 'query' => [
- 'type' => 'string',
- 'required' => true,
+ 'input' => [
+ 'type' => 'object',
+ 'properties' => [
+ 'content' => ['type' => 'string'],
+ 'file_name' => ['type' => 'string'],
+ 'oss' => ['type' => 'string'],
+ 'url' => ['type' => 'string'],
+ ],
],
- 'way' => [
- 'type' => 'string',
+ 'output' => [
+ 'type' => 'object',
+ 'properties' => [
+ 'type' => ['type' => 'string'],
+ 'oss' => ['type' => 'string'],
+ ],
],
- 'top_k' => [
- 'type' => 'integer',
- 'format' => 'int64',
+ 'parameters' => ['type' => 'object'],
+ ],
+ ],
+ ],
+ ],
+ 'responses' => [
+ 200 => [
+ 'schema' => [
+ 'type' => 'object',
+ 'properties' => [
+ 'request_id' => ['type' => 'string'],
+ 'latency' => ['type' => 'integer', 'format' => 'int32'],
+ 'result' => [
+ 'type' => 'object',
+ 'properties' => [
+ 'task_id' => ['type' => 'string'],
+ ],
],
],
],
],
],
+ 'staticInfo' => ['returnType' => 'synchronous'],
+ ],
+ 'GetAudioAsrTaskStatus' => [
+ 'summary' => '获取视频截帧异步提取任务状态',
+ 'path' => '/v3/openapi/workspaces/{workspace_name}/audio-asr/{service_id}/async/task-status',
+ 'methods' => ['get'],
+ 'schemes' => ['http', 'https'],
+ 'security' => [
+ [
+ 'BearerToken' => [],
+ ],
+ ],
+ 'consumes' => ['application/json'],
+ 'produces' => ['application/json'],
+ 'operationType' => 'write',
+ 'deprecated' => false,
+ 'systemTags' => ['operationType' => 'none', 'riskType' => 'none', 'chargeType' => 'paid'],
+ 'parameters' => [
+ [
+ 'name' => 'workspace_name',
+ 'in' => 'path',
+ 'schema' => ['type' => 'string', 'required' => true],
+ ],
+ [
+ 'name' => 'service_id',
+ 'in' => 'path',
+ 'schema' => ['type' => 'string', 'required' => true],
+ ],
+ [
+ 'name' => 'task_id',
+ 'in' => 'query',
+ 'schema' => ['type' => 'string', 'required' => true],
+ ],
+ ],
'responses' => [
200 => [
'schema' => [
'type' => 'object',
'properties' => [
- 'request_id' => [
- 'type' => 'string',
+ 'request_id' => ['type' => 'string'],
+ 'latency' => ['type' => 'integer', 'format' => 'int32'],
+ 'usage' => [
+ 'type' => 'object',
+ 'properties' => [
+ 'duration' => ['type' => 'number', 'format' => 'float'],
+ ],
+ ],
+ 'result' => [
+ 'type' => 'object',
+ 'properties' => [
+ 'status' => ['type' => 'string'],
+ 'task_id' => ['type' => 'string'],
+ 'error' => ['type' => 'string'],
+ 'data' => [
+ 'type' => 'array',
+ 'items' => [
+ 'type' => 'object',
+ 'properties' => [
+ 'text' => ['type' => 'string'],
+ 'start' => ['type' => 'number', 'format' => 'float'],
+ 'end' => ['type' => 'number', 'format' => 'float'],
+ ],
+ ],
+ ],
+ ],
],
- 'latency' => [
- 'type' => 'integer',
- 'format' => 'int32',
+ ],
+ ],
+ ],
+ ],
+ 'staticInfo' => ['returnType' => 'synchronous'],
+ ],
+ 'GetImageObjectDetection' => [
+ 'summary' => '图片主体检测',
+ 'path' => '/v3/openapi/workspaces/{workspace_name}/image-object-detection/{service_id}',
+ 'methods' => ['post'],
+ 'schemes' => ['http', 'https'],
+ 'security' => [
+ [
+ 'BearerToken' => [],
+ ],
+ ],
+ 'consumes' => ['application/json'],
+ 'produces' => ['application/json'],
+ 'operationType' => 'read',
+ 'deprecated' => false,
+ 'systemTags' => ['operationType' => 'none', 'riskType' => 'none', 'chargeType' => 'paid', 'tenantRelevance' => 'tenant'],
+ 'parameters' => [
+ [
+ 'name' => 'workspace_name',
+ 'in' => 'path',
+ 'schema' => ['title' => 'A short description of struct', 'type' => 'string'],
+ ],
+ [
+ 'name' => 'service_id',
+ 'in' => 'path',
+ 'schema' => ['type' => 'string'],
+ ],
+ [
+ 'name' => 'body',
+ 'in' => 'body',
+ 'style' => 'json',
+ 'schema' => [
+ 'type' => 'object',
+ 'properties' => [
+ 'image' => [
+ 'type' => 'object',
+ 'properties' => [
+ 'url' => ['type' => 'string'],
+ 'content' => ['type' => 'string'],
+ ],
],
+ 'options' => ['type' => 'object'],
+ ],
+ ],
+ ],
+ ],
+ 'responses' => [
+ 200 => [
+ 'schema' => [
+ 'title' => 'Schema of Response',
+ 'type' => 'object',
+ 'properties' => [
+ 'request_id' => ['type' => 'string'],
+ 'latency' => ['type' => 'integer', 'format' => 'int32'],
'usage' => [
'type' => 'object',
'properties' => [
- 'search_count' => [
- 'type' => 'integer',
- 'format' => 'int64',
- ],
- 'rewrite_model.input_tokens' => [
- 'type' => 'integer',
- 'format' => 'int64',
- ],
- 'rewrite_model.output_tokens' => [
- 'type' => 'integer',
- 'format' => 'int64',
- ],
- 'rewrite_model.total_tokens' => [
- 'type' => 'integer',
- 'format' => 'int64',
- ],
- 'filter_model.input_tokens' => [
- 'type' => 'integer',
- 'format' => 'int64',
- ],
- 'filter_model.output_tokens' => [
- 'type' => 'integer',
- 'format' => 'int64',
+ 'image' => ['type' => 'integer', 'format' => 'int64'],
+ ],
+ ],
+ 'result' => [
+ 'type' => 'object',
+ 'properties' => [
+ 'objects' => [
+ 'type' => 'array',
+ 'items' => [
+ 'type' => 'object',
+ 'properties' => [
+ 'confidence' => ['type' => 'string'],
+ 'location' => [
+ 'type' => 'object',
+ 'properties' => [
+ 'height' => ['type' => 'integer', 'format' => 'int32'],
+ 'width' => ['type' => 'integer', 'format' => 'int32'],
+ 'Y' => ['type' => 'integer', 'format' => 'int32'],
+ 'X' => ['type' => 'integer', 'format' => 'int32'],
+ ],
+ ],
+ ],
+ ],
],
- 'filter_model.total_tokens' => [
- 'type' => 'integer',
- 'format' => 'int64',
+ ],
+ ],
+ ],
+ ],
+ ],
+ ],
+ 'staticInfo' => ['returnType' => 'synchronous'],
+ ],
+ 'GetMultiModalEmbedding' => [
+ 'summary' => '多模态向量化',
+ 'path' => '/v3/openapi/workspaces/{workspace_name}/multi-modal-embedding/{service_id}',
+ 'methods' => ['post'],
+ 'schemes' => ['http', 'https'],
+ 'security' => [
+ [
+ 'BearerToken' => [],
+ ],
+ ],
+ 'consumes' => ['application/json'],
+ 'produces' => ['application/json'],
+ 'operationType' => 'read',
+ 'deprecated' => false,
+ 'systemTags' => ['operationType' => 'none', 'riskType' => 'none', 'chargeType' => 'paid', 'tenantRelevance' => 'tenant'],
+ 'parameters' => [
+ [
+ 'name' => 'workspace_name',
+ 'in' => 'path',
+ 'schema' => ['type' => 'string', 'required' => true],
+ ],
+ [
+ 'name' => 'service_id',
+ 'in' => 'path',
+ 'schema' => ['type' => 'string', 'required' => true],
+ ],
+ [
+ 'name' => 'body',
+ 'in' => 'body',
+ 'style' => 'json',
+ 'schema' => [
+ 'type' => 'object',
+ 'properties' => [
+ 'input' => [
+ 'type' => 'array',
+ 'items' => [
+ 'type' => 'object',
+ 'properties' => [
+ 'text' => ['type' => 'string'],
+ 'image' => ['type' => 'string'],
],
],
],
+ 'options' => ['type' => 'object'],
+ ],
+ ],
+ ],
+ ],
+ 'responses' => [
+ 200 => [
+ 'schema' => [
+ 'type' => 'object',
+ 'properties' => [
+ 'request_id' => ['type' => 'string'],
+ 'latency' => ['type' => 'integer', 'format' => 'int32'],
+ 'usage' => [
+ 'type' => 'object',
+ 'properties' => [
+ 'token_count' => ['type' => 'integer', 'format' => 'int64'],
+ 'image' => ['type' => 'integer', 'format' => 'int64'],
+ 'text_token' => ['type' => 'integer', 'format' => 'int64'],
+ 'image_token' => ['type' => 'integer', 'format' => 'int64'],
+ ],
+ ],
'result' => [
'type' => 'object',
'properties' => [
- 'search_result' => [
+ 'embeddings' => [
'type' => 'array',
'items' => [
'type' => 'object',
'properties' => [
- 'tilte' => [
- 'type' => 'string',
- ],
- 'link' => [
- 'type' => 'string',
- ],
- 'snippet' => [
- 'type' => 'string',
- ],
- 'content' => [
- 'type' => 'string',
- ],
- 'position' => [
- 'type' => 'integer',
- 'format' => 'int64',
+ 'index' => ['type' => 'integer', 'format' => 'int64'],
+ 'embedding' => [
+ 'type' => 'array',
+ 'items' => ['type' => 'number', 'format' => 'double'],
],
],
],
@@ -1476,51 +1488,456 @@
],
],
],
+ 'staticInfo' => ['returnType' => 'synchronous'],
],
- 'GetEmbeddingTuning' => [
- 'summary' => '向量微调',
- 'path' => '/v3/openapi/workspaces/{workspace_name}/embedding-tuning/{service_id}',
- 'methods' => [
- 'post',
+ 'GetMultiModalReranker' => [
+ 'summary' => '多模态 Reranker',
+ 'path' => '/v3/openapi/workspaces/{workspace_name}/multi-modal-reranker/{service_id}',
+ 'methods' => ['post'],
+ 'schemes' => ['http', 'https'],
+ 'security' => [
+ [
+ 'BearerToken' => [],
+ ],
],
- 'schemes' => [
- 'http',
- 'https',
+ 'consumes' => ['application/json'],
+ 'produces' => ['application/json'],
+ 'operationType' => 'read',
+ 'deprecated' => false,
+ 'systemTags' => ['operationType' => 'none', 'riskType' => 'none', 'chargeType' => 'paid', 'tenantRelevance' => 'tenant'],
+ 'parameters' => [
+ [
+ 'name' => 'workspace_name',
+ 'in' => 'path',
+ 'schema' => ['title' => 'A short description of struct', 'type' => 'string'],
+ ],
+ [
+ 'name' => 'service_id',
+ 'in' => 'path',
+ 'schema' => ['type' => 'string'],
+ ],
+ [
+ 'name' => 'body',
+ 'in' => 'body',
+ 'style' => 'json',
+ 'schema' => [
+ 'type' => 'object',
+ 'properties' => [
+ 'query' => [
+ 'type' => 'object',
+ 'properties' => [
+ 'text' => ['type' => 'string'],
+ 'image' => ['type' => 'string'],
+ ],
+ ],
+ 'docs' => [
+ 'type' => 'array',
+ 'items' => [
+ 'type' => 'object',
+ 'properties' => [
+ 'text' => ['type' => 'string'],
+ 'image' => ['type' => 'string'],
+ ],
+ ],
+ ],
+ 'options' => ['type' => 'object'],
+ ],
+ ],
+ ],
],
+ 'responses' => [
+ 200 => [
+ 'schema' => [
+ 'title' => 'Schema of Response',
+ 'type' => 'object',
+ 'properties' => [
+ 'request_id' => ['type' => 'string'],
+ 'latency' => ['type' => 'integer', 'format' => 'int32'],
+ 'usage' => [
+ 'type' => 'object',
+ 'properties' => [
+ 'text_token' => ['type' => 'integer', 'format' => 'int64'],
+ 'image_token' => ['type' => 'integer', 'format' => 'int64'],
+ ],
+ ],
+ 'result' => [
+ 'type' => 'object',
+ 'properties' => [
+ 'scores' => [
+ 'type' => 'array',
+ 'items' => [
+ 'type' => 'object',
+ 'properties' => [
+ 'index' => ['type' => 'integer', 'format' => 'int32'],
+ 'score' => ['type' => 'number', 'format' => 'double'],
+ ],
+ ],
+ ],
+ ],
+ ],
+ ],
+ ],
+ ],
+ ],
+ 'staticInfo' => ['returnType' => 'synchronous'],
+ ],
+ 'GetVideoSnapshotTaskStatus' => [
+ 'summary' => '获取视频截帧异步提取任务状态',
+ 'path' => '/v3/openapi/workspaces/{workspace_name}/video-snapshot/{service_id}/async/task-status',
+ 'methods' => ['get'],
+ 'schemes' => ['http', 'https'],
'security' => [
[
'BearerToken' => [],
],
],
- 'consumes' => [
- 'application/json',
+ 'consumes' => ['application/json'],
+ 'produces' => ['application/json'],
+ 'operationType' => 'write',
+ 'deprecated' => false,
+ 'systemTags' => ['operationType' => 'none', 'riskType' => 'none', 'chargeType' => 'paid'],
+ 'parameters' => [
+ [
+ 'name' => 'workspace_name',
+ 'in' => 'path',
+ 'schema' => ['type' => 'string', 'required' => true],
+ ],
+ [
+ 'name' => 'service_id',
+ 'in' => 'path',
+ 'schema' => ['type' => 'string', 'required' => true],
+ ],
+ [
+ 'name' => 'task_id',
+ 'in' => 'query',
+ 'schema' => ['type' => 'string', 'required' => true],
+ ],
],
- 'produces' => [
- 'application/json',
+ 'responses' => [
+ 200 => [
+ 'schema' => [
+ 'type' => 'object',
+ 'properties' => [
+ 'request_id' => ['type' => 'string'],
+ 'latency' => ['type' => 'integer', 'format' => 'int32'],
+ 'usage' => [
+ 'type' => 'object',
+ 'properties' => [
+ 'image_count' => ['type' => 'integer', 'format' => 'int64'],
+ ],
+ ],
+ 'result' => [
+ 'type' => 'object',
+ 'properties' => [
+ 'status' => ['type' => 'string'],
+ 'task_id' => ['type' => 'string'],
+ 'error' => ['type' => 'string'],
+ 'data' => [
+ 'type' => 'array',
+ 'items' => [
+ 'type' => 'object',
+ 'properties' => [
+ 'frame_index' => ['type' => 'integer', 'format' => 'int64'],
+ 'path' => ['type' => 'string'],
+ 'frame_time' => ['type' => 'number', 'format' => 'float'],
+ ],
+ ],
+ ],
+ ],
+ ],
+ ],
+ ],
+ ],
],
- 'operationType' => 'read',
+ 'staticInfo' => ['returnType' => 'synchronous'],
+ ],
+ 'GetVideoSegmentationTaskStatus' => [
+ 'summary' => '获取视频切割异步任务状态',
+ 'path' => '/v3/openapi/workspaces/{workspace_name}/video-segmentation/{service_id}/async/task-status',
+ 'methods' => ['get'],
+ 'schemes' => ['http', 'https'],
+ 'security' => [
+ [
+ 'BearerToken' => [],
+ ],
+ ],
+ 'consumes' => ['application/json'],
+ 'produces' => ['application/json'],
+ 'operationType' => 'write',
'deprecated' => false,
- 'systemTags' => [
- 'operationType' => 'none',
- 'riskType' => 'none',
- 'chargeType' => 'paid',
+ 'systemTags' => ['operationType' => 'none', 'riskType' => 'none', 'chargeType' => 'paid'],
+ 'parameters' => [
+ [
+ 'name' => 'workspace_name',
+ 'in' => 'path',
+ 'schema' => ['type' => 'string', 'required' => true],
+ ],
+ [
+ 'name' => 'service_id',
+ 'in' => 'path',
+ 'schema' => ['type' => 'string', 'required' => true],
+ ],
+ [
+ 'name' => 'task_id',
+ 'in' => 'query',
+ 'schema' => ['type' => 'string', 'required' => true],
+ ],
+ ],
+ 'responses' => [
+ 200 => [
+ 'schema' => [
+ 'type' => 'object',
+ 'properties' => [
+ 'request_id' => ['type' => 'string'],
+ 'latency' => ['type' => 'integer', 'format' => 'int32'],
+ 'usage' => [
+ 'type' => 'object',
+ 'properties' => [
+ 'image_token' => ['type' => 'integer', 'format' => 'int64'],
+ 'audio_token' => ['type' => 'integer', 'format' => 'int64'],
+ ],
+ ],
+ 'result' => [
+ 'type' => 'object',
+ 'properties' => [
+ 'status' => ['type' => 'string'],
+ 'task_id' => ['type' => 'string'],
+ 'error' => ['type' => 'string'],
+ 'data' => [
+ 'type' => 'array',
+ 'items' => [
+ 'type' => 'object',
+ 'properties' => [
+ 'chunk_index' => ['type' => 'integer', 'format' => 'int32'],
+ 'start_time' => ['type' => 'number', 'format' => 'float'],
+ 'end_time' => ['type' => 'number', 'format' => 'float'],
+ 'snapshots' => [
+ 'type' => 'array',
+ 'items' => [
+ 'type' => 'object',
+ 'properties' => [
+ 'frame_index' => ['type' => 'integer', 'format' => 'int32'],
+ 'path' => ['type' => 'string'],
+ 'frame_time' => ['type' => 'number', 'format' => 'float'],
+ ],
+ ],
+ ],
+ 'transcript' => ['type' => 'string'],
+ ],
+ ],
+ ],
+ ],
+ ],
+ ],
+ ],
+ ],
],
+ 'staticInfo' => ['returnType' => 'synchronous'],
+ 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"request_id\\": \\"\\",\\n \\"latency\\": 0,\\n \\"usage\\": {\\n \\"image_token\\": 0,\\n \\"audio_token\\": 0\\n },\\n \\"result\\": {\\n \\"status\\": \\"\\",\\n \\"task_id\\": \\"\\",\\n \\"error\\": \\"\\",\\n \\"data\\": [\\n {\\n \\"chunk_index\\": 0,\\n \\"start_time\\": 0,\\n \\"end_time\\": 0,\\n \\"snapshots\\": [\\n {\\n \\"frame_index\\": 0,\\n \\"path\\": \\"\\",\\n \\"frame_time\\": 0\\n }\\n ],\\n \\"transcript\\": \\"\\"\\n }\\n ]\\n }\\n}","type":"json"}]',
+ ],
+ 'GetVideoSummarizationTaskStatus' => [
+ 'summary' => '获取视频总结异步任务状态',
+ 'path' => '/v3/openapi/workspaces/{workspace_name}/video-summarization/{service_id}/async/task-status',
+ 'methods' => ['get'],
+ 'schemes' => ['http', 'https'],
+ 'security' => [
+ [
+ 'BearerToken' => [],
+ ],
+ ],
+ 'consumes' => ['application/json'],
+ 'produces' => ['application/json'],
+ 'operationType' => 'write',
+ 'deprecated' => false,
+ 'systemTags' => ['operationType' => 'none', 'riskType' => 'none', 'chargeType' => 'paid'],
'parameters' => [
[
'name' => 'workspace_name',
'in' => 'path',
+ 'schema' => ['type' => 'string', 'required' => true],
+ ],
+ [
+ 'name' => 'service_id',
+ 'in' => 'path',
+ 'schema' => ['type' => 'string', 'required' => true],
+ ],
+ [
+ 'name' => 'task_id',
+ 'in' => 'query',
+ 'schema' => ['type' => 'string', 'required' => true],
+ ],
+ ],
+ 'responses' => [
+ 200 => [
'schema' => [
- 'title' => 'A short description of struct',
- 'type' => 'string',
+ 'type' => 'object',
+ 'properties' => [
+ 'request_id' => ['type' => 'string'],
+ 'latency' => ['type' => 'integer', 'format' => 'int32'],
+ 'usage' => [
+ 'type' => 'object',
+ 'properties' => [
+ 'image_token' => ['type' => 'integer', 'format' => 'int64'],
+ 'audio_token' => ['type' => 'integer', 'format' => 'int64'],
+ 'input_token' => ['type' => 'integer', 'format' => 'int64'],
+ 'output_token' => ['type' => 'integer', 'format' => 'int64'],
+ ],
+ ],
+ 'result' => [
+ 'type' => 'object',
+ 'properties' => [
+ 'status' => ['type' => 'string'],
+ 'task_id' => ['type' => 'string'],
+ 'error' => ['type' => 'string'],
+ 'data' => [
+ 'type' => 'object',
+ 'properties' => [
+ 'video_metadata' => [
+ 'type' => 'object',
+ 'properties' => [
+ 'title' => ['type' => 'string'],
+ 'summary' => ['type' => 'string'],
+ 'tags' => [
+ 'type' => 'array',
+ 'items' => ['type' => 'string'],
+ ],
+ ],
+ ],
+ 'chunks' => [
+ 'type' => 'array',
+ 'items' => [
+ 'type' => 'object',
+ 'properties' => [
+ 'index' => ['type' => 'integer', 'format' => 'int32'],
+ 'enhanced_transcript' => ['type' => 'string'],
+ 'metadata' => [
+ 'type' => 'object',
+ 'properties' => [
+ 'title' => ['type' => 'string'],
+ 'summary' => ['type' => 'string'],
+ 'tags' => [
+ 'type' => 'array',
+ 'items' => ['type' => 'string'],
+ ],
+ ],
+ ],
+ ],
+ ],
+ ],
+ ],
+ ],
+ ],
+ ],
+ ],
],
],
+ ],
+ 'staticInfo' => ['returnType' => 'synchronous'],
+ 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"request_id\\": \\"\\",\\n \\"latency\\": 0,\\n \\"usage\\": {\\n \\"image_token\\": 0,\\n \\"audio_token\\": 0,\\n \\"input_token\\": 0,\\n \\"output_token\\": 0\\n },\\n \\"result\\": {\\n \\"status\\": \\"\\",\\n \\"task_id\\": \\"\\",\\n \\"error\\": \\"\\",\\n \\"data\\": {\\n \\"video_metadata\\": {\\n \\"title\\": \\"\\",\\n \\"summary\\": \\"\\",\\n \\"tags\\": [\\n \\"\\"\\n ]\\n },\\n \\"chunks\\": [\\n {\\n \\"index\\": 0,\\n \\"enhanced_transcript\\": \\"\\",\\n \\"metadata\\": {\\n \\"title\\": \\"\\",\\n \\"summary\\": \\"\\",\\n \\"tags\\": [\\n \\"\\"\\n ]\\n }\\n }\\n ]\\n }\\n }\\n}","type":"json"}]',
+ ],
+ 'CreateVideoSegmentationTask' => [
+ 'summary' => '创建视频切割异步任务。',
+ 'path' => '/v3/openapi/workspaces/{workspace_name}/video-segmentation/{service_id}/async',
+ 'methods' => ['post'],
+ 'schemes' => ['http', 'https'],
+ 'security' => [
+ [
+ 'BearerToken' => [],
+ ],
+ ],
+ 'consumes' => ['application/json'],
+ 'produces' => ['application/json'],
+ 'operationType' => 'write',
+ 'deprecated' => false,
+ 'systemTags' => ['operationType' => 'none', 'riskType' => 'none', 'chargeType' => 'paid'],
+ 'parameters' => [
+ [
+ 'name' => 'workspace_name',
+ 'in' => 'path',
+ 'schema' => ['type' => 'string', 'required' => true],
+ ],
[
'name' => 'service_id',
'in' => 'path',
+ 'schema' => ['type' => 'string', 'required' => true],
+ ],
+ [
+ 'name' => 'body',
+ 'in' => 'body',
+ 'style' => 'json',
+ 'schema' => [
+ 'type' => 'object',
+ 'properties' => [
+ 'input' => [
+ 'type' => 'object',
+ 'properties' => [
+ 'file_name' => ['type' => 'string', 'required' => false],
+ 'oss' => ['type' => 'string', 'required' => false],
+ 'url' => ['type' => 'string', 'required' => false],
+ ],
+ 'required' => false,
+ ],
+ 'output' => [
+ 'type' => 'object',
+ 'properties' => [
+ 'type' => ['type' => 'string', 'required' => false],
+ 'oss' => ['type' => 'string', 'required' => false],
+ ],
+ 'required' => false,
+ ],
+ 'parameters' => ['type' => 'object', 'required' => false],
+ ],
+ 'required' => false,
+ ],
+ ],
+ ],
+ 'responses' => [
+ 200 => [
'schema' => [
- 'type' => 'string',
+ 'type' => 'object',
+ 'properties' => [
+ 'request_id' => ['type' => 'string'],
+ 'latency' => ['type' => 'integer', 'format' => 'int32'],
+ 'result' => [
+ 'type' => 'object',
+ 'properties' => [
+ 'task_id' => ['type' => 'string'],
+ ],
+ ],
+ ],
],
],
+ ],
+ 'staticInfo' => ['returnType' => 'synchronous'],
+ 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"request_id\\": \\"\\",\\n \\"latency\\": 0,\\n \\"result\\": {\\n \\"task_id\\": \\"\\"\\n }\\n}","type":"json"}]',
+ 'title' => '创建视频切割异步任务',
+ ],
+ 'CreateVideoSummarizationTask' => [
+ 'summary' => '创建视频总结异步任务',
+ 'path' => '/v3/openapi/workspaces/{workspace_name}/video-summarization/{service_id}/async',
+ 'methods' => ['post'],
+ 'schemes' => ['http', 'https'],
+ 'security' => [
+ [
+ 'BearerToken' => [],
+ ],
+ ],
+ 'consumes' => ['application/json'],
+ 'produces' => ['application/json'],
+ 'operationType' => 'write',
+ 'deprecated' => false,
+ 'systemTags' => ['operationType' => 'none', 'riskType' => 'none', 'chargeType' => 'paid'],
+ 'parameters' => [
+ [
+ 'name' => 'workspace_name',
+ 'in' => 'path',
+ 'schema' => ['type' => 'string', 'required' => true],
+ ],
+ [
+ 'name' => 'service_id',
+ 'in' => 'path',
+ 'schema' => ['type' => 'string', 'required' => true],
+ ],
[
'name' => 'body',
'in' => 'body',
@@ -1529,55 +1946,224 @@
'type' => 'object',
'properties' => [
'input' => [
- 'type' => 'array',
- 'items' => [
- 'type' => 'array',
- 'items' => [
- 'type' => 'number',
- 'format' => 'float',
+ 'type' => 'object',
+ 'properties' => [
+ 'file_name' => ['type' => 'string', 'required' => false],
+ 'oss' => ['type' => 'string', 'required' => false],
+ 'url' => ['type' => 'string', 'required' => false],
+ 'chunks' => [
+ 'type' => 'array',
+ 'items' => [
+ 'type' => 'object',
+ 'properties' => [
+ 'start_time' => ['type' => 'number', 'format' => 'float', 'required' => false],
+ 'end_time' => ['type' => 'number', 'format' => 'float', 'required' => false],
+ 'transcript' => ['type' => 'string', 'required' => false],
+ 'snapshots' => [
+ 'type' => 'array',
+ 'items' => [
+ 'type' => 'object',
+ 'properties' => [
+ 'frame_index' => ['type' => 'integer', 'format' => 'int32', 'required' => false],
+ 'path' => ['type' => 'string', 'required' => false],
+ 'frame_time' => ['type' => 'number', 'format' => 'float', 'required' => false],
+ ],
+ 'required' => false,
+ ],
+ 'required' => false,
+ ],
+ ],
+ 'required' => false,
+ ],
+ 'required' => false,
],
],
+ 'required' => false,
],
- 'parameters' => [
+ 'output' => [
'type' => 'object',
+ 'properties' => [
+ 'type' => ['type' => 'string', 'required' => false],
+ 'oss' => ['type' => 'string', 'required' => false],
+ ],
+ 'required' => false,
],
+ 'parameters' => ['type' => 'object', 'required' => false],
],
+ 'required' => false,
],
],
],
'responses' => [
200 => [
'schema' => [
- 'title' => 'Schema of Response',
'type' => 'object',
'properties' => [
- 'request_id' => [
- 'title' => 'Id of the request',
- 'type' => 'string',
+ 'request_id' => ['type' => 'string'],
+ 'latency' => ['type' => 'integer', 'format' => 'int32'],
+ 'result' => [
+ 'type' => 'object',
+ 'properties' => [
+ 'task_id' => ['type' => 'string'],
+ ],
],
- 'latency' => [
- 'type' => 'integer',
- 'format' => 'int32',
+ ],
+ ],
+ ],
+ ],
+ 'staticInfo' => ['returnType' => 'synchronous'],
+ 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"request_id\\": \\"\\",\\n \\"latency\\": 0,\\n \\"result\\": {\\n \\"task_id\\": \\"\\"\\n }\\n}","type":"json"}]',
+ ],
+ 'UpdateMemorySkill' => [
+ 'summary' => '更新 Skill',
+ 'path' => '/v3/openapi/workspaces/{workspace_name}/memory/{service_id}/skills/{skill_id}',
+ 'methods' => ['put'],
+ 'schemes' => ['http', 'https'],
+ 'security' => [
+ [
+ 'BearerToken' => [],
+ ],
+ ],
+ 'consumes' => ['application/json'],
+ 'produces' => ['application/json'],
+ 'operationType' => 'write',
+ 'deprecated' => false,
+ 'systemTags' => ['operationType' => 'none', 'riskType' => 'none', 'chargeType' => 'paid'],
+ 'parameters' => [
+ [
+ 'name' => 'workspace_name',
+ 'in' => 'path',
+ 'schema' => ['type' => 'string', 'required' => true],
+ ],
+ [
+ 'name' => 'service_id',
+ 'in' => 'path',
+ 'schema' => ['type' => 'string', 'required' => true],
+ ],
+ [
+ 'name' => 'skill_id',
+ 'in' => 'path',
+ 'schema' => ['type' => 'string', 'required' => true],
+ ],
+ [
+ 'name' => 'body',
+ 'in' => 'body',
+ 'style' => 'json',
+ 'schema' => [
+ 'type' => 'object',
+ 'properties' => [
+ 'name' => ['type' => 'string'],
+ 'version' => ['type' => 'string'],
+ 'files' => [
+ 'type' => 'object',
+ 'additionalProperties' => ['type' => 'string'],
],
- 'usage' => [
+ 'user_id' => ['type' => 'string'],
+ 'agent_id' => ['type' => 'string'],
+ ],
+ ],
+ ],
+ ],
+ 'responses' => [
+ 200 => [
+ 'schema' => [
+ 'type' => 'object',
+ 'properties' => [
+ 'request_id' => ['type' => 'string'],
+ 'latency' => ['type' => 'integer', 'format' => 'int32'],
+ 'status' => ['type' => 'string'],
+ 'result' => [
'type' => 'object',
'properties' => [
- 'doc_count' => [
- 'type' => 'integer',
- 'format' => 'int32',
+ 'name' => ['type' => 'string'],
+ 'version' => ['type' => 'string'],
+ 'files' => [
+ 'type' => 'object',
+ 'additionalProperties' => ['type' => 'string'],
],
],
],
+ ],
+ ],
+ ],
+ ],
+ 'staticInfo' => ['returnType' => 'synchronous'],
+ ],
+ 'CreateMemorySkill' => [
+ 'summary' => '上传skill',
+ 'path' => '/v3/openapi/workspaces/{workspace_name}/memory/{service_id}/skills',
+ 'methods' => ['post'],
+ 'schemes' => ['http', 'https'],
+ 'security' => [
+ [
+ 'BearerToken' => [],
+ ],
+ ],
+ 'consumes' => ['application/json'],
+ 'produces' => ['application/json'],
+ 'operationType' => 'write',
+ 'deprecated' => false,
+ 'systemTags' => ['operationType' => 'none', 'riskType' => 'none', 'chargeType' => 'paid'],
+ 'parameters' => [
+ [
+ 'name' => 'workspace_name',
+ 'in' => 'path',
+ 'schema' => ['type' => 'string', 'required' => true],
+ ],
+ [
+ 'name' => 'service_id',
+ 'in' => 'path',
+ 'schema' => ['type' => 'string', 'required' => true],
+ ],
+ [
+ 'name' => 'body',
+ 'in' => 'body',
+ 'style' => 'json',
+ 'schema' => [
+ 'type' => 'object',
+ 'properties' => [
+ 'zip_base64' => ['type' => 'string'],
+ 'user_id' => ['type' => 'string'],
+ 'agent_id' => ['type' => 'string'],
+ ],
+ ],
+ ],
+ ],
+ 'responses' => [
+ 200 => [
+ 'schema' => [
+ 'type' => 'object',
+ 'properties' => [
+ 'request_id' => ['type' => 'string'],
+ 'latency' => ['type' => 'integer', 'format' => 'int32'],
+ 'status' => ['type' => 'string'],
'result' => [
'type' => 'object',
'properties' => [
- 'output' => [
+ 'imported_count' => ['type' => 'integer', 'format' => 'int32'],
+ 'data' => [
'type' => 'array',
'items' => [
- 'type' => 'array',
- 'items' => [
- 'type' => 'number',
- 'format' => 'float',
+ 'type' => 'object',
+ 'properties' => [
+ 'id' => ['type' => 'string'],
+ 'name' => ['type' => 'string'],
+ 'description' => ['type' => 'string'],
+ 'version' => ['type' => 'string'],
+ 'owner' => ['type' => 'string'],
+ 'tags' => [
+ 'type' => 'array',
+ 'items' => ['type' => 'string'],
+ ],
+ 'triggers' => [
+ 'type' => 'array',
+ 'items' => ['type' => 'string'],
+ ],
+ 'resource_paths' => [
+ 'type' => 'array',
+ 'items' => ['type' => 'string'],
+ ],
+ 'updated_at' => ['type' => 'string'],
],
],
],
@@ -1587,84 +2173,650 @@
],
],
],
- 'staticInfo' => [
- 'returnType' => 'synchronous',
+ 'staticInfo' => ['returnType' => 'synchronous'],
+ ],
+ 'SearchMemory' => [
+ 'summary' => '根据查询条件搜索 Memory',
+ 'path' => '/v3/openapi/workspaces/{workspace_name}/memory/{service_id}/search',
+ 'methods' => ['post'],
+ 'schemes' => ['http', 'https'],
+ 'security' => [
+ [
+ 'BearerToken' => [],
+ ],
],
- 'eventInfo' => [
- 'enable' => false,
- 'eventNames' => [],
+ 'consumes' => ['application/json'],
+ 'produces' => ['application/json'],
+ 'operationType' => 'read',
+ 'deprecated' => false,
+ 'systemTags' => ['operationType' => 'none', 'riskType' => 'none', 'chargeType' => 'paid'],
+ 'parameters' => [
+ [
+ 'name' => 'workspace_name',
+ 'in' => 'path',
+ 'schema' => ['type' => 'string', 'required' => true],
+ ],
+ [
+ 'name' => 'service_id',
+ 'in' => 'path',
+ 'schema' => ['type' => 'string', 'required' => true],
+ ],
+ [
+ 'name' => 'body',
+ 'in' => 'body',
+ 'style' => 'json',
+ 'schema' => [
+ 'type' => 'object',
+ 'properties' => [
+ 'query' => ['type' => 'string', 'required' => true],
+ 'user_id' => ['type' => 'string'],
+ 'agent_id' => ['type' => 'string'],
+ 'run_id' => ['type' => 'string'],
+ 'size' => ['type' => 'integer', 'format' => 'int32'],
+ 'enhancements' => [
+ 'type' => 'object',
+ 'additionalProperties' => ['type' => 'any'],
+ ],
+ ],
+ ],
+ ],
+ ],
+ 'responses' => [
+ 200 => [
+ 'schema' => [
+ 'type' => 'object',
+ 'properties' => [
+ 'request_id' => ['type' => 'string'],
+ 'latency' => ['type' => 'integer', 'format' => 'int32'],
+ 'status' => ['type' => 'string'],
+ 'result' => [
+ 'type' => 'object',
+ 'properties' => [
+ 'memory' => [
+ 'type' => 'object',
+ 'properties' => [
+ 'total' => ['type' => 'integer', 'format' => 'int32'],
+ 'results' => [
+ 'type' => 'array',
+ 'items' => [
+ 'type' => 'object',
+ 'properties' => [
+ 'memory_id' => ['type' => 'string'],
+ 'memory' => ['type' => 'string'],
+ 'user_id' => ['type' => 'string'],
+ 'agent_id' => ['type' => 'string'],
+ ],
+ ],
+ ],
+ ],
+ ],
+ 'skill' => [
+ 'type' => 'object',
+ 'properties' => [
+ 'total' => ['type' => 'integer', 'format' => 'int32'],
+ 'results' => [
+ 'type' => 'array',
+ 'items' => [
+ 'type' => 'object',
+ 'properties' => [
+ 'skill_id' => ['type' => 'string'],
+ 'name' => ['type' => 'string'],
+ 'description' => ['type' => 'string'],
+ 'version' => ['type' => 'string'],
+ 'user_id' => ['type' => 'string'],
+ 'agent_id' => ['type' => 'string'],
+ ],
+ ],
+ ],
+ ],
+ ],
+ ],
+ ],
+ ],
+ ],
+ ],
],
],
- 'GetPrediction' => [
- 'summary' => '获取推理结果',
- 'path' => '/v3/openapi/deployments/{deployment_id}/predict',
- 'methods' => [
- 'post',
+ 'DeleteMemory' => [
+ 'summary' => '删除一条 Memory',
+ 'path' => '/v3/openapi/workspaces/{workspace_name}/memory/{service_id}/memories/{memory_id}',
+ 'methods' => ['delete'],
+ 'schemes' => ['http', 'https'],
+ 'security' => [
+ [
+ 'BearerToken' => [],
+ ],
],
- 'schemes' => [
- 'http',
- 'https',
+ 'consumes' => ['application/json'],
+ 'produces' => ['application/json'],
+ 'operationType' => 'write',
+ 'deprecated' => false,
+ 'systemTags' => ['operationType' => 'none', 'riskType' => 'none', 'chargeType' => 'paid'],
+ 'parameters' => [
+ [
+ 'name' => 'workspace_name',
+ 'in' => 'path',
+ 'schema' => ['type' => 'string', 'required' => true],
+ ],
+ [
+ 'name' => 'service_id',
+ 'in' => 'path',
+ 'schema' => ['type' => 'string', 'required' => true],
+ ],
+ [
+ 'name' => 'memory_id',
+ 'in' => 'path',
+ 'schema' => ['type' => 'string', 'required' => true],
+ ],
],
+ 'responses' => [
+ 200 => [
+ 'schema' => [
+ 'type' => 'object',
+ 'properties' => [
+ 'request_id' => ['type' => 'string'],
+ 'latency' => ['type' => 'integer', 'format' => 'int32'],
+ 'status' => ['type' => 'string'],
+ 'result' => [
+ 'type' => 'object',
+ 'properties' => [
+ 'status' => ['type' => 'string'],
+ 'memory_id' => ['type' => 'string'],
+ 'message' => ['type' => 'string'],
+ ],
+ ],
+ ],
+ ],
+ ],
+ ],
+ 'staticInfo' => ['returnType' => 'synchronous'],
+ ],
+ 'GetMemory' => [
+ 'summary' => '查看memory详情',
+ 'path' => '/v3/openapi/workspaces/{workspace_name}/memory/{service_id}/memories/{memory_id}',
+ 'methods' => ['get'],
+ 'schemes' => ['http', 'https'],
'security' => [
[
'BearerToken' => [],
],
],
- 'consumes' => [
- 'application/json',
- ],
- 'produces' => [],
+ 'consumes' => ['application/json'],
+ 'produces' => ['application/json'],
'operationType' => 'read',
'deprecated' => false,
- 'systemTags' => [
- 'operationType' => 'none',
- 'riskType' => 'none',
- 'chargeType' => 'paid',
+ 'systemTags' => ['operationType' => 'none', 'riskType' => 'none', 'chargeType' => 'paid'],
+ 'parameters' => [
+ [
+ 'name' => 'workspace_name',
+ 'in' => 'path',
+ 'schema' => ['type' => 'string', 'required' => true],
+ ],
+ [
+ 'name' => 'service_id',
+ 'in' => 'path',
+ 'schema' => ['type' => 'string', 'required' => true],
+ ],
+ [
+ 'name' => 'memory_id',
+ 'in' => 'path',
+ 'schema' => ['type' => 'string', 'required' => true],
+ ],
+ ],
+ 'responses' => [
+ 200 => [
+ 'schema' => [
+ 'type' => 'object',
+ 'properties' => [
+ 'request_id' => ['type' => 'string'],
+ 'latency' => ['type' => 'integer', 'format' => 'int32'],
+ 'status' => ['type' => 'string'],
+ 'result' => [
+ 'type' => 'object',
+ 'properties' => [
+ 'memory_id' => ['type' => 'string'],
+ 'memory' => ['type' => 'string'],
+ 'user_id' => ['type' => 'string'],
+ 'agent_id' => ['type' => 'string'],
+ ],
+ ],
+ ],
+ ],
+ ],
+ ],
+ 'staticInfo' => ['returnType' => 'synchronous'],
+ ],
+ 'GetMemoryTask' => [
+ 'summary' => '查询memory异步任务的处理状态',
+ 'path' => '/v3/openapi/workspaces/{workspace_name}/memory/{service_id}/tasks/{task_id}',
+ 'methods' => ['get'],
+ 'schemes' => ['http', 'https'],
+ 'security' => [
+ [
+ 'BearerToken' => [],
+ ],
+ ],
+ 'consumes' => ['application/json'],
+ 'produces' => ['application/json'],
+ 'operationType' => 'write',
+ 'deprecated' => false,
+ 'systemTags' => ['operationType' => 'none', 'riskType' => 'none', 'chargeType' => 'paid'],
+ 'parameters' => [
+ [
+ 'name' => 'workspace_name',
+ 'in' => 'path',
+ 'schema' => ['type' => 'string', 'required' => true],
+ ],
+ [
+ 'name' => 'service_id',
+ 'in' => 'path',
+ 'schema' => ['type' => 'string', 'required' => true],
+ ],
+ [
+ 'name' => 'task_id',
+ 'in' => 'path',
+ 'schema' => ['type' => 'string', 'required' => true],
+ ],
],
+ 'responses' => [
+ 200 => [
+ 'schema' => [
+ 'type' => 'object',
+ 'properties' => [
+ 'request_id' => ['type' => 'string'],
+ 'latency' => ['type' => 'integer', 'format' => 'int32'],
+ 'status' => ['type' => 'string'],
+ 'result' => [
+ 'type' => 'object',
+ 'properties' => [
+ 'task_id' => ['type' => 'string'],
+ 'status' => ['type' => 'string'],
+ 'memory_ids' => [
+ 'type' => 'array',
+ 'items' => ['type' => 'string'],
+ ],
+ 'skill_ids' => [
+ 'type' => 'array',
+ 'items' => ['type' => 'string'],
+ ],
+ 'error_message' => ['type' => 'string'],
+ ],
+ ],
+ ],
+ ],
+ ],
+ ],
+ 'staticInfo' => ['returnType' => 'synchronous'],
+ ],
+ 'GetMemoryHealth' => [
+ 'summary' => '检查 Memory 服务健康状态',
+ 'path' => '/v3/openapi/workspaces/{workspace_name}/memory/{service_id}/health',
+ 'methods' => ['get'],
+ 'schemes' => ['http', 'https'],
+ 'security' => [
+ [
+ 'BearerToken' => [],
+ ],
+ ],
+ 'consumes' => ['application/json'],
+ 'produces' => ['application/json'],
+ 'operationType' => 'write',
+ 'deprecated' => false,
+ 'systemTags' => ['operationType' => 'none', 'riskType' => 'none', 'chargeType' => 'paid'],
'parameters' => [
[
- 'name' => 'deployment_id',
+ 'name' => 'workspace_name',
'in' => 'path',
+ 'schema' => ['type' => 'string', 'required' => true],
+ ],
+ [
+ 'name' => 'service_id',
+ 'in' => 'path',
+ 'schema' => ['type' => 'string', 'required' => true],
+ ],
+ ],
+ 'responses' => [
+ 200 => [
+ 'schema' => [
+ 'type' => 'object',
+ 'properties' => [
+ 'request_id' => ['type' => 'string'],
+ 'latency' => ['type' => 'integer', 'format' => 'int32'],
+ 'result' => [
+ 'type' => 'object',
+ 'properties' => [
+ 'status' => ['type' => 'string'],
+ ],
+ ],
+ 'status' => ['type' => 'string'],
+ ],
+ ],
+ ],
+ ],
+ 'staticInfo' => ['returnType' => 'synchronous'],
+ ],
+ 'CreateMemory' => [
+ 'summary' => '存储 Memory 内容',
+ 'path' => '/v3/openapi/workspaces/{workspace_name}/memory/{service_id}/memories',
+ 'methods' => ['post'],
+ 'schemes' => ['http', 'https'],
+ 'security' => [
+ [
+ 'BearerToken' => [],
+ ],
+ ],
+ 'consumes' => ['application/json'],
+ 'produces' => ['application/json'],
+ 'operationType' => 'write',
+ 'deprecated' => false,
+ 'systemTags' => ['operationType' => 'none', 'riskType' => 'none', 'chargeType' => 'paid'],
+ 'parameters' => [
+ [
+ 'name' => 'workspace_name',
+ 'in' => 'path',
+ 'schema' => ['type' => 'string', 'required' => true],
+ ],
+ [
+ 'name' => 'service_id',
+ 'in' => 'path',
+ 'schema' => ['type' => 'string', 'required' => true],
+ ],
+ [
+ 'name' => 'body',
+ 'in' => 'body',
+ 'style' => 'json',
+ 'schema' => [
+ 'type' => 'object',
+ 'properties' => [
+ 'messages' => ['type' => 'any'],
+ 'user_id' => ['type' => 'string'],
+ 'agent_id' => ['type' => 'string'],
+ 'run_id' => ['type' => 'string'],
+ 'enhancements' => [
+ 'type' => 'object',
+ 'additionalProperties' => ['type' => 'any'],
+ ],
+ ],
+ ],
+ ],
+ ],
+ 'responses' => [
+ 200 => [
'schema' => [
- 'type' => 'string',
- 'required' => true,
+ 'type' => 'object',
+ 'properties' => [
+ 'request_id' => ['type' => 'string'],
+ 'latency' => ['type' => 'integer', 'format' => 'int32'],
+ 'status' => ['type' => 'string'],
+ 'result' => [
+ 'type' => 'object',
+ 'properties' => [
+ 'memory' => [
+ 'type' => 'object',
+ 'properties' => [
+ 'task_id' => ['type' => 'string'],
+ ],
+ ],
+ 'skill' => [
+ 'type' => 'object',
+ 'properties' => [
+ 'task_id' => ['type' => 'string'],
+ ],
+ ],
+ ],
+ ],
+ ],
],
],
+ ],
+ 'staticInfo' => ['returnType' => 'synchronous'],
+ ],
+ 'UpdateMemory' => [
+ 'summary' => '更新 Memory',
+ 'path' => '/v3/openapi/workspaces/{workspace_name}/memory/{service_id}/memories/{memory_id}',
+ 'methods' => ['put'],
+ 'schemes' => ['http', 'https'],
+ 'security' => [
+ [
+ 'BearerToken' => [],
+ ],
+ ],
+ 'consumes' => ['application/json'],
+ 'produces' => ['application/json'],
+ 'operationType' => 'write',
+ 'deprecated' => false,
+ 'systemTags' => ['operationType' => 'none', 'riskType' => 'none', 'chargeType' => 'paid'],
+ 'parameters' => [
+ [
+ 'name' => 'workspace_name',
+ 'in' => 'path',
+ 'schema' => ['type' => 'string', 'required' => true],
+ ],
+ [
+ 'name' => 'service_id',
+ 'in' => 'path',
+ 'schema' => ['type' => 'string', 'required' => true],
+ ],
+ [
+ 'name' => 'memory_id',
+ 'in' => 'path',
+ 'schema' => ['type' => 'string'],
+ ],
[
'name' => 'body',
'in' => 'body',
+ 'style' => 'json',
'schema' => [
- 'type' => 'string',
+ 'type' => 'object',
+ 'properties' => [
+ 'memory' => ['type' => 'string'],
+ ],
+ ],
+ ],
+ ],
+ 'responses' => [
+ 200 => [
+ 'schema' => [
+ 'type' => 'object',
+ 'properties' => [
+ 'request_id' => ['type' => 'string'],
+ 'latency' => ['type' => 'integer', 'format' => 'int32'],
+ 'status' => ['type' => 'string'],
+ 'result' => [
+ 'type' => 'object',
+ 'properties' => [
+ 'memory_id' => ['type' => 'string'],
+ 'memory' => ['type' => 'string'],
+ 'message' => ['type' => 'string'],
+ ],
+ ],
+ ],
],
],
+ ],
+ 'staticInfo' => ['returnType' => 'synchronous'],
+ ],
+ 'GetMemorySkill' => [
+ 'summary' => '查看skill详情',
+ 'path' => '/v3/openapi/workspaces/{workspace_name}/memory/{service_id}/skills/{skill_id}',
+ 'methods' => ['get'],
+ 'schemes' => ['http', 'https'],
+ 'security' => [
[
- 'name' => 'Token',
- 'in' => 'header',
+ 'BearerToken' => [],
+ ],
+ ],
+ 'consumes' => ['application/json'],
+ 'produces' => ['application/json'],
+ 'operationType' => 'read',
+ 'deprecated' => false,
+ 'systemTags' => ['operationType' => 'none', 'riskType' => 'none', 'chargeType' => 'paid'],
+ 'parameters' => [
+ [
+ 'name' => 'workspace_name',
+ 'in' => 'path',
+ 'schema' => ['type' => 'string', 'required' => true],
+ ],
+ [
+ 'name' => 'service_id',
+ 'in' => 'path',
+ 'schema' => ['type' => 'string', 'required' => true],
+ ],
+ [
+ 'name' => 'skill_id',
+ 'in' => 'path',
+ 'schema' => ['type' => 'string', 'required' => true],
+ ],
+ ],
+ 'responses' => [
+ 200 => [
'schema' => [
- 'type' => 'string',
+ 'type' => 'object',
+ 'properties' => [
+ 'request_id' => ['type' => 'string'],
+ 'latency' => ['type' => 'integer', 'format' => 'int32'],
+ 'status' => ['type' => 'string'],
+ 'result' => [
+ 'type' => 'object',
+ 'properties' => [
+ 'skill_id' => ['type' => 'string'],
+ 'name' => ['type' => 'string'],
+ 'files' => ['type' => 'string'],
+ 'agent_id' => ['type' => 'string'],
+ 'user_id' => ['type' => 'string'],
+ ],
+ ],
+ ],
],
],
],
+ 'staticInfo' => ['returnType' => 'synchronous'],
+ ],
+ 'DeleteMemorySkill' => [
+ 'summary' => '删除skill',
+ 'path' => '/v3/openapi/workspaces/{workspace_name}/memory/{service_id}/skills/{skill_id}',
+ 'methods' => ['delete'],
+ 'schemes' => ['http', 'https'],
+ 'security' => [
+ [
+ 'BearerToken' => [],
+ ],
+ ],
+ 'consumes' => ['application/json'],
+ 'produces' => ['application/json'],
+ 'operationType' => 'write',
+ 'deprecated' => false,
+ 'systemTags' => ['operationType' => 'none', 'riskType' => 'none', 'chargeType' => 'paid'],
+ 'parameters' => [
+ [
+ 'name' => 'workspace_name',
+ 'in' => 'path',
+ 'schema' => ['type' => 'string'],
+ ],
+ [
+ 'name' => 'service_id',
+ 'in' => 'path',
+ 'schema' => ['type' => 'string'],
+ ],
+ [
+ 'name' => 'skill_id',
+ 'in' => 'path',
+ 'schema' => ['type' => 'string'],
+ ],
+ ],
'responses' => [
200 => [
'schema' => [
- 'type' => 'string',
+ 'type' => 'object',
+ 'properties' => [
+ 'request_id' => ['type' => 'string'],
+ 'latency' => ['type' => 'integer', 'format' => 'int32'],
+ 'status' => ['type' => 'string'],
+ 'result' => [
+ 'type' => 'object',
+ 'properties' => [
+ 'status' => ['type' => 'string'],
+ 'skill_id' => ['type' => 'string'],
+ 'message' => ['type' => 'string'],
+ ],
+ ],
+ ],
],
],
],
- 'staticInfo' => [
- 'returnType' => 'synchronous',
+ 'staticInfo' => ['returnType' => 'synchronous'],
+ ],
+ 'GetJinaAiReader' => [
+ 'summary' => '获取JinaAiReader解析结果',
+ 'path' => '/v3/openapi/workspaces/{workspace_name}/jina-ai-reader/{service_id}',
+ 'methods' => ['post'],
+ 'schemes' => ['https'],
+ 'security' => [
+ [
+ 'BearerToken' => [],
+ ],
],
+ 'consumes' => ['application/json'],
+ 'produces' => ['application/json'],
+ 'operationType' => 'read',
+ 'deprecated' => false,
+ 'systemTags' => ['operationType' => 'none', 'riskType' => 'none', 'chargeType' => 'paid'],
+ 'parameters' => [
+ [
+ 'name' => 'workspace_name',
+ 'in' => 'path',
+ 'schema' => ['type' => 'string'],
+ ],
+ [
+ 'name' => 'service_id',
+ 'in' => 'path',
+ 'schema' => ['type' => 'string'],
+ ],
+ [
+ 'name' => 'body',
+ 'in' => 'body',
+ 'style' => 'json',
+ 'schema' => [
+ 'type' => 'object',
+ 'properties' => [
+ 'url' => ['type' => 'string'],
+ ],
+ ],
+ ],
+ ],
+ 'responses' => [
+ 200 => [
+ 'schema' => [
+ 'title' => 'Schema of Response',
+ 'type' => 'object',
+ 'properties' => [
+ 'request_id' => ['title' => 'Id of the request', 'type' => 'string'],
+ 'latency' => ['type' => 'integer', 'format' => 'int32'],
+ 'result' => [
+ 'type' => 'object',
+ 'properties' => [
+ 'content' => ['type' => 'string'],
+ 'meta' => [
+ 'type' => 'object',
+ 'additionalProperties' => ['type' => 'string'],
+ ],
+ ],
+ ],
+ 'usage' => [
+ 'type' => 'object',
+ 'properties' => [
+ 'token_count' => ['type' => 'integer', 'format' => 'int32'],
+ ],
+ ],
+ ],
+ ],
+ ],
+ ],
+ 'staticInfo' => ['returnType' => 'synchronous'],
],
],
'endpoints' => [
- [
- 'regionId' => 'cn-shanghai',
- 'endpoint' => 'searchplat.cn-shanghai.aliyuncs.com',
- ],
- [
- 'regionId' => 'eu-central-1',
- 'endpoint' => 'searchplat.eu-central-1.aliyuncs.com',
- ],
+ ['regionId' => 'cn-shanghai', 'endpoint' => 'searchplat.cn-shanghai.aliyuncs.com'],
+ ['regionId' => 'eu-central-1', 'endpoint' => 'searchplat.eu-central-1.aliyuncs.com'],
],
];
generated by cgit v1.2.3 (git 2.46.0) at 2026-07-12 17:53:02 +0000