UpdateAgent - 修改Agent

更新时间:
复制 MD 格式

修改Agent

调试

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

调试

授权信息

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

请求参数

名称

类型

必填

描述

示例值

BaseMeAgentId

integer

否

业务空间 Id

12345

JsonStr

string

否

完整 JSON 字符串信息,具体内容参见以下详细信息。

xxx


接口入参说明

1. 概述

Agent 管理请求的入参对象,包含 Agent 的基本属性配置和指令类型参数两大部分。


2. 顶层字段

字段名类型必填说明
idLong是Agent Id
agentNameString是Agent 名称
agentDescriptionString否Agent 描述信息
modelTypeString是大模型类型,取值参见 LLMCodeEnum 枚举
inputTypeString是分析对象类型,可选值:text(文本)、voice(语音)、image(图片)
instructionTypeString是指令类型 code,取值参见 AgentInstructionTypeEnum 枚举(见下表)
instructionTypeParamInstructionTypeParam是指令类型的详细配置参数,根据 instructionType 的不同传入对应的子对象

instructionType 枚举值

code描述对应 Param
serviceInspection服务质检serviceInspectionParam
field关键属性抽取fieldsParam
tagCategory标签分类tagCategoryParam
multiLevelTag多级标签识别tagTreeLevelParam
customPrompt自定义指令customPromptParam

3. InstructionTypeParam(指令类型参数)

instructionTypeParam 是各种指令类型的配置容器,根据 instructionType 的值,仅需传入对应的子对象,其余子对象可为 null。

字段名类型说明
fieldsParamFieldsParam关键属性抽取配置,当 instructionType=field 时传入
serviceInspectionParamServiceInspectionParam服务质检配置,当 instructionType=serviceInspection 时传入
tagCategoryParamTagCategoryParam标签分类配置,当 instructionType=tagCategory 时传入
tagTreeLevelParamTagTreeLevelParam多级标签分析配置,当 instructionType=multiLevelTag 时传入
customPromptParamCustomPromptParam自定义指令配置,当 instructionType=customPrompt 时传入

3.1 FieldsParam(关键属性抽取)

字段名类型必填说明
nameDescPairListList<NameDescPair>是需要抽取的关键属性维度列表

NameDescPair 结构:

字段名类型必填说明
nameString是属性名称
descString是属性描述
valueString是属性值

3.2 ServiceInspectionParam(服务质检)

字段名类型必填说明
sceneNameString是质检场景名称
sceneDescriptionString是质检场景描述
dimensionsList<Dimension>是质检维度列表,定义具体的检查维度及其条件

Dimension 结构:

字段名类型必填说明
dimensionString是维度名称(JSON 反序列化时也接受 title 作为别名)
descString是维度描述(JSON 反序列化时也接受 content 作为别名)

3.3 TagCategoryParam(标签分类)

字段名类型必填说明
nameDescPairListList<NameDescValueListPair>是标签分类维度列表,每个维度可包含多个候选标签值

NameDescValueListPair 结构:

字段名类型必填说明
nameString是维度/分类名称
descString是维度描述
valueListList<String>是该维度下的候选标签值列表

3.4 TagTreeLevelParam(多级标签识别)

字段名类型必填说明
tagIdsList<Long>是运行时传入的标签 ID 列表。取第一个 ID 作为已命中的起始父标签,从其子节点开始继续匹配
tagTreeLevelsList<TagTreeLevelInfoParam>是每一级的 prompt 配置列表,按层级顺序排列

TagTreeLevelInfoParam 结构:

字段名类型必填说明
tagTreeIdsList<Long>是当前层候选标签 ID 列表。包含 -1 表示全选(即匹配该层所有标签)
promptString是该层级的分析 prompt,与标签数据拼接后发送给大模型进行分析

3.5 CustomPromptParam(自定义指令)

字段名类型必填说明
customPromptString是用户自定义的 prompt 指令内容
nameDescPairListList<NameDescPair>否自定义字段列表,用于在 prompt 中引用的额外变量

NameDescPair 结构同 3.1。


4. 请求示例

{
  "id": 123,
  "userGroup": "default",
  "aliUid": 1000000001,
  "agentName": "客服质检 Agent",
  "agentDescription": "用于客服对话质量的自动检测",
  "modelType": "qwen-max",
  "inputType": "text",
  "instructionType": "serviceInspection",
  "instructionTypeParam": {
    "serviceInspectionParam": {
      "sceneName": "售后客服场景",
      "sceneDescription": "检查售后客服对话的服务质量",
      "dimensions": [
        {
          "dimension": "服务态度",
          "desc": "检查客服是否使用礼貌用语",
          "includeCondition": "包含问候语和感谢语",
          "excludeCondition": "无明显不当用语则不排除"
        }
      ]
    }
  }
}

返回参数

名称

类型

描述

示例值

object

Schema of Response

RequestId

string

Id of the request

4987D326-83D9-4A42-B9A5-0B27F9B40539

Code

string

状态码,200 表示正常

200

Message

string

如果有错误,会输出错误信息

successful

Success

boolean

请求是否成功,调用方可根据此字段来判断请求是否成功:true 表示成功;false/null 表示失败。

true

Data

boolean

返回结果

true

示例

正常返回示例

JSON格式

{
  "RequestId": "4987D326-83D9-4A42-B9A5-0B27F9B40539",
  "Code": "200",
  "Message": "successful",
  "Success": true,
  "Data": true
}

错误码

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

变更历史

更多信息,参考变更详情。