Agent
智能体
被如下接口引用:DescribeAgents。
| 名称 | 类型 | 必选 | 描述 |
|---|---|---|---|
| AgentId | String | 否 | 智能体Id 示例值:agt-xpcn2t3e |
| AgentName | String | 否 | 智能体名称 示例值:风险SQL治理智能体 |
| AgentInternalName | String | 否 | 智能体类型 示例值:aid |
| AgentStatus | String | 否 | 智能体状态 示例值:normal |
| DefaultVersion | String | 否 | 默认版本 示例值:v1.0.0.0 |
| AgentType | String | 否 | 智能体模式 示例值:service |
| Description | String | 否 | 描述 示例值:风险SQL治理智能体是一个专注于治理代码中的风险SQL的智能体 |
| Creator | String | 否 | 创建者 示例值:user |
| CreateTime | String | 否 | 创建时间 示例值:2025-07-15 16:06:10 |
| Updater | String | 否 | 更新者 示例值:user |
| UpdateTime | String | 否 | 更新时间 示例值:2025-07-15 16:06:10 |
AgentInstance
智能体实例
被如下接口引用:DescribeAgentInstance, DescribeAgentInstances。
| 名称 | 类型 | 必选 | 描述 |
|---|---|---|---|
| InstanceId | String | 否 | 智能体实例ID 示例值:agentins-efbt5y3h |
| InstanceName | String | 否 | 智能体实例名称 示例值:风险SQL治理Agent实例 |
| AgentId | String | 否 | 智能体ID 示例值:agt-xpcn2t3e |
| AgentName | String | 否 | 智能体名称 示例值:风险SQL治理智能体 |
| AgentInternalName | String | 否 | 智能体类型 示例值:aid |
| AgentType | String | 否 | 智能体服务模式 示例值:service |
| AgentVersion | String | 否 | 智能体版本 示例值:v1.0.0.0 |
| Status | String | 否 | 智能体实例状态 示例值:running |
| Parameters | Array of Parameter | 否 | 智能体实例参数列表 |
| CreateTime | String | 否 | 创建时间 示例值:2025-07-15 16:06:10 |
| UpdateTime | String | 否 | 修改时间 示例值:2025-07-15 16:06:10 |
| Tags | Array of TagItem | 否 | 资源绑定Tag列表 |
ChatBrief
会话信息
被如下接口引用:DescribeChats。
| 名称 | 类型 | 必选 | 描述 |
|---|---|---|---|
| AppId | Integer | 否 | 主账号Id 示例值:13579 |
| Uin | String | 否 | 主账号uin 示例值:13579 |
| OwnerUin | String | 否 | 子账号uin 示例值:13579 |
| InstanceId | String | 否 | 智能体实例ID 示例值:agtins-xxxxxxxx |
| ChatId | String | 否 | 会话ID 示例值:chat-xxxxxxxx |
| CreateTime | Integer | 否 | 创建时间 示例值:13579 |
| Title | String | 否 | 会话标题 示例值:你好 |
| Status | String | 否 | 会话状态 示例值:running |
| LastStreamingId | String | 否 | 最后一条流式ID 示例值:strm-xxxxxxxx |
| LastStreamingTokenId | Integer | 否 | 最后一条流式TokenID 示例值:0 |
ChatDetail
会话详情
被如下接口引用:DescribeChatDetail。
| 名称 | 类型 | 描述 |
|---|---|---|
| Role | String | 角色 示例值:user |
| UserMessage | String | 用户消息 示例值:帮我查询最近一个月的历史任务 |
| AssistantMessage | Array of CreateChatCompletionRes | 助手消息 注意:此字段可能返回 null,表示取不到有效值。 |
CodeRepo
仓库信息
被如下接口引用:ModifyAgentInstanceParameters。
| 名称 | 类型 | 必选 | 描述 |
|---|---|---|---|
| RepoUrl | String | 是 | 代码仓库地址 示例值:https://git.woa.com/calvinliao/tcs-middleware |
| Branch | String | 是 | 分支名 示例值:master |
| GitCommitPipelines | Array of String | 否 | Commit信息 示例值:["bdbe54afaa7e60b11cd87682bd9ab59c92a489ac"] |
| GitORMType | String | 否 | 数据库ORM类型 示例值:goframe |
| GitCodeLanguage | String | 否 | 代码编写语言 示例值:golang |
CreateChatCompletionRes
对话接口出参
被如下接口引用:DescribeChatDetail。
| 名称 | 类型 | 描述 |
|---|---|---|
| Object | String | 枚举值,返回的数据类型 示例值:chat.completion.chunk |
| Created | Integer | 消息时间戳 示例值:1677652281 |
| Model | String | 输出模型 示例值:DeepSeek-R1 |
| AppId | Integer | 用户标识 示例值:124789 |
| OwnerUin | String | 主账户标识 示例值:13579 |
| Uin | String | 当前账户标识 示例值:13579 |
| RequestId | String | Request ID 示例值:xxxx-xxxx-xxxx |
| ChatId | String | 当前会话ID 示例值:chat-1357911 |
| StreamingId | String | 当前流ID 示例值:strm-11111111 |
| TaskId | String | 当前任务ID 示例值:任务ID |
| Choices | Array of UploadChoice | 消息的数据详情 |
InstanceInfos
实例信息
被如下接口引用:ModifyAgentInstanceParameters。
| 名称 | 类型 | 必选 | 描述 |
|---|---|---|---|
| Region | String | 是 | 数据库地域 示例值:ap-guangzhou |
| InstanceId | String | 是 | 数据库实例id 示例值:cdb-jgmilzl8 |
| DatabaseName | String | 否 | 数据库名称 示例值:test_database |
| TableName | String | 否 | 表名称 示例值:test_table |
Parameter
智能体实例的参数值
被如下接口引用:CreateAgentInstance, DescribeAgentDutyTaskDetail, DescribeAgentInstance, DescribeAgentInstances, ModifyAgentInstanceParameters。
| 名称 | 类型 | 必选 | 描述 |
|---|---|---|---|
| Key | String | 是 | 参数键 注意:此字段可能返回 null,表示取不到有效值。 示例值:git_branch |
| Value | String | 是 | 参数值 注意:此字段可能返回 null,表示取不到有效值。 示例值:master |
| ValueType | String | 是 | 枚举值,可取值包括:string(字符串), int(整型), float(浮点型), bool(布尔型), struct(结构体), array(数组), 注意:此字段可能返回 null,表示取不到有效值。 示例值:string |
SqlAgentParameter
风险SQL智能体参数
被如下接口引用:ModifyAgentInstanceParameters。
| 名称 | 类型 | 必选 | 描述 |
|---|---|---|---|
| InstanceInfos | Array of InstanceInfos | 否 | 数据库实例信息列表 |
| CodeRepo | CodeRepo | 否 | 代码仓库信息 |
TagFilter
通过标签对资源进行过滤
被如下接口引用:DescribeAgentInstances。
| 名称 | 类型 | 必选 | 描述 |
|---|---|---|---|
| TagKey | String | 否 | 标签键 示例值:负责人 |
| TagValue | Array of String | 否 | 标签值 示例值:["bob"] |
TagItem
资源标签
被如下接口引用:CreateAgentInstance, DescribeAgentInstance, DescribeAgentInstances。
| 名称 | 类型 | 必选 | 描述 |
|---|---|---|---|
| TagKey | String | 否 | 标签键 示例值:负责人 |
| TagValue | String | 否 | 标签值 示例值:bob |
UploadChoice
流式输出消息数据体
被如下接口引用:DescribeChatDetail。
| 名称 | 类型 | 描述 |
|---|---|---|
| Index | Integer | 消息索引 示例值:0 |
| StepNo | Integer | 当前消息步骤 示例值:1 |
| CurrentStep | String | 当前步骤 示例值:数据处理 |
| Delta | UploadDelta | 增量信息 |
| FinishReason | String | 结束原因 示例值:stop |
| ErrorMessage | String | 错误信息,FinishReason为error时有效 示例值:error |
UploadDelta
流式接口当前消息数据详细内容
被如下接口引用:DescribeChatDetail。
| 名称 | 类型 | 描述 |
|---|---|---|
| StepBrief | String | 步骤摘要 示例值:正在进行数据处理 |
| Content | String | 步骤详情 示例值:正在处理第一条数据 |