QueryCopilotEmbedConfig - Quick BI - Alibaba Cloud Documentation Center

This topic is generated by a machine translation engine without any human intervention. ALIBABA CLOUD DOES NOT GUARANTEE THE ACCURACY OF MACHINE TRANSLATED CONTENT. To request a human-translated version of this topic or provide feedback on this translation, please include it in the feedback form.

Get the List of Configurations for Activating XiaoQ Embedding

Debugging

You can run this interface directly in OpenAPI Explorer, saving you the trouble of calculating signatures. After running successfully, OpenAPI Explorer can automatically generate SDK code samples.

Debug

Authorization information

The following table shows the authorization information corresponding to the API. The authorization information can be used in the Action policy element to grant a RAM user or RAM role the permissions to call this API operation. Description:

Operation: the value that you can use in the Action element to specify the operation on a resource.
Access level: the access level of each operation. The levels are read, write, and list.
Resource type: the type of the resource on which you can authorize the RAM user or the RAM role to perform the operation. Take note of the following items:
- For mandatory resource types, indicate with a prefix of * .
- If the permissions cannot be granted at the resource level, All Resources is used in the Resource type column of the operation.
Condition Key: the condition key that is defined by the cloud service.
Associated operation: other operations that the RAM user or the RAM role must have permissions to perform to complete the operation. To complete the operation, the RAM user or the RAM role must have the permissions to perform the associated operations.

Operation	Access level	Resource type	Condition key	Associated operation
quickbi-public:QueryCopilotEmbedConfig	list	All Resources ``	none	none

Request parameters

Parameter	Type	Required	Description	Example
Keyword	string	No	Name of the embedded configuration module, supports fuzzy search.	06-ELive

Response parameters

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

Examples

Sample success responses

JSONformat

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

Error codes

HTTP status code	Error code	Error message	Description
400	Internal.System.Error	An internal system error occurred.	An internal system error occurred.
400	UserRoleConfig.NotContain.Function	The user %s does not have permission to operate.	The user %s does not have permission to operate.

For a list of error codes, visit the Service error codes.