ModifyCopilotEmbedConfig - 修改智能问数嵌入配置

修改智能问数嵌入配置。

调试

您可以在OpenAPI Explorer中直接运行该接口,免去您计算签名的困扰。运行成功后,OpenAPI Explorer可以自动生成SDK代码示例。

授权信息

下表是API对应的授权信息,可以在RAM权限策略语句的Action元素中使用,用来给RAM用户或RAM角色授予调用此API的权限。具体说明如下:

  • 操作:是指具体的权限点。
  • 访问级别:是指每个操作的访问级别,取值为写入(Write)、读取(Read)或列出(List)。
  • 资源类型:是指操作中支持授权的资源类型。具体说明如下:
    • 对于必选的资源类型,用前面加 * 表示。
    • 对于不支持资源级授权的操作,用全部资源表示。
  • 条件关键字:是指云产品自身定义的条件关键字。
  • 关联操作:是指成功执行操作所需要的其他权限。操作者必须同时具备关联操作的权限,操作才能成功。
操作访问级别资源类型条件关键字关联操作
quickbi-public:ModifyCopilotEmbedConfigupdate
*全部资源
*

请求参数

名称类型必填描述示例值
CopilotIdstring

嵌入 id。

ccd3428c-dd2xxxxxxxxxxxxdffee
DataRangestring

数据范围。

注意 传参类型为 jsonString,并且分析主题与问数资源只能生效一个开关,并且当全选开关为 true 时,已全选开关为准,推荐传参只传一个,其他注释

如果客户要授权所有分析主题,则 {allTheme: true} 如果客户要授权所有问数资源,则 {allCube: true} 如果客户要授权部分问数资源,则 {llmCubes: [12314,12345]} 如果客户要授权部分分析主题,则 {themes: [12314,12345]}
ModuleNamestring

模块名称。

Q
AgentNamestring

机器人昵称。

Q

返回参数

名称类型描述示例值
object

Schema of Response

RequestIdstring

请求 id。

4BAA4694-CC27-555F-B15A-688AA9289FEE
Successboolean

是否请求成功。取值范围:

  • true:请求成功
  • false:请求失败
true
Resultboolean

返回接口执行结果。取值范围:

  • true:执行成功
  • false:执行失败
true

示例

正常返回示例

JSON格式

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

错误码

HTTP status code错误码错误信息描述
400UserRoleConfig.NotContain.FunctionThe user %s does not have permission to operate.此用户%s没有权限操作。
400Copilot.Modulename.ErrorModuleName max length limit 20.模块名称最大长度是20。
400Copilot.AgentName.ErrorAgentName max length limit 10.机器人名称最大长度限制为10。
400Invalid.Parameter.ErrorThe parameter is invalid:%s.无效参数%s。
400CopilotEmbed.Config.NotFindCan not find copilot embed config with this copilot ID.找不到此嵌入配置

访问错误中心查看更多错误码。