Update Copilot Embed Settings via ModifyCopilotEmbedConfig API - Quick BI - Alibaba Cloud - Quick BI

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

update

*All Resource

*

None

Request parameters

Parameter	Type	Required	Description	Example
CopilotId	string	Yes	Embedding ID.	ccd3428c-dd2xxxxxxxxxxxxdffee
DataRange	string	No	Data range. Important The parameter value is a JSON string. Only one selection mode takes effect at a time: either analysis themes or query resources. When the select-all switch is set to true, it takes precedence. We recommend that you specify only one parameter. Valid values: themes : themes allTheme : allTheme llmCubes : llmCubes allCube : allCube	如果客户要授权所有分析主题，则 {allTheme: true} 如果客户要授权所有问数资源，则 {allCube: true} 如果客户要授权部分问数资源，则 {llmCubes: [12314,12345]} 如果客户要授权部分分析主题，则 {themes: [12314,12345]}
ModuleName	string	No	Module name.	小Q
AgentName	string	No	Agent nickname.	小Q

Response elements

Element	Type	Description	Example
	object	The response schema.
RequestId	string	Request ID.	4BAA4694-CC27-555F-B15A-688AA9289FEE
Success	boolean	Indicates whether the request is successful. Valid values: true: The request was successful false: The request failed	true
Result	boolean	The execution result of the operation. Valid values: true: Execution succeeded false: Execution failed	true

Examples

Success response

JSON format

{
  "RequestId": "4BAA4694-CC27-555F-B15A-688AA9289FEE",
  "Success": true,
  "Result": true
}

Error codes

HTTP status code	Error code	Error message	Description
400	UserRoleConfig.NotContain.Function	The user %s does not have permission to operate.	The user %s does not have permission to operate.
400	Copilot.Modulename.Error	ModuleName max length limit 20.	The maximum length of a module name is 20.
400	Copilot.AgentName.Error	AgentName max length limit 10.	The maximum length of the robot name is limited to 10.
400	Invalid.Parameter.Error	The parameter is invalid:%s.	invalid parameter: ${0}.
400	CopilotEmbed.Config.NotFind	Can not find copilot embed config with this copilot ID.	Cannot find this embedded configuration

See Error Codes for a complete list.

Release notes

See Release Notes for a complete list.