Retrieve XiaoQ Embedding Configurations via QueryCopilotEmbedConfig API - Quick BI - Alibaba Cloud - Quick BI

Queries the list of Copilot (XiaoQ) embedding configurations.

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:QueryCopilotEmbedConfig

list

*All Resource

*

None

Request parameters

Parameter	Type	Required	Description	Example
Keyword	string	No	Name of the embedded configuration module. Fuzzy search is supported.	06-ELive

Response elements

Element	Type	Description	Example
	object	Response schema.
RequestId	string	Request ID.	1FC71085-D5FD-08E0-813A-4D4BD1031BC5
Success	boolean	Indicates whether the request was successful. Valid values: true: The request was successful. false: The request failed.	true
Result	array<object>	List of embedded configurations.
	array<object>	Embedded configuration object.
AgentName	string	Bot nickname.	小Q
CopilotId	string	Embedding ID.	9c079710-ddbe-48b3-b495-7c83c8d57cc4
CreateUser	string	ID of the creator.	qweqw12312423521
CreateUserName	string	Nickname of the creator.	诸葛
DataRange	object	Data range (analysis themes and question resources).
AllCube	boolean	Indicates whether all question resources are selected.	true/false
AllTheme	boolean	Indicates whether all analysis themes are selected.	true/false
LlmCubes	array	Collection of question resource IDs.
	string	Question resource ID.	123124,1231241
Themes	array	Collection of analysis theme IDs.
	string	Analysis theme ID.	123124,1231241
ModifyUser	string	ID of the modifier.	asda1231231dfs
ModuleName	string	Module name.	小Q
ShowName	string	Name of the embedded module.	0327

Examples

Success response

JSON format

{
  "RequestId": "1FC71085-D5FD-08E0-813A-4D4BD1031BC5",
  "Success": true,
  "Result": [
    {
      "AgentName": "小Q",
      "CopilotId": "9c079710-ddbe-48b3-b495-7c83c8d57cc4",
      "CreateUser": "qweqw12312423521",
      "CreateUserName": "诸葛",
      "DataRange": {
        "AllCube": true,
        "AllTheme": true,
        "LlmCubes": [
          "123124,1231241"
        ],
        "Themes": [
          "123124,1231241"
        ]
      },
      "ModifyUser": "asda1231231dfs",
      "ModuleName": "小Q",
      "ShowName": "0327"
    }
  ]
}

Error codes

HTTP status code	Error code	Error message	Description
400	UserRoleConfig.NotContain.Function	The user %s does not have permission to operate.

See Error Codes for a complete list.

Release notes

See Release Notes for a complete list.