帮你快速理解、总结文档立即下载

数据结构

最近更新时间:2026-09-23 01:04:56
我的收藏

AICallConfig

智能通话配置

被如下接口引用:ModifyApp。

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

AIOptimizeModel

AI一键优化模型配置

被如下接口引用:ModifyApp。

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

AccessKeyAuthConfig

AccessKey鉴权配置

被如下接口引用:CreatePlugin, ModifyPlugin。

名称 类型 必选 描述
ParamList Array of AccessKeyParamConfig 否

Access Key字段配置

PassThroughConfig AccessKeyPassThroughConfig 否

Access Key透传配置


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

Access Key 使用模式

枚举值:

  • 1: Access Key透传

示例值:1

AccessKeyParamConfig

Access Key 字段配置

被如下接口引用:CreatePlugin, ModifyPlugin。

名称 类型 必选 描述
FieldType Integer 否

Access Key 字段类型,1:AccessKeyId,2:AccessKeySecret,3:SessionToken


示例值:1
IsRequired Boolean 否

是否必填


示例值:true
ParamName String 否

header/query 字段名


示例值:SecretId
ParamValue String 否

AccessKey密钥默认值,允许为空


示例值:****

AccessKeyPassThroughConfig

Access Key 透传配置

被如下接口引用:CreatePlugin, ModifyPlugin。

名称 类型 必选 描述
KeyLocation Integer 否

Access Key 字段统一注入位置,0:Header,1:Query


示例值:0

AccountInfo

员工信息

被如下接口引用:DescribeAccountList, DescribeAuditLogList。

名称 类型 必选 描述
AccountUin String 否

员工子账号id


示例值:700000963993
NickName String 否

员工昵称


示例值:testadp111
Avatar String 否

员工头像


示例值:https://qidian-****-*********1.cos.ap-guangzhou.my*cloud.com/public/avatar_tiger02.png

AddOnPackageInfo

计费增值包用量信息

被如下接口引用:DescribeResourceSummary。

名称 类型 描述
AddOnTotal Float

增值包总量


示例值:0
AddOnUsage Float

增值包用量


示例值:0
ExclusiveConcurrency Integer

专属并发总数


示例值:0
ResourceStatus Integer

资源包状态

枚举值:

  • 1: 可使
  • 2: 已用完
  • 3: 已过期

示例值:1
ConcurrencyStatus Integer

专属并发状态

枚举值:

  • 1: 可使
  • 3: 已过期

示例值:1
ExclusiveTpm Integer

专属tpm


示例值:0
ExclusiveTpmStatus Integer

专属tpm状态

枚举值:

  • 1: 可使
  • 3: 已过期

示例值:1
ExclusiveComputeUnit Integer

专属计算单元


示例值:0
ExclusiveComputeUnitStatus Integer

专属计算单元状态

枚举值:

  • 1: 可使
  • 3: 已过期
  • 4: 已销毁
  • 5: 已隔离
  • 6: 未生效
  • 7: 暂不可用(套餐包过期时)

示例值:1

AgentAdvancedConfig

Agent高级设置

被如下接口引用:CreateAgent, DescribeAgentDetail, DescribeAgentSummaryList, ModifyAgent。

名称 类型 必选 描述
MaxReasoningRound Integer 否

最大推理轮数


示例值:30

AgentCollaborationConfig

[数据结构定义] Agent协同配置

被如下接口引用:ModifyApp。

名称 类型 必选 描述
AgentCollaborationMode Integer 是 协同方式。枚举值: 1:自由转交:Agent之间可自由传递任务, 2:工作流编排:基于预定义流程的协同, 3:Plan-and-Execute:规划与执行分离的协同模式
示例值:0
WorkflowId String 是 工作流Id
示例值:dd***das
WorkflowName String 是 工作流名称
示例值:我的工作流

AgentDetail

Agent 详情

被如下接口引用:DescribeAgentDetail。

名称 类型 描述
AgentId String

Agent ID


示例值:ab1b010c-edd9-4542-9f44-0a510d9377e1
Profile AgentProfile

Agent基本配置

Instructions String

系统提示词


示例值:你是一个clawAgent
Model AgentModelConfig

模型信息

ToolList Array of AgentTool

工具详情

PluginList Array of AgentPlugin

插件配置

SkillList Array of AgentSkill

技能详情

AdvancedConfig AgentAdvancedConfig

高级配置

ExternalToolList Array of AgentExternalToolConfig

调用方执行的 Function Tool 列表

入参限制:仅在 C 端用户态 Agent 场景可用,B 端配置态 Agent 忽略该字段与

AgentExternalToolConfig

调用方执行的 Function Tool 配置

被如下接口引用:CreateAgent, DescribeAgentDetail, ModifyAgent。

名称 类型 必选 描述
Type String 否

工具类型

入参限制:目前仅支持 "function"


示例值:function
Name String 否

工具名称


示例值:get_weather
Description String 否

工具描述


示例值:根据城市查询天气
Parameters Array of RequestParam 否

工具入参定义

AgentInput

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

被如下接口引用:CreateAgent, DescribeAgentDetail, ModifyAgent。

名称 类型 必选 描述
InputType Integer 否

输入来源类型:0 用户输入,3 自定义变量(API参数)


示例值:2
UserInputValue AgentUserInputValue 否

用户手写输入


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

系统参数


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

自定义变量(API参数)


示例值:1de4f872-7c73-42e3-9cf0-e33c7e73a271
EnvVariableId String 否

环境变量参数


示例值:1de4f872-7c73-42e3-9cf0-e33c7e73a271
AppVariableId String 否

应用变量参数


示例值:3ffe01e2-a102-4503-8170-35ac103d8780

AgentModelConfig

Agent 配置里面的模型定义

被如下接口引用:CreateAgent, DescribeAgentDetail, ModifyAgent。

名称 类型 必选 描述
ModelId String 否

模型唯一id


示例值:TCADP/gpt-5.5
Alias String 否

模型别名


示例值:GPT-5.5
ContextWordsLimit Integer 否

模型上下文长度字符限制


示例值:0
InstructionsWordsLimit Integer 否

指令长度字符限制


示例值:20000
ModelParameters ModelParams 否

模型参数


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

AgentPlugin

Agent 的插件信息

被如下接口引用:DescribeAgentDetail。

名称 类型 描述
Config AgentPluginConfig

插件基本配置

Name String

插件名称


示例值:图片生成(极速版)
IconUrl String

插件图标url


示例值:https://qidian-qbot-1251316161.cos.ap-guangzhou.myqcloud.com/public/plugin_files/03bigIcon%E5%A4%A7%E5%9B%BE%E6%A0%87%20%282%29.png
Description String

插件描述


示例值:基于混元大模型,可以根据用户输入的文本query,自动创作不同风格的图片(极速版)
PluginClass Integer

插件产品分类

枚举值:

  • 0: 普通插件
  • 1: 连接器类插件

示例值:0
Status Integer

插件状态

枚举值:

  • 0: 未知
  • 1: 可用
  • 2: 不可用

示例值:1
AuthConfigStatus Integer

插件鉴权配置状态

枚举值:

  • 0: 不需要授权
  • 1: 未配置
  • 2: 已配置

示例值:2

AgentPluginConfig

Agent 的插件基本配置

被如下接口引用:CreateAgent, DescribeAgentDetail, ModifyAgent。

名称 类型 必选 描述
PluginId String 否

插件id


示例值:bf8ad2f3-1e5c-410a-ae81-abd7c5c14f1c
HeaderParameterList Array of AgentPluginParameter 否

插件 Header 参数

QueryParameterList Array of AgentPluginParameter 否

插件 Query 参数

EnableCamRoleAuth Boolean 否

是否使用CAM一键授权,仅 auth_type=2时生效


示例值:true
AuthType Integer 否

授权类型

枚举值:

  • 0: 无鉴权
  • 1: API Key
  • 2: CAM授权
  • 3: OAuth2.0授权

示例值:2
OAuthConsent Integer 否

OAuth 授权同意模式;0-开发者授权;1-使用者授权(仅在auth_type=3时生效)


示例值:0
CredentialConfig AgentPluginCredentialConfig 否

凭证配置

AgentPluginCredentialConfig

Agent 插件凭据配置

被如下接口引用:CreateAgent, ModifyAgent。

名称 类型 必选 描述
AuthValueSource Integer 否

插件鉴权值来源

枚举值:

  • 0: 未指定
  • 1: 使用插件默认鉴权值,仅 APIKey/AccessKey 支持
  • 2: 引用凭证
  • 3: 引用变量

示例值:1
CredentialId String 否

凭证ID

入参限制:AuthValueSource=2时必填


示例值:K79A3**E6Gjk
ParamList Array of AgentPluginCredentialParam 否

参数配置

AgentPluginCredentialParam

Agent 插件凭据参数配置(变量模式)

被如下接口引用:CreateAgent, ModifyAgent。

名称 类型 必选 描述
KeyLocation Integer 否

参数位置

枚举值:

  • 0: Header 鉴权
  • 1: Query 鉴权

示例值:0
Name String 否

参数名称


示例值:SECRET_ID
Input AgentInput 否

参数取值来源

AgentPluginParameter

Agent 插件参数配置

被如下接口引用:CreateAgent, DescribeAgentDetail, ModifyAgent。

名称 类型 必选 描述
Name String 否

参数名称


示例值:SECRET_ID
IsRequired Boolean 否

是否必填


示例值:true
Input AgentInput 否

输入的值

AgentProfile

Agent 基本配置

被如下接口引用:CreateAgent, DescribeAgentDetail, DescribeAgentSummaryList, ModifyAgent。

名称 类型 必选 描述
Name String 否

Agent名称


示例值:h*claw
IconUrl String 否

图标URL


示例值:https://cdn.xiaowei.qq.com/static/lke/agent-robot.png
Role Integer 否

Agent 角色:0=主 / 1=子


示例值:1
Description String 否

Agent 描述


示例值:查询添加的子agent
AppName String 否

应用名称


示例值:hu*law
Developer String 否

开发者


示例值:c**1
ParentAgentId String 否

主AgentId,只读,不可通过修改接口进行变更


示例值:0f050c95-31b6-4d31-8c31-1fd6a6bafb4c

AgentRelease

Agent发布项目详情

被如下接口引用:DescribeAgentReleasePreviewList。

名称 类型 描述
ItemName String

名称


示例值:基础配置
UpdateTime String

更新时间, unix 秒时间戳 (s)


示例值:1776838008
ActionDescription String

动作描述


示例值:新增
ReleaseMessage String

变更为 测试


示例值:新增基础配置

AgentReleasePreview

Agent 发布预览信息

被如下接口引用:DescribeAgentReleasePreviewList。

名称 类型 描述
AgentId String

AgentID


示例值:e25e9a2b-**-f6f869e7cfb9
Name String

Agent名称


示例值:*_test
UpdateTime String

更新时间, unix 秒时间戳 (s)


示例值:1776838008
Action Integer

状态, 状态值:1:新增, 2:修改, 3:删除


示例值:1
ActionDescription String

动作描述


示例值:新增
Message String

发布消息


示例值:待发布变更 5 项
ReleaseList Array of AgentRelease

发布详情

AgentSkill

Agent 技能详情

被如下接口引用:DescribeAgentDetail。

名称 类型 描述
SkillId String

skillId


示例值:dd405ecb-***f3df021bc97d
Name String

skill名称


示例值:adp-skill-manager
Description String

技能描述


示例值:管理 ADP 技能广场技能
DisplayName String

skill展示名称


示例值:ADP技能管理
DisplayDescription String

技能展示描述


示例值:管理和发现技能
IconUrl String

skill图标url


示例值:https://qidian-****************************guangzhou.myqcloud.com/public/adp/skill/skill_icon/Excel-XLSX.png
SourceType Integer

Skill来源


示例值:1
CurrentVersion String

Skill版本


示例值:1.0.0

AgentSkillConfig

Agent 技能入参

被如下接口引用:CreateAgent, ModifyAgent。

名称 类型 必选 描述
SkillId String 否

技能ID


示例值:dd405ecb-232f-4344-bc3f-f3df021bc97d

AgentSpec

Agent 可编辑配置

被如下接口引用:CreateAgent, ModifyAgent。

名称 类型 必选 描述
Profile AgentProfile 否

Agent基本配置

Instructions String 否

系统提示词


示例值:你是一个ai助手
Model AgentModelConfig 否

主模型配置

ToolList Array of AgentToolConfig 否

工具信息

PluginList Array of AgentPluginConfig 否

插件信息

SkillList Array of AgentSkillConfig 否

技能信息

AdvancedConfig AgentAdvancedConfig 否

高级设置

ExternalToolList Array of AgentExternalToolConfig 否

调用方执行的 Function Tool 列表

入参限制:仅在 C 端用户态 Agent 场景可用,B 端配置态 Agent 忽略该字段与

AgentSummary

Agent摘要信息

被如下接口引用:DescribeAgentSummaryList。

名称 类型 描述
AgentId String

AgentId


示例值:a2865c63-ecf4-4b23-9a21-602d8c838111
Profile AgentProfile

Agent 身份画像

AdvancedConfig AgentAdvancedConfig

高级设置;scope=0 时返回

AgentSystemVariable

系统参数

被如下接口引用:CreateAgent, DescribeAgentDetail, ModifyAgent。

名称 类型 必选 描述
Name String 否

系统参数名


示例值:SYS.UserQuery
DialogHistoryLimit Integer 否

对话历史轮数的配置;如果Input是系统变量中的“对话历史”时才使用;


示例值:0

AgentTool

Agent 工具详情

被如下接口引用:DescribeAgentDetail。

名称 类型 描述
Config AgentToolBasicConfig

工具配置字段

Name String

工具名称


示例值:get_change_records
Status Integer

工具状态

枚举值:

  • 1: 可用
  • 2: 不可用
  • 3: 已失效

示例值:1
StreamMode Integer

调用方式

枚举值:

  • 0: 非流式
  • 1: 流式

示例值:0
ToolAccessMode Integer

工具访问模式

枚举值:

  • 0: 未指定
  • 1: 只读
  • 2: 写/删除

示例值:0

AgentToolBasicConfig

Agent的工具基础配置

被如下接口引用:CreateAgent, DescribeAgentDetail, ModifyAgent。

名称 类型 必选 描述
PluginId String 否

插件id


示例值:61a2635f-62f8-4e44-94fd-38cf07a9cc71
ToolId String 否

工具id


示例值:6f7a8b9c-0d1e-4f2a-3456-789abcdef01a
Description String 否

描述


示例值:查询企业作为被执行人的案件信息,包括执行标的、立案时间、执行法院,适用于企业债务执行情况了解、强制执行风险判断。
InputList Array of AgentToolInputParameter 否

工具输入参数列表


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

工具输出参数列表


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

工具Header参数列表


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

工具Query参数列表


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

工具来源: 0-来自插件,1-来自工作流


示例值:0
IsDisabled Boolean 否

是否禁用


示例值:false

AgentToolConfig

Agent 工具入参

被如下接口引用:CreateAgent, ModifyAgent。

名称 类型 必选 描述
Config AgentToolBasicConfig 否

工具配置

AgentToolInputParameter

Agent 工具输入参数定义

被如下接口引用:CreateAgent, DescribeAgentDetail, ModifyAgent。

名称 类型 必选 描述
Name String 否

工具名称


示例值:Query
Description 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
  • 20: ARRAY_ARRAY
  • 99: NULL

示例值:9
IsRequired Boolean 否

是否必填


示例值:true
SubParameterList Array of AgentToolInputParameter 否

子参数,仅 OBJECT 或 ARRAY<> 类型时使用


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

模式下是否对模型隐藏


示例值:true
OneOfList Array of AgentToolInputParameter 否

OneOf类型的参数


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

AnyOf类型的参数


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

参数取值来源


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

AgentToolOutputParameter

Agent 工具输出参数

被如下接口引用:CreateAgent, DescribeAgentDetail, ModifyAgent。

名称 类型 必选 描述
Name String 否

参数名称


示例值:References
Description String 否

变量描述


示例值:返回数据。Code为0:{},Code非0:RetrievalAnswer
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
  • 20: ARRAY_ARRAY
  • 99: NULL

示例值:1
SubParameterList Array of AgentToolOutputParameter 否

子参数,仅 OBJECT 或 ARRAY_OBJECT 类型时使用

RenderMode Integer 否

解析方式


示例值:0

AgentUserInputValue

用户输入值

被如下接口引用:CreateAgent, DescribeAgentDetail, ModifyAgent。

名称 类型 必选 描述
ValueList Array of String 否

用户输入参数值


示例值:["0.1"]

ApiKeyAuthConfig

ApiKey鉴权配置

被如下接口引用:CreatePlugin, ModifyPlugin。

名称 类型 必选 描述
KeyLocation Integer 是 密钥位置 HEADER/QUERY

枚举值:
| uint | 描述 |
| --- | --- |
| 0 | Header鉴权 |
| 1 | Query鉴权 |
示例值:0
KeyParamName String 是 密钥参数名
示例值:token
KeyParamValue String 是 密钥参数值
示例值:abcd123

ApiPluginConfig

API插件配置

被如下接口引用:CreatePlugin, ModifyPlugin。

名称 类型 必选 描述
AuthConfig AuthConfig 否 授权配置信息
注意:此字段可能返回 null,表示取不到有效值。

ApiToolConfig

ApiToolConfig

被如下接口引用:CreatePlugin, ModifyPlugin。

名称 类型 必选 描述
Body Array of RequestParam 否

请求体参数

Example ToolExample 否

示例

ExternalApiUrl String 否

API插件外部调用地址


示例值:https://adp.cloud.tencent.com/plugin/api/v1/fd215e08-ccb7-4968-8123-d5ccbdf440d3/2a35fdd4-fc6c-4c10-a65e-c4dc5e682d3a
Header Array of RequestParam 否

Header

Method String 否

请求方式


示例值:POST
Outputs Array of ResponseParam 否

输出

Query Array of RequestParam 否

查询参数

StreamMode Integer 否
枚举项枚举值描述
STREAM_MODE_UNARY0非流式
STREAM_MODE_STREAMING1流式

示例值:0
Url String 否

地址


示例值:http://xx.com/api

App

App 应用完整信息

被如下接口引用:DescribeApp。

名称 类型 必选 描述
AuxiliaryInfo AppAuxiliaryInfo 是

辅助信息(子状态/审批/申诉/搜索资源/特殊状态等)


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

配置


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

元数据


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

应用密钥信息


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

分享链接信息(含访问控制)


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

状态


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

应用引用的共享知识库列表

CorpShareConfig CorpShareConfig 否

企业共享配置


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

AppAdvancedConf

应用高级配置

被如下接口引用:ModifyApp。

名称 类型 必选 描述
EnableContextRewrite Boolean 是

是否开启上下文改写


示例值:false
EnableImageTextRetrieval Boolean 是

是否开启图文检索


示例值:false
ReplyFlexibility Integer 是

回复灵活度


示例值:1
DialogCustomConfig DialogCustomConfig 否

对话端自定义配置(所有模式共用,允许对话中动态修改配置)


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

意图达成优先级

AppAppeal

应用申诉信息(用户不可修改)

被如下接口引用:DescribeApp。

名称 类型 必选 描述
AppealingStatus AppealingStatus 是 申诉中的配置项
注意:此字段可能返回 null,表示取不到有效值。

AppAuxiliaryInfo

应用辅助信息 - 包含各类辅助状态和扩展信息(用户不可修改)

被如下接口引用:DescribeApp。

名称 类型 必选 描述
Appeal AppAppeal 是 申诉信息
注意:此字段可能返回 null,表示取不到有效值。
SearchResourceStatus SearchResourceStatusInfo 是 搜索资源状态
注意:此字段可能返回 null,表示取不到有效值。
SpecialStatusInfo SpecialStatusInfo 是 特殊状态信息
注意:此字段可能返回 null,表示取不到有效值。
SubStatus AppSubStatusInfo 是 子状态信息
注意:此字段可能返回 null,表示取不到有效值。

AppConfig

应用配置 - 用户可修改的所有配置

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

名称 类型 必选 描述
Experience AppExperienceConfig 是 体验配置
注意:此字段可能返回 null,表示取不到有效值。
Greeting AppGreetingConfig 是 欢迎语配置
注意:此字段可能返回 null,表示取不到有效值。
Memory AppMemoryConfig 是 记忆配置
注意:此字段可能返回 null,表示取不到有效值。
Mode AppModeConfig 是 模式相关配置
注意:此字段可能返回 null,表示取不到有效值。
Model AppModelConfig 是 模型配置
注意:此字段可能返回 null,表示取不到有效值。
WebSearch AppWebSearchConfig 是 联网搜索配置
注意:此字段可能返回 null,表示取不到有效值。
Workflow AppWorkflowConfig 是 工作流配置
注意:此字段可能返回 null,表示取不到有效值。

AppExperienceConfig

体验配置

被如下接口引用:ModifyApp。

名称 类型 必选 描述
Advanced AppAdvancedConf 是 高级配置
注意:此字段可能返回 null,表示取不到有效值。
Conversation ConversationExperience 是 对话体验配置
注意:此字段可能返回 null,表示取不到有效值。
Role RoleConfig 是 角色配置
注意:此字段可能返回 null,表示取不到有效值。

AppGreetingConfig

欢迎语配置

被如下接口引用:ModifyApp。

名称 类型 必选 描述
Greeting String 是

欢迎语内容


示例值:你好欢迎语
OpeningQuestionList Array of String 否

开场问题列表


示例值:["我的示例问题"]

AppMemoryConfig

记忆配置

被如下接口引用:ModifyApp。

名称 类型 必选 描述
Enabled Boolean 是 是否开启长记忆
示例值:false
LongMemoryDay Integer 是 长记忆时长
示例值:30
Model ModelDetailInfo 是 模型配置
注意:此字段可能返回 null,表示取不到有效值。
PromptContent String 是 prompt内容
示例值:prompt信息
PromptMode Integer 是 提示词模式。枚举值: 1:自定义
示例值:0

AppMetadata

应用元数据 - 基础标识和描述信息

被如下接口引用:DescribeApp。

名称 类型 必选 描述
AppId String 是 应用ID
示例值:206****5184
AppMode Integer 是 应用模式。枚举值: 1:标准模式, 2:Agent模式, 3:单工作流模式, 4:ClawAgent模式
示例值:1
Avatar String 是 应用头像
示例值:https://qidian-qbot-test-1251316161.cos.ap-guangzhou.myqcl**********************************************************ge/NrjBSfeRqMuNJalcGcNA-1981186399502619328.png
CreateTime String 是 创建时间 (Unix时间戳,秒级)
示例值:1780044175
Description String 是 应用描述
示例值:我的描述
Name String 是 应用名称
示例值:我的智能体应用03
SpaceId String 是 空间ID
示例值:default_space
UpdateTime String 是 更新时间 (Unix时间戳,秒级)
示例值:1780384282

AppModeConfig

模式配置 - 包含不同模式的独有配置

被如下接口引用:ModifyApp。

名称 类型 必选 描述
MultiAgentConfig MultiAgentConfig 是 多智能体配置(Agent模式)
注意:此字段可能返回 null,表示取不到有效值。
SingleWorkflowConfig SingleWorkflowConfig 是 单工作流配置(单工作流模式)
注意:此字段可能返回 null,表示取不到有效值。
ClawAgentConfig ClawAgentConfig 否 ClawAgent配置(ClawAgent模式)
注意:此字段可能返回 null,表示取不到有效值。

AppModelConfig

模型配置

被如下接口引用:ModifyApp。

名称 类型 必选 描述
AiOptimizeModel AIOptimizeModel 是 AI一键优化模型
注意:此字段可能返回 null,表示取不到有效值。
FileParseModel FileParseModel 是 实时文件解析模型
注意:此字段可能返回 null,表示取不到有效值。
GenerateModel GenerateModel 是 生成模型配置
注意:此字段可能返回 null,表示取不到有效值。
MultiModalQaModel MultiModalQAModel 是 多模态问答模型
注意:此字段可能返回 null,表示取不到有效值。
MultiModalUnderstandingModel MultiModalUnderstandingModel 是 多模态理解模型
注意:此字段可能返回 null,表示取不到有效值。
PromptRewriteModel PromptRewriteModel 是 Prompt改写模型
注意:此字段可能返回 null,表示取不到有效值。
ThinkModel ThinkModel 是 思考模型配置
注意:此字段可能返回 null,表示取不到有效值。

AppOperation

应用操作信息

被如下接口引用:DescribeAppSummaryList。

名称 类型 必选 描述
Creator String 是 创建人
示例值:user
CreatorUin String 是 创建人UIN
示例值:117890
CreatorUserAccount String 是 创建人账号(私有化场景使用)
示例值:创建人
UpdateTime String 是 修改时间 (Unix时间戳,秒级)
示例值:112345678965
Updater String 是 最后修改人
示例值:Updater
UpdaterUin String 是 修改人UIN
示例值:117890

AppPluginConfig

应用插件配置信息

被如下接口引用:CreatePlugin, ModifyPlugin。

名称 类型 必选 描述
AppId String 是 基于发布应用创建插件的应用ID
示例值:2054634579527622272

AppSecretInfo

应用密钥信息

被如下接口引用:DescribeApp。

名称 类型 必选 描述
AppKey String 是 应用密钥
示例值:cw**nptQWMSAtFeD
CreateTime String 是 创建时间
示例值:1780044174

AppShareAccessControl

AppShareAccessControl

被如下接口引用:CreateRelease, DescribeApp, DescribeLatestRelease, DescribeReleaseSummary。

名称 类型 必选 描述
AccessType Integer 否
枚举项枚举值描述
APP_SHARE_ACCESS_TYPE_UNSPECIFIED0
APP_SHARE_ACCESS_TYPE_PUBLIC1公开访问(所有用户都可访问)
APP_SHARE_ACCESS_TYPE_INTERNAL2内部访问(仅企业用户可访问)
APP_SHARE_ACCESS_TYPE_ACCOUNT_WHITELIST3账号白名单(指定UIN/手机/邮箱/IP可访问)

示例值:3
Enabled Boolean 否

是否开启访问控制

枚举值:

  • true: 启用
  • false: 禁用

示例值:true
Whitelist Array of AppShareWhitelistItem 否

白名单信息

AppShareURLInfo

分享链接信息(详情查询返回,用户不可修改部分;access_control 用户可修改部分由 ModifyApp 承载)

被如下接口引用:DescribeApp。

名称 类型 必选 描述
AccessControl AppShareAccessControl 是 当前生效的访问控制配置
注意:此字段可能返回 null,表示取不到有效值。
ShareUrl String 是 分享URL
示例值:https://tde.xiaowei.c****.tencen*

AppShareWhitelistItem

AppShareWhitelistItem

被如下接口引用:CreateRelease, DescribeLatestRelease, DescribeReleaseSummary。

名称 类型 必选 描述
Type Integer 否
枚举项枚举值描述
APP_SHARE_WHITELIST_TYPE_UNSPECIFIED0
APP_SHARE_WHITELIST_TYPE_UIN1UIN账号
APP_SHARE_WHITELIST_TYPE_PHONE2手机号码
APP_SHARE_WHITELIST_TYPE_EMAIL3邮箱地址
APP_SHARE_WHITELIST_TYPE_IP4IP地址
APP_SHARE_WHITELIST_TYPE_RTX5RTX账号

示例值:1
Values Array of String 否

白名单数组信息

参数格式:白名单值


示例值:["70000000"]

AppSharedKbInfo

应用引用的共享知识库简要信息(查询时仅返回ID和名称)

被如下接口引用:DescribeApp。

名称 类型 必选 描述
KbId String 是 共享知识库ID
示例值:2047150542445725376
KbName String 是 共享知识库名称
示例值:待删除-test-0423

AppStatusInfo

应用状态信息 - 运行时状态信息(用户不可修改)

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

名称 类型 必选 描述
Status Integer 是

应用状态

枚举值:

  • 1: 未上线
  • 2: 运行中
  • 3: 停用
  • 4: 导入中

示例值:2
StatusDescription String 是

状态描述


示例值:运行中

AppSubStatusInfo

应用子状态信息

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

名称 类型 必选 描述
ApprovalId String 是 审批记录ID (当sub_status_list包含PUBLISH_APPROVING时有效)
示例值:0
SubStatusList Array of Integer 否 应用子状态列表 (可能同时处于多个子状态)
示例值:[1]

AppSummary

应用摘要 - 列表查询返回的应用信息

被如下接口引用:DescribeAppSummaryList。

名称 类型 必选 描述
AppId String 是 应用ID
示例值:2060*20
AppMode Integer 是 应用模式。枚举值: 1:标准模式, 2:Agent模式, 3:单工作流模式, 4:ClawAgent模式
示例值:2
Avatar String 是 应用头像
示例值:https://cdn.xiaowei.qq.com/static/adp/app-default-avatar.png
Name String 是 应用名称
示例值:测试的应用信息
OperationInfo AppOperation 是 操作信息
注意:此字段可能返回 null,表示取不到有效值。
Status AppStatusInfo 是 状态信息
注意:此字段可能返回 null,表示取不到有效值。
SubStatus AppSubStatusInfo 是 子状态信息
注意:此字段可能返回 null,表示取不到有效值。
PermissionIdList Array of String 否 资源操作权限
示例值:["adpAppEdit"]

AppToolConfig

AppToolConfig

被如下接口引用:CreatePlugin, ModifyPlugin。

名称 类型 必选 描述
Inputs Array of RequestParam 否

输入参数

Outputs Array of ResponseParam 否

输出参数

AppTrigger

AppTrigger

被如下接口引用:DescribeAppTrigger, ModifyAppTrigger。

名称 类型 必选 描述
AppId String 否

应用ID


示例值:2078002407236474624
ExecuteConfig ExecuteConfig 否

执行配置

ExecuteType Integer 否
枚举项枚举值描述
APP_TRIGGER_EXECUTE_TYPE_UNSPECIFIED0未指定
APP_TRIGGER_EXECUTE_TYPE_PROMPT1指令执行
APP_TRIGGER_EXECUTE_TYPE_WORKFLOW2工作流执行

示例值:2
FailedCount String 否

失败次数


示例值:0
PushConfig TimerPushConfig 否

推送渠道配置

Scope Integer 否
枚举项枚举值描述
APP_TRIGGER_SCOPE_UNSPECIFIED0未指定
APP_TRIGGER_SCOPE_APP1B 端管理员
APP_TRIGGER_SCOPE_USER2C 端访客

示例值:2
Status Integer 否
枚举项枚举值描述
APP_TRIGGER_STATUS_UNSPECIFIED0未指定
APP_TRIGGER_STATUS_ENABLED1启用
APP_TRIGGER_STATUS_PAUSED2暂停
APP_TRIGGER_STATUS_DELETED3已删除

示例值:1
SuccessCount String 否

成功次数


示例值:0
TriggerConfig TriggerConfig 否

触发器配置

TriggerId String 否

触发器ID


示例值:b62b21d9-dff1-4841-b357-304ca4d7edfe
TriggerName String 否

触发器名称


示例值:C端测试(已修改)
TriggerStatus TriggerStatus 否

触发器状态

TriggerType Integer 否
枚举项枚举值描述
APP_TRIGGER_TYPE_UNSPECIFIED0未指定
APP_TRIGGER_TYPE_SCHEDULED1定时触发
APP_TRIGGER_TYPE_WEBHOOK2Webhook 触发

示例值:2
UserId String 否

访客ID


示例值:cuiyongchao

AppTriggerInstance

AppTriggerInstance

被如下接口引用:DescribeAppTriggerInstance。

名称 类型 必选 描述
AppId String 否

应用id


示例值:2078002407236474624
ConversationId String 否

会话id


示例值:b01cdf5f-0d55-4cc4-9137-7772593cd949
CreatedAt String 否

触发器创建时间


示例值:2026-07-29T10:52:51+08:00
FinishedAt String 否

结束时间


示例值:2026-07-29T10:52:58+08:00
InstanceId String 否

触发器运行实例id


示例值:728cbef2-f5df-4751-86af-75bc9bdc073d
RequestId String 否

请求ID


示例值:trigger_728cbef2-f5df-4751-86af-75bc9bdc073d
ResultCode String 否

结果码


示例值:SUCCESS
ResultSummary String 否

结果摘要


示例值:你好!有什么我可以帮你的吗?
RunId String 否

单次对话id


示例值:req_d6e503f0-bbe0-46bc-b4bb-290e15851a44
Scope Integer 否
枚举项枚举值描述
APP_TRIGGER_SCOPE_UNSPECIFIED0未指定
APP_TRIGGER_SCOPE_APP1B 端管理员
APP_TRIGGER_SCOPE_USER2C 端访客

示例值:2
Source Integer 否
枚举项枚举值描述
APP_TRIGGER_INSTANCE_SOURCE_UNSPECIFIED0未指定
APP_TRIGGER_INSTANCE_SOURCE_APP_TRIGGER1来源于应用触发器

示例值:1
StartedAt String 否

触发器开始执行时间


示例值:2026-07-29T10:52:51+08:00
Status Integer 否
枚举项枚举值描述
TIMER_RUN_STATUS_UNSPECIFIED0未指定
TIMER_RUN_STATUS_PENDING1等待执行
TIMER_RUN_STATUS_RUNNING2执行中
TIMER_RUN_STATUS_RETRY_WAIT3等待重试
TIMER_RUN_STATUS_SUCCESS4成功
TIMER_RUN_STATUS_DEAD5失败终态 (重试耗尽 / 不可重试)
TIMER_RUN_STATUS_CANCELLED6被任务暂停/删除/修改取消

示例值:4
TraceId String 否

TraceId,用于日志记录


示例值:ff1bc2b531ee4703b7569c52a18cbef0 / req_d6e503f0-bbe0-46bc-b4bb-290e15851a44
TriggerId String 否

触发器id


示例值:b62b21d9-dff1-4841-b357-304ca4d7edfe
UserId String 否

访客ID


示例值:cuiyongchao
WorkflowRunId String 否

工作流运行ID


示例值:wfr-0b3f2488-4255-4d54-b67e-2479a2a58fb3

AppTriggerParamBinding

AppTriggerParamBinding

被如下接口引用:CreateAppTrigger, DescribeAppTrigger, ModifyAppTrigger。

名称 类型 必选 描述
ParamName String 否

参数名字


示例值:info
ParamType Integer 否

参数类型

枚举值:

  • 0: 字符串
  • 1: 整数
  • 2: 浮点数
  • 4: 对象
  • 5: 字符串数组
  • 6: 整数数组
  • 7: 浮点数数组
  • 8: 布尔值数组
  • 3: 布尔值
  • 9: 对象数组
  • 10: 文件
  • 11: 文档
  • 12: 图片
  • 13: 音频
  • 14: 视频
  • 15: 文件数组
  • 16: 文档数组
  • 17: 图片数组
  • 18: 音频数组
  • 19: 视频数组
  • 20: 数组嵌套
  • 22: 密钥
  • 99: 空值
  • 100: 未指定类型,用于OneOf和AnyOf场景

示例值:1
Value AppTriggerParamBindingValue 否

参数值

AppTriggerParamBindingConfig

AppTriggerParamBindingConfig

被如下接口引用:CreateAppTrigger, DescribeAppTrigger, ModifyAppTrigger。

名称 类型 必选 描述
ParamList Array of AppTriggerParamBinding 否

绑定参数列表

AppTriggerParamBindingValue

AppTriggerParamBindingValue

被如下接口引用:CreateAppTrigger, DescribeAppTrigger, ModifyAppTrigger。

名称 类型 必选 描述
ParamValue String 否

参数值


示例值:23
VariableName String 否

应用变量名


示例值:Name

AppTriggerParamSchema

AppTriggerParamSchema

被如下接口引用:CreateAppTrigger, DescribeAppTrigger, ModifyAppTrigger。

名称 类型 必选 描述
ParamName String 否

参数名


示例值:asdas
ParamType Integer 否
枚举项枚举值描述
PARAM_TYPE_STRING0字符串
PARAM_TYPE_INT1整数
PARAM_TYPE_FLOAT2浮点数
PARAM_TYPE_BOOL3布尔值
PARAM_TYPE_OBJECT4对象
PARAM_TYPE_ARRAY_STRING5字符串数组
PARAM_TYPE_ARRAY_INT6整数数组
PARAM_TYPE_ARRAY_FLOAT7浮点数数组
PARAM_TYPE_ARRAY_BOOL8布尔值数组
PARAM_TYPE_ARRAY_OBJECT9对象数组
PARAM_TYPE_ARRAY_ARRAY20数组嵌套
PARAM_TYPE_NULL99空值
PARAM_TYPE_UNSPECIFIED100未指定类型,用于OneOf和AnyOf场景

示例值:8
Required Boolean 否

是否必选


示例值:true
SubParamList Array of AppTriggerParamSchema 否

子参数列表

AppTriggerPromptExecuteConfig

AppTriggerPromptExecuteConfig

被如下接口引用:CreateAppTrigger, DescribeAppTrigger, ModifyAppTrigger。

名称 类型 必选 描述
ExecutePrompt String 否

触发器执行提示词


示例值:你好
ParamBindingsApi AppTriggerParamBindingConfig 否

api参数绑定

AppTriggerRunLog

AppTriggerRunLog

被如下接口引用:DescribeAppTriggerRunLogList。

名称 类型 必选 描述
ConversationId String 否

会话id


示例值:b01cdf5f-0d55-4cc4-9137-7772593cd949
DurationMs String 否

执行时间


示例值:6591
EndTime String 否

结束时间

参数格式:YYYY-MM-DD hh:mm:ss


示例值:2026-07-29T10:52:58+08:00
FireType Integer 否
枚举项枚举值描述
APP_TRIGGER_FIRE_TYPE_UNSPECIFIED0未指定
APP_TRIGGER_FIRE_TYPE_SCHEDULED1定时触发
APP_TRIGGER_FIRE_TYPE_WEBHOOK2Webhook 触发
APP_TRIGGER_FIRE_TYPE_MANUAL_RUN3手动立即执行
APP_TRIGGER_FIRE_TYPE_TEST_RUN4测试执行

示例值:3
InstanceId String 否

触发实例id


示例值:728cbef2-f5df-4751-86af-75bc9bdc073d
PushStatus Integer 否
枚举项枚举值描述
TIMER_RUN_PUSH_STATUS_UNSPECIFIED0未指定
TIMER_RUN_PUSH_STATUS_NONE1未配置推送
TIMER_RUN_PUSH_STATUS_WAITING2等待推送
TIMER_RUN_PUSH_STATUS_SUCCESS3推送成功
TIMER_RUN_PUSH_STATUS_FAILED4推送失败

示例值:1
ResultCode String 否

结果码


示例值:NON_RETRYABLE_ERROR
ResultSummary String 否

结果概要


示例值:你好!有什么我可以帮你的吗?
RunId String 否

单次对话id


示例值:req_d6e503f0-bbe0-46bc-b4bb-290e15851a44
ScheduledFireTime String 否

触发时间

参数格式:YYYY:MM:DD hh:mm:ss


示例值:2026-07-29T10:52:51+08:00
Scope Integer 否
枚举项枚举值描述
APP_TRIGGER_SCOPE_UNSPECIFIED0未指定
APP_TRIGGER_SCOPE_APP1B 端管理员
APP_TRIGGER_SCOPE_USER2C 端访客

示例值:2
StartTime String 否

开始执行时间

参数格式:YYYY:MM:DD hh:mm:ss


示例值:2026-07-29T10:52:51+08:00
Status Integer 否
枚举项枚举值描述
TIMER_RUN_STATUS_UNSPECIFIED0未指定
TIMER_RUN_STATUS_PENDING1等待执行
TIMER_RUN_STATUS_RUNNING2执行中
TIMER_RUN_STATUS_RETRY_WAIT3等待重试
TIMER_RUN_STATUS_SUCCESS4成功
TIMER_RUN_STATUS_DEAD5失败终态 (重试耗尽 / 不可重试)
TIMER_RUN_STATUS_CANCELLED6被任务暂停/删除/修改取消

示例值:5
TriggerId String 否

触发器id


示例值:b62b21d9-dff1-4841-b357-304ca4d7edfe
Unread Boolean 否

是否已读


示例值:true
UserId String 否

访客Id


示例值:cuiyongchao
WorkflowRunId String 否

工作流运行id


示例值:wfr-0b3f2488-4255-4d54-b67e-2479a2a58fb3

AppTriggerScheduleConfig

AppTriggerScheduleConfig

被如下接口引用:CreateAppTrigger, DescribeAppTrigger, ModifyAppTrigger。

名称 类型 必选 描述
Schedule TimerScheduleConfig 否

触发器定时配置

AppTriggerScheduleStatus

AppTriggerScheduleStatus

被如下接口引用:DescribeAppTrigger, DescribeAppTriggerSummaryList, ModifyAppTrigger。

名称 类型 必选 描述
LastFireTime String 否

最近一次触发时间

参数格式:格式为YYYY-MM-DD hh:mm:ss


示例值:2026-07-29T10:52:58+08:00
NextFireTime String 否

下一次触发时间

参数格式:格式为YYYY-MM-DD hh:mm:ss


示例值:2026-07-16T18:00:00+08:00
PolicySummary String 否

触发方式


示例值:仅手动触发

AppTriggerSummary

AppTriggerSummary

被如下接口引用:DescribeAppTriggerSummaryList。

名称 类型 必选 描述
AppId String 否

应用ID


示例值:2078002407236474624
ExecuteType Integer 否
枚举项枚举值描述
APP_TRIGGER_EXECUTE_TYPE_UNSPECIFIED0未指定
APP_TRIGGER_EXECUTE_TYPE_PROMPT1指令执行
APP_TRIGGER_EXECUTE_TYPE_WORKFLOW2工作流执行

示例值:2
FailedCount String 否

失败次数


示例值:0
LastSessionId String 否

最近一次会话id


示例值:b01cdf5f-0d55-4cc4-9137-7772593cd949
Scope Integer 否
枚举项枚举值描述
APP_TRIGGER_SCOPE_UNSPECIFIED0未指定
APP_TRIGGER_SCOPE_APP1B 端管理员
APP_TRIGGER_SCOPE_USER2C 端访客

取值范围:[0, 2]


示例值:2
Status Integer 否
枚举项枚举值描述
APP_TRIGGER_STATUS_UNSPECIFIED0未指定
APP_TRIGGER_STATUS_ENABLED1启用
APP_TRIGGER_STATUS_PAUSED2暂停
APP_TRIGGER_STATUS_DELETED3已删除

示例值:1
SuccessCount String 否

成功次数


示例值:1
TriggerId String 否

触发器id


示例值:b62b21d9-dff1-4841-b357-304ca4d7edfe
TriggerName String 否

触发器名称


示例值:C端测试
TriggerStatus TriggerStatus 否

触发器执行状态

TriggerType Integer 否
枚举项枚举值描述
APP_TRIGGER_TYPE_UNSPECIFIED0未指定
APP_TRIGGER_TYPE_SCHEDULED1定时触发
APP_TRIGGER_TYPE_WEBHOOK2Webhook 触发

示例值:2
UnreadRunLogCount String 否

未读日志的数量


示例值:1
UserId String 否

访客ID


示例值:cuiyo**

AppTriggerWebhookConfig

AppTriggerWebhookConfig

被如下接口引用:CreateAppTrigger, DescribeAppTrigger, ModifyAppTrigger。

名称 类型 必选 描述
ParamSchemaConfig AppTriggerWebhookParamSchemaConfig 否

触发器webhook参数配置

WebhookKey String 否

webhook的key


示例值:9fb9a978-6bf5-48d0-a5b3-69ca8e033412
WebhookToken String 否

webhook的密钥


示例值:bc7569b77c8e30a24537693eaf77e1b010545185d5c04f76
WebhookUrl String 否

webhook的地址


示例值:https://tde.xiaowei.cloud.tencent.com/adp/v2/app/2075415763781738240/trigger/webhook/9fb9a978-6bf5-48d0-a5b3-69ca8e033412

AppTriggerWebhookParamSchemaConfig

AppTriggerWebhookParamSchemaConfig

被如下接口引用:CreateAppTrigger, DescribeAppTrigger, ModifyAppTrigger。

名称 类型 必选 描述
SchemaList Array of AppTriggerParamSchema 否

触发器API参数列表

AppTriggerWebhookStatus

AppTriggerWebhookStatus

被如下接口引用:DescribeAppTrigger, DescribeAppTriggerSummaryList, ModifyAppTrigger。

名称 类型 必选 描述
WebhookUrl String 否

推送Webbook地址


示例值:https://tde.xiaowei.cloud.tencent.com/adp/v2/app/2075415763781738240/trigger/webhook/9fb9a978-6bf5-48d0-a5b3-69ca8e033412

AppTriggerWorkflowExecuteConfig

AppTriggerWorkflowExecuteConfig

被如下接口引用:CreateAppTrigger, DescribeAppTrigger, ModifyAppTrigger。

名称 类型 必选 描述
ParamBindingsApi AppTriggerParamBindingConfig 否

工作流API参数绑定

ParamBindingsWorkflow AppTriggerParamBindingConfig 否

工作流参数绑定

WorkflowId String 否

工作流ID


示例值:2428abbd-9044-4031-8a5a-41ff3dc63fa2
WorkflowName String 否

工作流名字


示例值:测试工作流

AppWebSearchConfig

联网搜索配置(国际版使用)

被如下接口引用:ModifyApp。

名称 类型 必选 描述
ApiKey String 是 API密钥
示例值:sk-***
Enabled Boolean 是 是否开启
示例值:false
Provider String 是 服务提供商
示例值:代理商信息
TopN Integer 是 返回结果数量
示例值:0

AppWorkflowConfig

工作流配置

被如下接口引用:ModifyApp。

名称 类型 必选 描述
EnablePDL Boolean 是 是否使用PDL
示例值:false

AppealingStatus

申诉中的配置 - 记录各配置项是否在申诉中

被如下接口引用:DescribeApp。

名称 类型 必选 描述
AvatarInAppeal Boolean 是 头像是否在申诉中
示例值:false
FallbackReplyInAppeal Boolean 是 兜底回复语是否在申诉中
示例值:false
GreetingInAppeal Boolean 是 欢迎语是否在申诉中
示例值:false
NameInAppeal Boolean 是 应用名称是否在申诉中
示例值:false
RoleInAppeal Boolean 是 角色描述是否在申诉中
示例值:false

AuditLog

操作日志

被如下接口引用:DescribeAuditLogList。

名称 类型 必选 描述
AccountInfo AccountInfo 否

员工信息

AppId String 否

应用业务id


示例值:2076540405187173248
AppName String 否

应用名称

操作日志触发时的名称


示例值:eval-workflow-import-exec-043211
OperateTime String 否

操作时间

参数格式:秒时间戳


示例值:1783921629
Action String 否

操作类型


示例值:启用
Biz String 否

操作对象


示例值:工作流
Content String 否

操作内容


示例值:发布-eval-kb-routing-exec-043725
UniqueId String 否

操作唯一ID


示例值:a15d6f4af9a53aac4a3671a814f4d09a78d3723cfbe31eaa40001631d0be0af4

AuditLogMetaField

操作日志元数据

被如下接口引用:DescribeAuditLogMeta。

名称 类型 必选 描述
Key String 否

操作日志元数据key


示例值:create
Name String 否

操作日志元数据Name


示例值:新建

AuthConfig

插件授权配置

被如下接口引用:CreatePlugin, ModifyPlugin。

名称 类型 必选 描述
AuthType Integer 是

授权方式。

枚举值:

  • 0:无鉴权
  • 1:API Key 鉴权
  • 2:CAM 授权
  • 3:OAuth 2.0 授权

示例值:0
ApiKeyAuthConfig ApiKeyAuthConfig 否

API Key授权配置


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

CAM授权配置


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

OAuth2.0授权配置


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

AccessKey授权配置

BackgroundImage

BackgroundImage 背景图片配置

被如下接口引用:ModifyApp。

名称 类型 必选 描述
Brightness Integer 是 亮度值
示例值:117
LandscapeImageUrl String 是 横图(pc)
示例值:https://qidian-qbot-test-1251316161.cos.ap-guangzhou.myqcloud.com/public/1744544193038090240/*****************84/image/xdNgbZYwoJkwclZytKaa-2061707216749939200.jpg
OriginalImageUrl String 是 原始图
示例值:https://qidian-qbot-test-1251316161.cos.ap-guangzhou.myqcloud.co*******************************************************************************1707216749939200.jpg
PortraitImageUrl String 是 长图(手机)
示例值:https://qidian-qbot-test-1251316161.cos.ap-guangzhou.myqcloud.com/*********************90240/***0280711******184/ima***
ThemeColor String 是 主题色
示例值:#cc5631

BasicBilling

BasicBilling

被如下接口引用:CreatePlugin, ModifyPlugin。

名称 类型 必选 描述
BillingUnit Integer 否
枚举项枚举值描述
UNKNOW0
TOKEN1按token
PAGE_COUNT2按页数
TIMES3按次数
TIMES_THOUSAND4按千次数
SECOND5按时长
CHARACTER6按字符数
CHARACTER_THOUSAND7按千字符数
SHEET8按张
NUMBER9按个数

示例值:3
CashPrice Float 否

现金价格

单位:元


示例值:0.03
PuPrice Float 否

PU价格

单位:pu


示例值:30

BillingAttribute

BillingAttribute

被如下接口引用:CreatePlugin, ModifyPlugin。

名称 类型 必选 描述
Name String 否

属性名称


示例值:Resolution
Value String 否

属性值


示例值:4K

CallSource

调用来源

被如下接口引用:DescribeConcurrencyLimitDetailList, DescribeUsageDetailList。

名称 类型 必选 描述
SubjectId String 否

调用主体 ID,含义由 subject_type 决定(如 app_id、kb_id 等)


示例值:10023456
SubjectName String 否

调用主体名称


示例值:智能客服应用
SubjectType Integer 否

调用主体类型:APP/KB/WIDGET/OPEN_CLAW/KB_RECALL_TEST/WORKBENCH/MODEL_API

枚举项枚举值描述
METRIC_SOURCE_TYPE_UNSPECIFIED0
METRIC_SOURCE_TYPE_APP1应用开发
METRIC_SOURCE_TYPE_KB2知识库
METRIC_SOURCE_TYPE_WIDGET3Widget
METRIC_SOURCE_TYPE_OPEN_CLAW4ClawPro
METRIC_SOURCE_TYPE_KB_RECALL_TEST5知识库召回测试
METRIC_SOURCE_TYPE_WORKBENCH6智能工作台
METRIC_SOURCE_TYPE_MODEL_API7模型 API 调用

示例值:1

CallbackConfig

回调配置

被如下接口引用:CreateChannel, DescribeChannel, DescribeChannelList, ModifyChannel。

名称 类型 必选 描述
CallbackAesKey String 否

回调AESKey


示例值:tQ**IadwKAaMassVqLMEIjBMwfBhQWL
CallbackToken String 否

回调Token


示例值:a**Px*sjNYtw
CallbackUrl String 否

回调URL


示例值:https:/***gent.c*st/channel/callba/w*mrobot/1*980125***

CamAuthConfig

CAM授权信息

被如下接口引用:CreatePlugin, ModifyPlugin。

名称 类型 必选 描述
RoleName String 是

角色名称


示例值:TCADP_QCSLinkedRoleInTableOCR
KeyLocation Integer 否

密钥位置 HEADER/QUERY

枚举值:
| uint | 描述 |
| --- | --- |
| 0 | 头鉴权 |
| 1 | 请求信息鉴权 |


示例值:0
SecretIdName String 否

SecretId字段名称


示例值:SECRET_ID
SecretKeyName String 否

SecretKey字段名称


示例值:SECRET_KEY
ParamList Array of AccessKeyParamConfig 否

CAM Access Key 字段配置

SupportRoleAuth Boolean 否

是否支持CAM角色授权


示例值:true

CategoryModifyFields

分类可修改字段集合(配合 update_mask 使用)

被如下接口引用:ModifyCategory。

名称 类型 必选 描述
Name String 否

分类名


示例值:cateU_adp_qta_Idnp

CategoryPath

分类路径信息

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

名称 类型 必选 描述
CategoryId String 否

分类 ID


示例值:2095766524563077120
CategoryIdPath Array of String 否

从根节点开始的路径分类 ID 列表


示例值:["1001"]
CategoryNamePath Array of String 否

从根节点开始的路径分类名称列表


示例值:["产品咨询"]

CategoryPermission

CategoryPermission

被如下接口引用:DescribeMsgRecordCategoryList。

名称 类型 必选 描述
CanAdd Boolean 否

当前用户是否可新增子分类


示例值:true
CanDelete Boolean 否

当前用户是否可删除该分类


示例值:true
CanEdit Boolean 否

当前用户是否可编辑该分类


示例值:true

Channel

渠道信息

被如下接口引用:DescribeChannel, DescribeChannelList。

名称 类型 必选 描述
ChannelId String 否

渠道ID


示例值:2045*68
ChannelStatus Integer 否

渠道状态(仅B端):1-未发布,2-运行中,3-已下线(与ConnectStatus互斥)


示例值:3
ConnectStatus Integer 否

连接状态(仅C端):1-初始,2-连接成功,3-连接失败(与ChannelStatus互斥)


示例值:1
CreateTime String 否

创建时间(Unix秒)


示例值:1784617016
Spec ChannelSpec 否

渠道规格


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

更新时间(Unix秒)


示例值:1784617895
Updater String 否

最后更新人


示例值:4939

ChannelSpec

渠道规格(聚合场景/类型/名称/备注/配置)

被如下接口引用:CreateChannel, DescribeChannel, DescribeChannelList, ModifyChannel。

名称 类型 必选 描述
ChannelName String 否

渠道名称


示例值:钉钉机器人
ChannelType Integer 否

渠道类型,详见ChannelType枚举

枚举值:

  • 10000: 微信服务号(Wechat)
  • 10002: 企微应用(WeComApp)
  • 10004: 微信客服(WechatCustomerService)
  • 10009: 企微智能机器人(WeComRobot)
  • 10013: 钉钉机器人(DingTalk)
  • 10014: 企微智能机器人WebSocket(WeComRobot)
  • 10015: 微信ClawBot(WechatClawBot)
  • 10011: LINE(Line)
  • 10012: Telegram(Telegram)
  • 10016: 飞书机器人(Lark)

C端场景(Scene=1时)只支持10014和10015


示例值:10013
Description String 否

备注


示例值:ding3ufrav3malmak4sh_1
DingTalk DingTalkChannelConfig 否

钉钉机器人配置


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

飞书机器人配置


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

LINE配置


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

渠道场景:0-B端场景,1-C端场景


示例值:1
Telegram TelegramChannelConfig 否

Telegram配置


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

归属用户+Agent运行态标识(C端)


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

微信公众号/小程序配置


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

微信ClawBot配置


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

微信客服配置


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

企微应用配置


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

企微机器人配置


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

CheckResult

通用校验结果

被如下接口引用:CheckLabel。

名称 类型 必选 描述
Passed Boolean 否 是否通过校验
示例值:true
Reason String 否 失败原因(passed=false 时填充)
示例值:标签名称与管理后台重复

ClawAgentAgentTeamConfig

ClawAgent Agent团队协作配置

被如下接口引用:ModifyApp。

名称 类型 必选 描述
Enabled Boolean 否

是否开启Agent团队协作


示例值:true
PromptContent String 否

prompt内容


示例值:我的提示词

ClawAgentConfig

ClawAgent配置

被如下接口引用:ModifyApp。

名称 类型 必选 描述
AgentTeamConfig ClawAgentAgentTeamConfig 否 Agent团队协作配置
注意:此字段可能返回 null,表示取不到有效值。
LongMemoryConfig ClawAgentLongMemoryConfig 否 长期记忆配置
注意:此字段可能返回 null,表示取不到有效值。

ClawAgentLongMemoryConfig

ClawAgent长期记忆配置

被如下接口引用:ModifyApp。

名称 类型 必选 描述
Enabled Boolean 否

是否开启长期记忆


示例值:true

CodeToolConfig

CodeToolConfig

被如下接口引用:CreatePlugin, ModifyPlugin。

名称 类型 必选 描述
Code String 否

代码


示例值:代码内容,仅通过代码方式创建的工具有值
Example ToolExample 否

示例

Inputs Array of RequestParam 否

输入参数

Outputs Array of ResponseParam 否

输出参数

ComplexBilling

ComplexBilling

被如下接口引用:CreatePlugin, ModifyPlugin。

名称 类型 必选 描述
ComplexList Array of ComplexBillingItem 否

复合计费列表

ComplexBillingItem

ComplexBillingItem

被如下接口引用:CreatePlugin, ModifyPlugin。

名称 类型 必选 描述
BillingAttributeList Array of BillingAttribute 否

复合计费维度信息

BillingUnit Integer 否
枚举项枚举值描述
UNKNOW0
TOKEN1按token
PAGE_COUNT2按页数
TIMES3按次数
TIMES_THOUSAND4按千次数
SECOND5按时长
CHARACTER6按字符数
CHARACTER_THOUSAND7按千字符数
SHEET8按张
NUMBER9按个数

示例值:8
CashPrice Float 否

现金价格

单位:元


示例值:1.8
PuPrice Float 否

pu价格

单位:pu


示例值:1800

ConcurrencyLimitDetail

并发超限明细

被如下接口引用:DescribeConcurrencyLimitDetailList。

名称 类型 必选 描述
CallSource CallSource 否

调用来源(subject_type 决定 subject_id/subject_name 的含义,如 APP 时 subject_id=app_id、subject_name=app_name)

EventTime String 否

超限发生时间(Unix秒)


示例值:1754956800
ModelName String 否

模型名称


示例值:hunyuan-turbo
RequestQuery String 否

请求内容(用户请求的原始查询文本)


示例值:请帮我分析以下合同条款中的风险点,合同内容如下:甲方...
SpaceId String 否

空间 ID


示例值:space_abc123

ConflictQA

冲突 QA(冲突组中的单条 QA 快照)

被如下接口引用:DescribeConflictQA。

名称 类型 必选 描述
Answer String 否

答案


示例值:185
EffectiveDomain Integer 否

知识生效作用域:1=停用,2=仅开发域,3=仅发布域,4=全域

枚举项枚举值描述
KNOWLEDGE_EFFECTIVE_DOMAIN_UNKNOWN0
KNOWLEDGE_EFFECTIVE_DOMAIN_NONE1停用
KNOWLEDGE_EFFECTIVE_DOMAIN_DEV2仅开发域
KNOWLEDGE_EFFECTIVE_DOMAIN_RELEASE3仅发布域
KNOWLEDGE_EFFECTIVE_DOMAIN_ALL4全域


示例值:3
FileName String 否

关联文档名称


示例值:奥迪-图片过滤.docx
FileType String 否

关联文档类型


示例值:docx
QaId String 否

QA ID


示例值:2097938250275874240
Question String 否

问题


示例值:小王身高
SourceType Integer 否

来源类型:1=文档生成,2=批量导入,3=手动录入

枚举项枚举值描述
QA_SOURCE_TYPE_UNKNOWN0
QA_SOURCE_TYPE_DOC1文档生成
QA_SOURCE_TYPE_BATCH_IMPORT2批量导入
QA_SOURCE_TYPE_MANUAL3手动录入


示例值:3
UpdateTime String 否

更新时间(Unix 秒,用于排序判断新旧)


示例值:1789022510

ConflictQASummary

冲突问摘要信息

被如下接口引用:DescribeConflictQASummaryList。

名称 类型 必选 描述
ConflictGroupId String 否

冲突组 ID


示例值:2097996818891709760

ConsumptionClassification

消耗分类

被如下接口引用:DescribeConsumptionDetailList。

名称 类型 必选 描述
ConsumptionScene String 否

消耗场景(如推理/训练/评测等)


示例值:chat
ConsumptionTarget String 否

消耗目标(如具体模型名/插件名/平台功能名)


示例值:hunyuan-turbo
ConsumptionType String 否

消耗类型,取值集合由业务方定义(如 model/plugin/platform 等)


示例值:model
PackageName String 否

套餐包名称


示例值:企业标准套餐包

ConsumptionDetail

资源消耗明细

被如下接口引用:DescribeConsumptionDetailList。

名称 类型 必选 描述
Classification ConsumptionClassification 否

消耗分类(类型/目标/场景/套餐包)

EventTime String 否

消耗发生时间,Unix 秒


示例值:1754956800
MetricSourceType Integer 否

用量来源类型

枚举项枚举值描述
METRIC_SOURCE_TYPE_UNSPECIFIED0
METRIC_SOURCE_TYPE_APP1应用开发
METRIC_SOURCE_TYPE_KB2知识库
METRIC_SOURCE_TYPE_WIDGET3Widget
METRIC_SOURCE_TYPE_OPEN_CLAW4ClawPro
METRIC_SOURCE_TYPE_KB_RECALL_TEST5知识库召回测试
METRIC_SOURCE_TYPE_WORKBENCH6智能工作台
METRIC_SOURCE_TYPE_MODEL_API7模型 API 调用

示例值:1
Name String 否

名称


示例值:智能客服应用
SpaceName String 否

空间名称


示例值:产品研发空间
Usage ConsumptionUsage 否

消耗用量(数值/单位/PU 消耗)

UserName String 否

用户名称


示例值:张三

ConsumptionUsage

消耗用量

被如下接口引用:DescribeConsumptionDetailList。

名称 类型 必选 描述
ConsumptionPU Float 否

消耗PU


示例值:0.00897
Usage Float 否

用量数值


示例值:8970
UsageUnit Integer 否

用量单位,枚举值 DosageUnit

枚举项枚举值描述
DOSAGE_UNIT_TOKEN0token(默认)
DOSAGE_UNIT_PAGE_COUNT1page_count(页数)
DOSAGE_UNIT_TIMES2times(次数)
DOSAGE_UNIT_SECOND3second(秒)
DOSAGE_UNIT_ITEM4item(条)
DOSAGE_UNIT_SHEET5sheet(张)
DOSAGE_UNIT_CHARACTER6character(字符)
DOSAGE_UNIT_GB7GB
DOSAGE_UNIT_NUMBER8number(个数)
DOSAGE_UNIT_MILL_SECOND9mill_second(毫秒)

示例值:0

ContentFilter

内容过滤配置(图片名称正则/最小宽高),缺省时不启用过滤

被如下接口引用:DescribeDoc。

名称 类型 必选 描述
ImageMinHeight Integer 否

图片最小高度(像素),小于则过滤;<=0 表示不启用


示例值:64
ImageMinWidth Integer 否

图片最小宽度(像素),小于则过滤;<=0 表示不启用


示例值:64
ImageNamePatterns String 否

图片名称过滤规则(用分号 ';' 分隔的多条正则,如 'icon;notice;warning;info.')


示例值:icon;logo;banner.

Conversation

Conversation 会话信息

被如下接口引用:DescribeConversationList。

名称 类型 必选 描述
AppId String 是

应用 ID


示例值:2049148302274678336
ConversationId String 是

会话 ID


示例值:2f3395c6-f742-4e07-8686-b5618791790d
CreateTime String 是

创建时间


示例值:2026-04-30T14:20:31+08:00
Type Integer 是

会话类型 枚举值: 0-CONVERSATION_TYPE_UNSPECIFIED(未指定;列表查询时表示全部), 1-CONVERSATION_TYPE_VISITOR(访客端体验), 2-CONVERSATION_TYPE_EVALUATION(评测), 5-CONVERSATION_TYPE_API(API 接入), 10-CONVERSATION_TYPE_WORKFLOW(工作流调试), 20-CONVERSATION_TYPE_SHARE(分享链接)


示例值:2
UpdateTime String 是

更新时间


示例值:2026-04-30T14:20:31+08:00
Title String 否

会话标题


示例值:新会话
AgentId String 否

会话使用的用户端 AgentId


示例值:user_6a58d4ca-689b-43e5-b23d-804c4f1c5856

ConversationAgentTask

AgentTask 智能体任务信息

被如下接口引用:DescribeConversationMessageList。

名称 类型 必选 描述
Content String 是

任务内容


示例值:example task pending
Index String 是

任务序号


示例值:1
Status String 是

任务状态,pending:待执行,processing:处理中,success:已完成,failed:处理失败,stop:已取消


示例值:processing

ConversationContent

Content 消息内容信息

被如下接口引用:DescribeConversationMessageList。

名称 类型 必选 描述
Text String 是

文本内容


示例值:让我选择苹果或者香蕉
Type String 是

内容类型, text:文本,image:图片,file:文件,custom_variables:自定义输入参数信息,widget_action:widget动作信息


示例值:custom_variables
CustomParamList Array of String 否

自定义参数数据


示例值:["mock-param-a"]
CustomParams Array of String 否

自定义参数数据


示例值:["foo=bar"]
CustomVariablesData String 否

自定义变量数据


注意:此字段可能返回 null,表示取不到有效值。
示例值:{"env":"prod","region":"ap-shanghai"}
EnterpriseCharts String 否

企业表单


注意:此字段可能返回 null,表示取不到有效值。
示例值:{"series":[{"type":"line","data":[1,2,3]}]}
OptionCardList Array of String 否

选项卡列表


示例值:["mock-option-a"]
OptionCards Array of String 否

选项卡列表


示例值:["card-a"]
OptionMode Integer 否

选项卡模式 枚举值: 0-OPTION_MODE_SINGLE(单选), 1-OPTION_MODE_MULTI(多选)


注意:此字段可能返回 null,表示取不到有效值。
示例值:1
QuoteInfoList Array of ConversationQuoteInfo 否

引用角标信息列表

QuoteInfos Array of ConversationQuoteInfo 否

引用角标信息列表

ReferenceList Array of ConversationReference 否

参考来源列表

References Array of ConversationReference 否

参考来源列表

RelatedRecordId String 否

关联记录 ID


注意:此字段可能返回 null,表示取不到有效值。
示例值:example-related-record-id
TaskList Array of ConversationAgentTask 否

智能体任务列表

Tasks Array of ConversationAgentTask 否

智能体任务列表

WorkflowInput String 否

工作流输入参数


注意:此字段可能返回 null,表示取不到有效值。
示例值:example workflow input
McpApp ConversationMcpApp 否

MCP-APP调用信息


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

ConversationExperience

对话体验配置

被如下接口引用:ModifyApp。

名称 类型 必选 描述
AiCall AICallConfig 是 AI通话配置
注意:此字段可能返回 null,表示取不到有效值。
BackgroundImage BackgroundImage 是 背景图片配置
注意:此字段可能返回 null,表示取不到有效值。
EnableFallbackReply Boolean 是 兜底回复开关
示例值:false
EnableRecommended Boolean 是 是否使用推荐问
示例值:false
EnableWebSearch Boolean 是 是否使用联网搜索
示例值:false
FallbackReply String 是 兜底回复语
示例值:针对您这个问题,我暂时还无法进行回答,请换一个问题吧。
InputBoxConfig InputBoxConfig 是 输入框配置
注意:此字段可能返回 null,表示取不到有效值。
Method Integer 是 输出方式。枚举值: 1:流式, 2:非流式
示例值:1
RecommendPromptMode Integer 是 推荐问生成prompt模式。枚举值: 1:仅结合知识库输出推荐问的prompt
示例值:0

ConversationMcpApp

MCP App 内容,供历史会话重建可交互 App

被如下接口引用:DescribeConversationMessageList。

名称 类型 必选 描述
PluginId String 否

能力边界:一次请求只能读该 plugin 的资源


示例值:418eee0b-4aa7-4aef-939b-3c48d404e846
ResourceUri String 否

ui:// 资源,前端据此调 ReadMCPResource 拉 HTML


示例值:ui://overtime-list/overtime-list.html
ThreadId String 否

agent-exec 侧 thread


示例值:b18c602d-054d-4f1a-ad9b-f785ba4d69c5
ToolResult String 否

JSON:完整 CallToolResult 原文,供历史会话重建时重放


注意:此字段可能返回 null,表示取不到有效值。
示例值:{"content":[{"text":"已打开加班记录查看页:37 张申请单、43 条明细、合计 345.49 小时。按类别:延时加班 84.54h,休息日加班 252.95h,节假日加班 8h。

ConversationMessage

Message 消息信息

被如下接口引用:DescribeConversationMessageList。

名称 类型 必选 描述
ConversationId String 是

会话 ID


示例值:4abd149a-e010-4a6c-bc52-1132658f149d
Icon String 是

消息图标


示例值:https://example.com/icon.png
MessageId String 是

消息 ID


示例值:msg_c8e51d69-d693-415e-afc0-afb39facbc95_1_content
Name String 是

消息名称


示例值:example-assistant
RecordId String 是

记录 ID


示例值:rcd_c8e51d69-d693-415e-afc0-afb39facbc95
Role String 是

消息角色


示例值:user
Status String 是

消息状态,pending:待执行,processing:处理中,success:已完成,failed:处理失败,stop:已取消


示例值:success
StatusDesc String 是

状态描述


示例值:完整示例消息
Title String 是

消息标题


示例值:完整示例消息
ContentList Array of ConversationContent 否

消息内容列表

Contents Array of ConversationContent 否

消息内容列表

Type String 否

类型


示例值:tool_call

ConversationQuoteInfo

QuoteInfo 参考来源索引信息

被如下接口引用:DescribeConversationMessageList。

名称 类型 必选 描述
Index Integer 是

参考来源的索引值


示例值:1
Position Integer 是

参考来源位置


示例值:1

ConversationRecordErrorInfo

单次对话失败信息

被如下接口引用:DescribeConversationMessageList。

名称 类型 必选 描述
Code String 否

对话失败错误码


示例值:460722
Message String 否

对话失败错误信息


示例值:type:business, code:460722, msg:ErrAPPResourceLimitQPM

ConversationRecordSummary

单次对话记录统计信息

被如下接口引用:DescribeConversationMessageList。

名称 类型 必选 描述
RecordId String 否

回复记录 ID,对应 messages 中回复消息的 record_id


示例值:rcd_70b72a39-b7fc-405f-a0b9-32f786a3effc
RelatedRecordId String 否

用户提问记录 ID,对应 messages 中用户消息的 record_id


示例值:req_70b72a39-b7fc-405f-a0b9-32f786a3effc
TimeUsage ConversationRecordTimeUsage 否

单次对话耗时信息


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

单次对话 token 消耗信息


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

单次对话失败信息;成功时为空


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

单次员工助理对话当前状态

枚举值:

  • pending: 待处理
  • processing: 处理中
  • success: 成功
  • failed: 失败
  • stop: 停止

示例值:success

ConversationRecordTimeUsage

单次对话耗时信息

被如下接口引用:DescribeConversationMessageList。

名称 类型 必选 描述
Elapsed String 否

单次对话总耗时,单位毫秒


示例值:9374
FirstTokenCost String 否

首 token 耗时,单位毫秒


示例值:3294
TotalCost String 否

模型推理总耗时,单位毫秒


示例值:9374

ConversationRecordTokenUsage

单次对话 token 消耗信息

被如下接口引用:DescribeConversationMessageList。

名称 类型 必选 描述
InputTokens String 否

输入 token 总数


示例值:71070
OutputTokens String 否

输出 token 总数


示例值:1437
TotalTokens String 否

消耗 token 总数


示例值:72507
CachedTokens String 否

缓存命中 token 总数


示例值:0
ReasoningTokens String 否

推理 token 总数


示例值:71

ConversationReference

Reference 参考来源信息

被如下接口引用:DescribeConversationMessageList。

名称 类型 必选 描述
Index Integer 是

参考来源索引


示例值:1
Name String 是

参考来源名称


示例值:doc reference
Type Integer 是

参考来源类型 枚举值: 0-APP_REFERENCE_TYPE_UNSPECIFIED(未指定), 1-APP_REFERENCE_TYPE_QA(问答), 2-APP_REFERENCE_TYPE_SEGMENT(分片), 3-APP_REFERENCE_TYPE_DOC(文档), 4-APP_REFERENCE_TYPE_WEB_SEARCH(Web 搜索), 5-APP_REFERENCE_TYPE_GRAPH_RAG(GraphRAG)


示例值:3

ConversationResetInfo

会话重置信息

被如下接口引用:DescribeConversationMessageList。

名称 类型 必选 描述
ResetTime String 否

最近一次重置的毫秒级时间戳


示例值:1784561474000
ResetThroughRecordId String 否

最近一次重置边界;该记录及更早的记录不再作为对话上下文


示例值:oxX_20260715_191643_698_cohcnDRd

ConversationWorkspace

Workspace 工作空间信息

被如下接口引用:DescribeConversation。

名称 类型 必选 描述
WorkspaceId String 是

工作空间 ID


示例值:6576c839-839c-4a54-b820-408aec31dbe0
StorageType String 否

存储类型


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

CorpShareConfig

CorpShareConfig

被如下接口引用:CreateRelease, DescribeApp, DescribeLatestRelease, DescribeReleaseSummary。

名称 类型 必选 描述
Enabled Boolean 否

企业共享开关


示例值:true
ShareScope Integer 否

共享范围类型,1:企业全员,2:指定账户,3:指定空间


示例值:1
TagIdList Array of String 否

企业共享应用标签


示例值:["1990010100000000001"]
ShareScopeList Array of Identity 否

共享范围信息(用户时StrId为uin,Name为用户名称;空间时StrId为空间ID,Name为空间名称)

CronSchedule

CronSchedule

被如下接口引用:CreateAppTrigger, DescribeAppTrigger, ModifyAppTrigger。

名称 类型 必选 描述
Expression String 否 cron表达式
示例值:0 9 * * *

DBRetrievalConfig

数据库检索配置

被如下接口引用:SearchKnowledge。

名称 类型 必选 描述
Enabled Boolean 否

是否启用


示例值:true

DailySchedule

DailySchedule

被如下接口引用:CreateAppTrigger, DescribeAppTrigger, ModifyAppTrigger。

名称 类型 必选 描述
TimeOfDay String 否 时间
示例值:09:00

DeDuplicateStrategy

重复文件处理规则

被如下接口引用:ImportDocList。

名称 类型 必选 描述
CheckType Integer 否

校验方式:1=按文档内容判断是否相同

枚举项枚举值描述
DUPLICATE_FILE_CHECK_TYPE_UNKNOWN0未知
DUPLICATE_FILE_CHECK_TYPE_COS_HASH1按文档内容(cos_hash)判断是否相同


示例值:0
HandleType Integer 否

处理方式:1=返回报错,2=跳过并返回重复的文档 ID

枚举项枚举值描述
DUPLICATE_FILE_HANDLE_TYPE_UNKNOWN0未知
DUPLICATE_FILE_HANDLE_TYPE_RETURN_ERR1返回报错
DUPLICATE_FILE_HANDLE_TYPE_SKIP2跳过,返回重复的文档 ID


示例值:2

DialogCustomConfig

对话端自定义配置(所有模式共用,允许对话中动态修改配置)

被如下接口引用:ModifyApp。

名称 类型 必选 描述
Enabled Boolean 否

是否开启对话端动态修改配置


示例值:true

DigitalHumanConfig

数智人配置

被如下接口引用:ModifyApp。

名称 类型 必选 描述
AssetKey String 是 数智人形象资产id
示例值:df***df0
Avatar String 是 数智人图片
示例值:https://virtualhuman-cos-prod-1251316161.cos.ap-nanjing.tencentcos.cn/wupload/xy/virtualhuman_crm_prod/website_buy/vnZ6ZZYY.png
Name String 是 数智人形象名称
示例值:艾朵_职业套装_站姿
PreviewUrl String 是 数智人预览地址
示例值:https://virtualhuman-cos-prod-1251316161.cos.ap-nanjing.tencentcos.cn/wupload/xy/virtualhuman_crm_prod/preview/vStr966G.png

DingTalkChannelConfig

钉钉机器人渠道配置

被如下接口引用:CreateChannel, DescribeChannel, DescribeChannelList, ModifyChannel。

名称 类型 必选 描述
AppKey String 否

钉钉机器人ClientId(AppKey)


示例值:d*s3b1m***jw
AppSecret String 否

钉钉机器人ClientSecret(AppSecret)


示例值:2g*p****NGdd9lZkXChKQIrv_6aG*rGhRA5v

Distribution

回复类型分布项

被如下接口引用:DescribeAppStatisticsOverview。

名称 类型 必选 描述
CallCount String 否

该回复方式的调用次数


示例值:0
Percentage Float 否

该回复方式在总调用次数中的占比(百分比,0~100,保留两位小数;无数据时全为 0,有数据时各项之和为 100)


示例值:0
ReplyName String 否

回复方式名称(已按请求语言国际化;i18n 缺失时兜底为 reply_method 的枚举名)


示例值:问答直接回复

文档外部链接信息

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

名称 类型 必选 描述
ExternalUrl String 否

外部链接地址


示例值:https://tde.xiaowei.cloud.tencent.com/
ReplaceOriginEnabled Boolean 否

是否替换原文展示


示例值:true

DocImportSpec

文档导入规格(一次性输入的非持久化数据)

被如下接口引用:ImportDocList。

名称 类型 必选 描述
FileId String 是

文件 ID(通过文件管理服务获取的文件标识,不可为空)


示例值:2097945951689898304
CategoryId String 否

归属分类 ID


示例值:0
DeDuplicateStrategyList Array of DeDuplicateStrategy 否

重复文件处理规则列表

EffectiveDomain Integer 否

知识生效作用域

枚举项枚举值描述
KNOWLEDGE_EFFECTIVE_DOMAIN_UNKNOWN0
KNOWLEDGE_EFFECTIVE_DOMAIN_NONE1停用
KNOWLEDGE_EFFECTIVE_DOMAIN_DEV2仅开发域
KNOWLEDGE_EFFECTIVE_DOMAIN_RELEASE3仅发布域
KNOWLEDGE_EFFECTIVE_DOMAIN_ALL4全域


示例值:1
ExpirationPolicy ExpirationPolicy 否

过期策略(有效时间与超过有效时间后的行为)


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

外部链接


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

适用范围(标签条件)

ParseConfig DocParseConfig 否

解析配置(分割规则、内容过滤等)


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

开关配置


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

更新周期


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

用户访问配置


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

DocLifecycle

文档生命周期信息

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

名称 类型 必选 描述
CreateTime String 否

创建时间(Unix 秒)


示例值:1788783358
ExpirationPolicy ExpirationPolicy 否

过期策略(有效时间与超过有效时间后的行为)


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

文档状态:1=解析中,2=解析失败,3=导入失败,4=审核中,5=审核失败,6=学习中,7=学习失败,8=导入完成,9=已过期,10=超量失效,11=超量失效恢复中,12=重命名审核失败,13=重命名申诉失败,14=人工申诉中,15=人工申诉失败

枚举项枚举值描述
DOC_STATUS_UNKNOWN0
DOC_STATUS_PARSING1解析中
DOC_STATUS_PARSE_FAIL2解析失败
DOC_STATUS_IMPORT_FAIL3导入失败
DOC_STATUS_AUDITING4审核中
DOC_STATUS_AUDIT_FAIL5审核失败
DOC_STATUS_LEARNING6学习中
DOC_STATUS_LEARN_FAIL7学习失败
DOC_STATUS_IMPORTED8导入完成
DOC_STATUS_EXPIRED9已过期
DOC_STATUS_QUOTA_INVALID10超量失效
DOC_STATUS_QUOTA_RECOVERING11超量失效恢复中
DOC_STATUS_RENAME_AUDIT_FAIL12重命名审核失败
DOC_STATUS_RENAME_APPEAL_FAIL13重命名申诉失败
DOC_STATUS_MANUAL_APPEALING14人工申诉中
DOC_STATUS_MANUAL_APPEAL_FAIL15人工申诉失败


示例值:1
StatusDesc String 否

状态描述


示例值:重命名审核失败
StatusMessage String 否

状态附加信息


示例值:文档名称审核失败,请修改文档名称
UpdateTime String 否

更新时间(Unix 秒)


示例值:1788783408

文档链接

被如下接口引用:DescribeDoc。

名称 类型 必选 描述
CosUrl String 否

COS 链接地址,可用作预览和下载


示例值:https://cos.example.com/kb/50001/billing.pdf?sign=xxx
ExternalLink DocExternalLink 否

外部链接


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

DocMetadata

文档元信息

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

名称 类型 必选 描述
DocCharCount String 否

文档字符数


示例值:20
FileName String 否

文件名


示例值:04-交接报告已脱敏.pptx
FileSize String 否

文件大小(字节)


示例值:29087344
FileType String 否

文件类型/扩展名


示例值:pdf
RefFieldNameList Array of String 否

元数据引用字段名列表(用于显示文档哪些分类和属性被设置为元数据)


示例值:["产品咨询/计费咨询"]
SourceDesc String 否

来源描述


示例值:本地文档
SourceType Integer 否

文档来源类型:1=本地上传,2=网页链接,3=COS 对接,4=外部导入

枚举项枚举值描述
DOC_SOURCE_TYPE_UNKNOWN0
DOC_SOURCE_TYPE_LOCAL1本地上传
DOC_SOURCE_TYPE_URL2网页链接
DOC_SOURCE_TYPE_COS3COS 对接
DOC_SOURCE_TYPE_IMPORT4外部导入


示例值:28

DocModifyFields

文档可修改字段集合(配合 update_mask 使用)

被如下接口引用:ModifyDoc。

名称 类型 必选 描述
CategoryId String 否

归属分类 ID


示例值:2097978830645224896
EffectiveDomain Integer 否

生效作用域

枚举项枚举值描述
KNOWLEDGE_EFFECTIVE_DOMAIN_UNKNOWN0
KNOWLEDGE_EFFECTIVE_DOMAIN_NONE1停用
KNOWLEDGE_EFFECTIVE_DOMAIN_DEV2仅开发域
KNOWLEDGE_EFFECTIVE_DOMAIN_RELEASE3仅发布域
KNOWLEDGE_EFFECTIVE_DOMAIN_ALL4全域


示例值:0
ExpirationPolicy ExpirationPolicy 否

过期策略(有效时间与超过有效时间后的行为)


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

外部链接


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

标签列表

Name String 否

文档名


示例值:肺鱼rename111.txt
ParseConfig DocParseConfig 否

解析配置(分割规则、内容过滤等)


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

开关配置


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

更新周期


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

用户访问配置


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

DocOperator

文档操作者信息

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

名称 类型 必选 描述
Modifier Operator 否

修改人


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

操作权限


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

DocParseConfig

文档解析配置

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

名称 类型 必选 描述
ContentFilter ContentFilter 否

内容过滤配置


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

分割规则


示例值:chapter

DocPermission

文档操作权限信息

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

名称 类型 必选 描述
CanDelete Boolean 否

是否可删除


示例值:true
CanEdit Boolean 否

是否可编辑


示例值:true
CanRestart Boolean 否

是否可重新生成


示例值:true
CanRetry Boolean 否

是否可重试


示例值:true

DocQuery

文档查询条件

被如下接口引用:DescribeDocSummaryList。

名称 类型 必选 描述
Query String 否

查询关键词(名称模糊搜索)


示例值:汽车
QueryScopeList Array of Integer 否

查询范围(query 作用的字段):1=文件名,2=标签或标签值;支持多选,缺省时无效


示例值:[1]

DocRetrievalConfig

文档检索配置

被如下接口引用:SearchKnowledge。

名称 类型 必选 描述
Confidence Float 否

置信度阈值


示例值:0.2
Enabled Boolean 否

是否启用


示例值:true
TopN Integer 否

返回前 N 条


示例值:5

DocSummary

文档摘要信息

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

名称 类型 必选 描述
CategoryPath CategoryPath 否

所属分类路径(包含分类 ID、从根节点开始的分类 ID 路径和分类名称路径)


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

文档 ID


示例值:2096935505918795456
KnowledgeScope KnowledgeScope 否

知识生效范围(聚合生效作用域 + 标签条件)


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

生命周期信息


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

元信息


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

操作者信息(聚合修改人 + 操作权限)


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

任务状态信息


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

DocSwitch

文档开关配置

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

名称 类型 必选 描述
DownloadEnabled Boolean 否

是否可下载


示例值:true
ReferEnabled Boolean 否

是否在参考来源中展示


示例值:true

DocTaskStatus

文档任务状态信息

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

名称 类型 必选 描述
CompletedTaskTypeList Array of Integer 否

已完成的历史任务类型列表


示例值:[1]
OngoingTaskTypeList Array of Integer 否

正在进行中的任务类型列表


示例值:[1]

DocUpdatePeriod

文档更新周期配置

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

名称 类型 必选 描述
Enabled Boolean 否

是否开启周期性更新


示例值:true
PeriodHour Integer 否

更新周期(小时)


示例值:24

DuplexBilling

DuplexBilling

被如下接口引用:CreatePlugin, ModifyPlugin。

名称 类型 必选 描述
BillingUnit Integer 否
枚举项枚举值描述
UNKNOW0
TOKEN1按token
PAGE_COUNT2按页数
TIMES3按次数
TIMES_THOUSAND4按千次数
SECOND5按时长
CHARACTER6按字符数
CHARACTER_THOUSAND7按千字符数
SHEET8按张
NUMBER9按个数

示例值:1
InputCashPrice Float 否

输入现金价格

单位:元


示例值:0.12
InputPuPrice Float 否

输入pu价格

单位:pu


示例值:120
OutputCashPrice Float 否

输出现金价格

单位:元


示例值:0.12
OutputPuPrice Float 否

输出pu价格

单位:pu


示例值:120

ESConfig

ES 配置

被如下接口引用:CreateKB, DescribeKB, ModifyKB。

名称 类型 必选 描述
CanModify Boolean 否

是否支持修改存储方式


示例值:true
EncryptedPassword String 否

ES 密码(加密后)


示例值:WG1MFdZ8blow
InstanceId String 否

ES 集群 ID


示例值:es-jirwzied
StorageType Integer 否

存储类型:1=默认存储,2=自定义存储

枚举项枚举值描述
ES_STORAGE_TYPE_UNKNOWN0
ES_STORAGE_TYPE_DEFAULT1默认存储
ES_STORAGE_TYPE_CUSTOM2自定义存储


示例值:0
UserName String 否

ES 用户名


示例值:elastic

EffectivePeriod

有效期

被如下接口引用:CreateQAList, ModifyDocList, ModifyQAList。

名称 类型 必选 描述
EndTime String 否

有效期结束时间(Unix 秒,0 表示永久有效)


示例值:1789094967
StartTime String 否

有效期开始时间(Unix 秒)


示例值:1789008595

ExecuteConfig

ExecuteConfig

被如下接口引用:CreateAppTrigger, DescribeAppTrigger, ModifyAppTrigger。

名称 类型 必选 描述
PromptConfig AppTriggerPromptExecuteConfig 否

Prompt配置

WorkflowConfig AppTriggerWorkflowExecuteConfig 否

工作流配置

ExpirationAwareness

时效性检索增强配置

被如下接口引用:SearchKnowledge。

名称 类型 必选 描述
Enabled Boolean 否

是否启用时效性检索,开启后检索结果会结合知识的有效时间进行排序


示例值:true

ExpirationPolicy

过期策略(有效时间与超过有效时间后的行为)

被如下接口引用:CreateQAList, DescribeDoc, DescribeDocSummaryList, DescribeQA, DescribeQASummaryList, ImportDocList, ModifyDoc, ModifyDocList, ModifyQA, ModifyQAList。

名称 类型 必选 描述
EffectivePeriod EffectivePeriod 否

有效时间


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

超过有效时间后的行为:1=NOT_RETRIEVABLE 不可被检索,2=RETRIEVABLE 仍可被检索;永久有效时无意义

枚举项枚举值描述
EXPIRE_BEHAVIOR_UNKNOWN0未指定(服务端按默认处理)
EXPIRE_BEHAVIOR_NOT_RETRIEVABLE1不可被检索(到期下架)
EXPIRE_BEHAVIOR_RETRIEVABLE2仍可被检索(到期不下架,仅标记时效范围)


示例值:2

FieldMask

FieldMask

被如下接口引用:DescribeApp, DescribeDoc, DescribePlugin, ModifyAgent, ModifyApp, ModifyAppTrigger, ModifyCategory, ModifyChannel, ModifyDoc, ModifyKB, ModifyLabel, ModifyPlugin, ModifyQA, ModifySpace。

名称 类型 必选 描述
Paths Array of String 否

参数名称

参数格式:需要获取的指定字段路径


示例值:["SkillList"]

FileParseModel

文档解析模型参数

被如下接口引用:ModifyApp。

名称 类型 必选 描述
Alias String 是 模型别名
示例值:混元大模型
Description String 是 模型描述
示例值:混元
EnhancementMode String 是 增强模式
示例值:VLM
ModelId String 是 模型唯一ID
示例值:hunyuan
ModelProviderType String 是 模型类型
示例值:模型供应商类型
EnableFormulaEnhancement Boolean 否 是否启用公式增强
注意:此字段可能返回 null,表示取不到有效值。
示例值:true
EnableLLMEnhancement Boolean 否 是否启用 LLM 增强
注意:此字段可能返回 null,表示取不到有效值。
示例值:false
OutputHtmlTable Boolean 否 是否输出 HTML 表格
注意:此字段可能返回 null,表示取不到有效值。
示例值:true
SupportedFileList Array of SupportedFileType 否 支持的文件类型列表

Filter

列表通用过滤条件(多个 Filter 之间为 AND 关系,同一 Filter 的多个 value_list 为 OR 关系;BETWEEN 时 value_list 必须恰好 2 个元素表示闭区间 [start, end])

被如下接口引用:DescribeAccountList, DescribeAgentReleasePreviewList, DescribeAgentSummaryList, DescribeAppStatisticsOverview, DescribeAppSummaryList, DescribeAppTriggerRunLogList, DescribeAppTriggerSummaryList, DescribeAuditLogList, DescribeCategoryList, DescribeChannelList, DescribeConcurrencyLimitDetailList, DescribeConflictQASummaryList, DescribeConsumptionDetailList, DescribeDocSummaryList, DescribeKBSummaryList, DescribeLabel, DescribeLabelSummaryList, DescribeMetricOverviewList, DescribeModelList, DescribeMsgRecordList, DescribePluginSummaryList, DescribeQASummaryList, DescribeSkillDetail, DescribeSkillSummaryList, DescribeUsageDetailList, DescribeUsageSummaryList, DescribeVariableList, ExportQA。

名称 类型 必选 描述
Name String 否 过滤字段名
示例值:WorkflowRunId
Operator Integer 否 操作符,默认 IN(向后兼容)
枚举项枚举值描述
FILTER_OPERATOR_IN0属于 value_list(默认值,向后兼容;value_list 不可为空)
FILTER_OPERATOR_NOT_IN1不属于 value_list(value_list 不可为空)
FILTER_OPERATOR_BETWEEN2之间(闭区间 [start, end];value_list 必须恰好 2 个元素,允许其一为空表示单边开区间)

示例值:1
ValueList Array of String 否 过滤值数组
示例值:["8ad82e0553507b4c1ba771fb53029492"]

FinalRerankConfig

最终 rerank 配置

被如下接口引用:SearchKnowledge。

名称 类型 必选 描述
ModelName String 否

模型名称


示例值:Youtu/youtu-reranker-llm

GenerateModel

生成模型配置

被如下接口引用:ModifyApp。

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

GraphRAG

GraphRAG 配置

被如下接口引用:SearchKnowledge。

名称 类型 必选 描述
Enabled Boolean 否

是否启用


示例值:true

Identity

通用身份信息(支持数字 ID 与字符串 ID 两种形态)

被如下接口引用:CreateRelease, CreateSkillShare, DescribeApp, DescribeKB, DescribeKBSummaryList, DescribeLatestRelease, DescribeReleaseSummary。

名称 类型 必选 描述
Description String 否 描述
示例值:标签信息描述
Id String 否 数字 ID
示例值:1990010100000000001
Name String 否 名称
示例值:办公协作
StrId String 否 字符串 ID
示例值:1990010100000000001

InputBoxConfig

输入框配置

被如下接口引用:ModifyApp。

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

IntentAchievementInfo

意图达成信息

被如下接口引用:ModifyApp。

名称 类型 必选 描述
Description String 是 描述
示例值:文档回复
Name String 是 名称
示例值:doc

IntervalSchedule

IntervalSchedule

被如下接口引用:CreateAppTrigger, DescribeAppTrigger, ModifyAppTrigger。

名称 类型 必选 描述
StartAt String 否 开始时间
示例值:2026-06-13T00:00:00+08:00
Unit Integer 否
枚举值:
| 枚举值 | uint |
| --- | --- |
| INTERVAL_UNIT_UNSPECIFIED | 0 |
| INTERVAL_UNIT_HOUR | 1 |
| INTERVAL_UNIT_DAY | 2 |
示例值:1
Value Integer 否 值
示例值:2

KBCapacity

知识库容量信息

被如下接口引用:DescribeKB。

名称 类型 必选 描述
MaxCharSize String 否

最大字符数


示例值:0
OverCharSize String 否

超量字符数


示例值:0
UsedCharSize String 否

已用字符数


示例值:0

KBCategory

知识库分类信息(含元数据配置)

被如下接口引用:DescribeCategoryList。

名称 类型 必选 描述
CanAdd Boolean 否

是否可新增


示例值:true
CanDelete Boolean 否

是否可删除


示例值:true
CanEdit Boolean 否

是否可编辑


示例值:true
CategoryId String 否

分类 ID


示例值:2097981890478474752
ChildList Array of KBCategory 否

子分类列表

IsLeaf Boolean 否

是否为叶子节点(无子分类)


示例值:true
ItemCount Integer 否

分类对象的数量


示例值:3
MetaValue MetaValue 否

元数据配置(该分类被设置为元数据时的配置信息)


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

分类名称


示例值:aaa2323

KBModelConfig

知识库模型配置

被如下接口引用:CreateKB, DescribeKB, ModifyKB。

名称 类型 必选 描述
EmbeddingModel String 否

Embedding 模型


示例值:Youtu/youtu-embedding
QaExtractModel String 否

QA 抽取模型


示例值:Auto/auto
SchemaModel String 否

Schema 生成模型


示例值:Deepseek/deepseek-v4-pro

KBModifyExtendFields

知识库修改扩展字段(用于触发特殊操作)

被如下接口引用:ModifyKB。

名称 类型 必选 描述
Action Integer 否

扩展操作:1=触发恢复超量

枚举项枚举值描述
KB_EXTENDED_ACTION_UNKNOWN0
KB_EXTENDED_ACTION_RESUME_EXCEEDED1触发恢复超量(将知识库从超量状态恢复为正常状态)


示例值:0

KBPermission

知识库操作权限信息

被如下接口引用:DescribeKB, DescribeKBSummaryList。

名称 类型 必选 描述
CanDelete Boolean 否

是否可删除


示例值:true
CanEdit Boolean 否

是否可编辑


示例值:true
CanShare Boolean 否

能否被共享


示例值:true
CanView Boolean 否

是否可查看


示例值:true

KBRetrievalConfig

单个知识库检索配置

被如下接口引用:SearchKnowledge。

名称 类型 必选 描述
DbRetrievalConfig DBRetrievalConfig 否

数据库检索配置


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

文档检索配置


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

知识库 ID


示例值:2084643656683962752
OptionConfig RetrievalOption 否

检索可选配置


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

QA 检索配置


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

rerank 配置


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

检索过滤配置


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

检索策略:1=混合,2=语义,3=关键词,4=无

枚举项枚举值描述
SEARCH_STRATEGY_TYPE_UNKNOWN0
SEARCH_STRATEGY_TYPE_MIXING1混合检索
SEARCH_STRATEGY_TYPE_SEMANTIC2语义检索
SEARCH_STRATEGY_TYPE_KEYWORD3关键词检索
SEARCH_STRATEGY_TYPE_NONE4无语义/向量检索


示例值:1
TextToSqlModel ModelDetailInfo 否

text2sql 模型


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

KBShareStatus

知识库子状态信息

被如下接口引用:DescribeKB, DescribeKBSummaryList。

名称 类型 必选 描述
ApprovalId String 否

审批Id


示例值:2102028569658115904
SubStatusList Array of Integer 否

审批/共享状态:1=PENDING 审批中,2=REJECTED 已驳回, 3=APPROVED 同意, 4=CANCELLED 已取消


示例值:[1]

KBSpaceShare

知识库空间共享信息

被如下接口引用:DescribeKB, DescribeKBSummaryList。

名称 类型 必选 描述
IsSpaceShared Boolean 否

是否已被其他空间引用


示例值:true
SharedSpaceList Array of Identity 否

被引用空间信息


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

共享状态


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

是否允许操作


示例值:true

KBSpec

知识库可写属性集合(配合 update_mask 使用)

被如下接口引用:CreateKB, ModifyKB。

名称 类型 必选 描述
Description String 否

描述


示例值:V2 KB 用例自建共享 KB(已修改)
EsConfig ESConfig 否

ES 配置


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

模型配置


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

知识库名称


示例值:共享知识库-模型配置计费-更新_adp_qta_nGWWQc
OwnerId String 否

所有者 ID


示例值:2067622575842400832

KBSummary

知识库摘要信息

被如下接口引用:DescribeKB, DescribeKBSummaryList。

名称 类型 必选 描述
AppList Array of Identity 否

关联的应用列表,仅共享知识库返回

CreateTime String 否

创建时间(Unix 秒)


示例值:1788420591
Creator Operator 否

创建人


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

描述


示例值:测试权限
DocCount Integer 否

文档数


示例值:72
IsExceeded Boolean 否

是否超量


示例值:true
KbId String 否

知识库 ID


示例值:2085276041989969472
KbType Integer 否

类型:1=默认知识库,2=共享知识库

枚举项枚举值描述
KB_TYPE_UNKNOWN0
KB_TYPE_DEFAULT1默认知识库
KB_TYPE_SHARED2共享知识库


示例值:2
LatestOperator Operator 否

最后操作人,仅共享知识库返回


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

知识库名称


示例值:共享知识库_生效范围综合查询_adp_qta_TQMtMT
Permission KBPermission 否

操作权限


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

处理中状态列表


示例值:[1]
SharedSubType Integer 否

共享子类型:1=普通,2=公众号

枚举项枚举值描述
SHARED_KB_SUB_TYPE_UNKNOWN0
SHARED_KB_SUB_TYPE_NORMAL1普通
SHARED_KB_SUB_TYPE_PUBLIC_ACCOUNT2公众号


示例值:1
UpdateTime String 否

更新时间(Unix 秒)


示例值:1788420601
SpaceShare KBSpaceShare 否

知识库空间共享信息


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

KVPair

通用键值对

被如下接口引用:SearchKnowledge。

名称 类型 必选 描述
Key String 否 键
示例值:key
Value String 否 值
示例值:value

KnowledgeResult

单条检索结果

被如下接口引用:SearchKnowledge。

名称 类型 必选 描述
Confidence Float 否

置信度


示例值:0.3912946
KnowledgeType Integer 否

命中知识类型:1=问答,2=文档片段,3=数据库,4=图谱

枚举项枚举值描述
KNOWLEDGE_SOURCE_TYPE_UNKNOWN0
KNOWLEDGE_SOURCE_TYPE_QA1问答
KNOWLEDGE_SOURCE_TYPE_DOC2文档片段
KNOWLEDGE_SOURCE_TYPE_DB3数据库
KNOWLEDGE_SOURCE_TYPE_GRAPH4图谱


示例值:0
RecallTypeList Array of Integer 否

召回类型列表


示例值:[3]
ResultPayload SearchResultPayload 否

结果负载


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

检索结果类型

枚举项枚举值描述
SEARCH_RESULT_TYPE_UNKNOWN0
SEARCH_RESULT_TYPE_RETRIEVAL1普通检索结果
SEARCH_RESULT_TYPE_TEXT_TO_SQL2text2sql 结果
SEARCH_RESULT_TYPE_IMAGE_SEARCH_IMAGE3
SEARCH_RESULT_TYPE_TEXT_SEARCH_IMAGE4


示例值:1
SimilarQuestionExtra SimilarQuestionExtra 否

相似问额外信息


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

知识片段基础信息


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

知识来源信息


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

KnowledgeScope

知识生效范围

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

名称 类型 必选 描述
EffectiveDomain Integer 否

生效作用域

枚举项枚举值描述
KNOWLEDGE_EFFECTIVE_DOMAIN_UNKNOWN0
KNOWLEDGE_EFFECTIVE_DOMAIN_NONE1停用
KNOWLEDGE_EFFECTIVE_DOMAIN_DEV2仅开发域
KNOWLEDGE_EFFECTIVE_DOMAIN_RELEASE3仅发布域
KNOWLEDGE_EFFECTIVE_DOMAIN_ALL4全域


示例值:1
LabelRefList Array of LabelRef 否

适用范围(标签条件)

KnowledgeSnippetProfile

知识片段基础信息

被如下接口引用:SearchKnowledge。

名称 类型 必选 描述
Content String 否

内容


示例值:文档名:奔驰文档片段:车型:奔驰e300价格:30w地点:上海上市时间:2021年轮胎直径:80cm颜色:黑色
DocId String 否

关联文档 ID


示例值:2079848099272955712
DocName String 否

文档名


示例值:肺鱼.txt
KbId String 否

知识库 ID


示例值:2097668735455299264
KnowledgeId String 否

知识 ID


示例值:2079928370944713359
Question String 否

问题


示例值:小王电话
Title String 否

文档标题


示例值:肺鱼

KnowledgeSource

知识来源信息

被如下接口引用:SearchKnowledge。

名称 类型 必选 描述
IsBigData Boolean 否

是否为大数据


示例值:true
IsShared Boolean 否

是否为共享知识库


示例值:true
KbName String 否

知识库名


示例值:我的智能体应用31

LabelModifyFields

标签可修改字段集合(配合 update_mask 使用)

被如下接口引用:ModifyLabel。

名称 类型 必选 描述
Name String 否

标签名称


示例值:24234
TermModifyList Array of LabelTermModifyItem 否

标准词增量修改列表(增/改/删)

LabelRef

标签引用(出参用)

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

名称 类型 必选 描述
LabelId String 否

标签 ID


示例值:2096808563606119117
LabelName String 否

标签名称


示例值:车型
LabelTermIdList Array of String 否

标签标准词 ID 列表


示例值:["2096808563606119116"]
LabelTermList Array of String 否

标签标准词列表


示例值:["车型1"]

LabelRefIdentity

标签引用身份标识(入参用)

被如下接口引用:CreateQAList, ImportDocList, ModifyDoc, ModifyDocList, ModifyQA, ModifyQAList。

名称 类型 必选 描述
LabelId String 否

标签 ID


示例值:2097933107321374219
LabelTermIdList Array of String 否

标签标准词 ID 列表


示例值:["2097933107321374218"]

LabelRefIdentityList

标签引用列表

被如下接口引用:ModifyDocList, ModifyQAList。

名称 类型 必选 描述
ItemList Array of LabelRefIdentity 否

标签引用列表

LabelSummary

标签摘要

被如下接口引用:DescribeLabel, DescribeLabelSummaryList。

名称 类型 必选 描述
LabelId String 否

标签 ID


示例值:2096808563606119117
MetaValue MetaValue 否

元数据配置(该标签被设置为元数据时的配置信息)


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

标签名称


示例值:车型
RefCount Integer 否

引用该标签的资源数


示例值:4
TermList Array of LabelTerm 否

标签值(标准词 + 同义词列表)

TermTotalCount Integer 否

标签值总数


示例值:4

LabelTerm

标准词(标签值的一项)

被如下接口引用:CreateLabel, DescribeLabel, DescribeLabelSummaryList, ModifyLabel。

名称 类型 必选 描述
SynonymList Array of String 否

同义词列表


示例值:["车型11"]
Term String 否

标准词


示例值:测试70
TermId String 否

标准词 ID(由后台生成,创建时不传)


示例值:2096808563618702028

LabelTermCheckResult

标准词校验项

被如下接口引用:CheckLabel。

名称 类型 必选 描述
CheckResult CheckResult 否 校验结果
注意:此字段可能返回 null,表示取不到有效值。
Term String 否 待校验的标准词
示例值:测试50
TermId String 否 已存在时返回对应标准词 ID
示例值:2097973974787774145

LabelTermModifyItem

标签标准词修改项(增量更新)

被如下接口引用:ModifyLabel。

名称 类型 必选 描述
ModifyAction Integer 是

操作类型(不可为 0,取值:1=新增,2=修改,3=删除)

枚举项枚举值描述
MODIFY_ACTION_UNKNOWN0
MODIFY_ACTION_CREATE1新增
MODIFY_ACTION_UPDATE2修改
MODIFY_ACTION_DELETE3删除


示例值:2
SynonymList Array of String 否

同义词列表(CREATE 与 UPDATE 时传完整同义词集合,覆盖式更新)


示例值:["212"]
Term String 否

标准词(CREATE 与 UPDATE 必填,DELETE 可留空)


示例值:546553453
TermId String 否

标准词 ID(UPDATE 与 DELETE 必填,CREATE 留空由后台生成)


示例值:2095415870048304294

LarkChannelConfig

飞书机器人渠道配置

被如下接口引用:CreateChannel, DescribeChannel, DescribeChannelList, ModifyChannel。

名称 类型 必选 描述
AppId String 否

飞书机器人AppId


示例值:c***0****be9
AppSecret String 否

飞书机器人AppSecret


示例值:i8*v***TLnqns3nu

LineChannelConfig

LINE渠道配置

被如下接口引用:CreateChannel, DescribeChannel, DescribeChannelList, ModifyChannel。

名称 类型 必选 描述
AccessToken String 否

LINE Channel Access Token


示例值:b***23d4a7bc
CallbackUrl String 否

LINE回调地址


示例值:https://****b****3d4a7**
ChannelSecret String 否

LINE Channel Secret


示例值:*76-7a9323d4a7bc

MCPPluginConfig

MCP插件配置信息

被如下接口引用:CreatePlugin, ModifyPlugin。

名称 类型 必选 描述
ExternalMCPServerUrl String 否

MCP插件外部访问地址


示例值:https://adp.tencent.cloud.com/plugin/mcp/xxxxxx/mcp
MCPServerUrl String 否

MCP server地址


示例值:http://xxx.com/mcp
MCPTransport Integer 否

MCP传输类型: SSE/Streamable
枚举值:
| uint | 描述 |
| --- | --- |
| 0 | SSE + HTTP 模式 |
| 1 | Streamable HTTP 模式 |


示例值:0
PluginHeader Array of PluginParam 否

MCP插件的header参数

PluginQuery Array of PluginParam 否

MCP插件的query参数

SSEReadTimeout Integer 否

SSE长连接超时时间,单位秒


示例值:300
Timeout Integer 否

请求超时时间,单位秒


示例值:5
AuthConfig AuthConfig 否

授权信息

SupportsApps Boolean 否

是否支持交互界面(MCP Apps),插件级标签,默认false


示例值:false

MCPToolConfig

MCPToolConfig

被如下接口引用:CreatePlugin, ModifyPlugin。

名称 类型 必选 描述
Inputs Array of RequestParam 否

输入参数

Outputs Array of ResponseParam 否

输出参数

Meta MCPToolMeta 否

工具meta信息


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

是否支持交互界面(MCP Apps),插件级标签 默认值:false


示例值:false

MCPToolMeta

对应 MCP 协议工具 _meta,承载 MCP Apps 工具的 UI 元信息(本期仅消费 resourceUri)

被如下接口引用:CreatePlugin, ModifyPlugin。

名称 类型 必选 描述
Ui MCPToolUIMeta 否

工具的 UI 扩展元信息,对应 MCP 协议的 _meta.ui,声明工具关联的交互式界面资源(ResourceUri)及调用方可见性(Visibility)。仅当工具支持 MCP Apps 或声明了可见性时返回;纯文本工具该字段为空。详见 MCPToolUIMeta 结构定义。

MCPToolUIMeta

对应 MCP 协议 _meta.ui,定义 MCP Apps 工具的交互界面元信息(本期仅消费 resourceUri,visibility)

被如下接口引用:CreatePlugin, ModifyPlugin。

名称 类型 必选 描述
ResourceUri String 否

关联的 UI 资源 URI,ui:// scheme,格式为 ui://<插件标识>/<资源名>-<版本>。该字段是 MCP Apps 交互式界面的入口,非空时表示工具支持 Apps("文本 + 交互式界面"展示),为空则为纯文本工具。由工具同步结果自动识别填充,不支持手工编辑。


示例值:ui://overtime-apply/mcp-app.html
Visibility Array of String 否

工具的调用方可见性声明,取值范围:model(模型可调用)、app(应用界面可调用),可多选,如 ["model","app"]。与 ResourceUri 相互独立(SEP-1865),可单独存在,例如纯后端 app-only 工具为 ["app"]。当 ResourceUri 非空且本字段缺省时,按规范归一化为 ["model","app"];存量非 Apps 工具保持为空。

枚举值:

  • model: 支持model
  • app: 支持app

示例值:["model"]

ManualOnlySchedule

ManualOnlySchedule

被如下接口引用:CreateAppTrigger, DescribeAppTrigger, ModifyAppTrigger。

名称 类型 必选 描述
Enabled Boolean 否 启用
示例值:true

MetaValue

元数据值

被如下接口引用:DescribeCategoryList, DescribeLabel, DescribeLabelSummaryList。

名称 类型 必选 描述
Name String 否

元数据值名称(仅展示使用)


示例值:测试15
RefAll Boolean 否

是否引用该类型下的全部值(true 时 ref_value_id 应为 0)


示例值:true
RefValueId String 否

元数据引用的业务 ID(属性 ID、分类 ID 等);ref_all=true 时该字段应为 0


示例值:2096808563601924809
Scene Integer 否

元数据使用场景:1=仅检索使用,2=检索和生成都使用

枚举项枚举值描述
META_SCENE_UNKNOWN0未知
META_SCENE_SEARCH_ONLY1仅检索使用
META_SCENE_ALL2检索和生成都使用


示例值:2
ValueType Integer 否

元数据值类型:1=属性标签,2=文档分类,3=问答分类

枚举项枚举值描述
META_VALUE_TYPE_UNKNOWN0未知
META_VALUE_TYPE_TAG1属性标签
META_VALUE_TYPE_DOC_CATEGORY2文档分类
META_VALUE_TYPE_QA_CATEGORY3问答分类


示例值:1

MetricOverview

总览 KPI 卡片指标项

被如下接口引用:DescribeMetricOverviewList。

名称 类型 必选 描述
Key String 否

指标键,取值参考 MetricOverview 注释中的 key 白名单


示例值:total_calls
Mom Float 否

环比百分比,无环比时填 0


示例值:0.15
Unit Integer 否

指标单位,枚举值 DosageUnit;key 与 unit 的对应关系参考 MetricOverview 注释白名单

枚举项枚举值描述
DOSAGE_UNIT_TOKEN0token(默认)
DOSAGE_UNIT_PAGE_COUNT1page_count(页数)
DOSAGE_UNIT_TIMES2times(次数)
DOSAGE_UNIT_SECOND3second(秒)
DOSAGE_UNIT_ITEM4item(条)
DOSAGE_UNIT_SHEET5sheet(张)
DOSAGE_UNIT_CHARACTER6character(字符)
DOSAGE_UNIT_GB7GB
DOSAGE_UNIT_NUMBER8number(个数)
DOSAGE_UNIT_MILL_SECOND9mill_second(毫秒)

示例值:2
Value Float 否

指标数值


示例值:12580

Model

模型完整信息

被如下接口引用:DescribeModelList。

名称 类型 描述
BadgeList Array of ModelBadge

模型徽章列表


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

模型作者信息


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

模型限制信息


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

模型基本信息


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

模型超参配置


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

模型属性配置


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

模型提供商信息


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

模型状态信息


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

模型标签列表


示例值:["全模态"]

ModelBadge

模型徽章(对外,用户端可见):所有文案已渲染为最终展示内容,不暴露模板参数

被如下接口引用:DescribeModelList。

名称 类型 描述
Text String

展示文案(已渲染为最终文案)


示例值:限时免费
Theme Integer

样式主题

枚举项枚举值描述
MODEL_BADGE_THEME_UNSPECIFIED0未指定
MODEL_BADGE_THEME_INFO1信息(蓝色)
MODEL_BADGE_THEME_SUCCESS2成功(绿色)
MODEL_BADGE_THEME_WARNING3警告(橙色)
MODEL_BADGE_THEME_DANGER4危险(红色)

示例值:2
Tips String

tooltip 文案(已渲染为最终文案),为空则不展示


示例值:该模型当前限时免费使用
Type Integer

徽章类型

枚举项枚举值描述
MODEL_BADGE_TYPE_UNSPECIFIED0未指定
MODEL_BADGE_TYPE_FREE_TRIAL1限时免费
MODEL_BADGE_TYPE_DEPRECATING2即将下线
MODEL_BADGE_TYPE_NEW3新模型
MODEL_BADGE_TYPE_HOT4热门

示例值:1

ModelBasic

模型基本信息(已弃用,请使用 ModelProfile)

被如下接口引用:DescribeModelList。

名称 类型 描述
Description String

模型描述


示例值:通用大语言模型
IconUrl String

模型图标地址


示例值:https://example.cos.ap-guangzhou.myqcloud.com/public/***/image/***.png
ModelId String

模型ID


示例值:DeepSeek-V3.2
ModelType Integer

模型类型

枚举项枚举值描述
MODEL_TYPE_UNSPECIFIED0未指定
MODEL_TYPE_LLM1LLM模型
MODEL_TYPE_RERANK2Rerank模型
MODEL_TYPE_EMBEDDING3Embedding模型
MODEL_TYPE_FILE_PARSE4文档解析模型

示例值:1
Name String

模型名称


示例值:DeepSeek-V3.2

ModelDetailInfo

模型详细信息

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

名称 类型 必选 描述
Alias String 否 模型别名
示例值:DeepSeek-V3.2
HistoryLimit Integer 否 历史对话条数限制
示例值:5
ModelId String 否 模型唯一 ID
示例值:Deepseek/deepseek-v3.2
ModelParams ModelParams 否 模型参数
注意:此字段可能返回 null,表示取不到有效值。

ModelDeveloperBasic

模型作者基本信息(已弃用)

被如下接口引用:DescribeModelList。

名称 类型 必选 描述
Alias String 否

作者别名


示例值:智谱AI
Name String 否

作者标识


示例值:Zhipu

ModelLimit

模型限制信息

被如下接口引用:DescribeModelList。

名称 类型 描述
ContextLengthDescription String

模型上下文长度展示文案(如 128K、1000K)


示例值:128K
InputLengthLimit Integer

模型对话框输入长度字符数限制


示例值:8000
MaxInputTokensDescription String

最大输入 Tokens 展示文案(如 960k,服务端格式化,未配置为空串)


示例值:256K
MaxOutputTokensDescription String

最大输出 Tokens 展示文案(如 64k,服务端格式化,未配置为空串)


示例值:128K
PromptLengthLimit Integer

模型提示词长度字符数限制


示例值:4000

ModelParameter

模型超参

被如下接口引用:DescribeModelList。

名称 类型 描述
DefaultValue String

默认值


示例值:0.7
EnumValueList Array of String

可选值列表


示例值:[""enabled","disabled""]
MaxValue Float

最大值(仅数值类型有效)


示例值:1.0
MinValue Float

最小值(仅数值类型有效)


示例值:0.0
Name String

超参名称


示例值:temperature
Type Integer

超参类型。1-浮点数, 2-整数, 3-字符串


示例值:1

ModelParams

模型参数

被如下接口引用:CreateAgent, DescribeAgentDetail, ModifyAgent, ModifyApp, SearchKnowledge。

名称 类型 必选 描述
DeepThinking String 否

是否开启深度思考


示例值:disabled
FrequencyPenalty Float 否

频率惩罚


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

最大输出长度


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

存在惩罚


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

深度思考效果


示例值:none
RepetitionPenalty Float 否

重复惩罚


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

输出格式(text、json_object)


示例值:text
Seed Integer 否

seed 随机种子


注意:此字段可能返回 null,表示取不到有效值。
示例值:1
StopSequenceList Array of String 否

停止序列


示例值:["前进"]
Temperature Float 否

温度


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

top_p


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

top_k


示例值:1

ModelProperty

模型属性(支持工作流类型/AI 通话类型/是否关闭模型参数/是否支持深度思考/是否限时免费/是否默认模型等)

被如下接口引用:DescribeModelList。

名称 类型 描述
Name String

属性名称


示例值:support_workflow_status
Value String

属性值


示例值:1

ModelProviderBasic

模型提供商基本信息(已弃用,请使用 ModelProviderProfile)

被如下接口引用:DescribeModelList。

名称 类型 描述
Alias String

模型提供商别名


示例值:DeepSeek
Name String

模型提供商名称


示例值:deepseek
ProviderType Integer

模型提供商类型

枚举项枚举值描述
MODEL_PROVIDER_TYPE_UNSPECIFIED0未指定
MODEL_PROVIDER_TYPE_SELF1自有提供商
MODEL_PROVIDER_TYPE_CUSTOM2自定义模型提供商
MODEL_PROVIDER_TYPE_THIRD3第三方模型提供商

示例值:1

ModelStatus

模型状态

被如下接口引用:DescribeModelList。

名称 类型 描述
Concurrency Integer

专属并发数


示例值:0
IsExclusive Boolean

是否专属并发


示例值:false
IsExperienceSupported Boolean

是否支持在智能工作台直接体验(模型广场详情页:依赖 space_id 动态判定;false 时前端置灰「立即体验」按钮)


示例值:true
ResourceStatus Integer

资源状态

枚举项枚举值描述
RESOURCE_STATUS_UNSPECIFIED0未指定
RESOURCE_STATUS_AVAILABLE1资源可用
RESOURCE_STATUS_EXHAUSTED2资源已用尽

示例值:1
RpmLimit String

调用 RPM 上限(当前账号维度:有配置取配置,无配置取默认;0 表示未获取到)


示例值:10
TpmLimit String

调用 TPM 上限(当前账号维度:有配置取配置,无配置取默认;0 表示未获取到)


示例值:10000

ModelUsageDetail

模型调用明细

被如下接口引用:DescribeUsageDetailList。

名称 类型 必选 描述
CallType String 否

调用类型,来源于计费 scene_billing(与 filter.call_type 对应)


示例值:chat
IsDefaultKB Boolean 否

是否默认知识库


示例值:true
ModelName String 否

模型名称


示例值:hunyuan-turbo
ResourceConsumptionList Array of ResourceConsumption 否

MODEL 域单次调用的消耗计量列表(权威字段):按单位+label 分项列出每类计量。unit=TOKEN 时 label 区分 Token 子类别(input/output/avg_/cache_),label 为空表示 total_tokens;unit=PAGE_COUNT 表示模型消耗页数

ConsumptionPU Float 否

本次调用消耗 PU 量


示例值:0.008

ModelUsageSummary

模型资源用量聚合明细(MODEL 域专属)

被如下接口引用:DescribeUsageSummaryList。

名称 类型 必选 描述
CallCount Float 否

调用次数(业务调用维度的顶层计数)


示例值:1800
IsDefaultKB Boolean 否

是否默认知识库


示例值:true
ModelName String 否

模型名称,标识使用的 AI 模型


示例值:hunyuan-pro
ResourceConsumptionList Array of ResourceConsumption 否

MODEL 域消耗计量列表(权威字段):按单位+label 分项列出每类计量。unit=TOKEN 时 label 区分 Token 子类别(input/output/avg_/cache_),label 为空表示 total_tokens;unit=PAGE_COUNT 表示模型消耗页数

ConsumptionPU Float 否

模型消耗 PU 总量(聚合维度内的 PU 消耗之和)


示例值:194395

MsgRecord

MsgRecord

被如下接口引用:DescribeMsgRecordList。

名称 类型 描述
Answer String 答案
示例值:你好!有什么我可以帮助你的吗?
AppId String 应用ID
示例值:2059116175760018240
CategoryId String 分类ID
示例值:0
CreateTime String 创建时间
示例值:1780390822
Intent String 意图
示例值:聊天
IntentCategory String 意图分类
示例值:self_awareness
IsSmart Boolean 是否是智能分类
示例值:true
Question String 问题
示例值:你好
RecordId String 记录ID
示例值:9cf_20260602_170021_708_05qBgUfb
ReplyMethod Integer 表示消息的回复方式,枚举 ReplyMethod:0=未指定, 1=大模型直接回复, 2=保守回复, 3=拒答, 4=敏感回复, 5=问答对优先回复, 6=欢迎语, 7=并发超限, 8=全局干预知识, 9=任务流程过程回复, 10=任务流程答案, 11=搜索引擎, 12=知识润色, 13=图片理解, 14=实时文档, 15=澄清确认, 16=工作流回复, 17=工作流结束, 18=智能体回复, 19=多意图, 20=中断, 21=智能体计划预览, 22=智能体计划结果, 23=智能体结构化输出。
示例值:10
Result MsgRecordResult 返回结果
Score Integer 分数
示例值:0
SessionId String 会话ID
示例值:0fad7bb5-6b75-4667-bfea-64ec2503a964
Source MsgRecordSource 来源
TraceId String trace_id
示例值:bf21a83c67a647e3a8e2925ecbfda598

MsgRecordCategory

MsgRecordCategory

被如下接口引用:DescribeMsgRecordCategoryList。

名称 类型 必选 描述
CategoryId String 否

分类的业务 ID


示例值:2087095266081654784
Children Array of MsgRecordCategory 否

子分类列表,树形嵌套

Name String 否

分类名称


示例值:公众号渠道
Permission CategoryPermission 否

当前用户对该分类的操作权限

TotalCount String 否

该分类下消息记录的数量


示例值:0

MsgRecordResult

MsgRecordResult

被如下接口引用:DescribeMsgRecordList。

名称 类型 描述
CallResult Integer 表示该条消息的调用结果:0=CALL_RESULT_UNKNOWN(全部/未知), 1=CALL_RESULT_SUCCESS(成功), 2=CALL_RESULT_FAILED(失败);fail_reason(string)为调用失败时的失败原因描述。
示例值:1
CustomerVariable String 自定义变量,json字符串
示例值:{"name":"naevar"}
FailReason String 失败原因
示例值:0
FirstTokenLatency Integer 首token耗时
示例值:4636
InputToken Integer 输入token数
示例值:0
OutputToken Integer 输出token数
示例值:0
TotalToken Integer 总token数
示例值:0
TotalTokenLatency Integer 总token耗时
示例值:5673

MsgRecordSource

MsgRecordSource

被如下接口引用:DescribeMsgRecordList。

名称 类型 描述
ChannelType Integer 对话消息的接入渠道类型:0=未指定, 1=坐席, 2=体验页面(腾讯云), 3=评测端对话, 4=体验页面(手机号), 5=对话端API接入, 6=评测任务对话, 10=工作流调试, 10000=微信公众号, 10001=微信服务号, 10002=企微应用, 10003=网页组件, 10004=微信客服, 10005=微信小程序, 10006=元器, 10007=应用宝, 10008=元宝, 10009=企微智能机器人, 10010=元器API, 10011=LINE, 10012=Telegram, 10100=电脑管家, 20001=荣耀智能体平台, 20002=小米应用商店;user_id(string)为该渠道下的访客唯一标识。
示例值:3
FromId String 用户ID
示例值:180
FromType Integer 消息发送者的用户来源类型:1=用户(访客/C端用户), 2=机器人(AI回复), 3=坐席(人工客服);from_id(string)为该来源类型下的用户唯一标识 ID。
示例值:2
UserAvatar String 用户头像
示例值:https://qidian-qbot-1251316161.cos.ap-guangzhou.myqcloud.com/public/avatar_monkey01.png
UserId String 访客ID
示例值:1747547736783716352
UserNickname String 访客名称
示例值:coco测试11

MultiAgentConfig

多智能体配置

被如下接口引用:ModifyApp。

名称 类型 必选 描述
AgentCollaboration AgentCollaborationConfig 是 Agent协同配置
注意:此字段可能返回 null,表示取不到有效值。

MultiModalQAModel

多模态问答模型配置

被如下接口引用:ModifyApp。

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

MultiModalUnderstandingModel

多模态理解模型配置

被如下接口引用:ModifyApp。

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

OAuthConfig

OAuth2.0授权信息

被如下接口引用:CreatePlugin, ModifyPlugin。

名称 类型 必选 描述
AuthorizationUrl String 否 OAuth服务方授权页url地址
示例值:https://xxx.com/auth
ClientId String 否 客户端ID
示例值:nA8tI0fA4rW8iK6wR2cE
ClientSecret String 否 客户端密钥
示例值:yM3hM6dA8fA3fE2xG1jH5pK9vI2vQ2vQ
ScopeList Array of String 否 请求授权的数据范围
示例值:["read:user"]
TokenUrl String 否 获取access token的url地址
示例值:https://xxx.com/token

OnceSchedule

OnceSchedule

被如下接口引用:CreateAppTrigger, DescribeAppTrigger, ModifyAppTrigger。

名称 类型 必选 描述
FireTime String 否 触发时间
示例值:2026-06-01T09:00:00+08:00

OperationResult

通用操作结果项

被如下接口引用:CreateQAList, DeleteDocList, DeleteLabelList, DeleteQAList, ImportDocList, ModifyDocList, ModifyQAList。

名称 类型 必选 描述
Id String 否

资源 ID


示例值:2097223869533083840
Reason String 否

失败原因(succeeded=false 时填充)


示例值:450141-ErrAttributeLabelAttrHasUsed
Succeeded Boolean 否

是否成功


示例值:true

Operator

通用操作人信息

被如下接口引用:DescribeDoc, DescribeDocSummaryList, DescribeKB, DescribeKBSummaryList, DescribeQA, DescribeQASummaryList。

名称 类型 必选 描述
UserId String 否 用户 ID
示例值:9747
UserName String 否 用户姓名
示例值:张三

PlatformUsageSummary

平台资源用量聚合明细(PLATFORM 域专属)

被如下接口引用:DescribeUsageSummaryList。

名称 类型 必选 描述
ResourceConsumptionList Array of ResourceConsumption 否

PLATFORM 域消耗计量列表(权威字段):按单位+label 分项列出每类计量,label 取 PlatformBizType 枚举名称字符串;典型如 unit=TIMES + label=PLATFORM_BIZ_TYPE_SECURITY_AUDIT/WEB_SEARCH/OPEN_CLAW/APP_INVOKE,unit=ITEM + label=PLATFORM_BIZ_TYPE_LONG_TERM_MEMORY

Plugin

插件详情

被如下接口引用:DescribePlugin。

名称 类型 必选 描述
Config PluginConfig 否 插件配置
注意:此字段可能返回 null,表示取不到有效值。
CreateTime String 否 创建时间,unix时间戳
示例值:1780047312
Operation PluginOperation 否 插件运营管理信息
注意:此字段可能返回 null,表示取不到有效值。
PluginId String 否 插件id
示例值:0960ae93-80a0-408d-928b-f484064f834a
PluginVersion Integer 否 插件版本号
示例值:1
Profile PluginProfile 否 插件基础信息
注意:此字段可能返回 null,表示取不到有效值。
Statistics PluginStatistics 否 插件统计信息
注意:此字段可能返回 null,表示取不到有效值。
Status Integer 否

插件状态,1:可用,2:不可用

枚举值:

  • 1: 可用
  • 2: 不可用

示例值:1
ToolList Array of Tool 否 工具列表
注意:此字段可能返回 null,表示取不到有效值。
UpdateTime String 否 更新时间,Unix时间戳
示例值:1780047312
UserState PluginUserState 否 用户维度的插件状态信息
注意:此字段可能返回 null,表示取不到有效值。

PluginConfig

插件配置

被如下接口引用:CreatePlugin, DescribePlugin, DescribePluginSummaryList, ModifyPlugin。

名称 类型 必选 描述
ApiPluginConfig ApiPluginConfig 否 API插件配置
注意:此字段可能返回 null,表示取不到有效值。
AppPluginConfig AppPluginConfig 否 应用插件配置
注意:此字段可能返回 null,表示取不到有效值。
MCPPluginConfig MCPPluginConfig 否 mcp插件配置
注意:此字段可能返回 null,表示取不到有效值。

PluginOperation

PluginOperation

被如下接口引用:DescribePlugin, DescribePluginSummaryList。

名称 类型 必选 描述
AllowExternalAccess Boolean 否 是否允许外部调用
示例值:true
BillingType Integer 否

计费类型。

枚举值:

  • 0:免费
  • 1:公测
  • 2:官方收费

示例值:3
CategoryKey String 否 插件分类标识
示例值:search_fetch
Introduction String 否 插件概述
示例值:# 混元生3D AI3D> 前往 腾讯混元生3D 了解更多。
IsRecommended Boolean 否 是否精选
示例值:true

PluginParam

MCP插件参数信息

被如下接口引用:CreatePlugin, ModifyPlugin。

名称 类型 必选 描述
IsGlobalHidden Boolean 否 参数配置是否隐藏不可见
示例值:false
IsRequired Boolean 否 参数是否必填
示例值:true
Name String 否 参数名称
示例值:key
Value String 否 参数值
示例值:abc123

PluginProfile

PluginProfile

被如下接口引用:CreatePlugin, DescribePlugin, DescribePluginSummaryList, ModifyPlugin。

名称 类型 必选 描述
Author String 否 插件作者
示例值:智能体开发平台
Description String 否 插件描述
示例值:基于混元大模型,可以根据用户输入的文本query,自动创作不同风格的图片(极速版)
IconUrl String 否 插件图标url
示例值:https://qidian-qbot-test-1251316161.cos.ap-guangzhou.myqcloud.com/public/adp/0d0b65f37d0651ef8c4dc61d7238617d_1780285068379.png
Name String 否 插件名称
示例值:混元生3D AI3D
PluginClass Integer 否

插件产品分类

枚举值:

  • 0:普通插件
  • 1:连接器类插件

示例值:0
PluginKind Integer 否

插件类型

枚举值:

  • 0:API接口
  • 1:代码
  • 2:MCP
  • 3:应用

示例值:0
PluginSource Integer 否

插件来源

枚举值:

  • 0:自定义插件
  • 1:官方插件
  • 2:第三方插件

示例值:1

PluginStatistics

PluginStatistics

被如下接口引用:DescribePlugin, DescribePluginSummaryList。

名称 类型 必选 描述
CallCount Integer 否 插件调用量
示例值:9
ToolCount Integer 否 工具数量
示例值:6

PluginSummary

插件概要信息(用于插件列表)

被如下接口引用:DescribePluginSummaryList。

名称 类型 必选 描述
Config PluginConfig 否

插件配置信息

IsShared Boolean 否

是否已配置共享


示例值:false
Operation PluginOperation 否

插件运营管理信息

PluginId String 否

插件id


示例值:0960ae93-80a0-408d-928b-f484064f834a
Profile PluginProfile 否

插件基础信息

SpaceId String 否

插件所属空间 ID;内置插件为空


示例值:default_space
Statistics PluginStatistics 否

插件统计信息

Status Integer 否

插件状态,1:可用,2:不可用

枚举值:

  • 1: 可用
  • 2: 不可用

示例值:1
ToolList Array of ToolSummary 否

工具信息

UserState PluginUserState 否

用户维度的插件状态信息

UpdateTime String 否

更新时间,Unix时间戳

单位:秒


示例值:1787714756

PluginUsageDetail

插件调用明细

被如下接口引用:DescribeUsageDetailList。

名称 类型 必选 描述
PluginName String 否

插件名称


示例值:doc-parser-v2
ResourceConsumptionList Array of ResourceConsumption 否

PLUGIN 域单次调用的消耗计量列表(权威字段):按单位+label 分项列出每类计量。unit=TOKEN 时 label 区分 Token 子类别(input/output/avg_*),label 为空表示 total_tokens

ToolName String 否

插件工具名(tool_name)


示例值:parse_document

PluginUsageSummary

插件资源用量聚合明细(PLUGIN 域专属)

被如下接口引用:DescribeUsageSummaryList。

名称 类型 必选 描述
CallCount Float 否

调用次数(业务调用维度的顶层计数)


示例值:560
ResourceConsumptionList Array of ResourceConsumption 否

PLUGIN 域消耗计量列表(权威字段):按单位+label 分项列出每类计量。unit=TOKEN 时 label 区分 Token 子类别(input/output/avg_*),label 为空表示 total_tokens

PluginUserState

PluginUserState

被如下接口引用:DescribePlugin, DescribePluginSummaryList。

名称 类型 必选 描述
IsFavorite Boolean 否 是否已收藏该插件
示例值:true
IsInWhiteList Boolean 否 是否在插件白名单内
示例值:true
WhiteListType Integer 否

白名单类型,用于表示当前用户是否可直接使用该插件。

枚举值:

  • 0:非白名单插件,全量开放
  • 1:当前用户在白名单内
  • 2:当前用户不在白名单内,需提交申请

示例值:0

PromptRewriteModel

Prompt改写配置

被如下接口引用:ModifyApp。

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

QACreateSpec

QA 创建规格(一次性输入的非持久化数据)

被如下接口引用:CreateQAList。

名称 类型 必选 描述
Question String 是

问题


示例值:苹果有多少个品种?
Answer String 否

答案


示例值:答案1
CategoryId String 否

分类 ID


示例值:0
DocId String 否

关联文档 ID


示例值:0
EffectiveDomain Integer 否

知识生效作用域

枚举项枚举值描述
KNOWLEDGE_EFFECTIVE_DOMAIN_UNKNOWN0
KNOWLEDGE_EFFECTIVE_DOMAIN_NONE1停用
KNOWLEDGE_EFFECTIVE_DOMAIN_DEV2仅开发域
KNOWLEDGE_EFFECTIVE_DOMAIN_RELEASE3仅发布域
KNOWLEDGE_EFFECTIVE_DOMAIN_ALL4全域


示例值:3
ExpirationPolicy ExpirationPolicy 否

过期策略(有效时间与超过有效时间后的行为)


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

适用范围(标签条件)

QuestionDescription String 否

问题描述


示例值:明天天气
SimilarQuestionList Array of String 否

相似问列表


示例值:["明天天气怎么样"]

QALifecycle

QA 生命周期信息

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

名称 类型 必选 描述
CreateTime String 否

创建时间(Unix 秒)


示例值:1789036400
ExpirationPolicy ExpirationPolicy 否

过期策略(有效时间与超过有效时间后的行为)


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

状态:1=待校验,2=未采纳,3=导入失败,4=审核中,5=审核失败,6=学习中,7=学习失败,8=导入完成,9=已过期,10=超量失效,11=超量失效恢复中,12=人工申诉中,13=人工申诉失败

枚举项枚举值描述
QA_STATUS_UNKNOWN0
QA_STATUS_PENDING_VERIFY1待校验
QA_STATUS_NOT_ACCEPTED2未采纳
QA_STATUS_IMPORT_FAIL3导入失败
QA_STATUS_AUDITING4审核中
QA_STATUS_AUDIT_FAIL5审核失败
QA_STATUS_LEARNING6学习中
QA_STATUS_LEARN_FAIL7学习失败
QA_STATUS_IMPORTED8导入完成
QA_STATUS_EXPIRED9已过期
QA_STATUS_QUOTA_INVALID10超量失效
QA_STATUS_QUOTA_RECOVERING11超量失效恢复中
QA_STATUS_MANUAL_APPEALING12人工申诉中
QA_STATUS_MANUAL_APPEAL_FAIL13人工申诉失败


示例值:1
StatusDesc String 否

状态描述


示例值:人工申诉失败
StatusMessage String 否

状态附加信息


示例值:"不合规"
UpdateTime String 否

更新时间(Unix 秒)


示例值:1789036370

QAMetadata

QA 元信息

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

名称 类型 必选 描述
Answer String 否

答案


示例值:Large vehicle use right lane
QaCharCount String 否

问答字符数


示例值:12
QaSize String 否

问答大小(字节,含相似问)


示例值:164
Question String 否

问题


示例值:有哪些条件需要设置限制高度标志?解除限制高度标志什么意思?
RefFieldNameList Array of String 否

元数据引用字段名列表(用于显示问答哪些分类和属性被设置为元数据)


示例值:["b"]

QAModifyFields

QA 可修改字段集合(配合 update_mask 使用)

被如下接口引用:ModifyQA。

名称 类型 必选 描述
Answer String 否

答案


示例值:333334
CategoryId String 否

分类 ID


示例值:2085302048496970304
DocId String 否

关联文档 ID


示例值:2097657266583303104
EffectiveDomain Integer 否

知识生效作用域

枚举项枚举值描述
KNOWLEDGE_EFFECTIVE_DOMAIN_UNKNOWN0
KNOWLEDGE_EFFECTIVE_DOMAIN_NONE1停用
KNOWLEDGE_EFFECTIVE_DOMAIN_DEV2仅开发域
KNOWLEDGE_EFFECTIVE_DOMAIN_RELEASE3仅发布域
KNOWLEDGE_EFFECTIVE_DOMAIN_ALL4全域


示例值:4
ExpirationPolicy ExpirationPolicy 否

过期策略(有效时间与超过有效时间后的行为)


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

是否采纳(校验通过)


示例值:true
LabelRefList Array of LabelRefIdentity 否

适用范围(标签条件)

Question String 否

问题


示例值:活动预告
QuestionDescription String 否

问题描述


示例值:ces
SimilarQuestionList Array of SimilarQuestionModifySpec 否

相似问修改列表

QAOperator

QA 操作者信息

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

名称 类型 必选 描述
Modifier Operator 否

修改人


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

操作权限


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

QAPermission

QA 操作权限信息

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

名称 类型 必选 描述
CanAccept Boolean 否

是否可校验(采纳/不采纳)


示例值:true
CanDelete Boolean 否

是否可删除


示例值:true
CanEdit Boolean 否

是否可编辑


示例值:true

QAQuery

QA 查询条件

被如下接口引用:DescribeQASummaryList, ExportQA。

名称 类型 必选 描述
Query String 否

查询关键词(模糊搜索)


示例值:智能
QueryScopeList Array of Integer 否

查询范围(query 作用的字段):1=问题,2=标签或标签值,3=答案;支持多选,缺省时无效


示例值:[1]

QARetrievalConfig

QA 检索配置

被如下接口引用:SearchKnowledge。

名称 类型 必选 描述
Confidence Float 否

置信度阈值


示例值:0.7
Enabled Boolean 否

是否启用


示例值:true
TopN Integer 否

返回前 N 条


示例值:3

QASegmentHighlight

QA 分片高亮信息

被如下接口引用:DescribeQA。

名称 类型 必选 描述
EndPos String 否

高亮结束位置


示例值:15
StartPos String 否

高亮起始位置


示例值:14

QASourceInfo

QA 来源与关联文档信息

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

名称 类型 必选 描述
DocEffectiveDomain Integer 否

关联文档的生效作用域

枚举项枚举值描述
KNOWLEDGE_EFFECTIVE_DOMAIN_UNKNOWN0
KNOWLEDGE_EFFECTIVE_DOMAIN_NONE1停用
KNOWLEDGE_EFFECTIVE_DOMAIN_DEV2仅开发域
KNOWLEDGE_EFFECTIVE_DOMAIN_RELEASE3仅发布域
KNOWLEDGE_EFFECTIVE_DOMAIN_ALL4全域


示例值:2
DocId String 否

关联文档 ID


示例值:2097525825186409024
FileName String 否

关联文档名称


示例值:数据3.docx
FileType String 否

关联文档类型


示例值:xlsx
SourceDesc String 否

来源描述


示例值:批量导入
SourceType Integer 否

来源类型:1=文档生成,2=批量导入,3=手动录入

枚举项枚举值描述
QA_SOURCE_TYPE_UNKNOWN0
QA_SOURCE_TYPE_DOC1文档生成
QA_SOURCE_TYPE_BATCH_IMPORT2批量导入
QA_SOURCE_TYPE_MANUAL3手动录入


示例值:2

QASummary

QA 摘要信息

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

名称 类型 必选 描述
CategoryPath CategoryPath 否

所属分类路径(包含分类 ID、从根节点开始的分类 ID 路径和分类名称路径)


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

知识生效范围


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

生命周期信息


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

元信息(问题/答案/大小统计)


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

操作者信息


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

QA ID


示例值:2097996646136716608
SimilarQuestion SimilarQuestionStat 否

相似问统计


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

来源信息


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

ReleaseRecord

[数据结构定义] 发布记录

被如下接口引用:DescribeReleaseList。

名称 类型 必选 描述
CanExport Boolean 是 是否可导出
示例值:true
CanRollback Boolean 是 是否可回滚
示例值:false
Description String 是 发布描述
示例值:我的发布信息
FailCount Integer 是 发布失败数
示例值:0
Reason String 是 失败原因
示例值:发布原因
ReleaseId String 是 发布ID
示例值:20617****32
ReleaseVersion String 是 发布版本
示例值:v2026****08
Status Integer 是 发布状态。枚举值: 1:待发布, 2:发布中, 3:发布成功, 4:发布失败, 5:审核中, 6:审核成功, 7:审核失败, 8:发布成功回调处理中, 9:发布暂停, 10:申诉审核中, 11:申诉审核通过, 12:申诉审核不通过
示例值:3
StatusDescription String 是 状态描述
示例值:发布成功
SuccessCount Integer 是 发布成功数
示例值:0
UpdateTime String 是 更新时间 (Unix时间戳,秒级)
示例值:1780389728
Updater String 是 发布人
示例值:wu**g

ReleaseSummary

发布摘要信息

被如下接口引用:DescribeLatestRelease, DescribeReleaseSummary。

名称 类型 必选 描述
CreateTime String 是

创建时间 (Unix时间戳,秒级)


示例值:1780389728
Description String 是

发布描述


示例值:我的发布信息
ReleaseId String 是

发布ID


示例值:2061*32
Status Integer 是

发布状态。枚举值: 1:待发布, 2:发布中, 3:发布成功, 4:发布失败, 5:审核中, 6:审核成功, 7:审核失败, 8:发布成功回调处理中, 9:发布暂停, 10:申诉审核中, 11:申诉审核通过, 12:申诉审核不通过


示例值:3
StatusDescription String 是

状态描述


示例值:发布成功
AppShareAccessControl AppShareAccessControl 否

应用分享访问控制


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

发布渠道ID列表


示例值:["123213213213"]
CorpShareConfig CorpShareConfig 否

企业共享配置


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

RequestParam

RequestParam

被如下接口引用:CreateAgent, CreatePlugin, DescribeAgentDetail, ModifyAgent, ModifyPlugin。

名称 类型 必选 描述
AnyOf Array of RequestParam 否

AnyOf类型的参数

DefaultValue String 否

默认值


示例值:张三
Description String 否

参数描述


示例值:人物名字
IsGlobalHidden Boolean 否

全局隐藏不可见(区别于Agent场景的agent_hidden),true-全局隐藏不可见,false-可见


示例值:false
IsRequired Boolean 否

是否必选


示例值:true
Name String 否

参数名称


示例值:name
OneOf Array of RequestParam 否

OneOf类型的参数

SubParams Array of RequestParam 否

子参数,ParamType 是OBJECT 或 ARRAY<>类型有用

Type Integer 否
枚举项枚举值描述
PARAM_TYPE_STRING0字符串
PARAM_TYPE_INT1整数
PARAM_TYPE_FLOAT2浮点数
PARAM_TYPE_BOOL3布尔值
PARAM_TYPE_OBJECT4对象
PARAM_TYPE_ARRAY_STRING5字符串数组
PARAM_TYPE_ARRAY_INT6整数数组
PARAM_TYPE_ARRAY_FLOAT7浮点数数组
PARAM_TYPE_ARRAY_BOOL8布尔值数组
PARAM_TYPE_ARRAY_OBJECT9对象数组
PARAM_TYPE_ARRAY_ARRAY20数组嵌套
PARAM_TYPE_NULL99空值
PARAM_TYPE_UNSPECIFIED100未指定类型,用于OneOf和AnyOf场景

示例值:0

RerankConfig

重排配置

被如下接口引用:SearchKnowledge。

名称 类型 必选 描述
Enabled Boolean 否

是否启用


示例值:true
ModelName String 否

模型名称


示例值:Youtu/youtu-reranker-llm

ResourceConsumption

单项消耗计量

被如下接口引用:DescribeUsageDetailList, DescribeUsageSummaryList。

名称 类型 必选 描述
Label String 否

功能标签,PLATFORM 场景取 PlatformBizType 枚举名称;MODEL/PLUGIN 场景为空


示例值:avg_cache_miss
Unit Integer 否

消耗计量单位

枚举项枚举值描述
DOSAGE_UNIT_TOKEN0token(默认)
DOSAGE_UNIT_PAGE_COUNT1page_count(页数)
DOSAGE_UNIT_TIMES2times(次数)
DOSAGE_UNIT_SECOND3second(秒)
DOSAGE_UNIT_ITEM4item(条)
DOSAGE_UNIT_SHEET5sheet(张)
DOSAGE_UNIT_CHARACTER6character(字符)
DOSAGE_UNIT_GB7GB
DOSAGE_UNIT_NUMBER8number(个数)
DOSAGE_UNIT_MILL_SECOND9mill_second(毫秒)

示例值:1
Value Float 否

消耗数值


示例值:2187

ResourcePackageInfo

计费套餐包用量信息

被如下接口引用:DescribeResourceSummary。

名称 类型 描述
PackageType Integer

套餐类型

枚举值:

  • 1: 免费版
  • 2: 专业版
  • 3: 企业版

示例值:2
ResourceTotal Integer

资源包总量


示例值:150000
ResourceUsage Float

资源包用量


示例值:150000
KnowledgeCapacity Float

知识库容量


示例值:0
KnowledgeUsage Float

知识库用量


示例值:0
ResourceStatus Integer

资源包状态

枚举值:

  • 1: 正常
  • 3: 已到期
  • 4: 即将到期

示例值:3

ResponseParam

ResponseParam

被如下接口引用:CreatePlugin, ModifyPlugin。

名称 类型 必选 描述
Description String 否

变量描述


示例值:人物名字
Name String 否

参数名称


示例值:name
RenderMode Integer 否
枚举项枚举值描述
OUTPUT_RENDER_REPLACE0覆盖(全量替换)
OUTPUT_RENDER_APPEND1增量追加

示例值:0
SubParams Array of ResponseParam 否

只对 OBJECT 或 ARRAY_OBJECT 类型有用

Type Integer 否
枚举项枚举值描述
PARAM_TYPE_STRING0字符串
PARAM_TYPE_INT1整数
PARAM_TYPE_FLOAT2浮点数
PARAM_TYPE_BOOL3布尔值
PARAM_TYPE_OBJECT4对象
PARAM_TYPE_ARRAY_STRING5字符串数组
PARAM_TYPE_ARRAY_INT6整数数组
PARAM_TYPE_ARRAY_FLOAT7浮点数数组
PARAM_TYPE_ARRAY_BOOL8布尔值数组
PARAM_TYPE_ARRAY_OBJECT9对象数组
PARAM_TYPE_ARRAY_ARRAY20数组嵌套
PARAM_TYPE_NULL99空值
PARAM_TYPE_UNSPECIFIED100未指定类型,用于OneOf和AnyOf场景

示例值:0

RetrievalOption

检索可选配置

被如下接口引用:SearchKnowledge。

名称 类型 必选 描述
ExpirationAwareness ExpirationAwareness 否

时效性检索增强配置


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

GraphRAG配置


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

表格增强配置


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

RoleConfig

角色配置

被如下接口引用:ModifyApp。

名称 类型 必选 描述
RoleDescription String 是 角色描述
示例值:我是提示词信息

SearchAdvancedConfig

检索高级配置

被如下接口引用:SearchKnowledge。

名称 类型 必选 描述
FinalRerankConfig FinalRerankConfig 否

最终 rerank 配置


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

各知识库的检索配置

KnowledgeType Integer 否

检索知识类型:1=文档和问答,2=拒答

枚举项枚举值描述
SEARCH_KNOWLEDGE_TYPE_UNKNOWN0
SEARCH_KNOWLEDGE_TYPE_DOC_QA1文档和问答
SEARCH_KNOWLEDGE_TYPE_REJECTED_QUESTION2拒答


示例值:1
RecallCount Integer 否

最终返回结果数


示例值:13

SearchBilling

检索计费信息

被如下接口引用:SearchKnowledge。

名称 类型 必选 描述
BillingTagList Array of KVPair 否

计费标签列表

FinanceSubBusinessType String 否

计费子业务类型


示例值:SubBusinessType

SearchContext

检索请求上下文信息

被如下接口引用:SearchKnowledge。

名称 类型 必选 描述
CallSource Integer 否

请求来源

枚举项枚举值描述
CALL_SOURCE_UNSPECIFIED0
CALL_SOURCE_RAG1标准模式
CALL_SOURCE_WORKFLOW2工作流
CALL_SOURCE_PLUGIN3插件
CALL_SOURCE_OPENCLAW4openclaw
CALL_SOURCE_RECALL_TEST5召回测试
CALL_SOURCE_RECALL_TEST_DIFF6召回测试在对比的场景,同样需要触发检索接口。区别这种case前端不需要更新最新配置。因为对比1,2,3 可能最后保存的是2


示例值:5
Domain Integer 否

adp域:1=开发域,2=生产域

枚举项枚举值描述
ADP_DOMAIN_UNSPECIFIED0未指定
ADP_DOMAIN_DEV1开发域
ADP_DOMAIN_PROD2生产域


示例值:1
VisitorId String 否

访客 ID


示例值:2067622575842400832

SearchFilter

检索过滤

被如下接口引用:SearchKnowledge。

名称 类型 必选 描述
FilterType Integer 否

检索过滤类型

枚举项枚举值描述
SEARCH_FILTER_TYPE_UNKNOWN0
SEARCH_FILTER_TYPE_CUSTOMER_LABEL_VALUE1用户自定义标签值
SEARCH_FILTER_TYPE_CUSTOMER_LABEL_VALUE_ID2用户自定义标签值ID
SEARCH_FILTER_TYPE_DOC_ID3指定文档 ID 检索
SEARCH_FILTER_TYPE_DOC_CATEGORY_ID4指定文档分类 ID 检索
SEARCH_FILTER_TYPE_DB_TABLE_ID5指定数据库表 ID 检索
SEARCH_FILTER_TYPE_KB_SCHEMA_ID6指定知识库 schema ID


示例值:2
FilterValueList Array of String 否

过滤值列表,根据SearchFilterType取值1:传自定义标签值;2:传自定义标签值ID;3:传文档ID;4:传分类ID


示例值:["2067622575842400832"]
LabelId String 否

用户自定义标签 ID


示例值:2067622575842400832
LogicOp Integer 否

逻辑运算符:AND 或 OR

枚举项枚举值描述
LOGIC_OPR_NOOP0
LOGIC_OPR_AND1
LOGIC_OPR_OR2


示例值:1
SearchFilterList Array of SearchFilter 否

嵌套检索过滤

SearchFilterConfig

检索过滤配置

被如下接口引用:SearchKnowledge。

名称 类型 必选 描述
OnlyRetrievalSelectedLabel Boolean 否

是否仅检索选中标签,true:仅检索带有选中标签的知识,false:同时检索带有选中标签和不带任何标签的知识


示例值:true
SearchFilter SearchFilter 否

检索过滤


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

SearchInput

检索输入

被如下接口引用:SearchKnowledge。

名称 类型 必选 描述
ImageUrlList Array of String 否

图片 URL 列表


示例值:["http://test.image"]
Question String 否

问题


示例值:明天天气
SubQuestionList Array of String 否

拆解的子问题列表


示例值:["明天下雨吗"]

SearchResourceStatusInfo

搜索资源状态信息

被如下接口引用:DescribeApp。

名称 类型 必选 描述
ResourceStatus Integer 是 搜索资源状态: AVAILABLE(1)=资源可用, EXHAUSTED(2)=资源已用尽。枚举值: 1:资源可用, 2:资源已用尽
示例值:1

SearchResultPayload

检索结果负载

被如下接口引用:SearchKnowledge。

名称 类型 必选 描述
GraphData String 否

图谱附加信息(JSON 字符串)


示例值:数学
ImageUrlList Array of String 否

命中的图片 URL 列表


示例值:["http://test.com"]
SheetInfo String 否

表格附加信息(JSON 字符串)


示例值:[{}]

SimilarQuestion

QA 相似问

被如下接口引用:DescribeQA。

名称 类型 必选 描述
Content String 否

相似问内容


示例值:明天天气怎么样
IsAiGenerated Boolean 否

是否 AI 生成


示例值:true
SimilarQuestionId String 否

相似问 ID


示例值:2067622575842400832

SimilarQuestionExtra

相似问额外信息

被如下接口引用:SearchKnowledge。

名称 类型 必选 描述
Content String 否

相似问文本内容


示例值:问:奔驰e300都有什么颜色?
SimilarQuestionId String 否

相似问 ID


示例值:2097669080301892544

SimilarQuestionModifySpec

QA 相似问修改项

被如下接口引用:ModifyQA。

名称 类型 必选 描述
Content String 否

相似问内容(CREATE 与 UPDATE 必填)


示例值:有什么活动预告吗
ModifyAction Integer 否

操作类型:1=新增,2=修改,3=删除

枚举项枚举值描述
MODIFY_ACTION_UNKNOWN0
MODIFY_ACTION_CREATE1新增
MODIFY_ACTION_UPDATE2修改
MODIFY_ACTION_DELETE3删除


示例值:1
SimilarQuestionId String 否

相似问 ID(UPDATE 与 DELETE 必填)


示例值:2097978830645224896

SimilarQuestionStat

QA 相似问统计

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

名称 类型 必选 描述
SimilarQuestionCount Integer 否

相似问数量


示例值:1
SimilarQuestionTips String 否

相似问提示(展示一条相似问样例)


示例值:"智能"

SingleWorkflowConfig

单工作流配置

被如下接口引用:ModifyApp。

名称 类型 必选 描述
AsyncWorkflow Boolean 是

是否开启异步工作流


示例值:false
Status String 是

状态 发布状态(UNPUBLISHED: 待发布 PUBLISHING: 发布中 PUBLISHED: 已发布 PUBLISHED_FAIL:发布失败;DRAFT:待调试)


示例值:PUBLISHING
WorkflowDescription String 是

工作流描述


示例值:我的工作流信息
WorkflowId String 是

工作流Id


示例值:250b6*a-0436b0cc5717
WorkflowName String 是

工作流名称


示例值:我的工作流
Enabled Boolean 否

工作流是否启用


示例值:true

SkillAnalysisInfo

SkillAnalysisInfo Skill 安全扫描信息。

被如下接口引用:DescribeSkillDetail, DescribeSkillSummaryList。

名称 类型 必选 描述
AnalysisStatus Integer 是 安全检测状态

枚举值:
| uint | 描述 |
| --- | --- |
| 0 | 待检测 |
| 1 | 检测中 |
| 2 | 可用 |
| 3 | 不可用 |
| 4 | 检测失败 |
示例值:2
RiskDescription String 是 风险描述
示例值:风险**
RiskLevel Integer 是 风险等级

枚举值:
| uint | 描述 |
| --- | --- |
| 0 | 无风险 |
| 1 | 低风险 |
| 2 | 中风险 |
| 3 | 高风险 |
示例值:2
SecurityReportUrl String 是 安全报告跳转url;
示例值:https://tix.qq.com/search/skill?keyword=************35b2bf1e62e70d86170c

SkillCategory

SkillCategory Skill 分类信息。

被如下接口引用:DescribeSkillCategoryList。

名称 类型 必选 描述
CategoryKey String 是 分类标识
示例值:office_doc
CategoryName String 是 分类名称
示例值:通用办公

SkillClassification

SkillClassification Skill 分类与来源信息。

被如下接口引用:DescribeSkillSummaryList。

名称 类型 必选 描述
BillingType Integer 是 Skill 计费类型

枚举值:
| uint | 描述 |
| --- | --- |
| 0 | 免费 |
| 1 | 付费 |
示例值:0
BuiltinSource Integer 是 Skill 内置来源,仅在 create_type 为 SKILL_CREATE_TYPE_BUILTIN 时生效

枚举值:
| uint | 描述 |
| --- | --- |
| 0 | 占位 |
| 1 | ADP 专有 |
| 2 | 腾讯专有 |
| 3 | SkillHub |
| 99 | 其他 |
示例值:1
CategoryKey String 是 Skill 分类
示例值:ocr
CreateType Integer 是 Skill 创建方式

枚举值:
| uint | 描述 |
| --- | --- |
| 0 | 占位 |
| 1 | 文件上传 |
| 2 | 由企业级共享流程生成 |
| 3 | AIGC 生成 |
| 99 | 内置 Skill |
示例值:99
ProviderType Integer 是 Skill 提供方类型

枚举值:
| uint | 描述 |
| --- | --- |
| 0 | 占位 |
| 1 | 官方 |
| 2 | 第三方 |
| 3 | 自定义 |
| 4 | 自定义企业级共享 |
示例值:1
SourceLink String 是 Skill 来源链接
示例值:https://adp.***

SkillCorpShareConfig

Skill 企业共享配置。

被如下接口引用:CreateSkillShare, DescribeSkillSummaryList。

名称 类型 必选 描述
ShareScope Integer 否
枚举项枚举值描述
SHARE_SCOPE_TYPE_UNSPECIFIED0
SHARE_SCOPE_TYPE_ALL1
SHARE_SCOPE_TYPE_ACCOUNT2
SHARE_SCOPE_TYPE_SPACE3

枚举值:

  • 0: 未指定
  • 1: 全企业共享
  • 3: 按空间共享

示例值:3
ShareScopeList Array of Identity 否

共享范围信息,仅支持空间;StrId 为空间ID,Name 为空间名称

SkillDetail

skill详情

被如下接口引用:DescribeSkillDetail。

名称 类型 必选 描述
ReferenceSummaryList Array of SkillReferenceSummary 否 调用情况摘要
SkillSummary SkillSummary 否 Skill 摘要
VersionList Array of SkillVersion 否 版本列表

SkillNotice

Skill 异常通知。

被如下接口引用:DescribeSkillSummaryList。

名称 类型 必选 描述
Level Integer 否 通知级别

枚举值:
| uint | 描述 |
| --- | --- |
| 0 | 占位 |
| 1 | 成功,字符串面:"success" |
| 2 | 警告,字符串面:"warning" |
| 3 | 错误,字符串面:"error" |
示例值:3
NoticeContent String 否 文案(i18n 后字符串)
示例值:Skill「-tg-update*」最新版本发布失败,当前对外服务版本仍为上一已发布版本。
TriggerVersionId String 否 触发本通知的 Skill 版本ID
示例值:57cd8480-*-b27d-28b59aa59554
Type Integer 否 通知类型

枚举值:
| uint | 描述 |
| --- | --- |
| 0 | 占位 |
| 1 | 发布失败 |
| 2 | 共享审批被拒 |
示例值:1

SkillProfile

SkillProfile Skill 基础展示信息。

被如下接口引用:DescribeSkillSummaryList。

名称 类型 必选 描述
CreateTime String 是

创建时间(Unix秒)


示例值:1716825600
Creator String 是

创建者


示例值:智能体开发平台
Description String 是

Skill 描述


示例值:A skill for analyzing datasets, generating insights, and creating reports.
DisplayDescription String 是

Skill 展示描述


示例值:用于分析数据集、生成洞察并输出分析报告的 Skill。
DisplayName String 是

Skill 展示名称


示例值:数据分析助手
IconUrl String 是

Skill 图标


示例值:https://example.com/icons/data-analysis.png
Name String 是

Skill 名称


示例值:data_analysis_assistant
UpdateTime String 是

更新时间(Unix秒)


示例值:1716825600
SpaceId String 否

空间


示例值:default_space

SkillReferenceGroup

同一 SkillRefType 下的引用分组(含总数 + 引用详情列表)。 total_count 始终以未过滤的原始总量为准;reference_summary_list 受二次鉴权开关影响。

被如下接口引用:DescribeSkillReferenceList。

名称 类型 必选 描述
ReferenceSummaryList Array of SkillReferenceSummary 否

该类型下的引用详情列表

ReferenceType Integer 否
枚举项枚举值描述
SKILL_REF_UNKNOWN0占位
SKILL_REF_OPENCLAW1openclaw
SKILL_REF_AGENT2agent
SKILL_REF_CORP_ASSISTANT3企业助手

示例值:3
TotalCount Integer 否

该类型下的引用总数


示例值:1

SkillReferenceSummary

引用摘要(用于详情页展示,对应DB t_skill_reference)

被如下接口引用:DescribeSkillDetail, DescribeSkillReferenceList。

名称 类型 必选 描述
ReferenceId String 否

关联ID


示例值:206**04
ReferenceName String 否

关联名称


示例值:ClawPro 助手-**
ReferenceType Integer 否

关联类型

枚举值:
| uint | 描述 |
| --- | --- |
| 0 | 占位 |
| 1 | ClawPro |
| 2 | agent |


示例值:1
SpaceId String 否

空间ID


示例值:default_space
SpaceName String 否

空间名称


示例值:默认工作空间
Owner String 否

Reference实例拥有者


示例值:chan**.com

SkillShare

SkillShare Skill 企业共享信息。

被如下接口引用:DescribeSkillSummaryList。

名称 类型 必选 描述
ApprovalId String 是

审批ID


示例值:20621320***
ShareSkillId String 是

共享后关联的新 skill_id


示例值:c8c9668b-**-7c5f644f8a20_shared
ShareVersion String 是

共享版本,如 1.0.0


示例值:1.0.11
ShareVersionId String 是

共享版本ID


示例值:afebd117-*-a1f2-ab52264835c1
SkillId String 是

原 skill_id


示例值:c8c9668b-*-8af5-7c5f644f8a20
Status Integer 是

共享状态

枚举值:
| uint | 描述 |
| --- | --- |
| 0 | 未共享 |
| 1 | 已共享 |
| 2 | 审批中 |


示例值:2
CorpShareConfig SkillCorpShareConfig 否

企业共享范围

SkillSummary

SkillSummary 列表中的 Skill 摘要。

被如下接口引用:DescribeSkillDetail, DescribeSkillSummaryList。

名称 类型 必选 描述
ClassificationInfo SkillClassification 是 分类信息
注意:此字段可能返回 null,表示取不到有效值。
CurrentVersionInfo SkillVersion 是 当前版本信息
注意:此字段可能返回 null,表示取不到有效值。
IsFavorite Boolean 是 当前用户是否收藏
示例值:false
Profile SkillProfile 是 基础信息
注意:此字段可能返回 null,表示取不到有效值。
SkillId String 是 Skill ID
示例值:2d74f6c5-**-dfcd5cd1b7a6
NoticeList Array of SkillNotice 否 Skill 异常通知列表
PermissionIdList Array of String 否 当前用户对该 Skill 的资源操作权限位列表;内置/共享 Skill 固定为空数组
示例值:["adpSkillsCenterView"]
ShareList Array of SkillShare 否 共享信息;可能有两条,一条是已共享的,一条是审核中的
SkillStatus Integer 否 Skill状态

枚举值:
| uint | 描述 |
| --- | --- |
| 0 | 初始化(无任何已发布版本,且最新版本处于 INITIALIZED/UNRELEASED) |
| 1 | 安全检测中(无任何已发布版本,且最新版本处于 AUDITING) |
| 2 | 待发布(无任何已发布版本,且最新版本处于 PENDING_RELEASE) |
| 3 | 已发布(存在任一 RELEASED 版本,吸收态) |
示例值:2

SkillVersion

SkillVersion Skill 版本信息。

被如下接口引用:DescribeSkillDetail, DescribeSkillSummaryList。

名称 类型 必选 描述
AnalysisInfo SkillAnalysisInfo 是

检测信息


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

当前生效版本号


示例值:1.0.8
VersionId String 是

当前生效版本ID


示例值:25551ac3-**-1a829b1a6255
VersionStatus Integer 否

Skill 版本发布流程状态:

  - 0 INITIALIZED      初始化(版本初始态)  - 1 AUDITING         审核中(f_analysis_status ∈ {PENDING, RUNNING})  - 2 PENDING_RELEASE  待发布(低/中风险,等用户确认上架)  - 3 RELEASED         已发布  - 4 UNRELEASED       未发布(HIGH / UNAVAILABLE / FAILED / 用户放弃,含历史"不通过"语义)与 SkillAnalysisStatus 解耦:前者是用户视角发布生命周期,后者是安全检测阶段。

示例值:3
SkillMd5 String 否

Skill包的md5信息


示例值:6e33f50cb**1a3967ea3a857
SkillUrl String 否

版本包地址


示例值:https://a***/skill//***_*/****/*_package.zip
CreateTime String 否

版本创建时间(Unix秒)


示例值:1779884935
SkillMarkdownUrl String 否

skill md文档


示例值:https://****/**/***6**/SKILL.md
UpdateDesc String 否

版本变更说明


示例值:nano****
Updater String 否

变更用户


示例值:***@qq.com

Sort

排序条件

被如下接口引用:DescribeMsgRecordList。

名称 类型 必选 描述
Name String 是

排序字段名,如 create_time


示例值:create_time
Direction Integer 否

排序方向,1 升序,2 降序

枚举项枚举值描述
SORT_ORDER_INVALID0无效
SORT_ORDER_ASC1升序
SORT_ORDER_DESC2降序

示例值:1

Space

空间信息

被如下接口引用:DescribeSpaceList。

名称 类型 必选 描述
SpaceId String 否 空间id
示例值:default_space
Name String 否 空间名称
示例值:名称
Description String 否 空间描述
示例值:空间描述
PermissionIdList Array of String 否 空间权限
示例值:["adpSpace.ModifySpace"]

SpecialStatusInfo

特殊状态信息

被如下接口引用:DescribeApp。

名称 类型 必选 描述
Status Integer 是 状态 (0-不在特殊状态中, 1-在特殊状态中)。枚举值: 1:在特殊状态中
示例值:0

SummaryListSwitch

摘要列表查询通用开关配置

被如下接口引用:DescribeCategoryList, DescribeDocSummaryList, DescribeLabelSummaryList, DescribeQASummaryList。

名称 类型 必选 描述
ShowMetadataEnabled Boolean 否

是否显示元数据


示例值:true

SupportedFileType

支持的文件类型

被如下接口引用:ModifyApp。

名称 类型 必选 描述
Description String 是

描述信息


示例值:描述信息
FileExt String 是

文件类型(如 txt、pdf、jpg,建议用扩展名)


示例值:txt
MaxSizeBytes String 是

文件大小限制(单位:字节)


示例值:1000

SystemVariable

系统变量

被如下接口引用:DescribeSystemVariableList。

名称 类型 必选 描述
Description String 是 变量描述
示例值:会话ID(API调用请求参数中的session_id)
Name String 是 变量名称
示例值:SYS.SessionId

TableEnhancement

表格增强配置

被如下接口引用:SearchKnowledge。

名称 类型 必选 描述
Enabled Boolean 否

是否启用


示例值:true

TelegramChannelConfig

Telegram渠道配置

被如下接口引用:CreateChannel, DescribeChannel, DescribeChannelList, ModifyChannel。

名称 类型 必选 描述
BotToken String 否

Telegram Bot Token


示例值:1**12

ThinkModel

思考模型配置

被如下接口引用:ModifyApp。

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

TimeRange

查询时间范围(Unix 秒)

被如下接口引用:DescribeAppStatisticsOverview, DescribeConcurrencyLimitDetailList, DescribeConsumptionDetailList, DescribeMetricOverviewList, DescribeUsageDetailList, DescribeUsageSummaryList。

名称 类型 必选 描述
EndTime String 是

结束时间,Unix 秒


示例值:1786550699
StartTime String 是

开始时间,Unix 秒


示例值:1786550399

TimerPushConfig

TimerPushConfig

被如下接口引用:CreateAppTrigger, DescribeAppTrigger, ModifyAppTrigger。

名称 类型 必选 描述
PushChannel Integer 否

枚举值:
| uint | 描述 |
| --- | --- |
| 0 | |
| 1 | 不推送 |
| 2 | 微信公众号 |
| 3 | 企业微信 AI 机器人 |


示例值:2
PushTargetId String 否

推送会话ID


示例值:oxxxxxxx
PushTargetType Integer 否

枚举值:
| uint | 描述 |
| --- | --- |
| 0 | |
| 1 | 用户 (微信公众号 openid) |
| 2 | 群聊 (企微机器人 chat_id) |


示例值:1
PushWebhookUrl String 否

推送webhook的url


示例值:https://qyapi.weixin.qq.com/cgi-bin/webhook/send?key=446c1200-3738-4cdc-ac9e-01234578987

TimerScheduleConfig

TimerScheduleConfig

被如下接口引用:CreateAppTrigger, DescribeAppTrigger, ModifyAppTrigger。

名称 类型 必选 描述
Cron CronSchedule 否 cron配置
Daily DailySchedule 否 每日触发
Interval IntervalSchedule 否 固定间隔
ManualOnly ManualOnlySchedule 否 仅手动
Once OnceSchedule 否 单次
ScheduleType Integer 否
枚举值:
| uint | 描述 |
| --- | --- |
| 0 | |
| 1 | 仅手动 |
| 2 | 每天 |
| 3 | 每周 |
| 4 | 按间隔 |
| 5 | 一次性 |
| 6 | Cron |
示例值:1
Timezone String 否 时区
示例值:Asia/Shanghai
Weekly WeeklySchedule 否 每周固定时间触发

TokenUsage

Token 使用统计

被如下接口引用:SearchKnowledge。

名称 类型 必选 描述
CompletionTokens Integer 否

completion token 数


示例值:8
ModelName String 否

模型名称


示例值:Deepseek/deepseek-v4-flash
PromptTokens Integer 否

prompt token 数


示例值:6765
TotalTokens Integer 否

总 token 数


示例值:886

Tool

Tool

被如下接口引用:CreatePlugin, DescribePlugin, ModifyPlugin。

名称 类型 必选 描述
Billing ToolBilling 否

工具计费信息


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

工具调用次数

单位:次数


示例值:5
Description String 否

工具描述信息


示例值:获取指定日期和地点的天气信息
Name String 否

工具名称


示例值:GetWeatherInfo
PluginId String 否

插件ID


示例值:0960ae93-80a0-408d-928b-f484064f833h
ToolAccessMode Integer 否
枚举项枚举值描述
TOOL_ACCESS_MODE_UNKNOWN0未指定
TOOL_ACCESS_MODE_READ_ONLY1只读
TOOL_ACCESS_MODE_WRITE_DELETE2写/删除

示例值:0
ToolConfig ToolConfig 否

工具配置信息


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

工具ID


示例值:0960ae93-80a0-408d-928b-f484064f834a

ToolBilling

ToolBilling

被如下接口引用:CreatePlugin, ModifyPlugin。

名称 类型 必选 描述
BasicBilling BasicBilling 否

基础计费信息

BillingType Integer 否
枚举项枚举值描述
BILLING_TYPE_FREE0免费
BILLING_TYPE_LIMITED_FREE1限时免费
BILLING_TYPE_OFFICIAL_PAID2官方收费
BILLING_TYPE_OFFICIAL_PAID_OLD_FREE3官方收费(新/升级用户收费,存量老用户限时免费)

示例值:1
ComplexBilling ComplexBilling 否

复合类型计费信息

DuplexBilling DuplexBilling 否

双向计费信息

ToolConfig

ToolConfig

被如下接口引用:CreatePlugin, ModifyPlugin。

名称 类型 必选 描述
ApiToolConfig ApiToolConfig 否

API工具配置信息

AppToolConfig AppToolConfig 否

应用配置信息

CodeToolConfig CodeToolConfig 否

代码工具配置信息

MCPToolConfig MCPToolConfig 否

MCP工具配置信息

ToolExample

ToolExample

被如下接口引用:CreatePlugin, ModifyPlugin。

名称 类型 必选 描述
Request String 否

请求参数


示例值:{"input":"A"}
Response String 否

响应参数


示例值:{"result": "B"}

ToolSummary

工具信息

被如下接口引用:DescribePluginSummaryList。

名称 类型 必选 描述
ToolId String 否

工具Id


示例值:f5b3c7ed-c80c-4464-99be-d903d74591cf

TriggerConfig

TriggerConfig

被如下接口引用:CreateAppTrigger, DescribeAppTrigger, ModifyAppTrigger。

名称 类型 必选 描述
ScheduledConfig AppTriggerScheduleConfig 否

定时器配置

WebhookConfig AppTriggerWebhookConfig 否

Webhook配置

TriggerStatus

TriggerStatus

被如下接口引用:DescribeAppTrigger, DescribeAppTriggerSummaryList, ModifyAppTrigger。

名称 类型 必选 描述
ScheduledStatus AppTriggerScheduleStatus 否

定时器状态

Scope Integer 否
枚举项枚举值描述
APP_TRIGGER_SCOPE_UNSPECIFIED0未指定
APP_TRIGGER_SCOPE_APP1B 端管理员
APP_TRIGGER_SCOPE_USER2C 端访客

示例值:2
UserId String 否

访客id


示例值:cuiyongchao
WebhookStatus AppTriggerWebhookStatus 否

Webhook状态

UsageDetail

资源调用时序明细

被如下接口引用:DescribeUsageDetailList。

名称 类型 必选 描述
CallSource CallSource 否

调用来源

DosageId String 否

计量 ID,用于对账/回溯


示例值:dosage_9988776655
EventTime String 否

调用时间戳(Unix 秒)


示例值:1754956800
Model ModelUsageDetail 否

MODEL 域专属

Plugin PluginUsageDetail 否

PLUGIN 域专属

TraceId String 否

调用链路追踪 ID


示例值:trace_abc123def456
UserId String 否

用户 ID


示例值:user_001

UsageSummary

资源用量聚合明细

被如下接口引用:DescribeUsageSummaryList。

名称 类型 必选 描述
Model ModelUsageSummary 否

MODEL 域专属

Platform PlatformUsageSummary 否

PLATFORM 域专属

Plugin PluginUsageSummary 否

PLUGIN 域专属

SourceId String 否

来源 ID;CORP 视图=space_id(企业视图按 space 分组),SPACE 视图=app_id(uint64 字符串),APP 视图=app_id


示例值:space_abc123
SourceName String 否

来源名称;CORP 视图=space_name,SPACE 视图=app_name,APP 视图=app_name


示例值:产品研发空间
ViewType Integer 否

视图类型,决定 SourceId/SourceName 的业务含义

枚举项枚举值描述
VIEW_TYPE_UNSPECIFIED0未指定(无效值,请求勿传)
VIEW_TYPE_CORP1企业视图
VIEW_TYPE_SPACE2空间视图
VIEW_TYPE_APP3应用视图

示例值:1

UserAccessConfig

用户访问配置

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

名称 类型 必选 描述
CustomerKnowledgeId String 否

客户自定义知识 ID


示例值:cust-doc-abc-001
IsPublic Boolean 否

文档是否公开


示例值:true

UserAgentReference

用户+Agent归属引用

被如下接口引用:CreateChannel, DescribeChannel, DescribeChannelList, ModifyChannel。

名称 类型 必选 描述
AgentId String 否

claw agent 运行态标识


示例值:use**96b-a9217f611508
UserId String 否

归属用户标识


示例值:**bo

Variable

变量信息

被如下接口引用:CreateVariable, DescribeVariable, DescribeVariableList, ModifyVariable。

名称 类型 必选 描述
DefaultFileName String 是

默认文件名称


示例值:****
DefaultValue String 是

默认值


示例值:1
Description String 是

变量描述


示例值:我的环境变量
ModuleType Integer 是

变量模块类型

枚举值:

  • 0: API参数
  • 1: 环境参数
  • 2: 应用参数
  • 3: 系统参数

示例值:1
Name String 是

变量名称


示例值:myname1
Type Integer 是

变量类型

枚举值:

  • 0: 字符串
  • 1: 整数
  • 2: 浮点数
  • 3: 布尔值
  • 4: 对象
  • 5: 字符串数组
  • 6: 整数数组
  • 7: 浮点数数组
  • 8: 布尔值数组
  • 9: 对象数组
  • 10: 文件
  • 11: 文档
  • 12: 图片
  • 13: 音频
  • 14: 视频
  • 15: 文件数组
  • 16: 文档数组
  • 17: 图片数组
  • 18: 音频数组
  • 19: 视频数组
  • 20: 数组的数组
  • 21: 密钥

示例值:1
VariableId String 是

变量ID


示例值:e6b30407-81fd-4ca1-a153-1820d32a37b2
EnableEndpoints Boolean 否

是否启用网络策略(仅环境变量生效)


示例值:false
EndpointList Array of String 否

网络策略列表(支持: 精确域名、*.通配子域名、可带协议/端口/路径前缀)


示例值:["cloud.com"]
IsBuiltin Boolean 否

是否内置变量


示例值:false
EnableSandbox Boolean 否

是否可注入到沙箱环境


示例值:false

ViewScope

视图范围

被如下接口引用:DescribeAppStatisticsOverview, DescribeConcurrencyLimitDetailList, DescribeConsumptionDetailList, DescribeMetricOverviewList, DescribeUsageDetailList, DescribeUsageSummaryList。

名称 类型 必选 描述
ViewType Integer 是

视图类型;枚举值:VIEW_TYPE_CORP(1) 企业视图、VIEW_TYPE_SPACE(2) 空间视图、VIEW_TYPE_APP(3) 应用视图

枚举项枚举值描述
VIEW_TYPE_UNSPECIFIED0未指定(无效值,请求勿传)
VIEW_TYPE_CORP1企业视图
VIEW_TYPE_SPACE2空间视图
VIEW_TYPE_APP3应用视图

示例值:1
ScopeId String 否

视图范围 ID;VIEW_TYPE_CORP 留空;VIEW_TYPE_SPACE 填 space_id;VIEW_TYPE_APP 填 app_id(uint64 雪花 ID 的十进制字符串)


示例值:default_space

VoiceConfig

VoiceConfig

被如下接口引用:ModifyApp。

名称 类型 必选 描述
TimbreKey String 是 数智人音色key,需要和公有云音色id对齐
示例值:tts_female_55
VoiceName String 是 音色名称
示例值:智小柔-聊天女声
VoiceType Integer 是 公有云音色id
示例值:502001

WechatChannelConfig

微信公众号/小程序渠道配置

被如下接口引用:CreateChannel, DescribeChannel, DescribeChannelList, ModifyChannel。

名称 类型 必选 描述
QrcodeUrl String 否

授权二维码URL(创建后回填)


示例值:https://eeltime-test-1251316161.cos.ap-****gzhou.encentcos.9b*.pg?-ign-algoith=ha1&q-ak=KIDIqOlYFqIabLvWZaJv33todLwvM-*n-tie=784606077%3B2415326077-param-lst**-signature=34***a840a52da0bb509c2340980db95
WechatAppId String 否

公众号/小程序AppId(授权后回填)


示例值:wxe9*2
WechatRefreshToken String 否

公众号/小程序RefreshToken(授权后回填)


示例值:res****ndP-Wqso9FSO576beH0gA2IS4529**UIkz3e0

WechatClawBotChannelConfig

微信ClawBot渠道配置

被如下接口引用:CreateChannel, DescribeChannel, DescribeChannelList, ModifyChannel。

名称 类型 必选 描述
BotId String 否

ClawBot机器人ID(扫码后回填)


示例值:c**6f**ot
BotToken String 否

ClawBot机器人Token(扫码后回填)


示例值:12***
QrcodeStatus String 否

二维码状态(wait/confirmed/expired)


示例值:wait
QrcodeUrl String 否

二维码URL(创建后回填)


示例值:https://e***.qq.com/q/7Gi****de6bb**2d5c125229e41af631f6&*e=3
WechatUserId String 否

微信用户ID(扫码后回填)


示例值:o9*r2diI@im.wechat

WechatCustomerServiceChannelConfig

微信客服渠道配置

被如下接口引用:CreateChannel, DescribeChannel, DescribeChannelList, ModifyChannel。

名称 类型 必选 描述
AgentSecret String 否

企业微信应用Secret


示例值:UId**Z8_eBaogaaacwyk1v-XADI
Avatar String 否

头像URL


示例值:https://*picaz/**_2mKS32R9z1***58730024/0
Callback CallbackConfig 否

回调配置

CustomerServiceId String 否

客服账号ID


示例值:wkN*aMsTAC_A
Name String 否

客服账号名称


示例值:*-
ShareCodeUrl String 否

客服形象二维码URL


示例值:htt-458***in-aorithm=sh1&q-ak=AKIDIOlYF*fbLvJWZaJ33todLwQkvvkM&q-sig**=17735697%3B241*178**7%2414567&q-hear-list=&q-u***ramlist=&q-signature=15245f305f0dc22927396e52caff0a31a2c913*
WecomCorpId String 否

企业微信企业ID


示例值:ww****ef71

WecomAppChannelConfig

企微应用渠道配置

被如下接口引用:CreateChannel, DescribeChannel, DescribeChannelList, ModifyChannel。

名称 类型 必选 描述
Callback CallbackConfig 否

回调配置

ThirdChannelCorpId String 否

第三方企业ID


示例值:h***e**d
ThirdChannelId String 否

第三方渠道ID


示例值:r**d
WecomAgentId String 否

企微应用ID


示例值:1****22
WecomAgentSecret String 否

企微应用Secret


示例值:x3***N**THYUlkbMV1kr-iEWY8I
WecomCorpId String 否

企业ID


示例值:ww****7***4a16

WecomRobotCallbackAccess

企微机器人回调接入配置

被如下接口引用:CreateChannel, DescribeChannel, DescribeChannelList, ModifyChannel。

名称 类型 必选 描述
Callback CallbackConfig 否

回调配置

RobotName String 否

机器人名称


示例值:t****t
WecomCorpId String 否

企微企业ID


示例值:w***dc
WecomRobotId String 否

企微机器人ID


示例值:ai**IV2lOjCcAIo

WecomRobotChannelConfig

企微机器人渠道配置

被如下接口引用:CreateChannel, DescribeChannel, DescribeChannelList, ModifyChannel。

名称 类型 必选 描述
Callback WecomRobotCallbackAccess 否

回调接入配置


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

WebSocket长连接配置


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

WecomRobotWebsocketAccess

企微机器人WebSocket接入配置

被如下接口引用:CreateChannel, DescribeChannel, DescribeChannelList, ModifyChannel。

名称 类型 必选 描述
BindType Integer 否

绑定类型:1-扫码绑定,2-填写表单绑定


示例值:1
BotId String 否

企微机器人BotId


示例值:aib***fxzxWjrB9
BotSecret String 否

企微机器人BotSecret


示例值:eq****qMAyYJwQhISGohK7VxMO8

WeeklySchedule

WeeklySchedule

被如下接口引用:CreateAppTrigger, DescribeAppTrigger, ModifyAppTrigger。

名称 类型 必选 描述
Times Array of WeeklyTime 否 定时配置(星期)

WeeklyTime

WeeklyTime

被如下接口引用:CreateAppTrigger, DescribeAppTrigger, ModifyAppTrigger。

名称 类型 必选 描述
TimeOfDay String 否 时间
示例值:09:00
Weekday Integer 否 周几
示例值:1