/** * DeleteSkillShare请求参数结构体 */ export interface DeleteSkillShareRequest { /** *
申请备注,必填(弹窗"申请备注")
*/ ApplyRemark: string; /** *原 Skill ID,必填(前端无须感知 _shared 后缀)
*/ SkillId: string; /** *空间ID,必填
*/ SpaceId: string; /** *原版本 ID,必填(与 CreateSkillShare 上架时传的同一 version_id)
*/ VersionId: string; } /** * ToolConfig */ export interface ToolConfig { /** *API工具配置信息
*/ ApiToolConfig?: ApiToolConfig; /** *应用配置信息
*/ AppToolConfig?: AppToolConfig; /** *代码工具配置信息
*/ CodeToolConfig?: CodeToolConfig; /** *MCP工具配置信息
*/ MCPToolConfig?: MCPToolConfig; } /** * SkillClassification Skill 分类与来源信息。 */ export interface SkillClassification { /** * Skill 计费类型 枚举值: | uint | 描述 | | --- | --- | | 0 | 免费 | | 1 | 付费 | */ BillingType: number; /** * Skill 内置来源,仅在 create_type 为 SKILL_CREATE_TYPE_BUILTIN 时生效 枚举值: | uint | 描述 | | --- | --- | | 0 | 占位 | | 1 | ADP 专有 | | 2 | 腾讯专有 | | 3 | SkillHub | | 99 | 其他 | */ BuiltinSource: number; /** * Skill 分类 */ CategoryKey: string; /** * Skill 创建方式 枚举值: | uint | 描述 | | --- | --- | | 0 | 占位 | | 1 | 文件上传 | | 2 | 由企业级共享流程生成 | | 3 | AIGC 生成 | | 99 | 内置 Skill | */ CreateType: number; /** * Skill 提供方类型 枚举值: | uint | 描述 | | --- | --- | | 0 | 占位 | | 1 | 官方 | | 2 | 第三方 | | 3 | 自定义 | | 4 | 自定义企业级共享 | */ ProviderType: number; /** * Skill 来源链接 */ SourceLink: string; } /** * 检索输入 */ export interface SearchInput { /** *图片 URL 列表
*/ ImageUrlList?: Array问题
*/ Question?: string; /** *拆解的子问题列表
*/ SubQuestionList?: Array最大推理轮数
*/ MaxReasoningRound?: number; } /** * 最终 rerank 配置 */ export interface FinalRerankConfig { /** *模型名称
*/ ModelName?: string; } /** * PluginStatistics */ export interface PluginStatistics { /** * 插件调用量 */ CallCount?: number; /** * 工具数量 */ ToolCount?: number; } /** * 计费增值包用量信息 */ export interface AddOnPackageInfo { /** *增值包总量
*/ AddOnTotal?: number; /** *增值包用量
*/ AddOnUsage?: number; /** *专属并发总数
*/ ExclusiveConcurrency?: number; /** *资源包状态
枚举值:
专属并发状态
枚举值:
专属tpm
*/ ExclusiveTpm?: number; /** *专属tpm状态
枚举值:
专属计算单元
*/ ExclusiveComputeUnit?: number; /** *专属计算单元状态
枚举值:
模型列表
*/ ModelList?: Array模型总数
*/ TotalCount?: number; /** * 唯一请求 ID,由服务端生成,每次请求都会返回(若请求因其他原因未能抵达服务端,则该次请求不会获得 RequestId)。定位问题时需要提供该次请求的 RequestId。 */ RequestId?: string; } /** * 模型配置 */ export interface AppModelConfig { /** * AI一键优化模型 注意:此字段可能返回 null,表示取不到有效值。 */ AiOptimizeModel: AIOptimizeModel; /** * 实时文件解析模型 注意:此字段可能返回 null,表示取不到有效值。 */ FileParseModel: FileParseModel; /** * 生成模型配置 注意:此字段可能返回 null,表示取不到有效值。 */ GenerateModel: GenerateModel; /** * 多模态问答模型 注意:此字段可能返回 null,表示取不到有效值。 */ MultiModalQaModel: MultiModalQAModel; /** * 多模态理解模型 注意:此字段可能返回 null,表示取不到有效值。 */ MultiModalUnderstandingModel: MultiModalUnderstandingModel; /** * Prompt改写模型 注意:此字段可能返回 null,表示取不到有效值。 */ PromptRewriteModel: PromptRewriteModel; /** * 思考模型配置 注意:此字段可能返回 null,表示取不到有效值。 */ ThinkModel: ThinkModel; } /** * 插件详情 */ export interface Plugin { /** * 插件配置 注意:此字段可能返回 null,表示取不到有效值。 */ Config?: PluginConfig; /** * 创建时间,unix时间戳 */ CreateTime?: string; /** * 插件运营管理信息 注意:此字段可能返回 null,表示取不到有效值。 */ Operation?: PluginOperation; /** * 插件id */ PluginId?: string; /** * 插件版本号 */ PluginVersion?: number; /** * 插件基础信息 注意:此字段可能返回 null,表示取不到有效值。 */ Profile?: PluginProfile; /** * 插件统计信息 注意:此字段可能返回 null,表示取不到有效值。 */ Statistics?: PluginStatistics; /** *插件状态,1:可用,2:不可用
枚举值:
参数位置
枚举值:
参数名称
*/ Name?: string; /** *参数取值来源
*/ Input?: AgentInput; } /** * DescribeConversation请求参数结构体 */ export interface DescribeConversationRequest { /** *会话 ID
*/ ConversationId: string; /** *会话类型 枚举值: 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(分享链接)
*/ Type: number; /** *Type=CONVERSATION_TYPE_API 时必填,应用密钥
*/ AppKey?: string; /** *主用户Uin
*/ LoginSubAccountUin?: string; /** *子用户Uin
*/ LoginUin?: string; /** *Type=CONVERSATION_TYPE_SHARE 时必填,分享码
*/ ShareCode?: string; /** *Type=CONVERSATION_TYPE_API 时必填,访客ID
*/ UserId?: string; } /** * Conversation 会话信息 */ export interface Conversation { /** *应用 ID
*/ AppId: string; /** *会话 ID
*/ ConversationId: string; /** *创建时间
*/ CreateTime: string; /** *会话类型 枚举值: 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(分享链接)
*/ Type: number; /** *更新时间
*/ UpdateTime: string; /** *会话标题
*/ Title?: string; /** *会话使用的用户端 AgentId
*/ AgentId?: string; } /** * 插件授权配置 */ export interface AuthConfig { /** *授权方式。
枚举值:
API Key授权配置
注意:此字段可能返回 null,表示取不到有效值。 */ ApiKeyAuthConfig?: ApiKeyAuthConfig; /** *CAM授权配置
注意:此字段可能返回 null,表示取不到有效值。 */ CamAuthConfig?: CamAuthConfig; /** *OAuth2.0授权配置
注意:此字段可能返回 null,表示取不到有效值。 */ OAuthConfig?: OAuthConfig; /** *AccessKey授权配置
*/ AccessKeyAuthConfig?: AccessKeyAuthConfig; } /** * AppShareAccessControl */ export interface AppShareAccessControl { /** *| 枚举项 | 枚举值 | 描述 |
| APP_SHARE_ACCESS_TYPE_UNSPECIFIED | 0 | |
| APP_SHARE_ACCESS_TYPE_PUBLIC | 1 | 公开访问(所有用户都可访问) |
| APP_SHARE_ACCESS_TYPE_INTERNAL | 2 | 内部访问(仅企业用户可访问) |
| APP_SHARE_ACCESS_TYPE_ACCOUNT_WHITELIST | 3 | 账号白名单(指定UIN/手机/邮箱/IP可访问) |
是否开启访问控制
枚举值:
白名单信息
*/ Whitelist?: Array是否可新增
*/ CanAdd?: boolean; /** *是否可删除
*/ CanDelete?: boolean; /** *是否可编辑
*/ CanEdit?: boolean; /** *分类 ID
*/ CategoryId?: string; /** *子分类列表
*/ ChildList?: Array是否为叶子节点(无子分类)
*/ IsLeaf?: boolean; /** *分类对象的数量
*/ ItemCount?: number; /** *元数据配置(该分类被设置为元数据时的配置信息)
注意:此字段可能返回 null,表示取不到有效值。 */ MetaValue?: MetaValue; /** *分类名称
*/ Name?: string; } /** * 对话端自定义配置(所有模式共用,允许对话中动态修改配置) */ export interface DialogCustomConfig { /** *是否开启对话端动态修改配置
*/ Enabled?: boolean; } /** * DescribeMetricOverviewList返回参数结构体 */ export interface DescribeMetricOverviewListResponse { /** *所有域 Overview 统一出参:KPI 卡片列表,key 字符串标识指标,客户端按 resource_type 解析;key 白名单参考 platform.common.v2.MetricOverview 注释
*/ MetricList?: Array总记录数,等于 MetricList 长度,仅为列表接口一致性预留
*/ TotalCount?: string; /** * 唯一请求 ID,由服务端生成,每次请求都会返回(若请求因其他原因未能抵达服务端,则该次请求不会获得 RequestId)。定位问题时需要提供该次请求的 RequestId。 */ RequestId?: string; } /** * DescribeAppSummaryList请求参数结构体 */ export interface DescribeAppSummaryListRequest { /** * 空间ID(必填) */ SpaceId: string; /** * 过滤条件(多个Filter之间为AND关系,同一Filter的多个Values为OR关系): - AppStatus: 应用状态,枚举值,精确匹配(APP_STATUS_OFFLINE=1/APP_STATUS_RUNNING=2/APP_STATUS_DISABLED=3) - AppMode: 应用模式,枚举值,精确匹配(APP_MODE_STANDARD=1/APP_MODE_AGENT=2/APP_MODE_SINGLE_WORKFLOW=3/APP_MODE_CLAW_AGENT=4) */ FilterList?: ArrayPrompt配置
*/ PromptConfig?: AppTriggerPromptExecuteConfig; /** *工作流配置
*/ WorkflowConfig?: AppTriggerWorkflowExecuteConfig; } /** * CreateLabel返回参数结构体 */ export interface CreateLabelResponse { /** *标签 ID
*/ LabelId?: string; /** *标签值(标准词 + 同义词列表,含后台生成的 term_id)
*/ TermList?: ArrayTelegram Bot Token
*/ BotToken?: string; } /** * TriggerConfig */ export interface TriggerConfig { /** *定时器配置
*/ ScheduledConfig?: AppTriggerScheduleConfig; /** *Webhook配置
*/ WebhookConfig?: AppTriggerWebhookConfig; } /** * DescribeModelList请求参数结构体 */ export interface DescribeModelListRequest { /** *模型场景。0-不区分场景, 1-标准生成, 2-标准思考, 3-Agent思考, 4-多模态理解, 5-多模态问答, 6-改写, 7-长期记忆, 8-自然语言转SQL, 9-AI优化, 10-实时文件解析, 11-文件解析, 12-GraphRAG, 13-OpenClaw, 14-多模态Embedding, 15-Rerank, 16-文本Embedding, 17-Widget, 18-Claw模式, 19-工作流代码生成, 20-工作流大模型节点, 21-工作流节点专用向量化, 22-工作流参数提取, 23-工作流大模型知识问答, 24-工作流标签提取, 25-工作流意图识别, 26-工作流选项卡, 27-工作流逻辑判断, 28-文档生成问答, 29-知识库Schema
枚举值:
空间ID
*/ SpaceId?: string; /** *关键词模糊搜索
*/ Query?: string; /** *页码。从0开始
*/ PageNumber?: number; /** *每页数量,默认20,最大100
*/ PageSize?: number; /** *过滤条件(多个 Filter 之间为 AND, 同一 Filter 多 Values 为 OR)
DeveloperName: 模型作者名称
ProviderName: 模型提供商名称
ProviderType:模型提供商类型
消息记录分类树列表
*/ CategoryList?: Array标签列表
*/ LabelList?: Array总数
*/ TotalCount?: number; /** * 唯一请求 ID,由服务端生成,每次请求都会返回(若请求因其他原因未能抵达服务端,则该次请求不会获得 RequestId)。定位问题时需要提供该次请求的 RequestId。 */ RequestId?: string; } /** * DescribeDoc返回参数结构体 */ export interface DescribeDocResponse { /** *文档链接(外部链接 + COS 链接)
注意:此字段可能返回 null,表示取不到有效值。 */ DocLink?: DocLink; /** *解析配置(分割规则、内容过滤等)
注意:此字段可能返回 null,表示取不到有效值。 */ ParseConfig?: DocParseConfig; /** *文档基础信息
注意:此字段可能返回 null,表示取不到有效值。 */ Summary?: DocSummary; /** *开关配置
注意:此字段可能返回 null,表示取不到有效值。 */ Switch?: DocSwitch; /** *更新周期配置
注意:此字段可能返回 null,表示取不到有效值。 */ UpdatePeriod?: DocUpdatePeriod; /** *用户访问配置
注意:此字段可能返回 null,表示取不到有效值。 */ UserAccessConfig?: UserAccessConfig; /** * 唯一请求 ID,由服务端生成,每次请求都会返回(若请求因其他原因未能抵达服务端,则该次请求不会获得 RequestId)。定位问题时需要提供该次请求的 RequestId。 */ RequestId?: string; } /** * API插件配置 */ export interface ApiPluginConfig { /** * 授权配置信息 注意:此字段可能返回 null,表示取不到有效值。 */ AuthConfig?: AuthConfig; } /** * 申诉中的配置 - 记录各配置项是否在申诉中 */ export interface AppealingStatus { /** * 头像是否在申诉中 */ AvatarInAppeal: boolean; /** * 兜底回复语是否在申诉中 */ FallbackReplyInAppeal: boolean; /** * 欢迎语是否在申诉中 */ GreetingInAppeal: boolean; /** * 应用名称是否在申诉中 */ NameInAppeal: boolean; /** * 角色描述是否在申诉中 */ RoleInAppeal: boolean; } /** * DescribeVariable返回参数结构体 */ export interface DescribeVariableResponse { /** * 变量信息 */ Variable?: Variable; /** * 唯一请求 ID,由服务端生成,每次请求都会返回(若请求因其他原因未能抵达服务端,则该次请求不会获得 RequestId)。定位问题时需要提供该次请求的 RequestId。 */ RequestId?: string; } /** * CreateLabel请求参数结构体 */ export interface CreateLabelRequest { /** *所属知识库 ID
*/ KbId: string; /** *标签名称(长度不小于 1 个字符)
*/ Name: string; /** *标签值(标准词 + 同义词列表),其中 term_id 由后台生成、创建时留空
*/ TermList?: Array代码
*/ Code?: string; /** *示例
*/ Example?: ToolExample; /** *输入参数
*/ Inputs?: Array输出参数
*/ Outputs?: Array| 枚举项 | 枚举值 | 描述 |
| SHARE_SCOPE_TYPE_UNSPECIFIED | 0 | |
| SHARE_SCOPE_TYPE_ALL | 1 | |
| SHARE_SCOPE_TYPE_ACCOUNT | 2 | |
| SHARE_SCOPE_TYPE_SPACE | 3 |
枚举值:
共享范围信息,仅支持空间;StrId 为空间ID,Name 为空间名称
*/ ShareScopeList?: Array应用 ID
*/ AppId: string; /** *页码,从 0 开始;不传时按 0 处理
*/ PageNumber?: number; /** *每页数量,最大 100;不传或传 0 时按默认分页大小处理
*/ PageSize?: number; /** *排序条件,只支持按 CreateTime 排序
*/ Sort?: Sort; } /** * WeeklyTime */ export interface WeeklyTime { /** * 时间 */ TimeOfDay?: string; /** * 周几 */ Weekday?: number; } /** * 资源用量聚合明细 */ export interface UsageSummary { /** *MODEL 域专属
*/ Model?: ModelUsageSummary; /** *PLATFORM 域专属
*/ Platform?: PlatformUsageSummary; /** *PLUGIN 域专属
*/ Plugin?: PluginUsageSummary; /** *来源 ID;CORP 视图=space_id(企业视图按 space 分组),SPACE 视图=app_id(uint64 字符串),APP 视图=app_id
*/ SourceId?: string; /** *来源名称;CORP 视图=space_name,SPACE 视图=app_name,APP 视图=app_name
*/ SourceName?: string; /** *视图类型,决定 SourceId/SourceName 的业务含义
| 枚举项 | 枚举值 | 描述 |
| VIEW_TYPE_UNSPECIFIED | 0 | 未指定(无效值,请求勿传) |
| VIEW_TYPE_CORP | 1 | 企业视图 |
| VIEW_TYPE_SPACE | 2 | 空间视图 |
| VIEW_TYPE_APP | 3 | 应用视图 |
关联ID
*/ ReferenceId?: string; /** *关联名称
*/ ReferenceName?: string; /** *关联类型
枚举值:
| uint | 描述 |
| --- | --- |
| 0 | 占位 |
| 1 | ClawPro |
| 2 | agent |
空间ID
*/ SpaceId?: string; /** *空间名称
*/ SpaceName?: string; /** *Reference实例拥有者
*/ Owner?: string; } /** * BillingAttribute */ export interface BillingAttribute { /** *属性名称
*/ Name?: string; /** *属性值
*/ Value?: string; } /** * DescribeConcurrencyLimitDetailList返回参数结构体 */ export interface DescribeConcurrencyLimitDetailListResponse { /** *并发超限明细列表
*/ ConcurrencyLimitDetailList?: Array总记录数,用于前端分页
*/ TotalCount?: string; /** * 唯一请求 ID,由服务端生成,每次请求都会返回(若请求因其他原因未能抵达服务端,则该次请求不会获得 RequestId)。定位问题时需要提供该次请求的 RequestId。 */ RequestId?: string; } /** * DescribeChannel请求参数结构体 */ export interface DescribeChannelRequest { /** *应用业务ID
*/ AppId: string; /** *渠道业务ID
*/ ChannelId: string; /** *渠道场景:0-B端场景,1-C端场景
*/ Scene?: number; } /** * Agent 可编辑配置 */ export interface AgentSpec { /** *Agent基本配置
*/ Profile?: AgentProfile; /** *系统提示词
*/ Instructions?: string; /** *主模型配置
*/ Model?: AgentModelConfig; /** *工具信息
*/ ToolList?: Array插件信息
*/ PluginList?: Array技能信息
*/ SkillList?: Array高级设置
*/ AdvancedConfig?: AgentAdvancedConfig; /** *调用方执行的 Function Tool 列表
入参限制:仅在 C 端用户态 Agent 场景可用,B 端配置态 Agent 忽略该字段与
*/ ExternalToolList?: Array该回复方式的调用次数
*/ CallCount?: string; /** *该回复方式在总调用次数中的占比(百分比,0~100,保留两位小数;无数据时全为 0,有数据时各项之和为 100)
*/ Percentage?: number; /** *回复方式名称(已按请求语言国际化;i18n 缺失时兜底为 reply_method 的枚举名)
*/ ReplyName?: string; } /** * CreatePlugin请求参数结构体 */ export interface CreatePluginRequest { /** *插件基础资料
*/ Profile: PluginProfile; /** *插件类型配置
*/ Config: PluginConfig; /** *当前空间id
*/ SpaceId: string; /** *插件的工具列表
*/ ToolList?: Array登录用户主账号(集成商模式必填)
*/ LoginUin?: string; /** *登录用户子账号(集成商模式必填)
*/ LoginSubAccountUin?: string; } /** * 思考模型配置 */ export interface ThinkModel { /** * 思考模型 注意:此字段可能返回 null,表示取不到有效值。 */ Model: ModelDetailInfo; } /** * DeleteAgent返回参数结构体 */ export interface DeleteAgentResponse { /** * 唯一请求 ID,由服务端生成,每次请求都会返回(若请求因其他原因未能抵达服务端,则该次请求不会获得 RequestId)。定位问题时需要提供该次请求的 RequestId。 */ RequestId?: string; } /** * ModifyConversation返回参数结构体 */ export interface ModifyConversationResponse { /** * 唯一请求 ID,由服务端生成,每次请求都会返回(若请求因其他原因未能抵达服务端,则该次请求不会获得 RequestId)。定位问题时需要提供该次请求的 RequestId。 */ RequestId?: string; } /** * RetryRelease请求参数结构体 */ export interface RetryReleaseRequest { /** * 应用ID */ AppId: string; /** * 发布任务ID */ ReleaseId: string; } /** * 应用配置 - 用户可修改的所有配置 */ export interface AppConfig { /** * 体验配置 注意:此字段可能返回 null,表示取不到有效值。 */ Experience: AppExperienceConfig; /** * 欢迎语配置 注意:此字段可能返回 null,表示取不到有效值。 */ Greeting: AppGreetingConfig; /** * 记忆配置 注意:此字段可能返回 null,表示取不到有效值。 */ Memory: AppMemoryConfig; /** * 模式相关配置 注意:此字段可能返回 null,表示取不到有效值。 */ Mode: AppModeConfig; /** * 模型配置 注意:此字段可能返回 null,表示取不到有效值。 */ Model: AppModelConfig; /** * 联网搜索配置 注意:此字段可能返回 null,表示取不到有效值。 */ WebSearch: AppWebSearchConfig; /** * 工作流配置 注意:此字段可能返回 null,表示取不到有效值。 */ Workflow: AppWorkflowConfig; } /** * 应用辅助信息 - 包含各类辅助状态和扩展信息(用户不可修改) */ export interface AppAuxiliaryInfo { /** * 申诉信息 注意:此字段可能返回 null,表示取不到有效值。 */ Appeal: AppAppeal; /** * 搜索资源状态 注意:此字段可能返回 null,表示取不到有效值。 */ SearchResourceStatus: SearchResourceStatusInfo; /** * 特殊状态信息 注意:此字段可能返回 null,表示取不到有效值。 */ SpecialStatusInfo: SpecialStatusInfo; /** * 子状态信息 注意:此字段可能返回 null,表示取不到有效值。 */ SubStatus: AppSubStatusInfo; } /** * ModifyLabel返回参数结构体 */ export interface ModifyLabelResponse { /** *修改后的标签值(标准词 + 同义词列表)
*/ TermList?: Array会话类型 枚举值: 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(分享链接)
*/ Type: number; /** *应用 ID
*/ AppId?: string; /** *Type=CONVERSATION_TYPE_API 时必填,应用密钥
*/ AppKey?: string; /** *登录用户子账号(集成商模式必填)
*/ LoginSubAccountUin?: string; /** *登录用户主账号(集成商模式必填)
*/ LoginUin?: string; /** *Type=CONVERSATION_TYPE_SHARE 时必填,分享码
*/ ShareCode?: string; /** *Type=CONVERSATION_TYPE_API 时必填,访客ID
*/ UserId?: string; /** * 会话ID */ ConversationId?: string; /** * 会话标题 */ Title?: string; } /** * CreateChannel返回参数结构体 */ export interface CreateChannelResponse { /** *渠道ID
*/ ChannelId?: string; /** *二维码URL(扫码类渠道创建后回填,其他场景为空)
*/ QrcodeUrl?: string; /** * 唯一请求 ID,由服务端生成,每次请求都会返回(若请求因其他原因未能抵达服务端,则该次请求不会获得 RequestId)。定位问题时需要提供该次请求的 RequestId。 */ RequestId?: string; } /** * 意图达成信息 */ export interface IntentAchievementInfo { /** * 描述 */ Description: string; /** * 名称 */ Name: string; } /** * DeleteCategory返回参数结构体 */ export interface DeleteCategoryResponse { /** * 唯一请求 ID,由服务端生成,每次请求都会返回(若请求因其他原因未能抵达服务端,则该次请求不会获得 RequestId)。定位问题时需要提供该次请求的 RequestId。 */ RequestId?: string; } /** * 检索结果负载 */ export interface SearchResultPayload { /** *图谱附加信息(JSON 字符串)
*/ GraphData?: string; /** *命中的图片 URL 列表
*/ ImageUrlList?: Array表格附加信息(JSON 字符串)
*/ SheetInfo?: string; } /** * DescribeUsageDetailList返回参数结构体 */ export interface DescribeUsageDetailListResponse { /** *总记录数,用于前端分页
*/ TotalCount?: string; /** *资源调用时序明细列表
*/ UsageDetailList?: Array应用触发器信息
*/ Trigger?: AppTrigger; /** * 唯一请求 ID,由服务端生成,每次请求都会返回(若请求因其他原因未能抵达服务端,则该次请求不会获得 RequestId)。定位问题时需要提供该次请求的 RequestId。 */ RequestId?: string; } /** * ModifyVariable返回参数结构体 */ export interface ModifyVariableResponse { /** * 唯一请求 ID,由服务端生成,每次请求都会返回(若请求因其他原因未能抵达服务端,则该次请求不会获得 RequestId)。定位问题时需要提供该次请求的 RequestId。 */ RequestId?: string; } /** * DescribeKBSummaryList请求参数结构体 */ export interface DescribeKBSummaryListRequest { /** *工作空间 ID
*/ SpaceId: string; /** *通用过滤
*/ FilterList?: Array分页页码,从 0 开始
*/ PageNumber?: number; /** *每页数量,默认 10,最大 100
*/ PageSize?: number; /** *关键词
*/ Query?: string; } /** * Agent 技能入参 */ export interface AgentSkillConfig { /** *技能ID
*/ SkillId?: string; } /** * ModifyAgent请求参数结构体 */ export interface ModifyAgentRequest { /** *应用Id
*/ AppId?: string; /** *Agent Id
*/ AgentId?: string; /** *修改后的Agent的信息
*/ Agent?: AgentSpec; /** *需要更新的字段路径,如 ["Profile.Name", "Profile.IconUrl", "Instructions", "Model", "ToolList", "PluginList", "SkillList", "AdvancedConfig"]
*/ UpdateMask?: FieldMask; } /** * PluginOperation */ export interface PluginOperation { /** * 是否允许外部调用 */ AllowExternalAccess?: boolean; /** *计费类型。
枚举值:
Agent名称
*/ Name?: string; /** *图标URL
*/ IconUrl?: string; /** *Agent 角色:0=主 / 1=子
*/ Role?: number; /** *Agent 描述
*/ Description?: string; /** *应用名称
*/ AppName?: string; /** *开发者
*/ Developer?: string; /** *主AgentId,只读,不可通过修改接口进行变更
*/ ParentAgentId?: string; } /** * 检索高级配置 */ export interface SearchAdvancedConfig { /** *最终 rerank 配置
注意:此字段可能返回 null,表示取不到有效值。 */ FinalRerankConfig?: FinalRerankConfig; /** *各知识库的检索配置
*/ KbRetrievalList?: Array检索知识类型:1=文档和问答,2=拒答
| 枚举项 | 枚举值 | 描述 |
| SEARCH_KNOWLEDGE_TYPE_UNKNOWN | 0 | |
| SEARCH_KNOWLEDGE_TYPE_DOC_QA | 1 | 文档和问答 |
| SEARCH_KNOWLEDGE_TYPE_REJECTED_QUESTION | 2 | 拒答 |
最终返回结果数
*/ RecallCount?: number; } /** * 知识生效范围 */ export interface KnowledgeScope { /** *生效作用域
| 枚举项 | 枚举值 | 描述 |
| KNOWLEDGE_EFFECTIVE_DOMAIN_UNKNOWN | 0 | |
| KNOWLEDGE_EFFECTIVE_DOMAIN_NONE | 1 | 停用 |
| KNOWLEDGE_EFFECTIVE_DOMAIN_DEV | 2 | 仅开发域 |
| KNOWLEDGE_EFFECTIVE_DOMAIN_RELEASE | 3 | 仅发布域 |
| KNOWLEDGE_EFFECTIVE_DOMAIN_ALL | 4 | 全域 |
适用范围(标签条件)
*/ LabelRefList?: Array授权二维码URL(创建后回填)
*/ QrcodeUrl?: string; /** *公众号/小程序AppId(授权后回填)
*/ WechatAppId?: string; /** *公众号/小程序RefreshToken(授权后回填)
*/ WechatRefreshToken?: string; } /** * RunAppTriggerNow请求参数结构体 */ export interface RunAppTriggerNowRequest { /** *应用ID
*/ AppId?: string; /** *| 枚举项 | 枚举值 | 描述 |
| APP_TRIGGER_SCOPE_UNSPECIFIED | 0 | 未指定 |
| APP_TRIGGER_SCOPE_APP | 1 | B 端管理员 |
| APP_TRIGGER_SCOPE_USER | 2 | C 端访客 |
应用触发器ID
*/ TriggerId?: string; /** *访客ID
*/ UserId?: string; } /** * AppTriggerWebhookConfig */ export interface AppTriggerWebhookConfig { /** *触发器webhook参数配置
*/ ParamSchemaConfig?: AppTriggerWebhookParamSchemaConfig; /** *webhook的key
*/ WebhookKey?: string; /** *webhook的密钥
*/ WebhookToken?: string; /** *webhook的地址
*/ WebhookUrl?: string; } /** * MsgRecordSource */ export interface MsgRecordSource { /** * 对话消息的接入渠道类型: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)为该渠道下的访客唯一标识。 */ ChannelType?: number; /** * 用户ID */ FromId?: string; /** * 消息发送者的用户来源类型:1=用户(访客/C端用户), 2=机器人(AI回复), 3=坐席(人工客服);from_id(string)为该来源类型下的用户唯一标识 ID。 */ FromType?: number; /** * 用户头像 */ UserAvatar?: string; /** * 访客ID */ UserId?: string; /** * 访客名称 */ UserNickname?: string; } /** * MsgRecordResult */ export interface MsgRecordResult { /** * 表示该条消息的调用结果:0=CALL_RESULT_UNKNOWN(全部/未知), 1=CALL_RESULT_SUCCESS(成功), 2=CALL_RESULT_FAILED(失败);fail_reason(string)为调用失败时的失败原因描述。 */ CallResult?: number; /** * 自定义变量,json字符串 */ CustomerVariable?: string; /** * 失败原因 */ FailReason?: string; /** * 首token耗时 */ FirstTokenLatency?: number; /** * 输入token数 */ InputToken?: number; /** * 输出token数 */ OutputToken?: number; /** * 总token数 */ TotalToken?: number; /** * 总token耗时 */ TotalTokenLatency?: number; } /** * CreateVariable返回参数结构体 */ export interface CreateVariableResponse { /** * variable_id */ VariableId?: string; /** * 唯一请求 ID,由服务端生成,每次请求都会返回(若请求因其他原因未能抵达服务端,则该次请求不会获得 RequestId)。定位问题时需要提供该次请求的 RequestId。 */ RequestId?: string; } /** * 分享链接信息(详情查询返回,用户不可修改部分;access_control 用户可修改部分由 ModifyApp 承载) */ export interface AppShareURLInfo { /** * 当前生效的访问控制配置 注意:此字段可能返回 null,表示取不到有效值。 */ AccessControl: AppShareAccessControl; /** * 分享URL */ ShareUrl: string; } /** * ReleaseSkill返回参数结构体 */ export interface ReleaseSkillResponse { /** * 唯一请求 ID,由服务端生成,每次请求都会返回(若请求因其他原因未能抵达服务端,则该次请求不会获得 RequestId)。定位问题时需要提供该次请求的 RequestId。 */ RequestId?: string; } /** * 模型属性 */ export interface ModelProperty { /** * 属性名称 */ Name?: string; /** * 属性值 */ Value?: string; } /** * 文档解析配置 */ export interface DocParseConfig { /** *内容过滤配置
注意:此字段可能返回 null,表示取不到有效值。 */ ContentFilter?: ContentFilter; /** *分割规则
*/ SplitRule?: string; } /** * CreateRelease返回参数结构体 */ export interface CreateReleaseResponse { /** *need_approval
*/ NeedApproval?: boolean; /** *release_id
*/ ReleaseId?: string; /** * 唯一请求 ID,由服务端生成,每次请求都会返回(若请求因其他原因未能抵达服务端,则该次请求不会获得 RequestId)。定位问题时需要提供该次请求的 RequestId。 */ RequestId?: string; } /** * DescribeConflictQASummaryList返回参数结构体 */ export interface DescribeConflictQASummaryListResponse { /** *冲突问列表
*/ ConflictQaList?: Array总数
*/ TotalCount?: number; /** * 唯一请求 ID,由服务端生成,每次请求都会返回(若请求因其他原因未能抵达服务端,则该次请求不会获得 RequestId)。定位问题时需要提供该次请求的 RequestId。 */ RequestId?: string; } /** * DescribeConversationList请求参数结构体 */ export interface DescribeConversationListRequest { /** *会话类型,传 CONVERSATION_TYPE_UNSPECIFIED 表示全部 枚举值: 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(分享链接)
*/ Type: number; /** *应用 ID
*/ AppId?: string; /** *Type=CONVERSATION_TYPE_API 时必填,应用密钥
*/ AppKey?: string; /** *关键词
*/ Keyword?: string; /** *限制数目(整型),配合Offset使用
*/ Limit?: number; /** *子账户Uin
*/ LoginSubAccountUin?: string; /** *主账户Uin
*/ LoginUin?: string; /** *偏移量(整型),配合Limit使用,从0开始
*/ Offset?: number; /** *Type=CONVERSATION_TYPE_SHARE 时必填,分享码
*/ ShareCode?: string; /** *Type=CONVERSATION_TYPE_API 时必填,访客ID
*/ UserId?: string; /** *用户端 AgentId,当需要查询基于用户端 AgentId 创建的会话时使用
*/ AgentId?: string; } /** * 模型详细信息 */ export interface ModelDetailInfo { /** * 模型别名 */ Alias?: string; /** * 历史对话条数限制 */ HistoryLimit?: number; /** * 模型唯一 ID */ ModelId?: string; /** * 模型参数 注意:此字段可能返回 null,表示取不到有效值。 */ ModelParams?: ModelParams; } /** * ModifyVariable请求参数结构体 */ export interface ModifyVariableRequest { /** * app_id */ AppId: string; /** * 变量信息 */ Variable?: Variable; } /** * DescribeConcurrencyLimitDetailList请求参数结构体 */ export interface DescribeConcurrencyLimitDetailListRequest { /** *查询时间范围(Unix 秒)
*/ TimeRange: TimeRange; /** *视图范围:企业视图 / 空间视图/ 应用视图
*/ ViewScope: ViewScope; /** *扩展过滤。Filter 组合规则:多项 AND,同项 value_list OR。支持 Name:concurrency_type(qpm_tpm/dedicated,默认 qpm_tpm)、model_name(必填)、space_id、app_id/resource_id/source_id(应用ID,多选)、metric_source_type(METRIC_SOURCE_TYPE_* 枚举名或整数)
*/ FilterList?: Array页码,从 0 开始
*/ PageNumber?: number; /** *每页数量,最大 100
*/ PageSize?: number; } /** * MCP插件配置信息 */ export interface MCPPluginConfig { /** *MCP插件外部访问地址
*/ ExternalMCPServerUrl?: string; /** *MCP server地址
*/ MCPServerUrl?: string; /** *MCP传输类型: SSE/Streamable
枚举值:
| uint | 描述 |
| --- | --- |
| 0 | SSE + HTTP 模式 |
| 1 | Streamable HTTP 模式 |
MCP插件的header参数
*/ PluginHeader?: ArrayMCP插件的query参数
*/ PluginQuery?: ArraySSE长连接超时时间,单位秒
*/ SSEReadTimeout?: number; /** *请求超时时间,单位秒
*/ Timeout?: number; /** *授权信息
*/ AuthConfig?: AuthConfig; /** *是否支持交互界面(MCP Apps),插件级标签,默认false
*/ SupportsApps?: boolean; } /** * DescribeAppStatisticsOverview请求参数结构体 */ export interface DescribeAppStatisticsOverviewRequest { /** *应用类型。可选值:APP_TYPE_RAG(RAG)、APP_TYPE_WORKFLOW(Workflow)、APP_TYPE_CLAW(Claw)、APP_TYPE_MULTIAGENT(MultiAgent);本期仅 APP_TYPE_RAG 生效,其余为预留值,传入将返回 InvalidParameter
| 枚举项 | 枚举值 | 描述 |
| APP_TYPE_UNSPECIFIED | 0 | 未指定(无效值,请求勿传) |
| APP_TYPE_RAG | 1 | RAG(本期唯一支持) |
| APP_TYPE_WORKFLOW | 2 | Workflow(预留,暂不支持) |
| APP_TYPE_CLAW | 3 | Claw(预留,暂不支持) |
| APP_TYPE_MULTIAGENT | 4 | MultiAgent(预留,暂不支持) |
查询时间范围(Unix 秒)
*/ TimeRange: TimeRange; /** *视图范围:应用视图(VIEW_TYPE_APP),scope_id 填应用 ID(uint64 雪花 ID 的十进制字符串)
*/ ViewScope: ViewScope; /** *空间 ID
参数格式:
空间 ID
默认值:default_space
*/ SpaceId: string; /** *应用 ID
参数格式:
应用 ID
参考值:2099767969573745984
*/ AppId: string; /** *扩展过滤。Filter 组合规则:多项 AND,同项 value_list OR。支持 Name:space_id(空间 ID)、channel_type(调用方式/渠道类型,取值参考 trpc.adp.common.v2.ChannelType 枚举名);channel_type 不传时按全部渠道聚合
*/ FilterList?: Array新建分类的业务 ID
*/ CategoryId?: string; /** * 唯一请求 ID,由服务端生成,每次请求都会返回(若请求因其他原因未能抵达服务端,则该次请求不会获得 RequestId)。定位问题时需要提供该次请求的 RequestId。 */ RequestId?: string; } /** * CreateQAList请求参数结构体 */ export interface CreateQAListRequest { /** *所属知识库 ID
*/ KbId: string; /** *批量创建(数量:1~20)
*/ QaList: Array应用ID
*/ AppId?: string; /** *应用触发器执行配置
*/ ExecuteConfig?: ExecuteConfig; /** *| 枚举项 | 枚举值 | 描述 |
| APP_TRIGGER_EXECUTE_TYPE_UNSPECIFIED | 0 | 未指定 |
| APP_TRIGGER_EXECUTE_TYPE_PROMPT | 1 | 指令执行 |
| APP_TRIGGER_EXECUTE_TYPE_WORKFLOW | 2 | 工作流执行 |
第三方推送配置
*/ PushConfig?: TimerPushConfig; /** *| 枚举项 | 枚举值 | 描述 |
| APP_TRIGGER_SCOPE_UNSPECIFIED | 0 | 未指定 |
| APP_TRIGGER_SCOPE_APP | 1 | B 端管理员 |
| APP_TRIGGER_SCOPE_USER | 2 | C 端访客 |
触发器配置
*/ TriggerConfig?: TriggerConfig; /** *触发器名字
*/ TriggerName?: string; /** *| 枚举项 | 枚举值 | 描述 |
| APP_TRIGGER_TYPE_UNSPECIFIED | 0 | 未指定 |
| APP_TRIGGER_TYPE_SCHEDULED | 1 | 定时触发 |
| APP_TRIGGER_TYPE_WEBHOOK | 2 | Webhook 触发 |
访客ID
*/ UserId?: string; } /** * AppTriggerInstance */ export interface AppTriggerInstance { /** *应用id
*/ AppId?: string; /** *会话id
*/ ConversationId?: string; /** *触发器创建时间
*/ CreatedAt?: string; /** *结束时间
*/ FinishedAt?: string; /** *触发器运行实例id
*/ InstanceId?: string; /** *请求ID
*/ RequestId?: string; /** *结果码
*/ ResultCode?: string; /** *结果摘要
*/ ResultSummary?: string; /** *单次对话id
*/ RunId?: string; /** *| 枚举项 | 枚举值 | 描述 |
| APP_TRIGGER_SCOPE_UNSPECIFIED | 0 | 未指定 |
| APP_TRIGGER_SCOPE_APP | 1 | B 端管理员 |
| APP_TRIGGER_SCOPE_USER | 2 | C 端访客 |
| 枚举项 | 枚举值 | 描述 |
| APP_TRIGGER_INSTANCE_SOURCE_UNSPECIFIED | 0 | 未指定 |
| APP_TRIGGER_INSTANCE_SOURCE_APP_TRIGGER | 1 | 来源于应用触发器 |
触发器开始执行时间
*/ StartedAt?: string; /** *| 枚举项 | 枚举值 | 描述 |
| TIMER_RUN_STATUS_UNSPECIFIED | 0 | 未指定 |
| TIMER_RUN_STATUS_PENDING | 1 | 等待执行 |
| TIMER_RUN_STATUS_RUNNING | 2 | 执行中 |
| TIMER_RUN_STATUS_RETRY_WAIT | 3 | 等待重试 |
| TIMER_RUN_STATUS_SUCCESS | 4 | 成功 |
| TIMER_RUN_STATUS_DEAD | 5 | 失败终态 (重试耗尽 / 不可重试) |
| TIMER_RUN_STATUS_CANCELLED | 6 | 被任务暂停/删除/修改取消 |
TraceId,用于日志记录
*/ TraceId?: string; /** *触发器id
*/ TriggerId?: string; /** *访客ID
*/ UserId?: string; /** *工作流运行ID
*/ WorkflowRunId?: string; } /** * ModifyDocList请求参数结构体 */ export interface ModifyDocListRequest { /** *待修改的文档 ID 列表(数量:1~20)
*/ DocIdList: Array所属知识库 ID
*/ KbId: string; /** *归属分类 ID
*/ CategoryId?: string; /** *生效作用域
| 枚举项 | 枚举值 | 描述 |
| KNOWLEDGE_EFFECTIVE_DOMAIN_UNKNOWN | 0 | |
| KNOWLEDGE_EFFECTIVE_DOMAIN_NONE | 1 | 停用 |
| KNOWLEDGE_EFFECTIVE_DOMAIN_DEV | 2 | 仅开发域 |
| KNOWLEDGE_EFFECTIVE_DOMAIN_RELEASE | 3 | 仅发布域 |
| KNOWLEDGE_EFFECTIVE_DOMAIN_ALL | 4 | 全域 |
过期策略(有效时间与超过有效时间后的行为)
*/ ExpirationPolicy?: ExpirationPolicy; /** *外部链接
*/ ExternalLink?: DocExternalLink; /** *标签列表
*/ LabelRefList?: LabelRefIdentityList; /** *开关配置
*/ Switch?: DocSwitch; } /** * DeleteConversation请求参数结构体 */ export interface DeleteConversationRequest { /** *会话 ID
*/ ConversationId: string; /** *会话类型 枚举值: 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(分享链接)
*/ Type: number; /** *Type=CONVERSATION_TYPE_API 时必填,应用密钥
*/ AppKey?: string; /** *子用户Uin
*/ LoginSubAccountUin?: string; /** *主用户Uin
*/ LoginUin?: string; /** *Type=CONVERSATION_TYPE_SHARE 时必填,分享码
*/ ShareCode?: string; } /** * ModifyConflictQA请求参数结构体 */ export interface ModifyConflictQARequest { /** *所属知识库 ID
*/ KbId: string; /** *冲突组 ID(全局忽略时可不传)
*/ ConflictGroupId?: string; /** *是否全局忽略(忽略当前KB下所有待处理冲突问)
*/ IsIgnoreAll?: boolean; /** *决策涉及的 QA ID 列表(KEEP 与 DELETE 必填)
*/ QaIdList?: Array冲突解决策略:1=保留,2=忽略,3=删除(全局忽略时可不传)
| 枚举项 | 枚举值 | 描述 |
| CONFLICT_RESOLUTION_UNKNOWN | 0 | |
| CONFLICT_RESOLUTION_KEEP | 1 | 保留 |
| CONFLICT_RESOLUTION_IGNORE | 2 | 忽略 |
| CONFLICT_RESOLUTION_DELETE | 3 | 删除 |
| CONFLICT_RESOLUTION_MERGE | 4 | 合并 |
| CONFLICT_RESOLUTION_REPLACE | 5 | 替换 |
| CONFLICT_RESOLUTION_RENAME | 6 | 重命名 |
日志列表
*/ RunLogList?: Array日志列表数量
*/ TotalCount?: string; /** * 唯一请求 ID,由服务端生成,每次请求都会返回(若请求因其他原因未能抵达服务端,则该次请求不会获得 RequestId)。定位问题时需要提供该次请求的 RequestId。 */ RequestId?: string; } /** * DescribeConflictQASummaryList请求参数结构体 */ export interface DescribeConflictQASummaryListRequest { /** *所属知识库 ID
*/ KbId: string; /** *通用过滤(支持按 status 筛选 PENDING/RESOLVED)
*/ FilterList?: Array分页页码,从 0 开始
*/ PageNumber?: number; /** *每页数量,默认 10,最大 100
*/ PageSize?: number; } /** * DescribeSkillSummaryList请求参数结构体 */ export interface DescribeSkillSummaryListRequest { /** * 空间ID,必填 */ SpaceId: string; /** * 仅查询当前用户收藏的 Skill */ FavoriteOnly?: boolean; /** * 过滤条件(多个Filter之间为AND关系,同一Filter的多个Values为OR关系): - SkillIdList: Skill ID列表,字符串数组,精确匹配 - ProviderType: Skill 提供方类型,枚举值数组,精确匹配 (SKILL_PROVIDER_TYPE_OFFICIAL=1/SKILL_PROVIDER_TYPE_THIRD_PARTY=2/SKILL_PROVIDER_TYPE_CUSTOM=3/SKILL_PROVIDER_TYPE_CUSTOM_SHARED=4) - CategoryKey: 分类标识,字符串数组,精确匹配 - AnalysisStatus: 安全检测状态,枚举值数组,精确匹配 (SKILL_ANALYSIS_PENDING=0/SKILL_ANALYSIS_RUNNING=1/SKILL_ANALYSIS_AVAILABLE=2/SKILL_ANALYSIS_UNAVAILABLE=3/SKILL_ANALYSIS_FAILED=4) - RiskLevel: 风险等级,枚举值数组,精确匹配 (SKILL_RISK_NONE=0/SKILL_RISK_LOW=1/SKILL_RISK_MEDIUM=2/SKILL_RISK_HIGH=3) - SkillStatus: Skill 维度发布状态,枚举值数组,精确匹配,多值之间 OR;仅在 Perspective=EDITOR/ALL 时有实际意义 (SKILL_STATUS_INITIALIZED=0/SKILL_STATUS_AUDITING=1/SKILL_STATUS_PENDING_RELEASE=2/SKILL_STATUS_RELEASED=3) - ShareStatus: 共享状态,枚举值数组,精确匹配,仅在ProviderType包含SKILL_PROVIDER_TYPE_CUSTOM/SKILL_PROVIDER_TYPE_CUSTOM_SHARED时生效 (SHARE_STATUS_UNSHARED=0/SHARE_STATUS_SHARED=1/SHARE_STATUS_APPROVING=2) - Perspective: 视角枚举,字符串单值,Values 长度必须为 1,多值视为非法;仅在 ProviderType=SKILL_PROVIDER_TYPE_CUSTOM 时生效;不传默认 USER (USER=使用者视角,仅返回仅有使用权限的 Skill / EDITOR=编辑者视角,仅返回有编辑权限的 Skill / ALL=全量视角,返回有任一权限位的 Skill) - Creator: 创建者过滤,字符串单值,Values 长度必须为 1,多值视为非法;仅在 ProviderType=SKILL_PROVIDER_TYPE_CUSTOM 时生效 当前仅支持占位符 "$self",表示仅返回当前调用者创建的 Skill 后续如需扩展为指定身份,再在此处追加约定 */ FilterList?: ArrayCOS 链接地址,可用作预览和下载
*/ CosUrl?: string; /** *外部链接
注意:此字段可能返回 null,表示取不到有效值。 */ ExternalLink?: DocExternalLink; } /** * CopyApp返回参数结构体 */ export interface CopyAppResponse { /** * new_app_id */ NewAppId?: string; /** * 唯一请求 ID,由服务端生成,每次请求都会返回(若请求因其他原因未能抵达服务端,则该次请求不会获得 RequestId)。定位问题时需要提供该次请求的 RequestId。 */ RequestId?: string; } /** * Agent 插件凭据配置 */ export interface AgentPluginCredentialConfig { /** *插件鉴权值来源
枚举值:
凭证ID
入参限制:AuthValueSource=2时必填
*/ CredentialId?: string; /** *参数配置
*/ ParamList?: Array复合计费维度信息
*/ BillingAttributeList?: Array| 枚举项 | 枚举值 | 描述 |
| UNKNOW | 0 | |
| TOKEN | 1 | 按token |
| PAGE_COUNT | 2 | 按页数 |
| TIMES | 3 | 按次数 |
| TIMES_THOUSAND | 4 | 按千次数 |
| SECOND | 5 | 按时长 |
| CHARACTER | 6 | 按字符数 |
| CHARACTER_THOUSAND | 7 | 按千字符数 |
| SHEET | 8 | 按张 |
| NUMBER | 9 | 按个数 |
现金价格
单位:元
*/ CashPrice?: number; /** *pu价格
单位:pu
*/ PuPrice?: number; } /** * BackgroundImage 背景图片配置 */ export interface BackgroundImage { /** * 亮度值 */ Brightness: number; /** * 横图(pc) */ LandscapeImageUrl: string; /** * 原始图 */ OriginalImageUrl: string; /** * 长图(手机) */ PortraitImageUrl: string; /** * 主题色 */ ThemeColor: string; } /** * ModifyConflictQA返回参数结构体 */ export interface ModifyConflictQAResponse { /** * 唯一请求 ID,由服务端生成,每次请求都会返回(若请求因其他原因未能抵达服务端,则该次请求不会获得 RequestId)。定位问题时需要提供该次请求的 RequestId。 */ RequestId?: string; } /** * 模型完整信息 */ export interface Model { /** *模型徽章列表
*/ BadgeList?: Array模型限制信息
注意:此字段可能返回 null,表示取不到有效值。 */ LimitInfo?: ModelLimit; /** *模型基本信息
注意:此字段可能返回 null,表示取不到有效值。 */ ModelBasic?: ModelBasic; /** *模型超参配置
*/ ParameterList?: Array模型属性配置
*/ PropertyList?: Array模型提供商信息
注意:此字段可能返回 null,表示取不到有效值。 */ ProviderInfo?: ModelProviderBasic; /** *模型状态信息
注意:此字段可能返回 null,表示取不到有效值。 */ StatusInfo?: ModelStatus; /** *模型标签列表
*/ TagList?: Array模型作者信息
*/ DeveloperInfo?: ModelDeveloperBasic; } /** * 标准词校验项 */ export interface LabelTermCheckResult { /** * 校验结果 注意:此字段可能返回 null,表示取不到有效值。 */ CheckResult?: CheckResult; /** * 待校验的标准词 */ Term?: string; /** * 已存在时返回对应标准词 ID */ TermId?: string; } /** * 搜索资源状态信息 */ export interface SearchResourceStatusInfo { /** * 搜索资源状态: AVAILABLE(1)=资源可用, EXHAUSTED(2)=资源已用尽。枚举值: 1:资源可用, 2:资源已用尽 */ ResourceStatus: number; } /** * CreateQAGenerationTask请求参数结构体 */ export interface CreateQAGenerationTaskRequest { /** *待生成 QA 的文档 ID 列表(数量:1~20)
*/ DocIdList: Array所属知识库 ID
*/ KbId: string; } /** * 钉钉机器人渠道配置 */ export interface DingTalkChannelConfig { /** *钉钉机器人ClientId(AppKey)
*/ AppKey?: string; /** *钉钉机器人ClientSecret(AppSecret)
*/ AppSecret?: string; } /** * DescribeSpaceList请求参数结构体 */ export interface DescribeSpaceListRequest { /** * 支持空间名称模糊搜索 */ Query?: string; } /** * AppTriggerRunLog */ export interface AppTriggerRunLog { /** *会话id
*/ ConversationId?: string; /** *执行时间
*/ DurationMs?: string; /** *结束时间
参数格式:YYYY-MM-DD hh:mm:ss
*/ EndTime?: string; /** *| 枚举项 | 枚举值 | 描述 |
| APP_TRIGGER_FIRE_TYPE_UNSPECIFIED | 0 | 未指定 |
| APP_TRIGGER_FIRE_TYPE_SCHEDULED | 1 | 定时触发 |
| APP_TRIGGER_FIRE_TYPE_WEBHOOK | 2 | Webhook 触发 |
| APP_TRIGGER_FIRE_TYPE_MANUAL_RUN | 3 | 手动立即执行 |
| APP_TRIGGER_FIRE_TYPE_TEST_RUN | 4 | 测试执行 |
触发实例id
*/ InstanceId?: string; /** *| 枚举项 | 枚举值 | 描述 |
| TIMER_RUN_PUSH_STATUS_UNSPECIFIED | 0 | 未指定 |
| TIMER_RUN_PUSH_STATUS_NONE | 1 | 未配置推送 |
| TIMER_RUN_PUSH_STATUS_WAITING | 2 | 等待推送 |
| TIMER_RUN_PUSH_STATUS_SUCCESS | 3 | 推送成功 |
| TIMER_RUN_PUSH_STATUS_FAILED | 4 | 推送失败 |
结果码
*/ ResultCode?: string; /** *结果概要
*/ ResultSummary?: string; /** *单次对话id
*/ RunId?: string; /** *触发时间
参数格式:YYYY:MM:DD hh:mm:ss
*/ ScheduledFireTime?: string; /** *| 枚举项 | 枚举值 | 描述 |
| APP_TRIGGER_SCOPE_UNSPECIFIED | 0 | 未指定 |
| APP_TRIGGER_SCOPE_APP | 1 | B 端管理员 |
| APP_TRIGGER_SCOPE_USER | 2 | C 端访客 |
开始执行时间
参数格式:YYYY:MM:DD hh:mm:ss
*/ StartTime?: string; /** *| 枚举项 | 枚举值 | 描述 |
| TIMER_RUN_STATUS_UNSPECIFIED | 0 | 未指定 |
| TIMER_RUN_STATUS_PENDING | 1 | 等待执行 |
| TIMER_RUN_STATUS_RUNNING | 2 | 执行中 |
| TIMER_RUN_STATUS_RETRY_WAIT | 3 | 等待重试 |
| TIMER_RUN_STATUS_SUCCESS | 4 | 成功 |
| TIMER_RUN_STATUS_DEAD | 5 | 失败终态 (重试耗尽 / 不可重试) |
| TIMER_RUN_STATUS_CANCELLED | 6 | 被任务暂停/删除/修改取消 |
触发器id
*/ TriggerId?: string; /** *是否已读
*/ Unread?: boolean; /** *访客Id
*/ UserId?: string; /** *工作流运行id
*/ WorkflowRunId?: string; } /** * Content 消息内容信息 */ export interface ConversationContent { /** *文本内容
*/ Text: string; /** *内容类型, text:文本,image:图片,file:文件,custom_variables:自定义输入参数信息,widget_action:widget动作信息
*/ Type: string; /** *自定义参数数据
*/ CustomParamList?: Array自定义参数数据
*/ CustomParams?: Array自定义变量数据
注意:此字段可能返回 null,表示取不到有效值。 */ CustomVariablesData?: string; /** *企业表单
注意:此字段可能返回 null,表示取不到有效值。 */ EnterpriseCharts?: string; /** *选项卡列表
*/ OptionCardList?: Array选项卡列表
*/ OptionCards?: Array选项卡模式 枚举值: 0-OPTION_MODE_SINGLE(单选), 1-OPTION_MODE_MULTI(多选)
注意:此字段可能返回 null,表示取不到有效值。 */ OptionMode?: number; /** *引用角标信息列表
*/ QuoteInfoList?: Array引用角标信息列表
*/ QuoteInfos?: Array参考来源列表
*/ ReferenceList?: Array参考来源列表
*/ References?: Array关联记录 ID
注意:此字段可能返回 null,表示取不到有效值。 */ RelatedRecordId?: string; /** *智能体任务列表
*/ TaskList?: Array智能体任务列表
*/ Tasks?: Array工作流输入参数
注意:此字段可能返回 null,表示取不到有效值。 */ WorkflowInput?: string; /** *MCP-APP调用信息
注意:此字段可能返回 null,表示取不到有效值。 */ McpApp?: ConversationMcpApp; } /** * CAM授权信息 */ export interface CamAuthConfig { /** *角色名称
*/ RoleName: string; /** *密钥位置 HEADER/QUERY
枚举值:
| uint | 描述 |
| --- | --- |
| 0 | 头鉴权 |
| 1 | 请求信息鉴权 |
SecretId字段名称
*/ SecretIdName?: string; /** *SecretKey字段名称
*/ SecretKeyName?: string; /** *CAM Access Key 字段配置
*/ ParamList?: Array是否支持CAM角色授权
*/ SupportRoleAuth?: boolean; } /** * DescribeSkillReferenceList返回参数结构体 */ export interface DescribeSkillReferenceListResponse { /** *按 SkillRefType 分组的引用汇总:某类型 total_count = 0 时不入组(不返回空占位) 本期同时落 OPENCLAW / AGENT / CORP_ASSISTANT 三路
*/ ReferenceList?: Array当前用户是否允许强制删除有引用的Skill
*/ AllowForceModify?: boolean; /** * 唯一请求 ID,由服务端生成,每次请求都会返回(若请求因其他原因未能抵达服务端,则该次请求不会获得 RequestId)。定位问题时需要提供该次请求的 RequestId。 */ RequestId?: string; } /** * UnfavoritePlugin返回参数结构体 */ export interface UnfavoritePluginResponse { /** * 唯一请求 ID,由服务端生成,每次请求都会返回(若请求因其他原因未能抵达服务端,则该次请求不会获得 RequestId)。定位问题时需要提供该次请求的 RequestId。 */ RequestId?: string; } /** * CreateKB请求参数结构体 */ export interface CreateKBRequest { /** *知识库类型(不可为 0,取值:1=默认知识库,2=共享知识库)
| 枚举项 | 枚举值 | 描述 |
| KB_TYPE_UNKNOWN | 0 | |
| KB_TYPE_DEFAULT | 1 | 默认知识库 |
| KB_TYPE_SHARED | 2 | 共享知识库 |
工作空间 ID
*/ SpaceId: string; /** *可写属性
*/ Spec: KBSpec; /** *共享子类型:1=普通,2=公众号
| 枚举项 | 枚举值 | 描述 |
| SHARED_KB_SUB_TYPE_UNKNOWN | 0 | |
| SHARED_KB_SUB_TYPE_NORMAL | 1 | 普通 |
| SHARED_KB_SUB_TYPE_PUBLIC_ACCOUNT | 2 | 公众号 |
审批ID
*/ ApprovalId: string; /** *共享后关联的新 skill_id
*/ ShareSkillId: string; /** *共享版本,如 1.0.0
*/ ShareVersion: string; /** *共享版本ID
*/ ShareVersionId: string; /** *原 skill_id
*/ SkillId: string; /** *共享状态
枚举值:
| uint | 描述 |
| --- | --- |
| 0 | 未共享 |
| 1 | 已共享 |
| 2 | 审批中 |
企业共享范围
*/ CorpShareConfig?: SkillCorpShareConfig; } /** * AppShareWhitelistItem */ export interface AppShareWhitelistItem { /** *| 枚举项 | 枚举值 | 描述 |
| APP_SHARE_WHITELIST_TYPE_UNSPECIFIED | 0 | |
| APP_SHARE_WHITELIST_TYPE_UIN | 1 | UIN账号 |
| APP_SHARE_WHITELIST_TYPE_PHONE | 2 | 手机号码 |
| APP_SHARE_WHITELIST_TYPE_EMAIL | 3 | 邮箱地址 |
| APP_SHARE_WHITELIST_TYPE_IP | 4 | IP地址 |
| APP_SHARE_WHITELIST_TYPE_RTX | 5 | RTX账号 |
白名单数组信息
参数格式:白名单值
*/ Values?: Array知识库 ID
*/ KbId: string; /** *可写属性(与 update_mask 配合使用)
*/ Spec: KBSpec; /** *字段掩码:指定要修改的字段(蛇形字段名),未列出的字段忽略
*/ UpdateMask: FieldMask; /** *扩展操作(用于承载无法归类到常规字段修改的特殊操作,例如触发超量恢复等;需在 update_mask 中同时传入 'extend_fields' 才会生效,取值参见 KBExtendedAction:1=触发恢复超量)
*/ ExtendFields?: KBModifyExtendFields; } /** * CreateWebSocketToken请求参数结构体 */ export interface CreateWebSocketTokenRequest { /** *会话类型 枚举值: 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(分享链接)
*/ Type: number; /** *应用 ID
*/ AppId?: string; /** *Type=CONVERSATION_TYPE_API 时必填,应用密钥
*/ AppKey?: string; /** *子用户Uin
*/ LoginSubAccountUin?: string; /** *主用户Uin
*/ LoginUin?: string; /** *Type=CONVERSATION_TYPE_SHARE 时必填,分享码
*/ ShareCode?: string; /** *Type=CONVERSATION_TYPE_API 时必填,访客ID
*/ UserId?: string; } /** * DescribeChannelList请求参数结构体 */ export interface DescribeChannelListRequest { /** *应用业务ID
*/ AppId: string; /** *渠道场景:0-B端场景,1-C端场景
*/ Scene?: number; /** *过滤条件(可选,支持ChannelType/ChannelStatus等维度)
*/ FilterList?: Array页码(从1开始)
*/ PageNumber?: number; /** *每页数量(最大100)
*/ PageSize?: number; } /** * DescribeQA请求参数结构体 */ export interface DescribeQARequest { /** *所属知识库 ID
*/ KbId: string; /** *QA ID
*/ QaId: string; } /** * 文档查询条件 */ export interface DocQuery { /** *查询关键词(名称模糊搜索)
*/ Query?: string; /** *查询范围(query 作用的字段):1=文件名,2=标签或标签值;支持多选,缺省时无效
*/ QueryScopeList?: Array应用Id
*/ AppId: string; /** *页码
*/ PageNumber: number; /** *每页数量在1到200之间
*/ PageSize: number; /** *查询关键字, 用于模糊匹配标题
*/ Query?: string; /** *过滤条件
入参限制:支持 StartTime、EndTime、ActionList、ReleaseStatusList
*/ FilterList?: Array是否可下载
*/ DownloadEnabled?: boolean; /** *是否在参考来源中展示
*/ ReferEnabled?: boolean; } /** * PauseAppTrigger请求参数结构体 */ export interface PauseAppTriggerRequest { /** *应用ID
*/ AppId?: string; /** *| 枚举项 | 枚举值 | 描述 |
| APP_TRIGGER_SCOPE_UNSPECIFIED | 0 | 未指定 |
| APP_TRIGGER_SCOPE_APP | 1 | B 端管理员 |
| APP_TRIGGER_SCOPE_USER | 2 | C 端访客 |
应用触发器ID
*/ TriggerId?: string; /** *访客ID
*/ UserId?: string; } /** * 元数据值 */ export interface MetaValue { /** *元数据值名称(仅展示使用)
*/ Name?: string; /** *是否引用该类型下的全部值(true 时 ref_value_id 应为 0)
*/ RefAll?: boolean; /** *元数据引用的业务 ID(属性 ID、分类 ID 等);ref_all=true 时该字段应为 0
*/ RefValueId?: string; /** *元数据使用场景:1=仅检索使用,2=检索和生成都使用
| 枚举项 | 枚举值 | 描述 |
| META_SCENE_UNKNOWN | 0 | 未知 |
| META_SCENE_SEARCH_ONLY | 1 | 仅检索使用 |
| META_SCENE_ALL | 2 | 检索和生成都使用 |
元数据值类型:1=属性标签,2=文档分类,3=问答分类
| 枚举项 | 枚举值 | 描述 |
| META_VALUE_TYPE_UNKNOWN | 0 | 未知 |
| META_VALUE_TYPE_TAG | 1 | 属性标签 |
| META_VALUE_TYPE_DOC_CATEGORY | 2 | 文档分类 |
| META_VALUE_TYPE_QA_CATEGORY | 3 | 问答分类 |
操作类型(不可为 0,取值:1=新增,2=修改,3=删除)
| 枚举项 | 枚举值 | 描述 |
| MODIFY_ACTION_UNKNOWN | 0 | |
| MODIFY_ACTION_CREATE | 1 | 新增 |
| MODIFY_ACTION_UPDATE | 2 | 修改 |
| MODIFY_ACTION_DELETE | 3 | 删除 |
同义词列表(CREATE 与 UPDATE 时传完整同义词集合,覆盖式更新)
*/ SynonymList?: Array标准词(CREATE 与 UPDATE 必填,DELETE 可留空)
*/ Term?: string; /** *标准词 ID(UPDATE 与 DELETE 必填,CREATE 留空由后台生成)
*/ TermId?: string; } /** * CopyAgentFromApp请求参数结构体 */ export interface CopyAgentFromAppRequest { /** *应用Id
*/ AppId: string; /** *目标应用ID,kind=0时需传入
*/ TargetAppId?: string; /** *Agent 类型,区分 B 端配置态 Agent 与 C 端用户态 Agent
枚举值:
问题
*/ Question: string; /** *答案
*/ Answer?: string; /** *分类 ID
*/ CategoryId?: string; /** *关联文档 ID
*/ DocId?: string; /** *知识生效作用域
| 枚举项 | 枚举值 | 描述 |
| KNOWLEDGE_EFFECTIVE_DOMAIN_UNKNOWN | 0 | |
| KNOWLEDGE_EFFECTIVE_DOMAIN_NONE | 1 | 停用 |
| KNOWLEDGE_EFFECTIVE_DOMAIN_DEV | 2 | 仅开发域 |
| KNOWLEDGE_EFFECTIVE_DOMAIN_RELEASE | 3 | 仅发布域 |
| KNOWLEDGE_EFFECTIVE_DOMAIN_ALL | 4 | 全域 |
过期策略(有效时间与超过有效时间后的行为)
注意:此字段可能返回 null,表示取不到有效值。 */ ExpirationPolicy?: ExpirationPolicy; /** *适用范围(标签条件)
*/ LabelRefList?: Array问题描述
*/ QuestionDescription?: string; /** *相似问列表
*/ SimilarQuestionList?: Array默认值
*/ DefaultValue?: string; /** *可选值列表
*/ EnumValueList?: Array最大值(仅数值类型有效)
*/ MaxValue?: number; /** *最小值(仅数值类型有效)
*/ MinValue?: number; /** *超参名称
*/ Name?: string; /** *超参类型。1-浮点数, 2-整数, 3-字符串
*/ Type?: number; } /** * ModifyApp返回参数结构体 */ export interface ModifyAppResponse { /** *app_id
*/ AppId?: string; /** *更新时间 (Unix时间戳,秒级)
*/ UpdateTime?: string; /** * 唯一请求 ID,由服务端生成,每次请求都会返回(若请求因其他原因未能抵达服务端,则该次请求不会获得 RequestId)。定位问题时需要提供该次请求的 RequestId。 */ RequestId?: string; } /** * 过期策略(有效时间与超过有效时间后的行为) */ export interface ExpirationPolicy { /** *有效时间
注意:此字段可能返回 null,表示取不到有效值。 */ EffectivePeriod?: EffectivePeriod; /** *超过有效时间后的行为:1=NOT_RETRIEVABLE 不可被检索,2=RETRIEVABLE 仍可被检索;永久有效时无意义
| 枚举项 | 枚举值 | 描述 |
| EXPIRE_BEHAVIOR_UNKNOWN | 0 | 未指定(服务端按默认处理) |
| EXPIRE_BEHAVIOR_NOT_RETRIEVABLE | 1 | 不可被检索(到期下架) |
| EXPIRE_BEHAVIOR_RETRIEVABLE | 2 | 仍可被检索(到期不下架,仅标记时效范围) |
页码
从0开始
*/ PageNumber?: number; /** *分页数量
取值范围:[1, 100]
单位:个
最大100
*/ PageSize?: number; /** *参数过滤
支持SpaceId,NIckName 过滤查询
*/ FilterList?: Array企业微信应用Secret
*/ AgentSecret?: string; /** *头像URL
*/ Avatar?: string; /** *回调配置
*/ Callback?: CallbackConfig; /** *客服账号ID
*/ CustomerServiceId?: string; /** *客服账号名称
*/ Name?: string; /** *客服形象二维码URL
*/ ShareCodeUrl?: string; /** *企业微信企业ID
*/ WecomCorpId?: string; } /** * DescribeConversationList返回参数结构体 */ export interface DescribeConversationListResponse { /** *会话列表
*/ ConversationList?: Array会话列表
*/ Conversations?: Array总数
*/ TotalCount?: string; /** * 唯一请求 ID,由服务端生成,每次请求都会返回(若请求因其他原因未能抵达服务端,则该次请求不会获得 RequestId)。定位问题时需要提供该次请求的 RequestId。 */ RequestId?: string; } /** * 多智能体配置 */ export interface MultiAgentConfig { /** * Agent协同配置 注意:此字段可能返回 null,表示取不到有效值。 */ AgentCollaboration: AgentCollaborationConfig; } /** * CreateWebSocketToken返回参数结构体 */ export interface CreateWebSocketTokenResponse { /** *应用ID
*/ AppId?: string; /** *WebSocket Token
*/ Token?: string; /** *用户ID,在后续DescribeUserDialogConfig接口中会使用
*/ UserId?: string; /** * 唯一请求 ID,由服务端生成,每次请求都会返回(若请求因其他原因未能抵达服务端,则该次请求不会获得 RequestId)。定位问题时需要提供该次请求的 RequestId。 */ RequestId?: string; } /** * DescribeChannelList返回参数结构体 */ export interface DescribeChannelListResponse { /** *渠道列表
*/ ChannelList?: Array总数
*/ TotalCount?: number; /** * 唯一请求 ID,由服务端生成,每次请求都会返回(若请求因其他原因未能抵达服务端,则该次请求不会获得 RequestId)。定位问题时需要提供该次请求的 RequestId。 */ RequestId?: string; } /** * QA 分片高亮信息 */ export interface QASegmentHighlight { /** *高亮结束位置
*/ EndPos?: string; /** *高亮起始位置
*/ StartPos?: string; } /** * DescribeSkillCategoryList返回参数结构体 */ export interface DescribeSkillCategoryListResponse { /** * Skill 分类列表 */ CategoryList?: Array飞书机器人AppId
*/ AppId?: string; /** *飞书机器人AppSecret
*/ AppSecret?: string; } /** * 查询时间范围(Unix 秒) */ export interface TimeRange { /** *结束时间,Unix 秒
*/ EndTime: string; /** *开始时间,Unix 秒
*/ StartTime: string; } /** * DescribeConsumptionDetailList返回参数结构体 */ export interface DescribeConsumptionDetailListResponse { /** *资源消耗明细列表
*/ ConsumptionDetailList?: Array总记录数,用于前端分页
*/ TotalCount?: string; /** * 唯一请求 ID,由服务端生成,每次请求都会返回(若请求因其他原因未能抵达服务端,则该次请求不会获得 RequestId)。定位问题时需要提供该次请求的 RequestId。 */ RequestId?: string; } /** * 冲突问摘要信息 */ export interface ConflictQASummary { /** *冲突组 ID
*/ ConflictGroupId?: string; } /** * ModifyChannel返回参数结构体 */ export interface ModifyChannelResponse { /** * 唯一请求 ID,由服务端生成,每次请求都会返回(若请求因其他原因未能抵达服务端,则该次请求不会获得 RequestId)。定位问题时需要提供该次请求的 RequestId。 */ RequestId?: string; } /** * DeleteCategory请求参数结构体 */ export interface DeleteCategoryRequest { /** *待删除的分类 ID
*/ CategoryId: string; /** *分类类型(不可为 0,取值:1=文档分类,2=问答分类)
| 枚举项 | 枚举值 | 描述 |
| CATEGORY_TYPE_UNKNOWN | 0 | |
| CATEGORY_TYPE_DOC | 1 | 文档分类 |
| CATEGORY_TYPE_QA | 2 | 问答分类 |
所属知识库 ID
*/ KbId: string; } /** * 应用操作信息 */ export interface AppOperation { /** * 创建人 */ Creator: string; /** * 创建人UIN */ CreatorUin: string; /** * 创建人账号(私有化场景使用) */ CreatorUserAccount: string; /** * 修改时间 (Unix时间戳,秒级) */ UpdateTime: string; /** * 最后修改人 */ Updater: string; /** * 修改人UIN */ UpdaterUin: string; } /** * ClawAgent Agent团队协作配置 */ export interface ClawAgentAgentTeamConfig { /** *是否开启Agent团队协作
*/ Enabled?: boolean; /** *prompt内容
*/ PromptContent?: string; } /** * DescribeSystemVariableList返回参数结构体 */ export interface DescribeSystemVariableListResponse { /** * system_variable_list */ SystemVariableList?: Array客户自定义知识 ID
*/ CustomerKnowledgeId?: string; /** *文档是否公开
*/ IsPublic?: boolean; } /** * 知识库模型配置 */ export interface KBModelConfig { /** *Embedding 模型
*/ EmbeddingModel?: string; /** *QA 抽取模型
*/ QaExtractModel?: string; /** *Schema 生成模型
*/ SchemaModel?: string; } /** * Agent 的插件信息 */ export interface AgentPlugin { /** *插件基本配置
*/ Config?: AgentPluginConfig; /** *插件名称
*/ Name?: string; /** *插件图标url
*/ IconUrl?: string; /** *插件描述
*/ Description?: string; /** *插件产品分类
枚举值:
插件状态
枚举值:
插件鉴权配置状态
枚举值:
相似问内容(CREATE 与 UPDATE 必填)
*/ Content?: string; /** *操作类型:1=新增,2=修改,3=删除
| 枚举项 | 枚举值 | 描述 |
| MODIFY_ACTION_UNKNOWN | 0 | |
| MODIFY_ACTION_CREATE | 1 | 新增 |
| MODIFY_ACTION_UPDATE | 2 | 修改 |
| MODIFY_ACTION_DELETE | 3 | 删除 |
相似问 ID(UPDATE 与 DELETE 必填)
*/ SimilarQuestionId?: string; } /** * 检索计费信息 */ export interface SearchBilling { /** *计费标签列表
*/ BillingTagList?: Array计费子业务类型
*/ FinanceSubBusinessType?: string; } /** * DeleteQAList返回参数结构体 */ export interface DeleteQAListResponse { /** *批量删除结果
*/ ResultList?: Array最近一次重置的毫秒级时间戳
*/ ResetTime?: string; /** *最近一次重置边界;该记录及更早的记录不再作为对话上下文
*/ ResetThroughRecordId?: string; } /** * QA 来源与关联文档信息 */ export interface QASourceInfo { /** *关联文档的生效作用域
| 枚举项 | 枚举值 | 描述 |
| KNOWLEDGE_EFFECTIVE_DOMAIN_UNKNOWN | 0 | |
| KNOWLEDGE_EFFECTIVE_DOMAIN_NONE | 1 | 停用 |
| KNOWLEDGE_EFFECTIVE_DOMAIN_DEV | 2 | 仅开发域 |
| KNOWLEDGE_EFFECTIVE_DOMAIN_RELEASE | 3 | 仅发布域 |
| KNOWLEDGE_EFFECTIVE_DOMAIN_ALL | 4 | 全域 |
关联文档 ID
*/ DocId?: string; /** *关联文档名称
*/ FileName?: string; /** *关联文档类型
*/ FileType?: string; /** *来源描述
*/ SourceDesc?: string; /** *来源类型:1=文档生成,2=批量导入,3=手动录入
| 枚举项 | 枚举值 | 描述 |
| QA_SOURCE_TYPE_UNKNOWN | 0 | |
| QA_SOURCE_TYPE_DOC | 1 | 文档生成 |
| QA_SOURCE_TYPE_BATCH_IMPORT | 2 | 批量导入 |
| QA_SOURCE_TYPE_MANUAL | 3 | 手动录入 |
参考来源的索引值
*/ Index: number; /** *参考来源位置
*/ Position: number; } /** * DeleteLabelList请求参数结构体 */ export interface DeleteLabelListRequest { /** *所属知识库 ID
*/ KbId: string; /** *待删除标签 ID 列表(数量:1~20)
*/ LabelIdList: ArrayLINE Channel Access Token
*/ AccessToken?: string; /** *LINE回调地址
*/ CallbackUrl?: string; /** *LINE Channel Secret
*/ ChannelSecret?: string; } /** * 单次对话记录统计信息 */ export interface ConversationRecordSummary { /** *回复记录 ID,对应 messages 中回复消息的 record_id
*/ RecordId?: string; /** *用户提问记录 ID,对应 messages 中用户消息的 record_id
*/ RelatedRecordId?: string; /** *单次对话耗时信息
注意:此字段可能返回 null,表示取不到有效值。 */ TimeUsage?: ConversationRecordTimeUsage; /** *单次对话 token 消耗信息
注意:此字段可能返回 null,表示取不到有效值。 */ TokenUsage?: ConversationRecordTokenUsage; /** *单次对话失败信息;成功时为空
注意:此字段可能返回 null,表示取不到有效值。 */ ErrorInfo?: ConversationRecordErrorInfo; /** *单次员工助理对话当前状态
枚举值:
单次对话总耗时,单位毫秒
*/ Elapsed?: string; /** *首 token 耗时,单位毫秒
*/ FirstTokenCost?: string; /** *模型推理总耗时,单位毫秒
*/ TotalCost?: string; } /** * App 应用完整信息 */ export interface App { /** *辅助信息(子状态/审批/申诉/搜索资源/特殊状态等)
注意:此字段可能返回 null,表示取不到有效值。 */ AuxiliaryInfo: AppAuxiliaryInfo; /** *配置
注意:此字段可能返回 null,表示取不到有效值。 */ Config: AppConfig; /** *元数据
注意:此字段可能返回 null,表示取不到有效值。 */ Metadata: AppMetadata; /** *应用密钥信息
注意:此字段可能返回 null,表示取不到有效值。 */ SecretInfo: AppSecretInfo; /** *分享链接信息(含访问控制)
注意:此字段可能返回 null,表示取不到有效值。 */ ShareUrlInfo: AppShareURLInfo; /** *状态
注意:此字段可能返回 null,表示取不到有效值。 */ Status: AppStatusInfo; /** *应用引用的共享知识库列表
*/ SharedKbList?: Array企业共享配置
注意:此字段可能返回 null,表示取不到有效值。 */ CorpShareConfig?: CorpShareConfig; } /** * AppTriggerParamBindingValue */ export interface AppTriggerParamBindingValue { /** *参数值
*/ ParamValue?: string; /** *应用变量名
*/ VariableName?: string; } /** * 文档元信息 */ export interface DocMetadata { /** *文档字符数
*/ DocCharCount?: string; /** *文件名
*/ FileName?: string; /** *文件大小(字节)
*/ FileSize?: string; /** *文件类型/扩展名
*/ FileType?: string; /** *元数据引用字段名列表(用于显示文档哪些分类和属性被设置为元数据)
*/ RefFieldNameList?: Array来源描述
*/ SourceDesc?: string; /** *文档来源类型:1=本地上传,2=网页链接,3=COS 对接,4=外部导入
| 枚举项 | 枚举值 | 描述 |
| DOC_SOURCE_TYPE_UNKNOWN | 0 | |
| DOC_SOURCE_TYPE_LOCAL | 1 | 本地上传 |
| DOC_SOURCE_TYPE_URL | 2 | 网页链接 |
| DOC_SOURCE_TYPE_COS | 3 | COS 对接 |
| DOC_SOURCE_TYPE_IMPORT | 4 | 外部导入 |
请求来源
| 枚举项 | 枚举值 | 描述 |
| CALL_SOURCE_UNSPECIFIED | 0 | |
| CALL_SOURCE_RAG | 1 | 标准模式 |
| CALL_SOURCE_WORKFLOW | 2 | 工作流 |
| CALL_SOURCE_PLUGIN | 3 | 插件 |
| CALL_SOURCE_OPENCLAW | 4 | openclaw |
| CALL_SOURCE_RECALL_TEST | 5 | 召回测试 |
| CALL_SOURCE_RECALL_TEST_DIFF | 6 | 召回测试在对比的场景,同样需要触发检索接口。区别这种case前端不需要更新最新配置。因为对比1,2,3 可能最后保存的是2 |
adp域:1=开发域,2=生产域
| 枚举项 | 枚举值 | 描述 |
| ADP_DOMAIN_UNSPECIFIED | 0 | 未指定 |
| ADP_DOMAIN_DEV | 1 | 开发域 |
| ADP_DOMAIN_PROD | 2 | 生产域 |
访客 ID
*/ VisitorId?: string; } /** * ResponseParam */ export interface ResponseParam { /** *变量描述
*/ Description?: string; /** *参数名称
*/ Name?: string; /** *| 枚举项 | 枚举值 | 描述 |
| OUTPUT_RENDER_REPLACE | 0 | 覆盖(全量替换) |
| OUTPUT_RENDER_APPEND | 1 | 增量追加 |
只对 OBJECT 或 ARRAY_OBJECT 类型有用
*/ SubParams?: Array| 枚举项 | 枚举值 | 描述 |
| PARAM_TYPE_STRING | 0 | 字符串 |
| PARAM_TYPE_INT | 1 | 整数 |
| PARAM_TYPE_FLOAT | 2 | 浮点数 |
| PARAM_TYPE_BOOL | 3 | 布尔值 |
| PARAM_TYPE_OBJECT | 4 | 对象 |
| PARAM_TYPE_ARRAY_STRING | 5 | 字符串数组 |
| PARAM_TYPE_ARRAY_INT | 6 | 整数数组 |
| PARAM_TYPE_ARRAY_FLOAT | 7 | 浮点数数组 |
| PARAM_TYPE_ARRAY_BOOL | 8 | 布尔值数组 |
| PARAM_TYPE_ARRAY_OBJECT | 9 | 对象数组 |
| PARAM_TYPE_ARRAY_ARRAY | 20 | 数组嵌套 |
| PARAM_TYPE_NULL | 99 | 空值 |
| PARAM_TYPE_UNSPECIFIED | 100 | 未指定类型,用于OneOf和AnyOf场景 |
是否开启异步工作流
*/ AsyncWorkflow: boolean; /** *状态 发布状态(UNPUBLISHED: 待发布 PUBLISHING: 发布中 PUBLISHED: 已发布 PUBLISHED_FAIL:发布失败;DRAFT:待调试)
*/ Status: string; /** *工作流描述
*/ WorkflowDescription: string; /** *工作流Id
*/ WorkflowId: string; /** *工作流名称
*/ WorkflowName: string; /** *工作流是否启用
*/ Enabled?: boolean; } /** * CreateSimilarQuestion返回参数结构体 */ export interface CreateSimilarQuestionResponse { /** *生成的相似问列表
*/ QuestionList?: Array渠道信息(含spec)
*/ Channel?: Channel; /** * 唯一请求 ID,由服务端生成,每次请求都会返回(若请求因其他原因未能抵达服务端,则该次请求不会获得 RequestId)。定位问题时需要提供该次请求的 RequestId。 */ RequestId?: string; } /** * QA 可修改字段集合(配合 update_mask 使用) */ export interface QAModifyFields { /** *答案
*/ Answer?: string; /** *分类 ID
*/ CategoryId?: string; /** *关联文档 ID
*/ DocId?: string; /** *知识生效作用域
| 枚举项 | 枚举值 | 描述 |
| KNOWLEDGE_EFFECTIVE_DOMAIN_UNKNOWN | 0 | |
| KNOWLEDGE_EFFECTIVE_DOMAIN_NONE | 1 | 停用 |
| KNOWLEDGE_EFFECTIVE_DOMAIN_DEV | 2 | 仅开发域 |
| KNOWLEDGE_EFFECTIVE_DOMAIN_RELEASE | 3 | 仅发布域 |
| KNOWLEDGE_EFFECTIVE_DOMAIN_ALL | 4 | 全域 |
过期策略(有效时间与超过有效时间后的行为)
注意:此字段可能返回 null,表示取不到有效值。 */ ExpirationPolicy?: ExpirationPolicy; /** *是否采纳(校验通过)
*/ IsAccepted?: boolean; /** *适用范围(标签条件)
*/ LabelRefList?: Array问题
*/ Question?: string; /** *问题描述
*/ QuestionDescription?: string; /** *相似问修改列表
*/ SimilarQuestionList?: Array插件id
*/ PluginId?: string; /** *插件 Header 参数
*/ HeaderParameterList?: Array插件 Query 参数
*/ QueryParameterList?: Array是否使用CAM一键授权,仅 auth_type=2时生效
*/ EnableCamRoleAuth?: boolean; /** *授权类型
枚举值:
OAuth 授权同意模式;0-开发者授权;1-使用者授权(仅在auth_type=3时生效)
*/ OAuthConsent?: number; /** *凭证配置
*/ CredentialConfig?: AgentPluginCredentialConfig; } /** * 插件概要信息(用于插件列表) */ export interface PluginSummary { /** *插件配置信息
*/ Config?: PluginConfig; /** *是否已配置共享
*/ IsShared?: boolean; /** *插件运营管理信息
*/ Operation?: PluginOperation; /** *插件id
*/ PluginId?: string; /** *插件基础信息
*/ Profile?: PluginProfile; /** *插件所属空间 ID;内置插件为空
*/ SpaceId?: string; /** *插件统计信息
*/ Statistics?: PluginStatistics; /** *插件状态,1:可用,2:不可用
枚举值:
工具信息
*/ ToolList?: Array用户维度的插件状态信息
*/ UserState?: PluginUserState; /** *更新时间,Unix时间戳
单位:秒
*/ UpdateTime?: string; } /** * ModifyDocList返回参数结构体 */ export interface ModifyDocListResponse { /** *批量修改结果
*/ ResultList?: Array所属知识库 ID
*/ KbId: string; /** *过滤条件(多个 Filter 之间为 AND 关系,同一 Filter 的多个 Values 为 OR 关系):Status-QA状态,枚举值,精确匹配; CategoryId-分类ID,精确匹配; SourceType-QA来源类型,枚举值,精确匹配; EffectiveDomain-生效作用域,精确匹配; DocId-关联文档ID,精确匹配; CreateTime-创建时间,Unix秒,BETWEEN 传 [起始秒,结束秒]; UpdateTime-更新时间,Unix秒,BETWEEN 传 [起始秒,结束秒]
*/ FilterList?: Array分页页码,从 0 开始
*/ PageNumber?: number; /** *每页数量,默认 10,最大 100
*/ PageSize?: number; /** *查询条件(关键词 + 查询范围)
*/ Query?: QAQuery; /** *开关配置
*/ SummaryListSwitch?: SummaryListSwitch; } /** * CreateWorkspaceCredential返回参数结构体 */ export interface CreateWorkspaceCredentialResponse { /** *存储类型
注意:此字段可能返回 null,表示取不到有效值。 */ StorageType?: string; /** *工作空间 ID
*/ WorkspaceId?: string; /** * 唯一请求 ID,由服务端生成,每次请求都会返回(若请求因其他原因未能抵达服务端,则该次请求不会获得 RequestId)。定位问题时需要提供该次请求的 RequestId。 */ RequestId?: string; } /** * MCP App 内容,供历史会话重建可交互 App */ export interface ConversationMcpApp { /** *能力边界:一次请求只能读该 plugin 的资源
*/ PluginId?: string; /** *ui:// 资源,前端据此调 ReadMCPResource 拉 HTML
*/ ResourceUri?: string; /** *agent-exec 侧 thread
*/ ThreadId?: string; /** *JSON:完整 CallToolResult 原文,供历史会话重建时重放
注意:此字段可能返回 null,表示取不到有效值。 */ ToolResult?: string; } /** * ModifyPlugin请求参数结构体 */ export interface ModifyPluginRequest { /** *插件id
*/ PluginId: string; /** *插件版本号
*/ PluginVersion: number; /** *插件基础资料
*/ Profile?: PluginProfile; /** *插件类型配置
*/ Config?: PluginConfig; /** *指定需要更新的字段,避免全量覆盖
*/ UpdateMask?: FieldMask; /** *插件的工具列表,mcp插件不传
*/ ToolList?: Array登录用户主账号(集成商模式必填)
*/ LoginUin?: string; /** *登录用户子账号(集成商模式必填)
*/ LoginSubAccountUin?: string; } /** * 重复文件处理规则 */ export interface DeDuplicateStrategy { /** *校验方式:1=按文档内容判断是否相同
| 枚举项 | 枚举值 | 描述 |
| DUPLICATE_FILE_CHECK_TYPE_UNKNOWN | 0 | 未知 |
| DUPLICATE_FILE_CHECK_TYPE_COS_HASH | 1 | 按文档内容(cos_hash)判断是否相同 |
处理方式:1=返回报错,2=跳过并返回重复的文档 ID
| 枚举项 | 枚举值 | 描述 |
| DUPLICATE_FILE_HANDLE_TYPE_UNKNOWN | 0 | 未知 |
| DUPLICATE_FILE_HANDLE_TYPE_RETURN_ERR | 1 | 返回报错 |
| DUPLICATE_FILE_HANDLE_TYPE_SKIP | 2 | 跳过,返回重复的文档 ID |
总数
*/ TotalCount?: string; /** *员工列表
*/ AccountList?: Array归属分类 ID
*/ CategoryId?: string; /** *生效作用域
| 枚举项 | 枚举值 | 描述 |
| KNOWLEDGE_EFFECTIVE_DOMAIN_UNKNOWN | 0 | |
| KNOWLEDGE_EFFECTIVE_DOMAIN_NONE | 1 | 停用 |
| KNOWLEDGE_EFFECTIVE_DOMAIN_DEV | 2 | 仅开发域 |
| KNOWLEDGE_EFFECTIVE_DOMAIN_RELEASE | 3 | 仅发布域 |
| KNOWLEDGE_EFFECTIVE_DOMAIN_ALL | 4 | 全域 |
过期策略(有效时间与超过有效时间后的行为)
注意:此字段可能返回 null,表示取不到有效值。 */ ExpirationPolicy?: ExpirationPolicy; /** *外部链接
注意:此字段可能返回 null,表示取不到有效值。 */ ExternalLink?: DocExternalLink; /** *标签列表
*/ LabelRefList?: Array文档名
*/ Name?: string; /** *解析配置(分割规则、内容过滤等)
注意:此字段可能返回 null,表示取不到有效值。 */ ParseConfig?: DocParseConfig; /** *开关配置
注意:此字段可能返回 null,表示取不到有效值。 */ Switch?: DocSwitch; /** *更新周期
注意:此字段可能返回 null,表示取不到有效值。 */ UpdatePeriod?: DocUpdatePeriod; /** *用户访问配置
注意:此字段可能返回 null,表示取不到有效值。 */ UserAccessConfig?: UserAccessConfig; } /** * 用户输入值 */ export interface AgentUserInputValue { /** *用户输入参数值
*/ ValueList?: Array创建时间(Unix秒)
*/ CreateTime: string; /** *创建者
*/ Creator: string; /** *Skill 描述
*/ Description: string; /** *Skill 展示描述
*/ DisplayDescription: string; /** *Skill 展示名称
*/ DisplayName: string; /** *Skill 图标
*/ IconUrl: string; /** *Skill 名称
*/ Name: string; /** *更新时间(Unix秒)
*/ UpdateTime: string; /** *空间
*/ SpaceId?: string; } /** * DescribeMetricOverviewList请求参数结构体 */ export interface DescribeMetricOverviewListRequest { /** *看板域,必填,决定返回哪个域的 KPI 数据
| 枚举项 | 枚举值 | 描述 |
| RESOURCE_TYPE_UNSPECIFIED | 0 | |
| RESOURCE_TYPE_MODEL | 1 | 模型用量 |
| RESOURCE_TYPE_PLUGIN | 2 | 插件用量 |
| RESOURCE_TYPE_PLATFORM | 3 | 平台功能用量 |
| RESOURCE_TYPE_MODEL_CONCURRENCY | 4 | 模型并发超限 |
| RESOURCE_TYPE_KB_CAPACITY | 5 | 知识库容量 |
| RESOURCE_TYPE_USAGE_SUMMARY | 6 | 用量汇总 |
| RESOURCE_TYPE_RESOURCE_CONSUME | 7 | 资源消耗(计费明细) |
查询时间范围(Unix 秒)
*/ TimeRange: TimeRange; /** *视图范围:企业视图 / 空间视图
*/ ViewScope: ViewScope; /** *扩展过滤(resource_type=MODEL)。Filter 组合规则:多项 AND,同项 value_list OR。支持 Name:model_name(模型名)、user_id(用户ID)、space_id(空间ID)、resource_id/source_id(来源ID)、metric_source_type(METRIC_SOURCE_TYPE_* 枚举名或整数)
*/ FilterList?: Array请求体参数
*/ Body?: Array示例
*/ Example?: ToolExample; /** *API插件外部调用地址
*/ ExternalApiUrl?: string; /** *Header
*/ Header?: Array请求方式
*/ Method?: string; /** *输出
*/ Outputs?: Array查询参数
*/ Query?: Array| 枚举项 | 枚举值 | 描述 |
| STREAM_MODE_UNARY | 0 | 非流式 |
| STREAM_MODE_STREAMING | 1 | 流式 |
地址
*/ Url?: string; } /** * ToolExample */ export interface ToolExample { /** *请求参数
*/ Request?: string; /** *响应参数
*/ Response?: string; } /** * DescribeAppTriggerRunLogList请求参数结构体 */ export interface DescribeAppTriggerRunLogListRequest { /** *应用ID
*/ AppId?: string; /** *过滤参数
*/ FilterList?: Array页码
取值范围:[1, 1000000]
*/ PageNumber?: number; /** *每页数据量
取值范围:[1, 100]
*/ PageSize?: number; /** *| 枚举项 | 枚举值 | 描述 |
| APP_TRIGGER_SCOPE_UNSPECIFIED | 0 | 未指定 |
| APP_TRIGGER_SCOPE_APP | 1 | B 端管理员 |
| APP_TRIGGER_SCOPE_USER | 2 | C 端访客 |
应用触发器ID
*/ TriggerId?: string; /** *访客ID
*/ UserId?: string; } /** * 单项消耗计量 */ export interface ResourceConsumption { /** *功能标签,PLATFORM 场景取 PlatformBizType 枚举名称;MODEL/PLUGIN 场景为空
*/ Label?: string; /** *消耗计量单位
| 枚举项 | 枚举值 | 描述 |
| DOSAGE_UNIT_TOKEN | 0 | token(默认) |
| DOSAGE_UNIT_PAGE_COUNT | 1 | page_count(页数) |
| DOSAGE_UNIT_TIMES | 2 | times(次数) |
| DOSAGE_UNIT_SECOND | 3 | second(秒) |
| DOSAGE_UNIT_ITEM | 4 | item(条) |
| DOSAGE_UNIT_SHEET | 5 | sheet(张) |
| DOSAGE_UNIT_CHARACTER | 6 | character(字符) |
| DOSAGE_UNIT_GB | 7 | GB |
| DOSAGE_UNIT_NUMBER | 8 | number(个数) |
| DOSAGE_UNIT_MILL_SECOND | 9 | mill_second(毫秒) |
消耗数值
*/ Value?: number; } /** * 模型基本信息 */ export interface ModelBasic { /** * 模型描述 */ Description?: string; /** * 模型图标地址 */ IconUrl?: string; /** * 模型ID */ ModelId?: string; /** * 模型类型。1-LLM模型, 2-Rerank模型, 3-Embedding模型, 4-文档解析模型 */ ModelType?: number; /** * 模型名称 */ Name?: string; } /** * DescribeKBSummaryList返回参数结构体 */ export interface DescribeKBSummaryListResponse { /** *知识库列表
*/ KbList?: Array总数
*/ TotalCount?: number; /** * 唯一请求 ID,由服务端生成,每次请求都会返回(若请求因其他原因未能抵达服务端,则该次请求不会获得 RequestId)。定位问题时需要提供该次请求的 RequestId。 */ RequestId?: string; } /** * ModifyApp请求参数结构体 */ export interface ModifyAppRequest { /** *应用ID
*/ AppId: string; /** *应用模式。枚举值: 1:标准模式, 2:Agent模式, 3:单工作流模式, 4:ClawAgent模式
*/ AppMode?: number; /** *应用头像
*/ Avatar?: string; /** *应用配置
*/ Config?: AppConfig; /** *应用描述
*/ Description?: string; /** *应用名称
*/ Name?: string; /** *引用的共享知识库ID列表(全量覆盖)
*/ SharedKbIdList?: Array字段掩码,指定需要更新的字段(Paths为空则不更新任何字段)。Paths枚举值:
【顶层】Name, Avatar, Description, AppMode, SharedKbIdList
【Greeting】Config.Greeting, Config.Greeting.Greeting, Config.Greeting.OpeningQuestionList
【Model】Config.Model, Config.Model.ThinkModel, Config.Model.GenerateModel, Config.Model.AiOptimizeModel, Config.Model.FileParseModel, Config.Model.PromptRewriteModel, Config.Model.MultiModalQaModel, Config.Model.MultiModalUnderstandingModel
【WebSearch】Config.WebSearch
【Memory】Config.Memory, Config.Memory.Enabled, Config.Memory.LongMemoryDay, Config.Memory.Model, Config.Memory.PromptMode, Config.Memory.PromptContent
【Mode】Config.Mode, Config.Mode.MultiAgentConfig, Config.Mode.SingleWorkflowConfig, Config.Mode.ClawAgentConfig
【Mode.ClawAgentConfig】Config.Mode.ClawAgentConfig.LongMemoryConfig, Config.Mode.ClawAgentConfig.AgentTeamConfig
【Experience】Config.Experience, Config.Experience.Conversation, Config.Experience.Role, Config.Experience.Advanced
【Experience.Conversation】Config.Experience.Conversation.AiCall, Config.Experience.Conversation.BackgroundImage, Config.Experience.Conversation.Method, Config.Experience.Conversation.FallbackReply, Config.Experience.Conversation.Recommended, Config.Experience.Conversation.InputBoxConfig, Config.Experience.Conversation.WebSearch
【Experience.Conversation.AiCall】Config.Experience.Conversation.AiCall.VoiceInteract, Config.Experience.Conversation.AiCall.VoiceCall, Config.Experience.Conversation.AiCall.DigitalHuman
【Experience.Advanced】Config.Experience.Advanced.ContextRewrite, Config.Experience.Advanced.ImageTextRetrieval, Config.Experience.Advanced.IntentAchievement, Config.Experience.Advanced.ReplyFlexibility, Config.Experience.Advanced.DialogCustomConfig
所属知识库 ID
*/ KbId: string; /** *待删除的 QA ID 列表(数量:1~20)
*/ QaIdList: Array工具的 UI 扩展元信息,对应 MCP 协议的 _meta.ui,声明工具关联的交互式界面资源(ResourceUri)及调用方可见性(Visibility)。仅当工具支持 MCP Apps 或声明了可见性时返回;纯文本工具该字段为空。详见 MCPToolUIMeta 结构定义。
*/ Ui?: MCPToolUIMeta; } /** * CreateSpace返回参数结构体 */ export interface CreateSpaceResponse { /** * 空间id */ SpaceId?: string; /** * 唯一请求 ID,由服务端生成,每次请求都会返回(若请求因其他原因未能抵达服务端,则该次请求不会获得 RequestId)。定位问题时需要提供该次请求的 RequestId。 */ RequestId?: string; } /** * 文档导入规格(一次性输入的非持久化数据) */ export interface DocImportSpec { /** *文件 ID(通过文件管理服务获取的文件标识,不可为空)
*/ FileId: string; /** *归属分类 ID
*/ CategoryId?: string; /** *重复文件处理规则列表
*/ DeDuplicateStrategyList?: Array知识生效作用域
| 枚举项 | 枚举值 | 描述 |
| KNOWLEDGE_EFFECTIVE_DOMAIN_UNKNOWN | 0 | |
| KNOWLEDGE_EFFECTIVE_DOMAIN_NONE | 1 | 停用 |
| KNOWLEDGE_EFFECTIVE_DOMAIN_DEV | 2 | 仅开发域 |
| KNOWLEDGE_EFFECTIVE_DOMAIN_RELEASE | 3 | 仅发布域 |
| KNOWLEDGE_EFFECTIVE_DOMAIN_ALL | 4 | 全域 |
过期策略(有效时间与超过有效时间后的行为)
注意:此字段可能返回 null,表示取不到有效值。 */ ExpirationPolicy?: ExpirationPolicy; /** *外部链接
注意:此字段可能返回 null,表示取不到有效值。 */ ExternalLink?: DocExternalLink; /** *适用范围(标签条件)
*/ LabelRefList?: Array解析配置(分割规则、内容过滤等)
注意:此字段可能返回 null,表示取不到有效值。 */ ParseConfig?: DocParseConfig; /** *开关配置
注意:此字段可能返回 null,表示取不到有效值。 */ Switch?: DocSwitch; /** *更新周期
注意:此字段可能返回 null,表示取不到有效值。 */ UpdatePeriod?: DocUpdatePeriod; /** *用户访问配置
注意:此字段可能返回 null,表示取不到有效值。 */ UserAccessConfig?: UserAccessConfig; } /** * CreateVariable请求参数结构体 */ export interface CreateVariableRequest { /** * app_id */ AppId: string; /** * 变量信息 */ Variable?: Variable; } /** * 消耗分类 */ export interface ConsumptionClassification { /** *消耗场景(如推理/训练/评测等)
*/ ConsumptionScene?: string; /** *消耗目标(如具体模型名/插件名/平台功能名)
*/ ConsumptionTarget?: string; /** *消耗类型,取值集合由业务方定义(如 model/plugin/platform 等)
*/ ConsumptionType?: string; /** *套餐包名称
*/ PackageName?: string; } /** * ExportQA请求参数结构体 */ export interface ExportQARequest { /** *所属知识库 ID
*/ KbId: string; /** *过滤条件(多个 Filter 之间为 AND 关系,同一 Filter 的多个 Values 为 OR 关系):Status-QA状态,枚举值,精确匹配; CategoryId-分类ID,精确匹配; SourceType-QA来源类型,枚举值,精确匹配; EffectiveDomain-生效作用域,精确匹配; DocId-关联文档ID,精确匹配; CreateTime-创建时间,Unix秒,BETWEEN 传 [起始秒,结束秒]; UpdateTime-更新时间,Unix秒,BETWEEN 传 [起始秒,结束秒]; QaId-QA ID列表,精确匹配,支持多值
*/ FilterList?: Array查询条件(关键词 + 查询范围),与 DescribeQASummaryList 保持一致
*/ Query?: QAQuery; } /** * DescribeSystemVariableList请求参数结构体 */ export interface DescribeSystemVariableListRequest { /** * 应用ID */ AppId: string; } /** * DescribeReleaseSummary返回参数结构体 */ export interface DescribeReleaseSummaryResponse { /** * 发布信息 */ ReleaseSummary?: ReleaseSummary; /** * 唯一请求 ID,由服务端生成,每次请求都会返回(若请求因其他原因未能抵达服务端,则该次请求不会获得 RequestId)。定位问题时需要提供该次请求的 RequestId。 */ RequestId?: string; } /** * QA 摘要信息 */ export interface QASummary { /** *所属分类路径(包含分类 ID、从根节点开始的分类 ID 路径和分类名称路径)
注意:此字段可能返回 null,表示取不到有效值。 */ CategoryPath?: CategoryPath; /** *知识生效范围
注意:此字段可能返回 null,表示取不到有效值。 */ KnowledgeScope?: KnowledgeScope; /** *生命周期信息
注意:此字段可能返回 null,表示取不到有效值。 */ Lifecycle?: QALifecycle; /** *元信息(问题/答案/大小统计)
注意:此字段可能返回 null,表示取不到有效值。 */ Metadata?: QAMetadata; /** *操作者信息
注意:此字段可能返回 null,表示取不到有效值。 */ OperatorInfo?: QAOperator; /** *QA ID
*/ QaId?: string; /** *相似问统计
注意:此字段可能返回 null,表示取不到有效值。 */ SimilarQuestion?: SimilarQuestionStat; /** *来源信息
注意:此字段可能返回 null,表示取不到有效值。 */ SourceInfo?: QASourceInfo; } /** * MCPToolConfig */ export interface MCPToolConfig { /** *输入参数
*/ Inputs?: Array输出参数
*/ Outputs?: Array工具meta信息
注意:此字段可能返回 null,表示取不到有效值。 */ Meta?: MCPToolMeta; /** *是否支持交互界面(MCP Apps),插件级标签 默认值:false
*/ SupportsApps?: boolean; } /** * DescribeKB返回参数结构体 */ export interface DescribeKBResponse { /** *关联的应用 ID 列表
*/ AppIdList?: Array容量信息
注意:此字段可能返回 null,表示取不到有效值。 */ CapacityInfo?: KBCapacity; /** *ES 配置
注意:此字段可能返回 null,表示取不到有效值。 */ EsConfig?: ESConfig; /** *模型配置
注意:此字段可能返回 null,表示取不到有效值。 */ ModelConfig?: KBModelConfig; /** *所有者信息
注意:此字段可能返回 null,表示取不到有效值。 */ Owner?: Operator; /** *知识库摘要信息
注意:此字段可能返回 null,表示取不到有效值。 */ Summary?: KBSummary; /** * 唯一请求 ID,由服务端生成,每次请求都会返回(若请求因其他原因未能抵达服务端,则该次请求不会获得 RequestId)。定位问题时需要提供该次请求的 RequestId。 */ RequestId?: string; } /** * SkillSummary 列表中的 Skill 摘要。 */ export interface SkillSummary { /** * 分类信息 注意:此字段可能返回 null,表示取不到有效值。 */ ClassificationInfo: SkillClassification; /** * 当前版本信息 注意:此字段可能返回 null,表示取不到有效值。 */ CurrentVersionInfo: SkillVersion; /** * 当前用户是否收藏 */ IsFavorite: boolean; /** * 基础信息 注意:此字段可能返回 null,表示取不到有效值。 */ Profile: SkillProfile; /** * Skill ID */ SkillId: string; /** * Skill 异常通知列表 */ NoticeList?: Array所属知识库 ID
*/ KbId: string; /** *标签 ID
*/ LabelId: string; /** *通用过滤
*/ FilterList?: Array滚动加载游标的标准词 ID(首次请求传 0,后续传上一页最后一条的 TermId)
*/ LastTermId?: string; /** *每次加载数量,默认 10,最大 100
*/ Limit?: number; /** *关键词搜索
*/ Query?: string; } /** * 企微机器人WebSocket接入配置 */ export interface WecomRobotWebsocketAccess { /** *绑定类型:1-扫码绑定,2-填写表单绑定
*/ BindType?: number; /** *企微机器人BotId
*/ BotId?: string; /** *企微机器人BotSecret
*/ BotSecret?: string; } /** * [数据结构定义] Agent协同配置 */ export interface AgentCollaborationConfig { /** * 协同方式。枚举值: 1:自由转交:Agent之间可自由传递任务, 2:工作流编排:基于预定义流程的协同, 3:Plan-and-Execute:规划与执行分离的协同模式 */ AgentCollaborationMode: number; /** * 工作流Id */ WorkflowId: string; /** * 工作流名称 */ WorkflowName: string; } /** * MsgRecordCategory */ export interface MsgRecordCategory { /** *分类的业务 ID
*/ CategoryId?: string; /** *子分类列表,树形嵌套
*/ Children?: Array分类名称
*/ Name?: string; /** *当前用户对该分类的操作权限
*/ Permission?: CategoryPermission; /** *该分类下消息记录的数量
*/ TotalCount?: string; } /** * 摘要列表查询通用开关配置 */ export interface SummaryListSwitch { /** *是否显示元数据
*/ ShowMetadataEnabled?: boolean; } /** * CheckLabel请求参数结构体 */ export interface CheckLabelRequest { /** *所属知识库 ID
*/ KbId: string; /** *待校验的标准词列表(数量:1~100)
*/ TermList: Array标签 ID(在指定标签下校验标准词唯一性)
*/ LabelId?: string; } /** * ModifySkill返回参数结构体 */ export interface ModifySkillResponse { /** * 唯一请求 ID,由服务端生成,每次请求都会返回(若请求因其他原因未能抵达服务端,则该次请求不会获得 RequestId)。定位问题时需要提供该次请求的 RequestId。 */ RequestId?: string; } /** * 角色配置 */ export interface RoleConfig { /** * 角色描述 */ RoleDescription: string; } /** * DescribeAuditLogList返回参数结构体 */ export interface DescribeAuditLogListResponse { /** *操作日志列表
*/ AuditLogList?: Arrayes查询起始位置
用于入参查询下一页
*/ SearchAfter?: Array资源类型,限定为 RESOURCE_TYPE_MODEL / RESOURCE_TYPE_PLUGIN
| 枚举项 | 枚举值 | 描述 |
| RESOURCE_TYPE_UNSPECIFIED | 0 | |
| RESOURCE_TYPE_MODEL | 1 | 模型用量 |
| RESOURCE_TYPE_PLUGIN | 2 | 插件用量 |
| RESOURCE_TYPE_PLATFORM | 3 | 平台功能用量 |
| RESOURCE_TYPE_MODEL_CONCURRENCY | 4 | 模型并发超限 |
| RESOURCE_TYPE_KB_CAPACITY | 5 | 知识库容量 |
| RESOURCE_TYPE_USAGE_SUMMARY | 6 | 用量汇总 |
| RESOURCE_TYPE_RESOURCE_CONSUME | 7 | 资源消耗(计费明细) |
查询时间范围(Unix 秒)
*/ TimeRange: TimeRange; /** *视图范围:企业视图 / 空间视图 / 应用视图
*/ ViewScope: ViewScope; /** *扩展过滤(resource_type=MODEL)。Filter 组合规则:多项 AND,同项 value_list OR。支持 Name:model_name、user_id、space_id、resource_id/source_id、metric_source_type(METRIC_SOURCE_TYPE_* 或整数)、call_type(调用类型)
*/ FilterList?: Array页码,从 0 开始
*/ PageNumber?: number; /** *每页数量,最大 100
*/ PageSize?: number; } /** * DescribeUsageSummaryList返回参数结构体 */ export interface DescribeUsageSummaryListResponse { /** *总记录数,用于前端分页
*/ TotalCount?: string; /** *资源用量聚合明细列表
*/ UsageSummaryList?: Array应用详情
*/ App?: App; /** * 唯一请求 ID,由服务端生成,每次请求都会返回(若请求因其他原因未能抵达服务端,则该次请求不会获得 RequestId)。定位问题时需要提供该次请求的 RequestId。 */ RequestId?: string; } /** * DescribeAuditLogMeta请求参数结构体 */ export type DescribeAuditLogMetaRequest = null; /** * DeleteApp请求参数结构体 */ export interface DeleteAppRequest { /** *app_id
*/ AppId: string; /** *删除原因(非必填,审批时展示)
*/ Reason?: string; } /** * DescribeAppSummaryList返回参数结构体 */ export interface DescribeAppSummaryListResponse { /** * 应用摘要列表 */ AppSummaryList?: Array是否开启长期记忆
*/ Enabled?: boolean; } /** * FavoritePlugin请求参数结构体 */ export interface FavoritePluginRequest { /** *插件id
*/ PluginId: string; /** *当前空间id
*/ SpaceId: string; } /** * 知识片段基础信息 */ export interface KnowledgeSnippetProfile { /** *内容
*/ Content?: string; /** *关联文档 ID
*/ DocId?: string; /** *文档名
*/ DocName?: string; /** *知识库 ID
*/ KbId?: string; /** *知识 ID
*/ KnowledgeId?: string; /** *问题
*/ Question?: string; /** *文档标题
*/ Title?: string; } /** * 内容过滤配置(图片名称正则/最小宽高),缺省时不启用过滤 */ export interface ContentFilter { /** *图片最小高度(像素),小于则过滤;<=0 表示不启用
*/ ImageMinHeight?: number; /** *图片最小宽度(像素),小于则过滤;<=0 表示不启用
*/ ImageMinWidth?: number; /** *图片名称过滤规则(用分号 ';' 分隔的多条正则,如 'icon;notice;warning;info.*')
*/ ImageNamePatterns?: string; } /** * ImportDocList返回参数结构体 */ export interface ImportDocListResponse { /** *批量导入结果
*/ ResultList?: Array工具配置字段
*/ Config?: AgentToolBasicConfig; /** *工具名称
*/ Name?: string; /** *工具状态
枚举值:
调用方式
枚举值:
工具访问模式
枚举值:
SkillId
*/ SkillId: string; /** *空间ID
*/ SpaceId: string; /** *版本ID
*/ VersionId: string; } /** * DescribeVariable请求参数结构体 */ export interface DescribeVariableRequest { /** * app_id */ AppId: string; /** * variable_id */ VariableId: string; /** * module_type。枚举值: 1:环境参数, 2:应用参数, 3:系统参数, -1:所有参数 */ ModuleType?: number; } /** * 资源调用时序明细 */ export interface UsageDetail { /** *调用来源
*/ CallSource?: CallSource; /** *计量 ID,用于对账/回溯
*/ DosageId?: string; /** *调用时间戳(Unix 秒)
*/ EventTime?: string; /** *MODEL 域专属
*/ Model?: ModelUsageDetail; /** *PLUGIN 域专属
*/ Plugin?: PluginUsageDetail; /** *调用链路追踪 ID
*/ TraceId?: string; /** *用户 ID
*/ UserId?: string; } /** * 微信ClawBot渠道配置 */ export interface WechatClawBotChannelConfig { /** *ClawBot机器人ID(扫码后回填)
*/ BotId?: string; /** *ClawBot机器人Token(扫码后回填)
*/ BotToken?: string; /** *二维码状态(wait/confirmed/expired)
*/ QrcodeStatus?: string; /** *二维码URL(创建后回填)
*/ QrcodeUrl?: string; /** *微信用户ID(扫码后回填)
*/ WechatUserId?: string; } /** * 操作日志 */ export interface AuditLog { /** *员工信息
*/ AccountInfo?: AccountInfo; /** *应用业务id
*/ AppId?: string; /** *应用名称
操作日志触发时的名称
*/ AppName?: string; /** *操作时间
参数格式:秒时间戳
*/ OperateTime?: string; /** *操作类型
*/ Action?: string; /** *操作对象
*/ Biz?: string; /** *操作内容
*/ Content?: string; /** *操作唯一ID
*/ UniqueId?: string; } /** * UnfavoriteSkill请求参数结构体 */ export interface UnfavoriteSkillRequest { /** *SkillId
*/ SkillId: string; /** *空间ID
*/ SpaceId: string; } /** * DescribeConversation返回参数结构体 */ export interface DescribeConversationResponse { /** *应用 ID
*/ AppId?: string; /** *会话 ID
*/ ConversationId?: string; /** *创建时间
*/ CreateTime?: string; /** *会话类型 枚举值: 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(分享链接)
*/ Type?: number; /** *更新时间
*/ UpdateTime?: string; /** *工作空间
注意:此字段可能返回 null,表示取不到有效值。 */ Workspace?: ConversationWorkspace; /** *会话标题
*/ Title?: string; /** *会话使用的用户端 AgentId
*/ AgentId?: string; /** * 唯一请求 ID,由服务端生成,每次请求都会返回(若请求因其他原因未能抵达服务端,则该次请求不会获得 RequestId)。定位问题时需要提供该次请求的 RequestId。 */ RequestId?: string; } /** * AppTrigger */ export interface AppTrigger { /** *应用ID
*/ AppId?: string; /** *执行配置
*/ ExecuteConfig?: ExecuteConfig; /** *| 枚举项 | 枚举值 | 描述 |
| APP_TRIGGER_EXECUTE_TYPE_UNSPECIFIED | 0 | 未指定 |
| APP_TRIGGER_EXECUTE_TYPE_PROMPT | 1 | 指令执行 |
| APP_TRIGGER_EXECUTE_TYPE_WORKFLOW | 2 | 工作流执行 |
失败次数
*/ FailedCount?: string; /** *推送渠道配置
*/ PushConfig?: TimerPushConfig; /** *| 枚举项 | 枚举值 | 描述 |
| APP_TRIGGER_SCOPE_UNSPECIFIED | 0 | 未指定 |
| APP_TRIGGER_SCOPE_APP | 1 | B 端管理员 |
| APP_TRIGGER_SCOPE_USER | 2 | C 端访客 |
| 枚举项 | 枚举值 | 描述 |
| APP_TRIGGER_STATUS_UNSPECIFIED | 0 | 未指定 |
| APP_TRIGGER_STATUS_ENABLED | 1 | 启用 |
| APP_TRIGGER_STATUS_PAUSED | 2 | 暂停 |
| APP_TRIGGER_STATUS_DELETED | 3 | 已删除 |
成功次数
*/ SuccessCount?: string; /** *触发器配置
*/ TriggerConfig?: TriggerConfig; /** *触发器ID
*/ TriggerId?: string; /** *触发器名称
*/ TriggerName?: string; /** *触发器状态
*/ TriggerStatus?: TriggerStatus; /** *| 枚举项 | 枚举值 | 描述 |
| APP_TRIGGER_TYPE_UNSPECIFIED | 0 | 未指定 |
| APP_TRIGGER_TYPE_SCHEDULED | 1 | 定时触发 |
| APP_TRIGGER_TYPE_WEBHOOK | 2 | Webhook 触发 |
访客ID
*/ UserId?: string; } /** * DescribeAgentSummaryList返回参数结构体 */ export interface DescribeAgentSummaryListResponse { /** *总数
*/ TotalCount?: number; /** *Agent摘要信息
*/ AgentList?: Array知识库 ID
*/ KbId: string; /** *工作空间 ID
*/ SpaceId?: string; } /** * SkillVersion Skill 版本信息。 */ export interface SkillVersion { /** *检测信息
注意:此字段可能返回 null,表示取不到有效值。 */ AnalysisInfo: SkillAnalysisInfo; /** *当前生效版本号
*/ Version: string; /** *当前生效版本ID
*/ VersionId: string; /** *Skill 版本发布流程状态:
- 0 INITIALIZED 初始化(版本初始态) - 1 AUDITING 审核中(f_analysis_status ∈ {PENDING, RUNNING}) - 2 PENDING_RELEASE 待发布(低/中风险,等用户确认上架) - 3 RELEASED 已发布 - 4 UNRELEASED 未发布(HIGH / UNAVAILABLE / FAILED / 用户放弃,含历史"不通过"语义)与 SkillAnalysisStatus 解耦:前者是用户视角发布生命周期,后者是安全检测阶段。
*/
VersionStatus?: number;
/**
* Skill包的md5信息
*/ SkillMd5?: string; /** *版本包地址
*/ SkillUrl?: string; /** *版本创建时间(Unix秒)
*/ CreateTime?: string; /** *skill md文档
*/ SkillMarkdownUrl?: string; /** *版本变更说明
*/ UpdateDesc?: string; /** *变更用户
*/ Updater?: string; } /** * 模式配置 - 包含不同模式的独有配置 */ export interface AppModeConfig { /** * 多智能体配置(Agent模式) 注意:此字段可能返回 null,表示取不到有效值。 */ MultiAgentConfig: MultiAgentConfig; /** * 单工作流配置(单工作流模式) 注意:此字段可能返回 null,表示取不到有效值。 */ SingleWorkflowConfig: SingleWorkflowConfig; /** * ClawAgent配置(ClawAgent模式) 注意:此字段可能返回 null,表示取不到有效值。 */ ClawAgentConfig?: ClawAgentConfig; } /** * DescribeMsgRecordList返回参数结构体 */ export interface DescribeMsgRecordListResponse { /** *是否有更多页
*/ HasMore?: boolean; /** *消息记录列表
*/ MsgRecordList?: Array下一页游标信息
*/ NextCursor?: string; /** *上一页游标信息
*/ PrevCursor?: string; /** *符合条件的总记录数,用于前端分页显示
*/ TotalCount?: string; /** * 唯一请求 ID,由服务端生成,每次请求都会返回(若请求因其他原因未能抵达服务端,则该次请求不会获得 RequestId)。定位问题时需要提供该次请求的 RequestId。 */ RequestId?: string; } /** * Tool */ export interface Tool { /** *工具计费信息
注意:此字段可能返回 null,表示取不到有效值。 */ Billing?: ToolBilling; /** *工具调用次数
单位:次数
*/ CallCount?: number; /** *工具描述信息
*/ Description?: string; /** *工具名称
*/ Name?: string; /** *插件ID
*/ PluginId?: string; /** *| 枚举项 | 枚举值 | 描述 |
| TOOL_ACCESS_MODE_UNKNOWN | 0 | 未指定 |
| TOOL_ACCESS_MODE_READ_ONLY | 1 | 只读 |
| TOOL_ACCESS_MODE_WRITE_DELETE | 2 | 写/删除 |
工具配置信息
注意:此字段可能返回 null,表示取不到有效值。 */ ToolConfig?: ToolConfig; /** *工具ID
*/ ToolId?: string; } /** * 模型资源用量聚合明细(MODEL 域专属) */ export interface ModelUsageSummary { /** *调用次数(业务调用维度的顶层计数)
*/ CallCount?: number; /** *是否默认知识库
*/ IsDefaultKB?: boolean; /** *模型名称,标识使用的 AI 模型
*/ ModelName?: string; /** *MODEL 域消耗计量列表(权威字段):按单位+label 分项列出每类计量。unit=TOKEN 时 label 区分 Token 子类别(input/output/avg_* /cache_*),label 为空表示 total_tokens;unit=PAGE_COUNT 表示模型消耗页数
*/ ResourceConsumptionList?: Array模型消耗 PU 总量(聚合维度内的 PU 消耗之和)
*/ ConsumptionPU?: number; } /** * DescribeQA返回参数结构体 */ export interface DescribeQAResponse { /** *分片高亮信息
*/ HighlightList?: Array分片内容
*/ PageContent?: string; /** *问题描述
*/ QuestionDescription?: string; /** *相似问列表
*/ SimilarQuestionList?: Array基础信息
注意:此字段可能返回 null,表示取不到有效值。 */ Summary?: QASummary; /** * 唯一请求 ID,由服务端生成,每次请求都会返回(若请求因其他原因未能抵达服务端,则该次请求不会获得 RequestId)。定位问题时需要提供该次请求的 RequestId。 */ RequestId?: string; } /** * DescribeVariableList返回参数结构体 */ export interface DescribeVariableListResponse { /** * total_count */ TotalCount?: number; /** * variable_list */ VariableList?: Array标签 ID
*/ LabelId?: string; /** *标签名称
*/ LabelName?: string; /** *标签标准词 ID 列表
*/ LabelTermIdList?: Array标签标准词列表
*/ LabelTermList?: Array修改字段内容(与 update_mask 配合使用)
*/ Fields: QAModifyFields; /** *所属知识库 ID
*/ KbId: string; /** *QA ID
*/ QaId: string; /** *字段掩码:指定要修改的字段(支持的 Paths:Question, Answer, CategoryId, DocId, LabelRefList, QuestionDescription, ExpirationPolicy, SimilarQuestionList, EffectiveDomain, IsAccepted)
*/ UpdateMask: FieldMask; } /** * 标签摘要 */ export interface LabelSummary { /** *标签 ID
*/ LabelId?: string; /** *元数据配置(该标签被设置为元数据时的配置信息)
注意:此字段可能返回 null,表示取不到有效值。 */ MetaValue?: MetaValue; /** *标签名称
*/ Name?: string; /** *引用该标签的资源数
*/ RefCount?: number; /** *标签值(标准词 + 同义词列表)
*/ TermList?: Array标签值总数
*/ TermTotalCount?: number; } /** * DescribeReleaseList请求参数结构体 */ export interface DescribeReleaseListRequest { /** * 应用ID */ AppId: string; /** * 页码(从0开始) */ PageNumber?: number; /** * 每页数量(最大值:100) */ PageSize?: number; } /** * ModifySpace返回参数结构体 */ export interface ModifySpaceResponse { /** * 唯一请求 ID,由服务端生成,每次请求都会返回(若请求因其他原因未能抵达服务端,则该次请求不会获得 RequestId)。定位问题时需要提供该次请求的 RequestId。 */ RequestId?: string; } /** * Reference 参考来源信息 */ export interface ConversationReference { /** *参考来源索引
*/ Index: number; /** *参考来源名称
*/ Name: string; /** *参考来源类型 枚举值: 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)
*/ Type: number; } /** * MsgRecord */ export interface MsgRecord { /** * 答案 */ Answer?: string; /** * 应用ID */ AppId?: string; /** * 分类ID */ CategoryId?: string; /** * 创建时间 */ CreateTime?: string; /** * 意图 */ Intent?: string; /** * 意图分类 */ IntentCategory?: string; /** * 是否是智能分类 */ IsSmart?: boolean; /** * 问题 */ Question?: string; /** * 记录ID */ RecordId?: string; /** * 表示消息的回复方式,枚举 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=智能体结构化输出。 */ ReplyMethod?: number; /** * 返回结果 */ Result?: MsgRecordResult; /** * 分数 */ Score?: number; /** * 会话ID */ SessionId?: string; /** * 来源 */ Source?: MsgRecordSource; /** * trace_id */ TraceId?: string; } /** * 标签可修改字段集合(配合 update_mask 使用) */ export interface LabelModifyFields { /** *标签名称
*/ Name?: string; /** *标准词增量修改列表(增/改/删)
*/ TermModifyList?: Array应用 ID
*/ AppId: string; /** *待删除的分类业务 ID
*/ CategoryId: string; } /** * 文档操作者信息 */ export interface DocOperator { /** *修改人
注意:此字段可能返回 null,表示取不到有效值。 */ Modifier?: Operator; /** *操作权限
注意:此字段可能返回 null,表示取不到有效值。 */ Permission?: DocPermission; } /** * DescribeDocSummaryList请求参数结构体 */ export interface DescribeDocSummaryListRequest { /** *所属知识库 ID
*/ KbId: string; /** *过滤条件(多个 Filter 之间为 AND 关系,同一 Filter 的多个 Values 为 OR 关系):Status-文档状态,枚举值,精确匹配; CategoryId-分类ID,精确匹配; SourceType-文档来源类型,枚举值,精确匹配; EffectiveDomain-生效作用域,精确匹配; CreateTime-创建时间,Unix秒,BETWEEN 传 [起始秒,结束秒]; UpdateTime-更新时间,Unix秒,BETWEEN 传 [起始秒,结束秒]
*/ FilterList?: Array分页页码,从 0 开始
*/ PageNumber?: number; /** *每页数量,默认 10,最大 100
*/ PageSize?: number; /** *查询条件(关键词 + 查询范围)
*/ Query?: DocQuery; /** *开关配置
*/ SummaryListSwitch?: SummaryListSwitch; } /** * ModifyMsgRecordCategory返回参数结构体 */ export interface ModifyMsgRecordCategoryResponse { /** * 唯一请求 ID,由服务端生成,每次请求都会返回(若请求因其他原因未能抵达服务端,则该次请求不会获得 RequestId)。定位问题时需要提供该次请求的 RequestId。 */ RequestId?: string; } /** * UnfavoritePlugin请求参数结构体 */ export interface UnfavoritePluginRequest { /** *插件id
*/ PluginId: string; /** *当前空间id
*/ SpaceId: string; } /** * Agent 配置里面的模型定义 */ export interface AgentModelConfig { /** *模型唯一id
*/ ModelId?: string; /** *模型别名
*/ Alias?: string; /** *模型上下文长度字符限制
*/ ContextWordsLimit?: number; /** *指令长度字符限制
*/ InstructionsWordsLimit?: number; /** *模型参数
注意:此字段可能返回 null,表示取不到有效值。 */ ModelParameters?: ModelParams; } /** * 模型调用明细 */ export interface ModelUsageDetail { /** *调用类型,来源于计费 scene_billing(与 filter.call_type 对应)
*/ CallType?: string; /** *是否默认知识库
*/ IsDefaultKB?: boolean; /** *模型名称
*/ ModelName?: string; /** *MODEL 域单次调用的消耗计量列表(权威字段):按单位+label 分项列出每类计量。unit=TOKEN 时 label 区分 Token 子类别(input/output/avg_* /cache_*),label 为空表示 total_tokens;unit=PAGE_COUNT 表示模型消耗页数
*/ ResourceConsumptionList?: Array本次调用消耗 PU 量
*/ ConsumptionPU?: number; } /** * ModifyQAList请求参数结构体 */ export interface ModifyQAListRequest { /** *所属知识库 ID
*/ KbId: string; /** *待修改的 QA ID 列表(数量:1~20)
*/ QaIdList: Array分类 ID
*/ CategoryId?: string; /** *生效作用域
| 枚举项 | 枚举值 | 描述 |
| KNOWLEDGE_EFFECTIVE_DOMAIN_UNKNOWN | 0 | |
| KNOWLEDGE_EFFECTIVE_DOMAIN_NONE | 1 | 停用 |
| KNOWLEDGE_EFFECTIVE_DOMAIN_DEV | 2 | 仅开发域 |
| KNOWLEDGE_EFFECTIVE_DOMAIN_RELEASE | 3 | 仅发布域 |
| KNOWLEDGE_EFFECTIVE_DOMAIN_ALL | 4 | 全域 |
过期策略(有效时间与超过有效时间后的行为)
*/ ExpirationPolicy?: ExpirationPolicy; /** *是否采纳(校验通过)
*/ IsAccepted?: boolean; /** *适用范围(标签条件列表)
*/ LabelRefList?: LabelRefIdentityList; } /** * CreateConversation返回参数结构体 */ export interface CreateConversationResponse { /** *会话 ID
*/ ConversationId?: string; /** * 唯一请求 ID,由服务端生成,每次请求都会返回(若请求因其他原因未能抵达服务端,则该次请求不会获得 RequestId)。定位问题时需要提供该次请求的 RequestId。 */ RequestId?: string; } /** * DescribeSkillDetail请求参数结构体 */ export interface DescribeSkillDetailRequest { /** * skillID */ SkillId: string; /** * 空间ID */ SpaceId: string; /** * 版本过滤条件(多个Filter之间为AND关系,同一Filter的多个Values为OR关系): - Perspective: 视角枚举,字符串单值,Values 长度必须为 1,多值视为非法;仅作用于详情返回的 version_list 裁剪,不决定接口本身可见性;不传默认 USER (USER=使用者视角,version_list 仅返回已上线版本 / EDITOR=编辑者视角,version_list 返回全部存活版本 / ALL=全量视角,同 EDITOR) */ VersionFilterList?: Array默认文件名称
*/ DefaultFileName: string; /** *默认值
*/ DefaultValue: string; /** *变量描述
*/ Description: string; /** *变量模块类型
枚举值:
变量名称
*/ Name: string; /** *变量类型
枚举值:
变量ID
*/ VariableId: string; /** *是否启用网络策略(仅环境变量生效)
*/ EnableEndpoints?: boolean; /** *网络策略列表(支持: 精确域名、*.通配子域名、可带协议/端口/路径前缀)
*/ EndpointList?: Array是否内置变量
*/ IsBuiltin?: boolean; /** *是否可注入到沙箱环境
*/ EnableSandbox?: boolean; } /** * 时效性检索增强配置 */ export interface ExpirationAwareness { /** *是否启用时效性检索,开启后检索结果会结合知识的有效时间进行排序
*/ Enabled?: boolean; } /** * 企微机器人回调接入配置 */ export interface WecomRobotCallbackAccess { /** *回调配置
*/ Callback?: CallbackConfig; /** *机器人名称
*/ RobotName?: string; /** *企微企业ID
*/ WecomCorpId?: string; /** *企微机器人ID
*/ WecomRobotId?: string; } /** * FavoriteSkill请求参数结构体 */ export interface FavoriteSkillRequest { /** *SkillId
*/ SkillId: string; /** *空间ID
*/ SpaceId: string; } /** * 应用引用的共享知识库简要信息(查询时仅返回ID和名称) */ export interface AppSharedKbInfo { /** * 共享知识库ID */ KbId: string; /** * 共享知识库名称 */ KbName: string; } /** * ModifyMsgRecordCategory请求参数结构体 */ export interface ModifyMsgRecordCategoryRequest { /** *应用 ID
*/ AppId: string; /** *待修改的分类业务 ID
*/ CategoryId: string; /** *修改后的分类名称
*/ Name: string; } /** * ResetConversation返回参数结构体 */ export interface ResetConversationResponse { /** * 唯一请求 ID,由服务端生成,每次请求都会返回(若请求因其他原因未能抵达服务端,则该次请求不会获得 RequestId)。定位问题时需要提供该次请求的 RequestId。 */ RequestId?: string; } /** * DailySchedule */ export interface DailySchedule { /** * 时间 */ TimeOfDay?: string; } /** * Prompt改写配置 */ export interface PromptRewriteModel { /** * 模型配置 注意:此字段可能返回 null,表示取不到有效值。 */ Model: ModelDetailInfo; } /** * ManualOnlySchedule */ export interface ManualOnlySchedule { /** * 启用 */ Enabled?: boolean; } /** * ModifySpace请求参数结构体 */ export interface ModifySpaceRequest { /** * 工作空间名称,长度最大30个字符 */ Name?: string; /** * 空间描述,长度最大150个字符 */ Description?: string; /** * 空间id */ SpaceId?: string; /** * 指定需要更新的字段,支持Name和Description */ FieldMask?: FieldMask; } /** * DescribePluginSummaryList请求参数结构体 */ export interface DescribePluginSummaryListRequest { /** *空间ID,查询空间内的插件列表时使用
*/ SpaceId: string; /** *过滤条件列表,支持 PluginKind、CategoryKey、PluginSource、PluginId、PluginClass、BillingType、AuthType、IsShared、IsCreatedByMe
*/ FilterList?: Array是否只返回已收藏插件。取 true 时,仅返回当前用户已收藏的插件;取 false 或不传时不按收藏状态过滤。
*/ IsFavoriteOnly?: boolean; /** *插件展示场景。不传或取 0 时不限定场景。
枚举值:
页码 从0开始
*/ PageNumber?: number; /** *每页大小
*/ PageSize?: number; /** *查询内容 模糊匹配:插件名称/插件描述/工具名称/工具描述
*/ Query?: string; /** *排序方式。
枚举值:
筛选当前空间/企业共享插件
取值范围:[0, 2]
*/ PluginSpaceRelation?: number; } /** * CreateApp返回参数结构体 */ export interface CreateAppResponse { /** * app_id */ AppId?: string; /** * 唯一请求 ID,由服务端生成,每次请求都会返回(若请求因其他原因未能抵达服务端,则该次请求不会获得 RequestId)。定位问题时需要提供该次请求的 RequestId。 */ RequestId?: string; } /** * 知识库修改扩展字段(用于触发特殊操作) */ export interface KBModifyExtendFields { /** *扩展操作:1=触发恢复超量
| 枚举项 | 枚举值 | 描述 |
| KB_EXTENDED_ACTION_UNKNOWN | 0 | |
| KB_EXTENDED_ACTION_RESUME_EXCEEDED | 1 | 触发恢复超量(将知识库从超量状态恢复为正常状态) |
置信度阈值
*/ Confidence?: number; /** *是否启用
*/ Enabled?: boolean; /** *返回前 N 条
*/ TopN?: number; } /** * 操作日志元数据 */ export interface AuditLogMetaField { /** *操作日志元数据key
*/ Key?: string; /** *操作日志元数据Name
*/ Name?: string; } /** * CreateQAList返回参数结构体 */ export interface CreateQAListResponse { /** *批量创建结果
*/ ResultList?: Array作者标识
*/ Name?: string; /** *作者显示名称
*/ Alias?: string; } /** * ModifySkill请求参数结构体 */ export interface ModifySkillRequest { /** *SkillId
*/ SkillId: string; /** *空间ID
*/ SpaceId: string; /** *skill描述
*/ DisplayDescription?: string; /** *skill名称
*/ DisplayName?: string; /** *skill包文件地址(zip);传入则触发新版本生成,需与SkillVersion、UpdateDescription配套传入
*/ FileUrl?: string; /** *图标地址
*/ IconUrl?: string; /** *skill版本号(与FileUrl配套传入)
*/ SkillVersion?: string; /** *版本变更说明(与FileUrl配套传入)
*/ UpdateDescription?: string; } /** * 体验配置 */ export interface AppExperienceConfig { /** * 高级配置 注意:此字段可能返回 null,表示取不到有效值。 */ Advanced: AppAdvancedConf; /** * 对话体验配置 注意:此字段可能返回 null,表示取不到有效值。 */ Conversation: ConversationExperience; /** * 角色配置 注意:此字段可能返回 null,表示取不到有效值。 */ Role: RoleConfig; } /** * ResumeAppTrigger请求参数结构体 */ export interface ResumeAppTriggerRequest { /** *应用ID
*/ AppId?: string; /** *| 枚举项 | 枚举值 | 描述 |
| APP_TRIGGER_SCOPE_UNSPECIFIED | 0 | 未指定 |
| APP_TRIGGER_SCOPE_APP | 1 | B 端管理员 |
| APP_TRIGGER_SCOPE_USER | 2 | C 端访客 |
应用触发器ID
*/ TriggerId?: string; /** *访客ID
*/ UserId?: string; } /** * QA 操作者信息 */ export interface QAOperator { /** *修改人
注意:此字段可能返回 null,表示取不到有效值。 */ Modifier?: Operator; /** *操作权限
注意:此字段可能返回 null,表示取不到有效值。 */ Permission?: QAPermission; } /** * 标签引用列表 */ export interface LabelRefIdentityList { /** *标签引用列表
*/ ItemList?: Array应用ID
*/ AppId: string; /** *应用分享访问控制配置
*/ AppShareAccessControl?: AppShareAccessControl; /** *渠道ID列表
*/ ChannelIdList?: Array企业共享配置
*/ CorpShareConfig?: CorpShareConfig; /** *发布描述
*/ Description?: string; /** *将默认知识库中,仅调试生效的知识批量变更为"调试/发布都生效"
*/ IsDevToRelease?: boolean; /** *是否同步发布为应用模板
*/ IsPublishAsTemplate?: boolean; } /** * CreateWorkspaceCredential请求参数结构体 */ export interface CreateWorkspaceCredentialRequest { /** *会话类型 枚举值: 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(分享链接)
*/ Type: number; /** *工作空间 ID
*/ WorkspaceId: string; /** *应用 ID
*/ AppId?: string; /** *Type=CONVERSATION_TYPE_API 时必填,应用密钥
*/ AppKey?: string; /** *子用户Uin
*/ LoginSubAccountUin?: string; /** *主用户Uin
*/ LoginUin?: string; /** *Type=CONVERSATION_TYPE_SHARE 时必填,分享码
*/ ShareCode?: string; /** *Type=CONVERSATION_TYPE_API 时必填,访客ID
*/ UserId?: string; } /** * ModifyAppTrigger请求参数结构体 */ export interface ModifyAppTriggerRequest { /** *应用ID
*/ AppId?: string; /** *| 枚举项 | 枚举值 | 描述 |
| APP_TRIGGER_SCOPE_UNSPECIFIED | 0 | 未指定 |
| APP_TRIGGER_SCOPE_APP | 1 | B 端管理员 |
| APP_TRIGGER_SCOPE_USER | 2 | C 端访客 |
触发器信息
*/ Trigger?: AppTrigger; /** *触发器唯一ID
*/ TriggerId?: string; /** *修改字段
*/ UpdateMask?: FieldMask; /** *访客ID
*/ UserId?: string; } /** * DescribeAppTriggerSummaryList返回参数结构体 */ export interface DescribeAppTriggerSummaryListResponse { /** *应用触发器数量
*/ TotalCount?: string; /** *应用触发器列表
*/ TriggerList?: Array知识库 ID
*/ KbId: string; /** *工作空间 ID
*/ SpaceId?: string; } /** * CreateAgent请求参数结构体 */ export interface CreateAgentRequest { /** *应用Id
*/ AppId: string; /** *Agent 配置
*/ Agent?: AgentSpec; /** *Agent 类型,区分 B 端配置态 Agent 与 C 端用户态 Agent
枚举值:
插件id
*/ PluginId: string; /** *登录用户主账号(集成商模式必填)
*/ LoginUin?: string; /** *登录用户子账号(集成商模式必填)
*/ LoginSubAccountUin?: string; } /** * AI一键优化模型配置 */ export interface AIOptimizeModel { /** * 模型配置 注意:此字段可能返回 null,表示取不到有效值。 */ Model: ModelDetailInfo; } /** * 检索过滤配置 */ export interface SearchFilterConfig { /** *是否仅检索选中标签,true:仅检索带有选中标签的知识,false:同时检索带有选中标签和不带任何标签的知识
*/ OnlyRetrievalSelectedLabel?: boolean; /** *检索过滤
注意:此字段可能返回 null,表示取不到有效值。 */ SearchFilter?: SearchFilter; } /** * CreateSimilarQuestion请求参数结构体 */ export interface CreateSimilarQuestionRequest { /** *所属知识库 ID
*/ KbId: string; /** *问题
*/ Question: string; /** *答案
*/ Answer?: string; } /** * 单个知识库检索配置 */ export interface KBRetrievalConfig { /** *数据库检索配置
注意:此字段可能返回 null,表示取不到有效值。 */ DbRetrievalConfig?: DBRetrievalConfig; /** *文档检索配置
注意:此字段可能返回 null,表示取不到有效值。 */ DocRetrievalConfig?: DocRetrievalConfig; /** *知识库 ID
*/ KbId?: string; /** *检索可选配置
注意:此字段可能返回 null,表示取不到有效值。 */ OptionConfig?: RetrievalOption; /** *QA 检索配置
注意:此字段可能返回 null,表示取不到有效值。 */ QaRetrievalConfig?: QARetrievalConfig; /** *rerank 配置
注意:此字段可能返回 null,表示取不到有效值。 */ RerankConfig?: RerankConfig; /** *检索过滤配置
注意:此字段可能返回 null,表示取不到有效值。 */ SearchFilterConfig?: SearchFilterConfig; /** *检索策略:1=混合,2=语义,3=关键词,4=无
| 枚举项 | 枚举值 | 描述 |
| SEARCH_STRATEGY_TYPE_UNKNOWN | 0 | |
| SEARCH_STRATEGY_TYPE_MIXING | 1 | 混合检索 |
| SEARCH_STRATEGY_TYPE_SEMANTIC | 2 | 语义检索 |
| SEARCH_STRATEGY_TYPE_KEYWORD | 3 | 关键词检索 |
| SEARCH_STRATEGY_TYPE_NONE | 4 | 无语义/向量检索 |
text2sql 模型
注意:此字段可能返回 null,表示取不到有效值。 */ TextToSqlModel?: ModelDetailInfo; } /** * skill详情 */ export interface SkillDetail { /** * 调用情况摘要 */ ReferenceSummaryList?: Arrayplugin_list
*/ PluginList?: Arraytotal_count
*/ TotalCount?: number; /** * 唯一请求 ID,由服务端生成,每次请求都会返回(若请求因其他原因未能抵达服务端,则该次请求不会获得 RequestId)。定位问题时需要提供该次请求的 RequestId。 */ RequestId?: string; } /** * 应用子状态信息 */ export interface AppSubStatusInfo { /** * 审批记录ID (当sub_status_list包含PUBLISH_APPROVING时有效) */ ApprovalId: string; /** * 应用子状态列表 (可能同时处于多个子状态) */ SubStatusList?: Array视图类型;枚举值:VIEW_TYPE_CORP(1) 企业视图、VIEW_TYPE_SPACE(2) 空间视图、VIEW_TYPE_APP(3) 应用视图
| 枚举项 | 枚举值 | 描述 |
| VIEW_TYPE_UNSPECIFIED | 0 | 未指定(无效值,请求勿传) |
| VIEW_TYPE_CORP | 1 | 企业视图 |
| VIEW_TYPE_SPACE | 2 | 空间视图 |
| VIEW_TYPE_APP | 3 | 应用视图 |
视图范围 ID;VIEW_TYPE_CORP 留空;VIEW_TYPE_SPACE 填 space_id;VIEW_TYPE_APP 填 app_id(uint64 雪花 ID 的十进制字符串)
*/ ScopeId?: string; } /** * CreateConversation请求参数结构体 */ export interface CreateConversationRequest { /** *会话类型 枚举值: 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(分享链接)
*/ Type: number; /** *应用 ID
*/ AppId?: string; /** *Type=CONVERSATION_TYPE_API 时必填,应用密钥
*/ AppKey?: string; /** *登录用户子账号(集成商模式必填)
*/ LoginSubAccountUin?: string; /** *登录用户主账号(集成商模式必填)
*/ LoginUin?: string; /** *Type=CONVERSATION_TYPE_SHARE 时必填,分享码
*/ ShareCode?: string; /** *Type=CONVERSATION_TYPE_API 时必填,访客ID
*/ UserId?: string; /** *用户端 AgnetId,当Claw模式开启了“允许在对话中动态修改配置”时可用
*/ AgentId?: string; } /** * 调用方执行的 Function Tool 配置 */ export interface AgentExternalToolConfig { /** *工具类型
入参限制:目前仅支持 "function"
*/ Type?: string; /** *工具名称
*/ Name?: string; /** *工具描述
*/ Description?: string; /** *工具入参定义
*/ Parameters?: Array文档 ID
*/ DocId: string; /** *所属知识库 ID
*/ KbId: string; /** *字段掩码:当前支持的 Path:DocLink.CosUrl,其他未列举的字段默认都返回
*/ ReadMask?: FieldMask; } /** * 企微应用渠道配置 */ export interface WecomAppChannelConfig { /** *回调配置
*/ Callback?: CallbackConfig; /** *第三方企业ID
*/ ThirdChannelCorpId?: string; /** *第三方渠道ID
*/ ThirdChannelId?: string; /** *企微应用ID
*/ WecomAgentId?: string; /** *企微应用Secret
*/ WecomAgentSecret?: string; /** *企业ID
*/ WecomCorpId?: string; } /** * DescribeMsgRecordCategoryList请求参数结构体 */ export interface DescribeMsgRecordCategoryListRequest { /** *应用 ID
*/ AppId: string; } /** * 调用来源 */ export interface CallSource { /** *调用主体 ID,含义由 subject_type 决定(如 app_id、kb_id 等)
*/ SubjectId?: string; /** *调用主体名称
*/ SubjectName?: string; /** *调用主体类型:APP/KB/WIDGET/OPEN_CLAW/KB_RECALL_TEST/WORKBENCH/MODEL_API
| 枚举项 | 枚举值 | 描述 |
| METRIC_SOURCE_TYPE_UNSPECIFIED | 0 | |
| METRIC_SOURCE_TYPE_APP | 1 | 应用开发 |
| METRIC_SOURCE_TYPE_KB | 2 | 知识库 |
| METRIC_SOURCE_TYPE_WIDGET | 3 | Widget |
| METRIC_SOURCE_TYPE_OPEN_CLAW | 4 | ClawPro |
| METRIC_SOURCE_TYPE_KB_RECALL_TEST | 5 | 知识库召回测试 |
| METRIC_SOURCE_TYPE_WORKBENCH | 6 | 智能工作台 |
| METRIC_SOURCE_TYPE_MODEL_API | 7 | 模型 API 调用 |
消耗PU
*/ ConsumptionPU?: number; /** *用量数值
*/ Usage?: number; /** *用量单位,枚举值 DosageUnit
| 枚举项 | 枚举值 | 描述 |
| DOSAGE_UNIT_TOKEN | 0 | token(默认) |
| DOSAGE_UNIT_PAGE_COUNT | 1 | page_count(页数) |
| DOSAGE_UNIT_TIMES | 2 | times(次数) |
| DOSAGE_UNIT_SECOND | 3 | second(秒) |
| DOSAGE_UNIT_ITEM | 4 | item(条) |
| DOSAGE_UNIT_SHEET | 5 | sheet(张) |
| DOSAGE_UNIT_CHARACTER | 6 | character(字符) |
| DOSAGE_UNIT_GB | 7 | GB |
| DOSAGE_UNIT_NUMBER | 8 | number(个数) |
| DOSAGE_UNIT_MILL_SECOND | 9 | mill_second(毫秒) |
触发器执行提示词
*/ ExecutePrompt?: string; /** *api参数绑定
*/ ParamBindingsApi?: AppTriggerParamBindingConfig; } /** * DeleteSkillShare返回参数结构体 */ export interface DeleteSkillShareResponse { /** *是否走审批流(false 表示无需审批已直接执行下架)
*/ NeedApproval?: boolean; /** * 唯一请求 ID,由服务端生成,每次请求都会返回(若请求因其他原因未能抵达服务端,则该次请求不会获得 RequestId)。定位问题时需要提供该次请求的 RequestId。 */ RequestId?: string; } /** * ModifyCategory返回参数结构体 */ export interface ModifyCategoryResponse { /** * 唯一请求 ID,由服务端生成,每次请求都会返回(若请求因其他原因未能抵达服务端,则该次请求不会获得 RequestId)。定位问题时需要提供该次请求的 RequestId。 */ RequestId?: string; } /** * 发布摘要信息 */ export interface ReleaseSummary { /** *创建时间 (Unix时间戳,秒级)
*/ CreateTime: string; /** *发布描述
*/ Description: string; /** *发布ID
*/ ReleaseId: string; /** *发布状态。枚举值: 1:待发布, 2:发布中, 3:发布成功, 4:发布失败, 5:审核中, 6:审核成功, 7:审核失败, 8:发布成功回调处理中, 9:发布暂停, 10:申诉审核中, 11:申诉审核通过, 12:申诉审核不通过
*/ Status: number; /** *状态描述
*/ StatusDescription: string; /** *应用分享访问控制
注意:此字段可能返回 null,表示取不到有效值。 */ AppShareAccessControl?: AppShareAccessControl; /** *发布渠道ID列表
*/ ChannelIdList?: Array企业共享配置
注意:此字段可能返回 null,表示取不到有效值。 */ CorpShareConfig?: CorpShareConfig; } /** * QA 相似问 */ export interface SimilarQuestion { /** *相似问内容
*/ Content?: string; /** *是否 AI 生成
*/ IsAiGenerated?: boolean; /** *相似问 ID
*/ SimilarQuestionId?: string; } /** * Agent的工具基础配置 */ export interface AgentToolBasicConfig { /** *插件id
*/ PluginId?: string; /** *工具id
*/ ToolId?: string; /** *描述
*/ Description?: string; /** *工具输入参数列表
注意:此字段可能返回 null,表示取不到有效值。 */ InputList?: Array工具输出参数列表
注意:此字段可能返回 null,表示取不到有效值。 */ OutputList?: Array工具Header参数列表
注意:此字段可能返回 null,表示取不到有效值。 */ HeaderParameterList?: Array工具Query参数列表
注意:此字段可能返回 null,表示取不到有效值。 */ QueryParameterList?: Array工具来源: 0-来自插件,1-来自工作流
*/ ToolSource?: number; /** *是否禁用
*/ IsDisabled?: boolean; } /** * DescribeConflictQA返回参数结构体 */ export interface DescribeConflictQAResponse { /** *一个冲突组的详情列表
*/ ConflictQaList?: Array应用状态
枚举值:
状态描述
*/ StatusDescription: string; } /** * ComplexBilling */ export interface ComplexBilling { /** *复合计费列表
*/ ComplexList?: Array置信度阈值
*/ Confidence?: number; /** *是否启用
*/ Enabled?: boolean; /** *返回前 N 条
*/ TopN?: number; } /** * DescribeLabelSummaryList请求参数结构体 */ export interface DescribeLabelSummaryListRequest { /** *所属知识库 ID
*/ KbId: string; /** *通用过滤
*/ FilterList?: Array分页页码,从 0 开始
*/ PageNumber?: number; /** *每页数量,默认 10,最大 100
*/ PageSize?: number; /** *关键词搜索
*/ Query?: string; /** *开关配置
*/ SummaryListSwitch?: SummaryListSwitch; } /** * SearchKnowledge返回参数结构体 */ export interface SearchKnowledgeResponse { /** *检索结果列表
*/ KnowledgeList?: Array消耗的 token 统计
*/ TokenUsageList?: Array操作类型列表
*/ Actions?: Array操作对象列表
*/ BizObjects?: Array分类列表
*/ CategoryList?: Array总数
*/ TotalCount?: number; /** * 唯一请求 ID,由服务端生成,每次请求都会返回(若请求因其他原因未能抵达服务端,则该次请求不会获得 RequestId)。定位问题时需要提供该次请求的 RequestId。 */ RequestId?: string; } /** * AppTriggerParamSchema */ export interface AppTriggerParamSchema { /** *参数名
*/ ParamName?: string; /** *| 枚举项 | 枚举值 | 描述 |
| PARAM_TYPE_STRING | 0 | 字符串 |
| PARAM_TYPE_INT | 1 | 整数 |
| PARAM_TYPE_FLOAT | 2 | 浮点数 |
| PARAM_TYPE_BOOL | 3 | 布尔值 |
| PARAM_TYPE_OBJECT | 4 | 对象 |
| PARAM_TYPE_ARRAY_STRING | 5 | 字符串数组 |
| PARAM_TYPE_ARRAY_INT | 6 | 整数数组 |
| PARAM_TYPE_ARRAY_FLOAT | 7 | 浮点数数组 |
| PARAM_TYPE_ARRAY_BOOL | 8 | 布尔值数组 |
| PARAM_TYPE_ARRAY_OBJECT | 9 | 对象数组 |
| PARAM_TYPE_ARRAY_ARRAY | 20 | 数组嵌套 |
| PARAM_TYPE_NULL | 99 | 空值 |
| PARAM_TYPE_UNSPECIFIED | 100 | 未指定类型,用于OneOf和AnyOf场景 |
是否必选
*/ Required?: boolean; /** *子参数列表
*/ SubParamList?: Array枚举值:
| uint | 描述 |
| --- | --- |
| 0 | |
| 1 | 不推送 |
| 2 | 微信公众号 |
| 3 | 企业微信 AI 机器人 |
推送会话ID
*/ PushTargetId?: string; /** *枚举值:
| uint | 描述 |
| --- | --- |
| 0 | |
| 1 | 用户 (微信公众号 openid) |
| 2 | 群聊 (企微机器人 chat_id) |
推送webhook的url
*/ PushWebhookUrl?: string; } /** * 渠道规格(聚合场景/类型/名称/备注/配置) */ export interface ChannelSpec { /** *渠道名称
*/ ChannelName?: string; /** *渠道类型,详见ChannelType枚举
枚举值:
C端场景(Scene=1时)只支持10014和10015
*/ ChannelType?: number; /** *备注
*/ Description?: string; /** *钉钉机器人配置
注意:此字段可能返回 null,表示取不到有效值。 */ DingTalk?: DingTalkChannelConfig; /** *飞书机器人配置
注意:此字段可能返回 null,表示取不到有效值。 */ Lark?: LarkChannelConfig; /** *LINE配置
注意:此字段可能返回 null,表示取不到有效值。 */ Line?: LineChannelConfig; /** *渠道场景:0-B端场景,1-C端场景
*/ Scene?: number; /** *Telegram配置
注意:此字段可能返回 null,表示取不到有效值。 */ Telegram?: TelegramChannelConfig; /** *归属用户+Agent运行态标识(C端)
注意:此字段可能返回 null,表示取不到有效值。 */ UserAgent?: UserAgentReference; /** *微信公众号/小程序配置
注意:此字段可能返回 null,表示取不到有效值。 */ Wechat?: WechatChannelConfig; /** *微信ClawBot配置
注意:此字段可能返回 null,表示取不到有效值。 */ WechatClawBot?: WechatClawBotChannelConfig; /** *微信客服配置
注意:此字段可能返回 null,表示取不到有效值。 */ WechatCustomerService?: WechatCustomerServiceChannelConfig; /** *企微应用配置
注意:此字段可能返回 null,表示取不到有效值。 */ WecomApp?: WecomAppChannelConfig; /** *企微机器人配置
注意:此字段可能返回 null,表示取不到有效值。 */ WecomRobot?: WecomRobotChannelConfig; } /** * Agent 工具入参 */ export interface AgentToolConfig { /** *工具配置
*/ Config?: AgentToolBasicConfig; } /** * DeleteSkill返回参数结构体 */ export interface DeleteSkillResponse { /** * 唯一请求 ID,由服务端生成,每次请求都会返回(若请求因其他原因未能抵达服务端,则该次请求不会获得 RequestId)。定位问题时需要提供该次请求的 RequestId。 */ RequestId?: string; } /** * 知识库容量信息 */ export interface KBCapacity { /** *最大字符数
*/ MaxCharSize?: string; /** *超量字符数
*/ OverCharSize?: string; /** *已用字符数
*/ UsedCharSize?: string; } /** * 相似问额外信息 */ export interface SimilarQuestionExtra { /** *相似问文本内容
*/ Content?: string; /** *相似问 ID
*/ SimilarQuestionId?: string; } /** * DeleteDocList请求参数结构体 */ export interface DeleteDocListRequest { /** *待删除的文档 ID 列表(数量:1~20)
*/ DocIdList: Array所属知识库 ID
*/ KbId: string; } /** * WeeklySchedule */ export interface WeeklySchedule { /** * 定时配置(星期) */ Times?: Array是否开启深度思考
*/ DeepThinking?: string; /** *频率惩罚
注意:此字段可能返回 null,表示取不到有效值。 */ FrequencyPenalty?: number; /** *最大输出长度
注意:此字段可能返回 null,表示取不到有效值。 */ MaxTokens?: number; /** *存在惩罚
注意:此字段可能返回 null,表示取不到有效值。 */ PresencePenalty?: number; /** *深度思考效果
*/ ReasoningEffort?: string; /** *重复惩罚
注意:此字段可能返回 null,表示取不到有效值。 */ RepetitionPenalty?: number; /** *输出格式(text、json_object)
*/ ReplyFormat?: string; /** *seed 随机种子
注意:此字段可能返回 null,表示取不到有效值。 */ Seed?: number; /** *停止序列
*/ StopSequenceList?: Array温度
注意:此字段可能返回 null,表示取不到有效值。 */ Temperature?: number; /** *top_p
注意:此字段可能返回 null,表示取不到有效值。 */ TopP?: number; /** *top_k
*/ TopK?: number; } /** * Agent输入值,支持直接赋值和引用 */ export interface AgentInput { /** *输入来源类型:0 用户输入,3 自定义变量(API参数)
*/ InputType?: number; /** *用户手写输入
注意:此字段可能返回 null,表示取不到有效值。 */ UserInputValue?: AgentUserInputValue; /** *系统参数
注意:此字段可能返回 null,表示取不到有效值。 */ SystemVariable?: AgentSystemVariable; /** *自定义变量(API参数)
*/ CustomVariableId?: string; /** *环境变量参数
*/ EnvVariableId?: string; /** *应用变量参数
*/ AppVariableId?: string; } /** * Agent 发布预览信息 */ export interface AgentReleasePreview { /** *AgentID
*/ AgentId?: string; /** *Agent名称
*/ Name?: string; /** *更新时间, unix 秒时间戳 (s)
*/ UpdateTime?: string; /** *状态, 状态值:1:新增, 2:修改, 3:删除
*/ Action?: number; /** *动作描述
*/ ActionDescription?: string; /** *发布消息
*/ Message?: string; /** *发布详情
*/ ReleaseList?: Array参数名称
*/ Name?: string; /** *变量描述
*/ Description?: string; /** *参数类型
枚举值:
子参数,仅 OBJECT 或 ARRAY_OBJECT 类型时使用
*/ SubParameterList?: Array解析方式
*/ RenderMode?: number; } /** * CreateChannel请求参数结构体 */ export interface CreateChannelRequest { /** *应用业务ID
*/ AppId: string; /** *渠道规格(场景/类型/名称/备注/配置,必填)
*/ Spec?: ChannelSpec; } /** * 通用身份信息(支持数字 ID 与字符串 ID 两种形态) */ export interface Identity { /** * 描述 */ Description?: string; /** * 数字 ID */ Id?: string; /** * 名称 */ Name?: string; /** * 字符串 ID */ StrId?: string; } /** * AccessKey鉴权配置 */ export interface AccessKeyAuthConfig { /** *Access Key字段配置
*/ ParamList?: ArrayAccess Key透传配置
注意:此字段可能返回 null,表示取不到有效值。 */ PassThroughConfig?: AccessKeyPassThroughConfig; /** *Access Key 使用模式
枚举值:
基础信息
注意:此字段可能返回 null,表示取不到有效值。 */ Summary?: LabelSummary; /** * 唯一请求 ID,由服务端生成,每次请求都会返回(若请求因其他原因未能抵达服务端,则该次请求不会获得 RequestId)。定位问题时需要提供该次请求的 RequestId。 */ RequestId?: string; } /** * CreateAppTrigger返回参数结构体 */ export interface CreateAppTriggerResponse { /** *应用触发器ID
*/ TriggerId?: string; /** * 唯一请求 ID,由服务端生成,每次请求都会返回(若请求因其他原因未能抵达服务端,则该次请求不会获得 RequestId)。定位问题时需要提供该次请求的 RequestId。 */ RequestId?: string; } /** * DeleteKB返回参数结构体 */ export interface DeleteKBResponse { /** * 唯一请求 ID,由服务端生成,每次请求都会返回(若请求因其他原因未能抵达服务端,则该次请求不会获得 RequestId)。定位问题时需要提供该次请求的 RequestId。 */ RequestId?: string; } /** * 文档摘要信息 */ export interface DocSummary { /** *所属分类路径(包含分类 ID、从根节点开始的分类 ID 路径和分类名称路径)
注意:此字段可能返回 null,表示取不到有效值。 */ CategoryPath?: CategoryPath; /** *文档 ID
*/ DocId?: string; /** *知识生效范围(聚合生效作用域 + 标签条件)
注意:此字段可能返回 null,表示取不到有效值。 */ KnowledgeScope?: KnowledgeScope; /** *生命周期信息
注意:此字段可能返回 null,表示取不到有效值。 */ Lifecycle?: DocLifecycle; /** *元信息
注意:此字段可能返回 null,表示取不到有效值。 */ Metadata?: DocMetadata; /** *操作者信息(聚合修改人 + 操作权限)
注意:此字段可能返回 null,表示取不到有效值。 */ OperatorInfo?: DocOperator; /** *任务状态信息
注意:此字段可能返回 null,表示取不到有效值。 */ TaskStatus?: DocTaskStatus; } /** * 知识库可写属性集合(配合 update_mask 使用) */ export interface KBSpec { /** *描述
*/ Description?: string; /** *ES 配置
注意:此字段可能返回 null,表示取不到有效值。 */ EsConfig?: ESConfig; /** *模型配置
注意:此字段可能返回 null,表示取不到有效值。 */ ModelConfig?: KBModelConfig; /** *知识库名称
*/ Name?: string; /** *所有者 ID
*/ OwnerId?: string; } /** * 系统变量 */ export interface SystemVariable { /** * 变量描述 */ Description: string; /** * 变量名称 */ Name: string; } /** * ModifyPlugin返回参数结构体 */ export interface ModifyPluginResponse { /** * 唯一请求 ID,由服务端生成,每次请求都会返回(若请求因其他原因未能抵达服务端,则该次请求不会获得 RequestId)。定位问题时需要提供该次请求的 RequestId。 */ RequestId?: string; } /** * DescribeQASummaryList返回参数结构体 */ export interface DescribeQASummaryListResponse { /** *未采纳数量
*/ NotAcceptedCount?: number; /** *待校验数量
*/ PendingVerifyCount?: number; /** *QA 列表
*/ QaList?: Array总数
*/ TotalCount?: number; /** * 唯一请求 ID,由服务端生成,每次请求都会返回(若请求因其他原因未能抵达服务端,则该次请求不会获得 RequestId)。定位问题时需要提供该次请求的 RequestId。 */ RequestId?: string; } /** * DescribeAppTriggerInstance返回参数结构体 */ export interface DescribeAppTriggerInstanceResponse { /** *应用触发器实例
*/ Instance?: AppTriggerInstance; /** * 唯一请求 ID,由服务端生成,每次请求都会返回(若请求因其他原因未能抵达服务端,则该次请求不会获得 RequestId)。定位问题时需要提供该次请求的 RequestId。 */ RequestId?: string; } /** * 用户+Agent归属引用 */ export interface UserAgentReference { /** *claw agent 运行态标识
*/ AgentId?: string; /** *归属用户标识
*/ UserId?: string; } /** * CreateSkillShare请求参数结构体 */ export interface CreateSkillShareRequest { /** *必填,申请备注(弹窗"申请备注")
*/ ApplyRemark: string; /** *必填,原skill_id
*/ SkillId: string; /** *空间ID,必填
*/ SpaceId: string; /** *必填,被共享的版本id(必须高于已共享版本)
*/ VersionId: string; /** *共享配置
*/ CorpShareConfig?: SkillCorpShareConfig; } /** * 标准词(标签值的一项) */ export interface LabelTerm { /** *同义词列表
*/ SynonymList?: Array标准词
*/ Term?: string; /** *标准词 ID(由后台生成,创建时不传)
*/ TermId?: string; } /** * 资源消耗明细 */ export interface ConsumptionDetail { /** *消耗分类(类型/目标/场景/套餐包)
*/ Classification?: ConsumptionClassification; /** *消耗发生时间,Unix 秒
*/ EventTime?: string; /** *用量来源类型
| 枚举项 | 枚举值 | 描述 |
| METRIC_SOURCE_TYPE_UNSPECIFIED | 0 | |
| METRIC_SOURCE_TYPE_APP | 1 | 应用开发 |
| METRIC_SOURCE_TYPE_KB | 2 | 知识库 |
| METRIC_SOURCE_TYPE_WIDGET | 3 | Widget |
| METRIC_SOURCE_TYPE_OPEN_CLAW | 4 | ClawPro |
| METRIC_SOURCE_TYPE_KB_RECALL_TEST | 5 | 知识库召回测试 |
| METRIC_SOURCE_TYPE_WORKBENCH | 6 | 智能工作台 |
| METRIC_SOURCE_TYPE_MODEL_API | 7 | 模型 API 调用 |
名称
*/ Name?: string; /** *空间名称
*/ SpaceName?: string; /** *消耗用量(数值/单位/PU 消耗)
*/ Usage?: ConsumptionUsage; /** *用户名称
*/ UserName?: string; } /** * QA 生命周期信息 */ export interface QALifecycle { /** *创建时间(Unix 秒)
*/ CreateTime?: string; /** *过期策略(有效时间与超过有效时间后的行为)
注意:此字段可能返回 null,表示取不到有效值。 */ ExpirationPolicy?: ExpirationPolicy; /** *状态:1=待校验,2=未采纳,3=导入失败,4=审核中,5=审核失败,6=学习中,7=学习失败,8=导入完成,9=已过期,10=超量失效,11=超量失效恢复中,12=人工申诉中,13=人工申诉失败
| 枚举项 | 枚举值 | 描述 |
| QA_STATUS_UNKNOWN | 0 | |
| QA_STATUS_PENDING_VERIFY | 1 | 待校验 |
| QA_STATUS_NOT_ACCEPTED | 2 | 未采纳 |
| QA_STATUS_IMPORT_FAIL | 3 | 导入失败 |
| QA_STATUS_AUDITING | 4 | 审核中 |
| QA_STATUS_AUDIT_FAIL | 5 | 审核失败 |
| QA_STATUS_LEARNING | 6 | 学习中 |
| QA_STATUS_LEARN_FAIL | 7 | 学习失败 |
| QA_STATUS_IMPORTED | 8 | 导入完成 |
| QA_STATUS_EXPIRED | 9 | 已过期 |
| QA_STATUS_QUOTA_INVALID | 10 | 超量失效 |
| QA_STATUS_QUOTA_RECOVERING | 11 | 超量失效恢复中 |
| QA_STATUS_MANUAL_APPEALING | 12 | 人工申诉中 |
| QA_STATUS_MANUAL_APPEAL_FAIL | 13 | 人工申诉失败 |
状态描述
*/ StatusDesc?: string; /** *状态附加信息
*/ StatusMessage?: string; /** *更新时间(Unix 秒)
*/ UpdateTime?: string; } /** * 分类路径信息 */ export interface CategoryPath { /** *分类 ID
*/ CategoryId?: string; /** *从根节点开始的路径分类 ID 列表
*/ CategoryIdPath?: Array从根节点开始的路径分类名称列表
*/ CategoryNamePath?: Array文档 ID
*/ DocId: string; /** *修改字段内容(不可为空,与 update_mask 配合使用)
*/ Fields: DocModifyFields; /** *所属知识库 ID
*/ KbId: string; /** *字段掩码:指定要修改的字段(支持的 Paths:Name, CategoryId, EffectiveDomain, LabelRefList, ExternalLink, ExpirationPolicy, UpdatePeriod, Switch, ParseConfig, UserAccessConfig)
*/ UpdateMask: FieldMask; } /** * 欢迎语配置 */ export interface AppGreetingConfig { /** *欢迎语内容
*/ Greeting: string; /** *开场问题列表
*/ OpeningQuestionList?: Array应用ID
*/ AppId?: string; /** *参数过滤列表
*/ FilterList?: Array页码
取值范围:[1, 1000000]
*/ PageNumber?: number; /** *每页大小
取值范围:[1, 100]
*/ PageSize?: number; /** *模糊查询字符串
*/ Query?: string; /** *| 枚举项 | 枚举值 | 描述 |
| APP_TRIGGER_SCOPE_UNSPECIFIED | 0 | 未指定 |
| APP_TRIGGER_SCOPE_APP | 1 | B 端管理员 |
| APP_TRIGGER_SCOPE_USER | 2 | C 端访客 |
访客ID
*/ UserId?: string; } /** * AppTriggerScheduleConfig */ export interface AppTriggerScheduleConfig { /** *触发器定时配置
*/ Schedule?: TimerScheduleConfig; } /** * 单条检索结果 */ export interface KnowledgeResult { /** *置信度
*/ Confidence?: number; /** *命中知识类型:1=问答,2=文档片段,3=数据库,4=图谱
| 枚举项 | 枚举值 | 描述 |
| KNOWLEDGE_SOURCE_TYPE_UNKNOWN | 0 | |
| KNOWLEDGE_SOURCE_TYPE_QA | 1 | 问答 |
| KNOWLEDGE_SOURCE_TYPE_DOC | 2 | 文档片段 |
| KNOWLEDGE_SOURCE_TYPE_DB | 3 | 数据库 |
| KNOWLEDGE_SOURCE_TYPE_GRAPH | 4 | 图谱 |
召回类型列表
*/ RecallTypeList?: Array结果负载
注意:此字段可能返回 null,表示取不到有效值。 */ ResultPayload?: SearchResultPayload; /** *检索结果类型
| 枚举项 | 枚举值 | 描述 |
| SEARCH_RESULT_TYPE_UNKNOWN | 0 | |
| SEARCH_RESULT_TYPE_RETRIEVAL | 1 | 普通检索结果 |
| SEARCH_RESULT_TYPE_TEXT_TO_SQL | 2 | text2sql 结果 |
| SEARCH_RESULT_TYPE_IMAGE_SEARCH_IMAGE | 3 | |
| SEARCH_RESULT_TYPE_TEXT_SEARCH_IMAGE | 4 |
相似问额外信息
注意:此字段可能返回 null,表示取不到有效值。 */ SimilarQuestionExtra?: SimilarQuestionExtra; /** *知识片段基础信息
注意:此字段可能返回 null,表示取不到有效值。 */ SnippetProfile?: KnowledgeSnippetProfile; /** *知识来源信息
注意:此字段可能返回 null,表示取不到有效值。 */ SourceInfo?: KnowledgeSource; } /** * ModifyAppTrigger返回参数结构体 */ export interface ModifyAppTriggerResponse { /** * 唯一请求 ID,由服务端生成,每次请求都会返回(若请求因其他原因未能抵达服务端,则该次请求不会获得 RequestId)。定位问题时需要提供该次请求的 RequestId。 */ RequestId?: string; } /** * 员工信息 */ export interface AccountInfo { /** *员工子账号id
*/ AccountUin?: string; /** *员工昵称
*/ NickName?: string; /** *员工头像
*/ Avatar?: string; } /** * CreateSkill请求参数结构体 */ export interface CreateSkillRequest { /** *Skill 创建方式,必填;仅允许
枚举值:
skill包文件地址(zip);FILE_UPLOAD / AIGC 均必填
*/ FileUrl: string; /** *空间ID
*/ SpaceId: string; /** *skill展示描述
*/ DisplayDescription?: string; /** *skill展示名称
*/ DisplayName?: string; /** *图标地址
*/ IconUrl?: string; /** *skill业务唯一标识名(同企业下唯一);未传时从skill包解析
*/ Name?: string; /** *版本号
*/ SkillVersion?: string; /** *版本变更说明
*/ UpdateDescription?: string; } /** *排序条件
*/ export interface Sort { /** *排序字段名,如 create_time
*/ Name: string; /** *排序方向,1 升序,2 降序
| 枚举项 | 枚举值 | 描述 |
| SORT_ORDER_INVALID | 0 | 无效 |
| SORT_ORDER_ASC | 1 | 升序 |
| SORT_ORDER_DESC | 2 | 降序 |
Agent Id
*/ AgentId?: string; /** * 唯一请求 ID,由服务端生成,每次请求都会返回(若请求因其他原因未能抵达服务端,则该次请求不会获得 RequestId)。定位问题时需要提供该次请求的 RequestId。 */ RequestId?: string; } /** * FavoritePlugin返回参数结构体 */ export interface FavoritePluginResponse { /** * 唯一请求 ID,由服务端生成,每次请求都会返回(若请求因其他原因未能抵达服务端,则该次请求不会获得 RequestId)。定位问题时需要提供该次请求的 RequestId。 */ RequestId?: string; } /** * 总览 KPI 卡片指标项 */ export interface MetricOverview { /** *指标键,取值参考 MetricOverview 注释中的 key 白名单
*/ Key?: string; /** *环比百分比,无环比时填 0
*/ Mom?: number; /** *指标单位,枚举值 DosageUnit;key 与 unit 的对应关系参考 MetricOverview 注释白名单
| 枚举项 | 枚举值 | 描述 |
| DOSAGE_UNIT_TOKEN | 0 | token(默认) |
| DOSAGE_UNIT_PAGE_COUNT | 1 | page_count(页数) |
| DOSAGE_UNIT_TIMES | 2 | times(次数) |
| DOSAGE_UNIT_SECOND | 3 | second(秒) |
| DOSAGE_UNIT_ITEM | 4 | item(条) |
| DOSAGE_UNIT_SHEET | 5 | sheet(张) |
| DOSAGE_UNIT_CHARACTER | 6 | character(字符) |
| DOSAGE_UNIT_GB | 7 | GB |
| DOSAGE_UNIT_NUMBER | 8 | number(个数) |
| DOSAGE_UNIT_MILL_SECOND | 9 | mill_second(毫秒) |
指标数值
*/ Value?: number; } /** * Agent 技能详情 */ export interface AgentSkill { /** *skillId
*/ SkillId?: string; /** *skill名称
*/ Name?: string; /** *技能描述
*/ Description?: string; /** *skill展示名称
*/ DisplayName?: string; /** *技能展示描述
*/ DisplayDescription?: string; /** *skill图标url
*/ IconUrl?: string; /** *Skill来源
*/ SourceType?: number; /** *Skill版本
*/ CurrentVersion?: string; } /** * SearchKnowledge请求参数结构体 */ export interface SearchKnowledgeRequest { /** *检索高级配置
*/ AdvancedConfig: SearchAdvancedConfig; /** *检索输入
*/ Input: SearchInput; /** *检索上下文
*/ Context?: SearchContext; /** *计费信息
*/ SearchBilling?: SearchBilling; } /** * 数据库检索配置 */ export interface DBRetrievalConfig { /** *是否启用
*/ Enabled?: boolean; } /** * 模型徽章 */ export interface ModelBadge { /** * 展示文案 */ Text?: string; /** * 样式主题。1-信息(蓝色), 2-成功(绿色), 3-警告(橙色), 4-危险(红色) */ Theme?: number; /** * tooltip文案,为空则不展示 */ Tips?: string; /** * 徽章类型。1-限时免费, 2-即将下线, 3-新模型, 4-热门 */ Type?: number; } /** * Token 使用统计 */ export interface TokenUsage { /** *completion token 数
*/ CompletionTokens?: number; /** *模型名称
*/ ModelName?: string; /** *prompt token 数
*/ PromptTokens?: number; /** *总 token 数
*/ TotalTokens?: number; } /** * 平台资源用量聚合明细(PLATFORM 域专属) */ export interface PlatformUsageSummary { /** *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
*/ ResourceConsumptionList?: Array批量删除结果
*/ ResultList?: Array系统参数名
*/ Name?: string; /** *对话历史轮数的配置;如果Input是系统变量中的“对话历史”时才使用;
*/ DialogHistoryLimit?: number; } /** * 文档外部链接信息 */ export interface DocExternalLink { /** *外部链接地址
*/ ExternalUrl?: string; /** *是否替换原文展示
*/ ReplaceOriginEnabled?: boolean; } /** * PluginProfile */ export interface PluginProfile { /** * 插件作者 */ Author?: string; /** * 插件描述 */ Description?: string; /** * 插件图标url */ IconUrl?: string; /** * 插件名称 */ Name?: string; /** *插件产品分类
枚举值:
插件类型
枚举值:
插件来源
枚举值:
插件详情
*/ Plugin?: Plugin; /** * 唯一请求 ID,由服务端生成,每次请求都会返回(若请求因其他原因未能抵达服务端,则该次请求不会获得 RequestId)。定位问题时需要提供该次请求的 RequestId。 */ RequestId?: string; } /** * DescribeAgentReleasePreviewList返回参数结构体 */ export interface DescribeAgentReleasePreviewListResponse { /** *发布预览列表
*/ ReleaseList?: Array总数
*/ TotalCount?: number; /** * 唯一请求 ID,由服务端生成,每次请求都会返回(若请求因其他原因未能抵达服务端,则该次请求不会获得 RequestId)。定位问题时需要提供该次请求的 RequestId。 */ RequestId?: string; } /** * DescribeSkillSummaryList返回参数结构体 */ export interface DescribeSkillSummaryListResponse { /** * Skill 摘要列表 */ SkillSummaryList?: Array会话 ID
*/ ConversationId: string; /** *会话类型 枚举值: 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(分享链接)
*/ Type: number; /** *Type=CONVERSATION_TYPE_API 时必填,应用密钥
*/ AppKey?: string; /** *返回记录总数量,默认 10,最大 50。向前或向后查询时,不包含record_id指定记录的消息,查询方向中心向前后查询时,包含record_id指定的记录消息,返回记录数量为前后各limit / 2条,向上取整
*/ Limit?: number; /** *子用户Uin
*/ LoginSubAccountUin?: string; /** *主用户Uin
*/ LoginUin?: string; /** *查询锚点记录 ID
*/ RecordId?: string; /** *相对于 record_id 的查询方向 枚举值: 0-RECORD_QUERY_DIRECTION_UNSPECIFIED(未指定,兼容旧逻辑,默认向前查询), 1-RECORD_QUERY_DIRECTION_BACKWARD(从 record_id 向前查询更早的消息), 2-RECORD_QUERY_DIRECTION_FORWARD(从 record_id 向后查询更新的消息), 3-RECORD_QUERY_DIRECTION_BIDIRECTIONAL(以 record_id 为中心,同时向前后查询)
*/ RecordQueryDirection?: number; /** *Type=CONVERSATION_TYPE_SHARE 时必填,分享码
*/ ShareCode?: string; /** *Type=CONVERSATION_TYPE_API 时必填,访客ID
*/ UserId?: string; } /** * 有效期 */ export interface EffectivePeriod { /** *有效期结束时间(Unix 秒,0 表示永久有效)
*/ EndTime?: string; /** *有效期开始时间(Unix 秒)
*/ StartTime?: string; } /** * DescribeDocSummaryList返回参数结构体 */ export interface DescribeDocSummaryListResponse { /** *文档列表
*/ DocList?: Array总数
*/ TotalCount?: number; /** * 唯一请求 ID,由服务端生成,每次请求都会返回(若请求因其他原因未能抵达服务端,则该次请求不会获得 RequestId)。定位问题时需要提供该次请求的 RequestId。 */ RequestId?: string; } /** * DeleteDocList返回参数结构体 */ export interface DeleteDocListResponse { /** *批量删除结果
*/ ResultList?: Array应用Id
*/ AppId: string; /** *待删除AgentId
*/ AgentId: string; /** * 协作模式;0-Claw模式;1-Multi-Agent模式 */ CollaborationMode?: number; } /** * RequestParam */ export interface RequestParam { /** *AnyOf类型的参数
*/ AnyOf?: Array默认值
*/ DefaultValue?: string; /** *参数描述
*/ Description?: string; /** *全局隐藏不可见(区别于Agent场景的agent_hidden),true-全局隐藏不可见,false-可见
*/ IsGlobalHidden?: boolean; /** *是否必选
*/ IsRequired?: boolean; /** *参数名称
*/ Name?: string; /** *OneOf类型的参数
*/ OneOf?: Array子参数,ParamType 是OBJECT 或 ARRAY<>类型有用
*/ SubParams?: Array| 枚举项 | 枚举值 | 描述 |
| PARAM_TYPE_STRING | 0 | 字符串 |
| PARAM_TYPE_INT | 1 | 整数 |
| PARAM_TYPE_FLOAT | 2 | 浮点数 |
| PARAM_TYPE_BOOL | 3 | 布尔值 |
| PARAM_TYPE_OBJECT | 4 | 对象 |
| PARAM_TYPE_ARRAY_STRING | 5 | 字符串数组 |
| PARAM_TYPE_ARRAY_INT | 6 | 整数数组 |
| PARAM_TYPE_ARRAY_FLOAT | 7 | 浮点数数组 |
| PARAM_TYPE_ARRAY_BOOL | 8 | 布尔值数组 |
| PARAM_TYPE_ARRAY_OBJECT | 9 | 对象数组 |
| PARAM_TYPE_ARRAY_ARRAY | 20 | 数组嵌套 |
| PARAM_TYPE_NULL | 99 | 空值 |
| PARAM_TYPE_UNSPECIFIED | 100 | 未指定类型,用于OneOf和AnyOf场景 |
对话失败错误码
*/ Code?: string; /** *对话失败错误信息
*/ Message?: string; } /** * DescribeUsageSummaryList请求参数结构体 */ export interface DescribeUsageSummaryListRequest { /** *资源类型,限定为 MODEL / PLUGIN / PLATFORM
| 枚举项 | 枚举值 | 描述 |
| RESOURCE_TYPE_UNSPECIFIED | 0 | |
| RESOURCE_TYPE_MODEL | 1 | 模型用量 |
| RESOURCE_TYPE_PLUGIN | 2 | 插件用量 |
| RESOURCE_TYPE_PLATFORM | 3 | 平台功能用量 |
| RESOURCE_TYPE_MODEL_CONCURRENCY | 4 | 模型并发超限 |
| RESOURCE_TYPE_KB_CAPACITY | 5 | 知识库容量 |
| RESOURCE_TYPE_USAGE_SUMMARY | 6 | 用量汇总 |
| RESOURCE_TYPE_RESOURCE_CONSUME | 7 | 资源消耗(计费明细) |
查询时间范围(Unix 秒)
*/ TimeRange: TimeRange; /** *视图范围:企业视图 / 空间视图 / 应用视图
*/ ViewScope: ViewScope; /** *扩展过滤(resource_type=MODEL)。Filter 组合规则:多项 AND,同项 value_list OR。支持 Name:model_name(模型名)、user_id(用户ID)、space_id(空间ID)、resource_id/source_id(来源ID)、metric_source_type(METRIC_SOURCE_TYPE_* 枚举名或整数)
*/ FilterList?: Array页码,从 0 开始
*/ PageNumber?: number; /** *每页数量,最大 100
*/ PageSize?: number; } /** * Agent发布项目详情 */ export interface AgentRelease { /** *名称
*/ ItemName?: string; /** *更新时间, unix 秒时间戳 (s)
*/ UpdateTime?: string; /** *动作描述
*/ ActionDescription?: string; /** *变更为 测试
*/ ReleaseMessage?: string; } /** * Agent 工具输入参数定义 */ export interface AgentToolInputParameter { /** *工具名称
*/ Name?: string; /** *工具描述
*/ Description?: string; /** *工具参数类型
枚举值:
是否必填
*/ IsRequired?: boolean; /** *子参数,仅 OBJECT 或 ARRAY<> 类型时使用
注意:此字段可能返回 null,表示取不到有效值。 */ SubParameterList?: Array模式下是否对模型隐藏
*/ IsHidden?: boolean; /** *OneOf类型的参数
注意:此字段可能返回 null,表示取不到有效值。 */ OneOfList?: ArrayAnyOf类型的参数
注意:此字段可能返回 null,表示取不到有效值。 */ AnyOfList?: Array参数取值来源
注意:此字段可能返回 null,表示取不到有效值。 */ Input?: AgentInput; } /** * 知识库操作权限信息 */ export interface KBPermission { /** *是否可删除
*/ CanDelete?: boolean; /** *是否可编辑
*/ CanEdit?: boolean; /** *是否可查看
*/ CanView?: boolean; } /** * RunAppTriggerNow返回参数结构体 */ export interface RunAppTriggerNowResponse { /** *应用触发器实例ID
*/ InstanceId?: string; /** * 唯一请求 ID,由服务端生成,每次请求都会返回(若请求因其他原因未能抵达服务端,则该次请求不会获得 RequestId)。定位问题时需要提供该次请求的 RequestId。 */ RequestId?: string; } /** * DescribeConflictQA请求参数结构体 */ export interface DescribeConflictQARequest { /** *冲突组 ID
*/ ConflictGroupId: string; /** *所属知识库 ID
*/ KbId: string; } /** * DescribeSkillDetail返回参数结构体 */ export interface DescribeSkillDetailResponse { /** * skill详情 */ SkillDetail?: SkillDetail; /** * 唯一请求 ID,由服务端生成,每次请求都会返回(若请求因其他原因未能抵达服务端,则该次请求不会获得 RequestId)。定位问题时需要提供该次请求的 RequestId。 */ RequestId?: string; } /** * 回调配置 */ export interface CallbackConfig { /** *回调AESKey
*/ CallbackAesKey?: string; /** *回调Token
*/ CallbackToken?: string; /** *回调URL
*/ CallbackUrl?: string; } /** * DeleteAppTrigger请求参数结构体 */ export interface DeleteAppTriggerRequest { /** *应用ID
*/ AppId?: string; /** *| 枚举项 | 枚举值 | 描述 |
| APP_TRIGGER_SCOPE_UNSPECIFIED | 0 | 未指定 |
| APP_TRIGGER_SCOPE_APP | 1 | B 端管理员 |
| APP_TRIGGER_SCOPE_USER | 2 | C 端访客 |
触发器ID
*/ TriggerId?: string; /** *访客ID
*/ UserId?: string; } /** * QA 操作权限信息 */ export interface QAPermission { /** *是否可校验(采纳/不采纳)
*/ CanAccept?: boolean; /** *是否可删除
*/ CanDelete?: boolean; /** *是否可编辑
*/ CanEdit?: boolean; } /** * CreateQAGenerationTask返回参数结构体 */ export interface CreateQAGenerationTaskResponse { /** *任务 ID 列表
*/ TaskIdList?: Array分类名
*/ Name?: string; } /** * 通用操作结果项 */ export interface OperationResult { /** *资源 ID
*/ Id?: string; /** *失败原因(succeeded=false 时填充)
*/ Reason?: string; /** *是否成功
*/ Succeeded?: boolean; } /** * OnceSchedule */ export interface OnceSchedule { /** * 触发时间 */ FireTime?: string; } /** * QA 查询条件 */ export interface QAQuery { /** *查询关键词(模糊搜索)
*/ Query?: string; /** *查询范围(query 作用的字段):1=问题,2=标签或标签值,3=答案;支持多选,缺省时无效
*/ QueryScopeList?: Array关联的 UI 资源 URI,ui:// scheme,格式为 ui://<插件标识>/<资源名>-<版本>。该字段是 MCP Apps 交互式界面的入口,非空时表示工具支持 Apps("文本 + 交互式界面"展示),为空则为纯文本工具。由工具同步结果自动识别填充,不支持手工编辑。
*/ ResourceUri?: string; /** *工具的调用方可见性声明,取值范围:model(模型可调用)、app(应用界面可调用),可多选,如 ["model","app"]。与 ResourceUri 相互独立(SEP-1865),可单独存在,例如纯后端 app-only 工具为 ["app"]。当 ResourceUri 非空且本字段缺省时,按规范归一化为 ["model","app"];存量非 Apps 工具保持为空。
枚举值:
检索过滤类型
| 枚举项 | 枚举值 | 描述 |
| SEARCH_FILTER_TYPE_UNKNOWN | 0 | |
| SEARCH_FILTER_TYPE_CUSTOMER_LABEL_VALUE | 1 | 用户自定义标签值 |
| SEARCH_FILTER_TYPE_CUSTOMER_LABEL_VALUE_ID | 2 | 用户自定义标签值ID |
| SEARCH_FILTER_TYPE_DOC_ID | 3 | 指定文档 ID 检索 |
| SEARCH_FILTER_TYPE_DOC_CATEGORY_ID | 4 | 指定文档分类 ID 检索 |
| SEARCH_FILTER_TYPE_DB_TABLE_ID | 5 | 指定数据库表 ID 检索 |
| SEARCH_FILTER_TYPE_KB_SCHEMA_ID | 6 | 指定知识库 schema ID |
过滤值列表,根据SearchFilterType取值1:传自定义标签值;2:传自定义标签值ID;3:传文档ID;4:传分类ID
*/ FilterValueList?: Array用户自定义标签 ID
*/ LabelId?: string; /** *逻辑运算符:AND 或 OR
| 枚举项 | 枚举值 | 描述 |
| LOGIC_OPR_NOOP | 0 | |
| LOGIC_OPR_AND | 1 | |
| LOGIC_OPR_OR | 2 |
嵌套检索过滤
*/ SearchFilterList?: Array所属知识库 ID
*/ KbId: string; /** *过滤条件(多个 Filter 之间为 AND 关系,同一 Filter 的多个 Values 为 OR 关系):CategoryType-分类类型,枚举值,精确匹配(CATEGORY_TYPE_DOC=1/CATEGORY_TYPE_QA=2); ParentCategoryId-父分类ID,精确匹配
*/ FilterList?: Array分页页码,从 0 开始
*/ PageNumber?: number; /** *每页数量,默认 10,最大 100
*/ PageSize?: number; /** *关键词搜索
*/ Query?: string; /** *开关配置
*/ SummaryListSwitch?: SummaryListSwitch; } /** * FieldMask */ export interface FieldMask { /** *参数名称
参数格式:需要获取的指定字段路径
*/ Paths?: Array触发器API参数列表
*/ SchemaList?: Array会话 ID
*/ ConversationId: string; /** *消息图标
*/ Icon: string; /** *消息 ID
*/ MessageId: string; /** *消息名称
*/ Name: string; /** *记录 ID
*/ RecordId: string; /** *消息角色
*/ Role: string; /** *消息状态,pending:待执行,processing:处理中,success:已完成,failed:处理失败,stop:已取消
*/ Status: string; /** *状态描述
*/ StatusDesc: string; /** *消息标题
*/ Title: string; /** *消息内容列表
*/ ContentList?: Array消息内容列表
*/ Contents?: Array类型
*/ Type?: string; } /** * CreateCategory返回参数结构体 */ export interface CreateCategoryResponse { /** *创建成功的分类 ID
*/ CategoryId?: string; /** * 唯一请求 ID,由服务端生成,每次请求都会返回(若请求因其他原因未能抵达服务端,则该次请求不会获得 RequestId)。定位问题时需要提供该次请求的 RequestId。 */ RequestId?: string; } /** * 企微机器人渠道配置 */ export interface WecomRobotChannelConfig { /** *回调接入配置
注意:此字段可能返回 null,表示取不到有效值。 */ Callback?: WecomRobotCallbackAccess; /** *WebSocket长连接配置
注意:此字段可能返回 null,表示取不到有效值。 */ Websocket?: WecomRobotWebsocketAccess; } /** * ImportDocList请求参数结构体 */ export interface ImportDocListRequest { /** *待导入文档列表(数量:1~20)
*/ DocList: Array知识库 ID
*/ KbId: string; } /** * DescribeConsumptionDetailList请求参数结构体 */ export interface DescribeConsumptionDetailListRequest { /** *查询时间范围(Unix 秒)
*/ TimeRange: TimeRange; /** *视图范围:企业视图 / 空间视图
*/ ViewScope: ViewScope; /** *扩展过滤。Filter 组合规则:多项 AND,同项 value_list OR。支持 Name:metric_source_type(METRIC_SOURCE_TYPE_* 或整数)、source_ids(多选来源ID)、resource_id/source_id(单选来源ID,source_ids 未传时生效)、space_id、user_id
*/ FilterList?: Array页码,从 0 开始
*/ PageNumber?: number; /** *每页数量,最大 100
*/ PageSize?: number; } /** * 计费套餐包用量信息 */ export interface ResourcePackageInfo { /** *套餐类型
枚举值:
资源包总量
*/ ResourceTotal?: number; /** *资源包用量
*/ ResourceUsage?: number; /** *知识库容量
*/ KnowledgeCapacity?: number; /** *知识库用量
*/ KnowledgeUsage?: number; /** *资源包状态
枚举值:
导出任务 ID(通过 DescribeAsyncTaskStatus 查询完成状态)
*/ ExportTaskId?: string; /** * 唯一请求 ID,由服务端生成,每次请求都会返回(若请求因其他原因未能抵达服务端,则该次请求不会获得 RequestId)。定位问题时需要提供该次请求的 RequestId。 */ RequestId?: string; } /** * QA 元信息 */ export interface QAMetadata { /** *答案
*/ Answer?: string; /** *问答字符数
*/ QaCharCount?: string; /** *问答大小(字节,含相似问)
*/ QaSize?: string; /** *问题
*/ Question?: string; /** *元数据引用字段名列表(用于显示问答哪些分类和属性被设置为元数据)
*/ RefFieldNameList?: Array第一个记录 ID
*/ FirstRecordId?: string; /** *更新消息方向是否还有更多
*/ HasMoreAfter?: boolean; /** *更早消息方向是否还有更多
*/ HasMoreBefore?: boolean; /** *最后一个记录 ID
*/ LastRecordId?: string; /** *消息列表
*/ MessageList?: Array消息列表
* @deprecated */ Messages?: Array单次对话记录统计列表,与 message_list 通过 record_id / related_record_id 关联
注意:此字段可能返回 null,表示取不到有效值。 */ RecordSummaryList?: Array最近一次重置信息
注意:此字段可能返回 null,表示取不到有效值。 */ ResetInfo?: ConversationResetInfo; /** * 唯一请求 ID,由服务端生成,每次请求都会返回(若请求因其他原因未能抵达服务端,则该次请求不会获得 RequestId)。定位问题时需要提供该次请求的 RequestId。 */ RequestId?: string; } /** * AppToolConfig */ export interface AppToolConfig { /** *输入参数
*/ Inputs?: Array输出参数
*/ Outputs?: Array任务内容
*/ Content: string; /** *任务序号
*/ Index: string; /** *任务状态,pending:待执行,processing:处理中,success:已完成,failed:处理失败,stop:已取消
*/ Status: string; } /** * CheckLabel返回参数结构体 */ export interface CheckLabelResponse { /** *校验结果列表
*/ CheckList?: Array最近一次触发时间
参数格式:格式为YYYY-MM-DD hh:mm:ss
*/ LastFireTime?: string; /** *下一次触发时间
参数格式:格式为YYYY-MM-DD hh:mm:ss
*/ NextFireTime?: string; /** *触发方式
*/ PolicySummary?: string; } /** * 通用键值对 */ export interface KVPair { /** * 键 */ Key?: string; /** * 值 */ Value?: string; } /** * DeleteSkill请求参数结构体 */ export interface DeleteSkillRequest { /** *Skill ID,必填
*/ SkillId: string; /** *空间ID,必填
*/ SpaceId: string; } /** * DescribePlugin请求参数结构体 */ export interface DescribePluginRequest { /** *插件id
*/ PluginId: string; /** *当前空间id
*/ SpaceId: string; /** *获取指定字段
*/ FieldMask?: FieldMask; /** *插件展示场景。不传或取 0 时不限定场景。
枚举值:
渠道ID
*/ ChannelId?: string; /** *渠道状态(仅B端):1-未发布,2-运行中,3-已下线(与ConnectStatus互斥)
*/ ChannelStatus?: number; /** *连接状态(仅C端):1-初始,2-连接成功,3-连接失败(与ChannelStatus互斥)
*/ ConnectStatus?: number; /** *创建时间(Unix秒)
*/ CreateTime?: string; /** *渠道规格
注意:此字段可能返回 null,表示取不到有效值。 */ Spec?: ChannelSpec; /** *更新时间(Unix秒)
*/ UpdateTime?: string; /** *最后更新人
*/ Updater?: string; } /** * PluginUserState */ export interface PluginUserState { /** * 是否已收藏该插件 */ IsFavorite?: boolean; /** * 是否在插件白名单内 */ IsInWhiteList?: boolean; /** *白名单类型,用于表示当前用户是否可直接使用该插件。
枚举值:
创建时间(Unix 秒)
*/ CreateTime?: string; /** *过期策略(有效时间与超过有效时间后的行为)
注意:此字段可能返回 null,表示取不到有效值。 */ ExpirationPolicy?: ExpirationPolicy; /** *文档状态:1=解析中,2=解析失败,3=导入失败,4=审核中,5=审核失败,6=学习中,7=学习失败,8=导入完成,9=已过期,10=超量失效,11=超量失效恢复中,12=重命名审核失败,13=重命名申诉失败,14=人工申诉中,15=人工申诉失败
| 枚举项 | 枚举值 | 描述 |
| DOC_STATUS_UNKNOWN | 0 | |
| DOC_STATUS_PARSING | 1 | 解析中 |
| DOC_STATUS_PARSE_FAIL | 2 | 解析失败 |
| DOC_STATUS_IMPORT_FAIL | 3 | 导入失败 |
| DOC_STATUS_AUDITING | 4 | 审核中 |
| DOC_STATUS_AUDIT_FAIL | 5 | 审核失败 |
| DOC_STATUS_LEARNING | 6 | 学习中 |
| DOC_STATUS_LEARN_FAIL | 7 | 学习失败 |
| DOC_STATUS_IMPORTED | 8 | 导入完成 |
| DOC_STATUS_EXPIRED | 9 | 已过期 |
| DOC_STATUS_QUOTA_INVALID | 10 | 超量失效 |
| DOC_STATUS_QUOTA_RECOVERING | 11 | 超量失效恢复中 |
| DOC_STATUS_RENAME_AUDIT_FAIL | 12 | 重命名审核失败 |
| DOC_STATUS_RENAME_APPEAL_FAIL | 13 | 重命名申诉失败 |
| DOC_STATUS_MANUAL_APPEALING | 14 | 人工申诉中 |
| DOC_STATUS_MANUAL_APPEAL_FAIL | 15 | 人工申诉失败 |
状态描述
*/ StatusDesc?: string; /** *状态附加信息
*/ StatusMessage?: string; /** *更新时间(Unix 秒)
*/ UpdateTime?: string; } /** * 多模态理解模型配置 */ export interface MultiModalUnderstandingModel { /** * 模型配置 注意:此字段可能返回 null,表示取不到有效值。 */ Model: ModelDetailInfo; } /** * DescribeAppTrigger请求参数结构体 */ export interface DescribeAppTriggerRequest { /** *应用ID
*/ AppId?: string; /** *| 枚举项 | 枚举值 | 描述 |
| APP_TRIGGER_SCOPE_UNSPECIFIED | 0 | 未指定 |
| APP_TRIGGER_SCOPE_APP | 1 | B 端管理员 |
| APP_TRIGGER_SCOPE_USER | 2 | C 端访客 |
应用触发器ID
*/ TriggerId?: string; /** *访客ID
*/ UserId?: string; } /** * CorpShareConfig */ export interface CorpShareConfig { /** *企业共享开关
*/ Enabled?: boolean; /** *共享范围类型,1:企业全员,2:指定账户,3:指定空间
*/ ShareScope?: number; /** *企业共享应用标签
*/ TagIdList?: Array共享范围信息(用户时StrId为uin,Name为用户名称;空间时StrId为空间ID,Name为空间名称)
*/ ShareScopeList?: Array应用ID
*/ AppId?: string; /** *| 枚举项 | 枚举值 | 描述 |
| APP_TRIGGER_EXECUTE_TYPE_UNSPECIFIED | 0 | 未指定 |
| APP_TRIGGER_EXECUTE_TYPE_PROMPT | 1 | 指令执行 |
| APP_TRIGGER_EXECUTE_TYPE_WORKFLOW | 2 | 工作流执行 |
失败次数
*/ FailedCount?: string; /** *最近一次会话id
*/ LastSessionId?: string; /** *| 枚举项 | 枚举值 | 描述 |
| APP_TRIGGER_SCOPE_UNSPECIFIED | 0 | 未指定 |
| APP_TRIGGER_SCOPE_APP | 1 | B 端管理员 |
| APP_TRIGGER_SCOPE_USER | 2 | C 端访客 |
取值范围:[0, 2]
*/ Scope?: number; /** *| 枚举项 | 枚举值 | 描述 |
| APP_TRIGGER_STATUS_UNSPECIFIED | 0 | 未指定 |
| APP_TRIGGER_STATUS_ENABLED | 1 | 启用 |
| APP_TRIGGER_STATUS_PAUSED | 2 | 暂停 |
| APP_TRIGGER_STATUS_DELETED | 3 | 已删除 |
成功次数
*/ SuccessCount?: string; /** *触发器id
*/ TriggerId?: string; /** *触发器名称
*/ TriggerName?: string; /** *触发器执行状态
*/ TriggerStatus?: TriggerStatus; /** *| 枚举项 | 枚举值 | 描述 |
| APP_TRIGGER_TYPE_UNSPECIFIED | 0 | 未指定 |
| APP_TRIGGER_TYPE_SCHEDULED | 1 | 定时触发 |
| APP_TRIGGER_TYPE_WEBHOOK | 2 | Webhook 触发 |
未读日志的数量
*/ UnreadRunLogCount?: string; /** *访客ID
*/ UserId?: string; } /** * Workspace 工作空间信息 */ export interface ConversationWorkspace { /** *工作空间 ID
*/ WorkspaceId: string; /** *存储类型
注意:此字段可能返回 null,表示取不到有效值。 */ StorageType?: string; } /** * 同一 SkillRefType 下的引用分组(含总数 + 引用详情列表)。 total_count 始终以未过滤的原始总量为准;reference_summary_list 受二次鉴权开关影响。 */ export interface SkillReferenceGroup { /** *该类型下的引用详情列表
*/ ReferenceSummaryList?: Array| 枚举项 | 枚举值 | 描述 |
| SKILL_REF_UNKNOWN | 0 | 占位 |
| SKILL_REF_OPENCLAW | 1 | openclaw |
| SKILL_REF_AGENT | 2 | agent |
| SKILL_REF_CORP_ASSISTANT | 3 | 企业助手 |
该类型下的引用总数
*/ TotalCount?: number; } /** * DeleteSpace返回参数结构体 */ export interface DeleteSpaceResponse { /** * 唯一请求 ID,由服务端生成,每次请求都会返回(若请求因其他原因未能抵达服务端,则该次请求不会获得 RequestId)。定位问题时需要提供该次请求的 RequestId。 */ RequestId?: string; } /** * DescribeAppTriggerInstance请求参数结构体 */ export interface DescribeAppTriggerInstanceRequest { /** *应用ID
*/ AppId?: string; /** *触发器运行实例ID
*/ InstanceId?: string; /** *| 枚举项 | 枚举值 | 描述 |
| APP_TRIGGER_SCOPE_UNSPECIFIED | 0 | 未指定 |
| APP_TRIGGER_SCOPE_APP | 1 | B 端管理员 |
| APP_TRIGGER_SCOPE_USER | 2 | C 端访客 |
访客ID
*/ UserId?: string; } /** * 应用密钥信息 */ export interface AppSecretInfo { /** * 应用密钥 */ AppKey: string; /** * 创建时间 */ CreateTime: string; } /** * Agent 详情 */ export interface AgentDetail { /** *Agent ID
*/ AgentId?: string; /** *Agent基本配置
*/ Profile?: AgentProfile; /** *系统提示词
*/ Instructions?: string; /** *模型信息
*/ Model?: AgentModelConfig; /** *工具详情
*/ ToolList?: Array插件配置
*/ PluginList?: Array技能详情
*/ SkillList?: Array高级配置
*/ AdvancedConfig?: AgentAdvancedConfig; /** *调用方执行的 Function Tool 列表
入参限制:仅在 C 端用户态 Agent 场景可用,B 端配置态 Agent 忽略该字段与
*/ ExternalToolList?: Array是否启用
*/ Enabled?: boolean; } /** * ModifyQA返回参数结构体 */ export interface ModifyQAResponse { /** * 唯一请求 ID,由服务端生成,每次请求都会返回(若请求因其他原因未能抵达服务端,则该次请求不会获得 RequestId)。定位问题时需要提供该次请求的 RequestId。 */ RequestId?: string; } /** * CreateApp请求参数结构体 */ export interface CreateAppRequest { /** * 空间ID */ SpaceId: string; /** * 应用模式。枚举值: 1:标准模式, 2:Agent模式, 3:单工作流模式, 4:ClawAgent模式 */ AppMode?: number; /** * 应用头像 */ Avatar?: string; /** * 应用描述 */ Description?: string; /** * 应用名称 */ Name?: string; } /** * DeleteApp返回参数结构体 */ export interface DeleteAppResponse { /** * 唯一请求 ID,由服务端生成,每次请求都会返回(若请求因其他原因未能抵达服务端,则该次请求不会获得 RequestId)。定位问题时需要提供该次请求的 RequestId。 */ RequestId?: string; } /** * ES 配置 */ export interface ESConfig { /** *是否支持修改存储方式
*/ CanModify?: boolean; /** *ES 密码(加密后)
*/ EncryptedPassword?: string; /** *ES 集群 ID
*/ InstanceId?: string; /** *存储类型:1=默认存储,2=自定义存储
| 枚举项 | 枚举值 | 描述 |
| ES_STORAGE_TYPE_UNKNOWN | 0 | |
| ES_STORAGE_TYPE_DEFAULT | 1 | 默认存储 |
| ES_STORAGE_TYPE_CUSTOM | 2 | 自定义存储 |
ES 用户名
*/ UserName?: string; } /** * AppTriggerWebhookStatus */ export interface AppTriggerWebhookStatus { /** *推送Webbook地址
*/ WebhookUrl?: string; } /** * ResumeAppTrigger返回参数结构体 */ export interface ResumeAppTriggerResponse { /** * 唯一请求 ID,由服务端生成,每次请求都会返回(若请求因其他原因未能抵达服务端,则该次请求不会获得 RequestId)。定位问题时需要提供该次请求的 RequestId。 */ RequestId?: string; } /** * Access Key 字段配置 */ export interface AccessKeyParamConfig { /** *Access Key 字段类型,1:AccessKeyId,2:AccessKeySecret,3:SessionToken
*/ FieldType?: number; /** *是否必填
*/ IsRequired?: boolean; /** *header/query 字段名
*/ ParamName?: string; /** *AccessKey密钥默认值,允许为空
*/ ParamValue?: string; } /** * CategoryPermission */ export interface CategoryPermission { /** *当前用户是否可新增子分类
*/ CanAdd?: boolean; /** *当前用户是否可删除该分类
*/ CanDelete?: boolean; /** *当前用户是否可编辑该分类
*/ CanEdit?: boolean; } /** * 文档任务状态信息 */ export interface DocTaskStatus { /** *已完成的历史任务类型列表
*/ CompletedTaskTypeList?: Array正在进行中的任务类型列表
*/ OngoingTaskTypeList?: Array会话 ID
*/ ConversationId: string; /** *会话类型 枚举值: 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(分享链接)
*/ Type: number; /** *Type=CONVERSATION_TYPE_API 时必填,应用密钥
*/ AppKey?: string; /** *子用户Uin
*/ LoginSubAccountUin?: string; /** *主用户Uin
*/ LoginUin?: string; /** *Type=CONVERSATION_TYPE_SHARE 时必填,分享码
*/ ShareCode?: string; /** *Type=CONVERSATION_TYPE_API 时必填,访客ID
*/ UserId?: string; } /** * TimerScheduleConfig */ export interface TimerScheduleConfig { /** * cron配置 */ Cron?: CronSchedule; /** * 每日触发 */ Daily?: DailySchedule; /** * 固定间隔 */ Interval?: IntervalSchedule; /** * 仅手动 */ ManualOnly?: ManualOnlySchedule; /** * 单次 */ Once?: OnceSchedule; /** * 枚举值: | uint | 描述 | | --- | --- | | 0 | | | 1 | 仅手动 | | 2 | 每天 | | 3 | 每周 | | 4 | 按间隔 | | 5 | 一次性 | | 6 | Cron | */ ScheduleType?: number; /** * 时区 */ Timezone?: string; /** * 每周固定时间触发 */ Weekly?: WeeklySchedule; } /** * OAuth2.0授权信息 */ export interface OAuthConfig { /** * OAuth服务方授权页url地址 */ AuthorizationUrl?: string; /** * 客户端ID */ ClientId?: string; /** * 客户端密钥 */ ClientSecret?: string; /** * 请求授权的数据范围 */ ScopeList?: Array基础计费信息
*/ BasicBilling?: BasicBilling; /** *| 枚举项 | 枚举值 | 描述 |
| BILLING_TYPE_FREE | 0 | 免费 |
| BILLING_TYPE_LIMITED_FREE | 1 | 限时免费 |
| BILLING_TYPE_OFFICIAL_PAID | 2 | 官方收费 |
| BILLING_TYPE_OFFICIAL_PAID_OLD_FREE | 3 | 官方收费(新/升级用户收费,存量老用户限时免费) |
复合类型计费信息
*/ ComplexBilling?: ComplexBilling; /** *双向计费信息
*/ DuplexBilling?: DuplexBilling; } /** * BasicBilling */ export interface BasicBilling { /** *| 枚举项 | 枚举值 | 描述 |
| UNKNOW | 0 | |
| TOKEN | 1 | 按token |
| PAGE_COUNT | 2 | 按页数 |
| TIMES | 3 | 按次数 |
| TIMES_THOUSAND | 4 | 按千次数 |
| SECOND | 5 | 按时长 |
| CHARACTER | 6 | 按字符数 |
| CHARACTER_THOUSAND | 7 | 按千字符数 |
| SHEET | 8 | 按张 |
| NUMBER | 9 | 按个数 |
现金价格
单位:元
*/ CashPrice?: number; /** *PU价格
单位:pu
*/ PuPrice?: number; } /** * DescribeApp请求参数结构体 */ export interface DescribeAppRequest { /** *应用ID
*/ AppId: string; /** *应用域: ADP_DOMAIN_DEV(1)=开发域, ADP_DOMAIN_PROD(2)=发布域。枚举值: 1:开发域, 2:生产域
*/ Domain?: number; /** *字段掩码,指定需要返回的字段(Paths为空则返回所有字段)。Paths枚举值:AppConfig(应用配置), SecretInfo(应用密钥信息), ShareUrlInfo(分享链接信息), SpecialStatusInfo(特殊状态信息), SearchResourceStatus(搜索资源状态), SharedKbList(应用引用的共享知识库列表),CorpShareConfig(企业共享配置)
*/ FieldMask?: FieldMask; /** *特殊状态类型(当FieldMask包含SpecialStatusInfo时必填)。枚举值: 1:回滚状态, 2:首次导入状态
*/ StatusType?: number; } /** * DescribeResourceSummary请求参数结构体 */ export type DescribeResourceSummaryRequest = null; /** * CreatePlugin返回参数结构体 */ export interface CreatePluginResponse { /** *插件id
*/ PluginId?: string; /** * 唯一请求 ID,由服务端生成,每次请求都会返回(若请求因其他原因未能抵达服务端,则该次请求不会获得 RequestId)。定位问题时需要提供该次请求的 RequestId。 */ RequestId?: string; } /** * DescribeLatestRelease请求参数结构体 */ export interface DescribeLatestReleaseRequest { /** * app_id */ AppId: string; } /** * DeleteChannel请求参数结构体 */ export interface DeleteChannelRequest { /** *应用业务ID
*/ AppId: string; /** *渠道业务ID
*/ ChannelId: string; /** *渠道场景:0-B端场景,1-C端场景
*/ Scene?: number; } /** * CronSchedule */ export interface CronSchedule { /** * cron表达式 */ Expression?: string; } /** * CopyAgentFromApp返回参数结构体 */ export interface CopyAgentFromAppResponse { /** *主 Agent Id
*/ ParentAgentId?: string; /** * 唯一请求 ID,由服务端生成,每次请求都会返回(若请求因其他原因未能抵达服务端,则该次请求不会获得 RequestId)。定位问题时需要提供该次请求的 RequestId。 */ RequestId?: string; } /** * ModifyQAList返回参数结构体 */ export interface ModifyQAListResponse { /** *批量修改结果
*/ ResultList?: Array答案
*/ Answer?: string; /** *知识生效作用域:1=停用,2=仅开发域,3=仅发布域,4=全域
| 枚举项 | 枚举值 | 描述 |
| KNOWLEDGE_EFFECTIVE_DOMAIN_UNKNOWN | 0 | |
| KNOWLEDGE_EFFECTIVE_DOMAIN_NONE | 1 | 停用 |
| KNOWLEDGE_EFFECTIVE_DOMAIN_DEV | 2 | 仅开发域 |
| KNOWLEDGE_EFFECTIVE_DOMAIN_RELEASE | 3 | 仅发布域 |
| KNOWLEDGE_EFFECTIVE_DOMAIN_ALL | 4 | 全域 |
关联文档名称
*/ FileName?: string; /** *关联文档类型
*/ FileType?: string; /** *QA ID
*/ QaId?: string; /** *问题
*/ Question?: string; /** *来源类型:1=文档生成,2=批量导入,3=手动录入
| 枚举项 | 枚举值 | 描述 |
| QA_SOURCE_TYPE_UNKNOWN | 0 | |
| QA_SOURCE_TYPE_DOC | 1 | 文档生成 |
| QA_SOURCE_TYPE_BATCH_IMPORT | 2 | 批量导入 |
| QA_SOURCE_TYPE_MANUAL | 3 | 手动录入 |
更新时间(Unix 秒,用于排序判断新旧)
*/ UpdateTime?: string; } /** * RetryRelease返回参数结构体 */ export interface RetryReleaseResponse { /** * 唯一请求 ID,由服务端生成,每次请求都会返回(若请求因其他原因未能抵达服务端,则该次请求不会获得 RequestId)。定位问题时需要提供该次请求的 RequestId。 */ RequestId?: string; } /** * 智能通话配置 */ export interface AICallConfig { /** * 数智人配置 注意:此字段可能返回 null,表示取不到有效值。 */ DigitalHuman: DigitalHumanConfig; /** * 启用数智人 */ EnableDigitalHuman: boolean; /** * 启用语音通话 */ EnableVoiceCall: boolean; /** * 启用语音互动功能 */ EnableVoiceInteract: boolean; /** * 音色配置 注意:此字段可能返回 null,表示取不到有效值。 */ Voice: VoiceConfig; } /** * ModifyChannel请求参数结构体 */ export interface ModifyChannelRequest { /** *应用业务ID
*/ AppId: string; /** *渠道业务ID
*/ ChannelId: string; /** *渠道场景:0-B端场景,1-C端场景
*/ Scene?: number; /** *待更新的渠道规格
*/ Spec?: ChannelSpec; /** *更新字段掩码,
B端(Scene=0):支持:【spec.description" ,"spec.wecom_robot.callback.wecom_robot_id"】
C端(Scene=1):支持:【"spec.description" , "spec.wecom_robot.websocket.bot_id" ,"spec.wecom_robot.websocket.bot_secret"】
是否走了审批流(false表示无需审批已直接创建共享任务)
*/ NeedApproval?: boolean; /** * 唯一请求 ID,由服务端生成,每次请求都会返回(若请求因其他原因未能抵达服务端,则该次请求不会获得 RequestId)。定位问题时需要提供该次请求的 RequestId。 */ RequestId?: string; } /** * 表格增强配置 */ export interface TableEnhancement { /** *是否启用
*/ Enabled?: boolean; } /** * 知识来源信息 */ export interface KnowledgeSource { /** *是否为大数据
*/ IsBigData?: boolean; /** *是否为共享知识库
*/ IsShared?: boolean; /** *知识库名
*/ KbName?: string; } /** * Agent摘要信息 */ export interface AgentSummary { /** *AgentId
*/ AgentId?: string; /** *Agent 身份画像
*/ Profile?: AgentProfile; /** *高级设置;scope=0 时返回
*/ AdvancedConfig?: AgentAdvancedConfig; } /** * DeleteAppTrigger返回参数结构体 */ export interface DeleteAppTriggerResponse { /** * 唯一请求 ID,由服务端生成,每次请求都会返回(若请求因其他原因未能抵达服务端,则该次请求不会获得 RequestId)。定位问题时需要提供该次请求的 RequestId。 */ RequestId?: string; } /** * 列表通用过滤条件(多个 Filter 之间为 AND 关系,同一 Filter 的多个 value_list 为 OR 关系;BETWEEN 时 value_list 必须恰好 2 个元素表示闭区间 [start, end]) */ export interface Filter { /** * 过滤字段名 */ Name?: string; /** * 操作符,默认 IN(向后兼容)| 枚举项 | 枚举值 | 描述 |
| FILTER_OPERATOR_IN | 0 | 属于 value_list(默认值,向后兼容;value_list 不可为空) |
| FILTER_OPERATOR_NOT_IN | 1 | 不属于 value_list(value_list 不可为空) |
| FILTER_OPERATOR_BETWEEN | 2 | 之间(闭区间 [start, end];value_list 必须恰好 2 个元素,允许其一为空表示单边开区间) |
计费套餐包用量信息
*/ ResourcePackage?: ResourcePackageInfo; /** *计费增值包用量信息
*/ AddOnPackage?: AddOnPackageInfo; /** * 唯一请求 ID,由服务端生成,每次请求都会返回(若请求因其他原因未能抵达服务端,则该次请求不会获得 RequestId)。定位问题时需要提供该次请求的 RequestId。 */ RequestId?: string; } /** * 工具信息 */ export interface ToolSummary { /** *工具Id
*/ ToolId?: string; } /** * ModifyLabel请求参数结构体 */ export interface ModifyLabelRequest { /** *修改字段内容(不可为空,与 update_mask 配合使用)
*/ Fields: LabelModifyFields; /** *所属知识库 ID
*/ KbId: string; /** *待修改的标签 ID
*/ LabelId: string; /** *字段掩码:指定要修改的字段(支持的 Paths:Name, TermModifyList)
*/ UpdateMask: FieldMask; } /** * ModifyCategory请求参数结构体 */ export interface ModifyCategoryRequest { /** *待修改的分类 ID(必须大于 0)
*/ CategoryId: string; /** *分类类型(不可为 0,取值:1=文档分类,2=问答分类)
| 枚举项 | 枚举值 | 描述 |
| CATEGORY_TYPE_UNKNOWN | 0 | |
| CATEGORY_TYPE_DOC | 1 | 文档分类 |
| CATEGORY_TYPE_QA | 2 | 问答分类 |
修改字段内容(不可为空,与 update_mask 配合使用)
*/ Fields: CategoryModifyFields; /** *所属知识库 ID
*/ KbId: string; /** *字段掩码:指定要修改的字段(支持的 Paths:Name)
*/ UpdateMask: FieldMask; } /** * Access Key 透传配置 */ export interface AccessKeyPassThroughConfig { /** *Access Key 字段统一注入位置,0:Header,1:Query
*/ KeyLocation?: number; } /** * DescribeSkillReferenceList请求参数结构体 */ export interface DescribeSkillReferenceListRequest { /** *Skill ID,必填
*/ SkillId: string; /** *空间ID,必填
*/ SpaceId: string; } /** * AppTriggerParamBindingConfig */ export interface AppTriggerParamBindingConfig { /** *绑定参数列表
*/ ParamList?: Array创建成功后的skillID
*/ SkillId?: string; /** *创建成功后的版本ID
*/ VersionId?: string; /** * 唯一请求 ID,由服务端生成,每次请求都会返回(若请求因其他原因未能抵达服务端,则该次请求不会获得 RequestId)。定位问题时需要提供该次请求的 RequestId。 */ RequestId?: string; } /** * DescribeAuditLogList请求参数结构体 */ export interface DescribeAuditLogListRequest { /** *空间id
*/ SpaceId?: string; /** *每页数量
取值范围:[1, 100]
*/ Limit?: number; /** *es查询起始位置
对应接口返回SearchAfter
*/ SearchAfter?: Array参数过滤
支持 Action,BizObject,Content
支持SpaceId,AccountUin,AppId(最多100个)
支持startTime,endTime(秒时间戳)
是否开启周期性更新
*/ Enabled?: boolean; /** *更新周期(小时)
*/ PeriodHour?: number; } /** * 输入框配置 */ export interface InputBoxConfig { /** * 输入框按钮,1:上传图片、2:上传文档,3:腾讯文档,4:联网搜索 */ InputBoxButtons?: Array调用次数(业务调用维度的顶层计数)
*/ CallCount?: number; /** *PLUGIN 域消耗计量列表(权威字段):按单位+label 分项列出每类计量。unit=TOKEN 时 label 区分 Token 子类别(input/output/avg_*),label 为空表示 total_tokens
*/ ResourceConsumptionList?: Array创建后的知识库 ID
*/ KbId?: string; /** * 唯一请求 ID,由服务端生成,每次请求都会返回(若请求因其他原因未能抵达服务端,则该次请求不会获得 RequestId)。定位问题时需要提供该次请求的 RequestId。 */ RequestId?: string; } /** * 应用插件配置信息 */ export interface AppPluginConfig { /** * 基于发布应用创建插件的应用ID */ AppId: string; } /** * 文档操作权限信息 */ export interface DocPermission { /** *是否可删除
*/ CanDelete?: boolean; /** *是否可编辑
*/ CanEdit?: boolean; /** *是否可重新生成
*/ CanRestart?: boolean; /** *是否可重试
*/ CanRetry?: boolean; } /** * 记忆配置 */ export interface AppMemoryConfig { /** * 是否开启长记忆 */ Enabled: boolean; /** * 长记忆时长 */ LongMemoryDay: number; /** * 模型配置 注意:此字段可能返回 null,表示取不到有效值。 */ Model: ModelDetailInfo; /** * prompt内容 */ PromptContent: string; /** * 提示词模式。枚举值: 1:自定义 */ PromptMode: number; } /** * TriggerStatus */ export interface TriggerStatus { /** *定时器状态
*/ ScheduledStatus?: AppTriggerScheduleStatus; /** *| 枚举项 | 枚举值 | 描述 |
| APP_TRIGGER_SCOPE_UNSPECIFIED | 0 | 未指定 |
| APP_TRIGGER_SCOPE_APP | 1 | B 端管理员 |
| APP_TRIGGER_SCOPE_USER | 2 | C 端访客 |
访客id
*/ UserId?: string; /** *Webhook状态
*/ WebhookStatus?: AppTriggerWebhookStatus; } /** * DescribeAgentSummaryList请求参数结构体 */ export interface DescribeAgentSummaryListRequest { /** *查询范围;0-单应用查询;1-跨应用查询
*/ Scope?: number; /** *应用Id,Scope=0 时为目标应用ID(必填);scope=1 时无需填写
*/ AppId?: string; /** *过滤条件(name: "SearchWord", "SpaceId", "AgentSource", "AppId")
*/ FilterList?: Array每页数目
*/ PageSize?: number; /** *页码
*/ PageNumber?: number; } /** * AppTriggerParamBinding */ export interface AppTriggerParamBinding { /** *参数名字
*/ ParamName?: string; /** *参数类型
枚举值:
参数值
*/ Value?: AppTriggerParamBindingValue; } /** * 插件配置 */ export interface PluginConfig { /** * API插件配置 注意:此字段可能返回 null,表示取不到有效值。 */ ApiPluginConfig?: ApiPluginConfig; /** * 应用插件配置 注意:此字段可能返回 null,表示取不到有效值。 */ AppPluginConfig?: AppPluginConfig; /** * mcp插件配置 注意:此字段可能返回 null,表示取不到有效值。 */ MCPPluginConfig?: MCPPluginConfig; } /** * 重排配置 */ export interface RerankConfig { /** *是否启用
*/ Enabled?: boolean; /** *模型名称
*/ ModelName?: string; } /** * 并发超限明细 */ export interface ConcurrencyLimitDetail { /** *调用来源(subject_type 决定 subject_id/subject_name 的含义,如 APP 时 subject_id=app_id、subject_name=app_name)
*/ CallSource?: CallSource; /** *超限发生时间(Unix秒)
*/ EventTime?: string; /** *模型名称
*/ ModelName?: string; /** *请求内容(用户请求的原始查询文本)
*/ RequestQuery?: string; /** *空间 ID
*/ SpaceId?: string; } /** * CreateMsgRecordCategory请求参数结构体 */ export interface CreateMsgRecordCategoryRequest { /** *分类名称
*/ Name: string; /** *应用 ID
*/ AppId: string; /** *父分类业务 ID,0 表示一级分类(未分类)
*/ ParentId?: string; } /** * DescribeAppStatisticsOverview返回参数结构体 */ export interface DescribeAppStatisticsOverviewResponse { /** *首 tokens 平均耗时(毫秒)
*/ AvgFirstTokenTime?: string; /** *总 tokens 平均耗时(毫秒)
*/ AvgTotalTokenTime?: string; /** *应用调用成功率(百分比,0~100)
*/ CallSuccessRate?: number; /** *回复类型分布列表;按 app_type 统计,已补全所有回复方式并按固定顺序返回,无数据的回复方式 call_count 为 0
*/ ReplyTypeDistributionList?: Array总调用次数
*/ TotalCallCount?: string; /** * 唯一请求 ID,由服务端生成,每次请求都会返回(若请求因其他原因未能抵达服务端,则该次请求不会获得 RequestId)。定位问题时需要提供该次请求的 RequestId。 */ RequestId?: string; } /** * DescribeAgentDetail请求参数结构体 */ export interface DescribeAgentDetailRequest { /** *应用Id
*/ AppId?: string; /** *AgentId
*/ AgentId?: string; } /** * Agent 插件参数配置 */ export interface AgentPluginParameter { /** *参数名称
*/ Name?: string; /** *是否必填
*/ IsRequired?: boolean; /** *输入的值
*/ Input?: AgentInput; } /** * 插件调用明细 */ export interface PluginUsageDetail { /** *插件名称
*/ PluginName?: string; /** *PLUGIN 域单次调用的消耗计量列表(权威字段):按单位+label 分项列出每类计量。unit=TOKEN 时 label 区分 Token 子类别(input/output/avg_*),label 为空表示 total_tokens
*/ ResourceConsumptionList?: Array插件工具名(tool_name)
*/ ToolName?: string; } /** * CopyApp请求参数结构体 */ export interface CopyAppRequest { /** * app_id */ AppId: string; /** * target_space_id */ TargetSpaceId?: string; } /** * CreateCategory请求参数结构体 */ export interface CreateCategoryRequest { /** *分类类型(不可为 0,取值:1=文档分类,2=问答分类)
| 枚举项 | 枚举值 | 描述 |
| CATEGORY_TYPE_UNKNOWN | 0 | |
| CATEGORY_TYPE_DOC | 1 | 文档分类 |
| CATEGORY_TYPE_QA | 2 | 问答分类 |
所属知识库 ID
*/ KbId: string; /** *分类名(长度:1~64 个字符)
*/ Name: string; /** *父分类 ID
*/ ParentCategoryId?: string; } /** * DescribeAgentDetail返回参数结构体 */ export interface DescribeAgentDetailResponse { /** *Agent信息
*/ Agent?: AgentDetail; /** * 唯一请求 ID,由服务端生成,每次请求都会返回(若请求因其他原因未能抵达服务端,则该次请求不会获得 RequestId)。定位问题时需要提供该次请求的 RequestId。 */ RequestId?: string; } /** * 检索可选配置 */ export interface RetrievalOption { /** *时效性检索增强配置
注意:此字段可能返回 null,表示取不到有效值。 */ ExpirationAwareness?: ExpirationAwareness; /** *GraphRAG配置
注意:此字段可能返回 null,表示取不到有效值。 */ GraphRag?: GraphRAG; /** *表格增强配置
注意:此字段可能返回 null,表示取不到有效值。 */ TableEnhancement?: TableEnhancement; } /** * DeleteSpace请求参数结构体 */ export interface DeleteSpaceRequest { /** * 空间id */ SpaceId?: string; } /** * [数据结构定义] 发布记录 */ export interface ReleaseRecord { /** * 是否可导出 */ CanExport: boolean; /** * 是否可回滚 */ CanRollback: boolean; /** * 发布描述 */ Description: string; /** * 发布失败数 */ FailCount: number; /** * 失败原因 */ Reason: string; /** * 发布ID */ ReleaseId: string; /** * 发布版本 */ ReleaseVersion: string; /** * 发布状态。枚举值: 1:待发布, 2:发布中, 3:发布成功, 4:发布失败, 5:审核中, 6:审核成功, 7:审核失败, 8:发布成功回调处理中, 9:发布暂停, 10:申诉审核中, 11:申诉审核通过, 12:申诉审核不通过 */ Status: number; /** * 状态描述 */ StatusDescription: string; /** * 发布成功数 */ SuccessCount: number; /** * 更新时间 (Unix时间戳,秒级) */ UpdateTime: string; /** * 发布人 */ Updater: string; } /** * 单次对话 token 消耗信息 */ export interface ConversationRecordTokenUsage { /** *输入 token 总数
*/ InputTokens?: string; /** *输出 token 总数
*/ OutputTokens?: string; /** *消耗 token 总数
*/ TotalTokens?: string; /** *缓存命中 token 总数
*/ CachedTokens?: string; /** *推理 token 总数
*/ ReasoningTokens?: string; } /** * SkillAnalysisInfo Skill 安全扫描信息。 */ export interface SkillAnalysisInfo { /** * 安全检测状态 枚举值: | uint | 描述 | | --- | --- | | 0 | 待检测 | | 1 | 检测中 | | 2 | 可用 | | 3 | 不可用 | | 4 | 检测失败 | */ AnalysisStatus: number; /** * 风险描述 */ RiskDescription: string; /** * 风险等级 枚举值: | uint | 描述 | | --- | --- | | 0 | 无风险 | | 1 | 低风险 | | 2 | 中风险 | | 3 | 高风险 | */ RiskLevel: number; /** * 安全报告跳转url; */ SecurityReportUrl: string; } /** * AppTriggerWorkflowExecuteConfig */ export interface AppTriggerWorkflowExecuteConfig { /** *工作流API参数绑定
*/ ParamBindingsApi?: AppTriggerParamBindingConfig; /** *工作流参数绑定
*/ ParamBindingsWorkflow?: AppTriggerParamBindingConfig; /** *工作流ID
*/ WorkflowId?: string; /** *工作流名字
*/ WorkflowName?: string; } /** * 标签引用身份标识(入参用) */ export interface LabelRefIdentity { /** *标签 ID
*/ LabelId?: string; /** *标签标准词 ID 列表
*/ LabelTermIdList?: Array相似问数量
*/ SimilarQuestionCount?: number; /** *相似问提示(展示一条相似问样例)
*/ SimilarQuestionTips?: string; } /** * 应用高级配置 */ export interface AppAdvancedConf { /** *是否开启上下文改写
*/ EnableContextRewrite: boolean; /** *是否开启图文检索
*/ EnableImageTextRetrieval: boolean; /** *回复灵活度
*/ ReplyFlexibility: number; /** *对话端自定义配置(所有模式共用,允许对话中动态修改配置)
注意:此字段可能返回 null,表示取不到有效值。 */ DialogCustomConfig?: DialogCustomConfig; /** *意图达成优先级
*/ IntentAchievement?: Array关联的应用列表,仅共享知识库返回
*/ AppList?: Array创建时间(Unix 秒)
*/ CreateTime?: string; /** *创建人
注意:此字段可能返回 null,表示取不到有效值。 */ Creator?: Operator; /** *描述
*/ Description?: string; /** *文档数
*/ DocCount?: number; /** *是否超量
*/ IsExceeded?: boolean; /** *知识库 ID
*/ KbId?: string; /** *类型:1=默认知识库,2=共享知识库
| 枚举项 | 枚举值 | 描述 |
| KB_TYPE_UNKNOWN | 0 | |
| KB_TYPE_DEFAULT | 1 | 默认知识库 |
| KB_TYPE_SHARED | 2 | 共享知识库 |
最后操作人,仅共享知识库返回
注意:此字段可能返回 null,表示取不到有效值。 */ LatestOperator?: Operator; /** *知识库名称
*/ Name?: string; /** *操作权限
注意:此字段可能返回 null,表示取不到有效值。 */ Permission?: KBPermission; /** *处理中状态列表
*/ ProcessingFlagList?: Array共享子类型:1=普通,2=公众号
| 枚举项 | 枚举值 | 描述 |
| SHARED_KB_SUB_TYPE_UNKNOWN | 0 | |
| SHARED_KB_SUB_TYPE_NORMAL | 1 | 普通 |
| SHARED_KB_SUB_TYPE_PUBLIC_ACCOUNT | 2 | 公众号 |
更新时间(Unix 秒)
*/ UpdateTime?: string; } /** * PauseAppTrigger返回参数结构体 */ export interface PauseAppTriggerResponse { /** * 唯一请求 ID,由服务端生成,每次请求都会返回(若请求因其他原因未能抵达服务端,则该次请求不会获得 RequestId)。定位问题时需要提供该次请求的 RequestId。 */ RequestId?: string; } /** * ModifyKB返回参数结构体 */ export interface ModifyKBResponse { /** * 唯一请求 ID,由服务端生成,每次请求都会返回(若请求因其他原因未能抵达服务端,则该次请求不会获得 RequestId)。定位问题时需要提供该次请求的 RequestId。 */ RequestId?: string; } /** * DuplexBilling */ export interface DuplexBilling { /** *| 枚举项 | 枚举值 | 描述 |
| UNKNOW | 0 | |
| TOKEN | 1 | 按token |
| PAGE_COUNT | 2 | 按页数 |
| TIMES | 3 | 按次数 |
| TIMES_THOUSAND | 4 | 按千次数 |
| SECOND | 5 | 按时长 |
| CHARACTER | 6 | 按字符数 |
| CHARACTER_THOUSAND | 7 | 按千字符数 |
| SHEET | 8 | 按张 |
| NUMBER | 9 | 按个数 |
输入现金价格
单位:元
*/ InputCashPrice?: number; /** *输入pu价格
单位:pu
*/ InputPuPrice?: number; /** *输出现金价格
单位:元
*/ OutputCashPrice?: number; /** *输出pu价格
单位:pu
*/ OutputPuPrice?: number; } /** * 特殊状态信息 */ export interface SpecialStatusInfo { /** * 状态 (0-不在特殊状态中, 1-在特殊状态中)。枚举值: 1:在特殊状态中 */ Status: number; }