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

Modify Intelligent Query Embedding Configuration

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:ModifyCopilotEmbedConfig	update	All Resources ``	none	none

Request parameters

Parameter	Type	Required	Description	Example
CopilotId	string	Yes	Embedding ID.	ccd3428c-dd2xxxxxxxxxxxxdffee
DataRange	string	No	Data range. Notice The parameter type is jsonString, and only one switch between analysis themes and query resources can be effective. When the all-select switch is true, it takes precedence. It is recommended to pass only one parameter, with other notes Enumeration Value: themes: themes. allTheme: allTheme. llmCubes: llmCubes. allCube: allCube.	Map<String,Object> data=new HashMap<>(); data.put("allTheme",true); //data.put("allCube",true); //data.put("themes",Lists.newArrayList("1111","22222")); //data.put("llmCubes",Lists.newArrayList("33333","44444")); request.setDataRange(JSON.toJSONString(data));
ModuleName	string	No	Module name.	smartq
AgentName	string	No	Agent nickname.	smartq

Response parameters

Parameter	Type	Description	Example
	object	Schema of Response
RequestId	string	Request ID.	4BAA469******A9289FEE
Success	boolean	Indicates whether the request was successful. Possible values: true: The request was successful false: The request failed	true
Result	boolean	Returns the result of the API execution. Possible values: true: Execution succeeded false: Execution failed	true

Examples

Sample success responses

JSONformat

{
  "RequestId": "4BAA469******A9289FEE",
  "Success": true,
  "Result": true
}

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.
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.
500	Invalid.Parameter.Error	The parameter is invalid:%s.	invalid parameter: ${0}.
500	CopilotEmbed.Config.NotFind	Can not find copilot embed config with this copilot ID.	Cannot find this embedded configuration

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