文档

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

更新时间:

修改智能问数嵌入配置。

调试

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

授权信息

当前API暂无授权信息透出。

请求参数

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

嵌入 id。

ccd3428c-dd2xxxxxxxxxxxxdffee
DataRangestring

数据范围。

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

枚举值:
  • themes分析主题id数组
  • allTheme全部分析主题,true/false
  • llmCubes问数资源id数组
  • allCube全部问数资源,true/false
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));
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错误码错误信息描述
400Internal.System.ErrorAn internal system error occurred.系统内部异常。
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。
500Invalid.Parameter.ErrorThe parameter is invalid:%s.无效参数%s。
500CopilotEmbed.Config.NotFindCan not find copilot embed config with this copilot ID.找不到此嵌入配置

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