ExecuteAgent - 运行Agent

更新时间:
复制 MD 格式

运行Agent

调试

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

调试

授权信息

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

请求语法

POST  HTTP/1.1

请求参数

名称

类型

必填

描述

示例值

BaseMeAgentId

integer

业务空间 Id

123456

JsonStr

string

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

""

Stream

boolean

true 则会开启 SSE 响应,默认 false

false

1. 概述

使用场景: 调用 ExecuteAgent 接口时,将本类各字段序列化为 JSON 传入。服务端根据 instructionType 路由到不同的指令处理器(关键属性抽取/服务质检/标签分类等)。

2. 顶层字段说明

字段名类型必填说明
vidString会话 ID,若未传入则使用当前时间戳自动生成
modelTypeString大模型类型,
agentIdLongAgent 配置 ID
inputTypeString分析对象类型:text-文本
instructionTypeString指令类型: serviceInspection-服务质检,field-关键属性抽取,tagCategory-标签分类,customPrompt-自定义指令
instructionTypeParamInstructionTypeParam指令类型对应的参数,不同 instructionType 需要不同的子参数(详见 §4.1)
taskParamTaskParam任务数据参数,包含文本对话或音频文件信息(详见 §3.1)

3. 嵌套类详细说明

3.1 TaskParam — 任务数据参数

AgentTaskParam.TaskParam 承载本次任务的输入数据,根据 inputType 的不同,使用不同的子参数。

字段名类型说明
textParamTextParam文本参数,当 inputType = "text" 时使用
callbackUrlString任务完成后的回调通知地址(可选)

3.2 TextParam — 文本参数

AgentTaskParam.TextParam 封装文本类型的输入数据。

字段名类型说明
dialogueList<Dialogue>对话列表,每条评论为一个 Dialogue 对象

Dialogue 对象结构:

字段名类型必填说明
roleString说话角色,如 "客户" / "客服"
wordsString对话文本内容
identityString说话人身份标识(如客服工号)
beginLong本句开始时间相对偏移量(毫秒)
endLong本句结束时间相对偏移量(毫秒)
beginTimeDate本句开始绝对时间(yyyy-MM-dd HH:mm:ss
hourMinSecString时分秒格式(HH:mm:ss),电话场景必填
emotionValueInteger情绪能量值(1-10)
speechRateInteger语速值(每分钟字数)
silenceDurationInteger静音时长(秒)

4. InstructionTypeParam — 指令参数详细说明

AgentManageParam.InstructionTypeParam 根据不同的 instructionType 承载不同的指令配置参数。只需填写与当前 instructionType 对应的子参数,其余字段留空即可。

4.1 FieldsParam — 关键属性抽取(instructionType = "field"

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

NameDescPair 结构:

字段名类型说明
nameString属性名称(必填)
descString属性描述(可选)

4.2 ServiceInspectionParam — 服务质检(instructionType = "serviceInspection"

字段名类型必填说明
sceneNameString质检场景名称
sceneDescriptionString质检场景描述
dimensionsList<Dimension>质检维度列表

Dimension 结构:

字段名类型说明
dimensionString维度名称(必填)
descString维度描述(可选)

4.3 TagCategoryParam — 标签分类(instructionType = "tagCategory"

字段名类型必填说明
nameDescPairListList<NameDescValueListPair>标签分类维度列表

NameDescValueListPair 结构:

字段名类型说明
nameString维度名称
descString维度描述
valueListList<String>候选标签值列表

4.4 CustomPrompt — 自定义指令(instructionType = "customPrompt"

字段名类型必填说明
customPromptString用户自定义的 prompt 模板内容

返回参数

名称

类型

描述

示例值

object

Schema of Response

RequestId

string

Id of the request

F190ADE9-619A-447D-84E3-7E241A5C428E

Code

string

状态码,200 表示正常

200

Message

string

错误的时候,返回错误信息

successful

Success

boolean

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

true

Data

object

返回结果

LlmRequestId

string

大模型服务返回的 requestId

106C6CA0-282D-4AF7-85F0-D2D24***

FinishReason

string

如果是流式输出,正在生成时为 null,生成结束时如果由于停止 token 导致则为 stop。

stop

Text

string

大模型返回的结果。

这段对话似乎是客服与客户之间关于一个服务或产品的讨论,但具体内容难以明确理解,因为对话中的言语比较零散和抽象。

InputTokens

integer

输入 Token 数量

100

OutputTokens

integer

输出 Token 数量

200

TotalTokens

integer

总 Token 数量

300

TyxmTurboCount

string

turbo 模型使用次数

1

TyxmPlusCount

string

plus 模型使用次数

1

示例

正常返回示例

JSON格式

{
  "RequestId": "F190ADE9-619A-447D-84E3-7E241A5C428E",
  "Code": "200",
  "Message": "successful",
  "Success": true,
  "Data": {
    "LlmRequestId": "106C6CA0-282D-4AF7-85F0-D2D24***",
    "FinishReason": "stop",
    "Text": "这段对话似乎是客服与客户之间关于一个服务或产品的讨论,但具体内容难以明确理解,因为对话中的言语比较零散和抽象。",
    "InputTokens": 100,
    "OutputTokens": 200,
    "TotalTokens": 300,
    "TyxmTurboCount": "1",
    "TyxmPlusCount": "1"
  }
}

错误码

HTTP status code

错误码

错误信息

描述

400 InvalidParam Invalid Param %s . 参数不合法

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

变更历史

更多信息,参考变更详情