AICallConfig
智能通话
被如下接口引用：DescribeApp, ModifyApp。
| 名称 | 类型 | 必选 | 描述 |
|---|---|---|---|
| EnableVoiceInteract | Boolean | 否 | 启用语音互动功能 注意：此字段可能返回 null，表示取不到有效值。 示例值：false |
| EnableVoiceCall | Boolean | 否 | 启用语音通话 注意：此字段可能返回 null，表示取不到有效值。 示例值：false |
| EnableDigitalHuman | Boolean | 否 | 启用数智人 注意：此字段可能返回 null，表示取不到有效值。 示例值：false |
| Voice | VoiceConfig | 否 | 音色配置 注意：此字段可能返回 null，表示取不到有效值。 示例值： |
| DigitalHuman | DigitalHumanConfig | 否 | 数智人配置 注意：此字段可能返回 null，表示取不到有效值。 示例值： |
Agent
Agent 的定义
被如下接口引用：CreateAgent, DescribeAppAgentList, ModifyAgent。
| 名称 | 类型 | 必选 | 描述 |
|---|---|---|---|
| AgentId | String | 否 | AgentID 示例值：test-agent-id |
| WorkflowId | String | 否 | WorkflowID，非空则当前Agent从workflow转换而来 示例值：test-workflow-id |
| Name | String | 否 | Agent名称，同一个应用内，Agent名称不能重复 示例值：挂号Agent |
| IconUrl | String | 否 | 插件图标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 |
AgentDebugInfo
Agent调试信息
被如下接口引用：GetMsgRecord。
| 名称 | 类型 | 必选 | 描述 |
|---|---|---|---|
| Input | String | 否 | 工具、大模型的输入信息，json 注意：此字段可能返回 null，表示取不到有效值。 |
| Output | String | 否 | 工具、大模型的输出信息，json 注意：此字段可能返回 null，表示取不到有效值。 |
AgentInput
Agent输入值，支持直接赋值和引用
被如下接口引用：CreateAgent, DescribeAppAgentList, ModifyAgent。
| 名称 | 类型 | 必选 | 描述 |
|---|---|---|---|
| InputType | Integer | 否 | 输入来源类型：0 用户输入，3 自定义变量（API参数） 示例值：0 |
| UserInputValue | AgentInputUserInputValue | 否 | 用户手写输入 |
| CustomVarId | String | 否 | 自定义变量（API参数） 示例值：927175de-d2ae-4a26-839c-6b6c6d0ea4d7 |
AgentInputUserInputValue
用户手写输入
被如下接口引用：CreateAgent, DescribeAppAgentList, ModifyAgent。
| 名称 | 类型 | 必选 | 描述 |
|---|---|---|---|
| Values | Array of String | 否 | 用户输入的值 示例值：['text'] |
AgentKnowledgeAttrLabel
标签过滤器
被如下接口引用：CreateAgent, DescribeAppAgentList, ModifyAgent。
| 名称 | 类型 | 必选 | 描述 |
|---|---|---|---|
| AttributeBizId | String | 否 | 属性ID 示例值：1922991044897213888 |
| Inputs | Array of AgentInput | 否 | 标签值，标签值之间是或的关系，只有匹配的，才会进行知识检索，否则报检索不到 |
AgentKnowledgeFilter
知识检索筛选范围
被如下接口引用：CreateAgent, DescribeAppAgentList, ModifyAgent。
| 名称 | 类型 | 必选 | 描述 |
|---|---|---|---|
| FilterType | Integer | 否 | 知识检索筛选方式; 0: 全部知识; 1:按文档和问答; 2: 按标签 示例值：0 |
| DocAndAnswer | AgentKnowledgeFilterDocAndAnswer | 否 | 文档和问答过滤器 |
| Tag | AgentKnowledgeFilterTag | 否 | 标签过滤器 |
AgentKnowledgeFilterDocAndAnswer
文档和问答过滤器
被如下接口引用：CreateAgent, DescribeAppAgentList, ModifyAgent。
| 名称 | 类型 | 必选 | 描述 |
|---|---|---|---|
| DocBizIds | Array of String | 否 | 文档ID列表 示例值：["1923271504777045952"] |
| AllQa | Boolean | 否 | 问答 示例值：false |
AgentKnowledgeFilterTag
标签过滤器
被如下接口引用：CreateAgent, DescribeAppAgentList, ModifyAgent。
| 名称 | 类型 | 必选 | 描述 |
|---|---|---|---|
| Operator | Integer | 否 | 标签之间的关系;0:AND, 1:OR 示例值：1 |
| Labels | Array of AgentKnowledgeAttrLabel | 否 | 标签 |
AgentKnowledgeQAPlugin
知识库问答插件
被如下接口引用：CreateAgent, DescribeAppAgentList, ModifyAgent。
| 名称 | 类型 | 必选 | 描述 |
|---|---|---|---|
| Filter | AgentKnowledgeFilter | 否 | 知识检索筛选范围 |
AgentMCPServerInfo
mcp的服务信息
被如下接口引用：CreateAgent, DescribeAppAgentList, ModifyAgent。
| 名称 | 类型 | 必选 | 描述 |
|---|---|---|---|
| McpServerUrl | String | 否 | mcp server URL地址 示例值：http://xxxx |
| Headers | Array of AgentPluginHeader | 否 | mcp server header信息 |
| Timeout | Integer | 否 | 超时时间，单位秒 示例值：5 |
| SseReadTimeout | Integer | 否 | sse服务超时时间，单位秒 示例值：300 |
AgentModelInfo
Agent 配置里面的模型定义
被如下接口引用：CreateAgent, DescribeAppAgentList, ModifyAgent。
| 名称 | 类型 | 必选 | 描述 |
|---|---|---|---|
| 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 |
AgentPluginHeader
应用配置MCP插件header信息
被如下接口引用：CreateAgent, DescribeAppAgentList, ModifyAgent。
| 名称 | 类型 | 必选 | 描述 |
|---|---|---|---|
| ParamName | String | 否 | 参数名称 |
| ParamValue | String | 否 | 参数值 |
| GlobalHidden | Boolean | 否 | header参数配置是否隐藏不可见 示例值：false |
| Input | AgentInput | 否 | 输入的值 |
| IsRequired | Boolean | 否 | 参数是否可以为空 示例值：true |
AgentPluginInfo
Agent 的插件信息
被如下接口引用：CreateAgent, DescribeAppAgentList, ModifyAgent。
| 名称 | 类型 | 必选 | 描述 |
|---|---|---|---|
| PluginId | String | 否 | 插件id 示例值：0960ae93-80a0-408d-928b-f484064f834a |
| Headers | Array of AgentPluginHeader | 否 | 应用配置的插件header信息 |
| Model | AgentModelInfo | 否 | 插件调用LLM时使用的模型配置，一般用于指定知识库问答插件的生成模型 |
| PluginInfoType | Integer | 否 | 插件信息类型; 0: 未指定类型; 1: 知识库问答插件 示例值：0 |
| KnowledgeQa | AgentKnowledgeQAPlugin | 否 | 知识库问答插件配置 |
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，表示取不到有效值。 |
| DisplayContent | String | 否 | 展示的具体文本内容 注意：此字段可能返回 null，表示取不到有效值。 |
| DisplayType | Integer | 否 | 展示类型 注意：此字段可能返回 null，表示取不到有效值。 示例值：1：搜索引擎参考来源；2：知识库参考来源 |
| 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 | String | 否 | id 注意：此字段可能返回 null，表示取不到有效值。 |
| Name | String | 否 | 名称 注意：此字段可能返回 null，表示取不到有效值。 |
| Type | Integer | 否 | 类型 注意：此字段可能返回 null，表示取不到有效值。 |
| Url | String | 否 | 链接 注意：此字段可能返回 null，表示取不到有效值。 |
| DocBizId | String | 否 | 文档业务ID 注意：此字段可能返回 null，表示取不到有效值。 |
| DocName | String | 否 | 文档名称 注意：此字段可能返回 null，表示取不到有效值。 |
| QaBizId | String | 否 | 问答业务ID 注意：此字段可能返回 null，表示取不到有效值。 |
| Index | Integer | 否 | 搜索引擎索引 注意：此字段可能返回 null，表示取不到有效值。 |
| Title | 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，表示取不到有效值。 |
| Files | Array of FileInfo | 文件信息 注意：此字段可能返回 null，表示取不到有效值。 |
AgentToolInfo
Agent的工具信息
被如下接口引用：CreateAgent, DescribeAppAgentList, ModifyAgent。
| 名称 | 类型 | 必选 | 描述 |
|---|---|---|---|
| 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 |
AgentToolReqParam
Agent工具的请求参数定义
被如下接口引用：CreateAgent, DescribeAppAgentList, ModifyAgent。
| 名称 | 类型 | 必选 | 描述 |
|---|---|---|---|
| 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工具的响应参数定义
被如下接口引用：CreateAgent, DescribeAppAgentList, ModifyAgent。
| 名称 | 类型 | 必选 | 描述 |
|---|---|---|---|
| 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，表示取不到有效值。 |
| AppTypeDesc | String | 否 | 应用类型描述 注意：此字段可能返回 null，表示取不到有效值。 |
| AppBizId | String | 否 | 应用ID 注意：此字段可能返回 null，表示取不到有效值。 |
| Name | String | 否 | 应用名称 注意：此字段可能返回 null，表示取不到有效值。 |
| Avatar | String | 否 | 应用头像 注意：此字段可能返回 null，表示取不到有效值。 |
| Desc | String | 否 | 应用描述 注意：此字段可能返回 null，表示取不到有效值。 |
| AppStatus | Integer | 否 | 应用状态，1：未上线，2：运行中，3：停用 注意：此字段可能返回 null，表示取不到有效值。 |
| AppStatusDesc | String | 否 | 状态说明 注意：此字段可能返回 null，表示取不到有效值。 |
| UpdateTime | String | 否 | 修改时间 注意：此字段可能返回 null，表示取不到有效值。 |
| Operator | String | 否 | 最后修改人 注意：此字段可能返回 null，表示取不到有效值。 |
| ModelName | String | 否 | 模型名称 注意：此字段可能返回 null，表示取不到有效值。 |
| ModelAliasName | String | 否 | 生成模型别名 注意：此字段可能返回 null，表示取不到有效值。 |
| Pattern | String | 否 | 应用模式 standard:标准模式, agent: agent模式，single_workflow：单工作流模式 注意：此字段可能返回 null，表示取不到有效值。 |
| ThoughtModelAliasName | 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，表示取不到有效值。 |
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，表示取不到有效值。 |
| AttrKey | String | 标签标识 注意：此字段可能返回 null，表示取不到有效值。 |
| AttrName | String | 标签名称 注意：此字段可能返回 null，表示取不到有效值。 |
| LabelNames | Array of String | 标签值名称 注意：此字段可能返回 null，表示取不到有效值。 |
| IsUpdating | Boolean | 标签是否在更新中 注意：此字段可能返回 null，表示取不到有效值。 |
| Status | Integer | 状态 注意：此字段可能返回 null，表示取不到有效值。 |
| StatusDesc | String | 状态描述 注意：此字段可能返回 null，表示取不到有效值。 |
| LabelTotalCount | String | 标签值总数 |
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 | 标签值引用的工作流列表 |
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，表示取不到有效值。 |
| Name | String | 分类名称 注意：此字段可能返回 null，表示取不到有效值。 |
| Total | Integer | 分类下的Record（如文档、同义词等）数量 注意：此字段可能返回 null，表示取不到有效值。 |
| CanAdd | Boolean | 是否可新增 注意：此字段可能返回 null，表示取不到有效值。 |
| CanEdit | Boolean | 是否可编辑 注意：此字段可能返回 null，表示取不到有效值。 |
| CanDelete | Boolean | 是否可删除 注意：此字段可能返回 null，表示取不到有效值。 |
| Children | Array of CateInfo | 子分类 注意：此字段可能返回 null，表示取不到有效值。 |
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，表示取不到有效值。 |
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，表示取不到有效值。 |
Coord
坐标
被如下接口引用：ReconstructDocument。
| 名称 | 类型 | 描述 |
|---|---|---|
| X | Integer | 横坐标 |
| Y | Integer | 纵坐标 |
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 |
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 | 文档的自定义链接 |
DocumentElement
文档元素字段
被如下接口引用：ReconstructDocument。
| 名称 | 类型 | 描述 |
|---|---|---|
| Index | Integer | 文档元素索引 注意：此字段可能返回 null，表示取不到有效值。 |
| Type | String | 元素类型，包括paragraph、table、formula、figure、title、header、footer、figure_text 注意：此字段可能返回 null，表示取不到有效值。 |
| Text | String | 元素内容，当type为figure或formula(公式识别关闭)时该字段内容为图片的位置 注意：此字段可能返回 null，表示取不到有效值。 |
| Polygon | Polygon | 元素坐标，左上角(x1, y1)，右上角(x2, y2)，右下角(x3, y3)，左下角(x4, y4) 注意：此字段可能返回 null，表示取不到有效值。 |
| Level | Integer | 元素层级 注意：此字段可能返回 null，表示取不到有效值。 |
| InsetImageName | String | 入参开启EnableInsetImage后返回，表示在InsetImagePackage中的内嵌图片名称 注意：此字段可能返回 null，表示取不到有效值。 |
| Elements | Array of DocumentElement | 嵌套的文档元素信息，一般包含的是文档内嵌入图片的文字识别结果 注意：此字段可能返回 null，表示取不到有效值。 |
DocumentRecognizeInfo
单页文档识别的内容
被如下接口引用：ReconstructDocument。
| 名称 | 类型 | 描述 |
|---|---|---|
| PageNumber | Integer | 输入PDF文件的页码，从1开始。输入图片的话值始终为1 注意：此字段可能返回 null，表示取不到有效值。 |
| Angle | Integer | 旋转角度 注意：此字段可能返回 null，表示取不到有效值。 |
| Height | Integer | AI算法识别处理后的图片高度 注意：此字段可能返回 null，表示取不到有效值。 |
| Width | Integer | AI算法识别处理后的图片宽度 注意：此字段可能返回 null，表示取不到有效值。 |
| OriginHeight | Integer | 图片的原始高度，输入PDF文件则表示单页PDF转图片之后的图片高度 注意：此字段可能返回 null，表示取不到有效值。 |
| OriginWidth | Integer | 图片的原始宽度，输入PDF文件则表示单页PDF转图片之后的图片宽度 注意：此字段可能返回 null，表示取不到有效值。 |
| Elements | Array of DocumentElement | 文档元素信息 注意：此字段可能返回 null，表示取不到有效值。 |
| RotatedAngle | Float | 旋转角度 注意：此字段可能返回 null，表示取不到有效值。 |
EmbeddingObject
向量
被如下接口引用：GetEmbedding。
| 名称 | 类型 | 必选 | 描述 |
|---|---|---|---|
| Embedding | Array of Float | 否 | 向量 |
ExtraInfo
扩展信息
被如下接口引用：GetMsgRecord。
| 名称 | 类型 | 必选 | 描述 |
|---|---|---|---|
| EChartsInfo | Array of String | 否 | ECharts信息 注意：此字段可能返回 null，表示取不到有效值。 |
FileInfo
实时上传的文件信息
被如下接口引用：GetMsgRecord。
| 名称 | 类型 | 描述 |
|---|---|---|
| FileName | String | 文件名称 注意：此字段可能返回 null，表示取不到有效值。 |
| FileSize | String | 文件大小 注意：此字段可能返回 null，表示取不到有效值。 |
| FileUrl | String | 文件的URL地址，COS地址 注意：此字段可能返回 null，表示取不到有效值。 |
| FileType | String | 文件类型 注意：此字段可能返回 null，表示取不到有效值。 |
| DocId | String | 解析后返回的DocID 注意：此字段可能返回 null，表示取不到有效值。 |
| CreatedAt | String | 创建时间 注意：此字段可能返回 null，表示取不到有效值。 |
Filters
不满意回复检索过滤
被如下接口引用：ExportUnsatisfiedReply。
| 名称 | 类型 | 必选 | 描述 |
|---|---|---|---|
| Query | String | 否 | 检索，用户问题或答案 |
| Reasons | Array of String | 否 | 错误类型检索 |
GetWsTokenReq_Label
获取ws token label
被如下接口引用：GetWsToken。
| 名称 | 类型 | 必选 | 描述 |
|---|---|---|---|
| Name | String | 否 | 标签名 |
| Values | Array of String | 否 | 标签值 |
Highlight
分片高亮内容
被如下接口引用：DescribeQA, DescribeRefer。
| 名称 | 类型 | 必选 | 描述 |
|---|---|---|---|
| StartPos | String | 否 | 高亮起始位置 注意：此字段可能返回 null，表示取不到有效值。 |
| EndPos | String | 否 | 高亮结束位置 注意：此字段可能返回 null，表示取不到有效值。 |
| Text | String | 否 | 高亮子文本 注意：此字段可能返回 null，表示取不到有效值。 |
HistorySummary
多轮历史信息
被如下接口引用：GetMsgRecord。
| 名称 | 类型 | 必选 | 描述 |
|---|---|---|---|
| Assistant | String | 否 | 助手 注意：此字段可能返回 null，表示取不到有效值。 |
| User | String | 否 | 用户 注意：此字段可能返回 null，表示取不到有效值。 |
IntentAchievement
意图达成方式
被如下接口引用：DescribeApp, ModifyApp。
| 名称 | 类型 | 必选 | 描述 |
|---|---|---|---|
| Name | String | 否 | 意图达成方式，qa:问答回复、doc：文档回复、workflow：工作流回复，llm：大模型回复 示例值：qa |
| Desc | String | 否 | 意图达成方式描述 示例值：问答回复 |
InvokeAPI
请求的API信息
被如下接口引用：GetMsgRecord。
| 名称 | 类型 | 必选 | 描述 |
|---|---|---|---|
| Method | String | 否 | 请求方法，如GET/POST等 注意：此字段可能返回 null，表示取不到有效值。 |
| Url | String | 否 | 请求地址 注意：此字段可能返回 null，表示取不到有效值。 |
| HeaderValues | Array of StrValue | 否 | header参数 注意：此字段可能返回 null，表示取不到有效值。 |
| QueryValues | Array of StrValue | 否 | 入参Query 注意：此字段可能返回 null，表示取不到有效值。 |
| RequestPostBody | String | 否 | Post请求的原始数据 注意：此字段可能返回 null，表示取不到有效值。 |
| ResponseBody | String | 否 | 返回的原始数据 注意：此字段可能返回 null，表示取不到有效值。 |
| ResponseValues | Array of ValueInfo | 否 | 出参 注意：此字段可能返回 null，表示取不到有效值。 |
| FailMessage | String | 否 | 异常信息 注意：此字段可能返回 null，表示取不到有效值。 |
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 |
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，表示取不到有效值。 |
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，表示取不到有效值。 |
| 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，表示取不到有效值。 |
| AiCall | AICallConfig | 否 | 配置语音通话参数 注意：此字段可能返回 null，表示取不到有效值。 |
| ShareKnowledgeBases | Array of ShareKnowledgeBase | 否 | 共享知识库关联配置 |
KnowledgeQaOutput
应用管理输出配置
被如下接口引用：DescribeApp, ModifyApp。
| 名称 | 类型 | 必选 | 描述 |
|---|---|---|---|
| Method | Integer | 否 | 输出方式 1：流式 2：非流式 注意：此字段可能返回 null，表示取不到有效值。 |
| UseGeneralKnowledge | Boolean | 否 | 通用模型回复 注意：此字段可能返回 null，表示取不到有效值。 |
| BareAnswer | String | 否 | 未知回复语，300字符以内 注意：此字段可能返回 null，表示取不到有效值。 |
| ShowQuestionClarify | Boolean | 否 | 是否展示问题澄清开关 注意：此字段可能返回 null，表示取不到有效值。 |
| UseQuestionClarify | Boolean | 否 | 是否打开问题澄清 注意：此字段可能返回 null，表示取不到有效值。 |
| QuestionClarifyKeywords | Array of String | 否 | 问题澄清关键词列表 注意：此字段可能返回 null，表示取不到有效值。 |
| UseRecommended | Boolean | 否 | 是否打开推荐问题开关 注意：此字段可能返回 null，表示取不到有效值。 |
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 |
KnowledgeSummary
检索知识
被如下接口引用：GetMsgRecord。
| 名称 | 类型 | 必选 | 描述 |
|---|---|---|---|
| Type | Integer | 否 | 1是问答 2是文档片段 注意：此字段可能返回 null，表示取不到有效值。 |
| Content | String | 否 | 知识内容 注意：此字段可能返回 null，表示取不到有效值。 |
KnowledgeUpdateInfo
共享知识库更新信息
被如下接口引用：UpdateSharedKnowledge。
| 名称 | 类型 | 必选 | 描述 |
|---|---|---|---|
| KnowledgeName | String | 否 | 共享知识库名称 示例值：共享知识库1 |
| KnowledgeDescription | String | 否 | 共享知识库描述 注意：此字段可能返回 null，表示取不到有效值。 示例值：计算机基础理论知识库 |
| EmbeddingModel | String | 否 | Embedding模型 注意：此字段可能返回 null，表示取不到有效值。 示例值：general-text-embedding-v2.7 |
| QaExtractModel | String | 否 | 问答提取模型 注意：此字段可能返回 null，表示取不到有效值。 示例值：general-qa-extract-v1.8 |
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，表示取不到有效值。 |
ListAppCategoryRspOption
应用类型详情
被如下接口引用：ListAppCategory。
| 名称 | 类型 | 描述 |
|---|---|---|
| Text | String | 类型名称 注意：此字段可能返回 null，表示取不到有效值。 |
| Value | String | 类型值 注意：此字段可能返回 null，表示取不到有效值。 |
| Logo | String | 类型log 注意：此字段可能返回 null，表示取不到有效值。 |
ListDocItem
文档列表详情描述
被如下接口引用：ListDoc。
| 名称 | 类型 | 描述 |
|---|---|---|
| DocBizId | String | 文档ID 注意：此字段可能返回 null，表示取不到有效值。 |
| FileName | String | 文件名称 注意：此字段可能返回 null，表示取不到有效值。 |
| NewName | String | 重命名的新文档名称，在重命名提交之后，文档发布之前都是这个名称 |
| FileType | String | 文件类型 注意：此字段可能返回 null，表示取不到有效值。 |
| CosUrl | String | cos路径 注意：此字段可能返回 null，表示取不到有效值。 |
| UpdateTime | String | 更新时间 注意：此字段可能返回 null，表示取不到有效值。 |
| Status | Integer | 文档状态 注意：此字段可能返回 null，表示取不到有效值。 |
| StatusDesc | String | 文档状态描述 注意：此字段可能返回 null，表示取不到有效值。 |
| Reason | String | 原因 注意：此字段可能返回 null，表示取不到有效值。 |
| IsRefer | Boolean | 答案中是否引用 注意：此字段可能返回 null，表示取不到有效值。 |
| QaNum | Integer | 问答对数量 注意：此字段可能返回 null，表示取不到有效值。 |
| IsDeleted | Boolean | 是否已删除 注意：此字段可能返回 null，表示取不到有效值。 |
| Source | Integer | 文档来源 注意：此字段可能返回 null，表示取不到有效值。 |
| SourceDesc | String | 文档来源描述 注意：此字段可能返回 null，表示取不到有效值。 |
| IsAllowRestart | Boolean | 是否允许重新生成 注意：此字段可能返回 null，表示取不到有效值。 |
| IsDeletedQa | Boolean | qa是否已删除 注意：此字段可能返回 null，表示取不到有效值。 |
| IsCreatingQa | Boolean | 问答是否生成中 注意：此字段可能返回 null，表示取不到有效值。 |
| IsAllowDelete | Boolean | 是否允许删除 注意：此字段可能返回 null，表示取不到有效值。 |
| IsAllowRefer | Boolean | 是否允许操作引用开关 注意：此字段可能返回 null，表示取不到有效值。 |
| IsCreatedQa | Boolean | 问答是否生成过 注意：此字段可能返回 null，表示取不到有效值。 |
| DocCharSize | String | 文档字符量 注意：此字段可能返回 null，表示取不到有效值。 |
| AttrRange | Integer | 属性标签适用范围 注意：此字段可能返回 null，表示取不到有效值。 |
| AttrLabels | Array of AttrLabel | 属性标签 注意：此字段可能返回 null，表示取不到有效值。 |
| IsAllowEdit | Boolean | 是否允许编辑 注意：此字段可能返回 null，表示取不到有效值。 |
| ReferUrlType | Integer | 外部引用链接类型 0：系统链接 1：自定义链接 值为1时，WebUrl 字段不能为空，否则不生效。 注意：此字段可能返回 null，表示取不到有效值。 |
| WebUrl | String | 网页(或自定义链接)地址 注意：此字段可能返回 null，表示取不到有效值。 |
| ExpireStart | String | 有效开始时间，unix时间戳 注意：此字段可能返回 null，表示取不到有效值。 |
| ExpireEnd | String | 有效结束时间，unix时间戳，0代表永久有效 注意：此字段可能返回 null，表示取不到有效值。 |
| IsAllowRetry | Boolean | 是否允许重试，0：否，1：是 注意：此字段可能返回 null，表示取不到有效值。 |
| Processing | Array of Integer | 0:文档比对处理 1:文档生成问答 注意：此字段可能返回 null，表示取不到有效值。 |
| CreateTime | String | 文档创建落库时间 注意：此字段可能返回 null，表示取不到有效值。 |
| CateBizId | String | 文档所属分类ID |
| CustomerKnowledgeId | String | 文档的用户自定义ID |
| AttributeFlags | Array of Integer | 文档的属性标记，0: 不做用户外部权限校验 |
| IsDisabled | Boolean | false:未停用，ture:已停用 |
ListQaItem
问答详情数据
被如下接口引用：ListQA。
| 名称 | 类型 | 描述 |
|---|---|---|
| QaBizId | String | 问答ID |
| Question | String | 问题 |
| Answer | String | 答案 |
| Source | Integer | 来源 |
| SourceDesc | String | 来源描述 |
| UpdateTime | String | 更新时间 |
| Status | Integer | 状态 |
| StatusDesc | String | 状态描述 |
| DocBizId | String | 文档ID |
| CreateTime | String | 创建时间 |
| IsAllowEdit | Boolean | 是否允许编辑 |
| IsAllowDelete | Boolean | 是否允许删除 |
| IsAllowAccept | Boolean | 是否允许校验 |
| FileName | String | 文档名称 |
| FileType | String | 文档类型 |
| QaCharSize | String | 问答字符数 |
| ExpireStart | String | 有效开始时间，unix时间戳 |
| ExpireEnd | String | 有效结束时间，unix时间戳，0代表永久有效 |
| AttrRange | Integer | 属性标签适用范围 1：全部，2：按条件 |
| AttrLabels | Array of AttrLabel | 属性标签 |
| SimilarQuestionNum | Integer | 相似问个数 |
| SimilarQuestionTips | String | 返回问答关联的相似问,联动搜索,仅展示一条 |
| IsDisabled | Boolean | 问答是否停用，false:未停用，ture:已停用 |
ListReleaseItem
发布列表详情
被如下接口引用：ListRelease。
| 名称 | 类型 | 描述 |
|---|---|---|
| ReleaseBizId | String | 版本ID |
| Operator | String | 发布人 |
| Desc | String | 发布描述 |
| UpdateTime | String | 更新时间 |
| Status | Integer | 发布状态 |
| StatusDesc | String | 发布状态描述 |
| Reason | String | 失败原因 |
| SuccessCount | Integer | 发布成功数 |
| FailCount | Integer | 发布失败数 |
Message
一条message代表一条对话记录
role表示角色 user或者assistant
content表示对话内容
被如下接口引用：QueryRewrite。
| 名称 | 类型 | 必选 | 描述 |
|---|---|---|---|
| Role | String | 是 | role表示角色 user标识用户提问，assistant标识返回的答案 注意：此字段可能返回 null，表示取不到有效值。 示例值：user; assistant |
| Content | String | 是 | 对话内容 注意：此字段可能返回 null，表示取不到有效值。 示例值：你好 |
ModelInfo
模型信息
被如下接口引用：ListModel。
| 名称 | 类型 | 必选 | 描述 |
|---|---|---|---|
| ModelName | String | 否 | 模型名称 注意：此字段可能返回 null，表示取不到有效值。 |
| ModelDesc | String | 否 | 模型描述 注意：此字段可能返回 null，表示取不到有效值。 |
| AliasName | String | 否 | 模型名称 注意：此字段可能返回 null，表示取不到有效值。 |
| ResourceStatus | Integer | 否 | 资源状态 1：资源可用；2：资源已用尽 注意：此字段可能返回 null，表示取不到有效值。 |
| 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 | 否 | 模型图标 |
| IsFree | Boolean | 否 | 是否免费 |
| InputLenLimit | Integer | 否 | 模型对话框可输入的上限 注意：此字段可能返回 null，表示取不到有效值。 |
| SupportWorkflowStatus | Integer | 否 | 支持工作流的类型 0:模型不支持; 1: 模型支持工作流； 2： 模型支持效果不佳； 注意：此字段可能返回 null，表示取不到有效值。 |
| ModelCategory | String | 否 | 模型类别 generate：生成模型，thought：思考模型 |
| IsDefault | Boolean | 否 | 是否默认模型 |
| RoleLenLimit | Integer | 否 | 角色提示词输入长度限制 |
| IsExclusive | Boolean | 否 | 是否专属并发模型 |
| SupportAiCallStatus | Integer | 否 | 模型支持智能通话效果 |
| Concurrency | Integer | 否 | 专属并发数 |
ModelParameter
模型参数范围
被如下接口引用：ListModel。
| 名称 | 类型 | 必选 | 描述 |
|---|---|---|---|
| Default | Float | 否 | 默认值 注意：此字段可能返回 null，表示取不到有效值。 |
| Min | Float | 否 | 最小值 注意：此字段可能返回 null，表示取不到有效值。 |
| Max | Float | 否 | 最大值 注意：此字段可能返回 null，表示取不到有效值。 |
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，表示取不到有效值。 |
| RecordId | String | 记录ID |
| RelatedRecordId | String | 关联记录ID |
| IsFromSelf | Boolean | 是否来自自己 |
| FromName | String | 发送者名称 |
| FromAvatar | String | 发送者头像 |
| Timestamp | String | 时间戳 |
| HasRead | Boolean | 是否已读 |
| Score | Integer | 评价 |
| CanRating | Boolean | 是否评分 |
| CanFeedback | Boolean | 是否展示反馈按钮 注意：此字段可能返回 null，表示取不到有效值。 |
| Type | Integer | 记录类型 |
| References | Array of MsgRecordReference | 引用来源 |
| Reasons | Array of String | 评价原因 |
| IsLlmGenerated | Boolean | 是否大模型 |
| ImageUrls | Array of String | 图片链接，可公有读 注意：此字段可能返回 null，表示取不到有效值。 |
| 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，表示取不到有效值。 |
| OptionCards | Array of String | 选项卡, 用于多轮对话 注意：此字段可能返回 null，表示取不到有效值。 |
| TaskFlow | TaskFlowInfo | 任务信息 注意：此字段可能返回 null，表示取不到有效值。 |
| FileInfos | Array of FileInfo | 用户传入的文件信息 注意：此字段可能返回 null，表示取不到有效值。 |
| QuoteInfos | Array of QuoteInfo | 参考来源引用位置信息 注意：此字段可能返回 null，表示取不到有效值。 |
| AgentThought | AgentThought | Agent的思考过程信息 注意：此字段可能返回 null，表示取不到有效值。 |
| ExtraInfo | ExtraInfo | 扩展信息 注意：此字段可能返回 null，表示取不到有效值。 |
| WorkFlow | WorkflowInfo | 工作流信息 注意：此字段可能返回 null，表示取不到有效值。 |
MsgRecordReference
聊天详情Refer
被如下接口引用：GetMsgRecord。
| 名称 | 类型 | 描述 |
|---|---|---|
| Id | String | id |
| Url | String | 链接 |
| Type | Integer | 类型 |
| Name | String | 名称 |
| DocId | String | 来源文档ID |
| KnowledgeName | String | 知识库名称 |
| KnowledgeBizId | String | 知识库业务id |
| DocBizId | String | 文档业务id |
| QaBizId | String | 问答业务id |
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内容超过限制的时候此字段才有值） |
| Output | String | 否 | 输出变量信息 示例值：{"Name": "张三"} |
| OutputRef | String | 否 | 节点的输出的完整内容的链接。（当Output内容超过限制的时候此字段才有值） |
| TaskOutput | String | 否 | 原始输出信息。部分节点才有值，如工具节点、代码节点 示例值：{"Name": "张三"} |
| TaskOutputRef | String | 否 | 任务的原始输出的完整内容的链接。（当TaskOutput内容超过限制的时候此字段才有值） |
| Log | String | 否 | 节点的日志 |
| LogRef | String | 否 | 节点的日志的完整内容的链接志（当Log内容超过限制的时候才有值） |
| 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，表示取不到有效值。 |
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类型参数 |
Polygon
文本的坐标，以四个顶点坐标表示
注意：此字段可能返回 null，表示取不到有效值
被如下接口引用：ReconstructDocument。
| 名称 | 类型 | 描述 |
|---|---|---|
| LeftTop | Coord | 左上顶点坐标 |
| RightTop | Coord | 右上顶点坐标 |
| RightBottom | Coord | 右下顶点坐标 |
| LeftBottom | Coord | 左下顶点坐标 |
Procedure
执行过程信息记录
被如下接口引用：GetMsgRecord。
| 名称 | 类型 | 必选 | 描述 |
|---|---|---|---|
| Name | String | 否 | 执行过程英语名 注意：此字段可能返回 null，表示取不到有效值。 |
| Title | String | 否 | 中文名, 用于展示 注意：此字段可能返回 null，表示取不到有效值。 |
| Status | String | 否 | 状态常量: 使用中: processing, 成功: success, 失败: failed 注意：此字段可能返回 null，表示取不到有效值。 |
| Count | Integer | 否 | 消耗 token 数 注意：此字段可能返回 null，表示取不到有效值。 |
| Debugging | ProcedureDebugging | 否 | 调试信息 注意：此字段可能返回 null，表示取不到有效值。 |
| ResourceStatus | Integer | 否 | 计费资源状态，1：可用，2：不可用 注意：此字段可能返回 null，表示取不到有效值。 |
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 | 否 | 自定义参数 |
QACate
获取QA分类分组
被如下接口引用：ListQACate。
| 名称 | 类型 | 描述 |
|---|---|---|
| CateBizId | String | QA分类的业务ID 注意：此字段可能返回 null，表示取不到有效值。 |
| Name | String | 分类名称 注意：此字段可能返回 null，表示取不到有效值。 |
| Total | Integer | 分类下QA数量 注意：此字段可能返回 null，表示取不到有效值。 |
| CanAdd | Boolean | 是否可新增 注意：此字段可能返回 null，表示取不到有效值。 |
| CanEdit | Boolean | 是否可编辑 注意：此字段可能返回 null，表示取不到有效值。 |
| CanDelete | Boolean | 是否可删除 注意：此字段可能返回 null，表示取不到有效值。 |
| Children | Array of QACate | 子分类 注意：此字段可能返回 null，表示取不到有效值。 |
QAList
问答列表
被如下接口引用：VerifyQA。
| 名称 | 类型 | 必选 | 描述 |
|---|---|---|---|
| QaBizId | String | 是 | 问答ID |
| IsAccepted | Boolean | 否 | 是否采纳 |
| CateBizId | String | 否 | 分类ID |
| Question | String | 否 | 问题 |
| Answer | String | 否 | 答案 |
QAQuery
QA查询参数
被如下接口引用：ExportQAList。
| 名称 | 类型 | 必选 | 描述 |
|---|---|---|---|
| PageNumber | Integer | 是 | 页码 |
| PageSize | Integer | 是 | 每页数量 |
| BotBizId | String | 是 | 应用ID |
| Query | String | 否 | 查询内容 |
| CateBizId | String | 否 | 分类ID |
| AcceptStatus | Array of Integer | 否 | 校验状态 |
| ReleaseStatus | Array of Integer | 否 | 发布状态 |
| DocBizId | String | 否 | 文档ID |
| QaBizId | String | 否 | QAID |
| Source | Integer | 否 | 来源 |
| QueryAnswer | String | 否 | 查询答案 |
| QueryType | String | 否 | 查询类型 filename 名称、 attribute 标签 |
QuoteInfo
搜索引擎参考来源索引
被如下接口引用：GetMsgRecord。
| 名称 | 类型 | 必选 | 描述 |
|---|---|---|---|
| Position | Integer | 否 | 参考来源位置 注意：此字段可能返回 null，表示取不到有效值。 示例值：100 |
| Index | String | 否 | 参考来源索引顺序 注意：此字段可能返回 null，表示取不到有效值。 示例值：1 |
ReconstructDocumentConfig
ReconstructDocument配置选项
被如下接口引用：ReconstructDocument。
| 名称 | 类型 | 必选 | 描述 |
|---|---|---|---|
| EnableInsetImage | Boolean | 否 | 生成的Markdown中是否嵌入图片 |
ReconstructDocumentFailedPage
文档解析失败记录
被如下接口引用：GetReconstructDocumentResult。
| 名称 | 类型 | 描述 |
|---|---|---|
| PageNumber | Integer | 失败页码 注意：此字段可能返回 null，表示取不到有效值。 |
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，表示取不到有效值。 |
| Question | String | 被拒答的问题 注意：此字段可能返回 null，表示取不到有效值。 |
| Status | Integer | 状态 注意：此字段可能返回 null，表示取不到有效值。 |
| StatusDesc | String | 状态描述 注意：此字段可能返回 null，表示取不到有效值。 |
| UpdateTime | String | 更新时间 注意：此字段可能返回 null，表示取不到有效值。 |
| IsAllowEdit | Boolean | 是否允许编辑 注意：此字段可能返回 null，表示取不到有效值。 |
| IsAllowDelete | Boolean | 是否允许删除 注意：此字段可能返回 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，表示取不到有效值。 |
| NodeId | String | 否 | 节点ID 注意：此字段可能返回 null，表示取不到有效值。 |
| NodeName | String | 否 | 节点名称 注意：此字段可能返回 null，表示取不到有效值。 |
| InvokeApi | InvokeAPI | 否 | 请求的API 注意：此字段可能返回 null，表示取不到有效值。 |
| SlotValues | Array of ValueInfo | 否 | 当前节点的所有槽位的值，key：SlotID。没有值的时候也要返回空。 注意：此字段可能返回 null，表示取不到有效值。 |
SearchRange
检索范围配置
被如下接口引用：DescribeApp, ModifyApp。
| 名称 | 类型 | 必选 | 描述 |
|---|---|---|---|
| Condition | String | 否 | 检索条件and/or 注意：此字段可能返回 null，表示取不到有效值。 |
| ApiVarAttrInfos | Array of ApiVarAttrInfo | 否 | 自定义变量和标签关系数据 注意：此字段可能返回 null，表示取不到有效值。 |
SearchStrategy
知识库检索策略
被如下接口引用：DescribeApp, ModifyApp。
| 名称 | 类型 | 必选 | 描述 |
|---|---|---|---|
| StrategyType | Integer | 否 | 检索策略类型 0:混合检索，1：语义检索 注意：此字段可能返回 null，表示取不到有效值。 |
| TableEnhancement | Boolean | 否 | Excel检索增强开关 注意：此字段可能返回 null，表示取不到有效值。 |
ShareKnowledgeBase
共享知识库配置
被如下接口引用：DescribeApp, ModifyApp。
| 名称 | 类型 | 必选 | 描述 |
|---|---|---|---|
| KnowledgeBizId | String | 否 | 共享知识库ID |
| SearchRange | SearchRange | 否 | 检索范围 |
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，表示取不到有效值。 示例值："" |
| 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，表示取不到有效值。 |
| Value | String | 否 | 值 注意：此字段可能返回 null，表示取不到有效值。 |
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 | 否 | 自定义变量文件默认名称 |
TaskFlowInfo
任务流程信息
被如下接口引用：GetMsgRecord。
| 名称 | 类型 | 描述 |
|---|---|---|
| TaskFlowId | String | 任务流程ID 注意：此字段可能返回 null，表示取不到有效值。 |
| TaskFlowName | String | 任务流程名称 注意：此字段可能返回 null，表示取不到有效值。 |
| QueryRewrite | String | Query 重写结果 注意：此字段可能返回 null，表示取不到有效值。 |
| HitIntent | String | 命中意图 注意：此字段可能返回 null，表示取不到有效值。 |
| Type | Integer | 任务流程回复类型 0: 任务流回复 1: 任务流静默 2: 任务流拉回话术 3: 任务流自定义回复 注意：此字段可能返回 null，表示取不到有效值。 |
TaskFlowSummary
任务流程调试信息
被如下接口引用：GetMsgRecord。
| 名称 | 类型 | 必选 | 描述 |
|---|---|---|---|
| IntentName | String | 否 | 任务流程名 注意：此字段可能返回 null，表示取不到有效值。 |
| UpdatedSlotValues | Array of ValueInfo | 否 | 实体列表 注意：此字段可能返回 null，表示取不到有效值。 |
| RunNodes | Array of RunNodeInfo | 否 | 节点列表 注意：此字段可能返回 null，表示取不到有效值。 |
| Purposes | Array of String | 否 | 意图判断 注意：此字段可能返回 null，表示取不到有效值。 |
TaskParams
任务参数
被如下接口引用：GetTaskStatus。
| 名称 | 类型 | 描述 |
|---|---|---|
| CosPath | String | 下载地址,需要通过cos桶临时密钥去下载 注意：此字段可能返回 null，表示取不到有效值。 |
TokenStat
当前执行的 token 统计信息
被如下接口引用：GetMsgRecord。
| 名称 | 类型 | 必选 | 描述 |
|---|---|---|---|
| SessionId | String | 否 | 会话 ID 注意：此字段可能返回 null，表示取不到有效值。 |
| RequestId | String | 否 | 请求 ID 注意：此字段可能返回 null，表示取不到有效值。 |
| RecordId | String | 否 | 对应哪条会话, 会话 ID, 用于回答的消息存储使用, 可提前生成, 保存消息时使用 注意：此字段可能返回 null，表示取不到有效值。 |
| UsedCount | Integer | 否 | token 已使用数 注意：此字段可能返回 null，表示取不到有效值。 |
| FreeCount | Integer | 否 | 免费 token 数 注意：此字段可能返回 null，表示取不到有效值。 |
| OrderCount | Integer | 否 | 订单总 token 数 注意：此字段可能返回 null，表示取不到有效值。 |
| StatusSummary | String | 否 | 当前执行状态汇总, 常量: 使用中: processing, 成功: success, 失败: failed 注意：此字段可能返回 null，表示取不到有效值。 |
| StatusSummaryTitle | String | 否 | 当前执行状态汇总后中文展示 注意：此字段可能返回 null，表示取不到有效值。 |
| Elapsed | Integer | 否 | 当前请求执行时间, 单位 ms 注意：此字段可能返回 null，表示取不到有效值。 |
| TokenCount | Integer | 否 | 当前请求消耗 token 数 注意：此字段可能返回 null，表示取不到有效值。 |
| Procedures | Array of Procedure | 否 | 执行过程信息 注意：此字段可能返回 null，表示取不到有效值。 |
| TraceId | String | 否 | 执行过程信息TraceId 注意：此字段可能返回 null，表示取不到有效值。 |
UnsatisfiedReply
不满意回复
被如下接口引用：ListUnsatisfiedReply。
| 名称 | 类型 | 描述 |
|---|---|---|
| ReplyBizId | String | 不满意回复ID 注意：此字段可能返回 null，表示取不到有效值。 |
| RecordBizId | String | 消息记录ID 注意：此字段可能返回 null，表示取不到有效值。 |
| Question | String | 用户问题 注意：此字段可能返回 null，表示取不到有效值。 |
| Answer | String | 应用回复 注意：此字段可能返回 null，表示取不到有效值。 |
| Reasons | Array of String | 错误类型 注意：此字段可能返回 null，表示取不到有效值。 |
Usage
消耗量
被如下接口引用：GetEmbedding, QueryRewrite, RunReRank。
| 名称 | 类型 | 描述 |
|---|---|---|
| TotalPages | Integer | 文档页数 示例值：10 |
| InputTokens | Integer | 输入token数 示例值：10 |
| OutputTokens | Integer | 输出token数 示例值：10 |
| TotalTokens | Integer | 总token数 示例值：10 |
UserBaseInfo
用户基础信息
被如下接口引用：DescribeSharedKnowledge, ListSharedKnowledge。
| 名称 | 类型 | 必选 | 描述 |
|---|---|---|---|
| UserBizId | String | 否 | 用户ID 示例值：1906370579678213376 |
| UserName | String | 否 | 用户名称 注意：此字段可能返回 null，表示取不到有效值。 示例值：AI助手1 |
ValueInfo
任务流程参数信息
被如下接口引用：GetMsgRecord。
| 名称 | 类型 | 必选 | 描述 |
|---|---|---|---|
| Id | String | 否 | 值ID 注意：此字段可能返回 null，表示取不到有效值。 |
| Name | String | 否 | 名称 注意：此字段可能返回 null，表示取不到有效值。 |
| ValueType | Integer | 否 | 值类型：0:未知或者空, 1:string, 2:int, 3:float, 4:bool, 5:array(字符串数组), 6: object_array(结构体数组), 7: object(结构体) 注意：此字段可能返回 null，表示取不到有效值。 |
| ValueStr | String | 否 | string 注意：此字段可能返回 null，表示取不到有效值。 |
| ValueInt | String | 否 | int（避免精度丢失使用字符串返回） 注意：此字段可能返回 null，表示取不到有效值。 |
| ValueFloat | Float | 否 | float 注意：此字段可能返回 null，表示取不到有效值。 |
| ValueBool | Boolean | 否 | bool 注意：此字段可能返回 null，表示取不到有效值。 |
| ValueStrArray | Array of String | 否 | array 注意：此字段可能返回 null，表示取不到有效值。 |
VoiceConfig
音色参数
被如下接口引用：DescribeApp, ModifyApp。
| 名称 | 类型 | 必选 | 描述 |
|---|---|---|---|
| VoiceType | Integer | 否 | 公有云音色id 注意：此字段可能返回 null，表示取不到有效值。 示例值：501001 |
| TimbreKey | String | 否 | 音色key 注意：此字段可能返回 null，表示取不到有效值。 示例值：tts_timbre_yuehua |
| VoiceName | String | 否 | 音色名称 注意：此字段可能返回 null，表示取不到有效值。 示例值：月华 |
WordRecognizeInfo
解析为 word 文档的结果
被如下接口引用：ConvertDocument。
| 名称 | 类型 | 描述 |
|---|---|---|
| PageNumber | Integer | 输入文件的页码数 注意：此字段可能返回 null，表示取不到有效值。 示例值：1 |
| WordBase64 | String | word的base64 注意：此字段可能返回 null，表示取不到有效值。 |
WorkFlowSummary
工作流程调试信息
被如下接口引用：GetMsgRecord。
| 名称 | 类型 | 必选 | 描述 |
|---|---|---|---|
| WorkflowId | String | 否 | 工作流ID 注意：此字段可能返回 null，表示取不到有效值。 |
| WorkflowName | String | 否 | 工作流名称 注意：此字段可能返回 null，表示取不到有效值。 示例值：挂号工作流 |
| WorkflowRunId | String | 否 | 工作流运行ID 注意：此字段可能返回 null，表示取不到有效值。 |
| RunNodes | Array of WorkflowRunNodeInfo | 否 | 节点信息 注意：此字段可能返回 null，表示取不到有效值。 |
| OptionCards | Array of String | 否 | 选项卡 注意：此字段可能返回 null，表示取不到有效值。 示例值：["选项A","选项B"] |
| Outputs | Array of String | 否 | 多气泡的输出结果 注意：此字段可能返回 null，表示取不到有效值。 示例值：["是的","请稍等，正在为您查询"] |
| WorkflowReleaseTime | String | 否 | 工作流发布时间，unix时间戳 注意：此字段可能返回 null，表示取不到有效值。 示例值：1746800121 |
WorkflowInfo
工作流信息
被如下接口引用：GetMsgRecord。
| 名称 | 类型 | 必选 | 描述 |
|---|---|---|---|
| WorkflowId | String | 否 | 工作流ID 注意：此字段可能返回 null，表示取不到有效值。 |
| WorkflowName | String | 否 | 工作流名称 注意：此字段可能返回 null，表示取不到有效值。 示例值：挂号工作流 |
| WorkflowRunId | String | 否 | 工作流运行ID 注意：此字段可能返回 null，表示取不到有效值。 |
| OptionCards | Array of String | 否 | 选项卡 注意：此字段可能返回 null，表示取不到有效值。 示例值：["选项A","选项B"] |
| Outputs | Array of String | 否 | 多气泡的输出结果 注意：此字段可能返回 null，表示取不到有效值。 示例值：["是的","请稍等，正在为您查询"] |
| WorkflowReleaseTime | String | 否 | 工作流发布时间，unix时间戳 注意：此字段可能返回 null，表示取不到有效值。 示例值：1746800121 |
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 | 否 | 名称 示例值：订酒店 |
| State | Integer | 否 | 运行状态。0: 排队中；1: 运行中；2: 运行成功；3: 运行失败； 4: 已取消 示例值：1 |
| FailMessage | String | 否 | 错误信息 示例值：工具节点运行失败。 |
| TotalTokens | Integer | 否 | 消耗的token总数 示例值：560 |
| CreateTime | String | 否 | 创建时间（毫秒时间戳） 示例值：1744707612000 |
| StartTime | String | 否 | 开始时间（毫秒时间戳） 示例值：1744707612000 |
| EndTime | String | 否 | 结束时间（毫秒时间戳） 示例值：1744707612000 |
| DialogJson | String | 否 | 工作流画布Json |
| Query | String | 否 | 用户的输入 示例值：我想订明天的酒店 |
| MainModelName | String | 否 | 主模型名称 示例值：workflow-pro |
| CustomVariables | Array of CustomVariable | 否 | API参数配置 示例值：[{"Name": "name", "Value":"张三"}}] |
WorkflowRunNodeInfo
工作流运行节点信息
被如下接口引用：GetMsgRecord。
| 名称 | 类型 | 必选 | 描述 |
|---|---|---|---|
| NodeId | String | 否 | 节点ID 注意：此字段可能返回 null，表示取不到有效值。 示例值："" |
| NodeType | Integer | 否 | 节点类型 注意：此字段可能返回 null，表示取不到有效值。 示例值：0 |
| NodeName | String | 否 | 节点名称 注意：此字段可能返回 null，表示取不到有效值。 示例值："" |
| Status | Integer | 否 | 状态 注意：此字段可能返回 null，表示取不到有效值。 示例值："" |
| Input | String | 否 | 输入 注意：此字段可能返回 null，表示取不到有效值。 示例值："" |
| Output | String | 否 | 输出 注意：此字段可能返回 null，表示取不到有效值。 示例值："" |
| TaskOutput | String | 否 | 任务输出 注意：此字段可能返回 null，表示取不到有效值。 示例值："" |
| FailMessage | String | 否 | 错误信息 注意：此字段可能返回 null，表示取不到有效值。 示例值："" |
| CostMilliSeconds | Integer | 否 | 花费时长 注意：此字段可能返回 null，表示取不到有效值。 示例值：0 |
| StatisticInfos | Array of StatisticInfo | 否 | 大模型输出信息 注意：此字段可能返回 null，表示取不到有效值。 示例值：[] |
