Call SmartqQueryAbility API for Intelligent Q&A - Quick BI - Alibaba Cloud - Quick BI

Queries data by using the Smart Q&A feature.

Operation description

Note: When a user is authorized to call this API, the user can query data as a specified user by passing in the userId parameter.

Try it now

Try this API in OpenAPI Explorer, no manual signing needed. Successful calls auto-generate SDK code matching your parameters. Download it with built-in credential security for local usage.

Test

RAM authorization

The table below describes the authorization required to call this API. You can define it in a Resource Access Management (RAM) policy. The table's columns are detailed below:

Action: The actions can be used in the Action element of RAM permission policy statements to grant permissions to perform the operation.
API: The API that you can call to perform the action.
Access level: The predefined level of access granted for each API. Valid values: create, list, get, update, and delete.
Resource type: The type of the resource that supports authorization to perform the action. It indicates if the action supports resource-level permission. The specified resource must be compatible with the action. Otherwise, the policy will be ineffective.
- For APIs with resource-level permissions, required resource types are marked with an asterisk (*). Specify the corresponding Alibaba Cloud Resource Name (ARN) in the Resource element of the policy.
- For APIs without resource-level permissions, it is shown as All Resources. Use an asterisk (*) in the Resource element of the policy.
Condition key: The condition keys defined by the service. The key allows for granular control, applying to either actions alone or actions associated with specific resources. In addition to service-specific condition keys, Alibaba Cloud provides a set of common condition keys applicable across all RAM-supported services.
Dependent action: The dependent actions required to run the action. To complete the action, the RAM user or the RAM role must have the permissions to perform all dependent actions.

Action

Access level

Resource type

Condition key

Dependent action

quickbi-public:SmartqQueryAbility

get

*All Resource

*

None

Request parameters

Parameter	Type	Required	Description	Example
UserId	string	No	The user ID. Important If this parameter is not specified, data is queried as the organization owner by default.	7c7223ae-****-3c744528014b
UserQuestion	string	Yes	The question text.	test
CubeId	string	No	The dataset ID. Navigate to Workbench > Datasets, open the desired dataset, and find the cubeId in the URL. In multi-table scenarios, leave this parameter empty.	7c7223ae-****-3c744528014b
MultipleCubeIds	string	No	The list of multiple dataset IDs. The model selects one or more tables from the list based on the question to generate an answer. This parameter is required in multi-table scenarios and is not needed in single-table scenarios.	7c7**-3c744528014b,a876asd*yhashd2

Response elements

Element	Type	Description	Example
	object	Schema of Response
RequestId	string	The request ID.	D787E1A3-A************2B05DF8D885
Result	object	The returned result.
ChartType	string	The suggested chart type.	NEW_TABLE
MetaType	array<object>	The list of column tuple types.
	object	The metadata object.
Key	string	The column tuple name.	Polar***STPS
Value	string	The column tuple type.	string
Type	string	The metadata row or column type. Dimension: dimension Measure: measure	Dimension
Values	array<object>	The array of data value lists.
	object	The data value list object.
Row	array	The data values for each row.
	string	The data value for each field.	199
LogicSql	string	The visualization logic SQL.	select * ****
ConclusionText	string	The summary information.	test
DataList	array	The data list returned only in multi-step scenarios. Each element corresponds to a chart dataset.
	string	The chart data.	test
Success	boolean	Indicates whether the request was successful.	true

Examples

Success response

JSON format

{
  "RequestId": "D787E1A3-A************2B05DF8D885",
  "Result": {
    "ChartType": "NEW_TABLE",
    "MetaType": [
      {
        "Key": "Polar***STPS",
        "Value": "string",
        "Type": "Dimension"
      }
    ],
    "Values": [
      {
        "Row": [
          "199"
        ]
      }
    ],
    "LogicSql": "select * ****",
    "ConclusionText": "test",
    "DataList": [
      "test"
    ]
  },
  "Success": true
}

Error codes

See Error Codes for a complete list.

Release notes

See Release Notes for a complete list.

HTTP status code	Error code	Error message	Description
400	Internal.System.Error	An internal system error occurred.	An internal system error occurred.
400	Query.Auth.Error	Query is not permitted.	No query permission.
400	Instance.Expired	Your instance has expired.	Your instance has expired.
400	Instance.Not.Exist	The specified instance does not exist.	The specified instance does not exist.
400	Invalid.Organization	The specified organizational unit does not exist.	The specified organizational unit does not exist.
400	User.Not.In.Organization	The specified user is not in the organizational unit.	The specified user is not in the organizational unit.
400	Invalid.Parameter	An error occurred while verifying parameters.	An error occurred while verifying parameters.
400	Invalid.Parameter.Error	The parameter is invalid:%s.	invalid parameter: ${0}.
400	Invalid.Param.Error	The parameter is invalid.	The parameter is invalid.
400	Invalid.User.Admin	You are not an administrator of this organization.	Only organization administrators can perform this operation.
400	System.Param.Empty	You must specify the %s parameter.	You must specify the %s parameter.
400	Access.Forbidden	Your instance version or access key is not allowed to call the API operation, only professional version supports calling.	Your instance version or access key is not allowed to call the API operation, only professional version supports calling.
400	UserInfo.Error	The personal information is invalid.	The personal information is invalid.
400	ApiUser.Not.Exists	The specified user does not exist.	The specified user does not exist.
400	User.Not.WorkspaceAdmin	Only administrators of the group workspace can perform this operation.	Only administrators of the group workspace can perform this operation.
400	Application.Object.NotExist	The object you are operating does not exist or has been deleted.	The operation component does not exist or has been deleted.
400	Not.ApiCall.AuthUser	You are not an administrator or API call auth user of this organization.	Not an organization administrator or API call authorized user.
400	UserRoleConfig.NotContain.Function	The user %s does not have permission to operate.	The user %s does not have permission to operate.
400	RobotNl2sql.Moudle.NotPurchase	Please purchase Nl2sql module first.	Please purchase Nl2sql module first.
400	LlmCopilotQuestion.NotRelatedData.Error	The question you raised is not related to data queries, or the relevant field information could not be found in the dataset. Please try again.	The question you raised is not related to data queries, or the relevant field information could not be found in the dataset. Please try again.
500	Invalid.User.Organization	The user is not in your organization.