Intelligent Q provides open APIs that you can integrate based on your business requirements. The following tables list the available APIs. For parameter details and examples, see the corresponding topic in the Reference column.
Limitations
-
Intelligent Q is a value-added module that requires a separate purchase before you can use its open API.
-
The Intelligent Q open API is available only in Quick BI Professional Edition or higher.
Q-Query embedding
|
API |
Description |
Reference |
|
CreateTicket4Copilot |
Generates a ticket for embedding Intelligent Q. |
|
|
ModifyCopilotEmbedConfig |
Modifies Q-Query embedding configurations. |
|
|
QueryCopilotEmbedConfig |
Queries the list of Q-Query embedding configurations. |
|
|
QueryDataRange |
Retrieves the list of data range directories available in the embedding configuration UI. |
Q-Query management
|
API |
Description |
Reference |
|
ModifyDashboardNl2sqlStatus |
Modifies the Q-Query status of dashboards in batches. |
|
|
QueryDashboardNl2sql |
Queries the Q-Query resource information of a dashboard. |
|
|
SmartqAuthorize |
Manages Q-Query authorization in batches. |
|
|
QueryLlmCubeWithThemeListByUserId |
Queries the datasets and analysis themes for which a user has Q-Query authorization. |
Query which datasets and analysis themes a user has Q-Query authorization for |
|
SmartqAuthTransfer |
Synchronizes the Q-Query permissions of a specified user to other users. |
Synchronize the Q-Query permissions of a specified user to other users |
|
QuerySmartqPermissionByCubeId |
Checks whether a user has permissions on a specific Q-Query dataset. |
Check whether a user has permissions on a specific Q-Query dataset |
|
QueryDatasetSmartqStatus |
Checks whether Q-Query is enabled for a dataset. |
|
|
SmartqQueryAbility |
Queries data by using Q-Query. |