数据结构

最近更新时间:2026-02-02 02:22:20

我的收藏

AICallConfig

智能通话

被如下接口引用:DescribeApp, ModifyApp。

名称 类型 必选 描述
EnableVoiceInteract Boolean 启用语音互动功能
注意:此字段可能返回 null,表示取不到有效值。
示例值:false
EnableVoiceCall Boolean 启用语音通话
注意:此字段可能返回 null,表示取不到有效值。
示例值:false
EnableDigitalHuman Boolean 启用数智人
注意:此字段可能返回 null,表示取不到有效值。
示例值:false
Voice VoiceConfig 音色配置
注意:此字段可能返回 null,表示取不到有效值。
示例值:
DigitalHuman DigitalHumanConfig 数智人配置
注意:此字段可能返回 null,表示取不到有效值。
示例值:

Agent

Agent 的定义

被如下接口引用:DescribeAppAgentList。

名称 类型 必选 描述
AgentId String AgentID
示例值:test-agent-id
WorkflowId String WorkflowID,非空则当前Agent从workflow转换而来
示例值:test-workflow-id
Name String Agent名称,同一个应用内,Agent名称不能重复
示例值:挂号Agent
IconUrl String Agent图标url
示例值:https://example.com/image/icon
Instructions String Agent指令;当该Agent被调用时,将作为“系统提示词”使用,描述Agent应执行的操作和响应方式
示例值:帮我完成开发票
HandoffDescription String 当Agent作为转交目标时的描述,用于让其他Agent的LLM理解其功能和转交时机
示例值:我可以开发票
Handoffs Array of String Agent可转交的子AgentId列表
示例值:["agent-id1", "agent-id2"]
Model AgentModelInfo Agent调用LLM时使用的模型配置
Tools Array of AgentToolInfo Agent可使用的工具列表
Plugins Array of AgentPluginInfo Agent可使用的插件列表
IsStartingAgent Boolean 当前Agent是否是启动Agent
示例值:false
AgentType Integer Agent类型; 0: 未指定类型; 1: 知识库检索Agent
示例值:0
AgentMode Integer 0 自由转交,1 计划与执行
示例值:0
AdvancedConfig AgentAdvancedConfig 高级设置

AgentAdvancedConfig

Agent高级设置

被如下接口引用:DescribeAppAgentList。

名称 类型 必选 描述
EnableClarification Boolean 是否开启澄清询问
示例值:false
ThinkingMode Integer 思考模式,0为效果优先,1为速度优先
示例值:0
MaxReasoningRound Integer 最大推理轮数
示例值:10
HistoryLimit Integer 上下文轮数
示例值:10
EnableStructuredOutput Boolean 是否开启结构化输出
示例值:false
StructuredOutputConfig StructuredOutputConfig 结构化输出配置
AgentOutputConfig AgentOutputConfig Agent输出配置
ClarificationConfig ClarificationConfig 澄清询问配置

AgentDebugInfo

Agent调试信息

被如下接口引用:GetMsgRecord。

名称 类型 必选 描述
Input String 工具、大模型的输入信息,json
注意:此字段可能返回 null,表示取不到有效值。
示例值:输入
Output String 工具、大模型的输出信息,json
注意:此字段可能返回 null,表示取不到有效值。
示例值:输出
ModelName String 模型名
示例值:模型名

AgentHandoffAdvancedSetting

Agent转交高级设置

被如下接口引用:DescribeAppAgentList。

名称 类型 必选 描述
ConversationPolicy Integer 对话流转策略;0-由上一轮回复用户的 Agent 继续发起,1- 回到主Agent
示例值:0

AgentInput

Agent输入值,支持直接赋值和引用

被如下接口引用:DescribeAppAgentList。

名称 类型 必选 描述
InputType Integer 输入来源类型:0 用户输入,3 自定义变量(API参数)
示例值:0
UserInputValue AgentInputUserInputValue 用户手写输入
CustomVarId String 自定义变量(API参数)
示例值:9sde32de-d2ae-4a26-839c-6b6c6d0ea4d7
EnvVarId String 环境变量参数
示例值:9sde32de-d2ae-4a26-839c-6b6c6d0ea4d7
AppVarId String 应用变量参数
示例值:27d332de-d2ae-4a26-839c-6b6c6d0ea4d7
SystemVariable AgentInputSystemVariable 系统参数
ToolParam String 工具参数
示例值:query

AgentInputSystemVariable

系统参数

被如下接口引用:DescribeAppAgentList。

名称 类型 必选 描述
Name String 系统参数名
示例值:sdhge
DialogHistoryLimit Integer 对话历史轮数的配置;如果Input是系统变量中的“对话历史”时才使用;
示例值:3

AgentInputUserInputValue

用户手写输入

被如下接口引用:DescribeAppAgentList。

名称 类型 必选 描述
Values Array of String 用户输入的值
示例值:['text']

AgentKnowledge

Agent 知识库检索插件支持多知识库搜索

被如下接口引用:DescribeAppAgentList。

名称 类型 必选 描述
KnowledgeBizId String 知识库id
示例值:"1932739306311112222"
KnowledgeType Integer 0-应用内知识库
1-共享知识库
示例值:1
Filter Integer 0-全部知识
1-按文档和问答
2-按标签
示例值:1
DocBizIds Array of String 文档id
示例值:"1933511741231456800"
AllQa Boolean true:包含所有问答
false:不包含问答
示例值:true
Tag AgentKnowledgeFilterTag 文档标签过滤器

AgentKnowledgeAttrLabel

标签过滤器

被如下接口引用:DescribeAppAgentList。

名称 类型 必选 描述
AttributeBizId String 属性ID
示例值:1922991044897213888
Inputs Array of AgentInput 标签值,标签值之间是或的关系,只有匹配的,才会进行知识检索,否则报检索不到

AgentKnowledgeFilter

知识检索筛选范围

被如下接口引用:DescribeAppAgentList。

名称 类型 必选 描述
FilterType Integer 知识检索筛选方式; 0: 全部知识; 1:按文档和问答; 2: 按标签
示例值:0
DocAndAnswer AgentKnowledgeFilterDocAndAnswer 文档和问答过滤器
Tag AgentKnowledgeFilterTag 标签过滤器
KnowledgeList Array of AgentKnowledge 知识库列表
AllKnowledge Boolean 是否检索全部知识
示例值:true

AgentKnowledgeFilterDocAndAnswer

文档和问答过滤器

被如下接口引用:DescribeAppAgentList。

名称 类型 必选 描述
DocBizIds Array of String 文档ID列表
示例值:["1923271504777045952"]
AllQa Boolean 问答
示例值:false

AgentKnowledgeFilterTag

标签过滤器

被如下接口引用:DescribeAppAgentList。

名称 类型 必选 描述
Operator Integer 标签之间的关系;0:AND, 1:OR
示例值:1
Labels Array of AgentKnowledgeAttrLabel 标签

AgentKnowledgeQAPlugin

知识库问答插件

被如下接口引用:DescribeAppAgentList。

名称 类型 必选 描述
Filter AgentKnowledgeFilter 知识检索筛选范围

AgentMCPServerInfo

mcp的服务信息

被如下接口引用:DescribeAppAgentList。

名称 类型 必选 描述
McpServerUrl String mcp server URL地址
示例值:http://xxxx
Headers Array of AgentPluginHeader mcp server header信息
Timeout Integer 超时时间,单位秒
示例值:5
SseReadTimeout Integer sse服务超时时间,单位秒
示例值:300
Query Array of AgentPluginQuery mcp server query信息

AgentModelInfo

Agent 配置里面的模型定义

被如下接口引用:DescribeAppAgentList。

名称 类型 必选 描述
ModelName String 模型名称
示例值:function call pro
ModelAliasName String 模型别名
示例值:精调Function-call模型
Temperature Float 模型温度
示例值:0.5
TopP Float 模型TopP
示例值:0.5
IsEnabled Boolean 模型是否可用
示例值:true
HistoryLimit Integer 对话历史条数限制
示例值:5
ModelContextWordsLimit String 模型上下文长度字符限制
示例值:8k
InstructionsWordsLimit Integer 指令长度字符限制
示例值:4096
MaxReasoningRound Integer 单次会话最大推理轮数
示例值:10
ModelParams ModelParams 模型参数

AgentOutputConfig

Agent输出配置

被如下接口引用:DescribeAppAgentList。

名称 类型 必选 描述
OutputType Integer 输出类型,1-文本 2-json 3-widget
示例值:1
StructuredOutputParams Array of ParameterConfig Json结构化输出参数列表
WidgetId String widget id
示例值:test-widget-id

AgentPluginHeader

应用配置MCP插件header信息

被如下接口引用:DescribeAppAgentList。

名称 类型 必选 描述
ParamName String 参数名称
ParamValue String 参数值
GlobalHidden Boolean header参数配置是否隐藏不可见
示例值:false
Input AgentInput 输入的值
IsRequired Boolean 参数是否可以为空
示例值:true

AgentPluginInfo

Agent 的插件信息

被如下接口引用:DescribeAppAgentList。

名称 类型 必选 描述
PluginId String 插件id
示例值:0960ae93-80a0-408d-928b-f484064f834a
Headers Array of AgentPluginHeader 应用配置的插件header信息
Model AgentModelInfo 插件调用LLM时使用的模型配置,一般用于指定知识库问答插件的生成模型
PluginInfoType Integer 插件信息类型; 0: 未指定类型; 1: 知识库问答插件
示例值:0
KnowledgeQa AgentKnowledgeQAPlugin 知识库问答插件配置
EnableRoleAuth Boolean 是否使用一键授权
注意:此字段可能返回 null,表示取不到有效值。
示例值:false
Query Array of AgentPluginQuery 应用配置的插件query信息
McpType Integer MCP类型
示例值:0

AgentPluginQuery

应用配置MCP插件query信息

被如下接口引用:DescribeAppAgentList。

名称 类型 必选 描述
ParamName String 参数名称
ParamValue String 参数值
GlobalHidden Boolean query参数配置是否隐藏不可见,true-隐藏不可见,false-可见
示例值:false
IsRequired Boolean 参数是否可以为空
示例值:true
Input AgentInput 输入的值

AgentProcedure

思考事件过程信息

被如下接口引用:GetMsgRecord。

名称 类型 必选 描述
Index Integer 索引
注意:此字段可能返回 null,表示取不到有效值。
示例值:0
Name String 执行过程英语名
注意:此字段可能返回 null,表示取不到有效值。
示例值:thought
Title String 中文名, 用于展示
注意:此字段可能返回 null,表示取不到有效值。
示例值:思考
Status String 状态常量: 使用中: processing, 成功: success, 失败: failed
注意:此字段可能返回 null,表示取不到有效值。
示例值:processing
Icon String 图标
注意:此字段可能返回 null,表示取不到有效值。
示例值:https://lke-realtime-1251316161.cos.ap-guangzhou.myqcloud.com/icon%2Fthinking.png
Debugging AgentProcedureDebugging Agent调试信息
注意:此字段可能返回 null,表示取不到有效值。
Switch String 是否切换Agent,取值为"main"或者"workflow",不切换为空
注意:此字段可能返回 null,表示取不到有效值。
示例值:"main"
WorkflowName String 工作流名称
注意:此字段可能返回 null,表示取不到有效值。
示例值:开发票
Elapsed Integer 当前请求执行时间, 单位 ms
注意:此字段可能返回 null,表示取不到有效值。
示例值:1200
NodeName String 工作流节点名称
注意:此字段可能返回 null,表示取不到有效值。
示例值:大模型1
ReplyIndex Integer 用于展示思考放在哪个回复气泡中
注意:此字段可能返回 null,表示取不到有效值。
示例值:0
SourceAgentName String 主agent
注意:此字段可能返回 null,表示取不到有效值。
示例值:转交出去的agent
TargetAgentName String 挂号agent
注意:此字段可能返回 null,表示取不到有效值。
示例值:接受方agent
AgentIcon String Agent的图标
注意:此字段可能返回 null,表示取不到有效值。
示例值:智能体头像

AgentProcedureDebugging

Agent思考过程调试信息

被如下接口引用:GetMsgRecord。

名称 类型 必选 描述
Content String 模型思考内容
注意:此字段可能返回 null,表示取不到有效值。
示例值:1
DisplayContent String 展示的具体文本内容
注意:此字段可能返回 null,表示取不到有效值。
示例值:1
DisplayType Integer 1:搜索引擎参考来源;2:知识库参考来源
注意:此字段可能返回 null,表示取不到有效值。
示例值:1
QuoteInfos Array of QuoteInfo 搜索引擎展示的索引
注意:此字段可能返回 null,表示取不到有效值。
References Array of AgentReference 具体的参考来源
注意:此字段可能返回 null,表示取不到有效值。
DisplayStatus String 展示正在执行的状态
注意:此字段可能返回 null,表示取不到有效值。
示例值:正在浏览网页
SandboxUrl String 云桌面的URL地址
注意:此字段可能返回 null,表示取不到有效值。
示例值:沙盒地址
DisplayUrl String 云桌面里面通过浏览器打开的URL地址
注意:此字段可能返回 null,表示取不到有效值。
示例值:https://www.qq.com

AgentReference

Agent中的参考来源

被如下接口引用:GetMsgRecord。

名称 类型 必选 描述
DocId String 来源文档ID
注意:此字段可能返回 null,表示取不到有效值。
示例值:来源文档ID
Id String id
注意:此字段可能返回 null,表示取不到有效值。
示例值:id
Name String 名称
注意:此字段可能返回 null,表示取不到有效值。
示例值:名称
Type Integer 类型
注意:此字段可能返回 null,表示取不到有效值。
示例值:2
Url String 链接
注意:此字段可能返回 null,表示取不到有效值。
示例值:链接
DocBizId String 文档业务ID
注意:此字段可能返回 null,表示取不到有效值。
示例值:文档业务ID
DocName String 文档名称
注意:此字段可能返回 null,表示取不到有效值。
示例值:文档名称
QaBizId String 问答业务ID
注意:此字段可能返回 null,表示取不到有效值。
示例值:问答业务ID
Index Integer 搜索引擎索引
注意:此字段可能返回 null,表示取不到有效值。
示例值:1
Title String 标题
注意:此字段可能返回 null,表示取不到有效值。
示例值:标题
KnowledgeName String 知识库名称
注意:此字段可能返回 null,表示取不到有效值。
示例值:知识库名称
KnowledgeBizId String 知识库标识
注意:此字段可能返回 null,表示取不到有效值。
示例值:知识库标识

AgentThought

Agent的思考过程

被如下接口引用:GetMsgRecord。

名称 类型 描述
SessionId String 会话 ID
注意:此字段可能返回 null,表示取不到有效值。
示例值:b15e055c-0474-4436-8354-01bebd6352fc
RequestId String 请求 ID
注意:此字段可能返回 null,表示取不到有效值。
示例值:f786dd5d-9344-4429-aee3-a8a69b097e25
RecordId String 对应哪条会话, 会话 ID, 用于回答的消息存储使用, 可提前生成, 保存消息时使用
注意:此字段可能返回 null,表示取不到有效值。
示例值:f5F_20241211_224302_971_VDRZO1s2
Elapsed Integer 当前请求执行时间, 单位 ms
注意:此字段可能返回 null,表示取不到有效值。
示例值:1000
IsWorkflow Boolean 当前是否为工作流
注意:此字段可能返回 null,表示取不到有效值。
示例值:false
WorkflowName String 如果当前是工作流,工作流名称
注意:此字段可能返回 null,表示取不到有效值。
示例值:开发票
Procedures Array of AgentProcedure 具体思考过程详情
注意:此字段可能返回 null,表示取不到有效值。
TraceId String TraceId
注意:此字段可能返回 null,表示取不到有效值。
示例值:42c49c90e1a6e29276684fad2bbd68f9 / rZZ_20250910_202901_009_HrjaMfAq
Files Array of FileInfo 文件信息
注意:此字段可能返回 null,表示取不到有效值。

AgentToolInfo

Agent的工具信息

被如下接口引用:DescribeAppAgentList。

名称 类型 必选 描述
PluginId String 插件id
示例值:0960ae93-80a0-408d-928b-f484064f833h
PluginName String 插件名称
示例值:天气
IconUrl String 插件图标url
示例值:http://xxxx.jpg
PluginType Integer 0 自定义插件
1 官方插件
2 第三方插件 目前用于第三方实现的mcp server
示例值:1
ToolId String 工具id
示例值:0960ae93-80a0-408d-928b-f484064f834a
ToolName String 工具名称
示例值:GetWeatherInfo
ToolDesc String 工具描述
示例值:获取指定日期和地点的天气信息
Inputs Array of AgentToolReqParam 输入参数
Outputs Array of AgentToolRspParam 输出参数
CreateType Integer 创建方式,0:服务创建,1:代码创建,2:MCP创建
示例值:0
McpServer AgentMCPServerInfo MCP插件的配置信息
IsBindingKnowledge Boolean 该工具是否和知识库绑定
示例值:false
Status Integer 插件状态,1:可用,2:不可用
示例值:1
Headers Array of AgentPluginHeader header信息
CallingMethod String NON_STREAMING: 非流式 STREAMIN: 流式
注意:此字段可能返回 null,表示取不到有效值。
示例值:NON_STREAMING
Query Array of AgentPluginQuery query信息
FinanceStatus Integer 工具计费状态 0-不计费 1-可用 2-不可用(欠费、无资源等)
示例值:0
ToolSource Integer 工具来源: 0-来自插件,1-来自工作流
示例值:0
FinanceType Integer 计费状态;0-不计费,1-限时免费,2-官方收费
示例值:0
ToolAdvanceConfig ToolAdvanceConfig 工具高级设置
AuthMode Integer 授权模式; 0-开发者授权;1-使用者授权
示例值:1
AuthType Integer 授权类型; 0-无鉴权;1-APIKey;2-CAM授权;3-Oauth2.0授权;
示例值:0

AgentToolReqParam

Agent工具的请求参数定义

被如下接口引用:DescribeAppAgentList。

名称 类型 必选 描述
Name String 参数名称
示例值:姓名
Desc String 参数描述
示例值:人物名字
Type Integer 参数类型,0:string, 1:int, 2:float,3:bool 4:object 5:array_string, 6:array_int, 7:array_float, 8:array_bool, 9:array_object
示例值:0
IsRequired Boolean 参数是否必填
示例值:false
DefaultValue String 参数默认值
示例值:张三
SubParams Array of AgentToolReqParam 子参数,ParamType 是OBJECT 或 ARRAY<>类型有用
GlobalHidden Boolean 是否隐藏不可见
示例值:false
AgentHidden Boolean agent模式下模型是否可见
示例值:false
AnyOf Array of AgentToolReqParam 其中任意
OneOf Array of AgentToolReqParam 其中一个
Input AgentInput 输入

AgentToolRspParam

Agent工具的响应参数定义

被如下接口引用:DescribeAppAgentList。

名称 类型 必选 描述
Name String 参数名称
示例值:姓名
Desc String 参数描述
示例值:人物名字
Type Integer 参数类型,0:string, 1:int, 2:float,3:bool 4:object 5:array_string, 6:array_int, 7:array_float, 8:array_bool, 9:array_object
示例值:0
SubParams Array of AgentToolRspParam 子参数,ParamType 是OBJECT 或 ARRAY<>类型有用
AgentHidden Boolean agent模式下模型是否可见
示例值:false
GlobalHidden Boolean 是否隐藏不可见
示例值:false
AnalysisMethod String COVER: 覆盖解析 INCREMENT:增量解析
示例值:COVER

ApiVarAttrInfo

自定义变量和标签关系数据

被如下接口引用:DescribeApp, ModifyApp。

名称 类型 必选 描述
ApiVarId String 自定义变量id
注意:此字段可能返回 null,表示取不到有效值。
AttrBizId String 标签id
注意:此字段可能返回 null,表示取不到有效值。

AppBaseInfo

应用基础信息

被如下接口引用:DescribeSharedKnowledge, ListSharedKnowledge。

名称 类型 必选 描述
AppBizId String 应用ID
示例值:1908652910168703264
AppName String 应用名称
注意:此字段可能返回 null,表示取不到有效值。
示例值:共享知识库应用1

AppConfig

应用配置

被如下接口引用:DescribeApp, ModifyApp。

名称 类型 必选 描述
KnowledgeQa KnowledgeQaConfig 知识问答管理应用配置
注意:此字段可能返回 null,表示取不到有效值。
Summary SummaryConfig 知识摘要应用配置
注意:此字段可能返回 null,表示取不到有效值。
Classify ClassifyConfig 标签提取应用配置
注意:此字段可能返回 null,表示取不到有效值。

AppInfo

应用详情

被如下接口引用:ListApp。

名称 类型 必选 描述
AppType String 应用类型;knowledge_qa-知识问答管理;summary-知识摘要;classifys-知识标签提取
注意:此字段可能返回 null,表示取不到有效值。
示例值:knowledge_qa
AppTypeDesc String 应用类型描述
注意:此字段可能返回 null,表示取不到有效值。
示例值:知识库应用
AppBizId String 应用ID
注意:此字段可能返回 null,表示取不到有效值。
示例值:1932370484353927616
Name String 应用名称
注意:此字段可能返回 null,表示取不到有效值。
示例值:我的应用
Avatar String 应用头像
注意:此字段可能返回 null,表示取不到有效值。
示例值:头像地址
Desc String 应用描述
注意:此字段可能返回 null,表示取不到有效值。
示例值:应用描述信息
AppStatus Integer 应用状态,1:未上线,2:运行中,3:停用
注意:此字段可能返回 null,表示取不到有效值。
示例值:1
AppStatusDesc String 状态说明
注意:此字段可能返回 null,表示取不到有效值。
示例值:未上线
UpdateTime String 修改时间
注意:此字段可能返回 null,表示取不到有效值。
示例值:1753254304
Operator String 最后修改人
注意:此字段可能返回 null,表示取不到有效值。
示例值:操作人
ModelName String 模型名称
注意:此字段可能返回 null,表示取不到有效值。
示例值:cs-nomal-70b
ModelAliasName String 生成模型别名
注意:此字段可能返回 null,表示取不到有效值。
示例值: 精调知识大模型高级版
Pattern String 应用模式 standard:标准模式, agent: agent模式,single_workflow:单工作流模式
注意:此字段可能返回 null,表示取不到有效值。
示例值:standard
ThoughtModelAliasName String 思考模型别名
注意:此字段可能返回 null,表示取不到有效值。
示例值:思考模型高级版
PermissionIds Array of String 权限位信息
示例值:["adpAppEdit"]
Creator String 创建人昵称
注意:此字段可能返回 null,表示取不到有效值。
示例值:创建人

AppModel

应用模型配置

被如下接口引用:DescribeApp, ModifyApp。

名称 类型 必选 描述
Name String 模型名称
注意:此字段可能返回 null,表示取不到有效值。
Desc String 模型描述
注意:此字段可能返回 null,表示取不到有效值。
ContextLimit Integer 上下文指代轮次
注意:此字段可能返回 null,表示取不到有效值。
AliasName String 模型别名
注意:此字段可能返回 null,表示取不到有效值。
TokenBalance Float token余量
注意:此字段可能返回 null,表示取不到有效值。
IsUseContext Boolean 是否使用上下文指代轮次
注意:此字段可能返回 null,表示取不到有效值。
HistoryLimit Integer 上下文记忆轮数
注意:此字段可能返回 null,表示取不到有效值。
UsageType String 使用类型
注意:此字段可能返回 null,表示取不到有效值。
Temperature String 模型温度
注意:此字段可能返回 null,表示取不到有效值。
TopP String 模型TopP
注意:此字段可能返回 null,表示取不到有效值。
ResourceStatus Integer 模型资源状态 1:资源可用;2:资源已用尽
注意:此字段可能返回 null,表示取不到有效值。
ModelParams ModelParams 模型参数
注意:此字段可能返回 null,表示取不到有效值。

AppModelDetailInfo

模型详情

被如下接口引用:DescribeApp, ModifyApp。

名称 类型 必选 描述
ModelName String 模型名称
ModelParams ModelParams 模型参数
HistoryLimit Integer 限制
AliasName String 模型别名

AttrLabel

标签详情信息

被如下接口引用:DescribeDoc, DescribeQA, ListDoc, ListQA。

名称 类型 描述
Source Integer 标签来源
注意:此字段可能返回 null,表示取不到有效值。
AttrBizId String 标签ID
注意:此字段可能返回 null,表示取不到有效值。
AttrKey String 标签标识
注意:此字段可能返回 null,表示取不到有效值。
AttrName String 标签名称
注意:此字段可能返回 null,表示取不到有效值。
Labels Array of Label 标签值
注意:此字段可能返回 null,表示取不到有效值。

AttrLabelDetail

标签详情

被如下接口引用:ListAttributeLabel。

名称 类型 描述
AttrBizId String 标签ID
注意:此字段可能返回 null,表示取不到有效值。
示例值:1998645228471574272
AttrName String 标签名称
注意:此字段可能返回 null,表示取不到有效值。
示例值:部门名
LabelNames Array of String 标签值名称
注意:此字段可能返回 null,表示取不到有效值。
示例值:["lke"]
IsUpdating Boolean 标签是否在更新中
注意:此字段可能返回 null,表示取不到有效值。
示例值:true
Status Integer 发布状态(1 待发布 2 发布中 3 已发布 4 发布失败)
注意:此字段可能返回 null,表示取不到有效值。
示例值:0
StatusDesc String 状态描述
注意:此字段可能返回 null,表示取不到有效值。
示例值:待发布
LabelTotalCount String 标签值总数
示例值:1

AttrLabelRefer

标签引用信息

被如下接口引用:CreateQA, ModifyDoc, ModifyDocAttrRange, ModifyQA, ModifyQAAttrRange, SaveDoc。

名称 类型 必选 描述
Source Integer 标签来源,1:标签
示例值:1
AttributeBizId String 标签ID
示例值:1
LabelBizIds Array of String 标签值ID
示例值:[1,2]

AttributeFilters

导出知识标签过滤器

被如下接口引用:ExportAttributeLabel。

名称 类型 必选 描述
Query String 检索,属性或标签名称

AttributeLabel

标签值

被如下接口引用:CreateAttributeLabel, DescribeAttributeLabel, ModifyAttributeLabel。

名称 类型 必选 描述
LabelBizId String 标准词ID
注意:此字段可能返回 null,表示取不到有效值。
LabelName String 标准词名称
注意:此字段可能返回 null,表示取不到有效值。
SimilarLabels Array of String 同义词名称
注意:此字段可能返回 null,表示取不到有效值。

AttributeLabelRefByWorkflow

标签值引用的工作流详情

被如下接口引用:CheckAttributeLabelRefer。

名称 类型 描述
AttributeLabelBizId String 标签值id
WorkflowList Array of WorkflowRef 标签值引用的工作流列表

Audio

音频信息

被如下接口引用:GetMsgRecord。

名称 类型 必选 描述
Format String 音频文件格式
示例值:wav
AudioUrl String 音频文件地址
示例值:https://sample.com/123.wav
Title String 音频标题
注意:此字段可能返回 null,表示取不到有效值。
示例值:《丝之歌》:争议与魅力的博弈
Position Integer 音频文件在正文中的位置
注意:此字段可能返回 null,表示取不到有效值。
示例值:0
AudioTranscripts Array of AudioTranscript 音频转录后的文字列表
注意:此字段可能返回 null,表示取不到有效值。

AudioTranscript

音频转录的文本内容

被如下接口引用:GetMsgRecord。

名称 类型 必选 描述
Speaker String 音频的发言者
注意:此字段可能返回 null,表示取不到有效值。
示例值:主持人1
Transcript String 音频转录为文字后的内容
注意:此字段可能返回 null,表示取不到有效值。
示例值:《空洞骑士》的续作《丝之歌》终于来了!

BackgroundImageConfig

背景图相关配置

被如下接口引用:DescribeApp, ModifyApp。

名称 类型 必选 描述
LandscapeImageUrl String 横图(pc)
示例值:https://qidian-qbot-1251316161.cos.ap-guangzhou.myqcloud.com/public/1753030485940633600/1933045939331552832/image/hehEVqvCbsPmDkURkUUe-1936336152095918144.png
OriginalImageUrl String 原始图
示例值:https://qidian-qbot-1251316161.cos.ap-guangzhou.myqcloud.com/public/1753030485940633600/1933045939331552832/image/hehEVqvCbsPmDkURkUUe-1936336152095918144.png
PortraitImageUrl String 长图(手机)
示例值:https://qidian-qbot-1251316161.cos.ap-guangzhou.myqcloud.com/public/1753030485940633600/1933045939331552832/image/hehEVqvCbsPmDkURkUUe-1936336152095918144.png
ThemeColor String 主题色
示例值:#3B4651
Brightness Integer 亮度值
示例值:12

BaseConfig

应用基础配置

被如下接口引用:CreateApp, DescribeApp, ModifyApp。

名称 类型 必选 描述
Name String 应用名称
Avatar String 应用头像url,在CreateApp和ModifyApp中作为入参必填。
作为入参传入说明:
1. 传入的url图片限制为jpeg和png,大小限制为500KB,url链接需允许head请求。
2. 如果用户没有对象存储,可使用“获取文件上传临时密钥”(DescribeStorageCredential)接口,获取cos临时密钥和上传路径,自行上传头像至cos中并获取访问链接。
示例值:https://cdn.xiaowei.qq.com/static/lke/app-icon-knowledge_qa.png
Desc String 应用描述

CallDetail

调用类型

被如下接口引用:ListUsageCallDetail。

名称 类型 描述
Id String 关联ID
注意:此字段可能返回 null,表示取不到有效值。
CallTime String 调用时间
注意:此字段可能返回 null,表示取不到有效值。
TotalTokenUsage Float 总token消耗
注意:此字段可能返回 null,表示取不到有效值。
InputTokenUsage Float 输入token消耗
注意:此字段可能返回 null,表示取不到有效值。
OutputTokenUsage Float 输出token消耗
注意:此字段可能返回 null,表示取不到有效值。
SearchUsage Integer 搜索服务调用次数
注意:此字段可能返回 null,表示取不到有效值。
ModelName String 模型名称
注意:此字段可能返回 null,表示取不到有效值。
CallType String 调用类型
注意:此字段可能返回 null,表示取不到有效值。
UinAccount String 账号
注意:此字段可能返回 null,表示取不到有效值。
AppName String 应用名称
注意:此字段可能返回 null,表示取不到有效值。
PageUsage Integer 总消耗页数
注意:此字段可能返回 null,表示取不到有效值。
SubScene String 筛选子场景
注意:此字段可能返回 null,表示取不到有效值。
BillingTag String 账单明细对应的自定义tag
示例值:{"tag1":"vlue1", "tag2":"value2"}

CateInfo

分类信息

被如下接口引用:ListDocCate。

名称 类型 描述
CateBizId String 分类ID
注意:此字段可能返回 null,表示取不到有效值。
示例值:1978461293957811200
Name String 分类名称

注意:此字段可能返回 null,表示取不到有效值。
示例值:未分类
Total Integer 分类下的Record(如文档、同义词等)数量
注意:此字段可能返回 null,表示取不到有效值。
示例值:10
CanAdd Boolean 是否可新增

注意:此字段可能返回 null,表示取不到有效值。
示例值:true
CanEdit Boolean 是否可编辑

注意:此字段可能返回 null,表示取不到有效值。
示例值:true
CanDelete Boolean 是否可删除

注意:此字段可能返回 null,表示取不到有效值。
示例值:true
Children Array of CateInfo 子分类
注意:此字段可能返回 null,表示取不到有效值。
IsLeaf Boolean 是否为叶子节点
注意:此字段可能返回 null,表示取不到有效值。
示例值:false

ChannelListInfo

渠道详情信息

被如下接口引用:ListChannel。

名称 类型 必选 描述
ChannelType Integer 渠道类型 10000 微信订阅号 10001 微信服务号 10002 企微应用
示例值:10001
ChannelStatus Integer 渠道状态 1未发布 2运行中 3已下线
示例值:2
ChannelName String 渠道名称
示例值:微信公众号
ChannelId String 渠道id 数据库主键
示例值:1968125072589206740
Comment String 备注
示例值:公众号渠道
UpdateTime String 更新时间
示例值:1758087093
CreateTime String 创建时间
示例值:1758087052
UpdatedUser String 最后更新人
示例值:128641079067
YuanQiInfo YuanQi 智能体应用可见范围,public-所有人可见 private-仅自己可见 share-通过分享可见
注意:此字段可能返回 null,表示取不到有效值。

ClarificationConfig

澄清询问配置

被如下接口引用:DescribeAppAgentList。

名称 类型 必选 描述
OutputType Integer 输出类型,1-文本 3-widget
示例值:1
WidgetConfigs Array of ClarificationWidgetConfig 澄清widget配置

ClarificationWidgetConfig

澄清widget配置

被如下接口引用:DescribeAppAgentList。

名称 类型 必选 描述
WidgetId String widget id
示例值:test-widget-id
ClarificationWidgetType Integer 澄清widget类型
示例值:1
WidgetName String Widget名称
示例值:widget-name
WidgetPreview String Widget预览
示例值:widget-preview
Enabled Boolean 是否启用该Widget作为澄清样式
示例值:false

ClassifyConfig

标签提取配置

被如下接口引用:DescribeApp, ModifyApp。

名称 类型 必选 描述
Model AppModel 模型配置
注意:此字段可能返回 null,表示取不到有效值。
Labels Array of ClassifyLabel 标签列表
注意:此字段可能返回 null,表示取不到有效值。
Greeting String 欢迎语,200字符以内
注意:此字段可能返回 null,表示取不到有效值。

ClassifyLabel

标签信息

被如下接口引用:DescribeApp, ModifyApp。

名称 类型 必选 描述
Name String 标签名称
注意:此字段可能返回 null,表示取不到有效值。
Description String 标签描述
注意:此字段可能返回 null,表示取不到有效值。
Values Array of String 标签取值范围
注意:此字段可能返回 null,表示取不到有效值。

Content

对话记录内容详情

被如下接口引用:GetMsgRecord。

名称 类型 必选 描述
Type String 消息内容类型
text:文本
image:图片
file:文件
option_cards:选项卡
custom_params:用户自定义业务参数
sandbox:云桌面
custom_variables:自定义输入参数
web_search: 网页搜索内容
file_collection:文件收集信息
widget:widget信息
widget_action:用户端widget动作信息
示例值:text
Text String 文本内容
注意:此字段可能返回 null,表示取不到有效值。
示例值:你好
QuoteInfos Array of QuoteInfo 引用信息
注意:此字段可能返回 null,表示取不到有效值。
References Array of ContentReference 参考文献信息
注意:此字段可能返回 null,表示取不到有效值。
Image ImageInfoContent 图片信息
注意:此字段可能返回 null,表示取不到有效值。
File FileInfoContent 文件信息
注意:此字段可能返回 null,表示取不到有效值。
OptionCards Array of String 选项卡信息
注意:此字段可能返回 null,表示取不到有效值。
示例值:["选项1","选项2"]
CustomParams Array of String 用户自定义业务参数信息
注意:此字段可能返回 null,表示取不到有效值。
示例值:["{"name":"test"}"]
CustomVariables Array of String 自定义变量
注意:此字段可能返回 null,表示取不到有效值。
示例值:["{"name":"test"}"]
Sandbox SandboxContent 沙盒信息
注意:此字段可能返回 null,表示取不到有效值。
WebSearch WebSearchContent 网页搜索内容
注意:此字段可能返回 null,表示取不到有效值。
FileCollection FileCollection 文件收集信息
注意:此字段可能返回 null,表示取不到有效值。
Widget Widget Widget信息
注意:此字段可能返回 null,表示取不到有效值。
WidgetAction WidgetAction Widget动作信息
注意:此字段可能返回 null,表示取不到有效值。

ContentReference

会话内容参考文献信息

被如下接口引用:GetMsgRecord。

名称 类型 必选 描述
Index Integer 引用来源索引ID
注意:此字段可能返回 null,表示取不到有效值。
示例值:0
Name String 参考来源名称
示例值:示例引文
Type Integer 参考来源类型
1:问答
2:文档片段
4:联网检索到的内容
示例值:1
DocRefer DocReference 文档片段参考信息
注意:此字段可能返回 null,表示取不到有效值。
QaRefer QaReference 问答参考信息
注意:此字段可能返回 null,表示取不到有效值。
WebSearchRefer WebSearchReference 联网检索内容参考信息
注意:此字段可能返回 null,表示取不到有效值。

Context

获取不满意回复上下文响

被如下接口引用:DescribeUnsatisfiedReplyContext。

名称 类型 描述
RecordBizId String 消息记录ID信息
注意:此字段可能返回 null,表示取不到有效值。
IsVisitor Boolean 是否为用户
注意:此字段可能返回 null,表示取不到有效值。
NickName String 昵称
注意:此字段可能返回 null,表示取不到有效值。
Avatar String 头像
注意:此字段可能返回 null,表示取不到有效值。
Content String 消息内容
注意:此字段可能返回 null,表示取不到有效值。
FileInfos Array of MsgFileInfo 文档信息
注意:此字段可能返回 null,表示取不到有效值。
ReplyMethod Integer 回复方式,15:澄清确认回复
注意:此字段可能返回 null,表示取不到有效值。

Credentials

临时密钥结构

被如下接口引用:DescribeStorageCredential。

名称 类型 描述
Token String token
注意:此字段可能返回 null,表示取不到有效值。
TmpSecretId String 临时证书密钥ID
注意:此字段可能返回 null,表示取不到有效值。
TmpSecretKey String 临时证书密钥Key
注意:此字段可能返回 null,表示取不到有效值。
AppId Integer 临时证书appid
注意:此字段可能返回 null,表示取不到有效值。

CustomVariable

工作流的API参数

被如下接口引用:CreateWorkflowRun, DescribeWorkflowRun。

名称 类型 必选 描述
Name String 参数名称
示例值:name
Value String 参数的值
示例值:张三

DigitalHumanConfig

数智人配置

被如下接口引用:DescribeApp, ModifyApp。

名称 类型 必选 描述
AssetKey String 数智人资产key
示例值:qPfqrKkXGihmCqbJM2mZgkZGvKG1dFdvsLplgctolz4=
Name String 数智人名称
示例值:呦呦
Avatar String 图像
示例值:https://xxxx.png
PreviewUrl String 预览图
示例值:https://xxxx.png

DocFilterFlag

文档列表筛选标识位

被如下接口引用:ListDoc。

名称 类型 必选 描述
Flag String 标识位
示例值:is_created_qa
Value Boolean 标识值
示例值:true

DocReference

文档类参考来源信息

被如下接口引用:GetMsgRecord。

名称 类型 必选 描述
DocBizId Integer 文档业务ID
示例值:1982108829427482944
ReferBizId Integer 文档片段参考ID
注意:此字段可能返回 null,表示取不到有效值。
示例值:1999472789655812224
DocName String 文档名称
注意:此字段可能返回 null,表示取不到有效值。
示例值:讲师资料.txt
KnowledgeBizId Integer 文档所在知识库业务ID
注意:此字段可能返回 null,表示取不到有效值。
示例值:1999472789655812224
KnowledgeName String 文档所在知识库名称
注意:此字段可能返回 null,表示取不到有效值。
示例值:默认知识库
Url String 文档访问地址
注意:此字段可能返回 null,表示取不到有效值。
示例值:https://

DocSegment

文档片段

被如下接口引用:DescribeSegments。

名称 类型 描述
Id String 片段ID
注意:此字段可能返回 null,表示取不到有效值。
BusinessId String 业务ID
注意:此字段可能返回 null,表示取不到有效值。
FileType String 文件类型(markdown,word,txt)
注意:此字段可能返回 null,表示取不到有效值。
SegmentType String 文档切片类型(segment-文档切片 table-表格)
注意:此字段可能返回 null,表示取不到有效值。
Title String 标题
注意:此字段可能返回 null,表示取不到有效值。
PageContent String 段落内容
注意:此字段可能返回 null,表示取不到有效值。
OrgData String 段落原文
注意:此字段可能返回 null,表示取不到有效值。
DocId String 文章ID
注意:此字段可能返回 null,表示取不到有效值。
DocBizId String 文档业务ID
注意:此字段可能返回 null,表示取不到有效值。
DocUrl String 文档链接
注意:此字段可能返回 null,表示取不到有效值。
WebUrl String 文档的自定义链接
PageInfos Array of Integer 页码信息

DuplicateFileHandle

重复文档处理方式

被如下接口引用:SaveDoc。

名称 类型 必选 描述
CheckType Integer 重复文档判断方式,1:按文档内容,即cos_hash字段判断是否重复
示例值:1
HandleType Integer 重复文档处理方式,1:返回报错,2:跳过,返回重复的文档业务ID
示例值:1

ExtraInfo

扩展信息

被如下接口引用:GetMsgRecord。

名称 类型 必选 描述
EChartsInfo Array of String ECharts信息
注意:此字段可能返回 null,表示取不到有效值。
示例值:["ECharts"]

FileCollection

文件收集信息

被如下接口引用:GetMsgRecord。

名称 类型 必选 描述
MaxFileCount Integer 最大上传文件的数量
示例值:10
SupportedFileTypes Array of String 支持的上传文件类型
注意:此字段可能返回 null,表示取不到有效值。
示例值:["pnd","txt"]

FileInfo

实时上传的文件信息

被如下接口引用:GetMsgRecord。

名称 类型 描述
FileName String 文件名称
注意:此字段可能返回 null,表示取不到有效值。
示例值:文件名称
FileSize String 文件大小
注意:此字段可能返回 null,表示取不到有效值。
示例值:120
FileUrl String 文件的URL地址,COS地址
注意:此字段可能返回 null,表示取不到有效值。
示例值:https://xxx/xxx
FileType String 文件类型
注意:此字段可能返回 null,表示取不到有效值。
示例值:doc
DocId String 解析后返回的DocID
注意:此字段可能返回 null,表示取不到有效值。
示例值:0e532887-4ea0-f056-e2e8-83b7f4b3d453
CreatedAt String 创建时间
注意:此字段可能返回 null,表示取不到有效值。
示例值:1757507356

FileInfoContent

文件信息内容

被如下接口引用:GetMsgRecord。

名称 类型 必选 描述
DocBizId Integer 实时文档解析接口返回的 DocBizId
示例值:1982108829427482944
FileName String 文件名称
注意:此字段可能返回 null,表示取不到有效值。
示例值:讲师资料.txt
FileType String 文件类型
注意:此字段可能返回 null,表示取不到有效值。
示例值:txt
FileSize Integer 文件大小
注意:此字段可能返回 null,表示取不到有效值。
示例值:1024
FileUrl String 文件 URL
注意:此字段可能返回 null,表示取不到有效值。
示例值:http://sample.com

Filters

不满意回复检索过滤

被如下接口引用:ExportUnsatisfiedReply。

名称 类型 必选 描述
Query String 检索,用户问题或答案
示例值:不好
Reasons Array of String 错误类型检索

示例值:["不满意"]
HandlingStatuses Array of Integer 处理状态 0-待处理 1-已拒答 2-已忽略 3-已添加为新问答 4-已添加为相似问
示例值:[0,1,2,3,4]

Highlight

分片高亮内容

被如下接口引用:DescribeQA, DescribeRefer。

名称 类型 必选 描述
StartPos String 高亮起始位置

注意:此字段可能返回 null,表示取不到有效值。
EndPos String 高亮结束位置

注意:此字段可能返回 null,表示取不到有效值。
Text String 高亮子文本

注意:此字段可能返回 null,表示取不到有效值。

HistorySummary

多轮历史信息

被如下接口引用:GetMsgRecord。

名称 类型 必选 描述
Assistant String 助手
注意:此字段可能返回 null,表示取不到有效值。
示例值:您好有什么需要帮助吗
User String 用户
注意:此字段可能返回 null,表示取不到有效值。
示例值:你好

ImageInfoContent

图片信息

被如下接口引用:GetMsgRecord。

名称 类型 必选 描述
Url String 图片文件链接
示例值:http://sample.com

InputBoxConfig

输入框配置

被如下接口引用:DescribeApp, ModifyApp。

名称 类型 必选 描述
InputBoxButtons Array of Integer 输入框按钮,1:上传图片、2:上传文档,3:腾讯文档,4:联网搜索
示例值:[1]

IntentAchievement

意图达成方式

被如下接口引用:DescribeApp, ModifyApp。

名称 类型 必选 描述
Name String 意图达成方式,qa:问答回复、doc:文档回复、workflow:工作流回复,llm:大模型回复
示例值:qa
Desc String 意图达成方式描述
示例值:问答回复

InvokeAPI

请求的API信息

被如下接口引用:GetMsgRecord。

名称 类型 必选 描述
Method String 请求方法,如GET/POST等
注意:此字段可能返回 null,表示取不到有效值。
示例值:GET
Url String 请求地址
注意:此字段可能返回 null,表示取不到有效值。
示例值:https://xxx/xxx
HeaderValues Array of StrValue header参数
注意:此字段可能返回 null,表示取不到有效值。
QueryValues Array of StrValue 入参Query
注意:此字段可能返回 null,表示取不到有效值。
RequestPostBody String Post请求的原始数据
注意:此字段可能返回 null,表示取不到有效值。
示例值:{"id":1}
ResponseBody String 返回的原始数据
注意:此字段可能返回 null,表示取不到有效值。
示例值:"{}"
ResponseValues Array of ValueInfo 出参
注意:此字段可能返回 null,表示取不到有效值。
FailMessage String 异常信息
注意:此字段可能返回 null,表示取不到有效值。
示例值:内部错误

KnowledgeAdvancedConfig

知识库高级设置

被如下接口引用:DescribeApp, ModifyApp。

名称 类型 必选 描述
RerankModel String 重排序模型
注意:此字段可能返回 null,表示取不到有效值。
示例值:adp-rerank-model
RerankRecallNum Integer 召回数量
注意:此字段可能返回 null,表示取不到有效值。
示例值:5

KnowledgeBaseInfo

共享知识库基础信息

被如下接口引用:DescribeSharedKnowledge, ListReferShareKnowledge, ListSharedKnowledge。

名称 类型 必选 描述
KnowledgeBizId String 共享知识库业务ID
示例值:1908652910168703294
KnowledgeName String 共享知识库名称
示例值:共享知识库1
KnowledgeDescription String 共享知识库描述
注意:此字段可能返回 null,表示取不到有效值。
示例值:计算机基础理论知识库
EmbeddingModel String Embedding模型
注意:此字段可能返回 null,表示取不到有效值。
示例值:general-text-embedding-v2.7
QaExtractModel String 问答提取模型
注意:此字段可能返回 null,表示取不到有效值。
示例值:general-qa-extract-v1.8
UpdateTime String 更新时间
注意:此字段可能返回 null,表示取不到有效值。
示例值:1747757139
KnowledgeType Integer 共享知识库类型,0普通,1公众号
示例值:0
OwnerStaffId String 拥有者id
示例值:0
DocTotal Integer 知识库文档数量,当前仅支持公众号知识库
注意:此字段可能返回 null,表示取不到有效值。
示例值:0
ProcessingFlags Array of Integer 知识库处理中状态标记,1:向量embedding变更中
注意:此字段可能返回 null,表示取不到有效值。
示例值:[1]
OwnerStaffName String 知识库拥有者的名字
示例值:小明

KnowledgeCapacityPieGraphDetail

知识库容量饼图详情

被如下接口引用:DescribeKnowledgeUsagePieGraph。

名称 类型 描述
AppName String 当前应用名称
注意:此字段可能返回 null,表示取不到有效值。
示例值:知识问答
UsedCharSize String 当前应用使用的字符数
注意:此字段可能返回 null,表示取不到有效值。
示例值:4096
Proportion Float 当前应用对于总用量的占比
注意:此字段可能返回 null,表示取不到有效值。
示例值:0.1
KnowledgeType Integer 知识库类型:0默认1共享
示例值:1

KnowledgeDetail

应用使用知识库容量详情

被如下接口引用:ListAppKnowledgeDetail。

名称 类型 必选 描述
AppName String 应用名称
注意:此字段可能返回 null,表示取不到有效值。
UsedCharSize String 已用字符数
注意:此字段可能返回 null,表示取不到有效值。
Proportion Float 使用占比
注意:此字段可能返回 null,表示取不到有效值。
ExceedCharSize String 超量字符数
注意:此字段可能返回 null,表示取不到有效值。
IsSharedKnowledge Boolean 废弃
注意:此字段可能返回 null,表示取不到有效值。
KnowledgeType Integer 知识库类型:0默认1共享
示例值:1

KnowledgeDetailInfo

知识库详情信息

被如下接口引用:DescribeSharedKnowledge, ListSharedKnowledge。

名称 类型 必选 描述
Knowledge KnowledgeBaseInfo 知识库信息
注意:此字段可能返回 null,表示取不到有效值。
AppList Array of AppBaseInfo 应用列表
注意:此字段可能返回 null,表示取不到有效值。
User UserBaseInfo 用户信息
注意:此字段可能返回 null,表示取不到有效值。
PermissionIds Array of String 权限位信息
示例值:["knowledge"]

KnowledgeModelConfig

知识库模型设置

被如下接口引用:DescribeApp, ModifyApp。

名称 类型 必选 描述
EmbeddingModel String 向量模型,该字段只有共享知识库有,应用知识库没有
注意:此字段可能返回 null,表示取不到有效值。
示例值:adp-embedding-model
QaExtractModel String 问答对生成模型
注意:此字段可能返回 null,表示取不到有效值。
示例值:adp-model
SchemaModel String schema生成模型
注意:此字段可能返回 null,表示取不到有效值。
示例值:adp-schema-model

KnowledgeQaAgent

应用配置关联的agent信息

被如下接口引用:DescribeApp, ModifyApp。

名称 类型 必选 描述
AgentCollaboration Integer 协同方式,1:自由转交,2:工作流编排,3:Plan-and-Execute
注意:此字段可能返回 null,表示取不到有效值。
示例值:1
Workflow KnowledgeQaWorkflowInfo 应用配置agent关联的工作流
注意:此字段可能返回 null,表示取不到有效值。
示例值:工作流信息

KnowledgeQaConfig

知识问答配置

被如下接口引用:DescribeApp, ModifyApp。

名称 类型 必选 描述
Greeting String 欢迎语,200字符以内
注意:此字段可能返回 null,表示取不到有效值。
示例值:欢迎
RoleDescription String 角色描述,4000字符以内。通过填写描述,设定应用的 #角色名称、 #风格特点 及可达成的#意图。建议按照下面的模板填写,且自定义意图建议不超过5个。

#角色名称:
#风格特点:
#输出要求:
#能力限制:

能够达成以下用户意图
##意图名称:
##意图描述:
##意图示例:
##意图实现:

注意:此字段可能返回 null,表示取不到有效值。
示例值:这是一个角色提示词
Model AppModel 生成模型配置
注意:此字段可能返回 null,表示取不到有效值。
Search Array of KnowledgeQaSearch 知识搜索配置
注意:此字段可能返回 null,表示取不到有效值。
Output KnowledgeQaOutput 知识管理输出配置
注意:此字段可能返回 null,表示取不到有效值。
Workflow KnowledgeWorkflow 工作流程配置
注意:此字段可能返回 null,表示取不到有效值。
SearchRange SearchRange 检索范围
注意:此字段可能返回 null,表示取不到有效值。
Pattern String 应用模式,standard:标准模式, agent: agent模式,single_workflow:单工作流模式
注意:此字段可能返回 null,表示取不到有效值。
示例值:standard
SearchStrategy SearchStrategy 检索策略
注意:此字段可能返回 null,表示取不到有效值。
SingleWorkflow KnowledgeQaSingleWorkflow 单工作流ID,Pattern为single_workflow时传入
注意:此字段可能返回 null,表示取不到有效值。
Plugins Array of KnowledgeQaPlugin 应用关联插件
注意:此字段可能返回 null,表示取不到有效值。
ThoughtModel AppModel 思考模型配置
注意:此字段可能返回 null,表示取不到有效值。
IntentAchievements Array of IntentAchievement 意图达成方式优先级
注意:此字段可能返回 null,表示取不到有效值。
ImageTextRetrieval Boolean 是否开启图文检索
注意:此字段可能返回 null,表示取不到有效值。
示例值:false
AiCall AICallConfig 配置语音通话参数
注意:此字段可能返回 null,表示取不到有效值。
ShareKnowledgeBases Array of ShareKnowledgeBase 共享知识库关联配置
注意:此字段可能返回 null,表示取不到有效值。
BackgroundImage BackgroundImageConfig 背景图相关信息
注意:此字段可能返回 null,表示取不到有效值。
OpeningQuestions Array of String 开场问题
注意:此字段可能返回 null,表示取不到有效值。
示例值:["开场问题1","开场问题2","开场问题3"]
LongMemoryOpen Boolean 长期记忆开关
示例值:false
LongMemoryDay Integer 长期记忆时效
示例值:3
Agent KnowledgeQaAgent agent配置信息
注意:此字段可能返回 null,表示取不到有效值。
KnowledgeModelConfig KnowledgeModelConfig 知识库模型
注意:此字段可能返回 null,表示取不到有效值。
KnowledgeAdvancedConfig KnowledgeAdvancedConfig 知识库高级设置
注意:此字段可能返回 null,表示取不到有效值。

KnowledgeQaOutput

应用管理输出配置

被如下接口引用:DescribeApp, ModifyApp。

名称 类型 必选 描述
Method Integer 输出方式 1:流式 2:非流式
注意:此字段可能返回 null,表示取不到有效值。
示例值:1
UseGeneralKnowledge Boolean 通用模型回复
注意:此字段可能返回 null,表示取不到有效值。
示例值:false
BareAnswer String 未知回复语,300字符以内
注意:此字段可能返回 null,表示取不到有效值。
示例值:当前无法回答
ShowQuestionClarify Boolean 是否展示问题澄清开关
注意:此字段可能返回 null,表示取不到有效值。
示例值:true
UseQuestionClarify Boolean 是否打开问题澄清
注意:此字段可能返回 null,表示取不到有效值。
示例值:false
QuestionClarifyKeywords Array of String 问题澄清关键词列表
注意:此字段可能返回 null,表示取不到有效值。
示例值:["歧义"]
UseRecommended Boolean 是否打开推荐问题开关
注意:此字段可能返回 null,表示取不到有效值。
示例值:false
RecommendedPromptMode Integer 推荐问模式,0.结合知识库&对话历史推荐问题Prompt(默认) 1.仅结合知识库输出推荐问的prompt
注意:此字段可能返回 null,表示取不到有效值。
示例值:1
InputBoxConfig InputBoxConfig 输入框按钮配置

KnowledgeQaPlugin

应用关联插件信息

被如下接口引用:DescribeApp, ModifyApp。

名称 类型 必选 描述
PluginId String 插件ID
注意:此字段可能返回 null,表示取不到有效值。
PluginName String 插件名称
PluginIcon String 插件图标
ToolId String 工具ID
ToolName String 工具名称
ToolDesc String 工具描述
Inputs Array of PluginToolReqParam 工具输入参数
IsBindingKnowledge Boolean 插件是否和知识库绑定

KnowledgeQaSearch

检索配置

被如下接口引用:DescribeApp, ModifyApp。

名称 类型 必选 描述
Type String 知识来源 doc:文档,qa:问答 taskflow:业务流程,search:搜索增强,database:数据库
注意:此字段可能返回 null,表示取不到有效值。
ReplyFlexibility Integer 问答-回复灵活度 1:已采纳答案直接回复 2:已采纳润色后回复
注意:此字段可能返回 null,表示取不到有效值。
UseSearchEngine Boolean 搜索增强-搜索引擎状态
注意:此字段可能返回 null,表示取不到有效值。
ShowSearchEngine Boolean 是否显示搜索引擎检索状态
注意:此字段可能返回 null,表示取不到有效值。
IsEnabled Boolean 知识来源,是否选择
注意:此字段可能返回 null,表示取不到有效值。
QaTopN Integer 问答最大召回数量, 默认2,限制5
注意:此字段可能返回 null,表示取不到有效值。
DocTopN Integer 文档最大召回数量, 默认3,限制5
注意:此字段可能返回 null,表示取不到有效值。
Confidence Float 检索置信度,针对文档和问答有效,最小0.01,最大0.99
注意:此字段可能返回 null,表示取不到有效值。
ResourceStatus Integer 资源状态 1:资源可用;2:资源已用尽
注意:此字段可能返回 null,表示取不到有效值。

KnowledgeQaSingleWorkflow

问答知识库单工作流模式下指定单工作流配置

被如下接口引用:DescribeApp, GetWsToken, ModifyApp。

名称 类型 必选 描述
WorkflowId String 工作流ID
示例值:b97df586-16c4-4795-85fd-705c2b7a8265
WorkflowName String 工作流名称
示例值:工作流
WorkflowDesc String 工作流描述
示例值:这是一个描述
Status String 工作流状态,发布状态(UNPUBLISHED: 待发布 PUBLISHING: 发布中 PUBLISHED: 已发布 FAIL:发布失败)
示例值:UNPUBLISHED
IsEnable Boolean 工作流是否启用
示例值:true
AsyncWorkflow Boolean 是否开启异步调用工作流
示例值:false

KnowledgeQaWorkflowInfo

应用配置关联的工作流信息

被如下接口引用:DescribeApp, ModifyApp。

名称 类型 必选 描述
WorkflowId String 工作流ID
示例值:b97df586-16c4-4795-85fd-705c2b7a8265
WorkflowName String 工作流名称
示例值:工作流
WorkflowDesc String 工作流描述
示例值:订机票
Status String 工作流状态,发布状态(UNPUBLISHED: 待发布 PUBLISHING: 发布中 PUBLISHED: 已发布 FAIL:发布失败)
示例值:UNPUBLISHED
IsEnable Boolean 工作流是否启用
示例值:true

KnowledgeSummary

检索知识

被如下接口引用:GetMsgRecord。

名称 类型 必选 描述
Type Integer 1是问答 2是文档片段
注意:此字段可能返回 null,表示取不到有效值。
示例值:1
Content String 知识内容
注意:此字段可能返回 null,表示取不到有效值。
示例值:知识内容

KnowledgeUpdateInfo

共享知识库更新信息

被如下接口引用:UpdateSharedKnowledge。

名称 类型 必选 描述
KnowledgeName String 共享知识库名称
示例值:共享知识库1
KnowledgeDescription String 共享知识库描述
注意:此字段可能返回 null,表示取不到有效值。
示例值:计算机基础理论知识库
OwnerStaffId String 拥有者id
示例值:1089

KnowledgeWorkflow

问答知识库工作流配置

被如下接口引用:DescribeApp, ModifyApp。

名称 类型 必选 描述
IsEnabled Boolean 是否启用工作流
注意:此字段可能返回 null,表示取不到有效值。
示例值:true:启用,false:停用
UsePdl Boolean 是否启用PDL
注意:此字段可能返回 null,表示取不到有效值。
示例值:true:启用,false:停用

Label

标签ID

被如下接口引用:DescribeDoc, DescribeQA。

名称 类型 描述
LabelBizId String 标签ID
注意:此字段可能返回 null,表示取不到有效值。
LabelName String 标签名称
注意:此字段可能返回 null,表示取不到有效值。

ListDocItem

文档列表详情描述

被如下接口引用:ListDoc。

名称 类型 描述
DocBizId String 文档ID
注意:此字段可能返回 null,表示取不到有效值。
示例值:1222
FileName String 文件名称
注意:此字段可能返回 null,表示取不到有效值。
示例值:"text"
NewName String 重命名的新文档名称,在重命名提交之后,文档发布之前都是这个名称
示例值:"newName"
FileType String 文件类型
注意:此字段可能返回 null,表示取不到有效值。
示例值:"pdf"
CosUrl String cos路径
注意:此字段可能返回 null,表示取不到有效值。
示例值:"cos/test"
UpdateTime String 更新时间
注意:此字段可能返回 null,表示取不到有效值。
示例值:"2023-11-30"
Status Integer 文档状态
注意:此字段可能返回 null,表示取不到有效值。
示例值:19
StatusDesc String 文档状态描述
注意:此字段可能返回 null,表示取不到有效值。
示例值:"学习中"
Reason String 原因
注意:此字段可能返回 null,表示取不到有效值。
示例值:"xxxx"
IsRefer Boolean 答案中是否引用
注意:此字段可能返回 null,表示取不到有效值。
示例值:true
QaNum Integer 问答对数量
注意:此字段可能返回 null,表示取不到有效值。
示例值:1
IsDeleted Boolean 是否已删除
注意:此字段可能返回 null,表示取不到有效值。
示例值:false
Source Integer 文档来源
注意:此字段可能返回 null,表示取不到有效值。
示例值:1
SourceDesc String 文档来源描述
注意:此字段可能返回 null,表示取不到有效值。
示例值:"网页"
IsAllowRestart Boolean 是否允许重新生成
注意:此字段可能返回 null,表示取不到有效值。
示例值:true
IsDeletedQa Boolean qa是否已删除
注意:此字段可能返回 null,表示取不到有效值。
示例值:false
IsCreatingQa Boolean 问答是否生成中
注意:此字段可能返回 null,表示取不到有效值。
示例值:false
IsAllowDelete Boolean 是否允许删除
注意:此字段可能返回 null,表示取不到有效值。
示例值:false
IsAllowRefer Boolean 是否允许操作引用开关
注意:此字段可能返回 null,表示取不到有效值。
示例值:false
IsCreatedQa Boolean 问答是否生成过
注意:此字段可能返回 null,表示取不到有效值。
示例值:false
DocCharSize String 文档字符量
注意:此字段可能返回 null,表示取不到有效值。
示例值:"1022"
AttrRange Integer 属性标签适用范围
注意:此字段可能返回 null,表示取不到有效值。
示例值:1
AttrLabels Array of AttrLabel 属性标签
注意:此字段可能返回 null,表示取不到有效值。
IsAllowEdit Boolean 是否允许编辑
注意:此字段可能返回 null,表示取不到有效值。
示例值:false
ReferUrlType Integer 外部引用链接类型 0:系统链接 1:自定义链接
值为1时,WebUrl 字段不能为空,否则不生效。
注意:此字段可能返回 null,表示取不到有效值。
示例值:1
WebUrl String 网页(或自定义链接)地址
注意:此字段可能返回 null,表示取不到有效值。
示例值:"http://"
ExpireStart String 有效开始时间,unix时间戳
注意:此字段可能返回 null,表示取不到有效值。
示例值:"1970-01-01"
ExpireEnd String 有效结束时间,unix时间戳,0代表永久有效
注意:此字段可能返回 null,表示取不到有效值。
示例值:"1971-01-01"
IsAllowRetry Boolean 是否允许重试,0:否,1:是
注意:此字段可能返回 null,表示取不到有效值。
示例值:false
Processing Array of Integer 0:文档比对处理 1:文档生成问答
注意:此字段可能返回 null,表示取不到有效值。
示例值:[1]
CreateTime String 文档创建落库时间
注意:此字段可能返回 null,表示取不到有效值。
示例值:"2023-11-30"
CateBizId String 文档所属分类ID
示例值:"11988765442"
CustomerKnowledgeId String 文档的用户自定义ID
示例值:"11988765442"
AttributeFlags Array of Integer 文档的属性标记,0: 不做用户外部权限校验
示例值:[1]
IsDisabled Boolean false:未停用,ture:已停用
示例值:false
StaffName String 员工名称
示例值:"lihua"
EnableScope Integer 文档生效域: 1-不生效;2-仅开发域生效;3-仅发布域生效;4-开发域和发布域均生效
注意:此字段可能返回 null,表示取不到有效值。
示例值:1
DocSize String 文档大小,单位:字节
示例值:1024

ListQaItem

问答详情数据

被如下接口引用:ListQA。

名称 类型 描述
QaBizId String 问答ID
示例值:"1343444444"
Question String 问题
示例值:"你好吗?"
Answer String 答案
示例值:"我很好"
Source Integer 来源
示例值:1
SourceDesc String 来源描述
示例值:"手动导入"
UpdateTime String 更新时间
示例值:"2025-11-20"
Status Integer 状态
示例值:2
StatusDesc String 状态描述
示例值:"待发布"
DocBizId String 文档ID
示例值:"123333333"
CreateTime String 创建时间
示例值:"2025-11-20"
IsAllowEdit Boolean 是否允许编辑
示例值:false
IsAllowDelete Boolean 是否允许删除
示例值:false
IsAllowAccept Boolean 是否允许校验
示例值:false
FileName String 文档名称
示例值:"text"
FileType String 文档类型
示例值:"md"
QaCharSize String 问答字符数
示例值:1k"
ExpireStart String 有效开始时间,unix时间戳
示例值:"1970-01-01"
ExpireEnd String 有效结束时间,unix时间戳,0代表永久有效
示例值:"1970-01-01"
AttrRange Integer 属性标签适用范围 1:全部,2:按条件
示例值:1
AttrLabels Array of AttrLabel 属性标签
SimilarQuestionNum Integer 相似问个数
示例值:0
SimilarQuestionTips String 返回问答关联的相似问,联动搜索,仅展示一条
示例值:"相似问"
IsDisabled Boolean 问答是否停用,false:未停用,ture:已停用
示例值:false
StaffName String 员工名称
示例值:"lihua"
EnableScope Integer 问答生效域: 1-不生效;2-仅开发域生效;3-仅发布域生效;4-开发域和发布域均生效
注意:此字段可能返回 null,表示取不到有效值。
示例值:1
DocEnableScope Integer 问答关联的文档生效域:1-不生效;2-仅开发域生效;3-仅发布域生效;4-开发域和发布域均生效。
若问答未关联文档,则该字段值同问答生效域。
示例值:1
QaSize String 问答大小(含相似问),单位:字节
示例值:1024

ListReleaseItem

发布列表详情

被如下接口引用:ListRelease。

名称 类型 描述
ReleaseBizId String 版本ID
示例值:1730138654150348800
Operator String 发布人
示例值:zhangsan
Desc String 发布描述
示例值:修改检索配置
UpdateTime String 更新时间
示例值:1701332268
Status Integer 发布状态,1:待发布,2:发布中,3:发布成功,5:发布失败
示例值:3
StatusDesc String 发布状态描述
示例值:发布成功
Reason String 失败原因
示例值:配置不合法
SuccessCount Integer 发布成功数
示例值:8
FailCount Integer 发布失败数
示例值:0
ReleaseVersion String 版本号,格式是 v{date}{time}
示例值:v20251225120056
CanRollback Boolean 是否可还原
示例值:true

ModelInfo

模型信息

被如下接口引用:ListModel。

名称 类型 必选 描述
ModelName String 模型名称
注意:此字段可能返回 null,表示取不到有效值。
示例值:cs-normal
ModelDesc String 模型描述
注意:此字段可能返回 null,表示取不到有效值。
示例值:模型描述信息
AliasName String 模型名称
注意:此字段可能返回 null,表示取不到有效值。
示例值:精调模型
ResourceStatus Integer 资源状态 1:资源可用;2:资源已用尽
注意:此字段可能返回 null,表示取不到有效值。
示例值:1
PromptWordsLimit String 提示词内容字符限制
注意:此字段可能返回 null,表示取不到有效值。
示例值:["8K", "256K"]
TopP ModelParameter 通过核心采样控制内容生成的多样性,较高的Top P值会导致生成更多样的内容
注意:此字段可能返回 null,表示取不到有效值。
Temperature ModelParameter 温度控制随机性
注意:此字段可能返回 null,表示取不到有效值。
MaxTokens ModelParameter 最多能生成的token数量
注意:此字段可能返回 null,表示取不到有效值。
Source String 模型来源 Hunyuan:腾讯混元大模型,Industry:腾讯云行业大模型,Experience:新模型体验,Custom自定义模型
示例值:Hunyuan
Icon String 模型图标
示例值:https://cdn.xiaowei.qq.com/lke/assets/static/modelicon/hunyuan.png
IsFree Boolean 是否免费
示例值:true
InputLenLimit Integer 模型对话框可输入的上限
注意:此字段可能返回 null,表示取不到有效值。
示例值:4000
SupportWorkflowStatus Integer 支持工作流的类型 0:模型不支持; 1: 模型支持工作流; 2: 模型支持效果不佳;
注意:此字段可能返回 null,表示取不到有效值。
示例值:1
ModelCategory String 模型类别 generate:生成模型,thought:思考模型
示例值:generate
IsDefault Boolean 是否默认模型
示例值:true
RoleLenLimit Integer 角色提示词输入长度限制
示例值:4000
IsExclusive Boolean 是否专属并发模型
示例值:true
SupportAiCallStatus Integer 模型支持智能通话效果
示例值:1
Concurrency Integer 专属并发数
示例值:5
ModelTags Array of String 模型标签
注意:此字段可能返回 null,表示取不到有效值。
示例值:["文本推理"]
ModelParams Array of ModelParameter 模型超参定义
注意:此字段可能返回 null,表示取不到有效值。
ProviderName String 提供商名称
示例值:Hunyuan
ProviderAliasName String 提供商别名
示例值:腾讯混元
ProviderType String 提供商类型 Self:提供商,Custom:自定义模型提供商,Third:第三方模型提供商
示例值:Self
IsCloseModelParams Boolean 是否关闭模型超参
示例值:false
IsDeepThinking Boolean 是否支持深度思考
示例值:false

ModelParameter

模型参数范围

被如下接口引用:ListModel。

名称 类型 必选 描述
Name String 超参名称
注意:此字段可能返回 null,表示取不到有效值。
示例值:temperature
Type String 类型
示例值:string
DefaultValue String 默认值
示例值:1
EnumValues Array of String 枚举值
示例值:["disable","high"]
Default Float 默认值
注意:此字段可能返回 null,表示取不到有效值。
示例值:3.2
Min Float 最小值
注意:此字段可能返回 null,表示取不到有效值。
示例值:2.3
Max Float 最大值
注意:此字段可能返回 null,表示取不到有效值。
示例值:3.4

ModelParams

模型参数

被如下接口引用:DescribeApp, DescribeAppAgentList, ModifyApp。

名称 类型 必选 描述
Temperature Float 温度
示例值:0.1
TopP Float Top_P
示例值:0.1
Seed Integer 随机种子
示例值:3
PresencePenalty Float 存在惩罚
示例值:0.1
FrequencyPenalty Float 频率惩罚
示例值:0.1
RepetitionPenalty Float 重复惩罚
示例值:0.1
MaxTokens Integer 最大输出长度
示例值:1
StopSequences Array of String 停止序列
示例值:["set"]
ReplyFormat String 输出格式
示例值:text
DeepThinking String 深度思考值
disabled
enabled
注意:此字段可能返回 null,表示取不到有效值。
示例值:enabled
ReasoningEffort String 效果 disabled low medium high
注意:此字段可能返回 null,表示取不到有效值。
示例值:disabled

MsgFileInfo

文档信息

被如下接口引用:DescribeUnsatisfiedReplyContext。

名称 类型 描述
FileName String 文档名称
注意:此字段可能返回 null,表示取不到有效值。
FileSize String 文档大小
注意:此字段可能返回 null,表示取不到有效值。
FileUrl String 文档URL
注意:此字段可能返回 null,表示取不到有效值。
FileType String 文档类型
注意:此字段可能返回 null,表示取不到有效值。
DocId String 文档ID
注意:此字段可能返回 null,表示取不到有效值。

MsgRecord

消息详情

被如下接口引用:GetMsgRecord。

名称 类型 描述
Content String 内容
示例值:出差酒店房间推荐
SessionId String 当前记录所对应的 Session ID
注意:此字段可能返回 null,表示取不到有效值。
示例值:abb03b38-efcc-4d8e-bfc2-231100a04a26
RecordId String 记录ID
示例值:Fp3_20250910_202900_770_j31qfUuB
RelatedRecordId String 关联记录ID
示例值:Fp3_20250910_202900_770_j31qfUuB
IsFromSelf Boolean 是否来自自己
示例值:false
FromName String 发送者名称
示例值:访客
FromAvatar String 发送者头像
示例值:https://qidian-qbot-1251316161.cos.ap-guangzhou.myqcloud.com/public/avatar_monkey01.png
Timestamp String 时间戳
示例值:1757507341
HasRead Boolean 是否已读
示例值:false
Score Integer 评价
示例值:0
CanRating Boolean 是否评分
示例值:false
CanFeedback Boolean 是否展示反馈按钮
注意:此字段可能返回 null,表示取不到有效值。
示例值:false
Type Integer 记录类型
示例值:0
References Array of MsgRecordReference 引用来源
Reasons Array of String 评价原因
示例值:["评价"]
IsLlmGenerated Boolean 是否大模型
示例值:false
ImageUrls Array of String 图片链接,可公有读
注意:此字段可能返回 null,表示取不到有效值。
示例值:["https://xxx.jpg"]
TokenStat TokenStat 当次 token 统计信息
注意:此字段可能返回 null,表示取不到有效值。
ReplyMethod Integer 回复方式
1:大模型直接回复;
2:保守回复, 未知问题回复;
3:拒答问题回复;
4:敏感回复;
5:问答对直接回复, 已采纳问答对优先回复;
6:欢迎语回复;
7:并发超限回复;
8:全局干预知识;
9:任务流程过程回复, 当历史记录中 task_flow.type = 0 时, 为大模型回复;
10:任务流程答案回复;
11:搜索引擎回复;
12:知识润色后回复;
13:图片理解回复;
14:实时文档回复;
注意:此字段可能返回 null,表示取不到有效值。
示例值:1
OptionCards Array of String 选项卡, 用于多轮对话
注意:此字段可能返回 null,表示取不到有效值。
示例值:["选项1","选项2"]
TaskFlow TaskFlowInfo 任务信息
注意:此字段可能返回 null,表示取不到有效值。
FileInfos Array of FileInfo 用户传入的文件信息
注意:此字段可能返回 null,表示取不到有效值。
QuoteInfos Array of QuoteInfo 参考来源引用位置信息
注意:此字段可能返回 null,表示取不到有效值。
AgentThought AgentThought Agent的思考过程信息
注意:此字段可能返回 null,表示取不到有效值。
ExtraInfo ExtraInfo 扩展信息
注意:此字段可能返回 null,表示取不到有效值。
WorkFlow WorkflowInfo 工作流信息
注意:此字段可能返回 null,表示取不到有效值。
Widgets Array of Widget Widget信息
注意:此字段可能返回 null,表示取不到有效值。
WidgetAction WidgetAction Widget动作信息
注意:此字段可能返回 null,表示取不到有效值。
Audios Array of Audio 音频信息
注意:此字段可能返回 null,表示取不到有效值。

MsgRecordReference

聊天详情Refer

被如下接口引用:GetMsgRecord。

名称 类型 必选 描述
Id String id
示例值:asasdf
Url String 链接
示例值:https://xxxxxx.com/xxx
Type Integer 类型
示例值:1
Name String 名称
示例值:todo
DocId String 来源文档ID
示例值:1134
KnowledgeName String 知识库名称
示例值:知识库名称
KnowledgeBizId String 知识库业务id
示例值:知识库标识
DocBizId String 文档业务id
示例值:文档标识
QaBizId String 问答业务id
示例值:问答标识
Index Integer 文档索引id
示例值:1

NL2SQLModelConfig

Nl2Sql模型配置

被如下接口引用:DescribeApp, ModifyApp。

名称 类型 必选 描述
Model AppModelDetailInfo 模型配置
注意:此字段可能返回 null,表示取不到有效值。

NodeRunBase

节点运行的基本信息

被如下接口引用:DescribeWorkflowRun。

名称 类型 必选 描述
NodeRunId String 节点运行的ID
示例值:32d82e0553507b4c1ba771fb53029492
NodeId String 节点ID
示例值:e60de932-b050-65ce-261e-027760e93d81
WorkflowRunId String 工作流运行实例的ID
示例值:8ad82e0553507b4c1ba771fb53029492
NodeName String 节点名称
示例值:工具节点1
NodeType Integer 节点类型。
1: 开始节点
2:参数提取节点
3:大模型节点
4:知识问答节点
5:知识检索节点
6:标签提取节点
7:代码执行节点
8:工具节点
9:逻辑判断节点
10:回复节点
11:选项卡节点
12:循环节点
13:意图识别节点
14:工作流节点
15:插件节点
16:结束节点
17: 变量聚合节点数据
18: 批处理节点
19: 消息队列节点
示例值:1
State Integer 运行状态。0: 初始状态;1: 运行中;2: 运行成功; 3: 运行失败; 4: 已取消
示例值:1
FailCode String 错误码
示例值:NodeErr.CallPluginToolFailed
FailMessage String 错误信息
示例值:工具节点运行失败。
CostMilliseconds Integer 消耗时间(毫秒)
示例值:12000
TotalTokens Integer 消耗的token总数
示例值:560

NodeRunDetail

工作流节点运行详情

被如下接口引用:DescribeNodeRun。

名称 类型 必选 描述
NodeRunId String 节点运行的ID
示例值:3af2e0553507b4c1ba771fb53029492
NodeId String 节点ID
示例值:e60de932-b050-65ce-261e-027760e93d81
WorkflowRunId String 工作流运行实例的ID
示例值:8ad82e0553507b4c1ba771fb53029492
NodeName String 节点名称
示例值:工具节点1
NodeType Integer 节点类型。
1: 开始节点
2:参数提取节点
3:大模型节点
4:知识问答节点
5:知识检索节点
6:标签提取节点
7:代码执行节点
8:工具节点
9:逻辑判断节点
10:回复节点
11:选项卡节点
12:循环节点
13:意图识别节点
14:工作流节点
15:插件节点
16:结束节点
17: 变量聚合节点数据
18: 批处理节点
19: 消息队列节点
示例值:1
State Integer 运行状态。0: 初始状态;1: 运行中;2: 运行成功; 3: 运行失败; 4: 已取消
示例值:1
FailCode String 错误码
示例值:NodeErr.CallPluginToolFailed
FailMessage String 错误信息
示例值:工具节点运行失败。
CostMilliseconds Integer 消耗时间(毫秒)
示例值:12000
TotalTokens Integer 消耗的token总数
示例值:560
Input String 输入变量信息
示例值:{"Name": "张三"}
InputRef String 节点的输入的完整内容的链接。(当Input内容超过限制的时候此字段才有值)
示例值:www.cos.com
Output String 输出变量信息
示例值:{"Name": "张三"}
OutputRef String 节点的输出的完整内容的链接。(当Output内容超过限制的时候此字段才有值)
示例值:www.cos.com
TaskOutput String 原始输出信息。部分节点才有值,如工具节点、代码节点
示例值:{"Name": "张三"}
TaskOutputRef String 任务的原始输出的完整内容的链接。(当TaskOutput内容超过限制的时候此字段才有值)
示例值:www.cos.com
Log String 节点的日志
示例值:log
LogRef String 节点的日志的完整内容的链接志(当Log内容超过限制的时候才有值)
示例值:www.cos.com
StartTime String 开始时间戳(毫秒)
示例值:1672531100000
EndTime String 结束时间戳(毫秒)
示例值:1672531100000
StatisticInfos Array of StatisticInfo LLM统计信息。

Option

下拉框选项

被如下接口引用:ListSelectDoc。

名称 类型 必选 描述
Text String 文本
注意:此字段可能返回 null,表示取不到有效值。
Value String
注意:此字段可能返回 null,表示取不到有效值。
CharSize String 文件字符数
注意:此字段可能返回 null,表示取不到有效值。
FileType String 文件类型
注意:此字段可能返回 null,表示取不到有效值。

OptionCardIndex

选项卡索引

被如下接口引用:GetMsgRecord。

名称 类型 必选 描述
RecordId String 唯一标识
示例值:doc_20250726_153945_830_LX68mlEN
Index Integer 选项卡索引
示例值:1

OutputWidgetConfig

Widget输出参数配置

被如下接口引用:DescribeAppAgentList。

名称 类型 必选 描述
WidgetId String widget id
示例值:test-widget-id
WidgetName String widget名字
示例值:test-widget-name
WidgetParam Array of WidgetParam 展示结果

ParameterConfig

参数配置列表

被如下接口引用:DescribeAppAgentList。

名称 类型 必选 描述
Name String 字段名称
示例值:test1
Description String 字段描述
示例值:test1
Type Integer 字段类型
示例值:0
IsRequired Boolean 是否必填
示例值:false
SubParams Array of ParameterConfig 子参数
OneOf Array of ParameterConfig OneOf类型的参数
AnyOf Array of ParameterConfig AnyOf类型的参数

PluginToolReqParam

插件参数请求结构

被如下接口引用:DescribeApp, ModifyApp。

名称 类型 必选 描述
Name String 参数名称
示例值:姓名
Desc String 参数描述
示例值:人物名字
Type Integer 参数类型,0:string, 1:int, 2:float,3:bool 4:object 5:array_string, 6:array_int, 7:array_float, 8:array_bool, 9:array_object, 99:null, 100:upspecified
示例值:0
IsRequired Boolean 参数是否必填
示例值:false
DefaultValue String 参数默认值
示例值:张三
SubParams Array of PluginToolReqParam 子参数,ParamType 是OBJECT 或 ARRAY<>类型有用
GlobalHidden Boolean 插件参数配置是否隐藏不可见,true-隐藏不可见,false-可见
示例值:false
OneOf Array of PluginToolReqParam OneOf类型参数
AnyOf Array of PluginToolReqParam AnyOf类型参数

Procedure

执行过程信息记录

被如下接口引用:GetMsgRecord。

名称 类型 必选 描述
Name String 执行过程英语名
注意:此字段可能返回 null,表示取不到有效值。
示例值:英文名
Title String 中文名, 用于展示
注意:此字段可能返回 null,表示取不到有效值。
示例值:中文名
Status String 状态常量: 使用中: processing, 成功: success, 失败: failed
注意:此字段可能返回 null,表示取不到有效值。
示例值:状态
Count Integer 消耗 token 数
注意:此字段可能返回 null,表示取不到有效值。
示例值:200
Debugging ProcedureDebugging 调试信息
注意:此字段可能返回 null,表示取不到有效值。
ResourceStatus Integer 计费资源状态,1:可用,2:不可用
注意:此字段可能返回 null,表示取不到有效值。
示例值:1
InputCount Integer 输入消耗 token 数
示例值:100
OutputCount Integer 输出消耗 token 数
示例值:100

ProcedureDebugging

调试信息

被如下接口引用:GetMsgRecord。

名称 类型 必选 描述
Content String 检索query
注意:此字段可能返回 null,表示取不到有效值。
示例值:调试内容
System String 系统prompt
注意:此字段可能返回 null,表示取不到有效值。
示例值:系统信息
Histories Array of HistorySummary 多轮历史信息
注意:此字段可能返回 null,表示取不到有效值。
Knowledge Array of KnowledgeSummary 检索知识
注意:此字段可能返回 null,表示取不到有效值。
TaskFlow TaskFlowSummary 任务流程
注意:此字段可能返回 null,表示取不到有效值。
WorkFlow WorkFlowSummary 工作流调试信息
注意:此字段可能返回 null,表示取不到有效值。
Agent AgentDebugInfo Agent调试信息
注意:此字段可能返回 null,表示取不到有效值。
CustomVariables Array of String 自定义参数
注意:此字段可能返回 null,表示取不到有效值。
示例值:["string"]

QACate

获取QA分类分组

被如下接口引用:ListQACate。

名称 类型 描述
CateBizId String QA分类的业务ID
注意:此字段可能返回 null,表示取不到有效值。
示例值:1985999991020214592
Name String 分类名称

注意:此字段可能返回 null,表示取不到有效值。
示例值:未分类
Total Integer 分类下QA数量

注意:此字段可能返回 null,表示取不到有效值。
示例值:10
CanAdd Boolean 是否可新增

注意:此字段可能返回 null,表示取不到有效值。
示例值:true
CanEdit Boolean 是否可编辑

注意:此字段可能返回 null,表示取不到有效值。
示例值:true
CanDelete Boolean 是否可删除

注意:此字段可能返回 null,表示取不到有效值。
示例值:true
Children Array of QACate 子分类
注意:此字段可能返回 null,表示取不到有效值。
IsLeaf Boolean 是否是叶子节点
注意:此字段可能返回 null,表示取不到有效值。
示例值:false

QAList

问答列表

被如下接口引用:VerifyQA。

名称 类型 必选 描述
QaBizId String 问答ID
IsAccepted Boolean 是否采纳
CateBizId String 分类ID
Question String 问题
Answer String 答案

QAQuery

QA查询参数

被如下接口引用:ExportQAList。

名称 类型 必选 描述
PageNumber Integer 页码 从1开始

示例值:1
PageSize Integer 页大小 默认15 最大100

示例值:15
BotBizId String 应用ID
示例值:"1952993275700732800"
Query String 查询内容

示例值:"name"
CateBizId String 分类ID

示例值:"1734144647474577408"
AcceptStatus Array of Integer 校验状态的枚举值

示例值:[1,2,3]
ReleaseStatus Array of Integer 发布状态的枚举值

示例值:[2,3,4,7,8,9,11]
DocBizId String 文档ID

示例值:"19517346915356272"
QaBizId String QAID

示例值:"19517346915356272"
Source Integer 来源

示例值:1
QueryAnswer String 查询答案

示例值:"name"
QueryType String 查询类型 filename 名称、 attribute 标签
示例值:"filename"
EnableScope Integer 问答生效域检索,不检索不传。枚举值如下:
1-不生效;2-仅开发域生效;3-仅发布域生效;4-开发域和发布域均生效。
示例值:1

QaReference

问答对参考信息

被如下接口引用:GetMsgRecord。

名称 类型 必选 描述
QaBizId Integer 问答业务ID
示例值:1982108829427482944
ReferBizId Integer 文档片段参考ID
注意:此字段可能返回 null,表示取不到有效值。
示例值:1999472789655812224
KnowledgeBizId Integer 问答所在知识库业务ID
注意:此字段可能返回 null,表示取不到有效值。
示例值:1972219265921606848
KnowledgeName String 问答所在知识库名称
注意:此字段可能返回 null,表示取不到有效值。
示例值:默认知识库

QuoteInfo

搜索引擎参考来源索引

被如下接口引用:GetMsgRecord。

名称 类型 必选 描述
Position Integer 参考来源位置
注意:此字段可能返回 null,表示取不到有效值。
示例值:100
Index String 参考来源索引顺序
注意:此字段可能返回 null,表示取不到有效值。
示例值:1

ReferDetail

引用来源详情

被如下接口引用:DescribeRefer。

名称 类型 描述
ReferBizId String 引用ID
注意:此字段可能返回 null,表示取不到有效值。
DocType Integer 文档类型 (1 QA, 2 文档段)
注意:此字段可能返回 null,表示取不到有效值。
DocName String 文档名称
注意:此字段可能返回 null,表示取不到有效值。
PageContent String 分片内容
注意:此字段可能返回 null,表示取不到有效值。
Question String 问题
注意:此字段可能返回 null,表示取不到有效值。
Answer String 答案
注意:此字段可能返回 null,表示取不到有效值。
Confidence Float 置信度
注意:此字段可能返回 null,表示取不到有效值。
Mark Integer 标记
注意:此字段可能返回 null,表示取不到有效值。
Highlights Array of Highlight 分片高亮内容
注意:此字段可能返回 null,表示取不到有效值。
OrgData String 原始内容
注意:此字段可能返回 null,表示取不到有效值。
PageInfos Array of Integer 页码信息
注意:此字段可能返回 null,表示取不到有效值。
SheetInfos Array of String sheet信息
注意:此字段可能返回 null,表示取不到有效值。
DocBizId String 文档ID
注意:此字段可能返回 null,表示取不到有效值。
KnowledgeBizId String 知识库ID

RejectedQuestion

发布拒答

被如下接口引用:ListRejectedQuestion。

名称 类型 描述
RejectedBizId String 拒答问题ID


注意:此字段可能返回 null,表示取不到有效值。
示例值:18781034349007
Question String 被拒答的问题

注意:此字段可能返回 null,表示取不到有效值。
示例值:你是谁
Status Integer 发布状态(1 待发布 2 发布中 3 已发布 4 发布失败)
注意:此字段可能返回 null,表示取不到有效值。
示例值:1
StatusDesc String 状态描述
注意:此字段可能返回 null,表示取不到有效值。
示例值:已发布
UpdateTime String 更新时间, 秒级时间戳

注意:此字段可能返回 null,表示取不到有效值。
示例值:1756865070
IsAllowEdit Boolean 是否允许编辑

注意:此字段可能返回 null,表示取不到有效值。
示例值:false
IsAllowDelete Boolean 是否允许删除

注意:此字段可能返回 null,表示取不到有效值。
示例值:false
Operator String 操作人
注意:此字段可能返回 null,表示取不到有效值。
示例值:张三

ReleaseConfigs

发布配置项

被如下接口引用:ListReleaseConfigPreview。

名称 类型 描述
ConfigItem String 配置项描述
注意:此字段可能返回 null,表示取不到有效值。
UpdateTime String 更新时间
注意:此字段可能返回 null,表示取不到有效值。
Action Integer 状态
注意:此字段可能返回 null,表示取不到有效值。
Value String 变更后的内容
注意:此字段可能返回 null,表示取不到有效值。
LastValue String 变更前的内容
注意:此字段可能返回 null,表示取不到有效值。
Content String 变更内容(优先级展示content内容,content为空取value内容)
注意:此字段可能返回 null,表示取不到有效值。
Message String 失败原因
注意:此字段可能返回 null,表示取不到有效值。

ReleaseDoc

发布文档详情

被如下接口引用:ListReleaseDocPreview。

名称 类型 必选 描述
FileName String 文件名
FileType String 文件类型
UpdateTime String 更新时间
Action Integer 状态
ActionDesc String 状态描述
Message String 失败原因
DocBizId String 文档业务ID

ReleaseQA

发布问答

被如下接口引用:ListReleaseQAPreview。

名称 类型 必选 描述
Question String 问题
UpdateTime String 更新时间
Action Integer 状态
ActionDesc String 状态描述
Source Integer 来源1:文档生成,2:批量导入,3:手动添加
SourceDesc String 来源描述
FileName String 文件名字
FileType String 文档类型
Message String 失败原因
ReleaseStatus Integer 发布状态
QaBizId String QAID
DocBizId String 文档业务ID

ReleaseRejectedQuestion

发布拒答

被如下接口引用:ListRejectedQuestionPreview。

名称 类型 描述
Question String 问题
注意:此字段可能返回 null,表示取不到有效值。
UpdateTime String 更新时间
注意:此字段可能返回 null,表示取不到有效值。
Action Integer 状态
注意:此字段可能返回 null,表示取不到有效值。
ActionDesc String 状态描述
注意:此字段可能返回 null,表示取不到有效值。
Message String 失败原因
注意:此字段可能返回 null,表示取不到有效值。

RunNodeInfo

节点信息

被如下接口引用:GetMsgRecord。

名称 类型 必选 描述
NodeType Integer 节点类型,0:未指定,1:开始节点,2:API节点,3:询问节点,4:答案节点
注意:此字段可能返回 null,表示取不到有效值。
示例值:0
NodeId String 节点ID
注意:此字段可能返回 null,表示取不到有效值。
示例值:0e532887-4ea0-f056-e2e8-83b7f4b3d453
NodeName String 节点名称
注意:此字段可能返回 null,表示取不到有效值。
示例值:大模型知识问答
InvokeApi InvokeAPI 请求的API
注意:此字段可能返回 null,表示取不到有效值。
SlotValues Array of ValueInfo 当前节点的所有槽位的值,key:SlotID。没有值的时候也要返回空。
注意:此字段可能返回 null,表示取不到有效值。

SandboxContent

沙盒信息内容

被如下接口引用:GetMsgRecord。

名称 类型 必选 描述
Url String 沙盒的URL地址
注意:此字段可能返回 null,表示取不到有效值。
示例值:http://sample.com
DisplayUrl String 沙盒通过浏览器打开的URL地址
注意:此字段可能返回 null,表示取不到有效值。
示例值:http://sample.com
Content String 沙盒输出内容
注意:此字段可能返回 null,表示取不到有效值。
示例值:{"content":"test"}

SearchRange

检索范围配置

被如下接口引用:DescribeApp, ModifyApp。

名称 类型 必选 描述
Condition String 检索条件and/or
注意:此字段可能返回 null,表示取不到有效值。
ApiVarAttrInfos Array of ApiVarAttrInfo 自定义变量和标签关系数据
注意:此字段可能返回 null,表示取不到有效值。

SearchStrategy

知识库检索策略

被如下接口引用:DescribeApp, ModifyApp。

名称 类型 必选 描述
StrategyType Integer 检索策略类型 0:混合检索,1:语义检索
注意:此字段可能返回 null,表示取不到有效值。
示例值:1
TableEnhancement Boolean Excel检索增强开关, false关闭,true打开
注意:此字段可能返回 null,表示取不到有效值。
示例值:true
EmbeddingModel String 向量模型
注意:此字段可能返回 null,表示取不到有效值。
示例值:adp-embedding-model
RerankModelSwitch String 结果重排序开关, on打开,off关闭
注意:此字段可能返回 null,表示取不到有效值。
示例值:on
RerankModel String 结果重排序模型
注意:此字段可能返回 null,表示取不到有效值。
示例值:adp-rerank-model
NatureLanguageToSqlModelConfig NL2SQLModelConfig NL2SQL模型配置
注意:此字段可能返回 null,表示取不到有效值。

ShareKnowledgeBase

共享知识库配置

被如下接口引用:DescribeApp, ModifyApp。

名称 类型 必选 描述
KnowledgeBizId String 共享知识库ID
注意:此字段可能返回 null,表示取不到有效值。
示例值:1942591969559038144
SearchRange SearchRange 检索范围
注意:此字段可能返回 null,表示取不到有效值。
KnowledgeModelConfig KnowledgeModelConfig 知识库模型设置
注意:此字段可能返回 null,表示取不到有效值。
SearchStrategy SearchStrategy 检索策略配置
注意:此字段可能返回 null,表示取不到有效值。
Search Array of KnowledgeQaSearch 检索配置
注意:此字段可能返回 null,表示取不到有效值。
ReplyFlexibility Integer // 问答-回复灵活度 1:已采纳答案直接回复 2:已采纳润色后回复
注意:此字段可能返回 null,表示取不到有效值。
示例值:1
KnowledgeName String 共享知识库名称
注意:此字段可能返回 null,表示取不到有效值。
示例值:小学数据题集

SimilarQuestion

相似问信息

被如下接口引用:DescribeQA, ModifyQA。

名称 类型 必选 描述
SimBizId String 相似问ID
注意:此字段可能返回 null,表示取不到有效值。
示例值:10001
Question String 相似问内容
注意:此字段可能返回 null,表示取不到有效值。
示例值:您好
AuditStatus Integer 相似问审核状态,1审核失败
注意:此字段可能返回 null,表示取不到有效值。

SimilarQuestionModify

相似问修改(更新)信息

被如下接口引用:ModifyQA。

名称 类型 必选 描述
AddQuestions Array of String 需要添加的相似问(内容)列表
UpdateQuestions Array of SimilarQuestion 需要更新的相似问列表
DeleteQuestions Array of SimilarQuestion 需要删除的相似问列表

Stat

计费统计信息

被如下接口引用:DescribeCallStatsGraph, DescribeSearchStatsGraph, DescribeTokenUsageGraph。

名称 类型 描述
X String X轴: 时间区域;根据查询条件的粒度返回“分/小时/日”三种区间范围
注意:此字段可能返回 null,表示取不到有效值。
示例值:202411190855,2024111908,20241119
Y Float Y轴: 该时间区域内的统计值,如token消耗量,调用次数或使用量等信息
注意:此字段可能返回 null,表示取不到有效值。
示例值:1024

StatisticInfo

大模型token统计信息

被如下接口引用:DescribeNodeRun, GetMsgRecord。

名称 类型 必选 描述
ModelName String 模型名称
注意:此字段可能返回 null,表示取不到有效值。
示例值:deepseek-v3
FirstTokenCost Integer 首Token耗时
注意:此字段可能返回 null,表示取不到有效值。
示例值:0
TotalCost Integer 总耗时
注意:此字段可能返回 null,表示取不到有效值。
示例值:0
InputTokens Integer 输入Token数量
注意:此字段可能返回 null,表示取不到有效值。
示例值:0
OutputTokens Integer 输出Token数量
注意:此字段可能返回 null,表示取不到有效值。
示例值:0
TotalTokens Integer 总Token数量
注意:此字段可能返回 null,表示取不到有效值。
示例值:0

StrValue

字符串KV信息

被如下接口引用:GetMsgRecord。

名称 类型 必选 描述
Name String 名称
注意:此字段可能返回 null,表示取不到有效值。
示例值:id
Value String
注意:此字段可能返回 null,表示取不到有效值。
示例值:1

StructuredOutputConfig

结构化输出的配置项

被如下接口引用:DescribeAppAgentList。

名称 类型 必选 描述
StructuredOutputParams Array of ParameterConfig 参数列表

SummaryConfig

知识摘要应用配置

被如下接口引用:DescribeApp, ModifyApp。

名称 类型 必选 描述
Model AppModel 模型配置
注意:此字段可能返回 null,表示取不到有效值。
Output SummaryOutput 知识摘要输出配置
注意:此字段可能返回 null,表示取不到有效值。
Greeting String 欢迎语,200字符以内
注意:此字段可能返回 null,表示取不到有效值。

SummaryOutput

知识摘要输出配置

被如下接口引用:DescribeApp, ModifyApp。

名称 类型 必选 描述
Method Integer 输出方式 1:流式 2:非流式
注意:此字段可能返回 null,表示取不到有效值。
Requirement Integer 输出要求 1:文本总结 2:自定义要求
注意:此字段可能返回 null,表示取不到有效值。
RequireCommand String 自定义要求指令
注意:此字段可能返回 null,表示取不到有效值。

TaskFLowVar

变量详情

被如下接口引用:GetVarList。

名称 类型 必选 描述
VarId String 变量ID
注意:此字段可能返回 null,表示取不到有效值。
示例值:d125c28b-55db-4478-9066-6115ab97ee17
VarName String 变量名称
注意:此字段可能返回 null,表示取不到有效值。
示例值:发票类型
VarDesc String 变量描述(默认为"-")
示例值:发票类型包括纸质和电子
VarType String 变量类型 (STRING,INT,FLOAT,BOOL,OBJECT,ARRAY_STRING,ARRAY_INT,ARRAY_FLOAT,ARRAY_BOOL,ARRAY_OBJECT,FILE,DOCUMENT,IMAGE,AUDIO)

示例值:STRING
VarDefaultValue String 自定义变量默认值
示例值:电子发票
VarDefaultFileName String 自定义变量文件默认名称
VarModuleType Integer 变量类型
示例值:0

TaskFlowInfo

任务流程信息

被如下接口引用:GetMsgRecord。

名称 类型 描述
TaskFlowId String 任务流程ID
注意:此字段可能返回 null,表示取不到有效值。
示例值:0e532887-4ea0-f056-e2e8-83b7f4b3d453
TaskFlowName String 任务流程名称
注意:此字段可能返回 null,表示取不到有效值。
示例值:任务名称
QueryRewrite String Query 重写结果
注意:此字段可能返回 null,表示取不到有效值。
示例值:出差酒店推荐
HitIntent String 命中意图
注意:此字段可能返回 null,表示取不到有效值。
示例值:闲聊
Type Integer 任务流程回复类型
0: 任务流回复
1: 任务流静默
2: 任务流拉回话术
3: 任务流自定义回复
注意:此字段可能返回 null,表示取不到有效值。
示例值:1

TaskFlowSummary

任务流程调试信息

被如下接口引用:GetMsgRecord。

名称 类型 必选 描述
IntentName String 任务流程名
注意:此字段可能返回 null,表示取不到有效值。
示例值:闲聊
UpdatedSlotValues Array of ValueInfo 实体列表
注意:此字段可能返回 null,表示取不到有效值。
RunNodes Array of RunNodeInfo 节点列表
注意:此字段可能返回 null,表示取不到有效值。
Purposes Array of String 意图判断
注意:此字段可能返回 null,表示取不到有效值。
示例值:["intent"]

TaskParams

任务参数

被如下接口引用:GetTaskStatus。

名称 类型 描述
CosPath String 下载地址,需要通过cos桶临时密钥去下载
注意:此字段可能返回 null,表示取不到有效值。

TokenStat

当前执行的 token 统计信息

被如下接口引用:GetMsgRecord。

名称 类型 必选 描述
SessionId String 会话 ID
注意:此字段可能返回 null,表示取不到有效值。
示例值:abb03b38-efcc-4d8e-bfc2-231100a04a26
RequestId String 请求 ID
注意:此字段可能返回 null,表示取不到有效值。
示例值:L2rS86aDGF-6593177112
RecordId String 对应哪条会话, 会话 ID, 用于回答的消息存储使用, 可提前生成, 保存消息时使用
注意:此字段可能返回 null,表示取不到有效值。
示例值:MdM_20250908_170358_916_JoFuKasT
UsedCount Integer token 已使用数
注意:此字段可能返回 null,表示取不到有效值。
示例值:12
FreeCount Integer 免费 token 数
注意:此字段可能返回 null,表示取不到有效值。
示例值:1
OrderCount Integer 订单总 token 数
注意:此字段可能返回 null,表示取不到有效值。
示例值:12
StatusSummary String 当前执行状态汇总, 常量: 使用中: processing, 成功: success, 失败: failed
注意:此字段可能返回 null,表示取不到有效值。
示例值:success
StatusSummaryTitle String 当前执行状态汇总后中文展示
注意:此字段可能返回 null,表示取不到有效值。
示例值:成功
Elapsed Integer 当前请求执行时间, 单位 ms
注意:此字段可能返回 null,表示取不到有效值。
示例值:12
TokenCount Integer 当前请求消耗 token 数
注意:此字段可能返回 null,表示取不到有效值。
示例值:12
Procedures Array of Procedure 执行过程信息
注意:此字段可能返回 null,表示取不到有效值。
TraceId String 执行过程信息TraceId
注意:此字段可能返回 null,表示取不到有效值。
示例值:508e6f780ec19dc36dcb47916daf4e39 / 8E5_20250910_203106_755_3RhZOvjw

ToolAdvanceConfig

工具高级设置

被如下接口引用:DescribeAppAgentList。

名称 类型 必选 描述
EnableDirectResultReturn Boolean 工具调用结果是否直接返回给用户
示例值:true
OutputType Integer 输出样式 1-文本 2-json 3-widget
示例值:1
RawStructuredOutput String 原始结构化JSON输出
示例值:outputs
CustomTextOutputs String 自定义文本输出,多行展示
示例值:text outputs
OutputWidgetConfig OutputWidgetConfig Widget输出配置

UnsatisfiedReply

不满意回复

被如下接口引用:ListUnsatisfiedReply。

名称 类型 描述
ReplyBizId String 不满意回复ID
注意:此字段可能返回 null,表示取不到有效值。
示例值:18781034349007
RecordBizId String 消息记录ID
注意:此字段可能返回 null,表示取不到有效值。
示例值:888ff487-51fb-42c9-81d2-1bfc4dae24ae无
Question String 用户问题
注意:此字段可能返回 null,表示取不到有效值。
示例值:你是谁
Answer String 问题回复
注意:此字段可能返回 null,表示取不到有效值。
示例值:我是答案
Reasons Array of String 错误类型
注意:此字段可能返回 null,表示取不到有效值。
示例值:["回答不准确"]
Status Integer 处理状态,0:待处理,1:已拒答,2:已忽略,3:已纠错
注意:此字段可能返回 null,表示取不到有效值。
示例值:1
CreateTime String 创建时间,秒级时间戳
示例值:1756864444
UpdateTime String 更新时间,秒级时间戳
示例值:1756864444
Operator String 操作人
示例值:张三
FeedbackContent String 自定义反馈
示例值:自定义

UpdatePeriodInfo

更新时间策略

被如下接口引用:DescribeDoc, ModifyDoc, SaveDoc。

名称 类型 必选 描述
UpdatePeriodH Integer 文档更新频率类型:0不更新 -H 小时粒度,当前仅支持24(1天),72(3天),168(7天) 仅source=2 腾讯文档类型有效
注意:此字段可能返回 null,表示取不到有效值。
示例值:0

UserBaseInfo

用户基础信息

被如下接口引用:DescribeSharedKnowledge, ListSharedKnowledge。

名称 类型 必选 描述
UserBizId String 用户ID
示例值:1906370579678213376
UserName String 用户名称
注意:此字段可能返回 null,表示取不到有效值。
示例值:AI助手1

ValueInfo

任务流程参数信息

被如下接口引用:GetMsgRecord。

名称 类型 必选 描述
Id String 值ID
注意:此字段可能返回 null,表示取不到有效值。
示例值:1
Name String 名称
注意:此字段可能返回 null,表示取不到有效值。
示例值:name
ValueType Integer 值类型:0:未知或者空, 1:string, 2:int, 3:float, 4:bool, 5:array(字符串数组), 6: object_array(结构体数组), 7: object(结构体)
注意:此字段可能返回 null,表示取不到有效值。
示例值:1
ValueStr String string
注意:此字段可能返回 null,表示取不到有效值。
示例值:1231
ValueInt String int(避免精度丢失使用字符串返回)
注意:此字段可能返回 null,表示取不到有效值。
示例值:1231
ValueFloat Float float
注意:此字段可能返回 null,表示取不到有效值。
示例值:1231.0
ValueBool Boolean bool
注意:此字段可能返回 null,表示取不到有效值。
示例值:true
ValueStrArray Array of String array
注意:此字段可能返回 null,表示取不到有效值。
示例值:["1231"]

VoiceConfig

音色参数

被如下接口引用:DescribeApp, ModifyApp。

名称 类型 必选 描述
VoiceType Integer 公有云音色id
注意:此字段可能返回 null,表示取不到有效值。
示例值:501001
TimbreKey String 音色key
注意:此字段可能返回 null,表示取不到有效值。
示例值:tts_timbre_yuehua
VoiceName String 音色名称
注意:此字段可能返回 null,表示取不到有效值。
示例值:月华

WebSearchContent

网页搜索内容

被如下接口引用:GetMsgRecord。

名称 类型 必选 描述
Content String 网页搜索结果,json格式的string
示例值:[{"title":"测试页面","link":"https://sample.com","snippet":"这是一个测试页面","position":1}]

WebSearchReference

联网检索内容参考详情

被如下接口引用:GetMsgRecord。

名称 类型 必选 描述
Url String 网页URL
示例值:http://sample.com

Widget

对话端Widget结构

被如下接口引用:GetMsgRecord。

名称 类型 必选 描述
WidgetId String Widget配置ID

示例值:96317cc9-9628-82d5-8cb2-6232635d4ef2
WidgetRunId String Widget实例ID
示例值:210b4ce2-680a-87c7-eb40-2f3c9d49c456
State String Widget状态数据
注意:此字段可能返回 null,表示取不到有效值。
示例值:{"message":"widget"}
Position Integer Widget位置
注意:此字段可能返回 null,表示取不到有效值。
示例值:10
EncodedWidget String Base64编码的Widget信息
注意:此字段可能返回 null,表示取不到有效值。
示例值:eyJpZCI6ImU3Y2VmZjE3LTlhODEtNDJkZS05N2Q
Payload String 用户最近一次提交的payload
注意:此字段可能返回 null,表示取不到有效值。
示例值:{"message":"widget"}

WidgetAction

对话端Widget动作提交结构

被如下接口引用:GetMsgRecord。

名称 类型 必选 描述
WidgetId String Widget配置ID
示例值:96317cc9-9628-82d5-8cb2-6232635d4ef2
WidgetRunId String Widget实例ID
注意:此字段可能返回 null,表示取不到有效值。
示例值:210b4ce2-680a-87c7-eb40-2f3c9d49c456
ActionType String Widget动作
示例值:sys.chat
Payload String Widget动作提交的数据
注意:此字段可能返回 null,表示取不到有效值。
示例值:{"message":"widget"}

WidgetParam

Widget参数配置

被如下接口引用:DescribeAppAgentList。

名称 类型 必选 描述
Name String 参数名称
示例值:param
Type Integer 参数类型
示例值:0
SubParams Array of WidgetParam 子参数
DefaultValue String 默认值, Input未指定时,使用该值
示例值:value
Input AgentInput 输入的值

WorkFlowSummary

工作流程调试信息

被如下接口引用:GetMsgRecord。

名称 类型 必选 描述
WorkflowId String 工作流ID
注意:此字段可能返回 null,表示取不到有效值。
示例值:asdf125
WorkflowName String 工作流名称
注意:此字段可能返回 null,表示取不到有效值。
示例值:挂号工作流
WorkflowRunId String 工作流运行ID
注意:此字段可能返回 null,表示取不到有效值。
示例值:asdf2125
RunNodes Array of WorkflowRunNodeInfo 节点信息
注意:此字段可能返回 null,表示取不到有效值。
OptionCards Array of String 选项卡
注意:此字段可能返回 null,表示取不到有效值。
示例值:["选项A","选项B"]
Outputs Array of String 多气泡的输出结果
注意:此字段可能返回 null,表示取不到有效值。
示例值:["是的","请稍等,正在为您查询"]
WorkflowReleaseTime String 工作流发布时间,unix时间戳
注意:此字段可能返回 null,表示取不到有效值。
示例值:1
PendingMessages Array of String 中间消息
示例值:["中间消息"]
OptionCardIndex OptionCardIndex 选项卡索引
Contents Array of Content 工作流多气泡输出
注意:此字段可能返回 null,表示取不到有效值。

WorkflowInfo

工作流信息

被如下接口引用:GetMsgRecord。

名称 类型 必选 描述
WorkflowId String 工作流ID
注意:此字段可能返回 null,表示取不到有效值。
示例值:07d859ac-ec6a-0387-3121-a5ca6514e880
WorkflowName String 工作流名称
注意:此字段可能返回 null,表示取不到有效值。
示例值:挂号工作流
WorkflowRunId String 工作流运行ID
注意:此字段可能返回 null,表示取不到有效值。
示例值:07d859ac-ec6a-0387-3121-a5ca6514e880
OptionCards Array of String 选项卡
注意:此字段可能返回 null,表示取不到有效值。
示例值:["选项A","选项B"]
Outputs Array of String 多气泡的输出结果
注意:此字段可能返回 null,表示取不到有效值。
示例值:["是的","请稍等,正在为您查询"]
WorkflowReleaseTime String 工作流发布时间,unix时间戳
注意:此字段可能返回 null,表示取不到有效值。
示例值:1746800121
Contents Array of Content 工作流多气泡输出
注意:此字段可能返回 null,表示取不到有效值。

WorkflowRef

WorkflowRef详情

被如下接口引用:CheckAttributeLabelRefer。

名称 类型 必选 描述
WorkflowId String 任务流ID
示例值:1255215
WorkflowName String 任务流名称
示例值:开发票
WorkflowDesc String 任务流描述
示例值:开发票主要是告诉你开票方式和流程
AppBizId String 应用ID
示例值:5215125
UpdateTime Integer 更新时间
示例值:1731505418

WorkflowRunBase

工作流运行实例的基本信息

被如下接口引用:ListWorkflowRuns。

名称 类型 必选 描述
RunEnv Integer 运行环境。0: 测试环境; 1: 正式环境
示例值:1
AppBizId String 应用ID
示例值:1854548189164339200
WorkflowRunId String 工作流运行实例的ID
示例值:8ad82e0553507b4c1ba771fb53029492
WorkflowId String 所属工作流ID
示例值:98cc312553507b4c1ba771fb53029492
Name String 名称
示例值:订酒店
State Integer 运行状态。0: 排队中;1: 运行中;2: 运行成功;3: 运行失败; 4: 已取消
示例值:0
FailMessage String 错误信息
示例值:工具节点运行失败。
TotalTokens Integer 消耗的token总数
示例值:560
CreateTime String 创建时间(毫秒时间戳)
示例值:1744707612000
StartTime String 开始时间(毫秒时间戳)
示例值:1744707612000
EndTime String 结束时间(毫秒时间戳)
示例值:1744707612000

WorkflowRunDetail

工作流运行实例详情

被如下接口引用:DescribeWorkflowRun。

名称 类型 必选 描述
RunEnv Integer 运行环境。0: 测试环境; 1: 正式环境
示例值:1
AppBizId String 应用ID
示例值:1854548189164339200
WorkflowRunId String 工作流运行实例的ID
示例值:8ad82e0553507b4c1ba771fb53029492
WorkflowId String 所属工作流ID
示例值:98cc312553507b4c1ba771fb53029492
Name String 名称
示例值:订酒店
Output String 工作流输出
示例值:{"LoopTImes":4,"Question":"你好"}}
State Integer 运行状态。0: 排队中;1: 运行中;2: 运行成功;3: 运行失败; 4: 已取消
示例值:1
FailMessage String 错误信息
示例值:工具节点运行失败。
TotalTokens Integer 消耗的token总数
示例值:560
CreateTime String 创建时间(毫秒时间戳)
示例值:1744707612000
StartTime String 开始时间(毫秒时间戳)
示例值:1744707612000
EndTime String 结束时间(毫秒时间戳)
示例值:1744707612000
Query String 用户的输入
示例值:我想订明天的酒店
MainModelName String 主模型名称
示例值:workflow-pro
CustomVariables Array of CustomVariable API参数配置
WorkflowGraph String 工作流的流程图
示例值:{"WorkflowID":"xxx","WorkflowName":"qwe","WorkflowDesc":"135","Nodes":[]}

WorkflowRunNodeInfo

工作流运行节点信息

被如下接口引用:GetMsgRecord。

名称 类型 必选 描述
NodeId String 节点ID
注意:此字段可能返回 null,表示取不到有效值。
示例值:"1"
NodeType Integer 节点类型
注意:此字段可能返回 null,表示取不到有效值。
示例值:0
NodeName String 节点名称
注意:此字段可能返回 null,表示取不到有效值。
示例值:"name"
Status Integer 状态
注意:此字段可能返回 null,表示取不到有效值。
示例值:0
Input String 输入
注意:此字段可能返回 null,表示取不到有效值。
示例值:"input"
Output String 输出
注意:此字段可能返回 null,表示取不到有效值。
示例值:"output"
TaskOutput String 任务输出
注意:此字段可能返回 null,表示取不到有效值。
示例值:"taskOutput"
FailMessage String 错误信息
注意:此字段可能返回 null,表示取不到有效值。
示例值:"msg"
CostMilliSeconds Integer 花费时长
注意:此字段可能返回 null,表示取不到有效值。
示例值:0
StatisticInfos Array of StatisticInfo 大模型输出信息
注意:此字段可能返回 null,表示取不到有效值。
FailCode String 错误代码
注意:此字段可能返回 null,表示取不到有效值。
示例值:"NodeErr.MissingParam"

YuanQi

//智能体应用可见范围,public-所有人可见 private-仅自己可见 share-通过分享可见

被如下接口引用:ListChannel。

名称 类型 必选 描述
VisibleRange String public-所有人可见
示例值:pubilc