Quick BI 智能小Q开放API

更新时间:
复制为 MD 格式

智能小Q支持开放API,您可以根据业务需求进行使用。本文将为您介绍各接口的基本信息,具体API的参数及示例等详细信息,请参见表格中的参考链接对应的文档。

使用限制

  • 智能小Q属于增值模块,需要额外购买。未购买时不支持调用智能小Q开放API。

  • 仅专业版及以上支持智能小Q开放API。

Q问数嵌入

接口名称

接口描述

参考链接

CreateTicket4Copilot

用于生成智能小Q嵌入Ticket。

生成智能小Q嵌入Ticket

ModifyCopilotEmbedConfig

修改小Q问数嵌入配置。

修改小Q问数嵌入配置

QueryCopilotEmbedConfig

获取开通小Q嵌入的配置列表。

获取开通小Q嵌入的配置列表

QueryDataRange

获取嵌入配置界面的数据范围目录列表。

获取数据范围目录列表

Q问数管理

接口名称

接口描述

参考链接

ModifyDashboardNl2sqlStatus

批量编辑仪表板的小Q问数状态

批量编辑仪表板的小Q问数状态

QueryDashboardNl2sql

查询仪表板的问数资源信息

查询仪表板的问数资源信息

SmartqAuthorize

批量管理小Q问数的授权。

批量管理小Q问数的授权

QueryLlmCubeWithThemeListByUserId

查看用户有哪些数据集和分析主题的问数授权。

查看用户有哪些数据集和分析主题的问数授权

SmartqAuthTransfer

将指定用户的问数权限同步给其他用户。

将指定用户的问数权限同步给其他用户

QuerySmartqPermissionByCubeId

查看用户是否有某个小Q问数数据集权限。

查看用户是否有某个小Q问数数据集权限

QueryDatasetSmartqStatus

查看数据集是否开通小Q问数。

查看数据集是否开通小Q问数

SmartqQueryAbility

Q问数查询。

Q问数查询