From 7347bac4ab7e136157fc94777e6cf87ef9e08599 Mon Sep 17 00:00:00 2001 From: Zhineng Li Date: Fri, 13 Feb 2026 10:54:11 +0800 Subject: first commit --- data/zh_cn/searchplat/2024-04-01/api-docs.php | 8691 +++++++++++++++++++++++++ 1 file changed, 8691 insertions(+) create mode 100644 data/zh_cn/searchplat/2024-04-01/api-docs.php (limited to 'data/zh_cn/searchplat/2024-04-01/api-docs.php') diff --git a/data/zh_cn/searchplat/2024-04-01/api-docs.php b/data/zh_cn/searchplat/2024-04-01/api-docs.php new file mode 100644 index 0000000..58d9b3e --- /dev/null +++ b/data/zh_cn/searchplat/2024-04-01/api-docs.php @@ -0,0 +1,8691 @@ + '1.0', + 'info' => [ + 'style' => 'ROA', + 'product' => 'Searchplat', + 'version' => '2024-04-01', + ], + 'directories' => [ + [ + 'id' => 209161, + 'title' => '工作空间', + 'type' => 'directory', + 'children' => [ + 'CreateWorkspace', + 'UpdateWorkspace', + 'GetWorkspace', + 'ListWorkspaces', + 'DeleteWorkspace', + ], + ], + [ + 'id' => 209167, + 'title' => '访问凭证', + 'type' => 'directory', + 'children' => [ + 'UpdateCredentials', + 'CreateCredentials', + 'DeleteCredentials', + 'GetCredentials', + 'ListCredentials', + ], + ], + [ + 'id' => 209142, + 'title' => '体验数据', + 'type' => 'directory', + 'children' => [ + 'GetExperienceData', + 'DeleteExperienceData', + 'CreateExperienceData', + 'ListExperienceData', + ], + ], + [ + 'id' => 209147, + 'title' => '异步任务', + 'type' => 'directory', + 'children' => [ + 'ListAsyncTasks', + 'GetAsyncTask', + 'CreateAsyncTask', + ], + ], + [ + 'id' => 209151, + 'title' => '模型服务', + 'type' => 'directory', + 'children' => [ + 'ResumeFunctionInstance', + 'UpdateFunctionInstance', + 'ListFunctionInstances', + 'CeaseFunctionInstance', + 'CreateFunctionInstance', + 'CreateFunctionTask', + 'DeleteFunctionInstance', + 'GetFunctionInstance', + 'ListFunctionRestrictions', + ], + ], + [ + 'id' => 209137, + 'title' => '评测服务', + 'type' => 'directory', + 'children' => [ + 'DeleteRagEvaluatorTask', + 'CreateRagEvaluatorTask', + 'CreateRagEvaluatorTask', + 'GetRagEvaluatorTask', + 'ListRagEvaluatorTasks', + ], + ], + [ + 'id' => 220397, + 'title' => '离线任务', + 'type' => 'directory', + 'children' => [ + 'StopOfflineTask', + 'StartOfflineTask', + 'ListOfflineTask', + 'ModifyOfflineTask', + 'CreateOfflineTask', + 'GetOfflineTask', + 'DeleteOfflineTask', + ], + ], + [ + 'id' => 344252, + 'title' => '知识库配置', + 'type' => 'directory', + 'children' => [ + 'UpdateCapability', + 'ListCapabilities', + 'DescribeCapability', + 'DeleteCapability', + 'CreateCapability', + ], + ], + [ + 'id' => 278727, + 'title' => '数据源', + 'type' => 'directory', + 'children' => [ + 'GetTableFields', + ], + ], + [ + 'id' => 209173, + 'title' => '其他', + 'type' => 'directory', + 'children' => [ + 'DescribeRegions', + 'ListServices', + 'GetTables', + 'GetTableColumns', + ], + ], + ], + 'components' => [ + 'schemas' => [], + ], + 'apis' => [ + 'CreateWorkspace' => [ + 'summary' => '创建工作空间', + 'path' => '/openapi/platform/workspaces', + 'methods' => [ + 'post', + ], + 'schemes' => [ + 'http', + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'operationType' => 'write', + 'deprecated' => false, + 'systemTags' => [ + 'operationType' => 'none', + 'riskType' => 'none', + 'chargeType' => 'free', + 'abilityTreeCode' => '218195', + 'abilityTreeNodes' => [ + 'FEATUREopensearch2ESE2N', + ], + ], + 'parameters' => [ + [ + 'name' => 'body', + 'in' => 'body', + 'style' => 'json', + 'schema' => [ + 'description' => '请求body。', + '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', + ], + ], + 'required' => false, + ], + ], + ], + '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' => '2BA0504F-B179-586D-8210-A7C7C09A9907', + ], + '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', + ], + ], + ], + ], + ], + ], + ], + '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' => '创建工作空间', + ], + 'UpdateWorkspace' => [ + 'summary' => '更新工作空间。', + 'path' => '/openapi/platform/workspaces/{workspaceName}', + 'methods' => [ + 'put', + ], + 'schemes' => [ + 'http', + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'operationType' => 'write', + 'deprecated' => false, + 'systemTags' => [ + 'operationType' => 'none', + 'riskType' => 'none', + 'chargeType' => 'free', + 'abilityTreeCode' => '218191', + 'abilityTreeNodes' => [ + 'FEATUREopensearch8B42ZS', + ], + ], + 'parameters' => [ + [ + 'name' => 'workspaceName', + 'in' => 'path', + 'schema' => [ + 'description' => '工作空间名称', + 'type' => 'string', + 'required' => true, + 'example' => 'default', + ], + ], + [ + 'name' => 'body', + 'in' => 'body', + 'style' => 'json', + 'schema' => [ + 'description' => '请求结构体。', + 'type' => 'object', + 'properties' => [ + 'description' => [ + 'description' => '描述', + 'type' => 'string', + 'required' => false, + 'example' => 'test2024106271022', + ], + 'resourceGroupId' => [ + 'description' => '资源组ID', + 'type' => 'string', + 'required' => false, + 'example' => 'rg-aekzivjfrlpyn3y', + ], + ], + 'required' => false, + ], + ], + ], + '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' => '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', + ], + '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', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'operationType' => 'read', + 'deprecated' => false, + 'systemTags' => [ + 'operationType' => 'none', + 'riskType' => 'none', + 'chargeType' => 'free', + 'abilityTreeCode' => '218193', + 'abilityTreeNodes' => [ + 'FEATUREopensearchGVH0IN', + ], + ], + 'parameters' => [ + [ + 'name' => 'workspaceName', + 'in' => 'path', + 'schema' => [ + 'title' => 'A short description of struct', + 'description' => '工作空间名称', + 'type' => 'string', + 'required' => true, + 'example' => 'default', + ], + ], + ], + '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' => '58113A95-1858-5674-87E5-192AEE6FD9DD', + ], + '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', + ], + ], + ], + ], + ], + ], + ], + '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' => '查看一个工作空间详情', + ], + 'ListWorkspaces' => [ + 'summary' => '获取工作空间列表。', + 'path' => '/openapi/platform/workspaces', + 'methods' => [ + 'get', + ], + 'schemes' => [ + 'http', + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'operationType' => 'read', + 'deprecated' => false, + 'systemTags' => [ + 'operationType' => 'list', + 'riskType' => 'none', + 'chargeType' => 'free', + 'abilityTreeCode' => '218194', + 'abilityTreeNodes' => [ + 'FEATUREopensearchGVH0IN', + ], + ], + 'parameters' => [ + [ + 'name' => 'pageNumber', + 'in' => 'query', + 'schema' => [ + 'description' => '页码，默认 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' => '获取工作空间列表', + ], + 'DeleteWorkspace' => [ + 'summary' => '删除工作空间', + 'path' => '/openapi/platform/workspaces/{workspaceName}', + 'methods' => [ + 'delete', + ], + 'schemes' => [ + 'http', + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'operationType' => 'write', + 'deprecated' => false, + 'systemTags' => [ + 'operationType' => 'none', + 'riskType' => 'none', + 'chargeType' => 'free', + 'abilityTreeCode' => '218190', + 'abilityTreeNodes' => [ + 'FEATUREopensearch2ESE2N', + ], + ], + 'parameters' => [ + [ + 'name' => 'workspaceName', + 'in' => 'path', + 'schema' => [ + 'title' => 'A short description of struct', + 'description' => '工作空间名称。', + 'type' => 'string', + 'required' => true, + 'example' => 'myWorkspace', + ], + ], + ], + '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' => '5950143C-B8F0-5758-A08A-66F302FD587F', + ], + 'result' => [ + 'description' => '返回结果', + 'type' => 'object', + 'properties' => [ + 'instanceId' => [ + 'description' => '实例ID', + 'type' => 'string', + 'example' => 'ops-cn-em93wcq0s001', + ], + ], + ], + ], + ], + ], + ], + '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' => '删除工作空间', + ], + 'UpdateCredentials' => [ + 'path' => '/openapi/platform/workspaces/{workspaceName}/credentials/{token}', + 'methods' => [ + 'put', + ], + 'schemes' => [ + 'http', + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'operationType' => 'readAndWrite', + 'deprecated' => false, + 'systemTags' => [ + 'operationType' => 'none', + 'abilityTreeCode' => '220526', + 'abilityTreeNodes' => [ + 'FEATUREopensearch1AJKH0', + ], + ], + 'parameters' => [ + [ + 'name' => 'token', + 'in' => 'path', + 'schema' => [ + 'description' => '访问凭证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。', + 'type' => 'object', + 'properties' => [ + 'enabled' => [ + 'description' => '凭据是否启用。'."\n" + .'取值：'."\n" + ."\n" + .'- true：启用。 '."\n" + .'- false：禁用。', + 'type' => 'boolean', + 'required' => false, + ], + ], + 'required' => false, + ], + ], + [ + 'name' => 'workspaceName', + 'in' => 'path', + 'schema' => [ + 'description' => '工作空间名称。', + 'type' => 'string', + 'required' => true, + 'example' => 'myWorkspace', + ], + ], + ], + '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', + ], + 'result' => [ + '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', + ], + ], + ], + ], + ], + ], + ], + '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' => '更新访问凭证', + ], + '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' => '请求Body。', + 'type' => 'object', + 'properties' => [ + '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 => [ + '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' => '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-********', + ], + ], + ], + ], + ], + ], + ], + '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' => '创建访问凭证', + ], + 'DeleteCredentials' => [ + 'path' => '/openapi/platform/workspaces/{workspaceName}/credentials/{token}', + 'methods' => [ + 'delete', + ], + 'schemes' => [ + 'http', + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'operationType' => 'readAndWrite', + 'systemTags' => [ + 'operationType' => 'delete', + 'abilityTreeCode' => '220523', + 'abilityTreeNodes' => [ + 'FEATUREopensearch1AJKH0', + ], + ], + 'parameters' => [ + [ + 'name' => 'token', + 'in' => 'path', + 'schema' => [ + 'description' => '访问凭证token。', + 'type' => 'string', + 'required' => true, + 'example' => 'OS-********', + ], + ], + [ + 'name' => 'workspaceName', + 'in' => 'path', + 'schema' => [ + 'description' => '工作空间名称。', + 'type' => 'string', + 'required' => true, + 'example' => 'myWorkspace', + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'type' => 'object', + 'properties' => [ + 'requestId' => [ + 'description' => '请求id', + 'type' => 'string', + 'example' => '2423C841-91C4-5E51-B296-590D367967FC', + ], + ], + ], + ], + '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}","type":"json"}]', + 'title' => '删除访问凭证', + ], + 'GetCredentials' => [ + 'path' => '/openapi/platform/workspaces/{workspaceName}/credentials/{token}', + 'methods' => [ + 'get', + ], + 'schemes' => [ + 'http', + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'operationType' => 'read', + 'systemTags' => [ + 'operationType' => 'get', + 'abilityTreeCode' => '220524', + 'abilityTreeNodes' => [ + 'FEATUREopensearch1AJKH0', + ], + ], + 'parameters' => [ + [ + 'name' => 'token', + 'in' => 'path', + 'schema' => [ + 'description' => '访问凭证token。', + 'type' => 'string', + 'required' => true, + 'example' => 'OS-********', + ], + ], + [ + 'name' => 'workspaceName', + 'in' => 'path', + 'schema' => [ + 'description' => '工作空间名称。', + 'type' => 'string', + 'required' => true, + 'example' => 'myWorkspace', + ], + ], + ], + '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' => '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", + ], + ], + ], + ], + ], + ], + ], + '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' => '获取访问凭证详情', + ], + 'ListCredentials' => [ + 'path' => '/openapi/platform/workspaces/{workspaceName}/credentials', + 'methods' => [ + 'get', + ], + 'schemes' => [ + 'http', + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'operationType' => 'read', + 'deprecated' => false, + 'systemTags' => [ + 'operationType' => 'list', + 'abilityTreeCode' => '220525', + 'abilityTreeNodes' => [ + 'FEATUREopensearch1AJKH0', + ], + ], + 'parameters' => [ + [ + 'name' => 'pageSize', + 'in' => 'query', + 'schema' => [ + 'description' => '每页大小，默认值为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' => 'keyword', + 'in' => 'query', + 'schema' => [ + 'description' => '凭证值搜索关键词', + 'type' => 'string', + 'required' => false, + 'example' => 'OS-**', + ], + ], + [ + 'name' => 'workspaceName', + 'in' => 'path', + 'schema' => [ + 'description' => '工作空间名称。', + 'type' => 'string', + 'required' => true, + 'example' => 'myWorkspace', + ], + ], + ], + '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', + ], + ], + ], + ], + ], + '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' => '查询访问凭证列表', + ], + 'GetExperienceData' => [ + 'summary' => '获取体验数据详情。', + 'path' => '/openapi/platform/workspaces/{workspaceName}/experience-data/{id}', + 'methods' => [ + 'get', + ], + 'schemes' => [ + 'http', + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'operationType' => 'readAndWrite', + 'deprecated' => false, + 'systemTags' => [ + 'operationType' => 'get', + 'riskType' => 'none', + 'chargeType' => 'free', + 'abilityTreeCode' => '225363', + 'abilityTreeNodes' => [ + 'FEATUREopensearch1AJKH0', + ], + ], + 'parameters' => [ + [ + 'name' => 'dryRun', + 'in' => 'query', + 'schema' => [ + 'description' => '是否校验入参数据合法性，默认false。'."\n" + ."\n" + .'取值：'."\n" + ."\n" + .'- **true**'."\n" + ."\n" + .'- **false**', + 'type' => 'boolean', + 'required' => false, + 'example' => 'false', + ], + ], + [ + 'name' => 'workspaceName', + 'in' => 'path', + 'schema' => [ + 'description' => '工作空间名称', + 'type' => 'string', + 'required' => true, + 'example' => 'default', + ], + ], + [ + 'name' => 'id', + 'in' => 'path', + 'schema' => [ + 'description' => '体验数据ID', + 'type' => 'integer', + 'format' => 'int64', + 'required' => true, + 'example' => '1878', + ], + ], + ], + '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' => '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', + ], + 'requestId' => [ + 'type' => 'string', + ], + 'message' => [ + 'type' => 'string', + ], + 'httpCode' => [ + 'type' => 'integer', + 'format' => 'int32', + ], + ], + ], + ], + ], + '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', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'operationType' => 'readAndWrite', + 'deprecated' => false, + 'systemTags' => [ + 'operationType' => 'delete', + 'abilityTreeCode' => '225361', + 'abilityTreeNodes' => [ + 'FEATUREopensearch1AJKH0', + ], + ], + 'parameters' => [ + [ + 'name' => 'dryRun', + 'in' => 'query', + 'schema' => [ + 'description' => '是否为空运行请求', + 'type' => 'boolean', + 'required' => false, + 'example' => 'false', + ], + ], + [ + 'name' => 'id', + 'in' => 'path', + 'schema' => [ + 'description' => '数据id', + 'type' => 'integer', + 'format' => 'int64', + 'required' => true, + 'example' => '1956', + ], + ], + [ + 'name' => 'workspaceName', + 'in' => 'path', + 'schema' => [ + 'description' => '工作空间名称。', + 'type' => 'string', + 'required' => true, + 'example' => 'myWorkspace', + ], + ], + ], + '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' => '65C620DA-D6BE-5F56-BBCD-6F2282BB7BAD', + ], + ], + ], + ], + ], + 'staticInfo' => [ + 'returnType' => 'synchronous', + ], + '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', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'operationType' => 'readAndWrite', + 'deprecated' => false, + 'systemTags' => [ + 'operationType' => 'create', + 'riskType' => 'none', + 'chargeType' => 'free', + 'abilityTreeCode' => '225360', + 'abilityTreeNodes' => [ + 'FEATUREopensearch8B42ZS', + ], + ], + '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', + ], + ], + ], + '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' => '7ACFD0C5-61E4-5DEA-A995-8279BB99C7E4', + ], + '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', + ], + ], + ], + ], + ], + ], + ], + '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' => '创建体验数据', + ], + 'ListExperienceData' => [ + 'summary' => '获取指定工作空间下的所有体验数据，支持按服务类型和数据类型筛选。', + 'path' => '/openapi/platform/workspaces/{workspaceName}/experience-data', + 'methods' => [ + 'get', + ], + 'schemes' => [ + 'http', + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'operationType' => 'read', + 'deprecated' => false, + 'systemTags' => [ + 'operationType' => 'list', + 'riskType' => 'none', + 'chargeType' => 'free', + 'abilityTreeCode' => '225365', + 'abilityTreeNodes' => [ + 'FEATUREopensearch1AJKH0', + ], + ], + 'parameters' => [ + [ + 'name' => 'dryRun', + 'in' => 'query', + 'schema' => [ + 'description' => '- true'."\n" + .'- false', + 'type' => 'boolean', + 'required' => false, + 'example' => 'true', + ], + ], + [ + 'name' => 'serviceType', + 'in' => 'query', + 'schema' => [ + 'description' => '服务类型'."\n", + 'type' => 'string', + 'required' => false, + 'example' => 'document-analyze', + ], + ], + [ + 'name' => 'workspaceName', + 'in' => 'path', + 'schema' => [ + 'description' => '工作空间名称', + 'type' => 'string', + 'required' => true, + 'example' => 'default', + ], + ], + [ + 'name' => 'dataType', + 'in' => 'query', + 'schema' => [ + 'description' => '数据类型'."\n", + 'type' => 'string', + 'required' => false, + 'example' => 'file', + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'title' => 'Schema of Response', + 'description' => 'Schema of Response', + 'type' => 'object', + 'properties' => [ + 'requestId' => [ + 'title' => 'Id of the request', + 'description' => '请求ID'."\n", + 'type' => 'string', + 'example' => 'FDSS_1232', + ], + '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', + ], + ], + ], + ], + ], + ], + ], + ], + '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", + ], + 'ListAsyncTasks' => [ + 'summary' => '获取异步任务列表。', + 'path' => '/openapi/platform/workspaces/{workspaceName}/async-tasks', + 'methods' => [ + 'get', + ], + 'schemes' => [ + 'http', + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'operationType' => 'read', + 'deprecated' => false, + 'systemTags' => [ + 'operationType' => 'list', + 'riskType' => 'none', + 'chargeType' => 'free', + 'abilityTreeCode' => '225788', + 'abilityTreeNodes' => [ + 'FEATUREopensearch1AJKH0', + ], + ], + 'parameters' => [ + [ + 'name' => 'dryRun', + 'in' => 'query', + 'schema' => [ + 'description' => '是否校验入参数据合法性，默认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', + ], + ], + ], + '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' => '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', + ], + ], + ], + ], + ], + ], + ], + ], + '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' => '获取异步任务列表', + ], + 'GetAsyncTask' => [ + 'summary' => '获取异步任务详情。', + 'path' => '/openapi/platform/workspaces/{workspaceName}/async-tasks/{id}', + 'methods' => [ + 'get', + ], + 'schemes' => [ + 'http', + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'operationType' => 'read', + 'deprecated' => false, + 'systemTags' => [ + 'operationType' => 'get', + 'riskType' => 'none', + 'chargeType' => 'free', + 'abilityTreeCode' => '225787', + 'abilityTreeNodes' => [ + 'FEATUREopensearch1AJKH0', + ], + ], + 'parameters' => [ + [ + 'name' => 'dryRun', + 'in' => 'query', + 'schema' => [ + 'description' => '是否为空运行请求', + 'type' => 'boolean', + 'required' => false, + 'example' => 'false', + ], + ], + [ + 'name' => 'workspaceName', + 'in' => 'path', + 'schema' => [ + 'description' => '工作空间名称。', + 'type' => 'string', + 'required' => true, + 'example' => 'myWorkspace', + ], + ], + [ + 'name' => 'id', + 'in' => 'path', + 'schema' => [ + 'description' => '异步任务id', + 'type' => 'string', + 'required' => true, + 'example' => 'addf-dfd-faa', + ], + ], + ], + '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' => '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', + ], + ], + ], + ], + ], + ], + ], + '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', + ], + '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' => '请求体。', + '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, + ], + ], + ], + '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', + ], + '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', + ], + ], + ], + ], + ], + ], + ], + ], + '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' => '创建异步任务', + ], + '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', + ], + 'operationType' => 'write', + 'deprecated' => false, + 'systemTags' => [ + 'operationType' => 'none', + 'riskType' => 'none', + 'chargeType' => 'free', + 'abilityTreeCode' => '239782', + 'abilityTreeNodes' => [ + 'FEATUREopensearchJK5SO0', + ], + 'autoTest' => true, + 'tenantRelevance' => 'tenant', + ], + 'parameters' => [ + [ + 'name' => 'workspaceName', + 'in' => 'path', + 'schema' => [ + 'title' => 'opensearch应用名', + 'description' => '工作空间名', + 'type' => 'string', + 'required' => true, + 'example' => 'default', + ], + ], + [ + 'name' => 'functionName', + 'in' => 'path', + 'schema' => [ + 'title' => '功能名称', + 'description' => '服务类型', + 'type' => 'string', + 'required' => true, + 'example' => 'notebook', + ], + ], + [ + 'name' => 'instanceName', + 'in' => 'path', + 'schema' => [ + 'title' => '实例名称', + 'description' => 'notebook名称', + 'type' => 'string', + 'required' => true, + 'example' => 'test_notebook', + ], + ], + ], + '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' => '145.411', + ], + ], + ], + ], + ], + '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', + ], + 'UpdateFunctionInstance' => [ + 'summary' => '更新服务配置', + 'path' => '/openapi/platform/workspaces/{workspaceName}/functions/{functionName}/instances/{instanceName}', + 'methods' => [ + 'put', + ], + 'schemes' => [ + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'deprecated' => false, + 'systemTags' => [ + 'operationType' => 'none', + 'riskType' => 'none', + 'chargeType' => 'free', + 'abilityTreeCode' => '239782', + 'abilityTreeNodes' => [ + 'FEATUREopensearchJK5SO0', + ], + 'autoTest' => true, + 'tenantRelevance' => 'publicInformation', + ], + 'parameters' => [ + [ + 'name' => 'workspaceName', + 'in' => 'path', + 'schema' => [ + 'title' => 'opensearch应用名', + 'description' => '工作空间名称', + 'type' => 'string', + 'required' => true, + 'example' => 'default', + ], + ], + [ + 'name' => 'functionName', + 'in' => 'path', + 'schema' => [ + 'title' => '功能名称', + 'description' => '功能名称', + 'type' => 'string', + 'required' => true, + 'example' => 'deployment', + ], + ], + [ + 'name' => 'instanceName', + 'in' => 'path', + 'schema' => [ + 'title' => '实例名称', + 'description' => '实例名称', + 'type' => 'string', + 'required' => true, + 'example' => 'test', + ], + ], + [ + 'name' => 'Body', + 'in' => 'body', + 'style' => 'json', + 'schema' => [ + 'title' => 'body参数', + 'description' => 'body参数', + 'type' => 'object', + 'properties' => [ + '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' => '描述', + ], + ], + '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 \\"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', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'operationType' => 'read', + 'deprecated' => false, + 'systemTags' => [ + 'operationType' => 'list', + 'riskType' => 'none', + 'chargeType' => 'free', + 'abilityTreeCode' => '239787', + 'abilityTreeNodes' => [ + 'FEATUREopensearchJK5SO0', + ], + 'autoTest' => true, + 'tenantRelevance' => 'publicInformation', + ], + 'parameters' => [ + [ + 'name' => 'workspaceName', + 'in' => 'path', + 'schema' => [ + 'title' => '实例名称', + 'description' => '工作空间名称', + 'type' => 'string', + 'required' => false, + 'example' => 'default', + ], + ], + [ + 'name' => 'functionName', + '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', + ], + ], + [ + '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' => 'output', + 'in' => 'query', + 'schema' => [ + 'title' => '返回信息的丰富度', + 'description' => '控制返回信息的丰富度'."\n" + .'- simple：只显示基本信息'."\n" + .'- normal：显示createParameters, cron等信息（默认）'."\n" + .'- detail: 返回训练任务信息', + 'type' => 'string', + 'required' => false, + 'example' => 'simple', + ], + ], + ], + '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' => '39.108', + ], + 'message' => [ + 'description' => '错误信息', + 'type' => 'string', + 'example' => '"xx not found"', + ], + 'requestId' => [ + 'description' => '请求ID', + 'type' => 'string', + 'example' => '33E4F0CA-F766-5803-B11C-70DC57A5A6E4', + ], + 'result' => [ + 'description' => '返回结果', + 'type' => 'array', + 'items' => [ + 'description' => '返回结果', + 'type' => 'object', + 'properties' => [ + 'belongs' => [ + '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', + ], + ], + ], + 'createParameters' => [ + 'description' => '创建参数体', + 'type' => 'array', + 'items' => [ + 'description' => '创建参数体', + 'type' => 'object', + 'properties' => [ + 'name' => [ + 'description' => '参数名称。', + 'type' => 'string', + 'example' => 'name', + ], + 'value' => [ + 'description' => '参数值。', + 'type' => 'string', + 'example' => 'value', + ], + ], + ], + ], + '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', + ], + ], + ], + ], + ], + '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' => '获取服务/模型配置详情列表', + ], + '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' => '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', + ], + ], + ], + ], + ], + '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服务', + ], + 'CreateFunctionInstance' => [ + 'summary' => '创建服务配置', + 'path' => '/openapi/platform/workspaces/{workspaceName}/functions/{functionName}/instances', + 'methods' => [ + 'post', + ], + 'schemes' => [ + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'consumes' => [ + 'application/json', + ], + 'operationType' => 'readAndWrite', + 'deprecated' => false, + 'systemTags' => [ + 'operationType' => 'create', + 'riskType' => 'none', + 'chargeType' => 'free', + 'abilityTreeCode' => '239769', + 'abilityTreeNodes' => [ + 'FEATUREopensearchJK5SO0', + ], + 'autoTest' => true, + 'tenantRelevance' => 'publicInformation', + ], + 'parameters' => [ + [ + 'name' => 'workspaceName', + 'in' => 'path', + 'schema' => [ + 'description' => '工作空间名称。', + 'type' => 'string', + 'required' => true, + 'example' => 'myWorkspace', + ], + ], + [ + 'name' => 'functionName', + 'in' => 'path', + 'schema' => [ + 'description' => '服务、模型类型'."\n" + .'- nl2sql 服务'."\n" + .'- embedding-tuning 模型', + 'type' => 'string', + 'required' => true, + 'example' => 'nl2sql', + ], + ], + [ + 'name' => 'Body', + 'in' => 'body', + 'style' => 'json', + 'schema' => [ + '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, + 'docRequired' => true, + ], + ], + ], + 'responses' => [ + 200 => [ + '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', + ], + ], + ], + ], + ], + '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' => '创建服务/模型配置', + ], + 'CreateFunctionTask' => [ + 'summary' => '创建服务配置任务', + 'path' => '/openapi/platform/workspaces/{workspaceName}/functions/{functionName}/instances/{instanceName}/tasks', + 'methods' => [ + 'post', + ], + 'schemes' => [ + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'operationType' => 'write', + 'deprecated' => false, + 'systemTags' => [ + 'operationType' => 'create', + 'riskType' => 'none', + 'chargeType' => 'paid', + 'abilityTreeCode' => '239788', + 'abilityTreeNodes' => [ + 'FEATUREopensearchJK5SO0', + ], + 'autoTest' => true, + 'tenantRelevance' => 'publicInformation', + ], + 'parameters' => [ + [ + 'name' => 'workspaceName', + 'in' => 'path', + 'schema' => [ + 'description' => '工作空间名称。', + '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' => [ + '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', + ], + ], + ], + ], + ], + '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' => '激活配置', + ], + 'DeleteFunctionInstance' => [ + 'summary' => '删除服务配置', + 'path' => '/openapi/platform/workspaces/{workspaceName}/functions/{functionName}/instances/{instanceName}', + 'methods' => [ + 'delete', + ], + 'schemes' => [ + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'operationType' => 'write', + 'deprecated' => false, + 'systemTags' => [ + 'operationType' => 'delete', + 'riskType' => 'none', + 'chargeType' => 'free', + 'abilityTreeCode' => '239777', + 'abilityTreeNodes' => [ + 'FEATUREopensearchJK5SO0', + ], + 'autoTest' => true, + 'tenantRelevance' => 'publicInformation', + ], + 'parameters' => [ + [ + 'name' => 'workspaceName', + 'in' => 'path', + 'schema' => [ + 'title' => 'opensearch应用名', + 'description' => '工作空间名称。', + 'type' => 'string', + 'required' => false, + 'example' => 'myWorkspace', + ], + ], + [ + 'name' => 'functionName', + 'in' => 'path', + 'schema' => [ + 'title' => '功能名称', + 'description' => '服务/模型配置', + 'type' => 'string', + 'required' => false, + 'example' => 'nl2sql', + ], + ], + [ + 'name' => 'instanceName', + 'in' => 'path', + 'schema' => [ + 'title' => '实例名称', + 'description' => '配置名称', + 'type' => 'string', + 'required' => true, + 'example' => 'test', + ], + ], + ], + 'responses' => [ + 200 => [ + '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', + ], + ], + ], + ], + ], + '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' => '删除服务/模型配置', + ], + 'GetFunctionInstance' => [ + 'summary' => '查询指定工作空间中特定功能实例的详细信息。', + 'path' => '/openapi/platform/workspaces/{workspaceName}/functions/{functionName}/instances/{instanceName}', + 'methods' => [ + 'get', + ], + 'schemes' => [ + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'operationType' => 'read', + 'deprecated' => false, + 'systemTags' => [ + 'operationType' => 'get', + 'riskType' => 'none', + 'chargeType' => 'free', + 'abilityTreeCode' => '239784', + 'abilityTreeNodes' => [ + 'FEATUREopensearchJK5SO0', + ], + 'autoTest' => true, + 'tenantRelevance' => 'publicInformation', + ], + 'parameters' => [ + [ + 'name' => 'workspaceName', + 'in' => 'path', + 'schema' => [ + 'description' => '工作空间名称'."\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', + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'description' => '响应体示例'."\n", + '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', + ], + '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', + ], + ], + ], + 'createParameters' => [ + 'description' => '具体配置项'."\n", + 'type' => 'array', + 'items' => [ + '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', + ], + ], + ], + 'versionId' => [ + 'description' => '训练版本ID', + 'type' => 'integer', + 'format' => 'int64', + 'example' => '21', + ], + ], + ], + 'status' => [ + 'description' => '请求状态', + 'type' => 'string', + 'example' => 'OK', + ], + ], + ], + ], + ], + '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' => '获取服务/模型配置详情', + ], + 'ListFunctionRestrictions' => [ + 'summary' => '获取功能的限制项', + 'path' => '/openapi/platform/workspaces/{workspaceName}/functions/{functionName}/restrictions/{restrictionName}', + 'methods' => [ + 'get', + ], + 'schemes' => [ + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'consumes' => [ + 'application/json', + ], + 'produces' => [ + 'application/json', + ], + 'operationType' => 'read', + 'deprecated' => false, + 'systemTags' => [ + 'operationType' => 'get', + 'riskType' => 'none', + 'chargeType' => 'free', + 'abilityTreeNodes' => [ + 'FEATUREopensearchLIKVQB', + ], + ], + 'parameters' => [ + [ + 'name' => 'workspaceName', + 'in' => 'path', + 'schema' => [ + 'description' => '工作空间名称', + 'type' => 'string', + 'required' => false, + 'example' => 'default', + ], + ], + [ + 'name' => 'functionName', + 'in' => 'path', + 'schema' => [ + 'description' => '配置类型'."\n" + ."\n" + .'- deployment', + 'type' => 'string', + 'required' => false, + 'example' => 'deployment', + ], + ], + [ + 'name' => 'restrictionName', + 'in' => 'path', + 'schema' => [ + 'description' => '限制名称'."\n" + .'- model: 平台支持的模型名称'."\n" + .'- instance_type: 平台支持的资源类型', + 'type' => 'string', + 'required' => false, + 'example' => 'model', + ], + ], + [ + 'name' => 'modelType', + 'in' => 'query', + 'schema' => [ + 'description' => '模型类型', + 'type' => 'string', + 'required' => false, + 'example' => 'native', + ], + ], + [ + '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' => [ + 200 => [ + 'schema' => [ + 'title' => 'Schema of Response', + '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', + ], + 'result' => [ + 'description' => '返回结果', + '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', + ], + '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', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'consumes' => [ + 'application/json', + ], + 'produces' => [ + 'application/json', + ], + 'operationType' => 'write', + 'deprecated' => false, + 'systemTags' => [ + 'operationType' => 'delete', + 'riskType' => 'none', + 'chargeType' => 'free', + 'abilityTreeCode' => '226069', + 'abilityTreeNodes' => [ + 'FEATUREopensearchWAC9DF', + ], + ], + 'parameters' => [ + [ + 'name' => 'workspaceName', + 'in' => 'path', + 'schema' => [ + 'description' => '工作空间名称。', + 'type' => 'string', + 'required' => false, + 'example' => 'myWorkspace', + ], + ], + [ + 'name' => 'task_id', + 'in' => 'path', + 'schema' => [ + 'description' => '任务 id', + 'type' => 'string', + 'required' => false, + 'example' => 'T-6684b38a48bc8e012d00052c', + ], + ], + ], + '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' => [], + ], + ], + 'consumes' => [ + 'application/json', + ], + 'produces' => [ + 'application/json', + ], + 'operationType' => 'write', + 'deprecated' => false, + 'systemTags' => [ + 'operationType' => 'create', + 'riskType' => 'none', + 'chargeType' => 'free', + 'abilityTreeCode' => '226065', + 'abilityTreeNodes' => [ + 'FEATUREopensearchWAC9DF', + ], + ], + 'parameters' => [ + [ + 'name' => 'workspaceName', + 'in' => 'path', + 'schema' => [ + 'description' => '工作空间名称。', + 'type' => 'string', + 'required' => false, + 'example' => 'myWorkspace', + ], + ], + [ + '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, + ], + ], + ], + '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' => '0abb793917165176014887584e28d9', + ], + 'code' => [ + 'description' => '错误码'."\n", + 'type' => 'string', + 'example' => 'not found', + ], + 'message' => [ + 'description' => '错误信息。', + 'type' => 'string', + 'example' => '"xx not found"', + ], + 'result' => [ + 'description' => '返回结果', + 'type' => 'object', + 'properties' => [ + 'taskId' => [ + 'description' => '任务id', + 'type' => 'string', + 'example' => '1846389386674049024', + ], + ], + ], + ], + ], + ], + ], + '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' => '创建评测任务', + ], + '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' => 'read', + 'deprecated' => false, + 'systemTags' => [ + 'operationType' => 'get', + 'riskType' => 'none', + 'chargeType' => 'free', + 'abilityTreeCode' => '228521', + 'abilityTreeNodes' => [ + 'FEATUREopensearchWAC9DF', + ], + ], + 'parameters' => [ + [ + 'name' => 'workspaceName', + 'in' => 'path', + 'schema' => [ + 'description' => '工作空间名称', + 'type' => 'string', + 'required' => false, + 'example' => 'default', + ], + ], + [ + 'name' => 'task_id', + 'in' => 'path', + 'schema' => [ + 'description' => '任务ID。', + 'type' => 'string', + 'required' => false, + 'example' => 'de591cbcea6745e0b846ed051c5c3462', + ], + ], + ], + '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" + .' }', + ], + ], + ], + ], + ], + '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版评测任务', + ], + '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版评测任务列表', + ], + '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' => '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' => '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'."\n", + ], + ], + [ + 'name' => 'regionId', + 'in' => 'query', + 'schema' => [ + 'title' => '区域标识符', + 'description' => '区域标识符', + 'type' => 'string', + 'required' => false, + 'example' => 'cn-shanghai', + ], + ], + [ + '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', + ], + ], + ], + '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', + ], + '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' => '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', + ], + ], + ], + ], + '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', + ], + ], + ], + ], + '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', + ], + ], + ], + ], + ], + ], + ], + ], + ], + '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' => '停止离线任务', + ], + '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', + ], + ], + [ + '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', + ], + ], + ], + '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', + ], + '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', + ], + ], + ], + ], + ], + ], + ], + ], + ], + '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", + ], + 'ListOfflineTask' => [ + 'summary' => '获取离线任务信息列表', + 'path' => '/openapi/platform/workspaces/{workspaceName}/offline-tasks/{type}', + 'methods' => [ + 'get', + ], + 'schemes' => [ + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'consumes' => [ + 'application/json', + ], + 'produces' => [ + 'application/json', + ], + 'operationType' => 'read', + 'deprecated' => false, + 'systemTags' => [ + 'operationType' => 'none', + 'riskType' => 'none', + 'chargeType' => 'free', + 'abilityTreeNodes' => [ + 'FEATUREopensearchJK5SO0', + ], + ], + 'parameters' => [ + [ + 'name' => 'workspaceName', + 'in' => 'path', + 'schema' => [ + 'description' => '工作空间名称', + 'type' => 'string', + 'required' => false, + 'example' => 'default', + ], + ], + [ + 'name' => 'type', + 'in' => 'path', + 'schema' => [ + 'description' => '任务类型', + 'type' => 'string', + 'required' => false, + 'example' => 'video', + ], + ], + [ + 'name' => 'taskName', + 'in' => 'query', + 'schema' => [ + 'description' => '任务名称', + 'type' => 'string', + 'required' => false, + 'example' => 'syh', + ], + ], + [ + 'name' => 'taskStatus', + 'in' => 'query', + 'style' => 'json', + 'schema' => [ + 'description' => '任务状态', + 'type' => 'array', + 'items' => [ + 'description' => '任务状态', + 'type' => 'string', + 'required' => false, + 'example' => 'RUNNING', + ], + 'required' => false, + ], + ], + [ + 'name' => 'labels', + 'in' => 'query', + 'style' => 'json', + 'schema' => [ + 'description' => '任务标签列表', + 'type' => 'array', + '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', + ], + ], + [ + 'name' => 'pageSize', + 'in' => 'query', + 'schema' => [ + 'description' => '分页大小', + 'type' => 'integer', + 'format' => 'int32', + 'required' => false, + 'example' => '10', + ], + ], + [ + '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' => [ + 'TotalCount' => [ + 'description' => '记录总条数。', + 'type' => 'integer', + 'format' => 'int64', + 'example' => '7', + ], + 'RequestId' => [ + 'description' => '请求ID。', + 'type' => 'string', + 'example' => '786CC01F-0F1D-5FB5-8BFF-B0F3DB289772', + ], + 'Result' => [ + 'description' => '返回结果。', + 'type' => 'array', + 'items' => [ + 'description' => '返回结果。', + 'type' => 'object', + 'properties' => [ + 'Meta' => [ + 'description' => '任务元数据', + 'type' => 'object', + 'properties' => [ + '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', + ], + ], + ], + 'Processors' => [ + 'description' => '处理流程算子', + 'type' => 'array', + 'items' => [ + 'description' => '处理流程算子', + 'type' => 'object', + 'properties' => [ + 'Input' => [ + 'description' => '输入参数', + 'type' => 'object', + '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" + .'}', + ], + ], + 'Parameters' => [ + 'description' => 'processor处理参数', + 'type' => 'object', + 'additionalProperties' => [ + 'type' => 'string', + 'description' => 'processor处理参数', + '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' => 'table2', + ], + 'Parameters' => [ + 'description' => '数据汇配置参数，由type决定', + 'type' => 'object', + '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字段名称', + ], + ], + ], + 'Type' => [ + 'description' => '数据汇类型', + 'type' => 'string', + 'example' => 'swift', + ], + ], + ], + ], + 'Source' => [ + 'description' => '数据源信息', + 'type' => 'array', + 'items' => [ + 'description' => '数据源', + 'type' => 'object', + 'properties' => [ + 'Name' => [ + 'description' => '数据源名称', + 'type' => 'string', + 'example' => 'table', + ], + 'Parameters' => [ + 'description' => '数据源配置参数', + 'type' => 'object', + '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字段名称', + ], + ], + ], + 'Type' => [ + 'description' => '数据源类型', + 'type' => 'string', + 'example' => 'rds', + ], + ], + ], + ], + 'Status' => [ + 'description' => '任务状态', + 'type' => 'object', + 'properties' => [ + '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', + ], + ], + ], + ], + ], + ], + ], + ], + ], + ], + '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' => '获取离线任务列表', + ], + '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', + ], + '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' => 'syh', + ], + ], + [ + 'name' => 'dryRun', + 'in' => 'query', + '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', + ], + ], + [ + 'name' => 'body', + 'in' => 'body', + 'style' => 'json', + 'schema' => [ + 'description' => '请求体。', + 'type' => 'object', + 'properties' => [ + 'meta' => [ + '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', + ], + 'labels' => [ + 'description' => '任务标签列表', + 'type' => 'array', + 'items' => [ + 'description' => '标签', + 'type' => 'string', + 'required' => false, + 'example' => 'aa', + ], + 'required' => false, + ], + ], + 'required' => false, + ], + 'source' => [ + 'description' => '数据源信息', + 'type' => 'array', + 'items' => [ + 'description' => '数据源信息', + 'type' => 'object', + 'properties' => [ + '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', + ], + ], + 'schema' => [ + 'description' => '数据源Schema', + '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, + ], + 'sink' => [ + 'description' => '数据汇信息', + 'type' => 'array', + 'items' => [ + 'description' => '数据汇信息', + 'type' => 'object', + 'properties' => [ + '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', + ], + ], + 'schema' => [ + 'description' => '数据汇Schema', + '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'."\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" + .'}', + ], + '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', + ], + ], + 'required' => false, + ], + ], + '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' => '0abb793917165176014887584e28d9', + ], + 'result' => [ + 'description' => '返回结果', + 'type' => 'object', + 'properties' => [ + 'meta' => [ + 'description' => '元信息', + 'type' => 'object', + 'properties' => [ + 'taskName' => [ + 'description' => '任务名称', + 'type' => 'string', + 'example' => 'test', + ], + 'computeResource' => [ + 'description' => '计费规格', + 'type' => 'string', + 'example' => 'small', + ], + ], + ], + 'source' => [ + 'description' => '数据源信息', + 'type' => 'array', + 'items' => [ + 'description' => '数据源信息', + 'type' => 'object', + 'properties' => [ + 'name' => [ + 'description' => '数据源名', + 'type' => 'string', + 'example' => 'table1'."\n", + ], + 'type' => [ + 'description' => '数据源类型', + 'type' => 'string', + 'example' => 'swift', + ], + 'parameters' => [ + 'description' => '数据源配置参数，由type决定', + 'type' => 'object', + 'additionalProperties' => [ + 'type' => 'string', + 'description' => '数据源配置参数名称', + 'example' => 'name', + ], + ], + 'schema' => [ + 'description' => '数据源Schema', + 'type' => 'array', + 'items' => [ + 'description' => '数据源Schema', + 'type' => 'object', + 'additionalProperties' => [ + 'type' => 'string', + 'example' => 'name', + 'description' => '数据源Schema字段名称', + ], + ], + ], + 'primaryKey' => [ + 'description' => '数据源主键字段', + 'type' => 'string', + 'example' => 'id', + ], + ], + ], + ], + 'sink' => [ + 'description' => '数据汇信息', + 'type' => 'array', + 'items' => [ + 'description' => '数据汇信息', + 'type' => 'object', + 'properties' => [ + 'name' => [ + 'description' => '数据汇名', + 'type' => 'string', + 'example' => 'table2', + ], + 'type' => [ + 'description' => '数据汇类型', + 'type' => 'string', + 'example' => 'swift', + ], + 'parameters' => [ + 'description' => '数据汇配置参数，由type决定', + 'type' => 'object', + 'additionalProperties' => [ + 'type' => 'string', + 'description' => '数据汇配置参数名称', + 'example' => 'key1', + ], + ], + 'schema' => [ + 'description' => '数据汇Schema', + 'type' => 'array', + 'items' => [ + 'description' => '数据汇Schema', + 'type' => 'object', + 'additionalProperties' => [ + 'type' => 'string', + 'description' => '数据汇Schema字段名称', + 'example' => 'name', + ], + ], + ], + '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'."\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" + .'}', + ], + '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' => '""', + ], + ], + ], + ], + ], + ], + ], + ], + ], + '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', + ], + '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' => 'boolean', + 'required' => false, + 'example' => 'false', + ], + ], + [ + 'name' => 'dryRun', + 'in' => 'query', + 'schema' => [ + 'description' => '校验参数是否正确', + 'type' => 'boolean', + 'required' => false, + 'example' => 'false', + ], + ], + [ + 'name' => 'regionId', + 'in' => 'query', + 'schema' => [ + 'title' => '区域标识符', + 'description' => '区域标识符', + 'type' => 'string', + 'required' => false, + 'example' => 'cn-shanghai', + ], + ], + [ + 'name' => 'body', + 'in' => 'body', + 'style' => 'json', + 'schema' => [ + '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, + ], + ], + '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' => 'B7C901ED-2BC1-5CFB-BE23-242DE5E3BA5C', + ], + 'result' => [ + 'description' => '返回结果', + 'type' => 'object', + 'properties' => [ + 'meta' => [ + 'description' => '任务元数据', + 'type' => 'object', + 'properties' => [ + 'taskName' => [ + 'description' => '任务名称', + 'type' => 'string', + 'example' => 'test', + ], + 'computeResource' => [ + 'description' => '计费规格', + 'type' => 'string', + 'example' => 'small', + ], + ], + ], + 'source' => [ + 'description' => '数据源信息'."\n", + 'type' => 'array', + 'items' => [ + 'description' => '数据源信息', + 'type' => 'object', + 'properties' => [ + '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', + ], + ], + 'schema' => [ + 'description' => '数据源Schema', + 'type' => 'array', + 'items' => [ + 'description' => 'Schema', + 'type' => 'object', + 'additionalProperties' => [ + 'type' => 'string', + 'example' => '""', + 'description' => 'key为String类型', + ], + ], + ], + 'primaryKey' => [ + 'description' => '数据源主键字段', + 'type' => 'string', + 'example' => 'id', + ], + ], + ], + ], + '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', + ], + ], + ], + ], + '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" + .'}', + ], + ], + ], + ], + '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' => '""', + ], + ], + ], + ], + ], + ], + ], + ], + ], + '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", + ], + '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' => 'get', + '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' => '5950143C-B8F0-5758-A08A-66F302FD587F', + ], + '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' => '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', + ], + ], + ], + ], + '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类型', + ], + ], + ], + 'type' => [ + 'description' => '数据源类型', + 'type' => 'string', + 'example' => 'swift', + ], + ], + ], + ], + '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', + ], + ], + ], + ], + ], + ], + ], + ], + ], + '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\\": \\"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', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'consumes' => [ + 'application/json', + ], + 'produces' => [ + 'application/json', + ], + 'operationType' => 'read', + 'deprecated' => false, + 'systemTags' => [ + 'operationType' => 'update', + 'riskType' => 'none', + 'chargeType' => 'free', + 'abilityTreeNodes' => [ + 'FEATUREopensearch8B42ZS', + ], + 'tenantRelevance' => 'tenant', + ], + 'parameters' => [ + [ + 'name' => 'workspaceName', + 'in' => 'path', + 'schema' => [ + 'description' => '工作空间名称'."\n", + 'type' => 'string', + 'required' => true, + 'example' => 'default', + ], + ], + [ + 'name' => 'itemCategory', + 'in' => 'path', + 'schema' => [ + 'description' => '配置类别', + 'type' => 'string', + 'required' => true, + 'example' => 'ai_search_agent', + ], + ], + [ + 'name' => 'itemName', + 'in' => 'path', + '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', + ], + ], + [ + 'name' => 'body', + 'in' => 'body', + 'style' => 'json', + 'schema' => [ + '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" + .' }', + ], + ], + 'required' => false, + ], + ], + ], + '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' => '5950143C-B8F0-5758-A08A-66F302FD587F', + ], + 'httpCode' => [ + 'description' => 'HTTP状态码。', + 'type' => 'integer', + 'format' => 'int64', + 'example' => '200', + ], + 'status' => [ + 'description' => '请求状态', + 'type' => 'string', + 'example' => 'OK', + ], + ], + ], + ], + ], + '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', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'consumes' => [ + 'application/json', + ], + 'produces' => [ + 'application/json', + ], + 'operationType' => 'read', + 'deprecated' => false, + 'systemTags' => [ + 'operationType' => 'list', + 'riskType' => 'none', + 'chargeType' => 'free', + 'abilityTreeNodes' => [ + 'FEATUREopensearch8B42ZS', + ], + 'tenantRelevance' => 'tenant', + ], + 'parameters' => [ + [ + 'name' => 'workspaceName', + 'in' => 'path', + 'schema' => [ + 'description' => '工作空间名称'."\n", + 'type' => 'string', + 'required' => true, + 'example' => 'default', + ], + ], + [ + 'name' => 'itemCategory', + 'in' => 'path', + 'schema' => [ + 'description' => '配置类别', + 'type' => 'string', + 'required' => true, + 'example' => 'ai_search_agent', + ], + ], + [ + 'name' => 'pageNumber', + 'in' => 'query', + 'schema' => [ + 'description' => '页码', + 'type' => 'string', + 'required' => false, + 'example' => '1', + ], + ], + [ + 'name' => 'pageSize', + 'in' => 'query', + 'schema' => [ + 'description' => '分页size', + 'type' => 'string', + 'required' => false, + 'example' => '10', + ], + ], + [ + 'name' => 'nextToken', + 'in' => 'query', + 'schema' => [ + 'description' => '分页Token', + 'type' => 'string', + 'required' => false, + 'example' => 'tMEiGtggHs0=', + ], + ], + [ + 'name' => 'maxResults', + 'in' => 'query', + 'schema' => [ + 'description' => '分页查询时每页行数', + 'type' => 'integer', + 'format' => 'int32', + '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' => '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' => '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', + ], + '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', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'consumes' => [ + 'application/json', + ], + 'produces' => [ + 'application/json', + ], + 'operationType' => 'read', + 'deprecated' => false, + 'systemTags' => [ + 'operationType' => 'get', + 'riskType' => 'none', + 'chargeType' => 'free', + 'abilityTreeNodes' => [ + 'FEATUREopensearch8B42ZS', + ], + 'tenantRelevance' => 'tenant', + ], + 'parameters' => [ + [ + 'name' => 'workspaceName', + 'in' => 'path', + 'schema' => [ + 'description' => '**工作空间名称**'."\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', + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'title' => 'Schema of Response', + 'description' => 'Schema of Response', + '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', + ], + ], + ], + ], + ], + ], + ], + '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', + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'title' => 'Schema of Response', + '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', + ], + ], + ], + ], + ], + '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", + ], + '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' => 'create', + 'riskType' => 'none', + 'chargeType' => 'free', + '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' => [ + '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' => '创建配置', + ], + 'GetTableFields' => [ + 'path' => '/openapi/platform/workspaces/{workspaceName}/data-sources/{dataSourceType}/fields', + 'methods' => [ + 'get', + ], + 'schemes' => [ + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'operationType' => 'read', + 'deprecated' => false, + 'systemTags' => [ + 'operationType' => 'get', + 'abilityTreeCode' => '241066', + 'abilityTreeNodes' => [ + 'FEATUREopensearchJK5SO0', + ], + 'autoTest' => false, + 'notSupportAutoTestReason' => '无法关联资源', + 'tenantRelevance' => 'publicInformation', + ], + 'parameters' => [ + [ + 'name' => 'workspaceName', + 'in' => 'path', + 'schema' => [ + 'description' => '工作空间名称', + 'type' => 'string', + 'required' => true, + 'example' => 'default', + ], + ], + [ + 'name' => 'dataSourceType', + 'in' => 'path', + 'schema' => [ + 'description' => '数据源类型'."\n" + .'- odps', + 'type' => 'string', + 'required' => true, + 'docRequired' => true, + 'example' => 'odps', + ], + ], + [ + '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' => [ + 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', + ], + ], + ], + ], + '5XX' => [ + 'schema' => [ + 'type' => 'object', + 'properties' => [ + 'code' => [ + 'type' => 'string', + ], + 'message' => [ + 'type' => 'string', + ], + 'requestId' => [ + 'type' => 'string', + ], + 'httpCode' => [ + 'type' => 'integer', + 'format' => 'int32', + ], + ], + ], + ], + ], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"result\\": {\\n \\"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', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'operationType' => 'read', + 'deprecated' => false, + 'systemTags' => [ + 'operationType' => 'get', + 'abilityTreeCode' => '218714', + 'abilityTreeNodes' => [ + 'FEATUREopensearchJK5SO0', + ], + ], + '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', + ], + ], + ], + ], + ], + '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' => [], + ], + ], + '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', + ], + ], + ], + ], + ], + ], + ], + ], + ], + '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', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'consumes' => [ + 'application/json', + ], + 'produces' => [ + 'application/json', + ], + 'operationType' => 'read', + 'deprecated' => false, + 'systemTags' => [ + 'operationType' => 'get', + 'riskType' => 'none', + 'chargeType' => 'free', + 'abilityTreeCode' => '241066', + 'abilityTreeNodes' => [ + 'FEATUREopensearchJK5SO0', + ], + 'autoTest' => true, + 'tenantRelevance' => 'tenant', + ], + 'parameters' => [ + [ + 'name' => 'workspaceName', + 'in' => 'path', + 'schema' => [ + 'description' => '工作空间名称', + 'type' => 'string', + 'required' => true, + 'example' => 'default', + ], + ], + [ + 'name' => 'dataSourceType', + 'in' => 'path', + 'schema' => [ + 'description' => '数据源类型'."\n" + ."\n" + .'- rds'."\n" + .'- odps', + 'type' => 'string', + 'required' => true, + 'docRequired' => true, + 'example' => 'rds', + ], + ], + [ + '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' => [ + 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', + ], + ], + ], + ], + '5XX' => [ + 'schema' => [ + 'type' => 'object', + 'properties' => [ + 'code' => [ + 'type' => 'string', + ], + 'message' => [ + 'type' => 'string', + ], + 'requestId' => [ + 'type' => 'string', + ], + 'httpCode' => [ + 'type' => 'integer', + 'format' => 'int32', + ], + ], + ], + ], + ], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"result\\": [\\n \\"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', + ], + 'schemes' => [ + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'consumes' => [ + 'application/json', + ], + 'produces' => [ + 'application/json', + ], + 'operationType' => 'read', + 'deprecated' => false, + 'systemTags' => [ + 'operationType' => 'get', + 'riskType' => 'none', + 'chargeType' => 'free', + 'abilityTreeCode' => '241066', + 'abilityTreeNodes' => [ + 'FEATUREopensearchJK5SO0', + ], + 'autoTest' => true, + 'tenantRelevance' => 'tenant', + ], + 'parameters' => [ + [ + 'name' => 'workspaceName', + 'in' => 'path', + 'schema' => [ + 'description' => '工作空间名称', + 'type' => 'string', + 'required' => true, + 'example' => 'default', + ], + ], + [ + 'name' => 'dataSourceType', + 'in' => 'path', + 'schema' => [ + 'description' => '数据源类型'."\n" + ."\n" + .'- rds'."\n" + .'- odps', + 'type' => 'string', + 'required' => true, + 'docRequired' => true, + 'example' => 'rds', + ], + ], + [ + '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' => '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', + ], + ], + ], + ], + '5XX' => [ + 'schema' => [ + 'type' => 'object', + 'properties' => [ + 'code' => [ + 'type' => 'string', + ], + 'message' => [ + 'type' => 'string', + ], + 'requestId' => [ + 'type' => 'string', + ], + 'httpCode' => [ + 'type' => 'integer', + 'format' => 'int32', + ], + ], + ], + ], + ], + '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' => '获取数据表字段信息', + ], + ], + 'endpoints' => [ + [ + 'regionId' => 'cn-shanghai', + 'endpoint' => 'searchplat.cn-shanghai.aliyuncs.com', + ], + [ + 'regionId' => 'eu-central-1', + 'endpoint' => 'searchplat.eu-central-1.aliyuncs.com', + ], + ], +]; -- cgit v1.2.3