summaryrefslogtreecommitdiff
path: root/data/zh_cn/dataanalysisgbi/2024-08-23/api-docs.php
diff options
context:
space:
mode:
authorZhineng Li <im@zhineng.li>2026-07-12 17:11:17 +0800
committerZhineng Li <im@zhineng.li>2026-07-12 17:11:17 +0800
commit1c7f908ce09f98fdcbf79ed2a8ae21be60eaa634 (patch)
tree5f0857666365b7e40cdaa3733ebe1f3ba9e13c67 /data/zh_cn/dataanalysisgbi/2024-08-23/api-docs.php
parent7347bac4ab7e136157fc94777e6cf87ef9e08599 (diff)
downloadafterglow-metadata-full-1c7f908ce09f98fdcbf79ed2a8ae21be60eaa634.tar.gz
afterglow-metadata-full-1c7f908ce09f98fdcbf79ed2a8ae21be60eaa634.zip
update APIs 20260712
Diffstat (limited to 'data/zh_cn/dataanalysisgbi/2024-08-23/api-docs.php')
-rw-r--r--data/zh_cn/dataanalysisgbi/2024-08-23/api-docs.php5321
1 files changed, 2121 insertions, 3200 deletions
diff --git a/data/zh_cn/dataanalysisgbi/2024-08-23/api-docs.php b/data/zh_cn/dataanalysisgbi/2024-08-23/api-docs.php
index 242b705..a57c0b9 100644
--- a/data/zh_cn/dataanalysisgbi/2024-08-23/api-docs.php
+++ b/data/zh_cn/dataanalysisgbi/2024-08-23/api-docs.php
@@ -1,137 +1,75 @@
<?php return [
'version' => '1.0',
- 'info' => [
- 'style' => 'ROA',
- 'product' => 'DataAnalysisGBI',
- 'version' => '2024-08-23',
- ],
+ 'info' => ['style' => 'ROA', 'product' => 'DataAnalysisGBI', 'version' => '2024-08-23'],
'directories' => [
[
- 'id' => 202949,
- 'title' => '智能问数',
- 'type' => 'directory',
'children' => [
[
- 'id' => 199753,
- 'title' => '云端执行SQL方式',
+ 'children' => ['RunDataAnalysis'],
'type' => 'directory',
- 'children' => [
- 'RunDataAnalysis',
- ],
+ 'title' => '云端执行SQL方式',
+ 'id' => 285133,
],
[
- 'id' => 202907,
- 'title' => '本地执行SQL方式',
+ 'children' => ['RunDataResultAnalysis', 'RunSqlGeneration'],
'type' => 'directory',
- 'children' => [
- 'RunDataResultAnalysis',
- 'RunSqlGeneration',
- ],
+ 'title' => '本地执行SQL方式',
+ 'id' => 285135,
],
],
+ 'type' => 'directory',
+ 'title' => '智能问数',
+ 'id' => 285132,
],
[
- 'id' => 200236,
- 'title' => '业务逻辑解释',
+ 'children' => ['UpdateBusinessLogic', 'CreateBusinessLogic', 'ListBusinessLogic', 'DeleteBusinessLogic'],
'type' => 'directory',
- 'children' => [
- 'UpdateBusinessLogic',
- 'CreateBusinessLogic',
- 'ListBusinessLogic',
- 'DeleteBusinessLogic',
- ],
+ 'title' => '业务逻辑解释',
+ 'id' => 285127,
],
[
- 'id' => 200120,
- 'title' => '同义词解释',
+ 'children' => ['CreateSynonyms', 'ListSynonyms', 'UpdateSynonyms', 'BatchDeleteSynonyms'],
'type' => 'directory',
- 'children' => [
- 'CreateSynonyms',
- 'ListSynonyms',
- 'UpdateSynonyms',
- 'BatchDeleteSynonyms',
- ],
+ 'title' => '同义词解释',
+ 'id' => 285122,
],
[
- 'id' => 199743,
- 'title' => '数据源管理',
+ 'children' => ['CreateDatasourceAuthorization', 'CancelDatasourceAuthorization', 'SyncRemoteTables', 'ListSelectedTables', 'UpdateTableInfo', 'DeleteSelectedTable', 'ResyncTable', 'ListColumn', 'UpdateColumn', 'RecoverColumn', 'DeleteColumn', 'ListEnumMapping', 'UpdateEnumMapping'],
'type' => 'directory',
- 'children' => [
- 'CreateDatasourceAuthorization',
- 'CancelDatasourceAuthorization',
- 'SyncRemoteTables',
- 'ListSelectedTables',
- 'UpdateTableInfo',
- 'DeleteSelectedTable',
- 'ResyncTable',
- 'ListColumn',
- 'UpdateColumn',
- 'RecoverColumn',
- 'DeleteColumn',
- 'ListEnumMapping',
- 'UpdateEnumMapping',
- ],
+ 'title' => '数据源管理',
+ 'id' => 285102,
],
[
- 'id' => 199747,
- 'title' => '虚拟数据源',
+ 'children' => ['CreateVirtualDatasourceInstance', 'ListVirtualDatasourceInstance', 'UpdateVirtualDatasourceInstance', 'DeleteVirtualDatasourceInstance', 'SaveVirtualDatasourceDdl'],
'type' => 'directory',
- 'children' => [
- 'CreateVirtualDatasourceInstance',
- 'ListVirtualDatasourceInstance',
- 'UpdateVirtualDatasourceInstance',
- 'DeleteVirtualDatasourceInstance',
- 'SaveVirtualDatasourceDdl',
- ],
+ 'title' => '虚拟数据源',
+ 'id' => 285116,
],
],
'components' => [
'schemas' => [],
],
'apis' => [
- 'RunDataAnalysis' => [
- 'summary' => '析言为您提供了与官方页面对话效果相同的OpenAPI接口，只需传入workspaceId以及query等相关信息，即可对您已经创建好的业务空间进行问答和数据分析。'."\n"
- ."\n"
- .'该接口适合以下场景：'."\n"
- .'您在析言控制台关联了数据源，即析言可以通过公网或者VPC的方式访问您的数据库并执行SQL。'."\n"
- ."\n"
- .'具体的使用，可以参考以下最佳实践文档：'."\n"
- .'https://help.aliyun.com/zh/model-studio/gbi-best-practices',
- 'path' => '/{workspaceId}/gbi/runDataAnalysis',
- 'methods' => [
- 'post',
- ],
- 'schemes' => [
- 'https',
- 'sse',
- ],
+ 'BatchDeleteSynonyms' => [
+ 'summary' => '批量删除当前指定业务空间下的同义词。',
+ 'path' => '/gbi/batchDelete/synonyms',
+ 'methods' => ['post'],
+ 'schemes' => ['https'],
'security' => [
[
'AK' => [],
],
],
- 'consumes' => [],
- 'operationType' => 'read',
+ 'consumes' => ['application/json'],
+ 'produces' => ['application/json'],
+ 'operationType' => 'write',
'deprecated' => false,
- 'systemTags' => [
- 'operationType' => 'none',
- 'riskType' => 'none',
- 'chargeType' => 'free',
- 'abilityTreeNodes' => [
- 'FEATUREsfmXG6QUJ',
- ],
- 'tenantRelevance' => 'tenant',
- ],
+ 'systemTags' => ['operationType' => 'none', 'riskType' => 'none', 'chargeType' => 'free'],
'parameters' => [
[
'name' => 'workspaceId',
- 'in' => 'path',
- 'schema' => [
- 'description' => '当前请求所使用的阿里云百炼业务空间id',
- 'type' => 'string',
- 'required' => true,
- 'example' => 'llm-2v3934xtp49esw64'."\n",
- ],
+ 'in' => 'query',
+ 'schema' => ['description' => '当前请求所使用的百炼业务空间id', 'type' => 'string', 'required' => true, 'example' => 'llm-2v3934xtp49esw64'."\n"],
],
[
'name' => 'body',
@@ -141,69 +79,11 @@
'description' => '请求体参数',
'type' => 'object',
'properties' => [
- 'specificationType' => [
- 'description' => '当前请求指定使用的版本信息，不填时使用默认业务空间版本',
- 'type' => 'string',
- 'required' => false,
- 'enumValueTitles' => [
- 'STANDARD_TURBO' => '标准版turbo',
- 'STANDARD_MIX' => '标准版mix',
- 'CUSTOMIZATION' => '定制版turbo',
- ],
- 'example' => 'STANDARD_MIX',
- ],
- 'generateSqlOnly' => [
- 'description' => '当前请求只生成并返回sql，不会执行',
- 'type' => 'boolean',
- 'required' => false,
- 'example' => 'true',
- ],
- 'query' => [
- 'description' => '用户输入的query',
- 'type' => 'string',
- 'required' => true,
- 'example' => '请问销量前十的产品有哪些',
- ],
- 'sessionId' => [
- 'description' => '消息会话ID，服务窗回调消息返回的会话ID。',
- 'type' => 'string',
- 'required' => false,
- 'example' => 'sessionID',
- ],
- 'dataRole' => [
- 'description' => '数据权限-角色名称的列表'."\n"
- .'> 数据权限的相关配置内容需要在产品页面进行配置后，方可获取参数在api中调用',
+ 'synonymIdKeys' => [
+ 'description' => '需要指定删除的同义词的id列表',
'type' => 'array',
- 'items' => [
- 'description' => '数据权限-角色名称的具体名字',
- 'type' => 'string',
- 'required' => false,
- 'example' => '管理员',
- ],
- 'required' => false,
- ],
- 'userParams' => [
- 'description' => '数据角色依赖的自定义参数，当该角色配置了外部参数，必须传入'."\n"
- .'> 数据权限的相关配置内容需要在产品页面进行配置后，方可获取参数在api中调用',
- 'type' => 'any',
- 'required' => false,
- 'example' => '{'."\n"
- .' "shopId":['."\n"
- .' "1",'."\n"
- .' "2"'."\n"
- .' ],'."\n"
- .' "userId":"10001"'."\n"
- .'}',
- ],
- 'agentCtrlParams' => [
- 'description' => '当前对话接口所透传的自定义参数，现仅支持：跳过改写、跳过可视化模块、开启对话问题澄清',
- 'type' => 'any',
- 'required' => false,
- 'example' => '{'."\n"
- .' "withoutRewrite": true,'."\n"
- .' "withoutVisualization": true,'."\n"
- .' "enableChatMode": true'."\n"
- .'}',
+ 'items' => ['description' => '同义词id', 'type' => 'string', 'required' => false, 'example' => 'synonym-AAAAAAAAh6cWOUPagYstkg'],
+ 'required' => true,
],
],
'required' => false,
@@ -213,536 +93,118 @@
'responses' => [
200 => [
'schema' => [
- 'title' => 'Schema of Response',
- 'description' => 'Schema of Response',
+ 'title' => 'Result',
+ 'description' => 'Result',
'type' => 'object',
'properties' => [
- 'data' => [
- 'description' => '返回信息',
- 'type' => 'object',
- 'properties' => [
- 'errorMessage' => [
- 'description' => '错误信息',
- 'type' => 'string',
- 'example' => 'Access was denied, message: No such namespace namespaces/tech-scp-chain7.',
- ],
- 'event' => [
- 'description' => '事件类型',
- 'type' => 'string',
- 'enumValueTitles' => [
- 'result' => '最终结果事件',
- 'evidence' => '所用到的辅助模型推理的信息',
- 'sql_part' => '流式生成sql的中间事件',
- 'sql_data' => 'sql执行获取到结果的事件',
- 'selector' => '选表事件',
- 'refine' => '开启重试时的重试事件',
- 'rewrite' => '改写事件',
- 'sql' => '生成sql的最终事件',
- ],
- 'example' => 'rewrite',
- ],
- 'evidence' => [
- 'description' => '所用到的辅助模型推理的信息',
- 'type' => 'string',
- 'example' => '今年是2024年',
- ],
- 'requestId' => [
- 'description' => '当前本次请求的id',
- 'type' => 'string',
- 'example' => 'DA2578F7-88A5-5D6E-9305-33E724E97D60',
- ],
- 'rewrite' => [
- 'description' => '改写后的用户输入',
- 'type' => 'string',
- 'example' => '查询全部关键字数据，并以饼图形式展示',
- ],
- 'selector' => [
- 'description' => '这次对话，召回了哪些表以用于sql的生成',
- 'type' => 'array',
- 'items' => [
- 'description' => '召回的具体的表的名字',
- 'type' => 'string',
- 'example' => 'table_name1',
- ],
- ],
- 'sessionId' => [
- 'description' => '对话ID',
- 'type' => 'string',
- 'example' => 'sessionid1',
- ],
- 'sql' => [
- 'description' => '当前对话生成的SQL语句',
- 'type' => 'string',
- 'example' => 'select p.product_id, p.product_name, sum(o.quantity) as total_sales from products p join orders o on p.product_id = o.product_id where o.order_date between \'2022-10-22\' and \'2024-10-22\' group by p.product_id, p.product_name having total_sales > 5',
- ],
- 'sqlData' => [
- 'description' => 'sql执行所返回的结构化内容',
- 'type' => 'object',
- 'properties' => [
- 'column' => [
- 'description' => 'sql执行结果中，查询的具体的字段名字',
- 'type' => 'array',
- 'items' => [
- 'description' => '具体的字段名字内容',
- 'type' => 'string',
- 'example' => 'product',
- ],
- ],
- 'data' => [
- 'description' => 'sql执行后获取的结构化数据，可能是多条',
- 'type' => 'array',
- 'items' => [
- 'description' => 'sql执行后所查询到的结构化数据的一条内容',
- 'type' => 'object',
- 'example' => '{'."\n"
- .' "product_id": "29",'."\n"
- .' "total_sales": "63",'."\n"
- .' "product_name": "1L迷你电热水壶"'."\n"
- .' }',
- ],
- ],
- ],
- ],
- 'sqlError' => [
- 'description' => '当任务执行失败时，此字段会报错导致任务失败的原因',
- 'type' => 'string',
- 'example' => 'Can not issue data manipulation statements with executeQuery()',
- ],
- 'visualization' => [
- 'description' => '用于可视化模块展示所需要的信息',
- 'type' => 'object',
- 'properties' => [
- 'data' => [
- 'description' => '用于可视化模块展示的结构化信息',
- 'type' => 'object',
- 'properties' => [
- 'plotType' => [
- 'description' => '可视化图表展示的类型',
- 'type' => 'string',
- 'enumValueTitles' => [
- 'bar' => '柱状图',
- 'line' => '折线图',
- 'pie' => '饼状图',
- ],
- 'example' => 'bar',
- ],
- 'xAxis' => [
- 'description' => '可视化图表中x轴的内容',
- 'type' => 'array',
- 'items' => [
- 'description' => '具体某一个x轴所展示的字段',
- 'type' => 'string',
- 'example' => 'product_name',
- ],
- ],
- 'yAxis' => [
- 'description' => '可视化图表中y轴的内容',
- 'type' => 'array',
- 'items' => [
- 'description' => '具体某一个y轴所展示的字段',
- 'type' => 'string',
- 'example' => 'total_sales',
- ],
- ],
- 'stack' => [
- 'description' => '是否以堆叠的方式展示柱状图。仅当图表类型是柱状图的情况下，该参数才有效',
- 'type' => 'boolean',
- 'example' => 'false',
- ],
- 'option' => [
- 'description' => '初始化前端组件所需要的配置信息。仅当入参agentCtrlParams中chartsFramework=echarts时，该字段才有效',
- 'type' => 'string',
- 'example' => '{'."\n"
- .' xAxis: {'."\n"
- .' type: \'category\','."\n"
- .' data: [\'Mon\', \'Tue\', \'Wed\', \'Thu\', \'Fri\', \'Sat\', \'Sun\']'."\n"
- .' },'."\n"
- .' yAxis: {'."\n"
- .' type: \'value\''."\n"
- .' },'."\n"
- .' series: ['."\n"
- .' {'."\n"
- .' data: [150, 230, 224, 218, 135, 147, 260],'."\n"
- .' type: \'line\''."\n"
- .' }'."\n"
- .' ]'."\n"
- .'}',
- ],
- ],
- ],
- 'text' => [
- 'description' => '对于sql执行结果的分析总结',
- 'type' => 'string',
- 'example' => '查询结果显示，在过去两年中销量超过5的所有产品包括：2L大容量空气炸锅销售了109件，青春版运动手环销售了119件，2L大容量全自动豆浆机销售了106件，无线蓝牙耳机快充版销售了84件，2L大容量便携式榨汁机销售了136件，青春版智能手表销售了104件，挂壁式护眼台灯销售了102件，P30手机8+256G销售了83件，2L大容量电热水壶销售了84件，男士电动化妆刷套装销售了197件，旅行箱销售了82件，手链销售了101件，项链销售了84件，头饰发链销售了89件，腕表销售了98件，戒指销售了157件，真皮皮包销售了136件，风衣大衣销售了76件，运动旅行包销售了91件，丝巾销售了265件，1L迷你空气炸锅销售了85件，豪华款运动手环销售了132件，1L迷你全自动豆浆机销售了81件，豪华版无线蓝牙耳机（绿色）销售了122件，1L迷你便携式榨汁机销售了76件，豪华款智能手表销售了76件，粘贴式护眼台灯销售了109件，M60手机16+512G销售了109件，1L迷你电热水壶销售了63件，女士电动化妆刷套装销售了158件。',
- ],
- ],
- ],
- 'httpStatusCode' => [
- 'description' => '当前某一轮事件透出的http状态码，正常情况下不会额外透出，无需处理',
- 'type' => 'integer',
- 'format' => 'int64',
- 'example' => '200',
- ],
- 'attempts' => [
- 'description' => '开启sql校验时会输出的事件类型字段，包含每轮重试生成的sql以及报错原因',
- 'type' => 'array',
- 'items' => [
- 'description' => '每伦重试生成的具体sql、具体的报错信息',
- 'type' => 'any',
- 'example' => '[{"sql":"SHOW TABLES","sqlError":"sql is invalid"},{"sql":"SHOW TABLES;","sqlError":"sql is invalid"}]',
- ],
- ],
- 'chat' => [
- 'description' => '澄清事件，当用户问题较模糊并开启了需要澄清的开关时产生的事件',
- 'type' => 'object',
- 'properties' => [
- 'text' => [
- 'description' => '澄清话术，模型判断当前用户问题与当前关联数据内容信息不匹配时所产生的反问话术，帮助用户确认问题内容',
- 'type' => 'string',
- 'example' => '您想查询的是订单表的创建时间字段嘛？',
- ],
- ],
- ],
- ],
- ],
- 'message' => [
- 'description' => '系统错误透出的报错信息，用于报错排查，无需用户处理',
- 'type' => 'string',
- 'example' => 'org.springframework.core.task.TaskRejectedException: ExecutorService in active state did not accept task: java.util.concurrent.CompletableFuture$AsyncSupply@25653b3b',
- ],
- 'code' => [
- 'description' => '系统错误透出的错误码，用于报错排查，无需用户处理',
- 'type' => 'string',
- 'example' => 'NoAuth',
- ],
- 'httpStatusCode' => [
- 'description' => '当前本次请求透出的http状态码，正常情况下不会额外透出，无需处理',
- 'type' => 'integer',
- 'format' => 'int64',
- 'example' => '200',
- ],
+ 'data' => ['description' => '返回信息', 'type' => 'any', 'example' => 'true'],
+ 'errorMsg' => ['description' => '错误描述信息', 'type' => 'string', 'example' => 'NoAuth'],
+ 'code' => ['description' => '错误码', 'type' => 'string', 'example' => 'NoAuth'],
+ 'success' => ['description' => 'true 接口调用成功，false 接口调用失败', 'type' => 'boolean', 'example' => 'true'],
+ 'requestId' => ['description' => '请求id，每次请求都是唯一值，便于后续排查问题', 'type' => 'string', 'example' => '45390C6D-016D-5030-BF65-031ED1F65003'],
],
],
],
],
'errorCodes' => [
401 => [
- [
- 'errorCode' => 'NoAuth',
- 'errorMessage' => 'Bad Request: Workspace.Illegal.Auth.',
- ],
- [
- 'errorCode' => 'Internal.Error',
- 'errorMessage' => 'Bad Request: Internal Error.',
- ],
+ ['errorCode' => 'Internal.Error', 'errorMessage' => 'Bad Request: Internal Error.', 'description' => '内部错误，请联系客服人员排查'],
+ ['errorCode' => 'NoResourceAuth', 'errorMessage' => 'Bad Request: Resource Auth Error.', 'description' => '没有请求的资源的权限，请确保所请求的资源属于当前参数中的业务空间'],
+ ['errorCode' => 'NoAuth', 'errorMessage' => 'Bad Request: Workspace.Illegal.Auth.', 'description' => '当前所使用的账号无所指定业务空间的权限'],
+ ['errorCode' => 'SystemOperationInProgress', 'errorMessage' => 'Xiyan GBI is learning your previous modifications. Please try again later.', 'description' => '析言GBI正在学习您之前的修改内容，请稍后重试'],
],
],
- 'staticInfo' => [
- 'returnType' => 'synchronous',
- ],
- 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"data\\": {\\n \\"errorMessage\\": \\"Access was denied, message: No such namespace namespaces/tech-scp-chain7.\\",\\n \\"event\\": \\"rewrite\\",\\n \\"evidence\\": \\"今年是2024年\\",\\n \\"requestId\\": \\"DA2578F7-88A5-5D6E-9305-33E724E97D60\\",\\n \\"rewrite\\": \\"查询全部关键字数据，并以饼图形式展示\\",\\n \\"selector\\": [\\n \\"table_name1\\"\\n ],\\n \\"sessionId\\": \\"sessionid1\\",\\n \\"sql\\": \\"select p.product_id, p.product_name, sum(o.quantity) as total_sales from products p join orders o on p.product_id = o.product_id where o.order_date between \'2022-10-22\' and \'2024-10-22\' group by p.product_id, p.product_name having total_sales > 5\\",\\n \\"sqlData\\": {\\n \\"column\\": [\\n \\"product\\"\\n ],\\n \\"data\\": [\\n {\\n \\"product_id\\": \\"29\\",\\n \\"total_sales\\": \\"63\\",\\n \\"product_name\\": \\"1L迷你电热水壶\\"\\n }\\n ]\\n },\\n \\"sqlError\\": \\"Can not issue data manipulation statements with executeQuery()\\",\\n \\"visualization\\": {\\n \\"data\\": {\\n \\"plotType\\": \\"bar\\",\\n \\"xAxis\\": [\\n \\"product_name\\"\\n ],\\n \\"yAxis\\": [\\n \\"total_sales\\"\\n ],\\n \\"stack\\": false,\\n \\"option\\": \\"{\\\\n xAxis: {\\\\n type: \'category\',\\\\n data: [\'Mon\', \'Tue\', \'Wed\', \'Thu\', \'Fri\', \'Sat\', \'Sun\']\\\\n },\\\\n yAxis: {\\\\n type: \'value\'\\\\n },\\\\n series: [\\\\n {\\\\n data: [150, 230, 224, 218, 135, 147, 260],\\\\n type: \'line\'\\\\n }\\\\n ]\\\\n}\\"\\n },\\n \\"text\\": \\"查询结果显示，在过去两年中销量超过5的所有产品包括：2L大容量空气炸锅销售了109件，青春版运动手环销售了119件，2L大容量全自动豆浆机销售了106件，无线蓝牙耳机快充版销售了84件，2L大容量便携式榨汁机销售了136件，青春版智能手表销售了104件，挂壁式护眼台灯销售了102件，P30手机8+256G销售了83件，2L大容量电热水壶销售了84件，男士电动化妆刷套装销售了197件，旅行箱销售了82件，手链销售了101件，项链销售了84件，头饰发链销售了89件，腕表销售了98件，戒指销售了157件，真皮皮包销售了136件，风衣大衣销售了76件，运动旅行包销售了91件，丝巾销售了265件，1L迷你空气炸锅销售了85件，豪华款运动手环销售了132件，1L迷你全自动豆浆机销售了81件，豪华版无线蓝牙耳机（绿色）销售了122件，1L迷你便携式榨汁机销售了76件，豪华款智能手表销售了76件，粘贴式护眼台灯销售了109件，M60手机16+512G销售了109件，1L迷你电热水壶销售了63件，女士电动化妆刷套装销售了158件。\\"\\n },\\n \\"httpStatusCode\\": 200,\\n \\"attempts\\": [\\n \\"[{\\\\\\"sql\\\\\\":\\\\\\"SHOW TABLES\\\\\\",\\\\\\"sqlError\\\\\\":\\\\\\"sql is invalid\\\\\\"},{\\\\\\"sql\\\\\\":\\\\\\"SHOW TABLES;\\\\\\",\\\\\\"sqlError\\\\\\":\\\\\\"sql is invalid\\\\\\"}]\\"\\n ],\\n \\"chat\\": {\\n \\"text\\": \\"您想查询的是订单表的创建时间字段嘛？\\"\\n }\\n },\\n \\"message\\": \\"org.springframework.core.task.TaskRejectedException: ExecutorService in active state did not accept task: java.util.concurrent.CompletableFuture$AsyncSupply@25653b3b\\",\\n \\"code\\": \\"NoAuth\\",\\n \\"httpStatusCode\\": 200\\n}","type":"json"}]',
- 'title' => 'Chat对话接口',
- 'description' => '请确保在使用该接口前，已充分了解析言产品的收费方式和[价格](https://common-buy.aliyun.com/?&msctype=email&mscareaid=cn&mscsiteid=cn&mscmsgid=3800124102101018568&yunge_info=email___3800124102101018568&commodityCode=sfm_DataAnalysisGBI_public_cn)。',
+ 'staticInfo' => ['returnType' => 'synchronous'],
+ 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"data\\": \\"true\\",\\n \\"errorMsg\\": \\"NoAuth\\",\\n \\"code\\": \\"NoAuth\\",\\n \\"success\\": true,\\n \\"requestId\\": \\"45390C6D-016D-5030-BF65-031ED1F65003\\"\\n}","type":"json"}]',
+ 'title' => '批量删除同义词',
+ 'changeSet' => [],
],
- 'RunDataResultAnalysis' => [
- 'summary' => '对结构化数据类型的执行结果进行分析、可视化信息生成。',
- 'path' => '/gbi/runDataResultAnalysis',
- 'methods' => [
- 'post',
- ],
- 'schemes' => [
- 'https',
- 'sse',
- ],
+ 'CancelDatasourceAuthorization' => [
+ 'summary' => '取消关联的数据源授权。',
+ 'path' => '/gbi/cancel/datasource',
+ 'methods' => ['post'],
+ 'schemes' => ['https'],
'security' => [
[
'AK' => [],
],
],
- 'consumes' => [
- 'application/json',
- ],
- 'produces' => [
- 'application/json',
- ],
- 'operationType' => 'read',
+ 'consumes' => ['application/json'],
+ 'produces' => ['application/json'],
+ 'operationType' => 'write',
'deprecated' => false,
- 'systemTags' => [
- 'operationType' => 'none',
- 'riskType' => 'none',
- 'chargeType' => 'free',
- 'tenantRelevance' => 'tenant',
- ],
+ 'systemTags' => ['operationType' => 'none', 'riskType' => 'none', 'chargeType' => 'free'],
'parameters' => [
[
'name' => 'workspaceId',
'in' => 'query',
- 'schema' => [
- 'description' => '当前请求所使用的阿里云百炼业务空间id',
- 'type' => 'string',
- 'required' => true,
- 'example' => 'llm-2v3934xtp49esw64'."\n",
- ],
- ],
- [
- 'name' => 'body',
- 'in' => 'body',
- 'style' => 'json',
- 'schema' => [
- 'description' => '请求体参数',
- 'type' => 'object',
- 'properties' => [
- 'sqlData' => [
- 'description' => 'sql执行后所查询到的结构化数据内容，当前情况下此参数必传'."\n"
- .'<details>'."\n"
- .'<summary>sqlData示例子</summary>'."\n"
- .'{'."\n"
- .' "column": ['."\n"
- .' "month",'."\n"
- .' "total_received"'."\n"
- .' ],'."\n"
- .' "data": ['."\n"
- .' {'."\n"
- .' "month": "2024-01",'."\n"
- .' "total_received": "603"'."\n"
- .' },'."\n"
- .' {'."\n"
- .' "month": "2024-02",'."\n"
- .' "total_received": "749"'."\n"
- .' },'."\n"
- .' {'."\n"
- .' "month": "2024-03",'."\n"
- .' "total_received": "1311"'."\n"
- .' },'."\n"
- .' {'."\n"
- .' "month": "2024-04",'."\n"
- .' "total_received": "1003"'."\n"
- .' },'."\n"
- .' {'."\n"
- .' "month": "2024-05",'."\n"
- .' "total_received": "726"'."\n"
- .' },'."\n"
- .' {'."\n"
- .' "month": "2024-06",'."\n"
- .' "total_received": "791"'."\n"
- .' },'."\n"
- .' {'."\n"
- .' "month": "2024-07",'."\n"
- .' "total_received": "60"'."\n"
- .' }'."\n"
- .' ]'."\n"
- .'}'."\n"
- .'</details>',
- 'type' => 'object',
- 'properties' => [
- 'column' => [
- 'description' => 'SQL执行结果中，查询到的具体的字段名字列表',
- 'type' => 'array',
- 'items' => [
- 'description' => 'SQL执行结果中，查询到的具体的列名',
- 'type' => 'string',
- 'required' => false,
- 'example' => 'month',
- ],
- 'required' => false,
- ],
- 'data' => [
- 'description' => '与SQL执行结果中的列名对应的结构化信息列表，详细结构可参考上方sqlData的示例',
- 'type' => 'array',
- 'items' => [
- 'description' => '与SQL执行结果中的列名对应的结构化信息，每一个代表着一行数据，其中的字段与表头列表应该为一一对应的关系',
- 'type' => 'object',
- 'required' => false,
- 'additionalProperties' => [
- 'type' => 'string',
- 'description' => '当前列名所对应的一条数据的具体内容',
- 'example' => '2024-01',
- ],
- ],
- 'required' => false,
- ],
- ],
- 'required' => false,
- ],
- 'analysisMode' => [
- 'description' => '当前希望执行的可视化类型，可以只生成图表或只生成文本分析',
- 'type' => 'string',
- 'required' => false,
- 'enumValueTitles' => [
- 'all' => '生成图表和文字分析',
- 'text' => '只生成文字分析',
- 'chart' => '只生成图表',
- ],
- 'example' => 'all',
- ],
- 'requestId' => [
- 'description' => '请求id，这里的请求id为RunSqlGeneration接口中执行返回的requestId，若传入未被RunSqlGeneration执行过的requestId，执行会被拒绝',
- 'type' => 'string',
- 'required' => true,
- 'example' => 'FF76AD3F-8B32-567E-819B-0D3738917006',
- ],
- ],
- 'required' => false,
- ],
+ 'schema' => ['description' => '当前请求所使用的阿里云百炼业务空间id', 'type' => 'string', 'required' => true, 'example' => 'llm-2v3934xtp49esw64'."\n"],
],
],
'responses' => [
200 => [
'schema' => [
- 'title' => 'SseEmitter',
- 'description' => 'Schema of Response',
+ 'title' => 'Result',
+ 'description' => 'Result',
'type' => 'object',
'properties' => [
- 'data' => [
- 'description' => '返回结果',
- 'type' => 'object',
- 'properties' => [
- 'errorMessage' => [
- 'description' => '错误信息',
- 'type' => 'string',
- 'example' => 'Access was denied, message: No such namespace namespaces/tech-scp-chain7.',
- ],
- 'event' => [
- 'description' => '事件类型',
- 'type' => 'string',
- 'enumValueTitles' => [
- 'result' => '结果事件',
- ],
- 'example' => 'result',
- ],
- 'requestId' => [
- 'description' => '当前本次请求的id',
- 'type' => 'string',
- 'example' => 'DA2578F7-88A5-5D6E-9305-33E724E97D60',
- ],
- 'visualization' => [
- 'description' => '用于可视化模块展示所需要的信息',
- 'type' => 'object',
- 'properties' => [
- 'data' => [
- 'description' => '数据列表',
- 'type' => 'object',
- 'properties' => [
- 'plotType' => [
- 'description' => '可视化图表展示的类型',
- 'type' => 'string',
- 'example' => 'bar',
- ],
- 'xAxis' => [
- 'description' => '具体某一个x轴所展示的字段列表',
- 'type' => 'array',
- 'items' => [
- 'description' => '具体某一个x轴所展示的字段',
- 'type' => 'string',
- 'example' => 'product_name',
- ],
- ],
- 'yAxis' => [
- 'description' => '具体某一个y轴所展示的字段列表',
- 'type' => 'array',
- 'items' => [
- 'description' => '具体某一个y轴所展示的字段',
- 'type' => 'string',
- 'example' => 'total_sales',
- ],
- ],
- ],
- ],
- 'text' => [
- 'description' => '对于sql执行结果的分析总结',
- 'type' => 'string',
- 'example' => '查询结果显示，在过去两年中销量超过5的所有产品包括：2L大容量空气炸锅销售了109件，青春版运动手环销售了119件，2L大容量全自动豆浆机销售了106件，无线蓝牙耳机快充版销售了84件，2L大容量便携式榨汁机销售了136件，青春版智能手表销售了104件，挂壁式护眼台灯销售了102件，P30手机8+256G销售了83件，2L大容量电热水壶销售了84件，男士电动化妆刷套装销售了197件，旅行箱销售了82件，手链销售了101件，项链销售了84件，头饰发链销售了89件，腕表销售了98件，戒指销售了157件，真皮皮包销售了136件，风衣大衣销售了76件，运动旅行包销售了91件，丝巾销售了265件，1L迷你空气炸锅销售了85件，豪华款运动手环销售了132件，1L迷你全自动豆浆机销售了81件，豪华版无线蓝牙耳机（绿色）销售了122件，1L迷你便携式榨汁机销售了76件，豪华款智能手表销售了76件，粘贴式护眼台灯销售了109件，M60手机16+512G销售了109件，1L迷你电热水壶销售了63件，女士电动化妆刷套装销售了158件。',
- ],
- ],
- ],
- 'sql' => [
- 'description' => '当前对话生成的SQL语句',
- 'type' => 'string',
- 'example' => 'select p.product_id, p.product_name, sum(o.quantity) as total_sales from products p join orders o on p.product_id = o.product_id where o.order_date between \'2022-10-22\' and \'2024-10-22\' group by p.product_id, p.product_name having total_sales > 5',
- ],
- 'rewrite' => [
- 'description' => '改写后的用户输入',
- 'type' => 'string',
- 'example' => '过去两年中，销量超过5的产品有哪些',
- ],
- ],
- ],
+ 'data' => ['description' => '返回信息', 'type' => 'any', 'example' => 'true'],
+ 'errorMsg' => ['description' => '错误描述信息', 'type' => 'string', 'example' => '""'],
+ 'code' => ['description' => '错误码', 'type' => 'string', 'example' => '""'],
+ 'success' => ['description' => 'true 接口调用成功，false 接口调用失败', 'type' => 'boolean', 'example' => 'true'],
+ 'requestId' => ['description' => '请求id，每次请求都是唯一值，便于后续排查问题', 'type' => 'string', 'example' => 'FB11F719-9AC8-5C99-AB0A-4709D437FCFC'],
],
],
],
],
'errorCodes' => [
401 => [
- [
- 'errorCode' => 'Internal.Error',
- 'errorMessage' => 'Bad Request: Internal Error.',
- ],
- [
- 'errorCode' => 'NoAuth',
- 'errorMessage' => 'Bad Request: Workspace.Illegal.Auth.',
- ],
- [
- 'errorCode' => 'NoResourceAuth',
- 'errorMessage' => 'Bad Request: Resource Auth Error.',
- ],
- [
- 'errorCode' => 'Invalid.RequestId',
- 'errorMessage' => 'Bad Request: Invalid RequestId.',
- ],
+ ['errorCode' => 'NoAuth', 'errorMessage' => 'Bad Request: Workspace.Illegal.Auth.', 'description' => '当前所使用的账号无所指定业务空间的权限'],
+ ['errorCode' => 'Internal.Error', 'errorMessage' => 'Bad Request: Internal Error.', 'description' => '内部错误，请联系客服人员排查'],
],
],
- 'staticInfo' => [
- 'returnType' => 'synchronous',
+ 'staticInfo' => ['returnType' => 'synchronous'],
+ 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"data\\": \\"true\\",\\n \\"errorMsg\\": \\"\\\\\\"\\\\\\"\\",\\n \\"code\\": \\"\\\\\\"\\\\\\"\\",\\n \\"success\\": true,\\n \\"requestId\\": \\"FB11F719-9AC8-5C99-AB0A-4709D437FCFC\\"\\n}","type":"json"}]',
+ 'title' => '取消数据源关联关系授权',
+ 'responseParamsDescription' => '当 success 为 true 时，errorMsg 和 code 应为空字符串 ""。',
+ 'changeSet' => [],
+ 'flowControl' => [
+ 'flowControlList' => [],
+ ],
+ 'ramActions' => [
+ [
+ 'operationType' => 'none',
+ 'ramAction' => [
+ 'action' => 'dataanalysisgbi:CancelDatasourceAuthorization',
+ 'authLevel' => 'operate',
+ 'actionConditions' => [],
+ 'resources' => [
+ ['validationType' => 'always', 'product' => 'DataAnalysisGBI', 'resourceType' => '全部资源', 'arn' => '*'],
+ ],
+ ],
+ ],
],
- 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"data\\": {\\n \\"errorMessage\\": \\"Access was denied, message: No such namespace namespaces/tech-scp-chain7.\\",\\n \\"event\\": \\"result\\",\\n \\"requestId\\": \\"DA2578F7-88A5-5D6E-9305-33E724E97D60\\",\\n \\"visualization\\": {\\n \\"data\\": {\\n \\"plotType\\": \\"bar\\",\\n \\"xAxis\\": [\\n \\"product_name\\"\\n ],\\n \\"yAxis\\": [\\n \\"total_sales\\"\\n ]\\n },\\n \\"text\\": \\"查询结果显示，在过去两年中销量超过5的所有产品包括：2L大容量空气炸锅销售了109件，青春版运动手环销售了119件，2L大容量全自动豆浆机销售了106件，无线蓝牙耳机快充版销售了84件，2L大容量便携式榨汁机销售了136件，青春版智能手表销售了104件，挂壁式护眼台灯销售了102件，P30手机8+256G销售了83件，2L大容量电热水壶销售了84件，男士电动化妆刷套装销售了197件，旅行箱销售了82件，手链销售了101件，项链销售了84件，头饰发链销售了89件，腕表销售了98件，戒指销售了157件，真皮皮包销售了136件，风衣大衣销售了76件，运动旅行包销售了91件，丝巾销售了265件，1L迷你空气炸锅销售了85件，豪华款运动手环销售了132件，1L迷你全自动豆浆机销售了81件，豪华版无线蓝牙耳机（绿色）销售了122件，1L迷你便携式榨汁机销售了76件，豪华款智能手表销售了76件，粘贴式护眼台灯销售了109件，M60手机16+512G销售了109件，1L迷你电热水壶销售了63件，女士电动化妆刷套装销售了158件。\\"\\n },\\n \\"sql\\": \\"select p.product_id, p.product_name, sum(o.quantity) as total_sales from products p join orders o on p.product_id = o.product_id where o.order_date between \'2022-10-22\' and \'2024-10-22\' group by p.product_id, p.product_name having total_sales > 5\\",\\n \\"rewrite\\": \\"过去两年中，销量超过5的产品有哪些\\"\\n }\\n}","type":"json"}]',
- 'title' => '执行结果分析',
],
- 'RunSqlGeneration' => [
- 'summary' => '运行sql生成，根据当前的query信息，结合已关联的数据表，进行sql语句的生成。'."\n"
- ."\n"
- .'该接口适合以下场景：'."\n"
- .'您的数据库在本地，不能被析言访问。'."\n"
- .'您可以通过析言关联虚拟数据源，调用该接口生成SQL，然后自行解析和执行SQL。'."\n"
- ."\n"
- .'具体的使用，可以参考以下最佳实践文档：'."\n"
- .'https://help.aliyun.com/zh/model-studio/xiyan-gbi-local-data-best-practices',
- 'path' => '/gbi/runSqlGeneration',
- 'methods' => [
- 'post',
- ],
- 'schemes' => [
- 'https',
- 'sse',
- ],
+ 'CreateBusinessLogic' => [
+ 'summary' => '在指定的业务空间下创建新的业务逻辑解释。',
+ 'path' => '/gbi/create/logic',
+ 'methods' => ['post'],
+ 'schemes' => ['https'],
'security' => [
[
'AK' => [],
],
],
- 'consumes' => [
- 'application/json',
- ],
- 'produces' => [
- 'application/json',
- ],
- 'operationType' => 'read',
+ 'consumes' => ['application/json'],
+ 'produces' => ['application/json'],
+ 'operationType' => 'write',
'deprecated' => false,
- 'systemTags' => [
- 'operationType' => 'none',
- 'riskType' => 'none',
- 'chargeType' => 'free',
- 'tenantRelevance' => 'tenant',
- ],
+ 'systemTags' => ['operationType' => 'none', 'riskType' => 'none', 'chargeType' => 'free'],
'parameters' => [
[
'name' => 'workspaceId',
'in' => 'query',
- 'schema' => [
- 'description' => '当前请求所使用的阿里云百炼业务空间id',
- 'type' => 'string',
- 'required' => true,
- 'example' => 'llm-2v3934xtp49esw64'."\n",
- ],
+ 'schema' => ['description' => '当前请求所使用的阿里云百炼业务空间id', 'type' => 'string', 'required' => true, 'example' => 'llm-2v3934xtp49esw64'."\n"],
],
[
'name' => 'body',
@@ -752,29 +214,15 @@
'description' => '请求体参数',
'type' => 'object',
'properties' => [
- 'specificationType' => [
- 'description' => '当前请求指定使用的版本信息，不填时使用默认业务空间版本',
- 'type' => 'string',
- 'required' => false,
- 'enumValueTitles' => [
- 'STANDARD_TURBO' => '标准版turbo',
- 'STANDARD_MIX' => '标准版mix',
- 'CUSTOMIZATION' => '定制版turbo',
- ],
- 'example' => 'STANDARD_MIX',
- ],
- 'query' => [
- 'description' => '用户输入的query',
- 'type' => 'string',
- 'required' => true,
- 'example' => '请问销量前十的产品有哪些',
- ],
- 'sessionId' => [
- 'description' => '消息会话ID，多条requestId可以属于同一个会话sessionId',
- 'type' => 'string',
+ 'type' => [
+ 'description' => '创建的业务逻辑解释的类型',
+ 'type' => 'integer',
+ 'format' => 'int32',
'required' => false,
- 'example' => 'd5eced84-fd25-43ee-a245-adb4e4a8c3be',
+ 'enumValueTitles' => ['全局', '系统智能判断'],
+ 'example' => '1',
],
+ 'description' => ['description' => '业务逻辑解释的具体内容', 'type' => 'string', 'required' => false, 'example' => '冬季指的是，当年10月到第二年的三月'],
],
'required' => false,
],
@@ -783,147 +231,64 @@
'responses' => [
200 => [
'schema' => [
- 'title' => 'SseEmitter',
- 'description' => 'SseEmitter',
+ 'title' => 'Result',
+ 'description' => 'Result',
'type' => 'object',
'properties' => [
- 'data' => [
- 'description' => '返回信息',
- 'type' => 'object',
- 'properties' => [
- 'errorMessage' => [
- 'description' => '错误信息',
- 'type' => 'string',
- 'example' => 'Access was denied, message: No such namespace namespaces/tech-scp-chain7.',
- ],
- 'event' => [
- 'description' => '事件类型',
- 'type' => 'string',
- 'enumValueTitles' => [
- 'evidence' => '所用到的辅助模型推理的信息',
- 'sql_part' => '流式生成sql的中间事件',
- 'selector' => '选表事件',
- 'rewrite' => '改写事件',
- 'sql' => '生成sql的最终事件',
- ],
- 'example' => 'sql',
- ],
- 'evidence' => [
- 'description' => '所用到的辅助模型推理的信息',
- 'type' => 'string',
- 'example' => '今年是2024年',
- ],
- 'requestId' => [
- 'description' => '当前本次请求的id',
- 'type' => 'string',
- 'example' => 'DA2578F7-88A5-5D6E-9305-33E724E97D60',
- ],
- 'rewrite' => [
- 'description' => '改写后的用户输入',
- 'type' => 'string',
- 'example' => '查询全部关键字数据，并以饼图形式展示',
- ],
- 'selector' => [
- 'description' => '召回的具体的表的名字列表',
- 'type' => 'array',
- 'items' => [
- 'description' => '召回的具体的表的名字',
- 'type' => 'string',
- 'example' => 'table_name1',
- ],
- ],
- 'sessionId' => [
- 'description' => '对话ID',
- 'type' => 'string',
- 'example' => 'f64c38dd-a235-4bb4-ae6c-79eaedcba699',
- ],
- 'sql' => [
- 'description' => '当前对话生成的SQL语句',
- 'type' => 'string',
- 'example' => 'select p.product_id, p.product_name, sum(o.quantity) as total_sales from products p join orders o on p.product_id = o.product_id where o.order_date between \'2022-10-22\' and \'2024-10-22\' group by p.product_id, p.product_name having total_sales > 5',
- ],
- 'sqlError' => [
- 'description' => '当任务执行失败时，此字段会报错导致任务失败的原因',
- 'type' => 'string',
- 'example' => 'Can not issue data manipulation statements with executeQuery()',
- ],
- 'chat' => [
- 'type' => 'object',
- 'properties' => [
- 'text' => [
- 'type' => 'string',
- ],
- ],
- ],
- ],
- ],
+ 'data' => ['description' => '返回信息', 'type' => 'any', 'example' => 'true'],
+ 'errorMsg' => ['description' => '错误描述信息', 'type' => 'string', 'example' => 'NoAuth'],
+ 'code' => ['description' => '错误码', 'type' => 'string', 'example' => 'NoAuth'],
+ 'success' => ['description' => 'true 接口调用成功，false 接口调用失败', 'type' => 'boolean', 'example' => 'true'],
+ 'requestId' => ['description' => '请求id，每次请求都是唯一值，便于后续排查问题', 'type' => 'string', 'example' => 'FB11F719-9AC8-5C99-AB0A-4709D437FCFC'],
],
],
],
],
'errorCodes' => [
401 => [
- [
- 'errorCode' => 'Internal.Error',
- 'errorMessage' => 'Bad Request: Internal Error.',
- ],
- [
- 'errorCode' => 'NoAuth',
- 'errorMessage' => 'Bad Request: Workspace.Illegal.Auth.',
- ],
- [
- 'errorCode' => 'NoResourceAuth',
- 'errorMessage' => 'Bad Request: Resource Auth Error.',
- ],
- [
- 'errorCode' => 'SystemOperationInProgress',
- 'errorMessage' => 'Xiyan GBI is learning your previous modifications. Please try again later.',
- ],
+ ['errorCode' => 'Internal.Error', 'errorMessage' => 'Bad Request: Internal Error.', 'description' => '内部错误，请联系客服人员排查'],
+ ['errorCode' => 'NoAuth', 'errorMessage' => 'Bad Request: Workspace.Illegal.Auth.', 'description' => '当前所使用的账号无所指定业务空间的权限'],
+ ['errorCode' => 'NoResourceAuth', 'errorMessage' => 'Bad Request: Resource Auth Error.', 'description' => '没有请求的资源的权限，请确保所请求的资源属于当前参数中的业务空间'],
],
],
- 'staticInfo' => [
- 'returnType' => 'synchronous',
+ 'staticInfo' => ['returnType' => 'synchronous'],
+ 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"data\\": \\"true\\",\\n \\"errorMsg\\": \\"NoAuth\\",\\n \\"code\\": \\"NoAuth\\",\\n \\"success\\": true,\\n \\"requestId\\": \\"FB11F719-9AC8-5C99-AB0A-4709D437FCFC\\"\\n}","type":"json"}]',
+ 'title' => '创建业务逻辑解释',
+ 'changeSet' => [],
+ 'ramActions' => [
+ [
+ 'operationType' => 'none',
+ 'ramAction' => [
+ 'action' => 'dataanalysisgbi:CreateBusinessLogic',
+ 'authLevel' => 'operate',
+ 'actionConditions' => [],
+ 'resources' => [
+ ['validationType' => 'always', 'product' => 'DataAnalysisGBI', 'resourceType' => '全部资源', 'arn' => '*'],
+ ],
+ ],
+ ],
],
- 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"data\\": {\\n \\"errorMessage\\": \\"Access was denied, message: No such namespace namespaces/tech-scp-chain7.\\",\\n \\"event\\": \\"sql\\",\\n \\"evidence\\": \\"今年是2024年\\",\\n \\"requestId\\": \\"DA2578F7-88A5-5D6E-9305-33E724E97D60\\",\\n \\"rewrite\\": \\"查询全部关键字数据，并以饼图形式展示\\",\\n \\"selector\\": [\\n \\"table_name1\\"\\n ],\\n \\"sessionId\\": \\"f64c38dd-a235-4bb4-ae6c-79eaedcba699\\",\\n \\"sql\\": \\"select p.product_id, p.product_name, sum(o.quantity) as total_sales from products p join orders o on p.product_id = o.product_id where o.order_date between \'2022-10-22\' and \'2024-10-22\' group by p.product_id, p.product_name having total_sales > 5\\",\\n \\"sqlError\\": \\"Can not issue data manipulation statements with executeQuery()\\",\\n \\"chat\\": {\\n \\"text\\": \\"\\"\\n }\\n }\\n}","type":"json"}]',
- 'title' => '运行sql生成',
],
- 'UpdateBusinessLogic' => [
- 'summary' => '修改当前指定业务空间下所指定的业务逻辑解释。',
- 'path' => '/gbi/update/logic',
- 'methods' => [
- 'post',
- ],
- 'schemes' => [
- 'https',
- ],
+ 'CreateDatasourceAuthorization' => [
+ 'summary' => '创建数据库关联授权，在您指定的业务空间，对指定的数据源进行关联关系的创建，创建后可以对数据源下的表结构进行采集。',
+ 'path' => '/gbi/create/datasource',
+ 'methods' => ['post'],
+ 'schemes' => ['https'],
'security' => [
[
'AK' => [],
],
],
- 'consumes' => [
- 'application/json',
- ],
- 'produces' => [
- 'application/json',
- ],
+ 'consumes' => ['application/json'],
+ 'produces' => ['application/json'],
'operationType' => 'write',
'deprecated' => false,
- 'systemTags' => [
- 'operationType' => 'none',
- 'riskType' => 'none',
- 'chargeType' => 'free',
- ],
+ 'systemTags' => ['operationType' => 'none', 'riskType' => 'none', 'chargeType' => 'free'],
'parameters' => [
[
'name' => 'workspaceId',
'in' => 'query',
- 'schema' => [
- 'description' => '当前请求所使用的阿里云百炼业务空间id',
- 'type' => 'string',
- 'required' => true,
- 'example' => 'llm-2v3934xtp49esw64'."\n",
- ],
+ 'schema' => ['description' => '当前请求所使用的阿里云百炼业务空间id', 'type' => 'string', 'required' => true, 'example' => 'llm-2v3934xtp49esw64'."\n"],
],
[
'name' => 'body',
@@ -933,29 +298,18 @@
'description' => '请求体参数',
'type' => 'object',
'properties' => [
- 'businessLogicIdKey' => [
- 'description' => '业务逻辑解释的唯一标识符id',
- 'type' => 'string',
- 'required' => true,
- 'example' => 'businessLogic-AAAAAAAAAGAIyJoP7LbKuA',
- ],
- 'description' => [
- 'description' => '业务逻辑解释的内容',
- 'type' => 'string',
- 'required' => true,
- 'example' => '冬季指的是10月到去年三月',
- ],
'type' => [
- 'description' => '业务逻辑解释的类型',
+ 'description' => '当前关联数据源的类型',
'type' => 'integer',
- 'format' => 'int64',
+ 'format' => 'int32',
'required' => true,
- 'enumValueTitles' => [
- '全局',
- '系统智能判断',
- ],
- 'example' => '0',
+ 'enumValueTitles' => [1 => 'mysql类型数据源', 'postgresql类型数据源', 10 => 'hologress类型数据源', 'mysql类型数据源使用vpc链接', 'postgresql类型数据源使用vpc链接', 51 => 'mysql类型虚拟数据源实例', 'postgresql类型虚拟数据源实例'],
+ 'example' => '1',
],
+ 'url' => ['description' => '当前创建数据源的jdbc链接串地址', 'type' => 'string', 'required' => false, 'example' => 'jdbc:mysql://rm-2zedvv990c8d8rj8ejo.mysql.rds.aliyuncs.com:3306/gbi_good_case'],
+ 'userName' => ['description' => '登录当前数据源的用户名名称', 'type' => 'string', 'required' => false, 'example' => 'root'],
+ 'password' => ['description' => '登录当前数据源所使用的用户名的密码', 'type' => 'string', 'required' => false, 'example' => 'password'],
+ 'vdbId' => ['description' => '关联的类型为虚拟数据源时填写，内容为虚拟数据源的实例id，其他情况无需填写', 'type' => 'string', 'required' => false, 'example' => 'vdb-E0F693C8-9F72-5830-B81A-696C9D8EBBD1'."\n"],
],
'required' => false,
],
@@ -968,98 +322,59 @@
'description' => 'Result',
'type' => 'object',
'properties' => [
- 'data' => [
- 'description' => '返回信息',
- 'type' => 'any',
- 'example' => 'true',
- ],
- 'errorMsg' => [
- 'description' => '错误描述信息',
- 'type' => 'string',
- 'example' => 'NoAuth',
- ],
- 'code' => [
- 'description' => '错误码',
- 'type' => 'string',
- 'example' => 'NoAuth',
- ],
- 'success' => [
- 'description' => 'true 接口调用成功，false 接口调用失败',
- 'type' => 'boolean',
- 'example' => 'true',
- ],
- 'requestId' => [
- 'description' => '请求id，每次请求都是唯一值，便于后续排查问题',
- 'type' => 'string',
- 'example' => 'FB11F719-9AC8-5C99-AB0A-4709D437FCFC',
- ],
+ 'data' => ['description' => '返回信息', 'type' => 'any', 'example' => 'true'],
+ 'errorMsg' => ['description' => '错误描述信息', 'type' => 'string', 'example' => 'NoAuth'],
+ 'code' => ['description' => '错误码', 'type' => 'string', 'example' => 'NoAuth'],
+ 'success' => ['description' => 'true 接口调用成功，false 接口调用失败', 'type' => 'boolean', 'example' => 'true'],
+ 'requestId' => ['description' => '请求id，每次请求都是唯一值，便于后续排查问题', 'type' => 'string', 'example' => 'E0F693C8-9F72-5830-B81A-696C9D8EBBD1'],
],
],
],
],
'errorCodes' => [
401 => [
- [
- 'errorCode' => 'Internal.Error',
- 'errorMessage' => 'Bad Request: Internal Error.',
- ],
- [
- 'errorCode' => 'NoAuth',
- 'errorMessage' => 'Bad Request: Workspace.Illegal.Auth.',
- ],
- [
- 'errorCode' => 'NoResourceAuth',
- 'errorMessage' => 'Bad Request: Resource Auth Error.',
- ],
- [
- 'errorCode' => 'SystemOperationInProgress',
- 'errorMessage' => 'Xiyan GBI is learning your previous modifications. Please try again later.',
- ],
+ ['errorCode' => 'NoAuth', 'errorMessage' => 'Bad Request: Workspace.Illegal.Auth.', 'description' => '当前所使用的账号无所指定业务空间的权限'],
+ ['errorCode' => 'Internal.Error', 'errorMessage' => 'Bad Request: Internal Error.', 'description' => '内部错误，请联系客服人员排查'],
],
],
- 'staticInfo' => [
- 'returnType' => 'synchronous',
+ 'staticInfo' => ['returnType' => 'synchronous'],
+ 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"data\\": \\"true\\",\\n \\"errorMsg\\": \\"NoAuth\\",\\n \\"code\\": \\"NoAuth\\",\\n \\"success\\": true,\\n \\"requestId\\": \\"E0F693C8-9F72-5830-B81A-696C9D8EBBD1\\"\\n}","type":"json"}]',
+ 'title' => '数据源关联关系授权',
+ 'changeSet' => [],
+ 'ramActions' => [
+ [
+ 'operationType' => 'none',
+ 'ramAction' => [
+ 'action' => 'dataanalysisgbi:CreateDatasourceAuthorization',
+ 'authLevel' => 'operate',
+ 'actionConditions' => [],
+ 'resources' => [
+ ['validationType' => 'always', 'product' => 'DataAnalysisGBI', 'resourceType' => '全部资源', 'arn' => '*'],
+ ],
+ ],
+ ],
],
- 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"data\\": \\"true\\",\\n \\"errorMsg\\": \\"NoAuth\\",\\n \\"code\\": \\"NoAuth\\",\\n \\"success\\": true,\\n \\"requestId\\": \\"FB11F719-9AC8-5C99-AB0A-4709D437FCFC\\"\\n}","type":"json"}]',
- 'title' => '修改业务逻辑解释',
],
- 'CreateBusinessLogic' => [
- 'summary' => '在指定的业务空间下创建新的业务逻辑解释。',
- 'path' => '/gbi/create/logic',
- 'methods' => [
- 'post',
- ],
- 'schemes' => [
- 'https',
- ],
+ 'CreateSynonyms' => [
+ 'summary' => '在当前指定的业务空间下面，新建同义词。',
+ 'path' => '/gbi/create/synonyms',
+ 'methods' => ['post'],
+ 'schemes' => ['https'],
'security' => [
[
'AK' => [],
],
],
- 'consumes' => [
- 'application/json',
- ],
- 'produces' => [
- 'application/json',
- ],
- 'operationType' => 'write',
+ 'consumes' => ['application/json'],
+ 'produces' => ['application/json'],
+ 'operationType' => 'readAndWrite',
'deprecated' => false,
- 'systemTags' => [
- 'operationType' => 'none',
- 'riskType' => 'none',
- 'chargeType' => 'free',
- ],
+ 'systemTags' => ['operationType' => 'none', 'riskType' => 'none', 'chargeType' => 'free'],
'parameters' => [
[
'name' => 'workspaceId',
'in' => 'query',
- 'schema' => [
- 'description' => '当前请求所使用的阿里云百炼业务空间id',
- 'type' => 'string',
- 'required' => true,
- 'example' => 'llm-2v3934xtp49esw64'."\n",
- ],
+ 'schema' => ['description' => '当前请求所使用的阿里云百炼业务空间id', 'type' => 'string', 'required' => true, 'example' => 'llm-2v3934xtp49esw64'."\n"],
],
[
'name' => 'body',
@@ -1069,22 +384,19 @@
'description' => '请求体参数',
'type' => 'object',
'properties' => [
- 'type' => [
- 'description' => '创建的业务逻辑解释的类型',
- 'type' => 'integer',
- 'format' => 'int32',
- 'required' => false,
- 'enumValueTitles' => [
- '全局',
- '系统智能判断',
- ],
- 'example' => '1',
+ 'word' => ['description' => '同义词本身', 'type' => 'string', 'required' => true, 'example' => '首都'],
+ 'wordSynonyms' => [
+ 'description' => '需要与同义词映射的词语列表',
+ 'type' => 'array',
+ 'items' => ['description' => '需要映射的同义词', 'type' => 'string', 'required' => false, 'example' => '北京'],
+ 'required' => true,
],
- 'description' => [
- 'description' => '业务逻辑解释的具体内容',
- 'type' => 'string',
+ 'columns' => [
+ 'description' => '如果需要关联到数据表的某个具体的列，则可以在这里填写具体的列名，形式为：表名.列名',
+ 'type' => 'array',
+ 'items' => ['description' => '表名.列名', 'type' => 'string', 'required' => false, 'example' => 'table.id'."\n"
+ ."\n"],
'required' => false,
- 'example' => '冬季指的是，当年10月到第二年的三月',
],
],
'required' => false,
@@ -1098,94 +410,63 @@
'description' => 'Result',
'type' => 'object',
'properties' => [
- 'data' => [
- 'description' => '返回信息',
- 'type' => 'any',
- 'example' => 'true',
- ],
- 'errorMsg' => [
- 'description' => '错误描述信息',
- 'type' => 'string',
- 'example' => 'NoAuth',
- ],
- 'code' => [
- 'description' => '错误码',
- 'type' => 'string',
- 'example' => 'NoAuth',
- ],
- 'success' => [
- 'description' => 'true 接口调用成功，false 接口调用失败',
- 'type' => 'boolean',
- 'example' => 'true',
- ],
- 'requestId' => [
- 'description' => '请求id，每次请求都是唯一值，便于后续排查问题',
- 'type' => 'string',
- 'example' => 'FB11F719-9AC8-5C99-AB0A-4709D437FCFC',
- ],
+ 'data' => ['description' => '返回信息', 'type' => 'any', 'example' => 'true'],
+ 'errorMsg' => ['description' => '错误描述信息', 'type' => 'string', 'example' => 'NoAuth'],
+ 'code' => ['description' => '错误码', 'type' => 'string', 'example' => 'NoAuth'],
+ 'success' => ['description' => 'true 接口调用成功，false 接口调用失败', 'type' => 'boolean', 'example' => 'true'],
+ 'requestId' => ['description' => '请求id，每次请求都是唯一值，便于后续排查问题', 'type' => 'string', 'example' => 'FB11F719-9AC8-5C99-AB0A-4709D437FCFC'],
],
],
],
],
'errorCodes' => [
401 => [
- [
- 'errorCode' => 'Internal.Error',
- 'errorMessage' => 'Bad Request: Internal Error.',
- ],
- [
- 'errorCode' => 'NoAuth',
- 'errorMessage' => 'Bad Request: Workspace.Illegal.Auth.',
- ],
- [
- 'errorCode' => 'NoResourceAuth',
- 'errorMessage' => 'Bad Request: Resource Auth Error.',
- ],
+ ['errorCode' => 'Internal.Error', 'errorMessage' => 'Bad Request: Internal Error.', 'description' => '内部错误，请联系客服人员排查'],
+ ['errorCode' => 'NoAuth', 'errorMessage' => 'Bad Request: Workspace.Illegal.Auth.', 'description' => '当前所使用的账号无所指定业务空间的权限'],
+ ['errorCode' => 'NoResourceAuth', 'errorMessage' => 'Bad Request: Resource Auth Error.', 'description' => '没有请求的资源的权限，请确保所请求的资源属于当前参数中的业务空间'],
],
],
- 'staticInfo' => [
- 'returnType' => 'synchronous',
- ],
+ 'staticInfo' => ['returnType' => 'synchronous'],
'responseDemo' => '[{"errorExample":"","example":"{\\n \\"data\\": \\"true\\",\\n \\"errorMsg\\": \\"NoAuth\\",\\n \\"code\\": \\"NoAuth\\",\\n \\"success\\": true,\\n \\"requestId\\": \\"FB11F719-9AC8-5C99-AB0A-4709D437FCFC\\"\\n}","type":"json"}]',
- 'title' => '创建业务逻辑解释',
- ],
- 'ListBusinessLogic' => [
- 'summary' => '获取当前指定业务空间下的企业知识名词解释列表。',
- 'path' => '/gbi/list/logic',
- 'methods' => [
- 'post',
- ],
- 'schemes' => [
- 'https',
+ 'title' => '创建同义词',
+ 'changeSet' => [],
+ 'flowControl' => [
+ 'flowControlList' => [],
+ ],
+ 'ramActions' => [
+ [
+ 'operationType' => 'none',
+ 'ramAction' => [
+ 'action' => 'dataanalysisgbi:CreateSynonyms',
+ 'authLevel' => 'operate',
+ 'actionConditions' => [],
+ 'resources' => [
+ ['validationType' => 'always', 'product' => 'DataAnalysisGBI', 'resourceType' => '全部资源', 'arn' => '*'],
+ ],
+ ],
+ ],
],
+ ],
+ 'CreateVirtualDatasourceInstance' => [
+ 'summary' => '在您指定的业务空间创建虚拟数据源实例，虚拟数据源实例代表着一个虚拟的数据库，可以向虚拟数据源中添加ddl语句，来完成您构建虚拟数据库，数据表的能力。',
+ 'path' => '/gbi/virtualDatasource/createVirtualDatasourceInstance',
+ 'methods' => ['post'],
+ 'schemes' => ['https'],
'security' => [
[
'AK' => [],
],
],
- 'consumes' => [
- 'application/json',
- ],
- 'produces' => [
- 'application/json',
- ],
- 'operationType' => 'read',
+ 'consumes' => ['application/json'],
+ 'produces' => ['application/json'],
+ 'operationType' => 'write',
'deprecated' => false,
- 'systemTags' => [
- 'operationType' => 'none',
- 'riskType' => 'none',
- 'chargeType' => 'free',
- ],
+ 'systemTags' => ['operationType' => 'none', 'riskType' => 'none', 'chargeType' => 'free'],
'parameters' => [
[
'name' => 'workspaceId',
'in' => 'query',
- 'schema' => [
- 'description' => '当前请求所使用的阿里云百炼业务空间id',
- 'type' => 'string',
- 'required' => true,
- 'example' => 'llm-2v3934xtp49esw64'."\n",
- ],
+ 'schema' => ['description' => '当前请求所使用的阿里云百炼业务空间id', 'type' => 'string', 'required' => true, 'example' => 'llm-2v3934xtp49esw64'."\n"],
],
[
'name' => 'body',
@@ -1195,22 +476,15 @@
'description' => '请求体参数',
'type' => 'object',
'properties' => [
- 'nextToken' => [
- 'description' => '分页游标。'."\n"
- ."\n"
- .'- 如果是首次调用，该参数不传。'."\n"
- ."\n"
- .'- 如果是非首次调用，该参数传上传调用时返回的nextToken。',
- 'type' => 'string',
- 'required' => false,
- 'example' => 'e8Z0nRyY51ZQmYljqGNK',
- ],
- 'maxResults' => [
- 'description' => '每页最大条目数',
+ 'name' => ['description' => '虚拟数据源实例的名字', 'type' => 'string', 'required' => false, 'example' => 'virtual-instance-1'],
+ 'description' => ['description' => '虚拟数据源实例的描述', 'type' => 'string', 'required' => false, 'example' => '虚拟数据源实例的描述'],
+ 'type' => [
+ 'description' => '当前虚拟数据源的类型',
'type' => 'integer',
'format' => 'int32',
'required' => false,
- 'example' => '10',
+ 'enumValueTitles' => [51 => 'mysql类型虚拟数据源', 'postgresql类型虚拟数据源'],
+ 'example' => '51',
],
],
'required' => false,
@@ -1224,129 +498,61 @@
'description' => 'Result',
'type' => 'object',
'properties' => [
- 'data' => [
- 'description' => '数据列表。',
- 'type' => 'any',
- 'example' => '{'."\n"
- .' "data": {'."\n"
- .' "data": ['."\n"
- .' {'."\n"
- .' "gmtModified": 1732018200000,'."\n"
- .' "workSpaceId": "10024809",'."\n"
- .' "description": "1",'."\n"
- .' "businessLogicIdKey": "businessLogic-AAAAAAAAAGAIyJoP7LbKuA",'."\n"
- .' "gmtCreate": 1732018200000,'."\n"
- .' "type": 0,'."\n"
- .' "status": 1'."\n"
- .' },'."\n"
- .' {'."\n"
- .' "gmtModified": 1721791780000,'."\n"
- .' "workSpaceId": "10024809",'."\n"
- .' "description": "时间相关列的格式是 YYYYMMDD",'."\n"
- .' "businessLogicIdKey": "businessLogic-AAAAAAAAAEXeM8VSLGi77w",'."\n"
- .' "gmtCreate": 1721791780000,'."\n"
- .' "type": 0,'."\n"
- .' "status": 1'."\n"
- .' },'."\n"
- .' {'."\n"
- .' "gmtModified": 1732013491000,'."\n"
- .' "workSpaceId": "10024809",'."\n"
- .' "description": "查询数据的时候，如果发现列有中文的描述或者中文的名字，请将查询到的结果展示成as 列中文名的形式",'."\n"
- .' "businessLogicIdKey": "businessLogic-AAAAAAAAAE9NdahlKmg-OQ",'."\n"
- .' "gmtCreate": 1727420945000,'."\n"
- .' "type": 0,'."\n"
- .' "status": 1'."\n"
- .' }'."\n"
- .' ],'."\n"
- .' "nextToken": "+uGRPVXVZ9upasz0PegzUA==",'."\n"
- .' "totalCount": 0'."\n"
- .' }'."\n"
- .'}',
- ],
- 'errorMsg' => [
- 'description' => '错误描述信息。',
- 'type' => 'string',
- 'example' => 'NoAuth',
- ],
- 'code' => [
- 'description' => '错误码。',
- 'type' => 'string',
- 'example' => 'NoAuth',
- ],
- 'success' => [
- 'description' => 'true 接口调用成功，false 接口调用失败',
- 'type' => 'boolean',
- 'example' => 'true',
- ],
- 'requestId' => [
- 'description' => '请求id，每次请求都是唯一值，便于后续排查问题'."\n"
- ."\n",
- 'type' => 'string',
- 'example' => 'FB11F719-9AC8-5C99-AB0A-4709D437FCFC',
- ],
+ 'data' => ['description' => '响应数据。即成功与否。', 'type' => 'any', 'example' => 'true'],
+ 'errorMsg' => ['description' => '错误信息', 'type' => 'string', 'example' => 'NoAuth'],
+ 'code' => ['description' => '错误码。', 'type' => 'string', 'example' => 'NoAuth'],
+ 'success' => ['description' => 'true 接口调用成功，false 接口调用失败', 'type' => 'boolean', 'example' => 'true'],
+ 'requestId' => ['description' => '请求id，每次请求都是唯一值，便于后续排查问题', 'type' => 'string', 'example' => 'D02D895A-5E58-5A9F-963D-D8B027AB7AE2'],
],
],
],
],
'errorCodes' => [
401 => [
- [
- 'errorCode' => 'Internal.Error',
- 'errorMessage' => 'Bad Request: Internal Error.',
- ],
- [
- 'errorCode' => 'NoAuth',
- 'errorMessage' => 'Bad Request: Workspace.Illegal.Auth.',
- ],
- [
- 'errorCode' => 'NoResourceAuth',
- 'errorMessage' => 'Bad Request: Resource Auth Error.',
- ],
+ ['errorCode' => 'NoAuth', 'errorMessage' => 'Bad Request: Workspace.Illegal.Auth.', 'description' => '当前所使用的账号无所指定业务空间的权限'],
+ ['errorCode' => 'Internal.Error', 'errorMessage' => 'Bad Request: Internal Error.', 'description' => '内部错误，请联系客服人员排查'],
],
],
- 'staticInfo' => [
- 'returnType' => 'synchronous',
+ 'staticInfo' => ['returnType' => 'synchronous'],
+ 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"data\\": \\"true\\",\\n \\"errorMsg\\": \\"NoAuth\\",\\n \\"code\\": \\"NoAuth\\",\\n \\"success\\": true,\\n \\"requestId\\": \\"D02D895A-5E58-5A9F-963D-D8B027AB7AE2\\"\\n}","type":"json"}]',
+ 'title' => '创建虚拟数据源实例',
+ 'changeSet' => [
+ ['createdAt' => '2024-12-10T15:46:05.000Z', 'description' => '请求参数发生变更'],
+ ],
+ 'ramActions' => [
+ [
+ 'operationType' => 'none',
+ 'ramAction' => [
+ 'action' => 'dataanalysisgbi:CreateVirtualDatasourceInstance',
+ 'authLevel' => 'operate',
+ 'actionConditions' => [],
+ 'resources' => [
+ ['validationType' => 'always', 'product' => 'DataAnalysisGBI', 'resourceType' => '全部资源', 'arn' => '*'],
+ ],
+ ],
+ ],
],
- 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"data\\": \\"{\\\\n \\\\\\"data\\\\\\": {\\\\n \\\\\\"data\\\\\\": [\\\\n {\\\\n \\\\\\"gmtModified\\\\\\": 1732018200000,\\\\n \\\\\\"workSpaceId\\\\\\": \\\\\\"10024809\\\\\\",\\\\n \\\\\\"description\\\\\\": \\\\\\"1\\\\\\",\\\\n \\\\\\"businessLogicIdKey\\\\\\": \\\\\\"businessLogic-AAAAAAAAAGAIyJoP7LbKuA\\\\\\",\\\\n \\\\\\"gmtCreate\\\\\\": 1732018200000,\\\\n \\\\\\"type\\\\\\": 0,\\\\n \\\\\\"status\\\\\\": 1\\\\n },\\\\n {\\\\n \\\\\\"gmtModified\\\\\\": 1721791780000,\\\\n \\\\\\"workSpaceId\\\\\\": \\\\\\"10024809\\\\\\",\\\\n \\\\\\"description\\\\\\": \\\\\\"时间相关列的格式是 YYYYMMDD\\\\\\",\\\\n \\\\\\"businessLogicIdKey\\\\\\": \\\\\\"businessLogic-AAAAAAAAAEXeM8VSLGi77w\\\\\\",\\\\n \\\\\\"gmtCreate\\\\\\": 1721791780000,\\\\n \\\\\\"type\\\\\\": 0,\\\\n \\\\\\"status\\\\\\": 1\\\\n },\\\\n {\\\\n \\\\\\"gmtModified\\\\\\": 1732013491000,\\\\n \\\\\\"workSpaceId\\\\\\": \\\\\\"10024809\\\\\\",\\\\n \\\\\\"description\\\\\\": \\\\\\"查询数据的时候，如果发现列有中文的描述或者中文的名字，请将查询到的结果展示成as 列中文名的形式\\\\\\",\\\\n \\\\\\"businessLogicIdKey\\\\\\": \\\\\\"businessLogic-AAAAAAAAAE9NdahlKmg-OQ\\\\\\",\\\\n \\\\\\"gmtCreate\\\\\\": 1727420945000,\\\\n \\\\\\"type\\\\\\": 0,\\\\n \\\\\\"status\\\\\\": 1\\\\n }\\\\n ],\\\\n \\\\\\"nextToken\\\\\\": \\\\\\"+uGRPVXVZ9upasz0PegzUA==\\\\\\",\\\\n \\\\\\"totalCount\\\\\\": 0\\\\n }\\\\n}\\",\\n \\"errorMsg\\": \\"NoAuth\\",\\n \\"code\\": \\"NoAuth\\",\\n \\"success\\": true,\\n \\"requestId\\": \\"FB11F719-9AC8-5C99-AB0A-4709D437FCFC\\"\\n}","type":"json"}]',
- 'title' => '业务逻辑解释列表',
],
'DeleteBusinessLogic' => [
'summary' => '删除指定业务空间下所指定的业务逻辑解释。',
'path' => '/gbi/delete/logic',
- 'methods' => [
- 'post',
- ],
- 'schemes' => [
- 'https',
- ],
+ 'methods' => ['post'],
+ 'schemes' => ['https'],
'security' => [
[
'AK' => [],
],
],
- 'consumes' => [
- 'application/json',
- ],
- 'produces' => [
- 'application/json',
- ],
+ 'consumes' => ['application/json'],
+ 'produces' => ['application/json'],
'operationType' => 'write',
'deprecated' => false,
- 'systemTags' => [
- 'operationType' => 'none',
- 'riskType' => 'none',
- 'chargeType' => 'free',
- ],
+ 'systemTags' => ['operationType' => 'none', 'riskType' => 'none', 'chargeType' => 'free'],
'parameters' => [
[
'name' => 'workspaceId',
'in' => 'query',
- 'schema' => [
- 'description' => '当前请求所使用的百炼业务空间id',
- 'type' => 'string',
- 'required' => true,
- 'example' => 'llm-2v3934xtp49esw64'."\n",
- ],
+ 'schema' => ['description' => '当前请求所使用的百炼业务空间id', 'type' => 'string', 'required' => true, 'example' => 'llm-2v3934xtp49esw64'."\n"],
],
[
'name' => 'body',
@@ -1359,12 +565,7 @@
'businessLogicIdKeys' => [
'description' => '业务逻辑解释的唯一标识符id列表',
'type' => 'array',
- 'items' => [
- 'description' => '业务逻辑解释的唯一标识符id',
- 'type' => 'string',
- 'required' => false,
- 'example' => 'businessLogic-AAAAAAAAAGAIyJoP7LbKuA',
- ],
+ 'items' => ['description' => '业务逻辑解释的唯一标识符id', 'type' => 'string', 'required' => false, 'example' => 'businessLogic-AAAAAAAAAGAIyJoP7LbKuA'],
'required' => true,
],
],
@@ -1379,98 +580,64 @@
'description' => 'Result',
'type' => 'object',
'properties' => [
- 'data' => [
- 'description' => '返回信息',
- 'type' => 'any',
- 'example' => 'true',
- ],
- 'errorMsg' => [
- 'description' => '错误描述信息。',
- 'type' => 'string',
- 'example' => 'NoAuth',
- ],
- 'code' => [
- 'description' => '错误码',
- 'type' => 'string',
- 'example' => 'NoAuth',
- ],
- 'success' => [
- 'description' => 'true 接口调用成功，false 接口调用失败',
- 'type' => 'boolean',
- 'example' => 'true',
- ],
- 'requestId' => [
- 'description' => '请求id，每次请求都是唯一值，便于后续排查问题',
- 'type' => 'string',
- 'example' => 'FB11F719-9AC8-5C99-AB0A-4709D437FCFC',
- ],
+ 'data' => ['description' => '返回信息', 'type' => 'any', 'example' => 'true'],
+ 'errorMsg' => ['description' => '错误描述信息。', 'type' => 'string', 'example' => 'NoAuth'],
+ 'code' => ['description' => '错误码', 'type' => 'string', 'example' => 'NoAuth'],
+ 'success' => ['description' => 'true 接口调用成功，false 接口调用失败', 'type' => 'boolean', 'example' => 'true'],
+ 'requestId' => ['description' => '请求id，每次请求都是唯一值，便于后续排查问题', 'type' => 'string', 'example' => 'FB11F719-9AC8-5C99-AB0A-4709D437FCFC'],
],
],
],
],
'errorCodes' => [
401 => [
- [
- 'errorCode' => 'Internal.Error',
- 'errorMessage' => 'Bad Request: Internal Error.',
- ],
- [
- 'errorCode' => 'NoAuth',
- 'errorMessage' => 'Bad Request: Workspace.Illegal.Auth.',
- ],
- [
- 'errorCode' => 'NoResourceAuth',
- 'errorMessage' => 'Bad Request: Resource Auth Error.',
- ],
- [
- 'errorCode' => 'SystemOperationInProgress',
- 'errorMessage' => 'Xiyan GBI is learning your previous modifications. Please try again later.',
- ],
+ ['errorCode' => 'Internal.Error', 'errorMessage' => 'Bad Request: Internal Error.', 'description' => '内部错误，请联系客服人员排查'],
+ ['errorCode' => 'NoAuth', 'errorMessage' => 'Bad Request: Workspace.Illegal.Auth.', 'description' => '当前所使用的账号无所指定业务空间的权限'],
+ ['errorCode' => 'NoResourceAuth', 'errorMessage' => 'Bad Request: Resource Auth Error.', 'description' => '没有请求的资源的权限，请确保所请求的资源属于当前参数中的业务空间'],
+ ['errorCode' => 'SystemOperationInProgress', 'errorMessage' => 'Xiyan GBI is learning your previous modifications. Please try again later.', 'description' => '析言GBI正在学习您之前的修改内容，请稍后重试'],
],
],
- 'staticInfo' => [
- 'returnType' => 'synchronous',
- ],
+ 'staticInfo' => ['returnType' => 'synchronous'],
'responseDemo' => '[{"errorExample":"","example":"{\\n \\"data\\": \\"true\\",\\n \\"errorMsg\\": \\"NoAuth\\",\\n \\"code\\": \\"NoAuth\\",\\n \\"success\\": true,\\n \\"requestId\\": \\"FB11F719-9AC8-5C99-AB0A-4709D437FCFC\\"\\n}","type":"json"}]',
'title' => '删除业务逻辑解释',
- ],
- 'CreateSynonyms' => [
- 'summary' => '在当前指定的业务空间下面，新建同义词。',
- 'path' => '/gbi/create/synonyms',
- 'methods' => [
- 'post',
- ],
- 'schemes' => [
- 'https',
+ 'changeSet' => [],
+ 'flowControl' => [
+ 'flowControlList' => [],
+ ],
+ 'ramActions' => [
+ [
+ 'operationType' => 'none',
+ 'ramAction' => [
+ 'action' => 'dataanalysisgbi:DeleteBusinessLogic',
+ 'authLevel' => 'operate',
+ 'actionConditions' => [],
+ 'resources' => [
+ ['validationType' => 'always', 'product' => 'DataAnalysisGBI', 'resourceType' => '全部资源', 'arn' => '*'],
+ ],
+ ],
+ ],
],
+ ],
+ 'DeleteColumn' => [
+ 'summary' => '从当前所指定的业务空间中，删除所指定的列。',
+ 'path' => '/gbi/delete/column',
+ 'methods' => ['post'],
+ 'schemes' => ['https'],
'security' => [
[
'AK' => [],
],
],
- 'consumes' => [
- 'application/json',
- ],
- 'produces' => [
- 'application/json',
- ],
- 'operationType' => 'readAndWrite',
+ 'consumes' => ['application/json'],
+ 'produces' => ['application/json'],
+ 'operationType' => 'write',
'deprecated' => false,
- 'systemTags' => [
- 'operationType' => 'none',
- 'riskType' => 'none',
- 'chargeType' => 'free',
- ],
+ 'systemTags' => ['operationType' => 'none', 'riskType' => 'none', 'chargeType' => 'free'],
'parameters' => [
[
'name' => 'workspaceId',
'in' => 'query',
- 'schema' => [
- 'description' => '当前请求所使用的阿里云百炼业务空间id',
- 'type' => 'string',
- 'required' => true,
- 'example' => 'llm-2v3934xtp49esw64'."\n",
- ],
+ 'schema' => ['description' => '当前请求所使用的阿里云百炼业务空间id', 'type' => 'string', 'required' => true, 'example' => 'llm-2v3934xtp49esw64'."\n"],
],
[
'name' => 'body',
@@ -1480,35 +647,7 @@
'description' => '请求体参数',
'type' => 'object',
'properties' => [
- 'word' => [
- 'description' => '同义词本身',
- 'type' => 'string',
- 'required' => true,
- 'example' => '首都',
- ],
- 'wordSynonyms' => [
- 'description' => '需要与同义词映射的词语列表',
- 'type' => 'array',
- 'items' => [
- 'description' => '需要映射的同义词',
- 'type' => 'string',
- 'required' => false,
- 'example' => '北京',
- ],
- 'required' => true,
- ],
- 'columns' => [
- 'description' => '如果需要关联到数据表的某个具体的列，则可以在这里填写具体的列名，形式为：表名.列名',
- 'type' => 'array',
- 'items' => [
- 'description' => '表名.列名',
- 'type' => 'string',
- 'required' => false,
- 'example' => 'table.id'."\n"
- ."\n",
- ],
- 'required' => false,
- ],
+ 'columnIdKey' => ['description' => '想要删除的数据列的唯一标识符id', 'type' => 'string', 'required' => true, 'example' => 'column-AAAAAAAAh6Q9ERazKYFvkA'],
],
'required' => false,
],
@@ -1521,94 +660,61 @@
'description' => 'Result',
'type' => 'object',
'properties' => [
- 'data' => [
- 'description' => '返回信息',
- 'type' => 'any',
- 'example' => 'true',
- ],
- 'errorMsg' => [
- 'description' => '错误描述信息',
- 'type' => 'string',
- 'example' => 'NoAuth',
- ],
- 'code' => [
- 'description' => '错误码',
- 'type' => 'string',
- 'example' => 'NoAuth',
- ],
- 'success' => [
- 'description' => 'true 接口调用成功，false 接口调用失败',
- 'type' => 'boolean',
- 'example' => 'true',
- ],
- 'requestId' => [
- 'description' => '请求id，每次请求都是唯一值，便于后续排查问题',
- 'type' => 'string',
- 'example' => 'FB11F719-9AC8-5C99-AB0A-4709D437FCFC',
- ],
+ 'data' => ['description' => '返回信息', 'type' => 'any', 'example' => 'true'],
+ 'errorMsg' => ['description' => '错误描述信息', 'type' => 'string', 'example' => 'NoAuth'],
+ 'code' => ['description' => '错误码', 'type' => 'string', 'example' => 'NoAuth'],
+ 'success' => ['description' => 'true 接口调用成功，false 接口调用失败', 'type' => 'boolean', 'example' => 'true'],
+ 'requestId' => ['description' => '请求id，每次请求都是唯一值，便于后续排查问题', 'type' => 'string', 'example' => 'D02D895A-5E58-5A9F-963D-D8B027AB7AE2'],
],
],
],
],
'errorCodes' => [
401 => [
- [
- 'errorCode' => 'Internal.Error',
- 'errorMessage' => 'Bad Request: Internal Error.',
- ],
- [
- 'errorCode' => 'NoAuth',
- 'errorMessage' => 'Bad Request: Workspace.Illegal.Auth.',
- ],
- [
- 'errorCode' => 'NoResourceAuth',
- 'errorMessage' => 'Bad Request: Resource Auth Error.',
- ],
+ ['errorCode' => 'Internal.Error', 'errorMessage' => 'Bad Request: Internal Error.', 'description' => '内部错误，请联系客服人员排查'],
+ ['errorCode' => 'NoAuth', 'errorMessage' => 'Bad Request: Workspace.Illegal.Auth.', 'description' => '当前所使用的账号无所指定业务空间的权限'],
+ ['errorCode' => 'NoResourceAuth', 'errorMessage' => 'Bad Request: Resource Auth Error.', 'description' => '没有请求的资源的权限，请确保所请求的资源属于当前参数中的业务空间'],
+ ['errorCode' => 'SystemOperationInProgress', 'errorMessage' => 'Xiyan GBI is learning your previous modifications. Please try again later.', 'description' => '析言GBI正在学习您之前的修改内容，请稍后重试'],
],
],
- 'staticInfo' => [
- 'returnType' => 'synchronous',
+ 'staticInfo' => ['returnType' => 'synchronous'],
+ 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"data\\": \\"true\\",\\n \\"errorMsg\\": \\"NoAuth\\",\\n \\"code\\": \\"NoAuth\\",\\n \\"success\\": true,\\n \\"requestId\\": \\"D02D895A-5E58-5A9F-963D-D8B027AB7AE2\\"\\n}","type":"json"}]',
+ 'title' => '删除数据表中的列',
+ 'changeSet' => [],
+ 'ramActions' => [
+ [
+ 'operationType' => 'none',
+ 'ramAction' => [
+ 'action' => 'dataanalysisgbi:DeleteColumn',
+ 'authLevel' => 'operate',
+ 'actionConditions' => [],
+ 'resources' => [
+ ['validationType' => 'always', 'product' => 'DataAnalysisGBI', 'resourceType' => '全部资源', 'arn' => '*'],
+ ],
+ ],
+ ],
],
- 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"data\\": \\"true\\",\\n \\"errorMsg\\": \\"NoAuth\\",\\n \\"code\\": \\"NoAuth\\",\\n \\"success\\": true,\\n \\"requestId\\": \\"FB11F719-9AC8-5C99-AB0A-4709D437FCFC\\"\\n}","type":"json"}]',
- 'title' => '创建同义词',
],
- 'ListSynonyms' => [
- 'summary' => '获取当前指定业务空间下的同义词列表。',
- 'path' => '/gbi/list/synonyms',
- 'methods' => [
- 'post',
- ],
- 'schemes' => [
- 'https',
- ],
+ 'DeleteSelectedTable' => [
+ 'summary' => '将当前指定数据表从指定业务空间管控中删除。',
+ 'path' => '/gbi/delete/table',
+ 'methods' => ['post'],
+ 'schemes' => ['https'],
'security' => [
[
'AK' => [],
],
],
- 'consumes' => [
- 'application/json',
- ],
- 'produces' => [
- 'application/json',
- ],
+ 'consumes' => ['application/json'],
+ 'produces' => ['application/json'],
'operationType' => 'read',
'deprecated' => false,
- 'systemTags' => [
- 'operationType' => 'none',
- 'riskType' => 'none',
- 'chargeType' => 'free',
- ],
+ 'systemTags' => ['operationType' => 'none', 'riskType' => 'none', 'chargeType' => 'free'],
'parameters' => [
[
'name' => 'workspaceId',
'in' => 'query',
- 'schema' => [
- 'description' => '当前请求所使用的阿里云百炼业务空间id',
- 'type' => 'string',
- 'required' => true,
- 'example' => 'llm-2v3934xtp49esw64'."\n",
- ],
+ 'schema' => ['description' => '当前请求所使用的阿里云百炼业务空间id', 'type' => 'string', 'required' => true, 'example' => 'llm-2v3934xtp49esw64'."\n"],
],
[
'name' => 'body',
@@ -1618,23 +724,7 @@
'description' => '请求体参数',
'type' => 'object',
'properties' => [
- 'nextToken' => [
- 'description' => '分页游标。'."\n"
- ."\n"
- .'- 如果是首次调用，该参数不传。'."\n"
- ."\n"
- .'- 如果是非首次调用，该参数传上传调用时返回的nextToken。',
- 'type' => 'string',
- 'required' => false,
- 'example' => 'e8Z0nRyY51ZQmYljqGNK',
- ],
- 'maxResults' => [
- 'description' => '每页最大条目数',
- 'type' => 'integer',
- 'format' => 'int64',
- 'required' => false,
- 'example' => '10',
- ],
+ 'tableIdKey' => ['description' => '数据表的唯一标识符id', 'type' => 'string', 'required' => true, 'example' => 'table-AAAAAAAAFQBwSLJkUj4CYg'],
],
'required' => false,
],
@@ -1647,122 +737,64 @@
'description' => 'Result',
'type' => 'object',
'properties' => [
- 'data' => [
- 'description' => '返回信息',
- 'type' => 'any',
- 'example' => '{'."\n"
- .' "data": {'."\n"
- .' "data": ['."\n"
- .' {'."\n"
- .' "gmtModified": 1734401404000,'."\n"
- .' "columns": ['."\n"
- .' "test.id",'."\n"
- .' "user_info.createdt"'."\n"
- .' ],'."\n"
- .' "synonymIdKey": "synonyms-AAAAAAAAAVLaD8z63NnFhA",'."\n"
- .' "wordSynonyms": ['."\n"
- .' "1"'."\n"
- .' ],'."\n"
- .' "workSpaceId": "10024809",'."\n"
- .' "gmtCreate": 1734401404000,'."\n"
- .' "word": "1",'."\n"
- .' "status": 1'."\n"
- .' }'."\n"
- .' ],'."\n"
- .' "nextToken": "k1BLjEN114wyfrhDHoJlbg==",'."\n"
- .' "totalCount": 0'."\n"
- .' }'."\n"
- .'}',
- ],
- 'errorMsg' => [
- 'description' => '错误描述信息。',
- 'type' => 'string',
- 'example' => 'NoAuth',
- ],
- 'code' => [
- 'description' => '错误码',
- 'type' => 'string',
- 'example' => 'NoAuth',
- ],
- 'success' => [
- 'description' => '调用是否成功。'."\n"
- .'true，表示成功；'."\n"
- .'false，表示失败。',
- 'type' => 'boolean',
- 'example' => 'true',
- ],
- 'requestId' => [
- 'description' => '请求id，每次请求都是唯一值，便于后续排查问题',
- 'type' => 'string',
- 'example' => 'D02D895A-5E58-5A9F-963D-D8B027AB7AE2',
- ],
+ 'data' => ['description' => '返回信息', 'type' => 'any', 'example' => 'true'],
+ 'errorMsg' => ['description' => '错误描述信息', 'type' => 'string', 'example' => 'NoAuth'],
+ 'code' => ['description' => '错误码', 'type' => 'string', 'example' => 'NoAuth'],
+ 'success' => ['description' => 'true 接口调用成功，false 接口调用失败', 'type' => 'boolean', 'example' => 'true'],
+ 'requestId' => ['description' => '请求id，每次请求都是唯一值，便于后续排查问题', 'type' => 'string', 'example' => '45390C6D-016D-5030-BF65-031ED1F65003'],
],
],
],
],
'errorCodes' => [
401 => [
- [
- 'errorCode' => 'Internal.Error',
- 'errorMessage' => 'Bad Request: Internal Error.',
- ],
- [
- 'errorCode' => 'NoAuth',
- 'errorMessage' => 'Bad Request: Workspace.Illegal.Auth.',
- ],
- [
- 'errorCode' => 'NoResourceAuth',
- 'errorMessage' => 'Bad Request: Resource Auth Error.',
- ],
- [
- 'errorCode' => 'SystemOperationInProgress',
- 'errorMessage' => 'Xiyan GBI is learning your previous modifications. Please try again later.',
- ],
+ ['errorCode' => 'Internal.Error', 'errorMessage' => 'Bad Request: Internal Error.', 'description' => '内部错误，请联系客服人员排查'],
+ ['errorCode' => 'NoResourceAuth', 'errorMessage' => 'Bad Request: Resource Auth Error.', 'description' => '没有请求的资源的权限，请确保所请求的资源属于当前参数中的业务空间'],
+ ['errorCode' => 'NoAuth', 'errorMessage' => 'Bad Request: Workspace.Illegal.Auth.', 'description' => '当前所使用的账号无所指定业务空间的权限'],
+ ['errorCode' => 'SystemOperationInProgress', 'errorMessage' => 'Xiyan GBI is learning your previous modifications. Please try again later.', 'description' => '析言GBI正在学习您之前的修改内容，请稍后重试'],
],
],
- 'staticInfo' => [
- 'returnType' => 'synchronous',
+ 'staticInfo' => ['returnType' => 'synchronous'],
+ 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"data\\": \\"true\\",\\n \\"errorMsg\\": \\"NoAuth\\",\\n \\"code\\": \\"NoAuth\\",\\n \\"success\\": true,\\n \\"requestId\\": \\"45390C6D-016D-5030-BF65-031ED1F65003\\"\\n}","type":"json"}]',
+ 'title' => '删除所选择的数据表',
+ 'changeSet' => [],
+ 'flowControl' => [
+ 'flowControlList' => [],
+ ],
+ 'ramActions' => [
+ [
+ 'operationType' => 'none',
+ 'ramAction' => [
+ 'action' => 'dataanalysisgbi:DeleteSelectedTable',
+ 'authLevel' => 'operate',
+ 'actionConditions' => [],
+ 'resources' => [
+ ['validationType' => 'always', 'product' => 'DataAnalysisGBI', 'resourceType' => '全部资源', 'arn' => '*'],
+ ],
+ ],
+ ],
],
- 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"data\\": \\"{\\\\n \\\\\\"data\\\\\\": {\\\\n \\\\\\"data\\\\\\": [\\\\n {\\\\n \\\\\\"gmtModified\\\\\\": 1734401404000,\\\\n \\\\\\"columns\\\\\\": [\\\\n \\\\\\"test.id\\\\\\",\\\\n \\\\\\"user_info.createdt\\\\\\"\\\\n ],\\\\n \\\\\\"synonymIdKey\\\\\\": \\\\\\"synonyms-AAAAAAAAAVLaD8z63NnFhA\\\\\\",\\\\n \\\\\\"wordSynonyms\\\\\\": [\\\\n \\\\\\"1\\\\\\"\\\\n ],\\\\n \\\\\\"workSpaceId\\\\\\": \\\\\\"10024809\\\\\\",\\\\n \\\\\\"gmtCreate\\\\\\": 1734401404000,\\\\n \\\\\\"word\\\\\\": \\\\\\"1\\\\\\",\\\\n \\\\\\"status\\\\\\": 1\\\\n }\\\\n ],\\\\n \\\\\\"nextToken\\\\\\": \\\\\\"k1BLjEN114wyfrhDHoJlbg==\\\\\\",\\\\n \\\\\\"totalCount\\\\\\": 0\\\\n }\\\\n}\\",\\n \\"errorMsg\\": \\"NoAuth\\",\\n \\"code\\": \\"NoAuth\\",\\n \\"success\\": true,\\n \\"requestId\\": \\"D02D895A-5E58-5A9F-963D-D8B027AB7AE2\\"\\n}","type":"json"}]',
- 'title' => '同义词列表',
],
- 'UpdateSynonyms' => [
- 'summary' => '修改当前业务空间指定的同义词信息。',
- 'path' => '/gbi/update/synonyms',
- 'methods' => [
- 'post',
- ],
- 'schemes' => [
- 'https',
- ],
+ 'DeleteVirtualDatasourceInstance' => [
+ 'summary' => '删除指定业务空间下面的虚拟数据源实例。',
+ 'path' => '/gbi/virtualDatasource/deleteVirtualDatasourceInstance',
+ 'methods' => ['post'],
+ 'schemes' => ['https'],
'security' => [
[
'AK' => [],
],
],
- 'consumes' => [
- 'application/json',
- ],
- 'produces' => [
- 'application/json',
- ],
- 'operationType' => 'readAndWrite',
+ 'consumes' => ['application/json'],
+ 'produces' => ['application/json'],
+ 'operationType' => 'read',
'deprecated' => false,
- 'systemTags' => [
- 'operationType' => 'none',
- 'riskType' => 'none',
- 'chargeType' => 'free',
- ],
+ 'systemTags' => ['operationType' => 'none', 'riskType' => 'none', 'chargeType' => 'free'],
'parameters' => [
[
'name' => 'workspaceId',
'in' => 'query',
- 'schema' => [
- 'description' => '当前请求所使用的阿里云百炼业务空间id',
- 'type' => 'string',
- 'required' => true,
- 'example' => 'llm-2v3934xtp49esw64'."\n",
- ],
+ 'schema' => ['description' => '当前请求所使用的阿里云百炼业务空间id', 'type' => 'string', 'required' => true, 'example' => 'llm-2v3934xtp49esw64'."\n"],
],
[
'name' => 'body',
@@ -1772,40 +804,7 @@
'description' => '请求体参数',
'type' => 'object',
'properties' => [
- 'synonymIdKey' => [
- 'description' => '同义词的唯一标识符id',
- 'type' => 'string',
- 'required' => true,
- 'example' => 'synonyms-AAAAAAAAAUpwTTVrwTFJwQ',
- ],
- 'word' => [
- 'description' => '同义词本身',
- 'type' => 'string',
- 'required' => true,
- 'example' => '首都',
- ],
- 'wordSynonyms' => [
- 'description' => '需要与同义词映射的词语列表',
- 'type' => 'array',
- 'items' => [
- 'description' => '需要与同义词映射的词语',
- 'type' => 'string',
- 'required' => false,
- 'example' => '北京',
- ],
- 'required' => true,
- ],
- 'columns' => [
- 'description' => '如果需要关联到数据表的某个具体的列，则可以在这里填写具体的列名，形式为：表名.列名',
- 'type' => 'array',
- 'items' => [
- 'description' => '如果需要关联到数据表的某个具体的列，则可以在这里填写具体的列名',
- 'type' => 'string',
- 'required' => false,
- 'example' => 'table.username',
- ],
- 'required' => false,
- ],
+ 'vdbId' => ['description' => '虚拟数据源实例id', 'type' => 'string', 'required' => true, 'example' => 'vdb-7D63529B-5D42-5BF0-84E4-F742FFE02E7F'."\n"],
],
'required' => false,
],
@@ -1818,98 +817,62 @@
'description' => 'Result',
'type' => 'object',
'properties' => [
- 'data' => [
- 'description' => '返回信息',
- 'type' => 'any',
- 'example' => 'true',
- ],
- 'errorMsg' => [
- 'description' => '错误描述信息',
- 'type' => 'string',
- 'example' => 'NoAuth',
- ],
- 'code' => [
- 'description' => '错误码',
- 'type' => 'string',
- 'example' => 'NoAuth',
- ],
- 'success' => [
- 'description' => 'true 接口调用成功，false 接口调用失败',
- 'type' => 'boolean',
- 'example' => 'true',
- ],
- 'requestId' => [
- 'description' => '请求id，每次请求都是唯一值，便于后续排查问题',
- 'type' => 'string',
- 'example' => '7D63529B-5D42-5BF0-84E4-F742FFE02E7F',
- ],
+ 'data' => ['description' => '响应数据。即成功与否。', 'type' => 'any', 'example' => 'true'],
+ 'errorMsg' => ['description' => '错误描述信息。', 'type' => 'string', 'example' => 'NoAuth'],
+ 'code' => ['description' => '错误码。', 'type' => 'string', 'example' => 'NoAuth'],
+ 'success' => ['description' => 'true 接口调用成功，false 接口调用失败', 'type' => 'boolean', 'example' => 'true'],
+ 'requestId' => ['description' => '请求id，每次请求都是唯一值，便于后续排查问题', 'type' => 'string', 'example' => '7D63529B-5D42-5BF0-84E4-F742FFE02E7F'],
],
],
],
],
'errorCodes' => [
401 => [
- [
- 'errorCode' => 'Internal.Error',
- 'errorMessage' => 'Bad Request: Internal Error.',
- ],
- [
- 'errorCode' => 'NoAuth',
- 'errorMessage' => 'Bad Request: Workspace.Illegal.Auth.',
- ],
- [
- 'errorCode' => 'NoResourceAuth',
- 'errorMessage' => 'Bad Request: Resource Auth Error.',
- ],
- [
- 'errorCode' => 'SystemOperationInProgress',
- 'errorMessage' => 'Xiyan GBI is learning your previous modifications. Please try again later.',
- ],
+ ['errorCode' => 'NoAuth', 'errorMessage' => 'Bad Request: Workspace.Illegal.Auth.', 'description' => '当前所使用的账号无所指定业务空间的权限'],
+ ['errorCode' => 'Internal.Error', 'errorMessage' => 'Bad Request: Internal Error.', 'description' => '内部错误，请联系客服人员排查'],
],
],
- 'staticInfo' => [
- 'returnType' => 'synchronous',
- ],
+ 'staticInfo' => ['returnType' => 'synchronous'],
'responseDemo' => '[{"errorExample":"","example":"{\\n \\"data\\": \\"true\\",\\n \\"errorMsg\\": \\"NoAuth\\",\\n \\"code\\": \\"NoAuth\\",\\n \\"success\\": true,\\n \\"requestId\\": \\"7D63529B-5D42-5BF0-84E4-F742FFE02E7F\\"\\n}","type":"json"}]',
- 'title' => '修改同义词',
- ],
- 'BatchDeleteSynonyms' => [
- 'summary' => '批量删除当前指定业务空间下的同义词。',
- 'path' => '/gbi/batchDelete/synonyms',
- 'methods' => [
- 'post',
- ],
- 'schemes' => [
- 'https',
+ 'title' => '删除虚拟数据源实例',
+ 'changeSet' => [],
+ 'flowControl' => [
+ 'flowControlList' => [],
+ ],
+ 'ramActions' => [
+ [
+ 'operationType' => 'none',
+ 'ramAction' => [
+ 'action' => 'dataanalysisgbi:DeleteVirtualDatasourceInstance',
+ 'authLevel' => 'operate',
+ 'actionConditions' => [],
+ 'resources' => [
+ ['validationType' => 'always', 'product' => 'DataAnalysisGBI', 'resourceType' => '全部资源', 'arn' => '*'],
+ ],
+ ],
+ ],
],
+ ],
+ 'ListBusinessLogic' => [
+ 'summary' => '获取当前指定业务空间下的企业知识名词解释列表。',
+ 'path' => '/gbi/list/logic',
+ 'methods' => ['post'],
+ 'schemes' => ['https'],
'security' => [
[
'AK' => [],
],
],
- 'consumes' => [
- 'application/json',
- ],
- 'produces' => [
- 'application/json',
- ],
- 'operationType' => 'write',
+ 'consumes' => ['application/json'],
+ 'produces' => ['application/json'],
+ 'operationType' => 'read',
'deprecated' => false,
- 'systemTags' => [
- 'operationType' => 'none',
- 'riskType' => 'none',
- 'chargeType' => 'free',
- ],
+ 'systemTags' => ['operationType' => 'none', 'riskType' => 'none', 'chargeType' => 'free'],
'parameters' => [
[
'name' => 'workspaceId',
'in' => 'query',
- 'schema' => [
- 'description' => '当前请求所使用的百炼业务空间id',
- 'type' => 'string',
- 'required' => true,
- 'example' => 'llm-2v3934xtp49esw64'."\n",
- ],
+ 'schema' => ['description' => '当前请求所使用的阿里云百炼业务空间id', 'type' => 'string', 'required' => true, 'example' => 'llm-2v3934xtp49esw64'."\n"],
],
[
'name' => 'body',
@@ -1919,17 +882,12 @@
'description' => '请求体参数',
'type' => 'object',
'properties' => [
- 'synonymIdKeys' => [
- 'description' => '需要指定删除的同义词的id列表',
- 'type' => 'array',
- 'items' => [
- 'description' => '同义词id',
- 'type' => 'string',
- 'required' => false,
- 'example' => 'synonym-AAAAAAAAh6cWOUPagYstkg',
- ],
- 'required' => true,
- ],
+ 'nextToken' => ['description' => '分页游标。'."\n"
+ ."\n"
+ .'- 如果是首次调用，该参数不传。'."\n"
+ ."\n"
+ .'- 如果是非首次调用，该参数传上传调用时返回的nextToken。', 'type' => 'string', 'required' => false, 'example' => 'e8Z0nRyY51ZQmYljqGNK'],
+ 'maxResults' => ['description' => '每页最大条目数', 'type' => 'integer', 'format' => 'int32', 'required' => false, 'example' => '10'],
],
'required' => false,
],
@@ -1942,98 +900,98 @@
'description' => 'Result',
'type' => 'object',
'properties' => [
- 'data' => [
- 'description' => '返回信息',
- 'type' => 'any',
- 'example' => 'true',
- ],
- 'errorMsg' => [
- 'description' => '错误描述信息',
- 'type' => 'string',
- 'example' => 'NoAuth',
- ],
- 'code' => [
- 'description' => '错误码',
- 'type' => 'string',
- 'example' => 'NoAuth',
- ],
- 'success' => [
- 'description' => 'true 接口调用成功，false 接口调用失败',
- 'type' => 'boolean',
- 'example' => 'true',
- ],
- 'requestId' => [
- 'description' => '请求id，每次请求都是唯一值，便于后续排查问题',
- 'type' => 'string',
- 'example' => '45390C6D-016D-5030-BF65-031ED1F65003',
- ],
+ 'data' => ['description' => '数据列表。', 'type' => 'any', 'example' => '{'."\n"
+ .' "data": {'."\n"
+ .' "data": ['."\n"
+ .' {'."\n"
+ .' "gmtModified": 1732018200000,'."\n"
+ .' "workSpaceId": "10024809",'."\n"
+ .' "description": "1",'."\n"
+ .' "businessLogicIdKey": "businessLogic-AAAAAAAAAGAIyJoP7LbKuA",'."\n"
+ .' "gmtCreate": 1732018200000,'."\n"
+ .' "type": 0,'."\n"
+ .' "status": 1'."\n"
+ .' },'."\n"
+ .' {'."\n"
+ .' "gmtModified": 1721791780000,'."\n"
+ .' "workSpaceId": "10024809",'."\n"
+ .' "description": "时间相关列的格式是 YYYYMMDD",'."\n"
+ .' "businessLogicIdKey": "businessLogic-AAAAAAAAAEXeM8VSLGi77w",'."\n"
+ .' "gmtCreate": 1721791780000,'."\n"
+ .' "type": 0,'."\n"
+ .' "status": 1'."\n"
+ .' },'."\n"
+ .' {'."\n"
+ .' "gmtModified": 1732013491000,'."\n"
+ .' "workSpaceId": "10024809",'."\n"
+ .' "description": "查询数据的时候，如果发现列有中文的描述或者中文的名字，请将查询到的结果展示成as 列中文名的形式",'."\n"
+ .' "businessLogicIdKey": "businessLogic-AAAAAAAAAE9NdahlKmg-OQ",'."\n"
+ .' "gmtCreate": 1727420945000,'."\n"
+ .' "type": 0,'."\n"
+ .' "status": 1'."\n"
+ .' }'."\n"
+ .' ],'."\n"
+ .' "nextToken": "+uGRPVXVZ9upasz0PegzUA==",'."\n"
+ .' "totalCount": 0'."\n"
+ .' }'."\n"
+ .'}'],
+ 'errorMsg' => ['description' => '错误描述信息。', 'type' => 'string', 'example' => 'NoAuth'],
+ 'code' => ['description' => '错误码。', 'type' => 'string', 'example' => 'NoAuth'],
+ 'success' => ['description' => 'true 接口调用成功，false 接口调用失败', 'type' => 'boolean', 'example' => 'true'],
+ 'requestId' => ['description' => '请求id，每次请求都是唯一值，便于后续排查问题'."\n"
+ ."\n", 'type' => 'string', 'example' => 'FB11F719-9AC8-5C99-AB0A-4709D437FCFC'],
],
],
],
],
'errorCodes' => [
401 => [
- [
- 'errorCode' => 'Internal.Error',
- 'errorMessage' => 'Bad Request: Internal Error.',
- ],
- [
- 'errorCode' => 'NoResourceAuth',
- 'errorMessage' => 'Bad Request: Resource Auth Error.',
- ],
- [
- 'errorCode' => 'NoAuth',
- 'errorMessage' => 'Bad Request: Workspace.Illegal.Auth.',
- ],
- [
- 'errorCode' => 'SystemOperationInProgress',
- 'errorMessage' => 'Xiyan GBI is learning your previous modifications. Please try again later.',
- ],
+ ['errorCode' => 'Internal.Error', 'errorMessage' => 'Bad Request: Internal Error.', 'description' => '内部错误，请联系客服人员排查'],
+ ['errorCode' => 'NoAuth', 'errorMessage' => 'Bad Request: Workspace.Illegal.Auth.', 'description' => '当前所使用的账号无所指定业务空间的权限'],
+ ['errorCode' => 'NoResourceAuth', 'errorMessage' => 'Bad Request: Resource Auth Error.', 'description' => '没有请求的资源的权限，请确保所请求的资源属于当前参数中的业务空间'],
],
],
- 'staticInfo' => [
- 'returnType' => 'synchronous',
+ 'staticInfo' => ['returnType' => 'synchronous'],
+ 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"data\\": \\"{\\\\n \\\\\\"data\\\\\\": {\\\\n \\\\\\"data\\\\\\": [\\\\n {\\\\n \\\\\\"gmtModified\\\\\\": 1732018200000,\\\\n \\\\\\"workSpaceId\\\\\\": \\\\\\"10024809\\\\\\",\\\\n \\\\\\"description\\\\\\": \\\\\\"1\\\\\\",\\\\n \\\\\\"businessLogicIdKey\\\\\\": \\\\\\"businessLogic-AAAAAAAAAGAIyJoP7LbKuA\\\\\\",\\\\n \\\\\\"gmtCreate\\\\\\": 1732018200000,\\\\n \\\\\\"type\\\\\\": 0,\\\\n \\\\\\"status\\\\\\": 1\\\\n },\\\\n {\\\\n \\\\\\"gmtModified\\\\\\": 1721791780000,\\\\n \\\\\\"workSpaceId\\\\\\": \\\\\\"10024809\\\\\\",\\\\n \\\\\\"description\\\\\\": \\\\\\"时间相关列的格式是 YYYYMMDD\\\\\\",\\\\n \\\\\\"businessLogicIdKey\\\\\\": \\\\\\"businessLogic-AAAAAAAAAEXeM8VSLGi77w\\\\\\",\\\\n \\\\\\"gmtCreate\\\\\\": 1721791780000,\\\\n \\\\\\"type\\\\\\": 0,\\\\n \\\\\\"status\\\\\\": 1\\\\n },\\\\n {\\\\n \\\\\\"gmtModified\\\\\\": 1732013491000,\\\\n \\\\\\"workSpaceId\\\\\\": \\\\\\"10024809\\\\\\",\\\\n \\\\\\"description\\\\\\": \\\\\\"查询数据的时候，如果发现列有中文的描述或者中文的名字，请将查询到的结果展示成as 列中文名的形式\\\\\\",\\\\n \\\\\\"businessLogicIdKey\\\\\\": \\\\\\"businessLogic-AAAAAAAAAE9NdahlKmg-OQ\\\\\\",\\\\n \\\\\\"gmtCreate\\\\\\": 1727420945000,\\\\n \\\\\\"type\\\\\\": 0,\\\\n \\\\\\"status\\\\\\": 1\\\\n }\\\\n ],\\\\n \\\\\\"nextToken\\\\\\": \\\\\\"+uGRPVXVZ9upasz0PegzUA==\\\\\\",\\\\n \\\\\\"totalCount\\\\\\": 0\\\\n }\\\\n}\\",\\n \\"errorMsg\\": \\"NoAuth\\",\\n \\"code\\": \\"NoAuth\\",\\n \\"success\\": true,\\n \\"requestId\\": \\"FB11F719-9AC8-5C99-AB0A-4709D437FCFC\\"\\n}","type":"json"}]',
+ 'title' => '业务逻辑解释列表',
+ 'changeSet' => [],
+ 'flowControl' => [
+ 'flowControlList' => [],
+ ],
+ 'ramActions' => [
+ [
+ 'operationType' => 'none',
+ 'ramAction' => [
+ 'action' => 'dataanalysisgbi:ListBusinessLogic',
+ 'authLevel' => 'operate',
+ 'actionConditions' => [],
+ 'resources' => [
+ ['validationType' => 'always', 'product' => 'DataAnalysisGBI', 'resourceType' => '全部资源', 'arn' => '*'],
+ ],
+ ],
+ ],
],
- 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"data\\": \\"true\\",\\n \\"errorMsg\\": \\"NoAuth\\",\\n \\"code\\": \\"NoAuth\\",\\n \\"success\\": true,\\n \\"requestId\\": \\"45390C6D-016D-5030-BF65-031ED1F65003\\"\\n}","type":"json"}]',
- 'title' => '批量删除同义词',
],
- 'CreateDatasourceAuthorization' => [
- 'summary' => '创建数据库关联授权，在您指定的业务空间，对指定的数据源进行关联关系的创建，创建后可以对数据源下的表结构进行采集。',
- 'path' => '/gbi/create/datasource',
- 'methods' => [
- 'post',
- ],
- 'schemes' => [
- 'https',
- ],
+ 'ListColumn' => [
+ 'summary' => '获取当前指定业务空间，指定表下面的列信息。',
+ 'path' => '/gbi/list/column',
+ 'methods' => ['post'],
+ 'schemes' => ['https'],
'security' => [
[
'AK' => [],
],
],
- 'consumes' => [
- 'application/json',
- ],
- 'produces' => [
- 'application/json',
- ],
- 'operationType' => 'write',
+ 'consumes' => ['application/json'],
+ 'produces' => ['application/json'],
+ 'operationType' => 'read',
'deprecated' => false,
- 'systemTags' => [
- 'operationType' => 'none',
- 'riskType' => 'none',
- 'chargeType' => 'free',
- ],
+ 'systemTags' => ['operationType' => 'none', 'riskType' => 'none', 'chargeType' => 'free'],
'parameters' => [
[
'name' => 'workspaceId',
'in' => 'query',
- 'schema' => [
- 'description' => '当前请求所使用的阿里云百炼业务空间id',
- 'type' => 'string',
- 'required' => true,
- 'example' => 'llm-2v3934xtp49esw64'."\n",
- ],
+ 'schema' => ['description' => '当前请求所使用的阿里云百炼业务空间id', 'type' => 'string', 'required' => true, 'example' => 'llm-2v3934xtp49esw64'."\n"],
],
[
'name' => 'body',
@@ -2043,46 +1001,13 @@
'description' => '请求体参数',
'type' => 'object',
'properties' => [
- 'type' => [
- 'description' => '当前关联数据源的类型',
- 'type' => 'integer',
- 'format' => 'int32',
- 'required' => true,
- 'enumValueTitles' => [
- 1 => 'mysql类型数据源',
- 'postgresql类型数据源',
- 10 => 'hologress类型数据源',
- 'mysql类型数据源使用vpc链接',
- 'postgresql类型数据源使用vpc链接',
- 51 => 'mysql类型虚拟数据源实例',
- 'postgresql类型虚拟数据源实例',
- ],
- 'example' => '1',
- ],
- 'url' => [
- 'description' => '当前创建数据源的jdbc链接串地址',
- 'type' => 'string',
- 'required' => false,
- 'example' => 'jdbc:mysql://rm-2zedvv990c8d8rj8ejo.mysql.rds.aliyuncs.com:3306/gbi_good_case',
- ],
- 'userName' => [
- 'description' => '登录当前数据源的用户名名称',
- 'type' => 'string',
- 'required' => false,
- 'example' => 'root',
- ],
- 'password' => [
- 'description' => '登录当前数据源所使用的用户名的密码',
- 'type' => 'string',
- 'required' => false,
- 'example' => 'password',
- ],
- 'vdbId' => [
- 'description' => '关联的类型为虚拟数据源时填写，内容为虚拟数据源的实例id，其他情况无需填写',
- 'type' => 'string',
- 'required' => false,
- 'example' => 'vdb-E0F693C8-9F72-5830-B81A-696C9D8EBBD1'."\n",
- ],
+ 'tableIdKey' => ['description' => '数据表的唯一标识符id', 'type' => 'string', 'required' => true, 'example' => 'table-AAAAAAAAFQBwSLJkUj4CYg'],
+ 'nextToken' => ['description' => '分页游标。'."\n"
+ ."\n"
+ .'- 如果是首次调用，该参数不传。'."\n"
+ ."\n"
+ .'- 如果是非首次调用，该参数传上传调用时返回的nextToken。', 'type' => 'integer', 'format' => 'int32', 'required' => false, 'example' => 'e8Z0nRyY51ZQmYljqGNK'],
+ 'maxResults' => ['description' => '每页最大条目数', 'type' => 'integer', 'format' => 'int32', 'required' => false, 'example' => '10'],
],
'required' => false,
],
@@ -2095,89 +1020,156 @@
'description' => 'Result',
'type' => 'object',
'properties' => [
- 'data' => [
- 'description' => '返回信息',
- 'type' => 'any',
- 'example' => 'true',
- ],
- 'errorMsg' => [
- 'description' => '错误描述信息',
- 'type' => 'string',
- 'example' => 'NoAuth',
- ],
- 'code' => [
- 'description' => '错误码',
- 'type' => 'string',
- 'example' => 'NoAuth',
- ],
- 'success' => [
- 'description' => 'true 接口调用成功，false 接口调用失败',
- 'type' => 'boolean',
- 'example' => 'true',
- ],
- 'requestId' => [
- 'description' => '请求id，每次请求都是唯一值，便于后续排查问题',
- 'type' => 'string',
- 'example' => 'E0F693C8-9F72-5830-B81A-696C9D8EBBD1',
- ],
+ 'data' => ['description' => '返回信息', 'type' => 'any', 'example' => '{'."\n"
+ .' "data": {'."\n"
+ .' "data": ['."\n"
+ .' {'."\n"
+ .' "tableIdKey": "table-AAAAAAAAFQBwSLJkUj4CYg",'."\n"
+ .' "initializationData": "{\\"description\\":\\"下单客户的ID\\",\\"enumType\\":0,\\"gmtCreate\\":1734059103879,\\"name\\":\\"customer_id\\",\\"samples\\":\\"[]\\",\\"tableId\\":5376,\\"type\\":\\"number\\"}",'."\n"
+ .' "enumType": 0,'."\n"
+ .' "name": "customer_id",'."\n"
+ .' "description": "下单客户的ID",'."\n"
+ .' "gmtCreate": 1734059104000,'."\n"
+ .' "type": "number",'."\n"
+ .' "samples": [],'."\n"
+ .' "columnIdKey": "column-AAAAAAAAh6Q9ERazKYFvkA",'."\n"
+ .' "enumValues": []'."\n"
+ .' },'."\n"
+ .' {'."\n"
+ .' "tableIdKey": "table-AAAAAAAAFQBwSLJkUj4CYg",'."\n"
+ .' "initializationData": "{\\"description\\":\\"下单日期，格式为YYYY-MM-DD\\",\\"enumType\\":0,\\"gmtCreate\\":1734059103913,\\"name\\":\\"order_date\\",\\"samples\\":\\"[]\\",\\"tableId\\":5376,\\"type\\":\\"date\\"}",'."\n"
+ .' "enumType": 0,'."\n"
+ .' "name": "order_date",'."\n"
+ .' "description": "下单日期，格式为YYYY-MM-DD",'."\n"
+ .' "gmtCreate": 1734059104000,'."\n"
+ .' "type": "date",'."\n"
+ .' "samples": [],'."\n"
+ .' "columnIdKey": "column-AAAAAAAAh6XbT54v-8NjeA",'."\n"
+ .' "enumValues": []'."\n"
+ .' },'."\n"
+ .' {'."\n"
+ .' "tableIdKey": "table-AAAAAAAAFQBwSLJkUj4CYg",'."\n"
+ .' "initializationData": "{\\"description\\":\\"订单ID\\",\\"enumType\\":0,\\"gmtCreate\\":1734059103946,\\"name\\":\\"order_id\\",\\"samples\\":\\"[]\\",\\"tableId\\":5376,\\"type\\":\\"number\\"}",'."\n"
+ .' "enumType": 0,'."\n"
+ .' "name": "order_id",'."\n"
+ .' "description": "订单ID",'."\n"
+ .' "gmtCreate": 1734059104000,'."\n"
+ .' "type": "number",'."\n"
+ .' "samples": [],'."\n"
+ .' "columnIdKey": "column-AAAAAAAAh6avEvz8bdb30Q",'."\n"
+ .' "enumValues": []'."\n"
+ .' },'."\n"
+ .' {'."\n"
+ .' "tableIdKey": "table-AAAAAAAAFQBwSLJkUj4CYg",'."\n"
+ .' "initializationData": "{\\"description\\":\\"订单状态（例如：待发货、已发货、已送达）\\",\\"enumType\\":0,\\"gmtCreate\\":1734059103980,\\"name\\":\\"order_status\\",\\"samples\\":\\"[]\\",\\"tableId\\":5376,\\"type\\":\\"text\\"}",'."\n"
+ .' "enumType": 0,'."\n"
+ .' "name": "order_status",'."\n"
+ .' "description": "订单状态（例如：待发货、已发货、已送达）",'."\n"
+ .' "gmtCreate": 1734059104000,'."\n"
+ .' "type": "text",'."\n"
+ .' "samples": [],'."\n"
+ .' "columnIdKey": "column-AAAAAAAAh6cWOUPagYstkg",'."\n"
+ .' "enumValues": []'."\n"
+ .' },'."\n"
+ .' {'."\n"
+ .' "tableIdKey": "table-AAAAAAAAFQBwSLJkUj4CYg",'."\n"
+ .' "initializationData": "{\\"description\\":\\"所订购产品的ID\\",\\"enumType\\":0,\\"gmtCreate\\":1734059104013,\\"name\\":\\"product_id\\",\\"samples\\":\\"[]\\",\\"tableId\\":5376,\\"type\\":\\"number\\"}",'."\n"
+ .' "enumType": 0,'."\n"
+ .' "name": "product_id",'."\n"
+ .' "description": "所订购产品的ID",'."\n"
+ .' "gmtCreate": 1734059104000,'."\n"
+ .' "type": "number",'."\n"
+ .' "samples": [],'."\n"
+ .' "columnIdKey": "column-AAAAAAAAh6hFxzroVe3k4Q",'."\n"
+ .' "enumValues": []'."\n"
+ .' },'."\n"
+ .' {'."\n"
+ .' "tableIdKey": "table-AAAAAAAAFQBwSLJkUj4CYg",'."\n"
+ .' "initializationData": "{\\"description\\":\\"订购产品的数量\\",\\"enumType\\":0,\\"gmtCreate\\":1734059104046,\\"name\\":\\"quantity\\",\\"samples\\":\\"[]\\",\\"tableId\\":5376,\\"type\\":\\"number\\"}",'."\n"
+ .' "enumType": 0,'."\n"
+ .' "name": "quantity",'."\n"
+ .' "description": "订购产品的数量",'."\n"
+ .' "gmtCreate": 1734059104000,'."\n"
+ .' "type": "number",'."\n"
+ .' "samples": [],'."\n"
+ .' "columnIdKey": "column-AAAAAAAAh6ncfHPApl0elQ",'."\n"
+ .' "enumValues": []'."\n"
+ .' }'."\n"
+ .' ],'."\n"
+ .' "nextToken": "T65g+mLhrbH14+IU/ABI3Q==",'."\n"
+ .' "totalCount": 0'."\n"
+ .' }'."\n"
+ .'}'],
+ 'errorMsg' => ['description' => '错误描述信息。', 'type' => 'string', 'example' => 'NoAuth'],
+ 'code' => ['description' => '错误码', 'type' => 'string', 'example' => 'NoAuth'],
+ 'success' => ['description' => 'true 接口调用成功，false 接口调用失败', 'type' => 'boolean', 'example' => 'true'],
+ 'requestId' => ['description' => '请求id，每次请求都是唯一值，便于后续排查问题'."\n"
+ ."\n", 'type' => 'string', 'example' => 'FB11F719-9AC8-5C99-AB0A-4709D437FCFC'],
],
],
],
],
'errorCodes' => [
401 => [
- [
- 'errorCode' => 'NoAuth',
- 'errorMessage' => 'Bad Request: Workspace.Illegal.Auth.',
- ],
- [
- 'errorCode' => 'Internal.Error',
- 'errorMessage' => 'Bad Request: Internal Error.',
- ],
+ ['errorCode' => 'Internal.Error', 'errorMessage' => 'Bad Request: Internal Error.', 'description' => '内部错误，请联系客服人员排查'],
+ ['errorCode' => 'NoAuth', 'errorMessage' => 'Bad Request: Workspace.Illegal.Auth.', 'description' => '当前所使用的账号无所指定业务空间的权限'],
+ ['errorCode' => 'NoResourceAuth', 'errorMessage' => 'Bad Request: Resource Auth Error.', 'description' => '没有请求的资源的权限，请确保所请求的资源属于当前参数中的业务空间'],
],
],
- 'staticInfo' => [
- 'returnType' => 'synchronous',
+ 'staticInfo' => ['returnType' => 'synchronous'],
+ 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"data\\": \\"{\\\\n \\\\\\"data\\\\\\": {\\\\n \\\\\\"data\\\\\\": [\\\\n {\\\\n \\\\\\"tableIdKey\\\\\\": \\\\\\"table-AAAAAAAAFQBwSLJkUj4CYg\\\\\\",\\\\n \\\\\\"initializationData\\\\\\": \\\\\\"{\\\\\\\\\\\\\\"description\\\\\\\\\\\\\\":\\\\\\\\\\\\\\"下单客户的ID\\\\\\\\\\\\\\",\\\\\\\\\\\\\\"enumType\\\\\\\\\\\\\\":0,\\\\\\\\\\\\\\"gmtCreate\\\\\\\\\\\\\\":1734059103879,\\\\\\\\\\\\\\"name\\\\\\\\\\\\\\":\\\\\\\\\\\\\\"customer_id\\\\\\\\\\\\\\",\\\\\\\\\\\\\\"samples\\\\\\\\\\\\\\":\\\\\\\\\\\\\\"[]\\\\\\\\\\\\\\",\\\\\\\\\\\\\\"tableId\\\\\\\\\\\\\\":5376,\\\\\\\\\\\\\\"type\\\\\\\\\\\\\\":\\\\\\\\\\\\\\"number\\\\\\\\\\\\\\"}\\\\\\",\\\\n \\\\\\"enumType\\\\\\": 0,\\\\n \\\\\\"name\\\\\\": \\\\\\"customer_id\\\\\\",\\\\n \\\\\\"description\\\\\\": \\\\\\"下单客户的ID\\\\\\",\\\\n \\\\\\"gmtCreate\\\\\\": 1734059104000,\\\\n \\\\\\"type\\\\\\": \\\\\\"number\\\\\\",\\\\n \\\\\\"samples\\\\\\": [],\\\\n \\\\\\"columnIdKey\\\\\\": \\\\\\"column-AAAAAAAAh6Q9ERazKYFvkA\\\\\\",\\\\n \\\\\\"enumValues\\\\\\": []\\\\n },\\\\n {\\\\n \\\\\\"tableIdKey\\\\\\": \\\\\\"table-AAAAAAAAFQBwSLJkUj4CYg\\\\\\",\\\\n \\\\\\"initializationData\\\\\\": \\\\\\"{\\\\\\\\\\\\\\"description\\\\\\\\\\\\\\":\\\\\\\\\\\\\\"下单日期，格式为YYYY-MM-DD\\\\\\\\\\\\\\",\\\\\\\\\\\\\\"enumType\\\\\\\\\\\\\\":0,\\\\\\\\\\\\\\"gmtCreate\\\\\\\\\\\\\\":1734059103913,\\\\\\\\\\\\\\"name\\\\\\\\\\\\\\":\\\\\\\\\\\\\\"order_date\\\\\\\\\\\\\\",\\\\\\\\\\\\\\"samples\\\\\\\\\\\\\\":\\\\\\\\\\\\\\"[]\\\\\\\\\\\\\\",\\\\\\\\\\\\\\"tableId\\\\\\\\\\\\\\":5376,\\\\\\\\\\\\\\"type\\\\\\\\\\\\\\":\\\\\\\\\\\\\\"date\\\\\\\\\\\\\\"}\\\\\\",\\\\n \\\\\\"enumType\\\\\\": 0,\\\\n \\\\\\"name\\\\\\": \\\\\\"order_date\\\\\\",\\\\n \\\\\\"description\\\\\\": \\\\\\"下单日期，格式为YYYY-MM-DD\\\\\\",\\\\n \\\\\\"gmtCreate\\\\\\": 1734059104000,\\\\n \\\\\\"type\\\\\\": \\\\\\"date\\\\\\",\\\\n \\\\\\"samples\\\\\\": [],\\\\n \\\\\\"columnIdKey\\\\\\": \\\\\\"column-AAAAAAAAh6XbT54v-8NjeA\\\\\\",\\\\n \\\\\\"enumValues\\\\\\": []\\\\n },\\\\n {\\\\n \\\\\\"tableIdKey\\\\\\": \\\\\\"table-AAAAAAAAFQBwSLJkUj4CYg\\\\\\",\\\\n \\\\\\"initializationData\\\\\\": \\\\\\"{\\\\\\\\\\\\\\"description\\\\\\\\\\\\\\":\\\\\\\\\\\\\\"订单ID\\\\\\\\\\\\\\",\\\\\\\\\\\\\\"enumType\\\\\\\\\\\\\\":0,\\\\\\\\\\\\\\"gmtCreate\\\\\\\\\\\\\\":1734059103946,\\\\\\\\\\\\\\"name\\\\\\\\\\\\\\":\\\\\\\\\\\\\\"order_id\\\\\\\\\\\\\\",\\\\\\\\\\\\\\"samples\\\\\\\\\\\\\\":\\\\\\\\\\\\\\"[]\\\\\\\\\\\\\\",\\\\\\\\\\\\\\"tableId\\\\\\\\\\\\\\":5376,\\\\\\\\\\\\\\"type\\\\\\\\\\\\\\":\\\\\\\\\\\\\\"number\\\\\\\\\\\\\\"}\\\\\\",\\\\n \\\\\\"enumType\\\\\\": 0,\\\\n \\\\\\"name\\\\\\": \\\\\\"order_id\\\\\\",\\\\n \\\\\\"description\\\\\\": \\\\\\"订单ID\\\\\\",\\\\n \\\\\\"gmtCreate\\\\\\": 1734059104000,\\\\n \\\\\\"type\\\\\\": \\\\\\"number\\\\\\",\\\\n \\\\\\"samples\\\\\\": [],\\\\n \\\\\\"columnIdKey\\\\\\": \\\\\\"column-AAAAAAAAh6avEvz8bdb30Q\\\\\\",\\\\n \\\\\\"enumValues\\\\\\": []\\\\n },\\\\n {\\\\n \\\\\\"tableIdKey\\\\\\": \\\\\\"table-AAAAAAAAFQBwSLJkUj4CYg\\\\\\",\\\\n \\\\\\"initializationData\\\\\\": \\\\\\"{\\\\\\\\\\\\\\"description\\\\\\\\\\\\\\":\\\\\\\\\\\\\\"订单状态（例如：待发货、已发货、已送达）\\\\\\\\\\\\\\",\\\\\\\\\\\\\\"enumType\\\\\\\\\\\\\\":0,\\\\\\\\\\\\\\"gmtCreate\\\\\\\\\\\\\\":1734059103980,\\\\\\\\\\\\\\"name\\\\\\\\\\\\\\":\\\\\\\\\\\\\\"order_status\\\\\\\\\\\\\\",\\\\\\\\\\\\\\"samples\\\\\\\\\\\\\\":\\\\\\\\\\\\\\"[]\\\\\\\\\\\\\\",\\\\\\\\\\\\\\"tableId\\\\\\\\\\\\\\":5376,\\\\\\\\\\\\\\"type\\\\\\\\\\\\\\":\\\\\\\\\\\\\\"text\\\\\\\\\\\\\\"}\\\\\\",\\\\n \\\\\\"enumType\\\\\\": 0,\\\\n \\\\\\"name\\\\\\": \\\\\\"order_status\\\\\\",\\\\n \\\\\\"description\\\\\\": \\\\\\"订单状态（例如：待发货、已发货、已送达）\\\\\\",\\\\n \\\\\\"gmtCreate\\\\\\": 1734059104000,\\\\n \\\\\\"type\\\\\\": \\\\\\"text\\\\\\",\\\\n \\\\\\"samples\\\\\\": [],\\\\n \\\\\\"columnIdKey\\\\\\": \\\\\\"column-AAAAAAAAh6cWOUPagYstkg\\\\\\",\\\\n \\\\\\"enumValues\\\\\\": []\\\\n },\\\\n {\\\\n \\\\\\"tableIdKey\\\\\\": \\\\\\"table-AAAAAAAAFQBwSLJkUj4CYg\\\\\\",\\\\n \\\\\\"initializationData\\\\\\": \\\\\\"{\\\\\\\\\\\\\\"description\\\\\\\\\\\\\\":\\\\\\\\\\\\\\"所订购产品的ID\\\\\\\\\\\\\\",\\\\\\\\\\\\\\"enumType\\\\\\\\\\\\\\":0,\\\\\\\\\\\\\\"gmtCreate\\\\\\\\\\\\\\":1734059104013,\\\\\\\\\\\\\\"name\\\\\\\\\\\\\\":\\\\\\\\\\\\\\"product_id\\\\\\\\\\\\\\",\\\\\\\\\\\\\\"samples\\\\\\\\\\\\\\":\\\\\\\\\\\\\\"[]\\\\\\\\\\\\\\",\\\\\\\\\\\\\\"tableId\\\\\\\\\\\\\\":5376,\\\\\\\\\\\\\\"type\\\\\\\\\\\\\\":\\\\\\\\\\\\\\"number\\\\\\\\\\\\\\"}\\\\\\",\\\\n \\\\\\"enumType\\\\\\": 0,\\\\n \\\\\\"name\\\\\\": \\\\\\"product_id\\\\\\",\\\\n \\\\\\"description\\\\\\": \\\\\\"所订购产品的ID\\\\\\",\\\\n \\\\\\"gmtCreate\\\\\\": 1734059104000,\\\\n \\\\\\"type\\\\\\": \\\\\\"number\\\\\\",\\\\n \\\\\\"samples\\\\\\": [],\\\\n \\\\\\"columnIdKey\\\\\\": \\\\\\"column-AAAAAAAAh6hFxzroVe3k4Q\\\\\\",\\\\n \\\\\\"enumValues\\\\\\": []\\\\n },\\\\n {\\\\n \\\\\\"tableIdKey\\\\\\": \\\\\\"table-AAAAAAAAFQBwSLJkUj4CYg\\\\\\",\\\\n \\\\\\"initializationData\\\\\\": \\\\\\"{\\\\\\\\\\\\\\"description\\\\\\\\\\\\\\":\\\\\\\\\\\\\\"订购产品的数量\\\\\\\\\\\\\\",\\\\\\\\\\\\\\"enumType\\\\\\\\\\\\\\":0,\\\\\\\\\\\\\\"gmtCreate\\\\\\\\\\\\\\":1734059104046,\\\\\\\\\\\\\\"name\\\\\\\\\\\\\\":\\\\\\\\\\\\\\"quantity\\\\\\\\\\\\\\",\\\\\\\\\\\\\\"samples\\\\\\\\\\\\\\":\\\\\\\\\\\\\\"[]\\\\\\\\\\\\\\",\\\\\\\\\\\\\\"tableId\\\\\\\\\\\\\\":5376,\\\\\\\\\\\\\\"type\\\\\\\\\\\\\\":\\\\\\\\\\\\\\"number\\\\\\\\\\\\\\"}\\\\\\",\\\\n \\\\\\"enumType\\\\\\": 0,\\\\n \\\\\\"name\\\\\\": \\\\\\"quantity\\\\\\",\\\\n \\\\\\"description\\\\\\": \\\\\\"订购产品的数量\\\\\\",\\\\n \\\\\\"gmtCreate\\\\\\": 1734059104000,\\\\n \\\\\\"type\\\\\\": \\\\\\"number\\\\\\",\\\\n \\\\\\"samples\\\\\\": [],\\\\n \\\\\\"columnIdKey\\\\\\": \\\\\\"column-AAAAAAAAh6ncfHPApl0elQ\\\\\\",\\\\n \\\\\\"enumValues\\\\\\": []\\\\n }\\\\n ],\\\\n \\\\\\"nextToken\\\\\\": \\\\\\"T65g+mLhrbH14+IU/ABI3Q==\\\\\\",\\\\n \\\\\\"totalCount\\\\\\": 0\\\\n }\\\\n}\\",\\n \\"errorMsg\\": \\"NoAuth\\",\\n \\"code\\": \\"NoAuth\\",\\n \\"success\\": true,\\n \\"requestId\\": \\"FB11F719-9AC8-5C99-AB0A-4709D437FCFC\\"\\n}","type":"json"}]',
+ 'title' => '数据表下的数据列集合',
+ 'changeSet' => [],
+ 'flowControl' => [
+ 'flowControlList' => [],
+ ],
+ 'ramActions' => [
+ [
+ 'operationType' => 'none',
+ 'ramAction' => [
+ 'action' => 'dataanalysisgbi:ListColumn',
+ 'authLevel' => 'operate',
+ 'actionConditions' => [],
+ 'resources' => [
+ ['validationType' => 'always', 'product' => 'DataAnalysisGBI', 'resourceType' => '全部资源', 'arn' => '*'],
+ ],
+ ],
+ ],
],
- 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"data\\": \\"true\\",\\n \\"errorMsg\\": \\"NoAuth\\",\\n \\"code\\": \\"NoAuth\\",\\n \\"success\\": true,\\n \\"requestId\\": \\"E0F693C8-9F72-5830-B81A-696C9D8EBBD1\\"\\n}","type":"json"}]',
- 'title' => '数据源关联关系授权',
],
- 'CancelDatasourceAuthorization' => [
- 'summary' => '取消关联的数据源授权。',
- 'path' => '/gbi/cancel/datasource',
- 'methods' => [
- 'post',
- ],
- 'schemes' => [
- 'https',
- ],
+ 'ListEnumMapping' => [
+ 'summary' => '获取当前业务空间，指定表、列下的枚举值。',
+ 'path' => '/gbi/list/mapping',
+ 'methods' => ['post'],
+ 'schemes' => ['https'],
'security' => [
[
'AK' => [],
],
],
- 'consumes' => [
- 'application/json',
- ],
- 'produces' => [
- 'application/json',
- ],
- 'operationType' => 'write',
+ 'consumes' => ['application/json'],
+ 'produces' => ['application/json'],
+ 'operationType' => 'read',
'deprecated' => false,
- 'systemTags' => [
- 'operationType' => 'none',
- 'riskType' => 'none',
- 'chargeType' => 'free',
- ],
+ 'systemTags' => ['operationType' => 'none', 'riskType' => 'none', 'chargeType' => 'free'],
'parameters' => [
[
'name' => 'workspaceId',
'in' => 'query',
+ 'schema' => ['description' => '当前请求所使用的阿里云百炼业务空间id', 'type' => 'string', 'required' => true, 'example' => 'llm-2v3934xtp49esw64'."\n"],
+ ],
+ [
+ 'name' => 'body',
+ 'in' => 'body',
+ 'style' => 'json',
'schema' => [
- 'description' => '当前请求所使用的阿里云百炼业务空间id',
- 'type' => 'string',
- 'required' => true,
- 'example' => 'llm-2v3934xtp49esw64'."\n",
+ 'description' => '请求体参数',
+ 'type' => 'object',
+ 'properties' => [
+ 'tableIdKey' => ['description' => '数据表的唯一标识符id', 'type' => 'string', 'required' => true, 'example' => 'table-AAAAAAAAFQBwSLJkUj4CYg'],
+ 'columnIdKey' => ['description' => '数据列的唯一标识符id', 'type' => 'string', 'required' => true, 'example' => 'column-AAAAAAAAh6cWOUPagYstkg'],
+ ],
+ 'required' => false,
],
],
],
@@ -2188,91 +1180,69 @@
'description' => 'Result',
'type' => 'object',
'properties' => [
- 'data' => [
- 'description' => '返回信息',
- 'type' => 'any',
- 'example' => 'true',
- ],
- 'errorMsg' => [
- 'description' => '错误描述信息',
- 'type' => 'string',
- 'example' => '""',
- ],
- 'code' => [
- 'description' => '错误码',
- 'type' => 'string',
- 'example' => '""',
- ],
- 'success' => [
- 'description' => 'true 接口调用成功，false 接口调用失败',
- 'type' => 'boolean',
- 'example' => 'true',
- ],
- 'requestId' => [
- 'description' => '请求id，每次请求都是唯一值，便于后续排查问题',
- 'type' => 'string',
- 'example' => 'FB11F719-9AC8-5C99-AB0A-4709D437FCFC',
- ],
+ 'data' => ['description' => '返回信息', 'type' => 'any', 'example' => '{'."\n"
+ .' "data": {'."\n"
+ .' "数码产品": [],'."\n"
+ .' "箱包配饰": []'."\n"
+ .' }'."\n"
+ .'}'],
+ 'errorMsg' => ['description' => '错误描述信息。', 'type' => 'string', 'example' => 'NoAuth'],
+ 'code' => ['description' => '错误码。', 'type' => 'string', 'example' => 'NoAuth'],
+ 'success' => ['description' => 'true 接口调用成功，false 接口调用失败', 'type' => 'boolean', 'example' => 'true'],
+ 'requestId' => ['description' => '请求id，每次请求都是唯一值，便于后续排查问题', 'type' => 'string', 'example' => 'FB11F719-9AC8-5C99-AB0A-4709D437FCFC'],
],
],
],
],
'errorCodes' => [
401 => [
- [
- 'errorCode' => 'NoAuth',
- 'errorMessage' => 'Bad Request: Workspace.Illegal.Auth.',
- ],
- [
- 'errorCode' => 'Internal.Error',
- 'errorMessage' => 'Bad Request: Internal Error.',
- ],
+ ['errorCode' => 'Internal.Error', 'errorMessage' => 'Bad Request: Internal Error.', 'description' => '内部错误，请联系客服人员排查'],
+ ['errorCode' => 'NoAuth', 'errorMessage' => 'Bad Request: Workspace.Illegal.Auth.', 'description' => '当前所使用的账号无所指定业务空间的权限'],
+ ['errorCode' => 'NoResourceAuth', 'errorMessage' => 'Bad Request: Resource Auth Error.', 'description' => '没有请求的资源的权限，请确保所请求的资源属于当前参数中的业务空间'],
+ ['errorCode' => 'SystemOperationInProgress', 'errorMessage' => 'Xiyan GBI is learning your previous modifications. Please try again later.', 'description' => '析言GBI正在学习您之前的修改内容，请稍后重试'],
],
],
- 'staticInfo' => [
- 'returnType' => 'synchronous',
+ 'staticInfo' => ['returnType' => 'synchronous'],
+ 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"data\\": \\"{\\\\n \\\\\\"data\\\\\\": {\\\\n \\\\\\"数码产品\\\\\\": [],\\\\n \\\\\\"箱包配饰\\\\\\": []\\\\n }\\\\n}\\",\\n \\"errorMsg\\": \\"NoAuth\\",\\n \\"code\\": \\"NoAuth\\",\\n \\"success\\": true,\\n \\"requestId\\": \\"FB11F719-9AC8-5C99-AB0A-4709D437FCFC\\"\\n}","type":"json"}]',
+ 'title' => '枚举值映射列表',
+ 'changeSet' => [],
+ 'flowControl' => [
+ 'flowControlList' => [],
+ ],
+ 'ramActions' => [
+ [
+ 'operationType' => 'none',
+ 'ramAction' => [
+ 'action' => 'dataanalysisgbi:ListEnumMapping',
+ 'authLevel' => 'operate',
+ 'actionConditions' => [],
+ 'resources' => [
+ ['validationType' => 'always', 'product' => 'DataAnalysisGBI', 'resourceType' => '全部资源', 'arn' => '*'],
+ ],
+ ],
+ ],
],
- 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"data\\": \\"true\\",\\n \\"errorMsg\\": \\"\\\\\\"\\\\\\"\\",\\n \\"code\\": \\"\\\\\\"\\\\\\"\\",\\n \\"success\\": true,\\n \\"requestId\\": \\"FB11F719-9AC8-5C99-AB0A-4709D437FCFC\\"\\n}","type":"json"}]',
- 'title' => '取消数据源关联关系授权',
- 'responseParamsDescription' => '当 success 为 true 时，errorMsg 和 code 应为空字符串 ""。',
],
- 'SyncRemoteTables' => [
- 'summary' => '更新当前业务空间所关联的数据表，从远程数据源（虚拟数据源）同步最近的表并关联到您所指定的业务空间。',
- 'path' => '/gbi/update/datasource/tables',
- 'methods' => [
- 'post',
- ],
- 'schemes' => [
- 'https',
- ],
+ 'ListSelectedTables' => [
+ 'summary' => '获取当前业务空间处于以关联状态的数据表。',
+ 'path' => '/gbi/list/datasource/table',
+ 'methods' => ['post'],
+ 'schemes' => ['https'],
'security' => [
[
'AK' => [],
],
],
- 'consumes' => [
- 'application/json',
- ],
- 'produces' => [
- 'application/json',
- ],
- 'operationType' => 'write',
+ 'consumes' => ['application/json'],
+ 'produces' => ['application/json'],
+ 'operationType' => 'read',
'deprecated' => false,
- 'systemTags' => [
- 'operationType' => 'none',
- 'riskType' => 'none',
- 'chargeType' => 'free',
- ],
+ 'systemTags' => ['operationType' => 'none', 'riskType' => 'none', 'chargeType' => 'free'],
'parameters' => [
[
'name' => 'workspaceId',
'in' => 'query',
- 'schema' => [
- 'description' => '当前请求所使用的阿里云百炼业务空间id',
- 'type' => 'string',
- 'required' => true,
- 'example' => 'llm-2v3934xtp49esw64'."\n",
- ],
+ 'schema' => ['description' => '当前请求所使用的阿里云百炼业务空间id', 'type' => 'string', 'required' => true, 'example' => 'llm-2v3934xtp49esw64'."\n"],
],
[
'name' => 'body',
@@ -2282,49 +1252,12 @@
'description' => '请求体参数',
'type' => 'object',
'properties' => [
- 'tableNames' => [
- 'description' => '需要关联的数据表的名称列表',
- 'type' => 'array',
- 'items' => [
- 'description' => '数据表名称',
- 'type' => 'string',
- 'required' => false,
- 'example' => 'user',
- ],
- 'required' => true,
- ],
- 'pullSamples' => [
- 'description' => '关联数据表时是否拉取数据样例',
- 'type' => 'boolean',
- 'required' => false,
- 'example' => 'true',
- ],
- 'keepTableNames' => [
- 'description' => '关联数据表时，需要执行"保留并新增"操作的数据表名称列表。'."\n"
- ."\n"
- .'> 保留并新增：对于选择“保留并新增"的表，析言将保留已关联列的信息，同时补充未关联列的信息。',
- 'type' => 'array',
- 'items' => [
- 'description' => '数据表名称',
- 'type' => 'string',
- 'required' => false,
- 'example' => 'order',
- ],
- 'required' => false,
- ],
- 'noModifiedTableNames' => [
- 'description' => '关联数据表时，需要"保留并跳过"的数据表名称列表。'."\n"
- ."\n"
- .'> 保留并跳过：对于选择"保留并跳过"的表，析言将保留所有已关联列的信息，同时不补充任何未关联列的信息。',
- 'type' => 'array',
- 'items' => [
- 'description' => '数据表名称',
- 'type' => 'string',
- 'required' => false,
- 'example' => 'user',
- ],
- 'required' => false,
- ],
+ 'nextToken' => ['description' => '分页游标。'."\n"
+ ."\n"
+ .'- 如果是首次调用，该参数不传。'."\n"
+ ."\n"
+ .'- 如果是非首次调用，该参数传上传调用时返回的nextToken。', 'type' => 'string', 'required' => false, 'example' => 'e8Z0nRyY51ZQmYljqGNK'],
+ 'maxResults' => ['description' => '每页最大条目数', 'type' => 'integer', 'format' => 'int32', 'required' => false, 'example' => '10'],
],
'required' => false,
],
@@ -2337,90 +1270,93 @@
'description' => 'Result',
'type' => 'object',
'properties' => [
- 'data' => [
- 'description' => '返回信息',
- 'type' => 'any',
- 'example' => 'true',
- ],
- 'errorMsg' => [
- 'description' => '错误描述信息',
- 'type' => 'string',
- 'example' => 'NoAuth',
- ],
- 'code' => [
- 'description' => '错误码',
- 'type' => 'string',
- 'example' => 'NoAuth',
- ],
- 'success' => [
- 'description' => 'true 接口调用成功，false 接口调用失败',
- 'type' => 'boolean',
- 'example' => 'true',
- ],
- 'requestId' => [
- 'description' => '请求id，每次请求都是唯一值，便于后续排查问题',
- 'type' => 'string',
- 'example' => 'E9563C85-5810-5835-B68C-78580BC3169E',
- ],
+ 'data' => ['description' => '返回信息', 'type' => 'any', 'example' => '{'."\n"
+ .' "data": {'."\n"
+ .' "data": ['."\n"
+ .' {'."\n"
+ .' "tableIdKey": "table-AAAAAAAAFP8AL2bSar8jcQ",'."\n"
+ .' "workSpaceId": "10026203",'."\n"
+ .' "description": "存储客户信息的表",'."\n"
+ .' "foreignKey": "orders.customer_id=customers.customer_id",'."\n"
+ .' "primaryKey": "customer_id",'."\n"
+ .' "tableName": "customers"'."\n"
+ .' },'."\n"
+ .' {'."\n"
+ .' "tableIdKey": "table-AAAAAAAAFP8AL2bSar8jcQ",'."\n"
+ .' "workSpaceId": "10026203",'."\n"
+ .' "description": "存储订单信息的表",'."\n"
+ .' "foreignKey": "orders.customer_id=customers.customer_id",'."\n"
+ .' "primaryKey": "order_id",'."\n"
+ .' "tableName": "orders"'."\n"
+ .' },'."\n"
+ .' {'."\n"
+ .' "tableIdKey": "table-AAAAAAAAFP8AL2bSar8jcQ",'."\n"
+ .' "workSpaceId": "10026203",'."\n"
+ .' "description": "存储产品信息的表",'."\n"
+ .' "foreignKey": "",'."\n"
+ .' "primaryKey": "product_id",'."\n"
+ .' "tableName": "products"'."\n"
+ .' }'."\n"
+ .' ],'."\n"
+ .' "nextToken": "GsLIn+Ur2OowIcLywVF9Vg==",'."\n"
+ .' "totalCount": 0'."\n"
+ .' }'."\n"
+ .'}'],
+ 'errorMsg' => ['description' => '错误描述信息', 'type' => 'string', 'example' => 'NoAuth'],
+ 'code' => ['description' => '错误码', 'type' => 'string', 'example' => 'NoAuth'],
+ 'success' => ['description' => 'true 接口调用成功，false 接口调用失败', 'type' => 'boolean', 'example' => 'true'],
+ 'requestId' => ['description' => '请求id，每次请求都是唯一值，便于后续排查问题', 'type' => 'string', 'example' => 'FB11F719-9AC8-5C99-AB0A-4709D437FCFC'],
],
],
],
],
'errorCodes' => [
401 => [
- [
- 'errorCode' => 'NoAuth',
- 'errorMessage' => 'Bad Request: Workspace.Illegal.Auth.',
- ],
- [
- 'errorCode' => 'Internal.Error',
- 'errorMessage' => 'Bad Request: Internal Error.',
- ],
+ ['errorCode' => 'Internal.Error', 'errorMessage' => 'Bad Request: Internal Error.', 'description' => '内部错误，请联系客服人员排查'],
+ ['errorCode' => 'NoAuth', 'errorMessage' => 'Bad Request: Workspace.Illegal.Auth.', 'description' => '当前所使用的账号无所指定业务空间的权限'],
],
],
- 'staticInfo' => [
- 'returnType' => 'synchronous',
+ 'staticInfo' => ['returnType' => 'synchronous'],
+ 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"data\\": \\"{\\\\n \\\\\\"data\\\\\\": {\\\\n \\\\\\"data\\\\\\": [\\\\n {\\\\n \\\\\\"tableIdKey\\\\\\": \\\\\\"table-AAAAAAAAFP8AL2bSar8jcQ\\\\\\",\\\\n \\\\\\"workSpaceId\\\\\\": \\\\\\"10026203\\\\\\",\\\\n \\\\\\"description\\\\\\": \\\\\\"存储客户信息的表\\\\\\",\\\\n \\\\\\"foreignKey\\\\\\": \\\\\\"orders.customer_id=customers.customer_id\\\\\\",\\\\n \\\\\\"primaryKey\\\\\\": \\\\\\"customer_id\\\\\\",\\\\n \\\\\\"tableName\\\\\\": \\\\\\"customers\\\\\\"\\\\n },\\\\n {\\\\n \\\\\\"tableIdKey\\\\\\": \\\\\\"table-AAAAAAAAFP8AL2bSar8jcQ\\\\\\",\\\\n \\\\\\"workSpaceId\\\\\\": \\\\\\"10026203\\\\\\",\\\\n \\\\\\"description\\\\\\": \\\\\\"存储订单信息的表\\\\\\",\\\\n \\\\\\"foreignKey\\\\\\": \\\\\\"orders.customer_id=customers.customer_id\\\\\\",\\\\n \\\\\\"primaryKey\\\\\\": \\\\\\"order_id\\\\\\",\\\\n \\\\\\"tableName\\\\\\": \\\\\\"orders\\\\\\"\\\\n },\\\\n {\\\\n \\\\\\"tableIdKey\\\\\\": \\\\\\"table-AAAAAAAAFP8AL2bSar8jcQ\\\\\\",\\\\n \\\\\\"workSpaceId\\\\\\": \\\\\\"10026203\\\\\\",\\\\n \\\\\\"description\\\\\\": \\\\\\"存储产品信息的表\\\\\\",\\\\n \\\\\\"foreignKey\\\\\\": \\\\\\"\\\\\\",\\\\n \\\\\\"primaryKey\\\\\\": \\\\\\"product_id\\\\\\",\\\\n \\\\\\"tableName\\\\\\": \\\\\\"products\\\\\\"\\\\n }\\\\n ],\\\\n \\\\\\"nextToken\\\\\\": \\\\\\"GsLIn+Ur2OowIcLywVF9Vg==\\\\\\",\\\\n \\\\\\"totalCount\\\\\\": 0\\\\n }\\\\n}\\",\\n \\"errorMsg\\": \\"NoAuth\\",\\n \\"code\\": \\"NoAuth\\",\\n \\"success\\": true,\\n \\"requestId\\": \\"FB11F719-9AC8-5C99-AB0A-4709D437FCFC\\"\\n}","type":"json"}]',
+ 'title' => '选择的数据表集合',
+ 'changeSet' => [],
+ 'flowControl' => [
+ 'flowControlList' => [],
+ ],
+ 'ramActions' => [
+ [
+ 'operationType' => 'none',
+ 'ramAction' => [
+ 'action' => 'dataanalysisgbi:ListSelectedTables',
+ 'authLevel' => 'operate',
+ 'actionConditions' => [],
+ 'resources' => [
+ ['validationType' => 'always', 'product' => 'DataAnalysisGBI', 'resourceType' => '全部资源', 'arn' => '*'],
+ ],
+ ],
+ ],
],
- 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"data\\": \\"true\\",\\n \\"errorMsg\\": \\"NoAuth\\",\\n \\"code\\": \\"NoAuth\\",\\n \\"success\\": true,\\n \\"requestId\\": \\"E9563C85-5810-5835-B68C-78580BC3169E\\"\\n}","type":"json"}]',
- 'title' => '从数据源同步数据表',
],
- 'ListSelectedTables' => [
- 'summary' => '获取当前业务空间处于以关联状态的数据表。',
- 'path' => '/gbi/list/datasource/table',
- 'methods' => [
- 'post',
- ],
- 'schemes' => [
- 'https',
- ],
+ 'ListSynonyms' => [
+ 'summary' => '获取当前指定业务空间下的同义词列表。',
+ 'path' => '/gbi/list/synonyms',
+ 'methods' => ['post'],
+ 'schemes' => ['https'],
'security' => [
[
'AK' => [],
],
],
- 'consumes' => [
- 'application/json',
- ],
- 'produces' => [
- 'application/json',
- ],
+ 'consumes' => ['application/json'],
+ 'produces' => ['application/json'],
'operationType' => 'read',
'deprecated' => false,
- 'systemTags' => [
- 'operationType' => 'none',
- 'riskType' => 'none',
- 'chargeType' => 'free',
- ],
+ 'systemTags' => ['operationType' => 'none', 'riskType' => 'none', 'chargeType' => 'free'],
'parameters' => [
[
'name' => 'workspaceId',
'in' => 'query',
- 'schema' => [
- 'description' => '当前请求所使用的阿里云百炼业务空间id',
- 'type' => 'string',
- 'required' => true,
- 'example' => 'llm-2v3934xtp49esw64'."\n",
- ],
+ 'schema' => ['description' => '当前请求所使用的阿里云百炼业务空间id', 'type' => 'string', 'required' => true, 'example' => 'llm-2v3934xtp49esw64'."\n"],
],
[
'name' => 'body',
@@ -2430,23 +1366,12 @@
'description' => '请求体参数',
'type' => 'object',
'properties' => [
- 'nextToken' => [
- 'description' => '分页游标。'."\n"
- ."\n"
- .'- 如果是首次调用，该参数不传。'."\n"
- ."\n"
- .'- 如果是非首次调用，该参数传上传调用时返回的nextToken。',
- 'type' => 'string',
- 'required' => false,
- 'example' => 'e8Z0nRyY51ZQmYljqGNK',
- ],
- 'maxResults' => [
- 'description' => '每页最大条目数',
- 'type' => 'integer',
- 'format' => 'int32',
- 'required' => false,
- 'example' => '10',
- ],
+ 'nextToken' => ['description' => '分页游标。'."\n"
+ ."\n"
+ .'- 如果是首次调用，该参数不传。'."\n"
+ ."\n"
+ .'- 如果是非首次调用，该参数传上传调用时返回的nextToken。', 'type' => 'string', 'required' => false, 'example' => 'e8Z0nRyY51ZQmYljqGNK'],
+ 'maxResults' => ['description' => '每页最大条目数', 'type' => 'integer', 'format' => 'int64', 'required' => false, 'example' => '10'],
],
'required' => false,
],
@@ -2459,121 +1384,88 @@
'description' => 'Result',
'type' => 'object',
'properties' => [
- 'data' => [
- 'description' => '返回信息',
- 'type' => 'any',
- 'example' => '{'."\n"
- .' "data": {'."\n"
- .' "data": ['."\n"
- .' {'."\n"
- .' "tableIdKey": "table-AAAAAAAAFP8AL2bSar8jcQ",'."\n"
- .' "workSpaceId": "10026203",'."\n"
- .' "description": "存储客户信息的表",'."\n"
- .' "foreignKey": "orders.customer_id=customers.customer_id",'."\n"
- .' "primaryKey": "customer_id",'."\n"
- .' "tableName": "customers"'."\n"
- .' },'."\n"
- .' {'."\n"
- .' "tableIdKey": "table-AAAAAAAAFP8AL2bSar8jcQ",'."\n"
- .' "workSpaceId": "10026203",'."\n"
- .' "description": "存储订单信息的表",'."\n"
- .' "foreignKey": "orders.customer_id=customers.customer_id",'."\n"
- .' "primaryKey": "order_id",'."\n"
- .' "tableName": "orders"'."\n"
- .' },'."\n"
- .' {'."\n"
- .' "tableIdKey": "table-AAAAAAAAFP8AL2bSar8jcQ",'."\n"
- .' "workSpaceId": "10026203",'."\n"
- .' "description": "存储产品信息的表",'."\n"
- .' "foreignKey": "",'."\n"
- .' "primaryKey": "product_id",'."\n"
- .' "tableName": "products"'."\n"
- .' }'."\n"
- .' ],'."\n"
- .' "nextToken": "GsLIn+Ur2OowIcLywVF9Vg==",'."\n"
- .' "totalCount": 0'."\n"
- .' }'."\n"
- .'}',
- ],
- 'errorMsg' => [
- 'description' => '错误描述信息',
- 'type' => 'string',
- 'example' => 'NoAuth',
- ],
- 'code' => [
- 'description' => '错误码',
- 'type' => 'string',
- 'example' => 'NoAuth',
- ],
- 'success' => [
- 'description' => 'true 接口调用成功，false 接口调用失败',
- 'type' => 'boolean',
- 'example' => 'true',
- ],
- 'requestId' => [
- 'description' => '请求id，每次请求都是唯一值，便于后续排查问题',
- 'type' => 'string',
- 'example' => 'FB11F719-9AC8-5C99-AB0A-4709D437FCFC',
- ],
+ 'data' => ['description' => '返回信息', 'type' => 'any', 'example' => '{'."\n"
+ .' "data": {'."\n"
+ .' "data": ['."\n"
+ .' {'."\n"
+ .' "gmtModified": 1734401404000,'."\n"
+ .' "columns": ['."\n"
+ .' "test.id",'."\n"
+ .' "user_info.createdt"'."\n"
+ .' ],'."\n"
+ .' "synonymIdKey": "synonyms-AAAAAAAAAVLaD8z63NnFhA",'."\n"
+ .' "wordSynonyms": ['."\n"
+ .' "1"'."\n"
+ .' ],'."\n"
+ .' "workSpaceId": "10024809",'."\n"
+ .' "gmtCreate": 1734401404000,'."\n"
+ .' "word": "1",'."\n"
+ .' "status": 1'."\n"
+ .' }'."\n"
+ .' ],'."\n"
+ .' "nextToken": "k1BLjEN114wyfrhDHoJlbg==",'."\n"
+ .' "totalCount": 0'."\n"
+ .' }'."\n"
+ .'}'],
+ 'errorMsg' => ['description' => '错误描述信息。', 'type' => 'string', 'example' => 'NoAuth'],
+ 'code' => ['description' => '错误码', 'type' => 'string', 'example' => 'NoAuth'],
+ 'success' => ['description' => '调用是否成功。'."\n"
+ .'true，表示成功；'."\n"
+ .'false，表示失败。', 'type' => 'boolean', 'example' => 'true'],
+ 'requestId' => ['description' => '请求id，每次请求都是唯一值，便于后续排查问题', 'type' => 'string', 'example' => 'D02D895A-5E58-5A9F-963D-D8B027AB7AE2'],
],
],
],
],
'errorCodes' => [
401 => [
- [
- 'errorCode' => 'Internal.Error',
- 'errorMessage' => 'Bad Request: Internal Error.',
- ],
- [
- 'errorCode' => 'NoAuth',
- 'errorMessage' => 'Bad Request: Workspace.Illegal.Auth.',
- ],
+ ['errorCode' => 'Internal.Error', 'errorMessage' => 'Bad Request: Internal Error.', 'description' => '内部错误，请联系客服人员排查'],
+ ['errorCode' => 'NoAuth', 'errorMessage' => 'Bad Request: Workspace.Illegal.Auth.', 'description' => '当前所使用的账号无所指定业务空间的权限'],
+ ['errorCode' => 'NoResourceAuth', 'errorMessage' => 'Bad Request: Resource Auth Error.', 'description' => '没有请求的资源的权限，请确保所请求的资源属于当前参数中的业务空间'],
+ ['errorCode' => 'SystemOperationInProgress', 'errorMessage' => 'Xiyan GBI is learning your previous modifications. Please try again later.', 'description' => '析言GBI正在学习您之前的修改内容，请稍后重试'],
],
],
- 'staticInfo' => [
- 'returnType' => 'synchronous',
+ 'staticInfo' => ['returnType' => 'synchronous'],
+ 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"data\\": \\"{\\\\n \\\\\\"data\\\\\\": {\\\\n \\\\\\"data\\\\\\": [\\\\n {\\\\n \\\\\\"gmtModified\\\\\\": 1734401404000,\\\\n \\\\\\"columns\\\\\\": [\\\\n \\\\\\"test.id\\\\\\",\\\\n \\\\\\"user_info.createdt\\\\\\"\\\\n ],\\\\n \\\\\\"synonymIdKey\\\\\\": \\\\\\"synonyms-AAAAAAAAAVLaD8z63NnFhA\\\\\\",\\\\n \\\\\\"wordSynonyms\\\\\\": [\\\\n \\\\\\"1\\\\\\"\\\\n ],\\\\n \\\\\\"workSpaceId\\\\\\": \\\\\\"10024809\\\\\\",\\\\n \\\\\\"gmtCreate\\\\\\": 1734401404000,\\\\n \\\\\\"word\\\\\\": \\\\\\"1\\\\\\",\\\\n \\\\\\"status\\\\\\": 1\\\\n }\\\\n ],\\\\n \\\\\\"nextToken\\\\\\": \\\\\\"k1BLjEN114wyfrhDHoJlbg==\\\\\\",\\\\n \\\\\\"totalCount\\\\\\": 0\\\\n }\\\\n}\\",\\n \\"errorMsg\\": \\"NoAuth\\",\\n \\"code\\": \\"NoAuth\\",\\n \\"success\\": true,\\n \\"requestId\\": \\"D02D895A-5E58-5A9F-963D-D8B027AB7AE2\\"\\n}","type":"json"}]',
+ 'title' => '同义词列表',
+ 'changeSet' => [],
+ 'flowControl' => [
+ 'flowControlList' => [],
+ ],
+ 'ramActions' => [
+ [
+ 'operationType' => 'none',
+ 'ramAction' => [
+ 'action' => 'dataanalysisgbi:ListSynonyms',
+ 'authLevel' => 'operate',
+ 'actionConditions' => [],
+ 'resources' => [
+ ['validationType' => 'always', 'product' => 'DataAnalysisGBI', 'resourceType' => '全部资源', 'arn' => '*'],
+ ],
+ ],
+ ],
],
- 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"data\\": \\"{\\\\n \\\\\\"data\\\\\\": {\\\\n \\\\\\"data\\\\\\": [\\\\n {\\\\n \\\\\\"tableIdKey\\\\\\": \\\\\\"table-AAAAAAAAFP8AL2bSar8jcQ\\\\\\",\\\\n \\\\\\"workSpaceId\\\\\\": \\\\\\"10026203\\\\\\",\\\\n \\\\\\"description\\\\\\": \\\\\\"存储客户信息的表\\\\\\",\\\\n \\\\\\"foreignKey\\\\\\": \\\\\\"orders.customer_id=customers.customer_id\\\\\\",\\\\n \\\\\\"primaryKey\\\\\\": \\\\\\"customer_id\\\\\\",\\\\n \\\\\\"tableName\\\\\\": \\\\\\"customers\\\\\\"\\\\n },\\\\n {\\\\n \\\\\\"tableIdKey\\\\\\": \\\\\\"table-AAAAAAAAFP8AL2bSar8jcQ\\\\\\",\\\\n \\\\\\"workSpaceId\\\\\\": \\\\\\"10026203\\\\\\",\\\\n \\\\\\"description\\\\\\": \\\\\\"存储订单信息的表\\\\\\",\\\\n \\\\\\"foreignKey\\\\\\": \\\\\\"orders.customer_id=customers.customer_id\\\\\\",\\\\n \\\\\\"primaryKey\\\\\\": \\\\\\"order_id\\\\\\",\\\\n \\\\\\"tableName\\\\\\": \\\\\\"orders\\\\\\"\\\\n },\\\\n {\\\\n \\\\\\"tableIdKey\\\\\\": \\\\\\"table-AAAAAAAAFP8AL2bSar8jcQ\\\\\\",\\\\n \\\\\\"workSpaceId\\\\\\": \\\\\\"10026203\\\\\\",\\\\n \\\\\\"description\\\\\\": \\\\\\"存储产品信息的表\\\\\\",\\\\n \\\\\\"foreignKey\\\\\\": \\\\\\"\\\\\\",\\\\n \\\\\\"primaryKey\\\\\\": \\\\\\"product_id\\\\\\",\\\\n \\\\\\"tableName\\\\\\": \\\\\\"products\\\\\\"\\\\n }\\\\n ],\\\\n \\\\\\"nextToken\\\\\\": \\\\\\"GsLIn+Ur2OowIcLywVF9Vg==\\\\\\",\\\\n \\\\\\"totalCount\\\\\\": 0\\\\n }\\\\n}\\",\\n \\"errorMsg\\": \\"NoAuth\\",\\n \\"code\\": \\"NoAuth\\",\\n \\"success\\": true,\\n \\"requestId\\": \\"FB11F719-9AC8-5C99-AB0A-4709D437FCFC\\"\\n}","type":"json"}]',
- 'title' => '选择的数据表集合',
],
- 'UpdateTableInfo' => [
- 'summary' => '修改当前所指定的数据表的信息。',
- 'path' => '/gbi/update/table',
- 'methods' => [
- 'post',
- ],
- 'schemes' => [
- 'https',
- ],
+ 'ListVirtualDatasourceInstance' => [
+ 'summary' => '获取当前业务空间下的数据源实例列表。',
+ 'path' => '/gbi/virtualDatasource/listVirtualDatasourceInstance',
+ 'methods' => ['post'],
+ 'schemes' => ['https'],
'security' => [
[
'AK' => [],
],
],
- 'consumes' => [
- 'application/json',
- ],
- 'produces' => [
- 'application/json',
- ],
+ 'consumes' => ['application/json'],
+ 'produces' => ['application/json'],
'operationType' => 'read',
'deprecated' => false,
- 'systemTags' => [
- 'operationType' => 'none',
- 'riskType' => 'none',
- 'chargeType' => 'free',
- ],
+ 'systemTags' => ['operationType' => 'none', 'riskType' => 'none', 'chargeType' => 'free'],
'parameters' => [
[
'name' => 'workspaceId',
'in' => 'query',
- 'schema' => [
- 'description' => '当前请求所使用的百炼业务空间id',
- 'type' => 'string',
- 'required' => true,
- 'example' => 'llm-2v3934xtp49esw64'."\n",
- ],
+ 'schema' => ['description' => '当前请求所使用的阿里云百炼业务空间id', 'type' => 'string', 'required' => true, 'example' => 'llm-2v3934xtp49esw64'."\n"],
],
[
'name' => 'body',
@@ -2583,35 +1475,12 @@
'description' => '请求体参数',
'type' => 'object',
'properties' => [
- 'tableIdKey' => [
- 'description' => '数据表的唯一标识符id',
- 'type' => 'string',
- 'required' => true,
- 'example' => 'table-AAAAAAAAFQBwSLJkUj4CYg',
- ],
- 'description' => [
- 'description' => '对数据表的描述',
- 'type' => 'string',
- 'required' => false,
- 'example' => '这是一张用户信息表',
- ],
- 'primaryKey' => [
- 'description' => '主键字段',
- 'type' => 'string',
- 'required' => false,
- 'example' => 'id',
- ],
- 'foreignKeys' => [
- 'description' => '当前这张表的外键关系列表，采用“表名.列名=表名.列名”的形式',
- 'type' => 'array',
- 'items' => [
- 'description' => '具体的一个外键关系',
- 'type' => 'string',
- 'required' => false,
- 'example' => 'user.name=order.username',
- ],
- 'required' => false,
- ],
+ 'nextToken' => ['description' => '分页游标。'."\n"
+ ."\n"
+ .'- 如果是首次调用，该参数不传。'."\n"
+ ."\n"
+ .'- 如果是非首次调用，该参数传上传调用时返回的nextToken。', 'type' => 'string', 'required' => false, 'example' => 'e8Z0nRyY51ZQmYljqGNK'],
+ 'maxResults' => ['description' => '每页最大条目数', 'type' => 'integer', 'format' => 'int32', 'required' => false, 'example' => '100'],
],
'required' => false,
],
@@ -2624,98 +1493,79 @@
'description' => 'Result',
'type' => 'object',
'properties' => [
- 'data' => [
- 'description' => '返回信息',
- 'type' => 'any',
- 'example' => 'true',
- ],
- 'errorMsg' => [
- 'description' => '错误描述信息',
- 'type' => 'string',
- 'example' => 'NoAuth',
- ],
- 'code' => [
- 'description' => '错误码',
- 'type' => 'string',
- 'example' => 'NoAuth',
- ],
- 'success' => [
- 'description' => 'true 接口调用成功，false 接口调用失败',
- 'type' => 'boolean',
- 'example' => 'true',
- ],
- 'requestId' => [
- 'description' => '请求id，每次请求都是唯一值，便于后续排查问题',
- 'type' => 'string',
- 'example' => 'E9563C85-5810-5835-B68C-78580BC3169E',
- ],
+ 'data' => ['description' => '数据列表。', 'type' => 'any', 'example' => '{'."\n"
+ .' "data": ['."\n"
+ .' {'."\n"
+ .' "gmtModified": 1732708238000,'."\n"
+ .' "vdbId": "vdb-0380ee25-2f49-4ee1-8de4-419a16da5904",'."\n"
+ .' "name": "测试创建虚拟数据源实例",'."\n"
+ .' "description": "通过sdk创建的虚拟数据源实例",'."\n"
+ .' "id": 9,'."\n"
+ .' "gmtCreate": 1732708238000,'."\n"
+ .' "workspaceId": "10021406"'."\n"
+ .' }'."\n"
+ .' ],'."\n"
+ .' "nextToken": "jN4HsrkljlksnWgb8u5mWQ\\u003d\\u003d",'."\n"
+ .' "totalCount": 0'."\n"
+ .'}'],
+ 'errorMsg' => ['description' => '错误描述信息。', 'type' => 'string', 'example' => 'NoAuth'],
+ 'code' => ['description' => '错误码', 'type' => 'string', 'example' => 'NoAuth'],
+ 'success' => ['description' => '调用是否成功。'."\n"
+ .'true，表示成功；'."\n"
+ .'false，表示失败。', 'type' => 'boolean', 'example' => 'true'],
+ 'requestId' => ['description' => '请求id，每次请求都是唯一值，便于后续排查问题'."\n"
+ ."\n", 'type' => 'string', 'example' => '45390C6D-016D-5030-BF65-031ED1F65003'],
],
],
],
],
'errorCodes' => [
401 => [
- [
- 'errorCode' => 'Internal.Error',
- 'errorMessage' => 'Bad Request: Internal Error.',
- ],
- [
- 'errorCode' => 'NoAuth',
- 'errorMessage' => 'Bad Request: Workspace.Illegal.Auth.',
- ],
- [
- 'errorCode' => 'NoResourceAuth',
- 'errorMessage' => 'Bad Request: Resource Auth Error.',
- ],
- [
- 'errorCode' => 'SystemOperationInProgress',
- 'errorMessage' => 'Xiyan GBI is learning your previous modifications. Please try again later.',
- ],
+ ['errorCode' => 'NoAuth', 'errorMessage' => 'Bad Request: Workspace.Illegal.Auth.', 'description' => '当前所使用的账号无所指定业务空间的权限'],
+ ['errorCode' => 'Internal.Error', 'errorMessage' => 'Bad Request: Internal Error.', 'description' => '内部错误，请联系客服人员排查'],
],
],
- 'staticInfo' => [
- 'returnType' => 'synchronous',
+ 'staticInfo' => ['returnType' => 'synchronous'],
+ 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"data\\": \\"{\\\\n \\\\\\"data\\\\\\": [\\\\n {\\\\n \\\\\\"gmtModified\\\\\\": 1732708238000,\\\\n \\\\\\"vdbId\\\\\\": \\\\\\"vdb-0380ee25-2f49-4ee1-8de4-419a16da5904\\\\\\",\\\\n \\\\\\"name\\\\\\": \\\\\\"测试创建虚拟数据源实例\\\\\\",\\\\n \\\\\\"description\\\\\\": \\\\\\"通过sdk创建的虚拟数据源实例\\\\\\",\\\\n \\\\\\"id\\\\\\": 9,\\\\n \\\\\\"gmtCreate\\\\\\": 1732708238000,\\\\n \\\\\\"workspaceId\\\\\\": \\\\\\"10021406\\\\\\"\\\\n }\\\\n ],\\\\n \\\\\\"nextToken\\\\\\": \\\\\\"jN4HsrkljlksnWgb8u5mWQ\\\\\\\\u003d\\\\\\\\u003d\\\\\\",\\\\n \\\\\\"totalCount\\\\\\": 0\\\\n}\\",\\n \\"errorMsg\\": \\"NoAuth\\",\\n \\"code\\": \\"NoAuth\\",\\n \\"success\\": true,\\n \\"requestId\\": \\"45390C6D-016D-5030-BF65-031ED1F65003\\"\\n}","type":"json"}]',
+ 'title' => '虚拟数据源实例列表',
+ 'changeSet' => [],
+ 'flowControl' => [
+ 'flowControlList' => [],
+ ],
+ 'ramActions' => [
+ [
+ 'operationType' => 'none',
+ 'ramAction' => [
+ 'action' => 'dataanalysisgbi:ListVirtualDatasourceInstance',
+ 'authLevel' => 'operate',
+ 'actionConditions' => [],
+ 'resources' => [
+ ['validationType' => 'always', 'product' => 'DataAnalysisGBI', 'resourceType' => '全部资源', 'arn' => '*'],
+ ],
+ ],
+ ],
],
- 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"data\\": \\"true\\",\\n \\"errorMsg\\": \\"NoAuth\\",\\n \\"code\\": \\"NoAuth\\",\\n \\"success\\": true,\\n \\"requestId\\": \\"E9563C85-5810-5835-B68C-78580BC3169E\\"\\n}","type":"json"}]',
- 'title' => '修改数据表信息',
],
- 'DeleteSelectedTable' => [
- 'summary' => '将当前指定数据表从指定业务空间管控中删除。',
- 'path' => '/gbi/delete/table',
- 'methods' => [
- 'post',
- ],
- 'schemes' => [
- 'https',
- ],
+ 'RecoverColumn' => [
+ 'summary' => '将指定数据表的数据列恢复到初始化关联时的状态。',
+ 'path' => '/gbi/recover/column',
+ 'methods' => ['post'],
+ 'schemes' => ['https'],
'security' => [
[
'AK' => [],
],
],
- 'consumes' => [
- 'application/json',
- ],
- 'produces' => [
- 'application/json',
- ],
- 'operationType' => 'read',
+ 'consumes' => ['application/json'],
+ 'produces' => ['application/json'],
+ 'operationType' => 'write',
'deprecated' => false,
- 'systemTags' => [
- 'operationType' => 'none',
- 'riskType' => 'none',
- 'chargeType' => 'free',
- ],
+ 'systemTags' => ['operationType' => 'none', 'riskType' => 'none', 'chargeType' => 'free'],
'parameters' => [
[
'name' => 'workspaceId',
'in' => 'query',
- 'schema' => [
- 'description' => '当前请求所使用的阿里云百炼业务空间id',
- 'type' => 'string',
- 'required' => true,
- 'example' => 'llm-2v3934xtp49esw64'."\n",
- ],
+ 'schema' => ['description' => '当前请求所使用的阿里云百炼业务空间id', 'type' => 'string', 'required' => true, 'example' => 'llm-2v3934xtp49esw64'."\n"],
],
[
'name' => 'body',
@@ -2725,12 +1575,8 @@
'description' => '请求体参数',
'type' => 'object',
'properties' => [
- 'tableIdKey' => [
- 'description' => '数据表的唯一标识符id',
- 'type' => 'string',
- 'required' => true,
- 'example' => 'table-AAAAAAAAFQBwSLJkUj4CYg',
- ],
+ 'columnIdKey' => ['description' => '数据列的唯一标识符id', 'type' => 'string', 'required' => true, 'example' => 'column-AAAAAAAAh6cWOUPagYstkg'],
+ 'tableIdKey' => ['description' => '数据表的唯一标识符id', 'type' => 'string', 'required' => true, 'example' => 'table-AAAAAAAAFQBwSLJkUj4CYg'],
],
'required' => false,
],
@@ -2743,98 +1589,64 @@
'description' => 'Result',
'type' => 'object',
'properties' => [
- 'data' => [
- 'description' => '返回信息',
- 'type' => 'any',
- 'example' => 'true',
- ],
- 'errorMsg' => [
- 'description' => '错误描述信息',
- 'type' => 'string',
- 'example' => 'NoAuth',
- ],
- 'code' => [
- 'description' => '错误码',
- 'type' => 'string',
- 'example' => 'NoAuth',
- ],
- 'success' => [
- 'description' => 'true 接口调用成功，false 接口调用失败',
- 'type' => 'boolean',
- 'example' => 'true',
- ],
- 'requestId' => [
- 'description' => '请求id，每次请求都是唯一值，便于后续排查问题',
- 'type' => 'string',
- 'example' => '45390C6D-016D-5030-BF65-031ED1F65003',
- ],
+ 'data' => ['description' => '返回信息', 'type' => 'any', 'example' => 'true'],
+ 'errorMsg' => ['description' => '错误描述信息', 'type' => 'string', 'example' => 'NoAuth'],
+ 'code' => ['description' => '错误码', 'type' => 'string', 'example' => 'NoAuth'],
+ 'success' => ['description' => 'true 接口调用成功，false 接口调用失败', 'type' => 'boolean', 'example' => 'true'],
+ 'requestId' => ['description' => '请求id，每次请求都是唯一值，便于后续排查问题', 'type' => 'string', 'example' => 'FB11F719-9AC8-5C99-AB0A-4709D437FCFC'],
],
],
],
],
'errorCodes' => [
401 => [
- [
- 'errorCode' => 'Internal.Error',
- 'errorMessage' => 'Bad Request: Internal Error.',
- ],
- [
- 'errorCode' => 'NoResourceAuth',
- 'errorMessage' => 'Bad Request: Resource Auth Error.',
- ],
- [
- 'errorCode' => 'NoAuth',
- 'errorMessage' => 'Bad Request: Workspace.Illegal.Auth.',
- ],
- [
- 'errorCode' => 'SystemOperationInProgress',
- 'errorMessage' => 'Xiyan GBI is learning your previous modifications. Please try again later.',
- ],
+ ['errorCode' => 'Internal.Error', 'errorMessage' => 'Bad Request: Internal Error.', 'description' => '内部错误，请联系客服人员排查'],
+ ['errorCode' => 'NoAuth', 'errorMessage' => 'Bad Request: Workspace.Illegal.Auth.', 'description' => '当前所使用的账号无所指定业务空间的权限'],
+ ['errorCode' => 'NoResourceAuth', 'errorMessage' => 'Bad Request: Resource Auth Error.', 'description' => '没有请求的资源的权限，请确保所请求的资源属于当前参数中的业务空间'],
+ ['errorCode' => 'SystemOperationInProgress', 'errorMessage' => 'Xiyan GBI is learning your previous modifications. Please try again later.', 'description' => '析言GBI正在学习您之前的修改内容，请稍后重试'],
],
],
- 'staticInfo' => [
- 'returnType' => 'synchronous',
+ 'staticInfo' => ['returnType' => 'synchronous'],
+ 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"data\\": \\"true\\",\\n \\"errorMsg\\": \\"NoAuth\\",\\n \\"code\\": \\"NoAuth\\",\\n \\"success\\": true,\\n \\"requestId\\": \\"FB11F719-9AC8-5C99-AB0A-4709D437FCFC\\"\\n}","type":"json"}]',
+ 'title' => '还原数据列信息',
+ 'changeSet' => [],
+ 'flowControl' => [
+ 'flowControlList' => [],
+ ],
+ 'ramActions' => [
+ [
+ 'operationType' => 'none',
+ 'ramAction' => [
+ 'action' => 'dataanalysisgbi:RecoverColumn',
+ 'authLevel' => 'operate',
+ 'actionConditions' => [],
+ 'resources' => [
+ ['validationType' => 'always', 'product' => 'DataAnalysisGBI', 'resourceType' => '全部资源', 'arn' => '*'],
+ ],
+ ],
+ ],
],
- 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"data\\": \\"true\\",\\n \\"errorMsg\\": \\"NoAuth\\",\\n \\"code\\": \\"NoAuth\\",\\n \\"success\\": true,\\n \\"requestId\\": \\"45390C6D-016D-5030-BF65-031ED1F65003\\"\\n}","type":"json"}]',
- 'title' => '删除所选择的数据表',
],
'ResyncTable' => [
'summary' => '从远程数据库刷新当前所关联的数据表信息。',
'path' => '/gbi/refresh/table',
- 'methods' => [
- 'post',
- ],
- 'schemes' => [
- 'https',
- ],
+ 'methods' => ['post'],
+ 'schemes' => ['https'],
'security' => [
[
'AK' => [],
],
],
- 'consumes' => [
- 'application/json',
- ],
- 'produces' => [
- 'application/json',
- ],
+ 'consumes' => ['application/json'],
+ 'produces' => ['application/json'],
'operationType' => 'write',
'deprecated' => false,
- 'systemTags' => [
- 'operationType' => 'none',
- 'riskType' => 'none',
- 'chargeType' => 'free',
- ],
+ 'systemTags' => ['operationType' => 'none', 'riskType' => 'none', 'chargeType' => 'free'],
'parameters' => [
[
'name' => 'workspaceId',
'in' => 'query',
- 'schema' => [
- 'description' => '当前请求所使用的阿里云百炼业务空间id',
- 'type' => 'string',
- 'required' => true,
- 'example' => 'llm-2v3934xtp49esw64'."\n",
- ],
+ 'schema' => ['description' => '当前请求所使用的阿里云百炼业务空间id', 'type' => 'string', 'required' => true, 'example' => 'llm-2v3934xtp49esw64'."\n"],
],
[
'name' => 'body',
@@ -2844,19 +1656,10 @@
'description' => '请求体参数',
'type' => 'object',
'properties' => [
- 'tableIdKey' => [
- 'description' => '数据表的唯一标识符id',
- 'type' => 'string',
- 'required' => true,
- 'example' => 'table-AAAAAAAAFQBwSLJkUj4CYg',
- ],
- 'keep' => [
- 'description' => '是否开启\'保留并新增"，true表示开启'."\n"
- ."\n"
- .'> 保留并新增：对于选择“保留并新增"的表，析言将保留已关联列的信息，同时补充未关联列的信息。',
- 'type' => 'boolean',
- 'required' => false,
- ],
+ 'tableIdKey' => ['description' => '数据表的唯一标识符id', 'type' => 'string', 'required' => true, 'example' => 'table-AAAAAAAAFQBwSLJkUj4CYg'],
+ 'keep' => ['description' => '是否开启\'保留并新增"，true表示开启'."\n"
+ ."\n"
+ .'> 保留并新增：对于选择“保留并新增"的表，析言将保留已关联列的信息，同时补充未关联列的信息。', 'type' => 'boolean', 'required' => false],
],
'required' => false,
],
@@ -2869,98 +1672,77 @@
'description' => 'Result',
'type' => 'object',
'properties' => [
- 'data' => [
- 'description' => '返回信息',
- 'type' => 'any',
- 'example' => 'true',
- ],
- 'errorMsg' => [
- 'description' => '错误描述信息',
- 'type' => 'string',
- 'example' => 'NoAuth',
- ],
- 'code' => [
- 'description' => '错误码',
- 'type' => 'string',
- 'example' => 'NoAuth',
- ],
- 'success' => [
- 'description' => 'true 接口调用成功，false 接口调用失败',
- 'type' => 'boolean',
- 'example' => 'true',
- ],
- 'requestId' => [
- 'description' => '请求id，每次请求都是唯一值，便于后续排查问题',
- 'type' => 'string',
- 'example' => 'FB11F719-9AC8-5C99-AB0A-4709D437FCFC',
- ],
+ 'data' => ['description' => '返回信息', 'type' => 'any', 'example' => 'true'],
+ 'errorMsg' => ['description' => '错误描述信息', 'type' => 'string', 'example' => 'NoAuth'],
+ 'code' => ['description' => '错误码', 'type' => 'string', 'example' => 'NoAuth'],
+ 'success' => ['description' => 'true 接口调用成功，false 接口调用失败', 'type' => 'boolean', 'example' => 'true'],
+ 'requestId' => ['description' => '请求id，每次请求都是唯一值，便于后续排查问题', 'type' => 'string', 'example' => 'FB11F719-9AC8-5C99-AB0A-4709D437FCFC'],
],
],
],
],
'errorCodes' => [
401 => [
- [
- 'errorCode' => 'Internal.Error',
- 'errorMessage' => 'Bad Request: Internal Error.',
- ],
- [
- 'errorCode' => 'NoAuth',
- 'errorMessage' => 'Bad Request: Workspace.Illegal.Auth.',
- ],
- [
- 'errorCode' => 'NoResourceAuth',
- 'errorMessage' => 'Bad Request: Resource Auth Error.',
- ],
- [
- 'errorCode' => 'SystemOperationInProgress',
- 'errorMessage' => 'Xiyan GBI is learning your previous modifications. Please try again later.',
- ],
+ ['errorCode' => 'Internal.Error', 'errorMessage' => 'Bad Request: Internal Error.', 'description' => '内部错误，请联系客服人员排查'],
+ ['errorCode' => 'NoAuth', 'errorMessage' => 'Bad Request: Workspace.Illegal.Auth.', 'description' => '当前所使用的账号无所指定业务空间的权限'],
+ ['errorCode' => 'NoResourceAuth', 'errorMessage' => 'Bad Request: Resource Auth Error.', 'description' => '没有请求的资源的权限，请确保所请求的资源属于当前参数中的业务空间'],
+ ['errorCode' => 'SystemOperationInProgress', 'errorMessage' => 'Xiyan GBI is learning your previous modifications. Please try again later.', 'description' => '析言GBI正在学习您之前的修改内容，请稍后重试'],
],
],
- 'staticInfo' => [
- 'returnType' => 'synchronous',
- ],
+ 'staticInfo' => ['returnType' => 'synchronous'],
'responseDemo' => '[{"errorExample":"","example":"{\\n \\"data\\": \\"true\\",\\n \\"errorMsg\\": \\"NoAuth\\",\\n \\"code\\": \\"NoAuth\\",\\n \\"success\\": true,\\n \\"requestId\\": \\"FB11F719-9AC8-5C99-AB0A-4709D437FCFC\\"\\n}","type":"json"}]',
'title' => '刷新当前所关联的数',
- ],
- 'ListColumn' => [
- 'summary' => '获取当前指定业务空间，指定表下面的列信息。',
- 'path' => '/gbi/list/column',
- 'methods' => [
- 'post',
+ 'changeSet' => [
+ ['createdAt' => '2025-01-15T05:55:16.000Z', 'description' => '请求参数发生变更'],
+ ],
+ 'flowControl' => [
+ 'flowControlList' => [],
],
- 'schemes' => [
- 'https',
+ 'ramActions' => [
+ [
+ 'operationType' => 'none',
+ 'ramAction' => [
+ 'action' => 'dataanalysisgbi:ResyncTable',
+ 'authLevel' => 'operate',
+ 'actionConditions' => [],
+ 'resources' => [
+ ['validationType' => 'always', 'product' => 'DataAnalysisGBI', 'resourceType' => '全部资源', 'arn' => '*'],
+ ],
+ ],
+ ],
],
+ ],
+ 'RunDataAnalysis' => [
+ 'summary' => '析言为您提供了与官方页面对话效果相同的OpenAPI接口，只需传入workspaceId以及query等相关信息，即可对您已经创建好的业务空间进行问答和数据分析。'."\n"
+ ."\n"
+ .'该接口适合以下场景：'."\n"
+ .'您在析言控制台关联了数据源，即析言可以通过公网或者VPC的方式访问您的数据库并执行SQL。'."\n"
+ ."\n"
+ .'具体的使用，可以参考以下最佳实践文档：'."\n"
+ .'https://help.aliyun.com/zh/model-studio/gbi-best-practices',
+ 'path' => '/{workspaceId}/gbi/runDataAnalysis',
+ 'methods' => ['post'],
+ 'schemes' => ['https', 'sse'],
'security' => [
[
'AK' => [],
],
],
- 'consumes' => [
- 'application/json',
- ],
- 'produces' => [
- 'application/json',
- ],
+ 'consumes' => [],
'operationType' => 'read',
'deprecated' => false,
'systemTags' => [
'operationType' => 'none',
'riskType' => 'none',
'chargeType' => 'free',
+ 'abilityTreeNodes' => ['FEATUREsfmXG6QUJ'],
+ 'tenantRelevance' => 'tenant',
],
'parameters' => [
[
'name' => 'workspaceId',
- 'in' => 'query',
- 'schema' => [
- 'description' => '当前请求所使用的阿里云百炼业务空间id',
- 'type' => 'string',
- 'required' => true,
- 'example' => 'llm-2v3934xtp49esw64'."\n",
- ],
+ 'in' => 'path',
+ 'schema' => ['description' => '当前请求所使用的阿里云百炼业务空间id', 'type' => 'string', 'required' => true, 'example' => 'llm-2v3934xtp49esw64'."\n"],
],
[
'name' => 'body',
@@ -2970,30 +1752,36 @@
'description' => '请求体参数',
'type' => 'object',
'properties' => [
- 'tableIdKey' => [
- 'description' => '数据表的唯一标识符id',
+ 'specificationType' => [
+ 'description' => '当前请求指定使用的版本信息，不填时使用默认业务空间版本',
'type' => 'string',
- 'required' => true,
- 'example' => 'table-AAAAAAAAFQBwSLJkUj4CYg',
- ],
- 'nextToken' => [
- 'description' => '分页游标。'."\n"
- ."\n"
- .'- 如果是首次调用，该参数不传。'."\n"
- ."\n"
- .'- 如果是非首次调用，该参数传上传调用时返回的nextToken。',
- 'type' => 'integer',
- 'format' => 'int32',
'required' => false,
- 'example' => 'e8Z0nRyY51ZQmYljqGNK',
+ 'enumValueTitles' => ['STANDARD_TURBO' => '标准版turbo', 'STANDARD_MIX' => '标准版mix', 'CUSTOMIZATION' => '定制版turbo'],
+ 'example' => 'STANDARD_MIX',
],
- 'maxResults' => [
- 'description' => '每页最大条目数',
- 'type' => 'integer',
- 'format' => 'int32',
+ 'generateSqlOnly' => ['description' => '当前请求只生成并返回sql，不会执行', 'type' => 'boolean', 'required' => false, 'example' => 'true'],
+ 'query' => ['description' => '用户输入的query', 'type' => 'string', 'required' => true, 'example' => '请问销量前十的产品有哪些'],
+ 'sessionId' => ['description' => '消息会话ID，服务窗回调消息返回的会话ID。', 'type' => 'string', 'required' => false, 'example' => 'sessionID'],
+ 'dataRole' => [
+ 'description' => '数据权限-角色名称的列表'."\n"
+ .'> 数据权限的相关配置内容需要在产品页面进行配置后，方可获取参数在api中调用',
+ 'type' => 'array',
+ 'items' => ['description' => '数据权限-角色名称的具体名字', 'type' => 'string', 'required' => false, 'example' => '管理员'],
'required' => false,
- 'example' => '10',
],
+ 'userParams' => ['description' => '数据角色依赖的自定义参数，当该角色配置了外部参数，必须传入'."\n"
+ .'> 数据权限的相关配置内容需要在产品页面进行配置后，方可获取参数在api中调用', 'type' => 'any', 'required' => false, 'example' => '{'."\n"
+ .' "shopId":['."\n"
+ .' "1",'."\n"
+ .' "2"'."\n"
+ .' ],'."\n"
+ .' "userId":"10001"'."\n"
+ .'}'],
+ 'agentCtrlParams' => ['description' => '当前对话接口所透传的自定义参数，现仅支持：跳过改写、跳过可视化模块、开启对话问题澄清', 'type' => 'any', 'required' => false, 'example' => '{'."\n"
+ .' "withoutRewrite": true,'."\n"
+ .' "withoutVisualization": true,'."\n"
+ .' "enableChatMode": true'."\n"
+ .'}'],
],
'required' => false,
],
@@ -3002,178 +1790,176 @@
'responses' => [
200 => [
'schema' => [
- 'title' => 'Result',
- 'description' => 'Result',
+ 'title' => 'Schema of Response',
+ 'description' => 'Schema of Response',
'type' => 'object',
'properties' => [
'data' => [
'description' => '返回信息',
- 'type' => 'any',
- 'example' => '{'."\n"
- .' "data": {'."\n"
- .' "data": ['."\n"
- .' {'."\n"
- .' "tableIdKey": "table-AAAAAAAAFQBwSLJkUj4CYg",'."\n"
- .' "initializationData": "{\\"description\\":\\"下单客户的ID\\",\\"enumType\\":0,\\"gmtCreate\\":1734059103879,\\"name\\":\\"customer_id\\",\\"samples\\":\\"[]\\",\\"tableId\\":5376,\\"type\\":\\"number\\"}",'."\n"
- .' "enumType": 0,'."\n"
- .' "name": "customer_id",'."\n"
- .' "description": "下单客户的ID",'."\n"
- .' "gmtCreate": 1734059104000,'."\n"
- .' "type": "number",'."\n"
- .' "samples": [],'."\n"
- .' "columnIdKey": "column-AAAAAAAAh6Q9ERazKYFvkA",'."\n"
- .' "enumValues": []'."\n"
- .' },'."\n"
- .' {'."\n"
- .' "tableIdKey": "table-AAAAAAAAFQBwSLJkUj4CYg",'."\n"
- .' "initializationData": "{\\"description\\":\\"下单日期，格式为YYYY-MM-DD\\",\\"enumType\\":0,\\"gmtCreate\\":1734059103913,\\"name\\":\\"order_date\\",\\"samples\\":\\"[]\\",\\"tableId\\":5376,\\"type\\":\\"date\\"}",'."\n"
- .' "enumType": 0,'."\n"
- .' "name": "order_date",'."\n"
- .' "description": "下单日期，格式为YYYY-MM-DD",'."\n"
- .' "gmtCreate": 1734059104000,'."\n"
- .' "type": "date",'."\n"
- .' "samples": [],'."\n"
- .' "columnIdKey": "column-AAAAAAAAh6XbT54v-8NjeA",'."\n"
- .' "enumValues": []'."\n"
- .' },'."\n"
- .' {'."\n"
- .' "tableIdKey": "table-AAAAAAAAFQBwSLJkUj4CYg",'."\n"
- .' "initializationData": "{\\"description\\":\\"订单ID\\",\\"enumType\\":0,\\"gmtCreate\\":1734059103946,\\"name\\":\\"order_id\\",\\"samples\\":\\"[]\\",\\"tableId\\":5376,\\"type\\":\\"number\\"}",'."\n"
- .' "enumType": 0,'."\n"
- .' "name": "order_id",'."\n"
- .' "description": "订单ID",'."\n"
- .' "gmtCreate": 1734059104000,'."\n"
- .' "type": "number",'."\n"
- .' "samples": [],'."\n"
- .' "columnIdKey": "column-AAAAAAAAh6avEvz8bdb30Q",'."\n"
- .' "enumValues": []'."\n"
- .' },'."\n"
- .' {'."\n"
- .' "tableIdKey": "table-AAAAAAAAFQBwSLJkUj4CYg",'."\n"
- .' "initializationData": "{\\"description\\":\\"订单状态（例如：待发货、已发货、已送达）\\",\\"enumType\\":0,\\"gmtCreate\\":1734059103980,\\"name\\":\\"order_status\\",\\"samples\\":\\"[]\\",\\"tableId\\":5376,\\"type\\":\\"text\\"}",'."\n"
- .' "enumType": 0,'."\n"
- .' "name": "order_status",'."\n"
- .' "description": "订单状态（例如：待发货、已发货、已送达）",'."\n"
- .' "gmtCreate": 1734059104000,'."\n"
- .' "type": "text",'."\n"
- .' "samples": [],'."\n"
- .' "columnIdKey": "column-AAAAAAAAh6cWOUPagYstkg",'."\n"
- .' "enumValues": []'."\n"
- .' },'."\n"
- .' {'."\n"
- .' "tableIdKey": "table-AAAAAAAAFQBwSLJkUj4CYg",'."\n"
- .' "initializationData": "{\\"description\\":\\"所订购产品的ID\\",\\"enumType\\":0,\\"gmtCreate\\":1734059104013,\\"name\\":\\"product_id\\",\\"samples\\":\\"[]\\",\\"tableId\\":5376,\\"type\\":\\"number\\"}",'."\n"
- .' "enumType": 0,'."\n"
- .' "name": "product_id",'."\n"
- .' "description": "所订购产品的ID",'."\n"
- .' "gmtCreate": 1734059104000,'."\n"
- .' "type": "number",'."\n"
- .' "samples": [],'."\n"
- .' "columnIdKey": "column-AAAAAAAAh6hFxzroVe3k4Q",'."\n"
- .' "enumValues": []'."\n"
- .' },'."\n"
- .' {'."\n"
- .' "tableIdKey": "table-AAAAAAAAFQBwSLJkUj4CYg",'."\n"
- .' "initializationData": "{\\"description\\":\\"订购产品的数量\\",\\"enumType\\":0,\\"gmtCreate\\":1734059104046,\\"name\\":\\"quantity\\",\\"samples\\":\\"[]\\",\\"tableId\\":5376,\\"type\\":\\"number\\"}",'."\n"
- .' "enumType": 0,'."\n"
- .' "name": "quantity",'."\n"
- .' "description": "订购产品的数量",'."\n"
- .' "gmtCreate": 1734059104000,'."\n"
- .' "type": "number",'."\n"
- .' "samples": [],'."\n"
- .' "columnIdKey": "column-AAAAAAAAh6ncfHPApl0elQ",'."\n"
- .' "enumValues": []'."\n"
- .' }'."\n"
- .' ],'."\n"
- .' "nextToken": "T65g+mLhrbH14+IU/ABI3Q==",'."\n"
- .' "totalCount": 0'."\n"
- .' }'."\n"
- .'}',
- ],
- 'errorMsg' => [
- 'description' => '错误描述信息。',
- 'type' => 'string',
- 'example' => 'NoAuth',
- ],
- 'code' => [
- 'description' => '错误码',
- 'type' => 'string',
- 'example' => 'NoAuth',
- ],
- 'success' => [
- 'description' => 'true 接口调用成功，false 接口调用失败',
- 'type' => 'boolean',
- 'example' => 'true',
- ],
- 'requestId' => [
- 'description' => '请求id，每次请求都是唯一值，便于后续排查问题'."\n"
- ."\n",
- 'type' => 'string',
- 'example' => 'FB11F719-9AC8-5C99-AB0A-4709D437FCFC',
+ 'type' => 'object',
+ 'properties' => [
+ 'errorMessage' => ['description' => '错误信息', 'type' => 'string', 'example' => 'Access was denied, message: No such namespace namespaces/tech-scp-chain7.'],
+ 'event' => [
+ 'description' => '事件类型',
+ 'type' => 'string',
+ 'enumValueTitles' => ['result' => '最终结果事件', 'evidence' => '所用到的辅助模型推理的信息', 'sql_part' => '流式生成sql的中间事件', 'sql_data' => 'sql执行获取到结果的事件', 'selector' => '选表事件', 'refine' => '开启重试时的重试事件', 'rewrite' => '改写事件', 'sql' => '生成sql的最终事件'],
+ 'example' => 'rewrite',
+ ],
+ 'evidence' => ['description' => '所用到的辅助模型推理的信息', 'type' => 'string', 'example' => '今年是2024年'],
+ 'requestId' => ['description' => '当前本次请求的id', 'type' => 'string', 'example' => 'DA2578F7-88A5-5D6E-9305-33E724E97D60'],
+ 'rewrite' => ['description' => '改写后的用户输入', 'type' => 'string', 'example' => '查询全部关键字数据，并以饼图形式展示'],
+ 'selector' => [
+ 'description' => '这次对话，召回了哪些表以用于sql的生成',
+ 'type' => 'array',
+ 'items' => ['description' => '召回的具体的表的名字', 'type' => 'string', 'example' => 'table_name1'],
+ ],
+ 'sessionId' => ['description' => '对话ID', 'type' => 'string', 'example' => 'sessionid1'],
+ 'sql' => ['description' => '当前对话生成的SQL语句', 'type' => 'string', 'example' => 'select p.product_id, p.product_name, sum(o.quantity) as total_sales from products p join orders o on p.product_id = o.product_id where o.order_date between \'2022-10-22\' and \'2024-10-22\' group by p.product_id, p.product_name having total_sales > 5'],
+ 'sqlData' => [
+ 'description' => 'sql执行所返回的结构化内容',
+ 'type' => 'object',
+ 'properties' => [
+ 'column' => [
+ 'description' => 'sql执行结果中，查询的具体的字段名字',
+ 'type' => 'array',
+ 'items' => ['description' => '具体的字段名字内容', 'type' => 'string', 'example' => 'product'],
+ ],
+ 'data' => [
+ 'description' => 'sql执行后获取的结构化数据，可能是多条',
+ 'type' => 'array',
+ 'items' => ['description' => 'sql执行后所查询到的结构化数据的一条内容', 'type' => 'object', 'example' => '{'."\n"
+ .' "product_id": "29",'."\n"
+ .' "total_sales": "63",'."\n"
+ .' "product_name": "1L迷你电热水壶"'."\n"
+ .' }'],
+ ],
+ ],
+ ],
+ 'sqlError' => ['description' => '当任务执行失败时，此字段会报错导致任务失败的原因', 'type' => 'string', 'example' => 'Can not issue data manipulation statements with executeQuery()'],
+ 'visualization' => [
+ 'description' => '用于可视化模块展示所需要的信息',
+ 'type' => 'object',
+ 'properties' => [
+ 'data' => [
+ 'description' => '用于可视化模块展示的结构化信息',
+ 'type' => 'object',
+ 'properties' => [
+ 'plotType' => [
+ 'description' => '可视化图表展示的类型',
+ 'type' => 'string',
+ 'enumValueTitles' => ['bar' => '柱状图', 'line' => '折线图', 'pie' => '饼状图'],
+ 'example' => 'bar',
+ ],
+ 'xAxis' => [
+ 'description' => '可视化图表中x轴的内容',
+ 'type' => 'array',
+ 'items' => ['description' => '具体某一个x轴所展示的字段', 'type' => 'string', 'example' => 'product_name'],
+ ],
+ 'yAxis' => [
+ 'description' => '可视化图表中y轴的内容',
+ 'type' => 'array',
+ 'items' => ['description' => '具体某一个y轴所展示的字段', 'type' => 'string', 'example' => 'total_sales'],
+ ],
+ 'stack' => ['description' => '是否以堆叠的方式展示柱状图。仅当图表类型是柱状图的情况下，该参数才有效', 'type' => 'boolean', 'example' => 'false'],
+ 'option' => ['description' => '初始化前端组件所需要的配置信息。仅当入参agentCtrlParams中chartsFramework=echarts时，该字段才有效', 'type' => 'string', 'example' => '{'."\n"
+ .' xAxis: {'."\n"
+ .' type: \'category\','."\n"
+ .' data: [\'Mon\', \'Tue\', \'Wed\', \'Thu\', \'Fri\', \'Sat\', \'Sun\']'."\n"
+ .' },'."\n"
+ .' yAxis: {'."\n"
+ .' type: \'value\''."\n"
+ .' },'."\n"
+ .' series: ['."\n"
+ .' {'."\n"
+ .' data: [150, 230, 224, 218, 135, 147, 260],'."\n"
+ .' type: \'line\''."\n"
+ .' }'."\n"
+ .' ]'."\n"
+ .'}'],
+ ],
+ ],
+ 'text' => ['description' => '对于sql执行结果的分析总结', 'type' => 'string', 'example' => '查询结果显示，在过去两年中销量超过5的所有产品包括：2L大容量空气炸锅销售了109件，青春版运动手环销售了119件，2L大容量全自动豆浆机销售了106件，无线蓝牙耳机快充版销售了84件，2L大容量便携式榨汁机销售了136件，青春版智能手表销售了104件，挂壁式护眼台灯销售了102件，P30手机8+256G销售了83件，2L大容量电热水壶销售了84件，男士电动化妆刷套装销售了197件，旅行箱销售了82件，手链销售了101件，项链销售了84件，头饰发链销售了89件，腕表销售了98件，戒指销售了157件，真皮皮包销售了136件，风衣大衣销售了76件，运动旅行包销售了91件，丝巾销售了265件，1L迷你空气炸锅销售了85件，豪华款运动手环销售了132件，1L迷你全自动豆浆机销售了81件，豪华版无线蓝牙耳机（绿色）销售了122件，1L迷你便携式榨汁机销售了76件，豪华款智能手表销售了76件，粘贴式护眼台灯销售了109件，M60手机16+512G销售了109件，1L迷你电热水壶销售了63件，女士电动化妆刷套装销售了158件。'],
+ ],
+ ],
+ 'httpStatusCode' => ['description' => '当前某一轮事件透出的http状态码，正常情况下不会额外透出，无需处理', 'type' => 'integer', 'format' => 'int64', 'example' => '200'],
+ 'attempts' => [
+ 'description' => '开启sql校验时会输出的事件类型字段，包含每轮重试生成的sql以及报错原因',
+ 'type' => 'array',
+ 'items' => ['description' => '每伦重试生成的具体sql、具体的报错信息', 'type' => 'any', 'example' => '[{"sql":"SHOW TABLES","sqlError":"sql is invalid"},{"sql":"SHOW TABLES;","sqlError":"sql is invalid"}]'],
+ ],
+ 'chat' => [
+ 'description' => '澄清事件，当用户问题较模糊并开启了需要澄清的开关时产生的事件',
+ 'type' => 'object',
+ 'properties' => [
+ 'text' => ['description' => '澄清话术，模型判断当前用户问题与当前关联数据内容信息不匹配时所产生的反问话术，帮助用户确认问题内容', 'type' => 'string', 'example' => '您想查询的是订单表的创建时间字段嘛？'],
+ ],
+ ],
+ ],
],
+ 'message' => ['description' => '系统错误透出的报错信息，用于报错排查，无需用户处理', 'type' => 'string', 'example' => 'org.springframework.core.task.TaskRejectedException: ExecutorService in active state did not accept task: java.util.concurrent.CompletableFuture$AsyncSupply@25653b3b'],
+ 'code' => ['description' => '系统错误透出的错误码，用于报错排查，无需用户处理', 'type' => 'string', 'example' => 'NoAuth'],
+ 'httpStatusCode' => ['description' => '当前本次请求透出的http状态码，正常情况下不会额外透出，无需处理', 'type' => 'integer', 'format' => 'int64', 'example' => '200'],
],
],
],
],
'errorCodes' => [
401 => [
- [
- 'errorCode' => 'Internal.Error',
- 'errorMessage' => 'Bad Request: Internal Error.',
- ],
- [
- 'errorCode' => 'NoAuth',
- 'errorMessage' => 'Bad Request: Workspace.Illegal.Auth.',
- ],
- [
- 'errorCode' => 'NoResourceAuth',
- 'errorMessage' => 'Bad Request: Resource Auth Error.',
- ],
+ ['errorCode' => 'NoAuth', 'errorMessage' => 'Bad Request: Workspace.Illegal.Auth.', 'description' => '当前所使用的账号无所指定业务空间的权限'],
+ ['errorCode' => 'Internal.Error', 'errorMessage' => 'Bad Request: Internal Error.', 'description' => '内部错误，请联系客服人员排查'],
],
],
- 'staticInfo' => [
- 'returnType' => 'synchronous',
+ 'staticInfo' => ['returnType' => 'synchronous'],
+ 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"data\\": {\\n \\"errorMessage\\": \\"Access was denied, message: No such namespace namespaces/tech-scp-chain7.\\",\\n \\"event\\": \\"rewrite\\",\\n \\"evidence\\": \\"今年是2024年\\",\\n \\"requestId\\": \\"DA2578F7-88A5-5D6E-9305-33E724E97D60\\",\\n \\"rewrite\\": \\"查询全部关键字数据，并以饼图形式展示\\",\\n \\"selector\\": [\\n \\"table_name1\\"\\n ],\\n \\"sessionId\\": \\"sessionid1\\",\\n \\"sql\\": \\"select p.product_id, p.product_name, sum(o.quantity) as total_sales from products p join orders o on p.product_id = o.product_id where o.order_date between \'2022-10-22\' and \'2024-10-22\' group by p.product_id, p.product_name having total_sales > 5\\",\\n \\"sqlData\\": {\\n \\"column\\": [\\n \\"product\\"\\n ],\\n \\"data\\": [\\n {\\n \\"product_id\\": \\"29\\",\\n \\"total_sales\\": \\"63\\",\\n \\"product_name\\": \\"1L迷你电热水壶\\"\\n }\\n ]\\n },\\n \\"sqlError\\": \\"Can not issue data manipulation statements with executeQuery()\\",\\n \\"visualization\\": {\\n \\"data\\": {\\n \\"plotType\\": \\"bar\\",\\n \\"xAxis\\": [\\n \\"product_name\\"\\n ],\\n \\"yAxis\\": [\\n \\"total_sales\\"\\n ],\\n \\"stack\\": false,\\n \\"option\\": \\"{\\\\n xAxis: {\\\\n type: \'category\',\\\\n data: [\'Mon\', \'Tue\', \'Wed\', \'Thu\', \'Fri\', \'Sat\', \'Sun\']\\\\n },\\\\n yAxis: {\\\\n type: \'value\'\\\\n },\\\\n series: [\\\\n {\\\\n data: [150, 230, 224, 218, 135, 147, 260],\\\\n type: \'line\'\\\\n }\\\\n ]\\\\n}\\"\\n },\\n \\"text\\": \\"查询结果显示，在过去两年中销量超过5的所有产品包括：2L大容量空气炸锅销售了109件，青春版运动手环销售了119件，2L大容量全自动豆浆机销售了106件，无线蓝牙耳机快充版销售了84件，2L大容量便携式榨汁机销售了136件，青春版智能手表销售了104件，挂壁式护眼台灯销售了102件，P30手机8+256G销售了83件，2L大容量电热水壶销售了84件，男士电动化妆刷套装销售了197件，旅行箱销售了82件，手链销售了101件，项链销售了84件，头饰发链销售了89件，腕表销售了98件，戒指销售了157件，真皮皮包销售了136件，风衣大衣销售了76件，运动旅行包销售了91件，丝巾销售了265件，1L迷你空气炸锅销售了85件，豪华款运动手环销售了132件，1L迷你全自动豆浆机销售了81件，豪华版无线蓝牙耳机（绿色）销售了122件，1L迷你便携式榨汁机销售了76件，豪华款智能手表销售了76件，粘贴式护眼台灯销售了109件，M60手机16+512G销售了109件，1L迷你电热水壶销售了63件，女士电动化妆刷套装销售了158件。\\"\\n },\\n \\"httpStatusCode\\": 200,\\n \\"attempts\\": [\\n \\"[{\\\\\\"sql\\\\\\":\\\\\\"SHOW TABLES\\\\\\",\\\\\\"sqlError\\\\\\":\\\\\\"sql is invalid\\\\\\"},{\\\\\\"sql\\\\\\":\\\\\\"SHOW TABLES;\\\\\\",\\\\\\"sqlError\\\\\\":\\\\\\"sql is invalid\\\\\\"}]\\"\\n ],\\n \\"chat\\": {\\n \\"text\\": \\"您想查询的是订单表的创建时间字段嘛？\\"\\n }\\n },\\n \\"message\\": \\"org.springframework.core.task.TaskRejectedException: ExecutorService in active state did not accept task: java.util.concurrent.CompletableFuture$AsyncSupply@25653b3b\\",\\n \\"code\\": \\"NoAuth\\",\\n \\"httpStatusCode\\": 200\\n}","type":"json"}]',
+ 'title' => 'Chat对话接口',
+ 'description' => '请确保在使用该接口前，已充分了解析言产品的收费方式和[价格](https://common-buy.aliyun.com/?&msctype=email&mscareaid=cn&mscsiteid=cn&mscmsgid=3800124102101018568&yunge_info=email___3800124102101018568&commodityCode=sfm_DataAnalysisGBI_public_cn)。',
+ 'changeSet' => [
+ ['createdAt' => '2025-03-26T09:57:58.000Z', 'description' => '响应参数发生变更'],
+ ['createdAt' => '2025-03-18T11:56:14.000Z', 'description' => '响应参数发生变更'],
+ ['createdAt' => '2025-03-14T02:33:23.000Z', 'description' => '响应参数发生变更'],
+ ['createdAt' => '2025-02-27T11:47:51.000Z', 'description' => '请求参数发生变更'],
+ ['createdAt' => '2025-02-14T05:58:10.000Z', 'description' => '请求参数发生变更'],
+ ['createdAt' => '2024-12-25T13:21:20.000Z', 'description' => '请求参数发生变更'],
+ ['createdAt' => '2024-12-06T09:38:52.000Z', 'description' => '错误码发生变更'],
+ ['createdAt' => '2024-11-25T12:17:49.000Z', 'description' => '错误码发生变更、响应参数发生变更'],
+ ],
+ 'flowControl' => [
+ 'flowControlList' => [],
+ ],
+ 'ramActions' => [
+ [
+ 'operationType' => 'none',
+ 'ramAction' => [
+ 'action' => 'dataanalysisgbi:RunDataAnalysis',
+ 'authLevel' => 'operate',
+ 'actionConditions' => [],
+ 'resources' => [
+ ['validationType' => 'always', 'product' => 'DataAnalysisGBI', 'resourceType' => '全部资源', 'arn' => '*'],
+ ],
+ ],
+ ],
],
- 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"data\\": \\"{\\\\n \\\\\\"data\\\\\\": {\\\\n \\\\\\"data\\\\\\": [\\\\n {\\\\n \\\\\\"tableIdKey\\\\\\": \\\\\\"table-AAAAAAAAFQBwSLJkUj4CYg\\\\\\",\\\\n \\\\\\"initializationData\\\\\\": \\\\\\"{\\\\\\\\\\\\\\"description\\\\\\\\\\\\\\":\\\\\\\\\\\\\\"下单客户的ID\\\\\\\\\\\\\\",\\\\\\\\\\\\\\"enumType\\\\\\\\\\\\\\":0,\\\\\\\\\\\\\\"gmtCreate\\\\\\\\\\\\\\":1734059103879,\\\\\\\\\\\\\\"name\\\\\\\\\\\\\\":\\\\\\\\\\\\\\"customer_id\\\\\\\\\\\\\\",\\\\\\\\\\\\\\"samples\\\\\\\\\\\\\\":\\\\\\\\\\\\\\"[]\\\\\\\\\\\\\\",\\\\\\\\\\\\\\"tableId\\\\\\\\\\\\\\":5376,\\\\\\\\\\\\\\"type\\\\\\\\\\\\\\":\\\\\\\\\\\\\\"number\\\\\\\\\\\\\\"}\\\\\\",\\\\n \\\\\\"enumType\\\\\\": 0,\\\\n \\\\\\"name\\\\\\": \\\\\\"customer_id\\\\\\",\\\\n \\\\\\"description\\\\\\": \\\\\\"下单客户的ID\\\\\\",\\\\n \\\\\\"gmtCreate\\\\\\": 1734059104000,\\\\n \\\\\\"type\\\\\\": \\\\\\"number\\\\\\",\\\\n \\\\\\"samples\\\\\\": [],\\\\n \\\\\\"columnIdKey\\\\\\": \\\\\\"column-AAAAAAAAh6Q9ERazKYFvkA\\\\\\",\\\\n \\\\\\"enumValues\\\\\\": []\\\\n },\\\\n {\\\\n \\\\\\"tableIdKey\\\\\\": \\\\\\"table-AAAAAAAAFQBwSLJkUj4CYg\\\\\\",\\\\n \\\\\\"initializationData\\\\\\": \\\\\\"{\\\\\\\\\\\\\\"description\\\\\\\\\\\\\\":\\\\\\\\\\\\\\"下单日期，格式为YYYY-MM-DD\\\\\\\\\\\\\\",\\\\\\\\\\\\\\"enumType\\\\\\\\\\\\\\":0,\\\\\\\\\\\\\\"gmtCreate\\\\\\\\\\\\\\":1734059103913,\\\\\\\\\\\\\\"name\\\\\\\\\\\\\\":\\\\\\\\\\\\\\"order_date\\\\\\\\\\\\\\",\\\\\\\\\\\\\\"samples\\\\\\\\\\\\\\":\\\\\\\\\\\\\\"[]\\\\\\\\\\\\\\",\\\\\\\\\\\\\\"tableId\\\\\\\\\\\\\\":5376,\\\\\\\\\\\\\\"type\\\\\\\\\\\\\\":\\\\\\\\\\\\\\"date\\\\\\\\\\\\\\"}\\\\\\",\\\\n \\\\\\"enumType\\\\\\": 0,\\\\n \\\\\\"name\\\\\\": \\\\\\"order_date\\\\\\",\\\\n \\\\\\"description\\\\\\": \\\\\\"下单日期，格式为YYYY-MM-DD\\\\\\",\\\\n \\\\\\"gmtCreate\\\\\\": 1734059104000,\\\\n \\\\\\"type\\\\\\": \\\\\\"date\\\\\\",\\\\n \\\\\\"samples\\\\\\": [],\\\\n \\\\\\"columnIdKey\\\\\\": \\\\\\"column-AAAAAAAAh6XbT54v-8NjeA\\\\\\",\\\\n \\\\\\"enumValues\\\\\\": []\\\\n },\\\\n {\\\\n \\\\\\"tableIdKey\\\\\\": \\\\\\"table-AAAAAAAAFQBwSLJkUj4CYg\\\\\\",\\\\n \\\\\\"initializationData\\\\\\": \\\\\\"{\\\\\\\\\\\\\\"description\\\\\\\\\\\\\\":\\\\\\\\\\\\\\"订单ID\\\\\\\\\\\\\\",\\\\\\\\\\\\\\"enumType\\\\\\\\\\\\\\":0,\\\\\\\\\\\\\\"gmtCreate\\\\\\\\\\\\\\":1734059103946,\\\\\\\\\\\\\\"name\\\\\\\\\\\\\\":\\\\\\\\\\\\\\"order_id\\\\\\\\\\\\\\",\\\\\\\\\\\\\\"samples\\\\\\\\\\\\\\":\\\\\\\\\\\\\\"[]\\\\\\\\\\\\\\",\\\\\\\\\\\\\\"tableId\\\\\\\\\\\\\\":5376,\\\\\\\\\\\\\\"type\\\\\\\\\\\\\\":\\\\\\\\\\\\\\"number\\\\\\\\\\\\\\"}\\\\\\",\\\\n \\\\\\"enumType\\\\\\": 0,\\\\n \\\\\\"name\\\\\\": \\\\\\"order_id\\\\\\",\\\\n \\\\\\"description\\\\\\": \\\\\\"订单ID\\\\\\",\\\\n \\\\\\"gmtCreate\\\\\\": 1734059104000,\\\\n \\\\\\"type\\\\\\": \\\\\\"number\\\\\\",\\\\n \\\\\\"samples\\\\\\": [],\\\\n \\\\\\"columnIdKey\\\\\\": \\\\\\"column-AAAAAAAAh6avEvz8bdb30Q\\\\\\",\\\\n \\\\\\"enumValues\\\\\\": []\\\\n },\\\\n {\\\\n \\\\\\"tableIdKey\\\\\\": \\\\\\"table-AAAAAAAAFQBwSLJkUj4CYg\\\\\\",\\\\n \\\\\\"initializationData\\\\\\": \\\\\\"{\\\\\\\\\\\\\\"description\\\\\\\\\\\\\\":\\\\\\\\\\\\\\"订单状态（例如：待发货、已发货、已送达）\\\\\\\\\\\\\\",\\\\\\\\\\\\\\"enumType\\\\\\\\\\\\\\":0,\\\\\\\\\\\\\\"gmtCreate\\\\\\\\\\\\\\":1734059103980,\\\\\\\\\\\\\\"name\\\\\\\\\\\\\\":\\\\\\\\\\\\\\"order_status\\\\\\\\\\\\\\",\\\\\\\\\\\\\\"samples\\\\\\\\\\\\\\":\\\\\\\\\\\\\\"[]\\\\\\\\\\\\\\",\\\\\\\\\\\\\\"tableId\\\\\\\\\\\\\\":5376,\\\\\\\\\\\\\\"type\\\\\\\\\\\\\\":\\\\\\\\\\\\\\"text\\\\\\\\\\\\\\"}\\\\\\",\\\\n \\\\\\"enumType\\\\\\": 0,\\\\n \\\\\\"name\\\\\\": \\\\\\"order_status\\\\\\",\\\\n \\\\\\"description\\\\\\": \\\\\\"订单状态（例如：待发货、已发货、已送达）\\\\\\",\\\\n \\\\\\"gmtCreate\\\\\\": 1734059104000,\\\\n \\\\\\"type\\\\\\": \\\\\\"text\\\\\\",\\\\n \\\\\\"samples\\\\\\": [],\\\\n \\\\\\"columnIdKey\\\\\\": \\\\\\"column-AAAAAAAAh6cWOUPagYstkg\\\\\\",\\\\n \\\\\\"enumValues\\\\\\": []\\\\n },\\\\n {\\\\n \\\\\\"tableIdKey\\\\\\": \\\\\\"table-AAAAAAAAFQBwSLJkUj4CYg\\\\\\",\\\\n \\\\\\"initializationData\\\\\\": \\\\\\"{\\\\\\\\\\\\\\"description\\\\\\\\\\\\\\":\\\\\\\\\\\\\\"所订购产品的ID\\\\\\\\\\\\\\",\\\\\\\\\\\\\\"enumType\\\\\\\\\\\\\\":0,\\\\\\\\\\\\\\"gmtCreate\\\\\\\\\\\\\\":1734059104013,\\\\\\\\\\\\\\"name\\\\\\\\\\\\\\":\\\\\\\\\\\\\\"product_id\\\\\\\\\\\\\\",\\\\\\\\\\\\\\"samples\\\\\\\\\\\\\\":\\\\\\\\\\\\\\"[]\\\\\\\\\\\\\\",\\\\\\\\\\\\\\"tableId\\\\\\\\\\\\\\":5376,\\\\\\\\\\\\\\"type\\\\\\\\\\\\\\":\\\\\\\\\\\\\\"number\\\\\\\\\\\\\\"}\\\\\\",\\\\n \\\\\\"enumType\\\\\\": 0,\\\\n \\\\\\"name\\\\\\": \\\\\\"product_id\\\\\\",\\\\n \\\\\\"description\\\\\\": \\\\\\"所订购产品的ID\\\\\\",\\\\n \\\\\\"gmtCreate\\\\\\": 1734059104000,\\\\n \\\\\\"type\\\\\\": \\\\\\"number\\\\\\",\\\\n \\\\\\"samples\\\\\\": [],\\\\n \\\\\\"columnIdKey\\\\\\": \\\\\\"column-AAAAAAAAh6hFxzroVe3k4Q\\\\\\",\\\\n \\\\\\"enumValues\\\\\\": []\\\\n },\\\\n {\\\\n \\\\\\"tableIdKey\\\\\\": \\\\\\"table-AAAAAAAAFQBwSLJkUj4CYg\\\\\\",\\\\n \\\\\\"initializationData\\\\\\": \\\\\\"{\\\\\\\\\\\\\\"description\\\\\\\\\\\\\\":\\\\\\\\\\\\\\"订购产品的数量\\\\\\\\\\\\\\",\\\\\\\\\\\\\\"enumType\\\\\\\\\\\\\\":0,\\\\\\\\\\\\\\"gmtCreate\\\\\\\\\\\\\\":1734059104046,\\\\\\\\\\\\\\"name\\\\\\\\\\\\\\":\\\\\\\\\\\\\\"quantity\\\\\\\\\\\\\\",\\\\\\\\\\\\\\"samples\\\\\\\\\\\\\\":\\\\\\\\\\\\\\"[]\\\\\\\\\\\\\\",\\\\\\\\\\\\\\"tableId\\\\\\\\\\\\\\":5376,\\\\\\\\\\\\\\"type\\\\\\\\\\\\\\":\\\\\\\\\\\\\\"number\\\\\\\\\\\\\\"}\\\\\\",\\\\n \\\\\\"enumType\\\\\\": 0,\\\\n \\\\\\"name\\\\\\": \\\\\\"quantity\\\\\\",\\\\n \\\\\\"description\\\\\\": \\\\\\"订购产品的数量\\\\\\",\\\\n \\\\\\"gmtCreate\\\\\\": 1734059104000,\\\\n \\\\\\"type\\\\\\": \\\\\\"number\\\\\\",\\\\n \\\\\\"samples\\\\\\": [],\\\\n \\\\\\"columnIdKey\\\\\\": \\\\\\"column-AAAAAAAAh6ncfHPApl0elQ\\\\\\",\\\\n \\\\\\"enumValues\\\\\\": []\\\\n }\\\\n ],\\\\n \\\\\\"nextToken\\\\\\": \\\\\\"T65g+mLhrbH14+IU/ABI3Q==\\\\\\",\\\\n \\\\\\"totalCount\\\\\\": 0\\\\n }\\\\n}\\",\\n \\"errorMsg\\": \\"NoAuth\\",\\n \\"code\\": \\"NoAuth\\",\\n \\"success\\": true,\\n \\"requestId\\": \\"FB11F719-9AC8-5C99-AB0A-4709D437FCFC\\"\\n}","type":"json"}]',
- 'title' => '数据表下的数据列集合',
],
- 'UpdateColumn' => [
- 'summary' => '修改当前指定业务空间中，指定列的信息。',
- 'path' => '/gbi/update/column',
- 'methods' => [
- 'post',
- ],
- 'schemes' => [
- 'https',
- ],
+ 'RunDataResultAnalysis' => [
+ 'summary' => '对结构化数据类型的执行结果进行分析、可视化信息生成。',
+ 'path' => '/gbi/runDataResultAnalysis',
+ 'methods' => ['post'],
+ 'schemes' => ['https', 'sse'],
'security' => [
[
'AK' => [],
],
],
- 'consumes' => [
- 'application/json',
- ],
- 'produces' => [
- 'application/json',
- ],
- 'operationType' => 'write',
+ 'consumes' => ['application/json'],
+ 'produces' => ['application/json'],
+ 'operationType' => 'read',
'deprecated' => false,
- 'systemTags' => [
- 'operationType' => 'none',
- 'riskType' => 'none',
- 'chargeType' => 'free',
- ],
+ 'systemTags' => ['operationType' => 'none', 'riskType' => 'none', 'chargeType' => 'free', 'tenantRelevance' => 'tenant'],
'parameters' => [
[
'name' => 'workspaceId',
'in' => 'query',
- 'schema' => [
- 'description' => '当前请求所使用的阿里云百炼业务空间id',
- 'type' => 'string',
- 'required' => true,
- 'example' => 'llm-2v3934xtp49esw64'."\n",
- ],
+ 'schema' => ['description' => '当前请求所使用的阿里云百炼业务空间id', 'type' => 'string', 'required' => true, 'example' => 'llm-2v3934xtp49esw64'."\n"],
],
[
'name' => 'body',
@@ -3183,77 +1969,77 @@
'description' => '请求体参数',
'type' => 'object',
'properties' => [
- 'columnIdKey' => [
- 'description' => '数据列的唯一标识符id',
- 'type' => 'string',
- 'required' => true,
- 'example' => 'column-AAAAAAAAh6cWOUPagYstkg',
- ],
- 'tableIdKey' => [
- 'description' => '数据表的唯一标识符id',
- 'type' => 'string',
- 'required' => true,
- 'example' => 'table-AAAAAAAAFQBwSLJkUj4CYg',
- ],
- 'chineseName' => [
- 'description' => '数据列的中文名字',
- 'type' => 'string',
- 'required' => false,
- 'example' => '学生姓名',
- ],
- 'description' => [
- 'description' => '数据列的描述',
- 'type' => 'string',
- 'required' => false,
- 'example' => '这个列用于表示学生的姓名',
- ],
- 'enumType' => [
- 'description' => '当前字段是否为枚举类型，是枚举值类型的基础下，可以补充enumValues字段来进行枚举值的补充',
- 'type' => 'integer',
- 'format' => 'int32',
- 'required' => true,
- 'enumValueTitles' => [
- '非枚举值类型',
- '是枚举值类型',
- ],
- 'example' => '1',
- ],
- 'enumValues' => [
- 'description' => '枚举值列表',
- 'type' => 'array',
- 'items' => [
- 'description' => '枚举值',
- 'type' => 'string',
- 'required' => false,
- 'example' => '北京',
- ],
- 'required' => false,
- ],
- 'samples' => [
- 'description' => '数据样例列表，在关联数据表时若选择允许拉取数据样例，这个字段会自行进行补充',
- 'type' => 'array',
- 'items' => [
- 'description' => '数据样例内容',
- 'type' => 'string',
- 'required' => false,
- 'example' => '上海',
+ 'sqlData' => [
+ 'description' => 'sql执行后所查询到的结构化数据内容，当前情况下此参数必传'."\n"
+ .'<details>'."\n"
+ .'<summary>sqlData示例子</summary>'."\n"
+ .'{'."\n"
+ .' "column": ['."\n"
+ .' "month",'."\n"
+ .' "total_received"'."\n"
+ .' ],'."\n"
+ .' "data": ['."\n"
+ .' {'."\n"
+ .' "month": "2024-01",'."\n"
+ .' "total_received": "603"'."\n"
+ .' },'."\n"
+ .' {'."\n"
+ .' "month": "2024-02",'."\n"
+ .' "total_received": "749"'."\n"
+ .' },'."\n"
+ .' {'."\n"
+ .' "month": "2024-03",'."\n"
+ .' "total_received": "1311"'."\n"
+ .' },'."\n"
+ .' {'."\n"
+ .' "month": "2024-04",'."\n"
+ .' "total_received": "1003"'."\n"
+ .' },'."\n"
+ .' {'."\n"
+ .' "month": "2024-05",'."\n"
+ .' "total_received": "726"'."\n"
+ .' },'."\n"
+ .' {'."\n"
+ .' "month": "2024-06",'."\n"
+ .' "total_received": "791"'."\n"
+ .' },'."\n"
+ .' {'."\n"
+ .' "month": "2024-07",'."\n"
+ .' "total_received": "60"'."\n"
+ .' }'."\n"
+ .' ]'."\n"
+ .'}'."\n"
+ .'</details>',
+ 'type' => 'object',
+ 'properties' => [
+ 'column' => [
+ 'description' => 'SQL执行结果中，查询到的具体的字段名字列表',
+ 'type' => 'array',
+ 'items' => ['description' => 'SQL执行结果中，查询到的具体的列名', 'type' => 'string', 'required' => false, 'example' => 'month'],
+ 'required' => false,
+ ],
+ 'data' => [
+ 'description' => '与SQL执行结果中的列名对应的结构化信息列表，详细结构可参考上方sqlData的示例',
+ 'type' => 'array',
+ 'items' => [
+ 'description' => '与SQL执行结果中的列名对应的结构化信息，每一个代表着一行数据，其中的字段与表头列表应该为一一对应的关系',
+ 'type' => 'object',
+ 'required' => false,
+ 'additionalProperties' => ['type' => 'string', 'description' => '当前列名所对应的一条数据的具体内容', 'example' => '2024-01'],
+ ],
+ 'required' => false,
+ ],
],
'required' => false,
],
- 'rangeMin' => [
- 'description' => '数字类型数据取值范围，最小值',
- 'type' => 'integer',
- 'format' => 'int64',
- 'required' => false,
- 'example' => '0',
- ],
- 'rangeMax' => [
- 'description' => '数字类型数据取值范围，最大值',
- 'type' => 'integer',
- 'format' => 'int64',
+ 'analysisMode' => [
+ 'description' => '当前希望执行的可视化类型，可以只生成图表或只生成文本分析',
+ 'type' => 'string',
'required' => false,
- 'example' => '2000',
+ 'enumValueTitles' => ['all' => '生成图表和文字分析', 'text' => '只生成文字分析', 'chart' => '只生成图表'],
+ 'example' => 'all',
],
+ 'requestId' => ['description' => '请求id，这里的请求id为RunSqlGeneration接口中执行返回的requestId，若传入未被RunSqlGeneration执行过的requestId，执行会被拒绝', 'type' => 'string', 'required' => true, 'example' => 'FF76AD3F-8B32-567E-819B-0D3738917006'],
],
'required' => false,
],
@@ -3262,34 +2048,49 @@
'responses' => [
200 => [
'schema' => [
- 'title' => 'Result',
- 'description' => 'Result',
+ 'title' => 'SseEmitter',
+ 'description' => 'Schema of Response',
'type' => 'object',
'properties' => [
'data' => [
- 'description' => '返回信息',
- 'type' => 'any',
- 'example' => 'true',
- ],
- 'errorMsg' => [
- 'description' => '错误信息',
- 'type' => 'string',
- 'example' => 'NoAuth',
- ],
- 'code' => [
- 'description' => '错误码',
- 'type' => 'string',
- 'example' => 'NoAuth',
- ],
- 'success' => [
- 'description' => 'true 接口调用成功，false 接口调用失败',
- 'type' => 'boolean',
- 'example' => 'true',
- ],
- 'requestId' => [
- 'description' => '请求id，每次请求都是唯一值，便于后续排查问题',
- 'type' => 'string',
- 'example' => '45390C6D-016D-5030-BF65-031ED1F65003',
+ 'description' => '返回结果',
+ 'type' => 'object',
+ 'properties' => [
+ 'errorMessage' => ['description' => '错误信息', 'type' => 'string', 'example' => 'Access was denied, message: No such namespace namespaces/tech-scp-chain7.'],
+ 'event' => [
+ 'description' => '事件类型',
+ 'type' => 'string',
+ 'enumValueTitles' => ['result' => '结果事件'],
+ 'example' => 'result',
+ ],
+ 'requestId' => ['description' => '当前本次请求的id', 'type' => 'string', 'example' => 'DA2578F7-88A5-5D6E-9305-33E724E97D60'],
+ 'visualization' => [
+ 'description' => '用于可视化模块展示所需要的信息',
+ 'type' => 'object',
+ 'properties' => [
+ 'data' => [
+ 'description' => '数据列表',
+ 'type' => 'object',
+ 'properties' => [
+ 'plotType' => ['description' => '可视化图表展示的类型', 'type' => 'string', 'example' => 'bar'],
+ 'xAxis' => [
+ 'description' => '具体某一个x轴所展示的字段列表',
+ 'type' => 'array',
+ 'items' => ['description' => '具体某一个x轴所展示的字段', 'type' => 'string', 'example' => 'product_name'],
+ ],
+ 'yAxis' => [
+ 'description' => '具体某一个y轴所展示的字段列表',
+ 'type' => 'array',
+ 'items' => ['description' => '具体某一个y轴所展示的字段', 'type' => 'string', 'example' => 'total_sales'],
+ ],
+ ],
+ ],
+ 'text' => ['description' => '对于sql执行结果的分析总结', 'type' => 'string', 'example' => '查询结果显示，在过去两年中销量超过5的所有产品包括：2L大容量空气炸锅销售了109件，青春版运动手环销售了119件，2L大容量全自动豆浆机销售了106件，无线蓝牙耳机快充版销售了84件，2L大容量便携式榨汁机销售了136件，青春版智能手表销售了104件，挂壁式护眼台灯销售了102件，P30手机8+256G销售了83件，2L大容量电热水壶销售了84件，男士电动化妆刷套装销售了197件，旅行箱销售了82件，手链销售了101件，项链销售了84件，头饰发链销售了89件，腕表销售了98件，戒指销售了157件，真皮皮包销售了136件，风衣大衣销售了76件，运动旅行包销售了91件，丝巾销售了265件，1L迷你空气炸锅销售了85件，豪华款运动手环销售了132件，1L迷你全自动豆浆机销售了81件，豪华版无线蓝牙耳机（绿色）销售了122件，1L迷你便携式榨汁机销售了76件，豪华款智能手表销售了76件，粘贴式护眼台灯销售了109件，M60手机16+512G销售了109件，1L迷你电热水壶销售了63件，女士电动化妆刷套装销售了158件。'],
+ ],
+ ],
+ 'sql' => ['description' => '当前对话生成的SQL语句', 'type' => 'string', 'example' => 'select p.product_id, p.product_name, sum(o.quantity) as total_sales from products p join orders o on p.product_id = o.product_id where o.order_date between \'2022-10-22\' and \'2024-10-22\' group by p.product_id, p.product_name having total_sales > 5'],
+ 'rewrite' => ['description' => '改写后的用户输入', 'type' => 'string', 'example' => '过去两年中，销量超过5的产品有哪些'],
+ ],
],
],
],
@@ -3297,67 +2098,62 @@
],
'errorCodes' => [
401 => [
- [
- 'errorCode' => 'Internal.Error',
- 'errorMessage' => 'Bad Request: Internal Error.',
- ],
- [
- 'errorCode' => 'NoAuth',
- 'errorMessage' => 'Bad Request: Workspace.Illegal.Auth.',
- ],
- [
- 'errorCode' => 'NoResourceAuth',
- 'errorMessage' => 'Bad Request: Resource Auth Error.',
- ],
- [
- 'errorCode' => 'SystemOperationInProgress',
- 'errorMessage' => 'Xiyan GBI is learning your previous modifications. Please try again later.',
- ],
+ ['errorCode' => 'Internal.Error', 'errorMessage' => 'Bad Request: Internal Error.', 'description' => '内部错误，请联系客服人员排查'],
+ ['errorCode' => 'NoAuth', 'errorMessage' => 'Bad Request: Workspace.Illegal.Auth.', 'description' => '当前所使用的账号无所指定业务空间的权限'],
+ ['errorCode' => 'NoResourceAuth', 'errorMessage' => 'Bad Request: Resource Auth Error.', 'description' => '没有请求的资源的权限，请确保所请求的资源属于当前参数中的业务空间'],
+ ['errorCode' => 'Invalid.RequestId', 'errorMessage' => 'Bad Request: Invalid RequestId.', 'description' => 'requestId错误或已过期'],
],
],
- 'staticInfo' => [
- 'returnType' => 'synchronous',
+ 'staticInfo' => ['returnType' => 'synchronous'],
+ 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"data\\": {\\n \\"errorMessage\\": \\"Access was denied, message: No such namespace namespaces/tech-scp-chain7.\\",\\n \\"event\\": \\"result\\",\\n \\"requestId\\": \\"DA2578F7-88A5-5D6E-9305-33E724E97D60\\",\\n \\"visualization\\": {\\n \\"data\\": {\\n \\"plotType\\": \\"bar\\",\\n \\"xAxis\\": [\\n \\"product_name\\"\\n ],\\n \\"yAxis\\": [\\n \\"total_sales\\"\\n ]\\n },\\n \\"text\\": \\"查询结果显示，在过去两年中销量超过5的所有产品包括：2L大容量空气炸锅销售了109件，青春版运动手环销售了119件，2L大容量全自动豆浆机销售了106件，无线蓝牙耳机快充版销售了84件，2L大容量便携式榨汁机销售了136件，青春版智能手表销售了104件，挂壁式护眼台灯销售了102件，P30手机8+256G销售了83件，2L大容量电热水壶销售了84件，男士电动化妆刷套装销售了197件，旅行箱销售了82件，手链销售了101件，项链销售了84件，头饰发链销售了89件，腕表销售了98件，戒指销售了157件，真皮皮包销售了136件，风衣大衣销售了76件，运动旅行包销售了91件，丝巾销售了265件，1L迷你空气炸锅销售了85件，豪华款运动手环销售了132件，1L迷你全自动豆浆机销售了81件，豪华版无线蓝牙耳机（绿色）销售了122件，1L迷你便携式榨汁机销售了76件，豪华款智能手表销售了76件，粘贴式护眼台灯销售了109件，M60手机16+512G销售了109件，1L迷你电热水壶销售了63件，女士电动化妆刷套装销售了158件。\\"\\n },\\n \\"sql\\": \\"select p.product_id, p.product_name, sum(o.quantity) as total_sales from products p join orders o on p.product_id = o.product_id where o.order_date between \'2022-10-22\' and \'2024-10-22\' group by p.product_id, p.product_name having total_sales > 5\\",\\n \\"rewrite\\": \\"过去两年中，销量超过5的产品有哪些\\"\\n }\\n}","type":"json"}]',
+ 'title' => '执行结果分析',
+ 'changeSet' => [
+ ['createdAt' => '2025-02-25T11:35:15.000Z', 'description' => '错误码发生变更'],
],
- 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"data\\": \\"true\\",\\n \\"errorMsg\\": \\"NoAuth\\",\\n \\"code\\": \\"NoAuth\\",\\n \\"success\\": true,\\n \\"requestId\\": \\"45390C6D-016D-5030-BF65-031ED1F65003\\"\\n}","type":"json"}]',
- 'title' => '修改数据列信息',
- ],
- 'RecoverColumn' => [
- 'summary' => '将指定数据表的数据列恢复到初始化关联时的状态。',
- 'path' => '/gbi/recover/column',
- 'methods' => [
- 'post',
+ 'flowControl' => [
+ 'flowControlList' => [],
],
- 'schemes' => [
- 'https',
+ 'ramActions' => [
+ [
+ 'operationType' => 'none',
+ 'ramAction' => [
+ 'action' => 'dataanalysisgbi:RunDataResultAnalysis',
+ 'authLevel' => 'operate',
+ 'actionConditions' => [],
+ 'resources' => [
+ ['validationType' => 'always', 'product' => 'DataAnalysisGBI', 'resourceType' => '全部资源', 'arn' => '*'],
+ ],
+ ],
+ ],
],
+ ],
+ 'RunSqlGeneration' => [
+ 'summary' => '运行sql生成，根据当前的query信息，结合已关联的数据表，进行sql语句的生成。'."\n"
+ ."\n"
+ .'该接口适合以下场景：'."\n"
+ .'您的数据库在本地，不能被析言访问。'."\n"
+ .'您可以通过析言关联虚拟数据源，调用该接口生成SQL，然后自行解析和执行SQL。'."\n"
+ ."\n"
+ .'具体的使用，可以参考以下最佳实践文档：'."\n"
+ .'https://help.aliyun.com/zh/model-studio/xiyan-gbi-local-data-best-practices',
+ 'path' => '/gbi/runSqlGeneration',
+ 'methods' => ['post'],
+ 'schemes' => ['https', 'sse'],
'security' => [
[
'AK' => [],
],
],
- 'consumes' => [
- 'application/json',
- ],
- 'produces' => [
- 'application/json',
- ],
- 'operationType' => 'write',
+ 'consumes' => ['application/json'],
+ 'produces' => ['application/json'],
+ 'operationType' => 'read',
'deprecated' => false,
- 'systemTags' => [
- 'operationType' => 'none',
- 'riskType' => 'none',
- 'chargeType' => 'free',
- ],
+ 'systemTags' => ['operationType' => 'none', 'riskType' => 'none', 'chargeType' => 'free', 'tenantRelevance' => 'tenant'],
'parameters' => [
[
'name' => 'workspaceId',
'in' => 'query',
- 'schema' => [
- 'description' => '当前请求所使用的阿里云百炼业务空间id',
- 'type' => 'string',
- 'required' => true,
- 'example' => 'llm-2v3934xtp49esw64'."\n",
- ],
+ 'schema' => ['description' => '当前请求所使用的阿里云百炼业务空间id', 'type' => 'string', 'required' => true, 'example' => 'llm-2v3934xtp49esw64'."\n"],
],
[
'name' => 'body',
@@ -3367,18 +2163,15 @@
'description' => '请求体参数',
'type' => 'object',
'properties' => [
- 'columnIdKey' => [
- 'description' => '数据列的唯一标识符id',
- 'type' => 'string',
- 'required' => true,
- 'example' => 'column-AAAAAAAAh6cWOUPagYstkg',
- ],
- 'tableIdKey' => [
- 'description' => '数据表的唯一标识符id',
+ 'specificationType' => [
+ 'description' => '当前请求指定使用的版本信息，不填时使用默认业务空间版本',
'type' => 'string',
- 'required' => true,
- 'example' => 'table-AAAAAAAAFQBwSLJkUj4CYg',
+ 'required' => false,
+ 'enumValueTitles' => ['STANDARD_TURBO' => '标准版turbo', 'STANDARD_MIX' => '标准版mix', 'CUSTOMIZATION' => '定制版turbo'],
+ 'example' => 'STANDARD_MIX',
],
+ 'query' => ['description' => '用户输入的query', 'type' => 'string', 'required' => true, 'example' => '请问销量前十的产品有哪些'],
+ 'sessionId' => ['description' => '消息会话ID，多条requestId可以属于同一个会话sessionId', 'type' => 'string', 'required' => false, 'example' => 'd5eced84-fd25-43ee-a245-adb4e4a8c3be'],
],
'required' => false,
],
@@ -3387,34 +2180,40 @@
'responses' => [
200 => [
'schema' => [
- 'title' => 'Result',
- 'description' => 'Result',
+ 'title' => 'SseEmitter',
+ 'description' => 'SseEmitter',
'type' => 'object',
'properties' => [
'data' => [
'description' => '返回信息',
- 'type' => 'any',
- 'example' => 'true',
- ],
- 'errorMsg' => [
- 'description' => '错误描述信息',
- 'type' => 'string',
- 'example' => 'NoAuth',
- ],
- 'code' => [
- 'description' => '错误码',
- 'type' => 'string',
- 'example' => 'NoAuth',
- ],
- 'success' => [
- 'description' => 'true 接口调用成功，false 接口调用失败',
- 'type' => 'boolean',
- 'example' => 'true',
- ],
- 'requestId' => [
- 'description' => '请求id，每次请求都是唯一值，便于后续排查问题',
- 'type' => 'string',
- 'example' => 'FB11F719-9AC8-5C99-AB0A-4709D437FCFC',
+ 'type' => 'object',
+ 'properties' => [
+ 'errorMessage' => ['description' => '错误信息', 'type' => 'string', 'example' => 'Access was denied, message: No such namespace namespaces/tech-scp-chain7.'],
+ 'event' => [
+ 'description' => '事件类型',
+ 'type' => 'string',
+ 'enumValueTitles' => ['evidence' => '所用到的辅助模型推理的信息', 'sql_part' => '流式生成sql的中间事件', 'selector' => '选表事件', 'rewrite' => '改写事件', 'sql' => '生成sql的最终事件'],
+ 'example' => 'sql',
+ ],
+ 'evidence' => ['description' => '所用到的辅助模型推理的信息', 'type' => 'string', 'example' => '今年是2024年'],
+ 'requestId' => ['description' => '当前本次请求的id', 'type' => 'string', 'example' => 'DA2578F7-88A5-5D6E-9305-33E724E97D60'],
+ 'rewrite' => ['description' => '改写后的用户输入', 'type' => 'string', 'example' => '查询全部关键字数据，并以饼图形式展示'],
+ 'selector' => [
+ 'description' => '召回的具体的表的名字列表',
+ 'type' => 'array',
+ 'items' => ['description' => '召回的具体的表的名字', 'type' => 'string', 'example' => 'table_name1'],
+ ],
+ 'sessionId' => ['description' => '对话ID', 'type' => 'string', 'example' => 'f64c38dd-a235-4bb4-ae6c-79eaedcba699'],
+ 'sql' => ['description' => '当前对话生成的SQL语句', 'type' => 'string', 'example' => 'select p.product_id, p.product_name, sum(o.quantity) as total_sales from products p join orders o on p.product_id = o.product_id where o.order_date between \'2022-10-22\' and \'2024-10-22\' group by p.product_id, p.product_name having total_sales > 5'],
+ 'sqlError' => ['description' => '当任务执行失败时，此字段会报错导致任务失败的原因', 'type' => 'string', 'example' => 'Can not issue data manipulation statements with executeQuery()'],
+ 'chat' => [
+ 'type' => 'object',
+ 'properties' => [
+ 'text' => ['type' => 'string', 'description' => ''],
+ ],
+ 'description' => '',
+ ],
+ ],
],
],
],
@@ -3422,67 +2221,55 @@
],
'errorCodes' => [
401 => [
- [
- 'errorCode' => 'Internal.Error',
- 'errorMessage' => 'Bad Request: Internal Error.',
- ],
- [
- 'errorCode' => 'NoAuth',
- 'errorMessage' => 'Bad Request: Workspace.Illegal.Auth.',
- ],
- [
- 'errorCode' => 'NoResourceAuth',
- 'errorMessage' => 'Bad Request: Resource Auth Error.',
- ],
- [
- 'errorCode' => 'SystemOperationInProgress',
- 'errorMessage' => 'Xiyan GBI is learning your previous modifications. Please try again later.',
- ],
+ ['errorCode' => 'Internal.Error', 'errorMessage' => 'Bad Request: Internal Error.', 'description' => '内部错误，请联系客服人员排查'],
+ ['errorCode' => 'NoAuth', 'errorMessage' => 'Bad Request: Workspace.Illegal.Auth.', 'description' => '当前所使用的账号无所指定业务空间的权限'],
+ ['errorCode' => 'NoResourceAuth', 'errorMessage' => 'Bad Request: Resource Auth Error.', 'description' => '没有请求的资源的权限，请确保所请求的资源属于当前参数中的业务空间'],
+ ['errorCode' => 'SystemOperationInProgress', 'errorMessage' => 'Xiyan GBI is learning your previous modifications. Please try again later.', 'description' => '析言GBI正在学习您之前的修改内容，请稍后重试'],
],
],
- 'staticInfo' => [
- 'returnType' => 'synchronous',
+ 'staticInfo' => ['returnType' => 'synchronous'],
+ 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"data\\": {\\n \\"errorMessage\\": \\"Access was denied, message: No such namespace namespaces/tech-scp-chain7.\\",\\n \\"event\\": \\"sql\\",\\n \\"evidence\\": \\"今年是2024年\\",\\n \\"requestId\\": \\"DA2578F7-88A5-5D6E-9305-33E724E97D60\\",\\n \\"rewrite\\": \\"查询全部关键字数据，并以饼图形式展示\\",\\n \\"selector\\": [\\n \\"table_name1\\"\\n ],\\n \\"sessionId\\": \\"f64c38dd-a235-4bb4-ae6c-79eaedcba699\\",\\n \\"sql\\": \\"select p.product_id, p.product_name, sum(o.quantity) as total_sales from products p join orders o on p.product_id = o.product_id where o.order_date between \'2022-10-22\' and \'2024-10-22\' group by p.product_id, p.product_name having total_sales > 5\\",\\n \\"sqlError\\": \\"Can not issue data manipulation statements with executeQuery()\\",\\n \\"chat\\": {\\n \\"text\\": \\"\\"\\n }\\n }\\n}","type":"json"}]',
+ 'title' => '运行sql生成',
+ 'changeSet' => [
+ ['createdAt' => '2025-03-26T09:57:58.000Z', 'description' => '响应参数发生变更'],
],
- 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"data\\": \\"true\\",\\n \\"errorMsg\\": \\"NoAuth\\",\\n \\"code\\": \\"NoAuth\\",\\n \\"success\\": true,\\n \\"requestId\\": \\"FB11F719-9AC8-5C99-AB0A-4709D437FCFC\\"\\n}","type":"json"}]',
- 'title' => '还原数据列信息',
- ],
- 'DeleteColumn' => [
- 'summary' => '从当前所指定的业务空间中，删除所指定的列。',
- 'path' => '/gbi/delete/column',
- 'methods' => [
- 'post',
+ 'flowControl' => [
+ 'flowControlList' => [],
],
- 'schemes' => [
- 'https',
+ 'ramActions' => [
+ [
+ 'operationType' => 'none',
+ 'ramAction' => [
+ 'action' => 'dataanalysisgbi:RunSqlGeneration',
+ 'authLevel' => 'operate',
+ 'actionConditions' => [],
+ 'resources' => [
+ ['validationType' => 'always', 'product' => 'DataAnalysisGBI', 'resourceType' => '全部资源', 'arn' => '*'],
+ ],
+ ],
+ ],
],
+ ],
+ 'SaveVirtualDatasourceDdl' => [
+ 'summary' => '向您当前指定的业务空间下指定的虚拟数据源实例中添加ddl语句，析言GBI云服务会将您的ddl语句解析成相关的表结构信息并进行维护。',
+ 'path' => '/gbi/virtualDatasource/addDdl2VirtualInstance',
+ 'methods' => ['post'],
+ 'schemes' => ['https'],
'security' => [
[
'AK' => [],
],
],
- 'consumes' => [
- 'application/json',
- ],
- 'produces' => [
- 'application/json',
- ],
+ 'consumes' => ['application/json'],
+ 'produces' => ['application/json'],
'operationType' => 'write',
'deprecated' => false,
- 'systemTags' => [
- 'operationType' => 'none',
- 'riskType' => 'none',
- 'chargeType' => 'free',
- ],
+ 'systemTags' => ['operationType' => 'none', 'riskType' => 'none', 'chargeType' => 'free'],
'parameters' => [
[
'name' => 'workspaceId',
'in' => 'query',
- 'schema' => [
- 'description' => '当前请求所使用的阿里云百炼业务空间id',
- 'type' => 'string',
- 'required' => true,
- 'example' => 'llm-2v3934xtp49esw64'."\n",
- ],
+ 'schema' => ['description' => '当前请求所使用的阿里云百炼业务空间id', 'type' => 'string', 'required' => true, 'example' => 'llm-2v3934xtp49esw64'."\n"],
],
[
'name' => 'body',
@@ -3492,12 +2279,8 @@
'description' => '请求体参数',
'type' => 'object',
'properties' => [
- 'columnIdKey' => [
- 'description' => '想要删除的数据列的唯一标识符id',
- 'type' => 'string',
- 'required' => true,
- 'example' => 'column-AAAAAAAAh6Q9ERazKYFvkA',
- ],
+ 'vdbId' => ['description' => '虚拟数据源实例id', 'type' => 'string', 'required' => true, 'example' => 'vdb-E0F693C8-9F72-5830-B81A-696C9D8EBBD1'."\n"],
+ 'ddl' => ['description' => 'create类型数据库ddl语句，支持传入多条，多条之间请用换行符分割（“\\n”）。', 'type' => 'string', 'required' => true, 'example' => 'CREATE TABLE user (id int NOT NULL AUTO_INCREMENT comment \'ID\',name varchar(10) NOT NULL comment \'姓名\', dept_id int NOT NULL comment \'部门ID\', salary bigint NULL DEFAULT 0 comment \'薪水\', PRIMARY KEY (`id`), KEY `idx_name` (`name`), KEY `d_id` (`dept_id`), CONSTRAINT `d_id` FOREIGN KEY (`dept_id`) REFERENCES `department` (`id`)) COMMENT=\'This is my table\' ENGINE=InnoDB AUTO_INCREMENT=20094 DEFAULT CHARSET=utf8 ;'],
],
'required' => false,
],
@@ -3510,98 +2293,63 @@
'description' => 'Result',
'type' => 'object',
'properties' => [
- 'data' => [
- 'description' => '返回信息',
- 'type' => 'any',
- 'example' => 'true',
- ],
- 'errorMsg' => [
- 'description' => '错误描述信息',
- 'type' => 'string',
- 'example' => 'NoAuth',
- ],
- 'code' => [
- 'description' => '错误码',
- 'type' => 'string',
- 'example' => 'NoAuth',
- ],
- 'success' => [
- 'description' => 'true 接口调用成功，false 接口调用失败',
- 'type' => 'boolean',
- 'example' => 'true',
- ],
- 'requestId' => [
- 'description' => '请求id，每次请求都是唯一值，便于后续排查问题',
- 'type' => 'string',
- 'example' => 'D02D895A-5E58-5A9F-963D-D8B027AB7AE2',
- ],
+ 'data' => ['description' => '返回信息', 'type' => 'any', 'example' => 'true'],
+ 'errorMsg' => ['description' => '错误描述信息', 'type' => 'string', 'example' => 'NoAuth'],
+ 'code' => ['description' => '错误码', 'type' => 'string', 'example' => 'NoAuth'],
+ 'success' => ['description' => 'true 接口调用成功，false 接口调用失败', 'type' => 'boolean', 'example' => 'true'],
+ 'requestId' => ['description' => '请求id，每次请求都是唯一值，便于后续排查问题'."\n"
+ ."\n", 'type' => 'string', 'example' => '72ABCA5B-1E93-55D3-8A61-6D8A03CC5C8B'],
],
],
],
],
'errorCodes' => [
401 => [
- [
- 'errorCode' => 'Internal.Error',
- 'errorMessage' => 'Bad Request: Internal Error.',
- ],
- [
- 'errorCode' => 'NoAuth',
- 'errorMessage' => 'Bad Request: Workspace.Illegal.Auth.',
- ],
- [
- 'errorCode' => 'NoResourceAuth',
- 'errorMessage' => 'Bad Request: Resource Auth Error.',
- ],
- [
- 'errorCode' => 'SystemOperationInProgress',
- 'errorMessage' => 'Xiyan GBI is learning your previous modifications. Please try again later.',
- ],
+ ['errorCode' => 'NoAuth', 'errorMessage' => 'Bad Request: Workspace.Illegal.Auth.', 'description' => '当前所使用的账号无所指定业务空间的权限'],
+ ['errorCode' => 'Internal.Error', 'errorMessage' => 'Bad Request: Internal Error.', 'description' => '内部错误，请联系客服人员排查'],
],
],
- 'staticInfo' => [
- 'returnType' => 'synchronous',
+ 'staticInfo' => ['returnType' => 'synchronous'],
+ 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"data\\": \\"true\\",\\n \\"errorMsg\\": \\"NoAuth\\",\\n \\"code\\": \\"NoAuth\\",\\n \\"success\\": true,\\n \\"requestId\\": \\"72ABCA5B-1E93-55D3-8A61-6D8A03CC5C8B\\"\\n}","type":"json"}]',
+ 'title' => '向虚拟数据源中添加ddl语句',
+ 'changeSet' => [],
+ 'flowControl' => [
+ 'flowControlList' => [],
+ ],
+ 'ramActions' => [
+ [
+ 'operationType' => 'none',
+ 'ramAction' => [
+ 'action' => 'dataanalysisgbi:SaveVirtualDatasourceDdl',
+ 'authLevel' => 'operate',
+ 'actionConditions' => [],
+ 'resources' => [
+ ['validationType' => 'always', 'product' => 'DataAnalysisGBI', 'resourceType' => '全部资源', 'arn' => '*'],
+ ],
+ ],
+ ],
],
- 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"data\\": \\"true\\",\\n \\"errorMsg\\": \\"NoAuth\\",\\n \\"code\\": \\"NoAuth\\",\\n \\"success\\": true,\\n \\"requestId\\": \\"D02D895A-5E58-5A9F-963D-D8B027AB7AE2\\"\\n}","type":"json"}]',
- 'title' => '删除数据表中的列',
],
- 'ListEnumMapping' => [
- 'summary' => '获取当前业务空间，指定表、列下的枚举值。',
- 'path' => '/gbi/list/mapping',
- 'methods' => [
- 'post',
- ],
- 'schemes' => [
- 'https',
- ],
+ 'SyncRemoteTables' => [
+ 'summary' => '更新当前业务空间所关联的数据表，从远程数据源（虚拟数据源）同步最近的表并关联到您所指定的业务空间。',
+ 'path' => '/gbi/update/datasource/tables',
+ 'methods' => ['post'],
+ 'schemes' => ['https'],
'security' => [
[
'AK' => [],
],
],
- 'consumes' => [
- 'application/json',
- ],
- 'produces' => [
- 'application/json',
- ],
- 'operationType' => 'read',
+ 'consumes' => ['application/json'],
+ 'produces' => ['application/json'],
+ 'operationType' => 'write',
'deprecated' => false,
- 'systemTags' => [
- 'operationType' => 'none',
- 'riskType' => 'none',
- 'chargeType' => 'free',
- ],
+ 'systemTags' => ['operationType' => 'none', 'riskType' => 'none', 'chargeType' => 'free'],
'parameters' => [
[
'name' => 'workspaceId',
'in' => 'query',
- 'schema' => [
- 'description' => '当前请求所使用的阿里云百炼业务空间id',
- 'type' => 'string',
- 'required' => true,
- 'example' => 'llm-2v3934xtp49esw64'."\n",
- ],
+ 'schema' => ['description' => '当前请求所使用的阿里云百炼业务空间id', 'type' => 'string', 'required' => true, 'example' => 'llm-2v3934xtp49esw64'."\n"],
],
[
'name' => 'body',
@@ -3611,17 +2359,28 @@
'description' => '请求体参数',
'type' => 'object',
'properties' => [
- 'tableIdKey' => [
- 'description' => '数据表的唯一标识符id',
- 'type' => 'string',
+ 'tableNames' => [
+ 'description' => '需要关联的数据表的名称列表',
+ 'type' => 'array',
+ 'items' => ['description' => '数据表名称', 'type' => 'string', 'required' => false, 'example' => 'user'],
'required' => true,
- 'example' => 'table-AAAAAAAAFQBwSLJkUj4CYg',
],
- 'columnIdKey' => [
- 'description' => '数据列的唯一标识符id',
- 'type' => 'string',
- 'required' => true,
- 'example' => 'column-AAAAAAAAh6cWOUPagYstkg',
+ 'pullSamples' => ['description' => '关联数据表时是否拉取数据样例', 'type' => 'boolean', 'required' => false, 'example' => 'true'],
+ 'keepTableNames' => [
+ 'description' => '关联数据表时，需要执行"保留并新增"操作的数据表名称列表。'."\n"
+ ."\n"
+ .'> 保留并新增：对于选择“保留并新增"的表，析言将保留已关联列的信息，同时补充未关联列的信息。',
+ 'type' => 'array',
+ 'items' => ['description' => '数据表名称', 'type' => 'string', 'required' => false, 'example' => 'order'],
+ 'required' => false,
+ ],
+ 'noModifiedTableNames' => [
+ 'description' => '关联数据表时，需要"保留并跳过"的数据表名称列表。'."\n"
+ ."\n"
+ .'> 保留并跳过：对于选择"保留并跳过"的表，析言将保留所有已关联列的信息，同时不补充任何未关联列的信息。',
+ 'type' => 'array',
+ 'items' => ['description' => '数据表名称', 'type' => 'string', 'required' => false, 'example' => 'user'],
+ 'required' => false,
],
],
'required' => false,
@@ -3635,103 +2394,64 @@
'description' => 'Result',
'type' => 'object',
'properties' => [
- 'data' => [
- 'description' => '返回信息',
- 'type' => 'any',
- 'example' => '{'."\n"
- .' "data": {'."\n"
- .' "数码产品": [],'."\n"
- .' "箱包配饰": []'."\n"
- .' }'."\n"
- .'}',
- ],
- 'errorMsg' => [
- 'description' => '错误描述信息。',
- 'type' => 'string',
- 'example' => 'NoAuth',
- ],
- 'code' => [
- 'description' => '错误码。',
- 'type' => 'string',
- 'example' => 'NoAuth',
- ],
- 'success' => [
- 'description' => 'true 接口调用成功，false 接口调用失败',
- 'type' => 'boolean',
- 'example' => 'true',
- ],
- 'requestId' => [
- 'description' => '请求id，每次请求都是唯一值，便于后续排查问题',
- 'type' => 'string',
- 'example' => 'FB11F719-9AC8-5C99-AB0A-4709D437FCFC',
- ],
+ 'data' => ['description' => '返回信息', 'type' => 'any', 'example' => 'true'],
+ 'errorMsg' => ['description' => '错误描述信息', 'type' => 'string', 'example' => 'NoAuth'],
+ 'code' => ['description' => '错误码', 'type' => 'string', 'example' => 'NoAuth'],
+ 'success' => ['description' => 'true 接口调用成功，false 接口调用失败', 'type' => 'boolean', 'example' => 'true'],
+ 'requestId' => ['description' => '请求id，每次请求都是唯一值，便于后续排查问题', 'type' => 'string', 'example' => 'E9563C85-5810-5835-B68C-78580BC3169E'],
],
],
],
],
'errorCodes' => [
401 => [
- [
- 'errorCode' => 'Internal.Error',
- 'errorMessage' => 'Bad Request: Internal Error.',
- ],
- [
- 'errorCode' => 'NoAuth',
- 'errorMessage' => 'Bad Request: Workspace.Illegal.Auth.',
- ],
- [
- 'errorCode' => 'NoResourceAuth',
- 'errorMessage' => 'Bad Request: Resource Auth Error.',
- ],
- [
- 'errorCode' => 'SystemOperationInProgress',
- 'errorMessage' => 'Xiyan GBI is learning your previous modifications. Please try again later.',
- ],
+ ['errorCode' => 'NoAuth', 'errorMessage' => 'Bad Request: Workspace.Illegal.Auth.', 'description' => '当前所使用的账号无所指定业务空间的权限'],
+ ['errorCode' => 'Internal.Error', 'errorMessage' => 'Bad Request: Internal Error.', 'description' => '内部错误，请联系客服人员排查'],
],
],
- 'staticInfo' => [
- 'returnType' => 'synchronous',
+ 'staticInfo' => ['returnType' => 'synchronous'],
+ 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"data\\": \\"true\\",\\n \\"errorMsg\\": \\"NoAuth\\",\\n \\"code\\": \\"NoAuth\\",\\n \\"success\\": true,\\n \\"requestId\\": \\"E9563C85-5810-5835-B68C-78580BC3169E\\"\\n}","type":"json"}]',
+ 'title' => '从数据源同步数据表',
+ 'changeSet' => [
+ ['createdAt' => '2025-01-15T05:55:16.000Z', 'description' => '请求参数发生变更'],
],
- 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"data\\": \\"{\\\\n \\\\\\"data\\\\\\": {\\\\n \\\\\\"数码产品\\\\\\": [],\\\\n \\\\\\"箱包配饰\\\\\\": []\\\\n }\\\\n}\\",\\n \\"errorMsg\\": \\"NoAuth\\",\\n \\"code\\": \\"NoAuth\\",\\n \\"success\\": true,\\n \\"requestId\\": \\"FB11F719-9AC8-5C99-AB0A-4709D437FCFC\\"\\n}","type":"json"}]',
- 'title' => '枚举值映射列表',
- ],
- 'UpdateEnumMapping' => [
- 'summary' => '修改当前指定业务空间指定列下的枚举值信息。',
- 'path' => '/gbi/update/mapping',
- 'methods' => [
- 'post',
+ 'flowControl' => [
+ 'flowControlList' => [],
],
- 'schemes' => [
- 'https',
+ 'ramActions' => [
+ [
+ 'operationType' => 'none',
+ 'ramAction' => [
+ 'action' => 'dataanalysisgbi:SyncRemoteTables',
+ 'authLevel' => 'operate',
+ 'actionConditions' => [],
+ 'resources' => [
+ ['validationType' => 'always', 'product' => 'DataAnalysisGBI', 'resourceType' => '全部资源', 'arn' => '*'],
+ ],
+ ],
+ ],
],
+ ],
+ 'UpdateBusinessLogic' => [
+ 'summary' => '修改当前指定业务空间下所指定的业务逻辑解释。',
+ 'path' => '/gbi/update/logic',
+ 'methods' => ['post'],
+ 'schemes' => ['https'],
'security' => [
[
'AK' => [],
],
],
- 'consumes' => [
- 'application/json',
- ],
- 'produces' => [
- 'application/json',
- ],
+ 'consumes' => ['application/json'],
+ 'produces' => ['application/json'],
'operationType' => 'write',
'deprecated' => false,
- 'systemTags' => [
- 'operationType' => 'none',
- 'riskType' => 'none',
- 'chargeType' => 'free',
- ],
+ 'systemTags' => ['operationType' => 'none', 'riskType' => 'none', 'chargeType' => 'free'],
'parameters' => [
[
'name' => 'workspaceId',
'in' => 'query',
- 'schema' => [
- 'description' => '当前请求所使用的阿里云百炼业务空间id',
- 'type' => 'string',
- 'required' => true,
- 'example' => 'llm-2v3934xtp49esw64'."\n",
- ],
+ 'schema' => ['description' => '当前请求所使用的阿里云百炼业务空间id', 'type' => 'string', 'required' => true, 'example' => 'llm-2v3934xtp49esw64'."\n"],
],
[
'name' => 'body',
@@ -3741,31 +2461,15 @@
'description' => '请求体参数',
'type' => 'object',
'properties' => [
- 'tableIdKey' => [
- 'description' => '数据表的唯一标识符id',
- 'type' => 'string',
- 'required' => true,
- 'example' => 'table-AAAAAAAAFQBwSLJkUj4CYg',
- ],
- 'columnIdKey' => [
- 'description' => '数据列的唯一标识符id',
- 'type' => 'string',
+ 'businessLogicIdKey' => ['description' => '业务逻辑解释的唯一标识符id', 'type' => 'string', 'required' => true, 'example' => 'businessLogic-AAAAAAAAAGAIyJoP7LbKuA'],
+ 'description' => ['description' => '业务逻辑解释的内容', 'type' => 'string', 'required' => true, 'example' => '冬季指的是10月到去年三月'],
+ 'type' => [
+ 'description' => '业务逻辑解释的类型',
+ 'type' => 'integer',
+ 'format' => 'int64',
'required' => true,
- 'example' => 'column-AAAAAAAAh6cWOUPagYstkg',
- ],
- 'enumMapping' => [
- 'description' => '枚举值映射',
- 'type' => 'object',
- 'required' => false,
- 'additionalProperties' => [
- 'type' => 'array',
- 'items' => [
- 'type' => 'string',
- 'example' => '上海',
- 'description' => '枚举值映射的具体内容',
- ],
- 'description' => '一个枚举值映射的内容列表',
- ],
+ 'enumValueTitles' => ['全局', '系统智能判断'],
+ 'example' => '0',
],
],
'required' => false,
@@ -3779,98 +2483,64 @@
'description' => 'Result',
'type' => 'object',
'properties' => [
- 'data' => [
- 'description' => '返回信息',
- 'type' => 'any',
- 'example' => 'true',
- ],
- 'errorMsg' => [
- 'description' => '错误描述信息',
- 'type' => 'string',
- 'example' => 'NoAuth',
- ],
- 'code' => [
- 'description' => '错误码',
- 'type' => 'string',
- 'example' => 'NoAuth',
- ],
- 'success' => [
- 'description' => 'true 接口调用成功，false 接口调用失败',
- 'type' => 'boolean',
- 'example' => 'true',
- ],
- 'requestId' => [
- 'description' => '请求id，每次请求都是唯一值，便于后续排查问题',
- 'type' => 'string',
- 'example' => 'FB11F719-9AC8-5C99-AB0A-4709D437FCFC',
- ],
+ 'data' => ['description' => '返回信息', 'type' => 'any', 'example' => 'true'],
+ 'errorMsg' => ['description' => '错误描述信息', 'type' => 'string', 'example' => 'NoAuth'],
+ 'code' => ['description' => '错误码', 'type' => 'string', 'example' => 'NoAuth'],
+ 'success' => ['description' => 'true 接口调用成功，false 接口调用失败', 'type' => 'boolean', 'example' => 'true'],
+ 'requestId' => ['description' => '请求id，每次请求都是唯一值，便于后续排查问题', 'type' => 'string', 'example' => 'FB11F719-9AC8-5C99-AB0A-4709D437FCFC'],
],
],
],
],
'errorCodes' => [
401 => [
- [
- 'errorCode' => 'Internal.Error',
- 'errorMessage' => 'Bad Request: Internal Error.',
- ],
- [
- 'errorCode' => 'NoAuth',
- 'errorMessage' => 'Bad Request: Workspace.Illegal.Auth.',
- ],
- [
- 'errorCode' => 'NoResourceAuth',
- 'errorMessage' => 'Bad Request: Resource Auth Error.',
- ],
- [
- 'errorCode' => 'SystemOperationInProgress',
- 'errorMessage' => 'Xiyan GBI is learning your previous modifications. Please try again later.',
- ],
+ ['errorCode' => 'Internal.Error', 'errorMessage' => 'Bad Request: Internal Error.', 'description' => '内部错误，请联系客服人员排查'],
+ ['errorCode' => 'NoAuth', 'errorMessage' => 'Bad Request: Workspace.Illegal.Auth.', 'description' => '当前所使用的账号无所指定业务空间的权限'],
+ ['errorCode' => 'NoResourceAuth', 'errorMessage' => 'Bad Request: Resource Auth Error.', 'description' => '没有请求的资源的权限，请确保所请求的资源属于当前参数中的业务空间'],
+ ['errorCode' => 'SystemOperationInProgress', 'errorMessage' => 'Xiyan GBI is learning your previous modifications. Please try again later.', 'description' => '析言GBI正在学习您之前的修改内容，请稍后重试'],
],
],
- 'staticInfo' => [
- 'returnType' => 'synchronous',
- ],
+ 'staticInfo' => ['returnType' => 'synchronous'],
'responseDemo' => '[{"errorExample":"","example":"{\\n \\"data\\": \\"true\\",\\n \\"errorMsg\\": \\"NoAuth\\",\\n \\"code\\": \\"NoAuth\\",\\n \\"success\\": true,\\n \\"requestId\\": \\"FB11F719-9AC8-5C99-AB0A-4709D437FCFC\\"\\n}","type":"json"}]',
- 'title' => '修改枚举值映射关系',
- ],
- 'CreateVirtualDatasourceInstance' => [
- 'summary' => '在您指定的业务空间创建虚拟数据源实例，虚拟数据源实例代表着一个虚拟的数据库，可以向虚拟数据源中添加ddl语句，来完成您构建虚拟数据库，数据表的能力。',
- 'path' => '/gbi/virtualDatasource/createVirtualDatasourceInstance',
- 'methods' => [
- 'post',
- ],
- 'schemes' => [
- 'https',
+ 'title' => '修改业务逻辑解释',
+ 'changeSet' => [],
+ 'flowControl' => [
+ 'flowControlList' => [],
+ ],
+ 'ramActions' => [
+ [
+ 'operationType' => 'none',
+ 'ramAction' => [
+ 'action' => 'dataanalysisgbi:UpdateBusinessLogic',
+ 'authLevel' => 'operate',
+ 'actionConditions' => [],
+ 'resources' => [
+ ['validationType' => 'always', 'product' => 'DataAnalysisGBI', 'resourceType' => '全部资源', 'arn' => '*'],
+ ],
+ ],
+ ],
],
+ ],
+ 'UpdateColumn' => [
+ 'summary' => '修改当前指定业务空间中，指定列的信息。',
+ 'path' => '/gbi/update/column',
+ 'methods' => ['post'],
+ 'schemes' => ['https'],
'security' => [
[
'AK' => [],
],
],
- 'consumes' => [
- 'application/json',
- ],
- 'produces' => [
- 'application/json',
- ],
+ 'consumes' => ['application/json'],
+ 'produces' => ['application/json'],
'operationType' => 'write',
'deprecated' => false,
- 'systemTags' => [
- 'operationType' => 'none',
- 'riskType' => 'none',
- 'chargeType' => 'free',
- ],
+ 'systemTags' => ['operationType' => 'none', 'riskType' => 'none', 'chargeType' => 'free'],
'parameters' => [
[
'name' => 'workspaceId',
'in' => 'query',
- 'schema' => [
- 'description' => '当前请求所使用的阿里云百炼业务空间id',
- 'type' => 'string',
- 'required' => true,
- 'example' => 'llm-2v3934xtp49esw64'."\n",
- ],
+ 'schema' => ['description' => '当前请求所使用的阿里云百炼业务空间id', 'type' => 'string', 'required' => true, 'example' => 'llm-2v3934xtp49esw64'."\n"],
],
[
'name' => 'body',
@@ -3880,29 +2550,32 @@
'description' => '请求体参数',
'type' => 'object',
'properties' => [
- 'name' => [
- 'description' => '虚拟数据源实例的名字',
- 'type' => 'string',
- 'required' => false,
- 'example' => 'virtual-instance-1',
+ 'columnIdKey' => ['description' => '数据列的唯一标识符id', 'type' => 'string', 'required' => true, 'example' => 'column-AAAAAAAAh6cWOUPagYstkg'],
+ 'tableIdKey' => ['description' => '数据表的唯一标识符id', 'type' => 'string', 'required' => true, 'example' => 'table-AAAAAAAAFQBwSLJkUj4CYg'],
+ 'chineseName' => ['description' => '数据列的中文名字', 'type' => 'string', 'required' => false, 'example' => '学生姓名'],
+ 'description' => ['description' => '数据列的描述', 'type' => 'string', 'required' => false, 'example' => '这个列用于表示学生的姓名'],
+ 'enumType' => [
+ 'description' => '当前字段是否为枚举类型，是枚举值类型的基础下，可以补充enumValues字段来进行枚举值的补充',
+ 'type' => 'integer',
+ 'format' => 'int32',
+ 'required' => true,
+ 'enumValueTitles' => ['非枚举值类型', '是枚举值类型'],
+ 'example' => '1',
],
- 'description' => [
- 'description' => '虚拟数据源实例的描述',
- 'type' => 'string',
+ 'enumValues' => [
+ 'description' => '枚举值列表',
+ 'type' => 'array',
+ 'items' => ['description' => '枚举值', 'type' => 'string', 'required' => false, 'example' => '北京'],
'required' => false,
- 'example' => '虚拟数据源实例的描述',
],
- 'type' => [
- 'description' => '当前虚拟数据源的类型',
- 'type' => 'integer',
- 'format' => 'int32',
+ 'samples' => [
+ 'description' => '数据样例列表，在关联数据表时若选择允许拉取数据样例，这个字段会自行进行补充',
+ 'type' => 'array',
+ 'items' => ['description' => '数据样例内容', 'type' => 'string', 'required' => false, 'example' => '上海'],
'required' => false,
- 'enumValueTitles' => [
- 51 => 'mysql类型虚拟数据源',
- 'postgresql类型虚拟数据源',
- ],
- 'example' => '51',
],
+ 'rangeMin' => ['description' => '数字类型数据取值范围，最小值', 'type' => 'integer', 'format' => 'int64', 'required' => false, 'example' => '0'],
+ 'rangeMax' => ['description' => '数字类型数据取值范围，最大值', 'type' => 'integer', 'format' => 'int64', 'required' => false, 'example' => '2000'],
],
'required' => false,
],
@@ -3915,90 +2588,64 @@
'description' => 'Result',
'type' => 'object',
'properties' => [
- 'data' => [
- 'description' => '响应数据。即成功与否。',
- 'type' => 'any',
- 'example' => 'true',
- ],
- 'errorMsg' => [
- 'description' => '错误信息',
- 'type' => 'string',
- 'example' => 'NoAuth',
- ],
- 'code' => [
- 'description' => '错误码。',
- 'type' => 'string',
- 'example' => 'NoAuth',
- ],
- 'success' => [
- 'description' => 'true 接口调用成功，false 接口调用失败',
- 'type' => 'boolean',
- 'example' => 'true',
- ],
- 'requestId' => [
- 'description' => '请求id，每次请求都是唯一值，便于后续排查问题',
- 'type' => 'string',
- 'example' => 'D02D895A-5E58-5A9F-963D-D8B027AB7AE2',
- ],
+ 'data' => ['description' => '返回信息', 'type' => 'any', 'example' => 'true'],
+ 'errorMsg' => ['description' => '错误信息', 'type' => 'string', 'example' => 'NoAuth'],
+ 'code' => ['description' => '错误码', 'type' => 'string', 'example' => 'NoAuth'],
+ 'success' => ['description' => 'true 接口调用成功，false 接口调用失败', 'type' => 'boolean', 'example' => 'true'],
+ 'requestId' => ['description' => '请求id，每次请求都是唯一值，便于后续排查问题', 'type' => 'string', 'example' => '45390C6D-016D-5030-BF65-031ED1F65003'],
],
],
],
],
'errorCodes' => [
401 => [
- [
- 'errorCode' => 'NoAuth',
- 'errorMessage' => 'Bad Request: Workspace.Illegal.Auth.',
- ],
- [
- 'errorCode' => 'Internal.Error',
- 'errorMessage' => 'Bad Request: Internal Error.',
- ],
+ ['errorCode' => 'Internal.Error', 'errorMessage' => 'Bad Request: Internal Error.', 'description' => '内部错误，请联系客服人员排查'],
+ ['errorCode' => 'NoAuth', 'errorMessage' => 'Bad Request: Workspace.Illegal.Auth.', 'description' => '当前所使用的账号无所指定业务空间的权限'],
+ ['errorCode' => 'NoResourceAuth', 'errorMessage' => 'Bad Request: Resource Auth Error.', 'description' => '没有请求的资源的权限，请确保所请求的资源属于当前参数中的业务空间'],
+ ['errorCode' => 'SystemOperationInProgress', 'errorMessage' => 'Xiyan GBI is learning your previous modifications. Please try again later.', 'description' => '析言GBI正在学习您之前的修改内容，请稍后重试'],
],
],
- 'staticInfo' => [
- 'returnType' => 'synchronous',
+ 'staticInfo' => ['returnType' => 'synchronous'],
+ 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"data\\": \\"true\\",\\n \\"errorMsg\\": \\"NoAuth\\",\\n \\"code\\": \\"NoAuth\\",\\n \\"success\\": true,\\n \\"requestId\\": \\"45390C6D-016D-5030-BF65-031ED1F65003\\"\\n}","type":"json"}]',
+ 'title' => '修改数据列信息',
+ 'changeSet' => [],
+ 'flowControl' => [
+ 'flowControlList' => [],
+ ],
+ 'ramActions' => [
+ [
+ 'operationType' => 'none',
+ 'ramAction' => [
+ 'action' => 'dataanalysisgbi:UpdateColumn',
+ 'authLevel' => 'operate',
+ 'actionConditions' => [],
+ 'resources' => [
+ ['validationType' => 'always', 'product' => 'DataAnalysisGBI', 'resourceType' => '全部资源', 'arn' => '*'],
+ ],
+ ],
+ ],
],
- 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"data\\": \\"true\\",\\n \\"errorMsg\\": \\"NoAuth\\",\\n \\"code\\": \\"NoAuth\\",\\n \\"success\\": true,\\n \\"requestId\\": \\"D02D895A-5E58-5A9F-963D-D8B027AB7AE2\\"\\n}","type":"json"}]',
- 'title' => '创建虚拟数据源实例',
],
- 'ListVirtualDatasourceInstance' => [
- 'summary' => '获取当前业务空间下的数据源实例列表。',
- 'path' => '/gbi/virtualDatasource/listVirtualDatasourceInstance',
- 'methods' => [
- 'post',
- ],
- 'schemes' => [
- 'https',
- ],
+ 'UpdateEnumMapping' => [
+ 'summary' => '修改当前指定业务空间指定列下的枚举值信息。',
+ 'path' => '/gbi/update/mapping',
+ 'methods' => ['post'],
+ 'schemes' => ['https'],
'security' => [
[
'AK' => [],
],
],
- 'consumes' => [
- 'application/json',
- ],
- 'produces' => [
- 'application/json',
- ],
- 'operationType' => 'read',
+ 'consumes' => ['application/json'],
+ 'produces' => ['application/json'],
+ 'operationType' => 'write',
'deprecated' => false,
- 'systemTags' => [
- 'operationType' => 'none',
- 'riskType' => 'none',
- 'chargeType' => 'free',
- ],
+ 'systemTags' => ['operationType' => 'none', 'riskType' => 'none', 'chargeType' => 'free'],
'parameters' => [
[
'name' => 'workspaceId',
'in' => 'query',
- 'schema' => [
- 'description' => '当前请求所使用的阿里云百炼业务空间id',
- 'type' => 'string',
- 'required' => true,
- 'example' => 'llm-2v3934xtp49esw64'."\n",
- ],
+ 'schema' => ['description' => '当前请求所使用的阿里云百炼业务空间id', 'type' => 'string', 'required' => true, 'example' => 'llm-2v3934xtp49esw64'."\n"],
],
[
'name' => 'body',
@@ -4008,22 +2655,17 @@
'description' => '请求体参数',
'type' => 'object',
'properties' => [
- 'nextToken' => [
- 'description' => '分页游标。'."\n"
- ."\n"
- .'- 如果是首次调用，该参数不传。'."\n"
- ."\n"
- .'- 如果是非首次调用，该参数传上传调用时返回的nextToken。',
- 'type' => 'string',
- 'required' => false,
- 'example' => 'e8Z0nRyY51ZQmYljqGNK',
- ],
- 'maxResults' => [
- 'description' => '每页最大条目数',
- 'type' => 'integer',
- 'format' => 'int32',
+ 'tableIdKey' => ['description' => '数据表的唯一标识符id', 'type' => 'string', 'required' => true, 'example' => 'table-AAAAAAAAFQBwSLJkUj4CYg'],
+ 'columnIdKey' => ['description' => '数据列的唯一标识符id', 'type' => 'string', 'required' => true, 'example' => 'column-AAAAAAAAh6cWOUPagYstkg'],
+ 'enumMapping' => [
+ 'description' => '枚举值映射',
+ 'type' => 'object',
'required' => false,
- 'example' => '100',
+ 'additionalProperties' => [
+ 'type' => 'array',
+ 'items' => ['type' => 'string', 'example' => '上海', 'description' => '枚举值映射的具体内容'],
+ 'description' => '一个枚举值映射的内容列表',
+ ],
],
],
'required' => false,
@@ -4037,107 +2679,64 @@
'description' => 'Result',
'type' => 'object',
'properties' => [
- 'data' => [
- 'description' => '数据列表。',
- 'type' => 'any',
- 'example' => '{'."\n"
- .' "data": ['."\n"
- .' {'."\n"
- .' "gmtModified": 1732708238000,'."\n"
- .' "vdbId": "vdb-0380ee25-2f49-4ee1-8de4-419a16da5904",'."\n"
- .' "name": "测试创建虚拟数据源实例",'."\n"
- .' "description": "通过sdk创建的虚拟数据源实例",'."\n"
- .' "id": 9,'."\n"
- .' "gmtCreate": 1732708238000,'."\n"
- .' "workspaceId": "10021406"'."\n"
- .' }'."\n"
- .' ],'."\n"
- .' "nextToken": "jN4HsrkljlksnWgb8u5mWQ\\u003d\\u003d",'."\n"
- .' "totalCount": 0'."\n"
- .'}',
- ],
- 'errorMsg' => [
- 'description' => '错误描述信息。',
- 'type' => 'string',
- 'example' => 'NoAuth',
- ],
- 'code' => [
- 'description' => '错误码',
- 'type' => 'string',
- 'example' => 'NoAuth',
- ],
- 'success' => [
- 'description' => '调用是否成功。'."\n"
- .'true，表示成功；'."\n"
- .'false，表示失败。',
- 'type' => 'boolean',
- 'example' => 'true',
- ],
- 'requestId' => [
- 'description' => '请求id，每次请求都是唯一值，便于后续排查问题'."\n"
- ."\n",
- 'type' => 'string',
- 'example' => '45390C6D-016D-5030-BF65-031ED1F65003',
- ],
+ 'data' => ['description' => '返回信息', 'type' => 'any', 'example' => 'true'],
+ 'errorMsg' => ['description' => '错误描述信息', 'type' => 'string', 'example' => 'NoAuth'],
+ 'code' => ['description' => '错误码', 'type' => 'string', 'example' => 'NoAuth'],
+ 'success' => ['description' => 'true 接口调用成功，false 接口调用失败', 'type' => 'boolean', 'example' => 'true'],
+ 'requestId' => ['description' => '请求id，每次请求都是唯一值，便于后续排查问题', 'type' => 'string', 'example' => 'FB11F719-9AC8-5C99-AB0A-4709D437FCFC'],
],
],
],
],
'errorCodes' => [
401 => [
- [
- 'errorCode' => 'NoAuth',
- 'errorMessage' => 'Bad Request: Workspace.Illegal.Auth.',
- ],
- [
- 'errorCode' => 'Internal.Error',
- 'errorMessage' => 'Bad Request: Internal Error.',
- ],
+ ['errorCode' => 'Internal.Error', 'errorMessage' => 'Bad Request: Internal Error.', 'description' => '内部错误，请联系客服人员排查'],
+ ['errorCode' => 'NoAuth', 'errorMessage' => 'Bad Request: Workspace.Illegal.Auth.', 'description' => '当前所使用的账号无所指定业务空间的权限'],
+ ['errorCode' => 'NoResourceAuth', 'errorMessage' => 'Bad Request: Resource Auth Error.', 'description' => '没有请求的资源的权限，请确保所请求的资源属于当前参数中的业务空间'],
+ ['errorCode' => 'SystemOperationInProgress', 'errorMessage' => 'Xiyan GBI is learning your previous modifications. Please try again later.', 'description' => '析言GBI正在学习您之前的修改内容，请稍后重试'],
],
],
- 'staticInfo' => [
- 'returnType' => 'synchronous',
+ 'staticInfo' => ['returnType' => 'synchronous'],
+ 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"data\\": \\"true\\",\\n \\"errorMsg\\": \\"NoAuth\\",\\n \\"code\\": \\"NoAuth\\",\\n \\"success\\": true,\\n \\"requestId\\": \\"FB11F719-9AC8-5C99-AB0A-4709D437FCFC\\"\\n}","type":"json"}]',
+ 'title' => '修改枚举值映射关系',
+ 'changeSet' => [],
+ 'flowControl' => [
+ 'flowControlList' => [],
+ ],
+ 'ramActions' => [
+ [
+ 'operationType' => 'none',
+ 'ramAction' => [
+ 'action' => 'dataanalysisgbi:UpdateEnumMapping',
+ 'authLevel' => 'operate',
+ 'actionConditions' => [],
+ 'resources' => [
+ ['validationType' => 'always', 'product' => 'DataAnalysisGBI', 'resourceType' => '全部资源', 'arn' => '*'],
+ ],
+ ],
+ ],
],
- 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"data\\": \\"{\\\\n \\\\\\"data\\\\\\": [\\\\n {\\\\n \\\\\\"gmtModified\\\\\\": 1732708238000,\\\\n \\\\\\"vdbId\\\\\\": \\\\\\"vdb-0380ee25-2f49-4ee1-8de4-419a16da5904\\\\\\",\\\\n \\\\\\"name\\\\\\": \\\\\\"测试创建虚拟数据源实例\\\\\\",\\\\n \\\\\\"description\\\\\\": \\\\\\"通过sdk创建的虚拟数据源实例\\\\\\",\\\\n \\\\\\"id\\\\\\": 9,\\\\n \\\\\\"gmtCreate\\\\\\": 1732708238000,\\\\n \\\\\\"workspaceId\\\\\\": \\\\\\"10021406\\\\\\"\\\\n }\\\\n ],\\\\n \\\\\\"nextToken\\\\\\": \\\\\\"jN4HsrkljlksnWgb8u5mWQ\\\\\\\\u003d\\\\\\\\u003d\\\\\\",\\\\n \\\\\\"totalCount\\\\\\": 0\\\\n}\\",\\n \\"errorMsg\\": \\"NoAuth\\",\\n \\"code\\": \\"NoAuth\\",\\n \\"success\\": true,\\n \\"requestId\\": \\"45390C6D-016D-5030-BF65-031ED1F65003\\"\\n}","type":"json"}]',
- 'title' => '虚拟数据源实例列表',
],
- 'UpdateVirtualDatasourceInstance' => [
- 'summary' => '修改指定业务空间下所指定的虚拟数据源的信息。',
- 'path' => '/gbi/virtualDatasource/updateVirtualDatasourceInstance',
- 'methods' => [
- 'post',
- ],
- 'schemes' => [
- 'https',
- ],
+ 'UpdateSynonyms' => [
+ 'summary' => '修改当前业务空间指定的同义词信息。',
+ 'path' => '/gbi/update/synonyms',
+ 'methods' => ['post'],
+ 'schemes' => ['https'],
'security' => [
[
'AK' => [],
],
],
- 'consumes' => [
- 'application/json',
- ],
- 'produces' => [
- 'application/json',
- ],
- 'operationType' => 'write',
+ 'consumes' => ['application/json'],
+ 'produces' => ['application/json'],
+ 'operationType' => 'readAndWrite',
'deprecated' => false,
- 'systemTags' => [
- 'operationType' => 'none',
- 'riskType' => 'none',
- 'chargeType' => 'free',
- ],
+ 'systemTags' => ['operationType' => 'none', 'riskType' => 'none', 'chargeType' => 'free'],
'parameters' => [
[
'name' => 'workspaceId',
'in' => 'query',
- 'schema' => [
- 'description' => '当前请求所使用的阿里云百炼业务空间id',
- 'type' => 'string',
- 'required' => false,
- 'example' => 'llm-2v3934xtp49esw64'."\n",
- ],
+ 'schema' => ['description' => '当前请求所使用的阿里云百炼业务空间id', 'type' => 'string', 'required' => true, 'example' => 'llm-2v3934xtp49esw64'."\n"],
],
[
'name' => 'body',
@@ -4147,34 +2746,19 @@
'description' => '请求体参数',
'type' => 'object',
'properties' => [
- 'name' => [
- 'description' => '虚拟数据源的名字',
- 'type' => 'string',
- 'required' => false,
- 'example' => '虚拟数据源1',
- ],
- 'description' => [
- 'description' => '虚拟数据源的描述',
- 'type' => 'string',
- 'required' => false,
- 'example' => '用于订单表的虚拟数据源实例',
- ],
- 'vdbId' => [
- 'description' => '虚拟数据源实例id',
- 'type' => 'string',
+ 'synonymIdKey' => ['description' => '同义词的唯一标识符id', 'type' => 'string', 'required' => true, 'example' => 'synonyms-AAAAAAAAAUpwTTVrwTFJwQ'],
+ 'word' => ['description' => '同义词本身', 'type' => 'string', 'required' => true, 'example' => '首都'],
+ 'wordSynonyms' => [
+ 'description' => '需要与同义词映射的词语列表',
+ 'type' => 'array',
+ 'items' => ['description' => '需要与同义词映射的词语', 'type' => 'string', 'required' => false, 'example' => '北京'],
'required' => true,
- 'example' => 'vdb-E0F693C8-9F72-5830-B81A-696C9D8EBBD1'."\n",
],
- 'type' => [
- 'description' => '当前虚拟数据源的类型',
- 'type' => 'integer',
- 'format' => 'int32',
+ 'columns' => [
+ 'description' => '如果需要关联到数据表的某个具体的列，则可以在这里填写具体的列名，形式为：表名.列名',
+ 'type' => 'array',
+ 'items' => ['description' => '如果需要关联到数据表的某个具体的列，则可以在这里填写具体的列名', 'type' => 'string', 'required' => false, 'example' => 'table.username'],
'required' => false,
- 'enumValueTitles' => [
- 51 => 'mysql类型虚拟数据源',
- 'postgresql类型虚拟数据源',
- ],
- 'example' => '51',
],
],
'required' => false,
@@ -4188,90 +2772,64 @@
'description' => 'Result',
'type' => 'object',
'properties' => [
- 'data' => [
- 'description' => '返回信息',
- 'type' => 'any',
- 'example' => 'true',
- ],
- 'errorMsg' => [
- 'description' => '错误描述信息',
- 'type' => 'string',
- 'example' => 'NoAuth',
- ],
- 'code' => [
- 'description' => '错误码',
- 'type' => 'string',
- 'example' => 'NoAuth',
- ],
- 'success' => [
- 'description' => 'true 接口调用成功，false 接口调用失败',
- 'type' => 'boolean',
- 'example' => 'true',
- ],
- 'requestId' => [
- 'description' => '请求id，每次请求都是唯一值，便于后续排查问题',
- 'type' => 'string',
- 'example' => 'E9563C85-5810-5835-B68C-78580BC3169E',
- ],
+ 'data' => ['description' => '返回信息', 'type' => 'any', 'example' => 'true'],
+ 'errorMsg' => ['description' => '错误描述信息', 'type' => 'string', 'example' => 'NoAuth'],
+ 'code' => ['description' => '错误码', 'type' => 'string', 'example' => 'NoAuth'],
+ 'success' => ['description' => 'true 接口调用成功，false 接口调用失败', 'type' => 'boolean', 'example' => 'true'],
+ 'requestId' => ['description' => '请求id，每次请求都是唯一值，便于后续排查问题', 'type' => 'string', 'example' => '7D63529B-5D42-5BF0-84E4-F742FFE02E7F'],
],
],
],
],
'errorCodes' => [
401 => [
- [
- 'errorCode' => 'Internal.Error',
- 'errorMessage' => 'Bad Request: Internal Error.',
- ],
- [
- 'errorCode' => 'NoAuth',
- 'errorMessage' => 'Bad Request: Workspace.Illegal.Auth.',
- ],
+ ['errorCode' => 'Internal.Error', 'errorMessage' => 'Bad Request: Internal Error.', 'description' => '内部错误，请联系客服人员排查'],
+ ['errorCode' => 'NoAuth', 'errorMessage' => 'Bad Request: Workspace.Illegal.Auth.', 'description' => '当前所使用的账号无所指定业务空间的权限'],
+ ['errorCode' => 'NoResourceAuth', 'errorMessage' => 'Bad Request: Resource Auth Error.', 'description' => '没有请求的资源的权限，请确保所请求的资源属于当前参数中的业务空间'],
+ ['errorCode' => 'SystemOperationInProgress', 'errorMessage' => 'Xiyan GBI is learning your previous modifications. Please try again later.', 'description' => '析言GBI正在学习您之前的修改内容，请稍后重试'],
],
],
- 'staticInfo' => [
- 'returnType' => 'synchronous',
+ 'staticInfo' => ['returnType' => 'synchronous'],
+ 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"data\\": \\"true\\",\\n \\"errorMsg\\": \\"NoAuth\\",\\n \\"code\\": \\"NoAuth\\",\\n \\"success\\": true,\\n \\"requestId\\": \\"7D63529B-5D42-5BF0-84E4-F742FFE02E7F\\"\\n}","type":"json"}]',
+ 'title' => '修改同义词',
+ 'changeSet' => [],
+ 'flowControl' => [
+ 'flowControlList' => [],
+ ],
+ 'ramActions' => [
+ [
+ 'operationType' => 'none',
+ 'ramAction' => [
+ 'action' => 'dataanalysisgbi:UpdateSynonyms',
+ 'authLevel' => 'operate',
+ 'actionConditions' => [],
+ 'resources' => [
+ ['validationType' => 'always', 'product' => 'DataAnalysisGBI', 'resourceType' => '全部资源', 'arn' => '*'],
+ ],
+ ],
+ ],
],
- 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"data\\": \\"true\\",\\n \\"errorMsg\\": \\"NoAuth\\",\\n \\"code\\": \\"NoAuth\\",\\n \\"success\\": true,\\n \\"requestId\\": \\"E9563C85-5810-5835-B68C-78580BC3169E\\"\\n}","type":"json"}]',
- 'title' => '修改虚拟数据源实例信息',
],
- 'DeleteVirtualDatasourceInstance' => [
- 'summary' => '删除指定业务空间下面的虚拟数据源实例。',
- 'path' => '/gbi/virtualDatasource/deleteVirtualDatasourceInstance',
- 'methods' => [
- 'post',
- ],
- 'schemes' => [
- 'https',
- ],
+ 'UpdateTableInfo' => [
+ 'summary' => '修改当前所指定的数据表的信息。',
+ 'path' => '/gbi/update/table',
+ 'methods' => ['post'],
+ 'schemes' => ['https'],
'security' => [
[
'AK' => [],
],
],
- 'consumes' => [
- 'application/json',
- ],
- 'produces' => [
- 'application/json',
- ],
+ 'consumes' => ['application/json'],
+ 'produces' => ['application/json'],
'operationType' => 'read',
'deprecated' => false,
- 'systemTags' => [
- 'operationType' => 'none',
- 'riskType' => 'none',
- 'chargeType' => 'free',
- ],
+ 'systemTags' => ['operationType' => 'none', 'riskType' => 'none', 'chargeType' => 'free'],
'parameters' => [
[
'name' => 'workspaceId',
'in' => 'query',
- 'schema' => [
- 'description' => '当前请求所使用的阿里云百炼业务空间id',
- 'type' => 'string',
- 'required' => true,
- 'example' => 'llm-2v3934xtp49esw64'."\n",
- ],
+ 'schema' => ['description' => '当前请求所使用的百炼业务空间id', 'type' => 'string', 'required' => true, 'example' => 'llm-2v3934xtp49esw64'."\n"],
],
[
'name' => 'body',
@@ -4281,11 +2839,14 @@
'description' => '请求体参数',
'type' => 'object',
'properties' => [
- 'vdbId' => [
- 'description' => '虚拟数据源实例id',
- 'type' => 'string',
- 'required' => true,
- 'example' => 'vdb-7D63529B-5D42-5BF0-84E4-F742FFE02E7F'."\n",
+ 'tableIdKey' => ['description' => '数据表的唯一标识符id', 'type' => 'string', 'required' => true, 'example' => 'table-AAAAAAAAFQBwSLJkUj4CYg'],
+ 'description' => ['description' => '对数据表的描述', 'type' => 'string', 'required' => false, 'example' => '这是一张用户信息表'],
+ 'primaryKey' => ['description' => '主键字段', 'type' => 'string', 'required' => false, 'example' => 'id'],
+ 'foreignKeys' => [
+ 'description' => '当前这张表的外键关系列表，采用“表名.列名=表名.列名”的形式',
+ 'type' => 'array',
+ 'items' => ['description' => '具体的一个外键关系', 'type' => 'string', 'required' => false, 'example' => 'user.name=order.username'],
+ 'required' => false,
],
],
'required' => false,
@@ -4299,90 +2860,64 @@
'description' => 'Result',
'type' => 'object',
'properties' => [
- 'data' => [
- 'description' => '响应数据。即成功与否。',
- 'type' => 'any',
- 'example' => 'true',
- ],
- 'errorMsg' => [
- 'description' => '错误描述信息。',
- 'type' => 'string',
- 'example' => 'NoAuth',
- ],
- 'code' => [
- 'description' => '错误码。',
- 'type' => 'string',
- 'example' => 'NoAuth',
- ],
- 'success' => [
- 'description' => 'true 接口调用成功，false 接口调用失败',
- 'type' => 'boolean',
- 'example' => 'true',
- ],
- 'requestId' => [
- 'description' => '请求id，每次请求都是唯一值，便于后续排查问题',
- 'type' => 'string',
- 'example' => '7D63529B-5D42-5BF0-84E4-F742FFE02E7F',
- ],
+ 'data' => ['description' => '返回信息', 'type' => 'any', 'example' => 'true'],
+ 'errorMsg' => ['description' => '错误描述信息', 'type' => 'string', 'example' => 'NoAuth'],
+ 'code' => ['description' => '错误码', 'type' => 'string', 'example' => 'NoAuth'],
+ 'success' => ['description' => 'true 接口调用成功，false 接口调用失败', 'type' => 'boolean', 'example' => 'true'],
+ 'requestId' => ['description' => '请求id，每次请求都是唯一值，便于后续排查问题', 'type' => 'string', 'example' => 'E9563C85-5810-5835-B68C-78580BC3169E'],
],
],
],
],
'errorCodes' => [
401 => [
- [
- 'errorCode' => 'NoAuth',
- 'errorMessage' => 'Bad Request: Workspace.Illegal.Auth.',
- ],
- [
- 'errorCode' => 'Internal.Error',
- 'errorMessage' => 'Bad Request: Internal Error.',
- ],
+ ['errorCode' => 'Internal.Error', 'errorMessage' => 'Bad Request: Internal Error.', 'description' => '内部错误，请联系客服人员排查'],
+ ['errorCode' => 'NoAuth', 'errorMessage' => 'Bad Request: Workspace.Illegal.Auth.', 'description' => '当前所使用的账号无所指定业务空间的权限'],
+ ['errorCode' => 'NoResourceAuth', 'errorMessage' => 'Bad Request: Resource Auth Error.', 'description' => '没有请求的资源的权限，请确保所请求的资源属于当前参数中的业务空间'],
+ ['errorCode' => 'SystemOperationInProgress', 'errorMessage' => 'Xiyan GBI is learning your previous modifications. Please try again later.', 'description' => '析言GBI正在学习您之前的修改内容，请稍后重试'],
],
],
- 'staticInfo' => [
- 'returnType' => 'synchronous',
+ 'staticInfo' => ['returnType' => 'synchronous'],
+ 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"data\\": \\"true\\",\\n \\"errorMsg\\": \\"NoAuth\\",\\n \\"code\\": \\"NoAuth\\",\\n \\"success\\": true,\\n \\"requestId\\": \\"E9563C85-5810-5835-B68C-78580BC3169E\\"\\n}","type":"json"}]',
+ 'title' => '修改数据表信息',
+ 'changeSet' => [],
+ 'flowControl' => [
+ 'flowControlList' => [],
+ ],
+ 'ramActions' => [
+ [
+ 'operationType' => 'none',
+ 'ramAction' => [
+ 'action' => 'dataanalysisgbi:UpdateTableInfo',
+ 'authLevel' => 'operate',
+ 'actionConditions' => [],
+ 'resources' => [
+ ['validationType' => 'always', 'product' => 'DataAnalysisGBI', 'resourceType' => '全部资源', 'arn' => '*'],
+ ],
+ ],
+ ],
],
- 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"data\\": \\"true\\",\\n \\"errorMsg\\": \\"NoAuth\\",\\n \\"code\\": \\"NoAuth\\",\\n \\"success\\": true,\\n \\"requestId\\": \\"7D63529B-5D42-5BF0-84E4-F742FFE02E7F\\"\\n}","type":"json"}]',
- 'title' => '删除虚拟数据源实例',
],
- 'SaveVirtualDatasourceDdl' => [
- 'summary' => '向您当前指定的业务空间下指定的虚拟数据源实例中添加ddl语句，析言GBI云服务会将您的ddl语句解析成相关的表结构信息并进行维护。',
- 'path' => '/gbi/virtualDatasource/addDdl2VirtualInstance',
- 'methods' => [
- 'post',
- ],
- 'schemes' => [
- 'https',
- ],
+ 'UpdateVirtualDatasourceInstance' => [
+ 'summary' => '修改指定业务空间下所指定的虚拟数据源的信息。',
+ 'path' => '/gbi/virtualDatasource/updateVirtualDatasourceInstance',
+ 'methods' => ['post'],
+ 'schemes' => ['https'],
'security' => [
[
'AK' => [],
],
],
- 'consumes' => [
- 'application/json',
- ],
- 'produces' => [
- 'application/json',
- ],
+ 'consumes' => ['application/json'],
+ 'produces' => ['application/json'],
'operationType' => 'write',
'deprecated' => false,
- 'systemTags' => [
- 'operationType' => 'none',
- 'riskType' => 'none',
- 'chargeType' => 'free',
- ],
+ 'systemTags' => ['operationType' => 'none', 'riskType' => 'none', 'chargeType' => 'free'],
'parameters' => [
[
'name' => 'workspaceId',
'in' => 'query',
- 'schema' => [
- 'description' => '当前请求所使用的阿里云百炼业务空间id',
- 'type' => 'string',
- 'required' => true,
- 'example' => 'llm-2v3934xtp49esw64'."\n",
- ],
+ 'schema' => ['description' => '当前请求所使用的阿里云百炼业务空间id', 'type' => 'string', 'required' => false, 'example' => 'llm-2v3934xtp49esw64'."\n"],
],
[
'name' => 'body',
@@ -4392,17 +2927,16 @@
'description' => '请求体参数',
'type' => 'object',
'properties' => [
- 'vdbId' => [
- 'description' => '虚拟数据源实例id',
- 'type' => 'string',
- 'required' => true,
- 'example' => 'vdb-E0F693C8-9F72-5830-B81A-696C9D8EBBD1'."\n",
- ],
- 'ddl' => [
- 'description' => 'create类型数据库ddl语句，支持传入多条，多条之间请用换行符分割（“\\n”）。',
- 'type' => 'string',
- 'required' => true,
- 'example' => 'CREATE TABLE user (id int NOT NULL AUTO_INCREMENT comment \'ID\',name varchar(10) NOT NULL comment \'姓名\', dept_id int NOT NULL comment \'部门ID\', salary bigint NULL DEFAULT 0 comment \'薪水\', PRIMARY KEY (`id`), KEY `idx_name` (`name`), KEY `d_id` (`dept_id`), CONSTRAINT `d_id` FOREIGN KEY (`dept_id`) REFERENCES `department` (`id`)) COMMENT=\'This is my table\' ENGINE=InnoDB AUTO_INCREMENT=20094 DEFAULT CHARSET=utf8 ;',
+ 'name' => ['description' => '虚拟数据源的名字', 'type' => 'string', 'required' => false, 'example' => '虚拟数据源1'],
+ 'description' => ['description' => '虚拟数据源的描述', 'type' => 'string', 'required' => false, 'example' => '用于订单表的虚拟数据源实例'],
+ 'vdbId' => ['description' => '虚拟数据源实例id', 'type' => 'string', 'required' => true, 'example' => 'vdb-E0F693C8-9F72-5830-B81A-696C9D8EBBD1'."\n"],
+ 'type' => [
+ 'description' => '当前虚拟数据源的类型',
+ 'type' => 'integer',
+ 'format' => 'int32',
+ 'required' => false,
+ 'enumValueTitles' => [51 => 'mysql类型虚拟数据源', 'postgresql类型虚拟数据源'],
+ 'example' => '51',
],
],
'required' => false,
@@ -4416,59 +2950,446 @@
'description' => 'Result',
'type' => 'object',
'properties' => [
- 'data' => [
- 'description' => '返回信息',
- 'type' => 'any',
- 'example' => 'true',
- ],
- 'errorMsg' => [
- 'description' => '错误描述信息',
- 'type' => 'string',
- 'example' => 'NoAuth',
- ],
- 'code' => [
- 'description' => '错误码',
- 'type' => 'string',
- 'example' => 'NoAuth',
- ],
- 'success' => [
- 'description' => 'true 接口调用成功，false 接口调用失败',
- 'type' => 'boolean',
- 'example' => 'true',
- ],
- 'requestId' => [
- 'description' => '请求id，每次请求都是唯一值，便于后续排查问题'."\n"
- ."\n",
- 'type' => 'string',
- 'example' => '72ABCA5B-1E93-55D3-8A61-6D8A03CC5C8B',
- ],
+ 'data' => ['description' => '返回信息', 'type' => 'any', 'example' => 'true'],
+ 'errorMsg' => ['description' => '错误描述信息', 'type' => 'string', 'example' => 'NoAuth'],
+ 'code' => ['description' => '错误码', 'type' => 'string', 'example' => 'NoAuth'],
+ 'success' => ['description' => 'true 接口调用成功，false 接口调用失败', 'type' => 'boolean', 'example' => 'true'],
+ 'requestId' => ['description' => '请求id，每次请求都是唯一值，便于后续排查问题', 'type' => 'string', 'example' => 'E9563C85-5810-5835-B68C-78580BC3169E'],
],
],
],
],
'errorCodes' => [
401 => [
- [
- 'errorCode' => 'NoAuth',
- 'errorMessage' => 'Bad Request: Workspace.Illegal.Auth.',
- ],
- [
- 'errorCode' => 'Internal.Error',
- 'errorMessage' => 'Bad Request: Internal Error.',
- ],
+ ['errorCode' => 'Internal.Error', 'errorMessage' => 'Bad Request: Internal Error.', 'description' => '内部错误，请联系客服人员排查'],
+ ['errorCode' => 'NoAuth', 'errorMessage' => 'Bad Request: Workspace.Illegal.Auth.', 'description' => '当前所使用的账号无所指定业务空间的权限'],
],
],
- 'staticInfo' => [
- 'returnType' => 'synchronous',
+ 'staticInfo' => ['returnType' => 'synchronous'],
+ 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"data\\": \\"true\\",\\n \\"errorMsg\\": \\"NoAuth\\",\\n \\"code\\": \\"NoAuth\\",\\n \\"success\\": true,\\n \\"requestId\\": \\"E9563C85-5810-5835-B68C-78580BC3169E\\"\\n}","type":"json"}]',
+ 'title' => '修改虚拟数据源实例信息',
+ 'changeSet' => [
+ ['createdAt' => '2024-12-10T15:46:05.000Z', 'description' => '请求参数发生变更'],
+ ],
+ 'flowControl' => [
+ 'flowControlList' => [],
+ ],
+ 'ramActions' => [
+ [
+ 'operationType' => 'none',
+ 'ramAction' => [
+ 'action' => 'dataanalysisgbi:UpdateVirtualDatasourceInstance',
+ 'authLevel' => 'operate',
+ 'actionConditions' => [],
+ 'resources' => [
+ ['validationType' => 'always', 'product' => 'DataAnalysisGBI', 'resourceType' => '全部资源', 'arn' => '*'],
+ ],
+ ],
+ ],
],
- 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"data\\": \\"true\\",\\n \\"errorMsg\\": \\"NoAuth\\",\\n \\"code\\": \\"NoAuth\\",\\n \\"success\\": true,\\n \\"requestId\\": \\"72ABCA5B-1E93-55D3-8A61-6D8A03CC5C8B\\"\\n}","type":"json"}]',
- 'title' => '向虚拟数据源中添加ddl语句',
],
],
'endpoints' => [
- [
- 'regionId' => 'cn-beijing',
- 'endpoint' => 'dataanalysisgbi.cn-beijing.aliyuncs.com',
+ ['regionId' => 'cn-beijing', 'regionName' => '华北2（北京）', 'areaId' => 'asiaPacific', 'areaName' => '亚太', 'public' => 'dataanalysisgbi.cn-beijing.aliyuncs.com', 'endpoint' => 'dataanalysisgbi.cn-beijing.aliyuncs.com', 'vpc' => 'dataanalysisgbi-vpc.cn-beijing.aliyuncs.com'],
+ ],
+ 'errorCodes' => [
+ ['code' => 'Internal Error', 'message' => 'Bad Request: Internal Error.', 'http_code' => 401, 'description' => '系统运行发生内部错误，请联系工作人员排查'],
+ ['code' => 'Internal.Error', 'message' => 'Bad Request: Internal Error.', 'http_code' => 401, 'description' => '内部错误，请联系客服人员排查'],
+ ['code' => 'Invalid.RequestId', 'message' => 'Bad Request: Invalid RequestId.', 'http_code' => 401, 'description' => 'requestId错误或已过期'],
+ ['code' => 'NoAuth', 'message' => 'Bad Request: Workspace.Illegal.Auth.', 'http_code' => 401, 'description' => '当前所使用的账号无所指定业务空间的权限'],
+ ['code' => 'NoResourceAuth', 'message' => 'Bad Request: Resource Auth Error.', 'http_code' => 401, 'description' => '没有请求的资源的权限，请确保所请求的资源属于当前参数中的业务空间'],
+ ['code' => 'Parameter.Error', 'message' => 'Bad Request: Parameter Error.', 'http_code' => 400, 'description' => '当前请求参数错误'],
+ ['code' => 'SystemOperationInProgress', 'message' => 'Xiyan GBI is learning your previous modifications. Please try again later.', 'http_code' => 401, 'description' => '析言GBI正在学习您之前的修改内容，请稍后重试'],
+ ],
+ 'changeSet' => [],
+ 'flowControl' => [
+ 'flowControlList' => [],
+ ],
+ 'ram' => [
+ 'productCode' => 'DataAnalysisGBI',
+ 'productName' => '大模型服务平台百炼',
+ 'ramCodes' => ['dataanalysisgbi'],
+ 'ramLevel' => '操作级',
+ 'ramConditions' => [],
+ 'ramActions' => [
+ [
+ 'apiName' => 'RunSqlGeneration',
+ 'description' => '运行sql生成',
+ 'operationType' => 'none',
+ 'ramAction' => [
+ 'action' => 'dataanalysisgbi:RunSqlGeneration',
+ 'authLevel' => 'operate',
+ 'actionConditions' => [],
+ 'resources' => [
+ ['validationType' => 'always', 'product' => 'DataAnalysisGBI', 'resourceType' => '全部资源', 'arn' => '*'],
+ ],
+ ],
+ ],
+ [
+ 'apiName' => 'ListSelectedTables',
+ 'description' => '选择的数据表集合',
+ 'operationType' => 'none',
+ 'ramAction' => [
+ 'action' => 'dataanalysisgbi:ListSelectedTables',
+ 'authLevel' => 'operate',
+ 'actionConditions' => [],
+ 'resources' => [
+ ['validationType' => 'always', 'product' => 'DataAnalysisGBI', 'resourceType' => '全部资源', 'arn' => '*'],
+ ],
+ ],
+ ],
+ [
+ 'apiName' => 'CreateVirtualDatasourceInstance',
+ 'description' => '创建虚拟数据源实例',
+ 'operationType' => 'none',
+ 'ramAction' => [
+ 'action' => 'dataanalysisgbi:CreateVirtualDatasourceInstance',
+ 'authLevel' => 'operate',
+ 'actionConditions' => [],
+ 'resources' => [
+ ['validationType' => 'always', 'product' => 'DataAnalysisGBI', 'resourceType' => '全部资源', 'arn' => '*'],
+ ],
+ ],
+ ],
+ [
+ 'apiName' => 'RunDataResultAnalysis',
+ 'description' => '执行结果分析',
+ 'operationType' => 'none',
+ 'ramAction' => [
+ 'action' => 'dataanalysisgbi:RunDataResultAnalysis',
+ 'authLevel' => 'operate',
+ 'actionConditions' => [],
+ 'resources' => [
+ ['validationType' => 'always', 'product' => 'DataAnalysisGBI', 'resourceType' => '全部资源', 'arn' => '*'],
+ ],
+ ],
+ ],
+ [
+ 'apiName' => 'UpdateSynonyms',
+ 'description' => '修改同义词',
+ 'operationType' => 'none',
+ 'ramAction' => [
+ 'action' => 'dataanalysisgbi:UpdateSynonyms',
+ 'authLevel' => 'operate',
+ 'actionConditions' => [],
+ 'resources' => [
+ ['validationType' => 'always', 'product' => 'DataAnalysisGBI', 'resourceType' => '全部资源', 'arn' => '*'],
+ ],
+ ],
+ ],
+ [
+ 'apiName' => 'ResyncTable',
+ 'description' => '刷新当前所关联的数',
+ 'operationType' => 'none',
+ 'ramAction' => [
+ 'action' => 'dataanalysisgbi:ResyncTable',
+ 'authLevel' => 'operate',
+ 'actionConditions' => [],
+ 'resources' => [
+ ['validationType' => 'always', 'product' => 'DataAnalysisGBI', 'resourceType' => '全部资源', 'arn' => '*'],
+ ],
+ ],
+ ],
+ [
+ 'apiName' => 'UpdateEnumMapping',
+ 'description' => '修改枚举值映射关系',
+ 'operationType' => 'none',
+ 'ramAction' => [
+ 'action' => 'dataanalysisgbi:UpdateEnumMapping',
+ 'authLevel' => 'operate',
+ 'actionConditions' => [],
+ 'resources' => [
+ ['validationType' => 'always', 'product' => 'DataAnalysisGBI', 'resourceType' => '全部资源', 'arn' => '*'],
+ ],
+ ],
+ ],
+ [
+ 'apiName' => 'SaveVirtualDatasourceDdl',
+ 'description' => '向虚拟数据源中添加ddl语句',
+ 'operationType' => 'none',
+ 'ramAction' => [
+ 'action' => 'dataanalysisgbi:SaveVirtualDatasourceDdl',
+ 'authLevel' => 'operate',
+ 'actionConditions' => [],
+ 'resources' => [
+ ['validationType' => 'always', 'product' => 'DataAnalysisGBI', 'resourceType' => '全部资源', 'arn' => '*'],
+ ],
+ ],
+ ],
+ [
+ 'apiName' => 'CreateBusinessLogic',
+ 'description' => '创建业务逻辑解释',
+ 'operationType' => 'none',
+ 'ramAction' => [
+ 'action' => 'dataanalysisgbi:CreateBusinessLogic',
+ 'authLevel' => 'operate',
+ 'actionConditions' => [],
+ 'resources' => [
+ ['validationType' => 'always', 'product' => 'DataAnalysisGBI', 'resourceType' => '全部资源', 'arn' => '*'],
+ ],
+ ],
+ ],
+ [
+ 'apiName' => 'UpdateTableInfo',
+ 'description' => '修改数据表信息',
+ 'operationType' => 'none',
+ 'ramAction' => [
+ 'action' => 'dataanalysisgbi:UpdateTableInfo',
+ 'authLevel' => 'operate',
+ 'actionConditions' => [],
+ 'resources' => [
+ ['validationType' => 'always', 'product' => 'DataAnalysisGBI', 'resourceType' => '全部资源', 'arn' => '*'],
+ ],
+ ],
+ ],
+ [
+ 'apiName' => 'ListBusinessLogic',
+ 'description' => '业务逻辑解释列表',
+ 'operationType' => 'none',
+ 'ramAction' => [
+ 'action' => 'dataanalysisgbi:ListBusinessLogic',
+ 'authLevel' => 'operate',
+ 'actionConditions' => [],
+ 'resources' => [
+ ['validationType' => 'always', 'product' => 'DataAnalysisGBI', 'resourceType' => '全部资源', 'arn' => '*'],
+ ],
+ ],
+ ],
+ [
+ 'apiName' => 'DeleteVirtualDatasourceInstance',
+ 'description' => '删除虚拟数据源实例',
+ 'operationType' => 'none',
+ 'ramAction' => [
+ 'action' => 'dataanalysisgbi:DeleteVirtualDatasourceInstance',
+ 'authLevel' => 'operate',
+ 'actionConditions' => [],
+ 'resources' => [
+ ['validationType' => 'always', 'product' => 'DataAnalysisGBI', 'resourceType' => '全部资源', 'arn' => '*'],
+ ],
+ ],
+ ],
+ [
+ 'apiName' => 'ListVirtualDatasourceInstance',
+ 'description' => '虚拟数据源实例列表',
+ 'operationType' => 'none',
+ 'ramAction' => [
+ 'action' => 'dataanalysisgbi:ListVirtualDatasourceInstance',
+ 'authLevel' => 'operate',
+ 'actionConditions' => [],
+ 'resources' => [
+ ['validationType' => 'always', 'product' => 'DataAnalysisGBI', 'resourceType' => '全部资源', 'arn' => '*'],
+ ],
+ ],
+ ],
+ [
+ 'apiName' => 'BatchDeleteSynonyms',
+ 'description' => '批量删除同义词',
+ 'operationType' => 'none',
+ 'ramAction' => [
+ 'action' => 'dataanalysisgbi:BatchDeleteSynonyms',
+ 'authLevel' => 'operate',
+ 'actionConditions' => [],
+ 'resources' => [
+ ['validationType' => 'always', 'product' => 'DataAnalysisGBI', 'resourceType' => '全部资源', 'arn' => '*'],
+ ],
+ ],
+ ],
+ [
+ 'apiName' => 'CreateSynonyms',
+ 'description' => '创建同义词',
+ 'operationType' => 'none',
+ 'ramAction' => [
+ 'action' => 'dataanalysisgbi:CreateSynonyms',
+ 'authLevel' => 'operate',
+ 'actionConditions' => [],
+ 'resources' => [
+ ['validationType' => 'always', 'product' => 'DataAnalysisGBI', 'resourceType' => '全部资源', 'arn' => '*'],
+ ],
+ ],
+ ],
+ [
+ 'apiName' => 'UpdateColumn',
+ 'description' => '修改数据列信息',
+ 'operationType' => 'none',
+ 'ramAction' => [
+ 'action' => 'dataanalysisgbi:UpdateColumn',
+ 'authLevel' => 'operate',
+ 'actionConditions' => [],
+ 'resources' => [
+ ['validationType' => 'always', 'product' => 'DataAnalysisGBI', 'resourceType' => '全部资源', 'arn' => '*'],
+ ],
+ ],
+ ],
+ [
+ 'apiName' => 'DeleteBusinessLogic',
+ 'description' => '删除业务逻辑解释',
+ 'operationType' => 'none',
+ 'ramAction' => [
+ 'action' => 'dataanalysisgbi:DeleteBusinessLogic',
+ 'authLevel' => 'operate',
+ 'actionConditions' => [],
+ 'resources' => [
+ ['validationType' => 'always', 'product' => 'DataAnalysisGBI', 'resourceType' => '全部资源', 'arn' => '*'],
+ ],
+ ],
+ ],
+ [
+ 'apiName' => 'ListSynonyms',
+ 'description' => '同义词列表',
+ 'operationType' => 'none',
+ 'ramAction' => [
+ 'action' => 'dataanalysisgbi:ListSynonyms',
+ 'authLevel' => 'operate',
+ 'actionConditions' => [],
+ 'resources' => [
+ ['validationType' => 'always', 'product' => 'DataAnalysisGBI', 'resourceType' => '全部资源', 'arn' => '*'],
+ ],
+ ],
+ ],
+ [
+ 'apiName' => 'RunDataAnalysis',
+ 'description' => 'Chat对话接口',
+ 'operationType' => 'none',
+ 'ramAction' => [
+ 'action' => 'dataanalysisgbi:RunDataAnalysis',
+ 'authLevel' => 'operate',
+ 'actionConditions' => [],
+ 'resources' => [
+ ['validationType' => 'always', 'product' => 'DataAnalysisGBI', 'resourceType' => '全部资源', 'arn' => '*'],
+ ],
+ ],
+ ],
+ [
+ 'apiName' => 'ListColumn',
+ 'description' => '数据表下的数据列集合',
+ 'operationType' => 'none',
+ 'ramAction' => [
+ 'action' => 'dataanalysisgbi:ListColumn',
+ 'authLevel' => 'operate',
+ 'actionConditions' => [],
+ 'resources' => [
+ ['validationType' => 'always', 'product' => 'DataAnalysisGBI', 'resourceType' => '全部资源', 'arn' => '*'],
+ ],
+ ],
+ ],
+ [
+ 'apiName' => 'DeleteColumn',
+ 'description' => '删除数据表中的列',
+ 'operationType' => 'none',
+ 'ramAction' => [
+ 'action' => 'dataanalysisgbi:DeleteColumn',
+ 'authLevel' => 'operate',
+ 'actionConditions' => [],
+ 'resources' => [
+ ['validationType' => 'always', 'product' => 'DataAnalysisGBI', 'resourceType' => '全部资源', 'arn' => '*'],
+ ],
+ ],
+ ],
+ [
+ 'apiName' => 'UpdateBusinessLogic',
+ 'description' => '修改业务逻辑解释',
+ 'operationType' => 'none',
+ 'ramAction' => [
+ 'action' => 'dataanalysisgbi:UpdateBusinessLogic',
+ 'authLevel' => 'operate',
+ 'actionConditions' => [],
+ 'resources' => [
+ ['validationType' => 'always', 'product' => 'DataAnalysisGBI', 'resourceType' => '全部资源', 'arn' => '*'],
+ ],
+ ],
+ ],
+ [
+ 'apiName' => 'CreateDatasourceAuthorization',
+ 'description' => '数据源关联关系授权',
+ 'operationType' => 'none',
+ 'ramAction' => [
+ 'action' => 'dataanalysisgbi:CreateDatasourceAuthorization',
+ 'authLevel' => 'operate',
+ 'actionConditions' => [],
+ 'resources' => [
+ ['validationType' => 'always', 'product' => 'DataAnalysisGBI', 'resourceType' => '全部资源', 'arn' => '*'],
+ ],
+ ],
+ ],
+ [
+ 'apiName' => 'SyncRemoteTables',
+ 'description' => '从数据源同步数据表',
+ 'operationType' => 'none',
+ 'ramAction' => [
+ 'action' => 'dataanalysisgbi:SyncRemoteTables',
+ 'authLevel' => 'operate',
+ 'actionConditions' => [],
+ 'resources' => [
+ ['validationType' => 'always', 'product' => 'DataAnalysisGBI', 'resourceType' => '全部资源', 'arn' => '*'],
+ ],
+ ],
+ ],
+ [
+ 'apiName' => 'CancelDatasourceAuthorization',
+ 'description' => '取消数据源关联关系授权',
+ 'operationType' => 'none',
+ 'ramAction' => [
+ 'action' => 'dataanalysisgbi:CancelDatasourceAuthorization',
+ 'authLevel' => 'operate',
+ 'actionConditions' => [],
+ 'resources' => [
+ ['validationType' => 'always', 'product' => 'DataAnalysisGBI', 'resourceType' => '全部资源', 'arn' => '*'],
+ ],
+ ],
+ ],
+ [
+ 'apiName' => 'DeleteSelectedTable',
+ 'description' => '删除所选择的数据表',
+ 'operationType' => 'none',
+ 'ramAction' => [
+ 'action' => 'dataanalysisgbi:DeleteSelectedTable',
+ 'authLevel' => 'operate',
+ 'actionConditions' => [],
+ 'resources' => [
+ ['validationType' => 'always', 'product' => 'DataAnalysisGBI', 'resourceType' => '全部资源', 'arn' => '*'],
+ ],
+ ],
+ ],
+ [
+ 'apiName' => 'ListEnumMapping',
+ 'description' => '枚举值映射列表',
+ 'operationType' => 'none',
+ 'ramAction' => [
+ 'action' => 'dataanalysisgbi:ListEnumMapping',
+ 'authLevel' => 'operate',
+ 'actionConditions' => [],
+ 'resources' => [
+ ['validationType' => 'always', 'product' => 'DataAnalysisGBI', 'resourceType' => '全部资源', 'arn' => '*'],
+ ],
+ ],
+ ],
+ [
+ 'apiName' => 'RecoverColumn',
+ 'description' => '还原数据列信息',
+ 'operationType' => 'none',
+ 'ramAction' => [
+ 'action' => 'dataanalysisgbi:RecoverColumn',
+ 'authLevel' => 'operate',
+ 'actionConditions' => [],
+ 'resources' => [
+ ['validationType' => 'always', 'product' => 'DataAnalysisGBI', 'resourceType' => '全部资源', 'arn' => '*'],
+ ],
+ ],
+ ],
+ [
+ 'apiName' => 'UpdateVirtualDatasourceInstance',
+ 'description' => '修改虚拟数据源实例信息',
+ 'operationType' => 'none',
+ 'ramAction' => [
+ 'action' => 'dataanalysisgbi:UpdateVirtualDatasourceInstance',
+ 'authLevel' => 'operate',
+ 'actionConditions' => [],
+ 'resources' => [
+ ['validationType' => 'always', 'product' => 'DataAnalysisGBI', 'resourceType' => '全部资源', 'arn' => '*'],
+ ],
+ ],
+ ],
],
+ 'resourceTypes' => [],
],
];
generated by cgit v1.2.3 (git 2.46.0) at 2026-07-12 23:16:21 +0000