///
import { AxiosPromise, AxiosRequestConfig } from "axios";
/** 智能通话 */
declare interface AICallConfig {
/** 启用语音互动功能 */
EnableVoiceInteract?: boolean | null;
/** 启用语音通话 */
EnableVoiceCall?: boolean | null;
/** 启用数智人 */
EnableDigitalHuman?: boolean | null;
/** 音色配置 */
Voice?: VoiceConfig | null;
/** 数智人配置 */
DigitalHuman?: DigitalHumanConfig | null;
}
/** Agent 的定义 */
declare interface Agent {
/** AgentID */
AgentId?: string;
/** WorkflowID,非空则当前Agent从workflow转换而来 */
WorkflowId?: string;
/** Agent名称,同一个应用内,Agent名称不能重复 */
Name?: string;
/** Agent图标url */
IconUrl?: string;
/** Agent指令;当该Agent被调用时,将作为“系统提示词”使用,描述Agent应执行的操作和响应方式 */
Instructions?: string;
/** 当Agent作为转交目标时的描述,用于让其他Agent的LLM理解其功能和转交时机 */
HandoffDescription?: string;
/** Agent可转交的子AgentId列表 */
Handoffs?: string[];
/** Agent调用LLM时使用的模型配置 */
Model?: AgentModelInfo;
/** Agent可使用的工具列表 */
Tools?: AgentToolInfo[];
/** Agent可使用的插件列表 */
Plugins?: AgentPluginInfo[];
/** 当前Agent是否是启动Agent */
IsStartingAgent?: boolean;
/** Agent类型; 0: 未指定类型; 1: 知识库检索Agent */
AgentType?: number;
/** 0 自由转交,1 计划与执行 */
AgentMode?: number;
/** 高级设置 */
AdvancedConfig?: AgentAdvancedConfig;
}
/** Agent高级设置 */
declare interface AgentAdvancedConfig {
/** 是否开启澄清询问 */
EnableClarification?: boolean;
/** 思考模式,0为效果优先,1为速度优先 */
ThinkingMode?: number;
/** 最大推理轮数 */
MaxReasoningRound?: number;
/** 上下文轮数 */
HistoryLimit?: number;
/** 是否开启结构化输出 */
EnableStructuredOutput?: boolean;
/** 结构化输出配置 */
StructuredOutputConfig?: StructuredOutputConfig;
/** Agent输出配置 */
AgentOutputConfig?: AgentOutputConfig;
/** 澄清询问配置 */
ClarificationConfig?: ClarificationConfig;
}
/** Agent调试信息 */
declare interface AgentDebugInfo {
/** 工具、大模型的输入信息,json */
Input?: string | null;
/** 工具、大模型的输出信息,json */
Output?: string | null;
/** 模型名 */
ModelName?: string;
}
/** Agent转交高级设置 */
declare interface AgentHandoffAdvancedSetting {
/** 对话流转策略;0-由上一轮回复用户的 Agent 继续发起,1- 回到主Agent */
ConversationPolicy?: number;
}
/** Agent输入值,支持直接赋值和引用 */
declare interface AgentInput {
/** 输入来源类型:0 用户输入,3 自定义变量(API参数) */
InputType?: number;
/** 用户手写输入 */
UserInputValue?: AgentInputUserInputValue;
/** 自定义变量(API参数) */
CustomVarId?: string;
/** 环境变量参数 */
EnvVarId?: string;
/** 应用变量参数 */
AppVarId?: string;
/** 系统参数 */
SystemVariable?: AgentInputSystemVariable;
/** 工具参数 */
ToolParam?: string;
}
/** 系统参数 */
declare interface AgentInputSystemVariable {
/** 系统参数名 */
Name?: string;
/** 对话历史轮数的配置;如果Input是系统变量中的“对话历史”时才使用; */
DialogHistoryLimit?: number;
}
/** 用户手写输入 */
declare interface AgentInputUserInputValue {
/** 用户输入的值 */
Values?: string[];
}
/** Agent 知识库检索插件支持多知识库搜索 */
declare interface AgentKnowledge {
/** 知识库id */
KnowledgeBizId?: string;
/** 0-应用内知识库1-共享知识库 */
KnowledgeType?: number;
/** 0-全部知识1-按文档和问答2-按标签 */
Filter?: number;
/** 文档id */
DocBizIds?: string[];
/** true:包含所有问答false:不包含问答 */
AllQa?: boolean;
/** 文档标签过滤器 */
Tag?: AgentKnowledgeFilterTag;
}
/** 标签过滤器 */
declare interface AgentKnowledgeAttrLabel {
/** 属性ID */
AttributeBizId?: string;
/** 标签值,标签值之间是或的关系,只有匹配的,才会进行知识检索,否则报检索不到 */
Inputs?: AgentInput[];
}
/** 知识检索筛选范围 */
declare interface AgentKnowledgeFilter {
/** 知识检索筛选方式; 0: 全部知识; 1:按文档和问答; 2: 按标签 */
FilterType?: number;
/** 文档和问答过滤器 */
DocAndAnswer?: AgentKnowledgeFilterDocAndAnswer;
/** 标签过滤器 */
Tag?: AgentKnowledgeFilterTag;
/** 知识库列表 */
KnowledgeList?: AgentKnowledge[];
/** 是否检索全部知识 */
AllKnowledge?: boolean;
}
/** 文档和问答过滤器 */
declare interface AgentKnowledgeFilterDocAndAnswer {
/** 文档ID列表 */
DocBizIds?: string[];
/** 问答 */
AllQa?: boolean;
}
/** 标签过滤器 */
declare interface AgentKnowledgeFilterTag {
/** 标签之间的关系;0:AND, 1:OR */
Operator?: number;
/** 标签 */
Labels?: AgentKnowledgeAttrLabel[];
}
/** 知识库问答插件 */
declare interface AgentKnowledgeQAPlugin {
/** 知识检索筛选范围 */
Filter?: AgentKnowledgeFilter;
}
/** mcp的服务信息 */
declare interface AgentMCPServerInfo {
/** mcp server URL地址 */
McpServerUrl?: string;
/** mcp server header信息 */
Headers?: AgentPluginHeader[];
/** 超时时间,单位秒 */
Timeout?: number;
/** sse服务超时时间,单位秒 */
SseReadTimeout?: number;
/** mcp server query信息 */
Query?: AgentPluginQuery[];
}
/** Agent 配置里面的模型定义 */
declare interface AgentModelInfo {
/** 模型名称 */
ModelName?: string;
/** 模型别名 */
ModelAliasName?: string;
/** 模型温度 */
Temperature?: number;
/** 模型TopP */
TopP?: number;
/** 模型是否可用 */
IsEnabled?: boolean;
/** 对话历史条数限制 */
HistoryLimit?: number;
/** 模型上下文长度字符限制 */
ModelContextWordsLimit?: string;
/** 指令长度字符限制 */
InstructionsWordsLimit?: number;
/** 单次会话最大推理轮数 */
MaxReasoningRound?: number;
/** 模型参数 */
ModelParams?: ModelParams;
}
/** Agent输出配置 */
declare interface AgentOutputConfig {
/** 输出类型,1-文本 2-json 3-widget */
OutputType?: number;
/** Json结构化输出参数列表 */
StructuredOutputParams?: ParameterConfig[];
/** widget id */
WidgetId?: string;
}
/** 应用配置MCP插件header信息 */
declare interface AgentPluginHeader {
/** 参数名称 */
ParamName?: string;
/** 参数值 */
ParamValue?: string;
/** header参数配置是否隐藏不可见 */
GlobalHidden?: boolean;
/** 输入的值 */
Input?: AgentInput;
/** 参数是否可以为空 */
IsRequired?: boolean;
}
/** Agent 的插件信息 */
declare interface AgentPluginInfo {
/** 插件id */
PluginId?: string;
/** 应用配置的插件header信息 */
Headers?: AgentPluginHeader[];
/** 插件调用LLM时使用的模型配置,一般用于指定知识库问答插件的生成模型 */
Model?: AgentModelInfo;
/** 插件信息类型; 0: 未指定类型; 1: 知识库问答插件 */
PluginInfoType?: number;
/** 知识库问答插件配置 */
KnowledgeQa?: AgentKnowledgeQAPlugin;
/** 是否使用一键授权 */
EnableRoleAuth?: boolean | null;
/** 应用配置的插件query信息 */
Query?: AgentPluginQuery[];
/** MCP类型 */
McpType?: number;
}
/** 应用配置MCP插件query信息 */
declare interface AgentPluginQuery {
/** 参数名称 */
ParamName?: string;
/** 参数值 */
ParamValue?: string;
/** query参数配置是否隐藏不可见,true-隐藏不可见,false-可见 */
GlobalHidden?: boolean;
/** 参数是否可以为空 */
IsRequired?: boolean;
/** 输入的值 */
Input?: AgentInput;
}
/** 思考事件过程信息 */
declare interface AgentProcedure {
/** 索引 */
Index?: number | null;
/** 执行过程英语名 */
Name?: string | null;
/** 中文名, 用于展示 */
Title?: string | null;
/** 状态常量: 使用中: processing, 成功: success, 失败: failed */
Status?: string | null;
/** 图标 */
Icon?: string | null;
/** Agent调试信息 */
Debugging?: AgentProcedureDebugging | null;
/** 是否切换Agent,取值为"main"或者"workflow",不切换为空 */
Switch?: string | null;
/** 工作流名称 */
WorkflowName?: string | null;
/** 当前请求执行时间, 单位 ms */
Elapsed?: number | null;
/** 工作流节点名称 */
NodeName?: string | null;
/** 用于展示思考放在哪个回复气泡中 */
ReplyIndex?: number | null;
/** 主agent */
SourceAgentName?: string | null;
/** 挂号agent */
TargetAgentName?: string | null;
/** Agent的图标 */
AgentIcon?: string | null;
}
/** Agent思考过程调试信息 */
declare interface AgentProcedureDebugging {
/** 模型思考内容 */
Content?: string | null;
/** 展示的具体文本内容 */
DisplayContent?: string | null;
/** 1:搜索引擎参考来源;2:知识库参考来源 */
DisplayType?: number | null;
/** 搜索引擎展示的索引 */
QuoteInfos?: QuoteInfo[] | null;
/** 具体的参考来源 */
References?: AgentReference[] | null;
/** 展示正在执行的状态 */
DisplayStatus?: string | null;
/** 云桌面的URL地址 */
SandboxUrl?: string | null;
/** 云桌面里面通过浏览器打开的URL地址 */
DisplayUrl?: string | null;
}
/** Agent中的参考来源 */
declare interface AgentReference {
/** 来源文档ID */
DocId?: string | null;
/** id */
Id?: string | null;
/** 名称 */
Name?: string | null;
/** 类型 */
Type?: number | null;
/** 链接 */
Url?: string | null;
/** 文档业务ID */
DocBizId?: string | null;
/** 文档名称 */
DocName?: string | null;
/** 问答业务ID */
QaBizId?: string | null;
/** 搜索引擎索引 */
Index?: number | null;
/** 标题 */
Title?: string | null;
/** 知识库名称 */
KnowledgeName?: string | null;
/** 知识库标识 */
KnowledgeBizId?: string | null;
}
/** Agent的思考过程 */
declare interface AgentThought {
/** 会话 ID */
SessionId?: string | null;
/** 请求 ID */
RequestId?: string | null;
/** 对应哪条会话, 会话 ID, 用于回答的消息存储使用, 可提前生成, 保存消息时使用 */
RecordId?: string | null;
/** 当前请求执行时间, 单位 ms */
Elapsed?: number | null;
/** 当前是否为工作流 */
IsWorkflow?: boolean | null;
/** 如果当前是工作流,工作流名称 */
WorkflowName?: string | null;
/** 具体思考过程详情 */
Procedures?: AgentProcedure[] | null;
/** TraceId */
TraceId?: string | null;
/** 文件信息 */
Files?: FileInfo[] | null;
}
/** Agent的工具信息 */
declare interface AgentToolInfo {
/** 插件id */
PluginId?: string;
/** 插件名称 */
PluginName?: string;
/** 插件图标url */
IconUrl?: string;
/** 0 自定义插件1 官方插件2 第三方插件 目前用于第三方实现的mcp server */
PluginType?: number;
/** 工具id */
ToolId?: string;
/** 工具名称 */
ToolName?: string;
/** 工具描述 */
ToolDesc?: string;
/** 输入参数 */
Inputs?: AgentToolReqParam[];
/** 输出参数 */
Outputs?: AgentToolRspParam[];
/** 创建方式,0:服务创建,1:代码创建,2:MCP创建 */
CreateType?: number;
/** MCP插件的配置信息 */
McpServer?: AgentMCPServerInfo;
/** 该工具是否和知识库绑定 */
IsBindingKnowledge?: boolean;
/** 插件状态,1:可用,2:不可用 */
Status?: number;
/** header信息 */
Headers?: AgentPluginHeader[];
/** NON_STREAMING: 非流式 STREAMIN: 流式 */
CallingMethod?: string | null;
/** query信息 */
Query?: AgentPluginQuery[];
/** 工具计费状态 0-不计费 1-可用 2-不可用(欠费、无资源等) */
FinanceStatus?: number;
/** 工具来源: 0-来自插件,1-来自工作流 */
ToolSource?: number;
/** 计费状态;0-不计费,1-限时免费,2-官方收费 */
FinanceType?: number;
/** 工具高级设置 */
ToolAdvanceConfig?: ToolAdvanceConfig;
/** 授权模式; 0-开发者授权;1-使用者授权 */
AuthMode?: number;
/** 授权类型; 0-无鉴权;1-APIKey;2-CAM授权;3-Oauth2.0授权; */
AuthType?: number;
}
/** Agent工具的请求参数定义 */
declare interface AgentToolReqParam {
/** 参数名称 */
Name?: string;
/** 参数描述 */
Desc?: string;
/** 参数类型,0:string, 1:int, 2:float,3:bool 4:object 5:array_string, 6:array_int, 7:array_float, 8:array_bool, 9:array_object */
Type?: number;
/** 参数是否必填 */
IsRequired?: boolean;
/** 参数默认值 */
DefaultValue?: string;
/** 子参数,ParamType 是OBJECT 或 ARRAY<>类型有用 */
SubParams?: AgentToolReqParam[];
/** 是否隐藏不可见 */
GlobalHidden?: boolean;
/** agent模式下模型是否可见 */
AgentHidden?: boolean;
/** 其中任意 */
AnyOf?: AgentToolReqParam[];
/** 其中一个 */
OneOf?: AgentToolReqParam[];
/** 输入 */
Input?: AgentInput;
}
/** Agent工具的响应参数定义 */
declare interface AgentToolRspParam {
/** 参数名称 */
Name?: string;
/** 参数描述 */
Desc?: string;
/** 参数类型,0:string, 1:int, 2:float,3:bool 4:object 5:array_string, 6:array_int, 7:array_float, 8:array_bool, 9:array_object */
Type?: number;
/** 子参数,ParamType 是OBJECT 或 ARRAY<>类型有用 */
SubParams?: AgentToolRspParam[];
/** agent模式下模型是否可见 */
AgentHidden?: boolean;
/** 是否隐藏不可见 */
GlobalHidden?: boolean;
/** COVER: 覆盖解析 INCREMENT:增量解析 */
AnalysisMethod?: string;
}
/** 自定义变量和标签关系数据 */
declare interface ApiVarAttrInfo {
/** 自定义变量id */
ApiVarId?: string | null;
/** 标签id */
AttrBizId?: string | null;
}
/** 应用基础信息 */
declare interface AppBaseInfo {
/** 应用ID */
AppBizId?: string;
/** 应用名称 */
AppName?: string | null;
}
/** 应用配置 */
declare interface AppConfig {
/** 知识问答管理应用配置 */
KnowledgeQa?: KnowledgeQaConfig | null;
/** 知识摘要应用配置 */
Summary?: SummaryConfig | null;
/** 标签提取应用配置 */
Classify?: ClassifyConfig | null;
}
/** 应用详情 */
declare interface AppInfo {
/** 应用类型;knowledge_qa-知识问答管理;summary-知识摘要;classifys-知识标签提取 */
AppType?: string | null;
/** 应用类型描述 */
AppTypeDesc?: string | null;
/** 应用ID */
AppBizId?: string | null;
/** 应用名称 */
Name?: string | null;
/** 应用头像 */
Avatar?: string | null;
/** 应用描述 */
Desc?: string | null;
/** 应用状态,1:未上线,2:运行中,3:停用 */
AppStatus?: number | null;
/** 状态说明 */
AppStatusDesc?: string | null;
/** 修改时间 */
UpdateTime?: string | null;
/** 最后修改人 */
Operator?: string | null;
/** 模型名称 */
ModelName?: string | null;
/** 生成模型别名 */
ModelAliasName?: string | null;
/** 应用模式 standard:标准模式, agent: agent模式,single_workflow:单工作流模式 */
Pattern?: string | null;
/** 思考模型别名 */
ThoughtModelAliasName?: string | null;
/** 权限位信息 */
PermissionIds?: string[];
/** 创建人昵称 */
Creator?: string | null;
}
/** 应用模型配置 */
declare interface AppModel {
/** 模型名称 */
Name?: string | null;
/** 模型描述 */
Desc?: string | null;
/** 上下文指代轮次 */
ContextLimit?: number | null;
/** 模型别名 */
AliasName?: string | null;
/** token余量 */
TokenBalance?: number | null;
/** 是否使用上下文指代轮次 */
IsUseContext?: boolean | null;
/** 上下文记忆轮数 */
HistoryLimit?: number | null;
/** 使用类型 */
UsageType?: string | null;
/** 模型温度 */
Temperature?: string | null;
/** 模型TopP */
TopP?: string | null;
/** 模型资源状态 1:资源可用;2:资源已用尽 */
ResourceStatus?: number | null;
/** 模型参数 */
ModelParams?: ModelParams | null;
}
/** 模型详情 */
declare interface AppModelDetailInfo {
/** 模型名称 */
ModelName?: string;
/** 模型参数 */
ModelParams?: ModelParams;
/** 限制 */
HistoryLimit?: number;
/** 模型别名 */
AliasName?: string;
}
/** 标签详情信息 */
declare interface AttrLabel {
/** 标签来源 */
Source?: number | null;
/** 标签ID */
AttrBizId?: string | null;
/** 标签标识 */
AttrKey?: string | null;
/** 标签名称 */
AttrName?: string | null;
/** 标签值 */
Labels?: Label[] | null;
}
/** 标签详情 */
declare interface AttrLabelDetail {
/** 标签ID */
AttrBizId?: string | null;
/** 标签标识 */
AttrKey?: string | null;
/** 标签名称 */
AttrName?: string | null;
/** 标签值名称 */
LabelNames?: string[] | null;
/** 标签是否在更新中 */
IsUpdating?: boolean | null;
/** 发布状态(1 待发布 2 发布中 3 已发布 4 发布失败) */
Status?: number | null;
/** 状态描述 */
StatusDesc?: string | null;
/** 标签值总数 */
LabelTotalCount?: string;
}
/** 标签引用信息 */
declare interface AttrLabelRefer {
/** 标签来源,1:标签 */
Source?: number;
/** 标签ID */
AttributeBizId?: string;
/** 标签值ID */
LabelBizIds?: string[];
}
/** 导出知识标签过滤器 */
declare interface AttributeFilters {
/** 检索,属性或标签名称 */
Query?: string;
}
/** 标签值 */
declare interface AttributeLabel {
/** 标准词ID */
LabelBizId?: string | null;
/** 标准词名称 */
LabelName?: string | null;
/** 同义词名称 */
SimilarLabels?: string[] | null;
}
/** 标签值引用的工作流详情 */
declare interface AttributeLabelRefByWorkflow {
/** 标签值id */
AttributeLabelBizId?: string;
/** 标签值引用的工作流列表 */
WorkflowList?: WorkflowRef[];
}
/** 音频信息 */
declare interface Audio {
/** 音频文件格式 */
Format?: string;
/** 音频文件地址 */
AudioUrl?: string;
/** 音频标题 */
Title?: string | null;
/** 音频文件在正文中的位置 */
Position?: number | null;
/** 音频转录后的文字列表 */
AudioTranscripts?: AudioTranscript[] | null;
}
/** 音频转录的文本内容 */
declare interface AudioTranscript {
/** 音频的发言者 */
Speaker?: string | null;
/** 音频转录为文字后的内容 */
Transcript?: string | null;
}
/** 背景图相关配置 */
declare interface BackgroundImageConfig {
/** 横图(pc) */
LandscapeImageUrl?: string;
/** 原始图 */
OriginalImageUrl?: string;
/** 长图(手机) */
PortraitImageUrl?: string;
/** 主题色 */
ThemeColor?: string;
/** 亮度值 */
Brightness?: number;
}
/** 应用基础配置 */
declare interface BaseConfig {
/** 应用名称 */
Name: string;
/** 应用头像url,在CreateApp和ModifyApp中作为入参必填。作为入参传入说明:1. 传入的url图片限制为jpeg和png,大小限制为500KB,url链接需允许head请求。2. 如果用户没有对象存储,可使用“获取文件上传临时密钥”(DescribeStorageCredential)接口,获取cos临时密钥和上传路径,自行上传头像至cos中并获取访问链接。 */
Avatar: string;
/** 应用描述 */
Desc?: string;
}
/** 调用类型 */
declare interface CallDetail {
/** 关联ID */
Id?: string | null;
/** 调用时间 */
CallTime?: string | null;
/** 总token消耗 */
TotalTokenUsage?: number | null;
/** 输入token消耗 */
InputTokenUsage?: number | null;
/** 输出token消耗 */
OutputTokenUsage?: number | null;
/** 搜索服务调用次数 */
SearchUsage?: number | null;
/** 模型名称 */
ModelName?: string | null;
/** 调用类型 */
CallType?: string | null;
/** 账号 */
UinAccount?: string | null;
/** 应用名称 */
AppName?: string | null;
/** 总消耗页数 */
PageUsage?: number | null;
/** 筛选子场景 */
SubScene?: string | null;
/** 账单明细对应的自定义tag */
BillingTag?: string;
}
/** 分类信息 */
declare interface CateInfo {
/** 分类ID */
CateBizId?: string | null;
/** 分类名称 */
Name?: string | null;
/** 分类下的Record(如文档、同义词等)数量 */
Total?: number | null;
/** 是否可新增 */
CanAdd?: boolean | null;
/** 是否可编辑 */
CanEdit?: boolean | null;
/** 是否可删除 */
CanDelete?: boolean | null;
/** 子分类 */
Children?: CateInfo[] | null;
/** 是否为叶子节点 */
IsLeaf?: boolean | null;
}
/** 渠道详情信息 */
declare interface ChannelListInfo {
/** 渠道类型 10000 微信订阅号 10001 微信服务号 10002 企微应用 */
ChannelType?: number;
/** 渠道状态 1未发布 2运行中 3已下线 */
ChannelStatus?: number;
/** 渠道名称 */
ChannelName?: string;
/** 渠道id 数据库主键 */
ChannelId?: string;
/** 备注 */
Comment?: string;
/** 更新时间 */
UpdateTime?: string;
/** 创建时间 */
CreateTime?: string;
/** 最后更新人 */
UpdatedUser?: string;
/** 智能体应用可见范围,public-所有人可见 private-仅自己可见 share-通过分享可见 */
YuanQiInfo?: YuanQi | null;
}
/** 澄清询问配置 */
declare interface ClarificationConfig {
/** 输出类型,1-文本 3-widget */
OutputType?: number;
/** 澄清widget配置 */
WidgetConfigs?: ClarificationWidgetConfig[];
}
/** 澄清widget配置 */
declare interface ClarificationWidgetConfig {
/** widget id */
WidgetId?: string;
/** 澄清widget类型 */
ClarificationWidgetType?: number;
/** Widget名称 */
WidgetName?: string;
/** Widget预览 */
WidgetPreview?: string;
/** 是否启用该Widget作为澄清样式 */
Enabled?: boolean;
}
/** 标签提取配置 */
declare interface ClassifyConfig {
/** 模型配置 */
Model?: AppModel | null;
/** 标签列表 */
Labels?: ClassifyLabel[] | null;
/** 欢迎语,200字符以内 */
Greeting?: string | null;
}
/** 标签信息 */
declare interface ClassifyLabel {
/** 标签名称 */
Name?: string | null;
/** 标签描述 */
Description?: string | null;
/** 标签取值范围 */
Values?: string[] | null;
}
/** 对话记录内容详情 */
declare interface Content {
/** 消息内容类型text:文本image:图片file:文件option_cards:选项卡custom_params:用户自定义业务参数sandbox:云桌面custom_variables:自定义输入参数web_search: 网页搜索内容file_collection:文件收集信息widget:widget信息widget_action:用户端widget动作信息 */
Type?: string;
/** 文本内容 */
Text?: string | null;
/** 引用信息 */
QuoteInfos?: QuoteInfo[] | null;
/** 参考文献信息 */
References?: ContentReference[] | null;
/** 图片信息 */
Image?: ImageInfoContent | null;
/** 文件信息 */
File?: FileInfoContent | null;
/** 选项卡信息 */
OptionCards?: string[] | null;
/** 用户自定义业务参数信息 */
CustomParams?: string[] | null;
/** 自定义变量 */
CustomVariables?: string[] | null;
/** 沙盒信息 */
Sandbox?: SandboxContent | null;
/** 网页搜索内容 */
WebSearch?: WebSearchContent | null;
/** 文件收集信息 */
FileCollection?: FileCollection | null;
/** Widget信息 */
Widget?: Widget | null;
/** Widget动作信息 */
WidgetAction?: WidgetAction | null;
}
/** 会话内容参考文献信息 */
declare interface ContentReference {
/** 引用来源索引ID */
Index?: number | null;
/** 参考来源名称 */
Name?: string;
/** 参考来源类型1:问答2:文档片段4:联网检索到的内容 */
Type?: number;
/** 文档片段参考信息 */
DocRefer?: DocReference | null;
/** 问答参考信息 */
QaRefer?: QaReference | null;
/** 联网检索内容参考信息 */
WebSearchRefer?: WebSearchReference | null;
}
/** 获取不满意回复上下文响 */
declare interface Context {
/** 消息记录ID信息 */
RecordBizId?: string | null;
/** 是否为用户 */
IsVisitor?: boolean | null;
/** 昵称 */
NickName?: string | null;
/** 头像 */
Avatar?: string | null;
/** 消息内容 */
Content?: string | null;
/** 文档信息 */
FileInfos?: MsgFileInfo[] | null;
/** 回复方式,15:澄清确认回复 */
ReplyMethod?: number | null;
}
/** 临时密钥结构 */
declare interface Credentials {
/** token */
Token?: string | null;
/** 临时证书密钥ID */
TmpSecretId?: string | null;
/** 临时证书密钥Key */
TmpSecretKey?: string | null;
/** 临时证书appid */
AppId?: number | null;
}
/** 工作流的API参数 */
declare interface CustomVariable {
/** 参数名称 */
Name?: string;
/** 参数的值 */
Value?: string;
}
/** 数智人配置 */
declare interface DigitalHumanConfig {
/** 数智人资产key */
AssetKey?: string;
/** 数智人名称 */
Name?: string;
/** 图像 */
Avatar?: string;
/** 预览图 */
PreviewUrl?: string;
}
/** 文档列表筛选标识位 */
declare interface DocFilterFlag {
/** 标识位 */
Flag?: string;
/** 标识值 */
Value?: boolean;
}
/** 文档类参考来源信息 */
declare interface DocReference {
/** 文档业务ID */
DocBizId?: number;
/** 文档片段参考ID */
ReferBizId?: number | null;
/** 文档名称 */
DocName?: string | null;
/** 文档所在知识库业务ID */
KnowledgeBizId?: number | null;
/** 文档所在知识库名称 */
KnowledgeName?: string | null;
/** 文档访问地址 */
Url?: string | null;
}
/** 文档片段 */
declare interface DocSegment {
/** 片段ID */
Id?: string | null;
/** 业务ID */
BusinessId?: string | null;
/** 文件类型(markdown,word,txt) */
FileType?: string | null;
/** 文档切片类型(segment-文档切片 table-表格) */
SegmentType?: string | null;
/** 标题 */
Title?: string | null;
/** 段落内容 */
PageContent?: string | null;
/** 段落原文 */
OrgData?: string | null;
/** 文章ID */
DocId?: string | null;
/** 文档业务ID */
DocBizId?: string | null;
/** 文档链接 */
DocUrl?: string | null;
/** 文档的自定义链接 */
WebUrl?: string;
/** 页码信息 */
PageInfos?: number[];
}
/** 重复文档处理方式 */
declare interface DuplicateFileHandle {
/** 重复文档判断方式,1:按文档内容,即cos_hash字段判断是否重复 */
CheckType?: number;
/** 重复文档处理方式,1:返回报错,2:跳过,返回重复的文档业务ID */
HandleType?: number;
}
/** 扩展信息 */
declare interface ExtraInfo {
/** ECharts信息 */
EChartsInfo?: string[] | null;
}
/** 文件收集信息 */
declare interface FileCollection {
/** 最大上传文件的数量 */
MaxFileCount: number;
/** 支持的上传文件类型 */
SupportedFileTypes: string[] | null;
}
/** 实时上传的文件信息 */
declare interface FileInfo {
/** 文件名称 */
FileName?: string | null;
/** 文件大小 */
FileSize?: string | null;
/** 文件的URL地址,COS地址 */
FileUrl?: string | null;
/** 文件类型 */
FileType?: string | null;
/** 解析后返回的DocID */
DocId?: string | null;
/** 创建时间 */
CreatedAt?: string | null;
}
/** 文件信息内容 */
declare interface FileInfoContent {
/** 实时文档解析接口返回的 DocBizId */
DocBizId?: number;
/** 文件名称 */
FileName?: string | null;
/** 文件类型 */
FileType?: string | null;
/** 文件大小 */
FileSize?: number | null;
/** 文件 URL */
FileUrl?: string | null;
}
/** 不满意回复检索过滤 */
declare interface Filters {
/** 检索,用户问题或答案 */
Query?: string;
/** 错误类型检索 */
Reasons?: string[];
/** 处理状态 0-待处理 1-已拒答 2-已忽略 3-已添加为新问答 4-已添加为相似问 */
HandlingStatuses?: number[];
}
/** 获取ws token label */
declare interface GetWsTokenReq_Label {
/** 标签名 */
Name?: string;
/** 标签值 */
Values?: string[];
}
/** 分片高亮内容 */
declare interface Highlight {
/** 高亮起始位置 */
StartPos?: string | null;
/** 高亮结束位置 */
EndPos?: string | null;
/** 高亮子文本 */
Text?: string | null;
}
/** 多轮历史信息 */
declare interface HistorySummary {
/** 助手 */
Assistant?: string | null;
/** 用户 */
User?: string | null;
}
/** 图片信息 */
declare interface ImageInfoContent {
/** 图片文件链接 */
Url?: string;
}
/** 输入框配置 */
declare interface InputBoxConfig {
/** 输入框按钮,1:上传图片、2:上传文档,3:腾讯文档,4:联网搜索 */
InputBoxButtons?: number[];
}
/** 意图达成方式 */
declare interface IntentAchievement {
/** 意图达成方式,qa:问答回复、doc:文档回复、workflow:工作流回复,llm:大模型回复 */
Name?: string;
/** 意图达成方式描述 */
Desc?: string;
}
/** 请求的API信息 */
declare interface InvokeAPI {
/** 请求方法,如GET/POST等 */
Method?: string | null;
/** 请求地址 */
Url?: string | null;
/** header参数 */
HeaderValues?: StrValue[] | null;
/** 入参Query */
QueryValues?: StrValue[] | null;
/** Post请求的原始数据 */
RequestPostBody?: string | null;
/** 返回的原始数据 */
ResponseBody?: string | null;
/** 出参 */
ResponseValues?: ValueInfo[] | null;
/** 异常信息 */
FailMessage?: string | null;
}
/** 知识库高级设置 */
declare interface KnowledgeAdvancedConfig {
/** 重排序模型 */
RerankModel?: string | null;
/** 召回数量 */
RerankRecallNum?: number | null;
}
/** 共享知识库基础信息 */
declare interface KnowledgeBaseInfo {
/** 共享知识库业务ID */
KnowledgeBizId?: string;
/** 共享知识库名称 */
KnowledgeName?: string;
/** 共享知识库描述 */
KnowledgeDescription?: string | null;
/** Embedding模型 */
EmbeddingModel?: string | null;
/** 问答提取模型 */
QaExtractModel?: string | null;
/** 更新时间 */
UpdateTime?: string | null;
/** 共享知识库类型,0普通,1公众号 */
KnowledgeType?: number;
/** 拥有者id */
OwnerStaffId?: string;
/** 知识库文档数量,当前仅支持公众号知识库 */
DocTotal?: number | null;
/** 知识库处理中状态标记,1:向量embedding变更中 */
ProcessingFlags?: number[] | null;
/** 知识库拥有者的名字 */
OwnerStaffName?: string;
}
/** 知识库容量饼图详情 */
declare interface KnowledgeCapacityPieGraphDetail {
/** 当前应用名称 */
AppName?: string | null;
/** 当前应用使用的字符数 */
UsedCharSize?: string | null;
/** 当前应用对于总用量的占比 */
Proportion?: number | null;
/** 知识库类型:0默认1共享 */
KnowledgeType?: number;
}
/** 应用使用知识库容量详情 */
declare interface KnowledgeDetail {
/** 应用名称 */
AppName?: string | null;
/** 已用字符数 */
UsedCharSize?: string | null;
/** 使用占比 */
Proportion?: number | null;
/** 超量字符数 */
ExceedCharSize?: string | null;
/** 废弃 */
IsSharedKnowledge?: boolean | null;
/** 知识库类型:0默认1共享 */
KnowledgeType?: number;
}
/** 知识库详情信息 */
declare interface KnowledgeDetailInfo {
/** 知识库信息 */
Knowledge?: KnowledgeBaseInfo | null;
/** 应用列表 */
AppList?: AppBaseInfo[] | null;
/** 用户信息 */
User?: UserBaseInfo | null;
/** 权限位信息 */
PermissionIds?: string[];
}
/** 知识库模型设置 */
declare interface KnowledgeModelConfig {
/** 向量模型,该字段只有共享知识库有,应用知识库没有 */
EmbeddingModel?: string | null;
/** 问答对生成模型 */
QaExtractModel?: string | null;
/** schema生成模型 */
SchemaModel?: string | null;
}
/** 应用配置关联的agent信息 */
declare interface KnowledgeQaAgent {
/** 协同方式,1:自由转交,2:工作流编排,3:Plan-and-Execute */
AgentCollaboration?: number | null;
/** 应用配置agent关联的工作流 */
Workflow?: KnowledgeQaWorkflowInfo | null;
}
/** 知识问答配置 */
declare interface KnowledgeQaConfig {
/** 欢迎语,200字符以内 */
Greeting?: string | null;
/** 角色描述,4000字符以内。通过填写描述,设定应用的 #角色名称、 #风格特点 及可达成的#意图。建议按照下面的模板填写,且自定义意图建议不超过5个。#角色名称:#风格特点:#输出要求:#能力限制:能够达成以下用户意图##意图名称:##意图描述:##意图示例:##意图实现: */
RoleDescription?: string | null;
/** 生成模型配置 */
Model?: AppModel | null;
/** 知识搜索配置 */
Search?: KnowledgeQaSearch[] | null;
/** 知识管理输出配置 */
Output?: KnowledgeQaOutput | null;
/** 工作流程配置 */
Workflow?: KnowledgeWorkflow | null;
/** 检索范围 */
SearchRange?: SearchRange | null;
/** 应用模式,standard:标准模式, agent: agent模式,single_workflow:单工作流模式 */
Pattern?: string | null;
/** 检索策略 */
SearchStrategy?: SearchStrategy | null;
/** 单工作流ID,Pattern为single_workflow时传入 */
SingleWorkflow?: KnowledgeQaSingleWorkflow | null;
/** 应用关联插件 */
Plugins?: KnowledgeQaPlugin[] | null;
/** 思考模型配置 */
ThoughtModel?: AppModel | null;
/** 意图达成方式优先级 */
IntentAchievements?: IntentAchievement[] | null;
/** 是否开启图文检索 */
ImageTextRetrieval?: boolean | null;
/** 配置语音通话参数 */
AiCall?: AICallConfig | null;
/** 共享知识库关联配置 */
ShareKnowledgeBases?: ShareKnowledgeBase[] | null;
/** 背景图相关信息 */
BackgroundImage?: BackgroundImageConfig | null;
/** 开场问题 */
OpeningQuestions?: string[] | null;
/** 长期记忆开关 */
LongMemoryOpen?: boolean;
/** 长期记忆时效 */
LongMemoryDay?: number;
/** agent配置信息 */
Agent?: KnowledgeQaAgent | null;
/** 知识库模型 */
KnowledgeModelConfig?: KnowledgeModelConfig | null;
/** 知识库高级设置 */
KnowledgeAdvancedConfig?: KnowledgeAdvancedConfig | null;
}
/** 应用管理输出配置 */
declare interface KnowledgeQaOutput {
/** 输出方式 1:流式 2:非流式 */
Method?: number | null;
/** 通用模型回复 */
UseGeneralKnowledge?: boolean | null;
/** 未知回复语,300字符以内 */
BareAnswer?: string | null;
/** 是否展示问题澄清开关 */
ShowQuestionClarify?: boolean | null;
/** 是否打开问题澄清 */
UseQuestionClarify?: boolean | null;
/** 问题澄清关键词列表 */
QuestionClarifyKeywords?: string[] | null;
/** 是否打开推荐问题开关 */
UseRecommended?: boolean | null;
/** 推荐问模式,0.结合知识库&对话历史推荐问题Prompt(默认) 1.仅结合知识库输出推荐问的prompt */
RecommendedPromptMode?: number | null;
/** 输入框按钮配置 */
InputBoxConfig?: InputBoxConfig;
}
/** 应用关联插件信息 */
declare interface KnowledgeQaPlugin {
/** 插件ID */
PluginId?: string | null;
/** 插件名称 */
PluginName?: string;
/** 插件图标 */
PluginIcon?: string;
/** 工具ID */
ToolId?: string;
/** 工具名称 */
ToolName?: string;
/** 工具描述 */
ToolDesc?: string;
/** 工具输入参数 */
Inputs?: PluginToolReqParam[];
/** 插件是否和知识库绑定 */
IsBindingKnowledge?: boolean;
}
/** 检索配置 */
declare interface KnowledgeQaSearch {
/** 知识来源 doc:文档,qa:问答 taskflow:业务流程,search:搜索增强,database:数据库 */
Type?: string | null;
/** 问答-回复灵活度 1:已采纳答案直接回复 2:已采纳润色后回复 */
ReplyFlexibility?: number | null;
/** 搜索增强-搜索引擎状态 */
UseSearchEngine?: boolean | null;
/** 是否显示搜索引擎检索状态 */
ShowSearchEngine?: boolean | null;
/** 知识来源,是否选择 */
IsEnabled?: boolean | null;
/** 问答最大召回数量, 默认2,限制5 */
QaTopN?: number | null;
/** 文档最大召回数量, 默认3,限制5 */
DocTopN?: number | null;
/** 检索置信度,针对文档和问答有效,最小0.01,最大0.99 */
Confidence?: number | null;
/** 资源状态 1:资源可用;2:资源已用尽 */
ResourceStatus?: number | null;
}
/** 问答知识库单工作流模式下指定单工作流配置 */
declare interface KnowledgeQaSingleWorkflow {
/** 工作流ID */
WorkflowId?: string;
/** 工作流名称 */
WorkflowName?: string;
/** 工作流描述 */
WorkflowDesc?: string;
/** 工作流状态,发布状态(UNPUBLISHED: 待发布 PUBLISHING: 发布中 PUBLISHED: 已发布 FAIL:发布失败) */
Status?: string;
/** 工作流是否启用 */
IsEnable?: boolean;
/** 是否开启异步调用工作流 */
AsyncWorkflow?: boolean;
}
/** 应用配置关联的工作流信息 */
declare interface KnowledgeQaWorkflowInfo {
/** 工作流ID */
WorkflowId?: string;
/** 工作流名称 */
WorkflowName?: string;
/** 工作流描述 */
WorkflowDesc?: string;
/** 工作流状态,发布状态(UNPUBLISHED: 待发布 PUBLISHING: 发布中 PUBLISHED: 已发布 FAIL:发布失败) */
Status?: string;
/** 工作流是否启用 */
IsEnable?: boolean;
}
/** 检索知识 */
declare interface KnowledgeSummary {
/** 1是问答 2是文档片段 */
Type?: number | null;
/** 知识内容 */
Content?: string | null;
}
/** 共享知识库更新信息 */
declare interface KnowledgeUpdateInfo {
/** 共享知识库名称 */
KnowledgeName?: string;
/** 共享知识库描述 */
KnowledgeDescription?: string | null;
/** Embedding模型 */
EmbeddingModel?: string | null;
/** 问答提取模型 */
QaExtractModel?: string | null;
/** 拥有者id */
OwnerStaffId?: string;
}
/** 问答知识库工作流配置 */
declare interface KnowledgeWorkflow {
/** 是否启用工作流 */
IsEnabled?: boolean | null;
/** 是否启用PDL */
UsePdl?: boolean | null;
}
/** 标签ID */
declare interface Label {
/** 标签ID */
LabelBizId?: string | null;
/** 标签名称 */
LabelName?: string | null;
}
/** 文档列表详情描述 */
declare interface ListDocItem {
/** 文档ID */
DocBizId?: string | null;
/** 文件名称 */
FileName?: string | null;
/** 重命名的新文档名称,在重命名提交之后,文档发布之前都是这个名称 */
NewName?: string;
/** 文件类型 */
FileType?: string | null;
/** cos路径 */
CosUrl?: string | null;
/** 更新时间 */
UpdateTime?: string | null;
/** 文档状态 */
Status?: number | null;
/** 文档状态描述 */
StatusDesc?: string | null;
/** 原因 */
Reason?: string | null;
/** 答案中是否引用 */
IsRefer?: boolean | null;
/** 问答对数量 */
QaNum?: number | null;
/** 是否已删除 */
IsDeleted?: boolean | null;
/** 文档来源 */
Source?: number | null;
/** 文档来源描述 */
SourceDesc?: string | null;
/** 是否允许重新生成 */
IsAllowRestart?: boolean | null;
/** qa是否已删除 */
IsDeletedQa?: boolean | null;
/** 问答是否生成中 */
IsCreatingQa?: boolean | null;
/** 是否允许删除 */
IsAllowDelete?: boolean | null;
/** 是否允许操作引用开关 */
IsAllowRefer?: boolean | null;
/** 问答是否生成过 */
IsCreatedQa?: boolean | null;
/** 文档字符量 */
DocCharSize?: string | null;
/** 属性标签适用范围 */
AttrRange?: number | null;
/** 属性标签 */
AttrLabels?: AttrLabel[] | null;
/** 是否允许编辑 */
IsAllowEdit?: boolean | null;
/** 外部引用链接类型 0:系统链接 1:自定义链接值为1时,WebUrl 字段不能为空,否则不生效。 */
ReferUrlType?: number | null;
/** 网页(或自定义链接)地址 */
WebUrl?: string | null;
/** 有效开始时间,unix时间戳 */
ExpireStart?: string | null;
/** 有效结束时间,unix时间戳,0代表永久有效 */
ExpireEnd?: string | null;
/** 是否允许重试,0:否,1:是 */
IsAllowRetry?: boolean | null;
/** 0:文档比对处理 1:文档生成问答 */
Processing?: number[] | null;
/** 文档创建落库时间 */
CreateTime?: string | null;
/** 文档所属分类ID */
CateBizId?: string;
/** 文档的用户自定义ID */
CustomerKnowledgeId?: string;
/** 文档的属性标记,0: 不做用户外部权限校验 */
AttributeFlags?: number[];
/** false:未停用,ture:已停用 */
IsDisabled?: boolean;
/** 员工名称 */
StaffName?: string;
/** 文档生效域: 1-不生效;2-仅开发域生效;3-仅发布域生效;4-开发域和发布域均生效 */
EnableScope?: number | null;
/** 文档大小,单位:字节 */
DocSize?: string;
}
/** 问答详情数据 */
declare interface ListQaItem {
/** 问答ID */
QaBizId?: string;
/** 问题 */
Question?: string;
/** 答案 */
Answer?: string;
/** 来源 */
Source?: number;
/** 来源描述 */
SourceDesc?: string;
/** 更新时间 */
UpdateTime?: string;
/** 状态 */
Status?: number;
/** 状态描述 */
StatusDesc?: string;
/** 文档ID */
DocBizId?: string;
/** 创建时间 */
CreateTime?: string;
/** 是否允许编辑 */
IsAllowEdit?: boolean;
/** 是否允许删除 */
IsAllowDelete?: boolean;
/** 是否允许校验 */
IsAllowAccept?: boolean;
/** 文档名称 */
FileName?: string;
/** 文档类型 */
FileType?: string;
/** 问答字符数 */
QaCharSize?: string;
/** 有效开始时间,unix时间戳 */
ExpireStart?: string;
/** 有效结束时间,unix时间戳,0代表永久有效 */
ExpireEnd?: string;
/** 属性标签适用范围 1:全部,2:按条件 */
AttrRange?: number;
/** 属性标签 */
AttrLabels?: AttrLabel[];
/** 相似问个数 */
SimilarQuestionNum?: number;
/** 返回问答关联的相似问,联动搜索,仅展示一条 */
SimilarQuestionTips?: string;
/** 问答是否停用,false:未停用,ture:已停用 */
IsDisabled?: boolean;
/** 员工名称 */
StaffName?: string;
/** 问答生效域: 1-不生效;2-仅开发域生效;3-仅发布域生效;4-开发域和发布域均生效 */
EnableScope?: number | null;
/** 问答关联的文档生效域:1-不生效;2-仅开发域生效;3-仅发布域生效;4-开发域和发布域均生效。若问答未关联文档,则该字段值同问答生效域。 */
DocEnableScope?: number;
/** 问答大小(含相似问),单位:字节 */
QaSize?: string;
}
/** 发布列表详情 */
declare interface ListReleaseItem {
/** 版本ID */
ReleaseBizId?: string;
/** 发布人 */
Operator?: string;
/** 发布描述 */
Desc?: string;
/** 更新时间 */
UpdateTime?: string;
/** 发布状态,1:待发布,2:发布中,3:发布成功,5:发布失败 */
Status?: number;
/** 发布状态描述 */
StatusDesc?: string;
/** 失败原因 */
Reason?: string;
/** 发布成功数 */
SuccessCount?: number;
/** 发布失败数 */
FailCount?: number;
/** 版本号,格式是 v{date}{time} */
ReleaseVersion?: string;
/** 是否可还原 */
CanRollback?: boolean;
}
/** 模型信息 */
declare interface ModelInfo {
/** 模型名称 */
ModelName?: string | null;
/** 模型描述 */
ModelDesc?: string | null;
/** 模型名称 */
AliasName?: string | null;
/** 资源状态 1:资源可用;2:资源已用尽 */
ResourceStatus?: number | null;
/** 提示词内容字符限制 */
PromptWordsLimit?: string | null;
/** 通过核心采样控制内容生成的多样性,较高的Top P值会导致生成更多样的内容 */
TopP?: ModelParameter | null;
/** 温度控制随机性 */
Temperature?: ModelParameter | null;
/** 最多能生成的token数量 */
MaxTokens?: ModelParameter | null;
/** 模型来源 Hunyuan:腾讯混元大模型,Industry:腾讯云行业大模型,Experience:新模型体验,Custom自定义模型 */
Source?: string;
/** 模型图标 */
Icon?: string;
/** 是否免费 */
IsFree?: boolean;
/** 模型对话框可输入的上限 */
InputLenLimit?: number | null;
/** 支持工作流的类型 0:模型不支持; 1: 模型支持工作流; 2: 模型支持效果不佳; */
SupportWorkflowStatus?: number | null;
/** 模型类别 generate:生成模型,thought:思考模型 */
ModelCategory?: string;
/** 是否默认模型 */
IsDefault?: boolean;
/** 角色提示词输入长度限制 */
RoleLenLimit?: number;
/** 是否专属并发模型 */
IsExclusive?: boolean;
/** 模型支持智能通话效果 */
SupportAiCallStatus?: number;
/** 专属并发数 */
Concurrency?: number;
/** 模型标签 */
ModelTags?: string[] | null;
/** 模型超参定义 */
ModelParams?: ModelParameter[] | null;
/** 提供商名称 */
ProviderName?: string;
/** 提供商别名 */
ProviderAliasName?: string;
/** 提供商类型 Self:提供商,Custom:自定义模型提供商,Third:第三方模型提供商 */
ProviderType?: string;
/** 是否关闭模型超参 */
IsCloseModelParams?: boolean;
/** 是否支持深度思考 */
IsDeepThinking?: boolean;
}
/** 模型参数范围 */
declare interface ModelParameter {
/** 超参名称 */
Name?: string | null;
/** 类型 */
Type?: string;
/** 默认值 */
DefaultValue?: string;
/** 枚举值 */
EnumValues?: string[];
/** 默认值 */
Default?: number | null;
/** 最小值 */
Min?: number | null;
/** 最大值 */
Max?: number | null;
}
/** 模型参数 */
declare interface ModelParams {
/** 温度 */
Temperature?: number;
/** Top_P */
TopP?: number;
/** 随机种子 */
Seed?: number;
/** 存在惩罚 */
PresencePenalty?: number;
/** 频率惩罚 */
FrequencyPenalty?: number;
/** 重复惩罚 */
RepetitionPenalty?: number;
/** 最大输出长度 */
MaxTokens?: number;
/** 停止序列 */
StopSequences?: string[];
/** 输出格式 */
ReplyFormat?: string;
/** 深度思考值disabledenabled */
DeepThinking?: string | null;
/** 效果 disabled low medium high */
ReasoningEffort?: string | null;
}
/** 文档信息 */
declare interface MsgFileInfo {
/** 文档名称 */
FileName?: string | null;
/** 文档大小 */
FileSize?: string | null;
/** 文档URL */
FileUrl?: string | null;
/** 文档类型 */
FileType?: string | null;
/** 文档ID */
DocId?: string | null;
}
/** 消息详情 */
declare interface MsgRecord {
/** 内容 */
Content?: string;
/** 当前记录所对应的 Session ID */
SessionId?: string | null;
/** 记录ID */
RecordId?: string;
/** 关联记录ID */
RelatedRecordId?: string;
/** 是否来自自己 */
IsFromSelf?: boolean;
/** 发送者名称 */
FromName?: string;
/** 发送者头像 */
FromAvatar?: string;
/** 时间戳 */
Timestamp?: string;
/** 是否已读 */
HasRead?: boolean;
/** 评价 */
Score?: number;
/** 是否评分 */
CanRating?: boolean;
/** 是否展示反馈按钮 */
CanFeedback?: boolean | null;
/** 记录类型 */
Type?: number;
/** 引用来源 */
References?: MsgRecordReference[];
/** 评价原因 */
Reasons?: string[];
/** 是否大模型 */
IsLlmGenerated?: boolean;
/** 图片链接,可公有读 */
ImageUrls?: string[] | null;
/** 当次 token 统计信息 */
TokenStat?: TokenStat | null;
/** 回复方式1:大模型直接回复;2:保守回复, 未知问题回复;3:拒答问题回复;4:敏感回复;5:问答对直接回复, 已采纳问答对优先回复;6:欢迎语回复;7:并发超限回复;8:全局干预知识;9:任务流程过程回复, 当历史记录中 task_flow.type = 0 时, 为大模型回复;10:任务流程答案回复;11:搜索引擎回复;12:知识润色后回复;13:图片理解回复;14:实时文档回复; */
ReplyMethod?: number | null;
/** 选项卡, 用于多轮对话 */
OptionCards?: string[] | null;
/** 任务信息 */
TaskFlow?: TaskFlowInfo | null;
/** 用户传入的文件信息 */
FileInfos?: FileInfo[] | null;
/** 参考来源引用位置信息 */
QuoteInfos?: QuoteInfo[] | null;
/** Agent的思考过程信息 */
AgentThought?: AgentThought | null;
/** 扩展信息 */
ExtraInfo?: ExtraInfo | null;
/** 工作流信息 */
WorkFlow?: WorkflowInfo | null;
/** Widget信息 */
Widgets?: Widget[] | null;
/** Widget动作信息 */
WidgetAction?: WidgetAction | null;
/** 音频信息 */
Audios?: Audio[] | null;
}
/** 聊天详情Refer */
declare interface MsgRecordReference {
/** id */
Id?: string;
/** 链接 */
Url?: string;
/** 类型 */
Type?: number;
/** 名称 */
Name?: string;
/** 来源文档ID */
DocId?: string;
/** 知识库名称 */
KnowledgeName?: string;
/** 知识库业务id */
KnowledgeBizId?: string;
/** 文档业务id */
DocBizId?: string;
/** 问答业务id */
QaBizId?: string;
/** 文档索引id */
Index?: number;
}
/** Nl2Sql模型配置 */
declare interface NL2SQLModelConfig {
/** 模型配置 */
Model?: AppModelDetailInfo | null;
}
/** 节点运行的基本信息 */
declare interface NodeRunBase {
/** 节点运行的ID */
NodeRunId?: string;
/** 节点ID */
NodeId?: string;
/** 工作流运行实例的ID */
WorkflowRunId?: string;
/** 节点名称 */
NodeName?: string;
/** 节点类型。1: 开始节点2:参数提取节点3:大模型节点4:知识问答节点5:知识检索节点6:标签提取节点7:代码执行节点8:工具节点9:逻辑判断节点10:回复节点11:选项卡节点12:循环节点13:意图识别节点14:工作流节点15:插件节点16:结束节点17: 变量聚合节点数据18: 批处理节点19: 消息队列节点 */
NodeType?: number;
/** 运行状态。0: 初始状态;1: 运行中;2: 运行成功; 3: 运行失败; 4: 已取消 */
State?: number;
/** 错误码 */
FailCode?: string;
/** 错误信息 */
FailMessage?: string;
/** 消耗时间(毫秒) */
CostMilliseconds?: number;
/** 消耗的token总数 */
TotalTokens?: number;
}
/** 工作流节点运行详情 */
declare interface NodeRunDetail {
/** 节点运行的ID */
NodeRunId?: string;
/** 节点ID */
NodeId?: string;
/** 工作流运行实例的ID */
WorkflowRunId?: string;
/** 节点名称 */
NodeName?: string;
/** 节点类型。1: 开始节点2:参数提取节点3:大模型节点4:知识问答节点5:知识检索节点6:标签提取节点7:代码执行节点8:工具节点9:逻辑判断节点10:回复节点11:选项卡节点12:循环节点13:意图识别节点14:工作流节点15:插件节点16:结束节点17: 变量聚合节点数据18: 批处理节点19: 消息队列节点 */
NodeType?: number;
/** 运行状态。0: 初始状态;1: 运行中;2: 运行成功; 3: 运行失败; 4: 已取消 */
State?: number;
/** 错误码 */
FailCode?: string;
/** 错误信息 */
FailMessage?: string;
/** 消耗时间(毫秒) */
CostMilliseconds?: number;
/** 消耗的token总数 */
TotalTokens?: number;
/** 输入变量信息 */
Input?: string;
/** 节点的输入的完整内容的链接。(当Input内容超过限制的时候此字段才有值) */
InputRef?: string;
/** 输出变量信息 */
Output?: string;
/** 节点的输出的完整内容的链接。(当Output内容超过限制的时候此字段才有值) */
OutputRef?: string;
/** 原始输出信息。部分节点才有值,如工具节点、代码节点 */
TaskOutput?: string;
/** 任务的原始输出的完整内容的链接。(当TaskOutput内容超过限制的时候此字段才有值) */
TaskOutputRef?: string;
/** 节点的日志 */
Log?: string;
/** 节点的日志的完整内容的链接志(当Log内容超过限制的时候才有值) */
LogRef?: string;
/** 开始时间戳(毫秒) */
StartTime?: string;
/** 结束时间戳(毫秒) */
EndTime?: string;
/** LLM统计信息。 */
StatisticInfos?: StatisticInfo[];
}
/** 下拉框选项 */
declare interface Option {
/** 文本 */
Text?: string | null;
/** 值 */
Value?: string | null;
/** 文件字符数 */
CharSize?: string | null;
/** 文件类型 */
FileType?: string | null;
}
/** 选项卡索引 */
declare interface OptionCardIndex {
/** 唯一标识 */
RecordId?: string;
/** 选项卡索引 */
Index?: number;
}
/** Widget输出参数配置 */
declare interface OutputWidgetConfig {
/** widget id */
WidgetId?: string;
/** widget名字 */
WidgetName?: string;
/** 展示结果 */
WidgetParam?: WidgetParam[];
}
/** 参数配置列表 */
declare interface ParameterConfig {
/** 字段名称 */
Name?: string;
/** 字段描述 */
Description?: string;
/** 字段类型 */
Type?: number;
/** 是否必填 */
IsRequired?: boolean;
/** 子参数 */
SubParams?: ParameterConfig[];
/** OneOf类型的参数 */
OneOf?: ParameterConfig[];
/** AnyOf类型的参数 */
AnyOf?: ParameterConfig[];
}
/** 插件参数请求结构 */
declare interface PluginToolReqParam {
/** 参数名称 */
Name?: string;
/** 参数描述 */
Desc?: string;
/** 参数类型,0:string, 1:int, 2:float,3:bool 4:object 5:array_string, 6:array_int, 7:array_float, 8:array_bool, 9:array_object, 99:null, 100:upspecified */
Type?: number;
/** 参数是否必填 */
IsRequired?: boolean;
/** 参数默认值 */
DefaultValue?: string;
/** 子参数,ParamType 是OBJECT 或 ARRAY<>类型有用 */
SubParams?: PluginToolReqParam[];
/** 插件参数配置是否隐藏不可见,true-隐藏不可见,false-可见 */
GlobalHidden?: boolean;
/** OneOf类型参数 */
OneOf?: PluginToolReqParam[];
/** AnyOf类型参数 */
AnyOf?: PluginToolReqParam[];
}
/** 执行过程信息记录 */
declare interface Procedure {
/** 执行过程英语名 */
Name?: string | null;
/** 中文名, 用于展示 */
Title?: string | null;
/** 状态常量: 使用中: processing, 成功: success, 失败: failed */
Status?: string | null;
/** 消耗 token 数 */
Count?: number | null;
/** 调试信息 */
Debugging?: ProcedureDebugging | null;
/** 计费资源状态,1:可用,2:不可用 */
ResourceStatus?: number | null;
/** 输入消耗 token 数 */
InputCount?: number;
/** 输出消耗 token 数 */
OutputCount?: number;
}
/** 调试信息 */
declare interface ProcedureDebugging {
/** 检索query */
Content?: string | null;
/** 系统prompt */
System?: string | null;
/** 多轮历史信息 */
Histories?: HistorySummary[] | null;
/** 检索知识 */
Knowledge?: KnowledgeSummary[] | null;
/** 任务流程 */
TaskFlow?: TaskFlowSummary | null;
/** 工作流调试信息 */
WorkFlow?: WorkFlowSummary | null;
/** Agent调试信息 */
Agent?: AgentDebugInfo | null;
/** 自定义参数 */
CustomVariables?: string[] | null;
}
/** 获取QA分类分组 */
declare interface QACate {
/** QA分类的业务ID */
CateBizId?: string | null;
/** 分类名称 */
Name?: string | null;
/** 分类下QA数量 */
Total?: number | null;
/** 是否可新增 */
CanAdd?: boolean | null;
/** 是否可编辑 */
CanEdit?: boolean | null;
/** 是否可删除 */
CanDelete?: boolean | null;
/** 子分类 */
Children?: QACate[] | null;
/** 是否是叶子节点 */
IsLeaf?: boolean | null;
}
/** 问答列表 */
declare interface QAList {
/** 问答ID */
QaBizId: string;
/** 是否采纳 */
IsAccepted?: boolean;
/** 分类ID */
CateBizId?: string;
/** 问题 */
Question?: string;
/** 答案 */
Answer?: string;
}
/** QA查询参数 */
declare interface QAQuery {
/** 页码 从1开始 */
PageNumber: number;
/** 页大小 默认15 最大100 */
PageSize: number;
/** 应用ID */
BotBizId: string;
/** 查询内容 */
Query?: string;
/** 分类ID */
CateBizId?: string;
/** 校验状态的枚举值 */
AcceptStatus?: number[];
/** 发布状态的枚举值 */
ReleaseStatus?: number[];
/** 文档ID */
DocBizId?: string;
/** QAID */
QaBizId?: string;
/** 来源 */
Source?: number;
/** 查询答案 */
QueryAnswer?: string;
/** 查询类型 filename 名称、 attribute 标签 */
QueryType?: string;
/** 问答生效域检索,不检索不传。枚举值如下:1-不生效;2-仅开发域生效;3-仅发布域生效;4-开发域和发布域均生效。 */
EnableScope?: number;
}
/** 问答对参考信息 */
declare interface QaReference {
/** 问答业务ID */
QaBizId?: number;
/** 文档片段参考ID */
ReferBizId?: number | null;
/** 问答所在知识库业务ID */
KnowledgeBizId?: number | null;
/** 问答所在知识库名称 */
KnowledgeName?: string | null;
}
/** 搜索引擎参考来源索引 */
declare interface QuoteInfo {
/** 参考来源位置 */
Position?: number | null;
/** 参考来源索引顺序 */
Index?: string | null;
}
/** 引用来源详情 */
declare interface ReferDetail {
/** 引用ID */
ReferBizId?: string | null;
/** 文档类型 (1 QA, 2 文档段) */
DocType?: number | null;
/** 文档名称 */
DocName?: string | null;
/** 分片内容 */
PageContent?: string | null;
/** 问题 */
Question?: string | null;
/** 答案 */
Answer?: string | null;
/** 置信度 */
Confidence?: number | null;
/** 标记 */
Mark?: number | null;
/** 分片高亮内容 */
Highlights?: Highlight[] | null;
/** 原始内容 */
OrgData?: string | null;
/** 页码信息 */
PageInfos?: number[] | null;
/** sheet信息 */
SheetInfos?: string[] | null;
/** 文档ID */
DocBizId?: string | null;
/** 知识库ID */
KnowledgeBizId?: string;
}
/** 发布拒答 */
declare interface RejectedQuestion {
/** 拒答问题ID */
RejectedBizId?: string | null;
/** 被拒答的问题 */
Question?: string | null;
/** 发布状态(1 待发布 2 发布中 3 已发布 4 发布失败) */
Status?: number | null;
/** 状态描述 */
StatusDesc?: string | null;
/** 更新时间, 秒级时间戳 */
UpdateTime?: string | null;
/** 是否允许编辑 */
IsAllowEdit?: boolean | null;
/** 是否允许删除 */
IsAllowDelete?: boolean | null;
/** 操作人 */
Operator?: string | null;
}
/** 发布配置项 */
declare interface ReleaseConfigs {
/** 配置项描述 */
ConfigItem?: string | null;
/** 更新时间 */
UpdateTime?: string | null;
/** 状态 */
Action?: number | null;
/** 变更后的内容 */
Value?: string | null;
/** 变更前的内容 */
LastValue?: string | null;
/** 变更内容(优先级展示content内容,content为空取value内容) */
Content?: string | null;
/** 失败原因 */
Message?: string | null;
}
/** 发布文档详情 */
declare interface ReleaseDoc {
/** 文件名 */
FileName?: string;
/** 文件类型 */
FileType?: string;
/** 更新时间 */
UpdateTime?: string;
/** 状态 */
Action?: number;
/** 状态描述 */
ActionDesc?: string;
/** 失败原因 */
Message?: string;
/** 文档业务ID */
DocBizId?: string;
}
/** 发布问答 */
declare interface ReleaseQA {
/** 问题 */
Question?: string;
/** 更新时间 */
UpdateTime?: string;
/** 状态 */
Action?: number;
/** 状态描述 */
ActionDesc?: string;
/** 来源1:文档生成,2:批量导入,3:手动添加 */
Source?: number;
/** 来源描述 */
SourceDesc?: string;
/** 文件名字 */
FileName?: string;
/** 文档类型 */
FileType?: string;
/** 失败原因 */
Message?: string;
/** 发布状态 */
ReleaseStatus?: number;
/** QAID */
QaBizId?: string;
/** 文档业务ID */
DocBizId?: string;
}
/** 发布拒答 */
declare interface ReleaseRejectedQuestion {
/** 问题 */
Question?: string | null;
/** 更新时间 */
UpdateTime?: string | null;
/** 状态 */
Action?: number | null;
/** 状态描述 */
ActionDesc?: string | null;
/** 失败原因 */
Message?: string | null;
}
/** 节点信息 */
declare interface RunNodeInfo {
/** 节点类型,0:未指定,1:开始节点,2:API节点,3:询问节点,4:答案节点 */
NodeType?: number | null;
/** 节点ID */
NodeId?: string | null;
/** 节点名称 */
NodeName?: string | null;
/** 请求的API */
InvokeApi?: InvokeAPI | null;
/** 当前节点的所有槽位的值,key:SlotID。没有值的时候也要返回空。 */
SlotValues?: ValueInfo[] | null;
}
/** 沙盒信息内容 */
declare interface SandboxContent {
/** 沙盒的URL地址 */
Url?: string | null;
/** 沙盒通过浏览器打开的URL地址 */
DisplayUrl?: string | null;
/** 沙盒输出内容 */
Content?: string | null;
}
/** 检索范围配置 */
declare interface SearchRange {
/** 检索条件and/or */
Condition?: string | null;
/** 自定义变量和标签关系数据 */
ApiVarAttrInfos?: ApiVarAttrInfo[] | null;
}
/** 知识库检索策略 */
declare interface SearchStrategy {
/** 检索策略类型 0:混合检索,1:语义检索 */
StrategyType?: number | null;
/** Excel检索增强开关, false关闭,true打开 */
TableEnhancement?: boolean | null;
/** 向量模型 */
EmbeddingModel?: string | null;
/** 结果重排序开关, on打开,off关闭 */
RerankModelSwitch?: string | null;
/** 结果重排序模型 */
RerankModel?: string | null;
/** NL2SQL模型配置 */
NatureLanguageToSqlModelConfig?: NL2SQLModelConfig | null;
}
/** 共享知识库配置 */
declare interface ShareKnowledgeBase {
/** 共享知识库ID */
KnowledgeBizId?: string | null;
/** 检索范围 */
SearchRange?: SearchRange | null;
/** 知识库模型设置 */
KnowledgeModelConfig?: KnowledgeModelConfig | null;
/** 检索策略配置 */
SearchStrategy?: SearchStrategy | null;
/** 检索配置 */
Search?: KnowledgeQaSearch[] | null;
/** // 问答-回复灵活度 1:已采纳答案直接回复 2:已采纳润色后回复 */
ReplyFlexibility?: number | null;
/** 共享知识库名称 */
KnowledgeName?: string | null;
}
/** 相似问信息 */
declare interface SimilarQuestion {
/** 相似问ID */
SimBizId?: string | null;
/** 相似问内容 */
Question?: string | null;
/** 相似问审核状态,1审核失败 */
AuditStatus?: number | null;
}
/** 相似问修改(更新)信息 */
declare interface SimilarQuestionModify {
/** 需要添加的相似问(内容)列表 */
AddQuestions?: string[];
/** 需要更新的相似问列表 */
UpdateQuestions?: SimilarQuestion[];
/** 需要删除的相似问列表 */
DeleteQuestions?: SimilarQuestion[];
}
/** 计费统计信息 */
declare interface Stat {
/** X轴: 时间区域;根据查询条件的粒度返回“分/小时/日”三种区间范围 */
X?: string | null;
/** Y轴: 该时间区域内的统计值,如token消耗量,调用次数或使用量等信息 */
Y?: number | null;
}
/** 大模型token统计信息 */
declare interface StatisticInfo {
/** 模型名称 */
ModelName?: string | null;
/** 首Token耗时 */
FirstTokenCost?: number | null;
/** 总耗时 */
TotalCost?: number | null;
/** 输入Token数量 */
InputTokens?: number | null;
/** 输出Token数量 */
OutputTokens?: number | null;
/** 总Token数量 */
TotalTokens?: number | null;
}
/** 字符串KV信息 */
declare interface StrValue {
/** 名称 */
Name?: string | null;
/** 值 */
Value?: string | null;
}
/** 结构化输出的配置项 */
declare interface StructuredOutputConfig {
/** 参数列表 */
StructuredOutputParams?: ParameterConfig[];
}
/** 知识摘要应用配置 */
declare interface SummaryConfig {
/** 模型配置 */
Model?: AppModel | null;
/** 知识摘要输出配置 */
Output?: SummaryOutput | null;
/** 欢迎语,200字符以内 */
Greeting?: string | null;
}
/** 知识摘要输出配置 */
declare interface SummaryOutput {
/** 输出方式 1:流式 2:非流式 */
Method?: number | null;
/** 输出要求 1:文本总结 2:自定义要求 */
Requirement?: number | null;
/** 自定义要求指令 */
RequireCommand?: string | null;
}
/** 变量详情 */
declare interface TaskFLowVar {
/** 变量ID */
VarId?: string | null;
/** 变量名称 */
VarName?: string | null;
/** 变量描述(默认为"-") */
VarDesc?: string;
/** 变量类型 (STRING,INT,FLOAT,BOOL,OBJECT,ARRAY_STRING,ARRAY_INT,ARRAY_FLOAT,ARRAY_BOOL,ARRAY_OBJECT,FILE,DOCUMENT,IMAGE,AUDIO) */
VarType?: string;
/** 自定义变量默认值 */
VarDefaultValue?: string;
/** 自定义变量文件默认名称 */
VarDefaultFileName?: string;
/** 变量类型 */
VarModuleType?: number;
}
/** 任务流程信息 */
declare interface TaskFlowInfo {
/** 任务流程ID */
TaskFlowId?: string | null;
/** 任务流程名称 */
TaskFlowName?: string | null;
/** Query 重写结果 */
QueryRewrite?: string | null;
/** 命中意图 */
HitIntent?: string | null;
/** 任务流程回复类型0: 任务流回复1: 任务流静默2: 任务流拉回话术3: 任务流自定义回复 */
Type?: number | null;
}
/** 任务流程调试信息 */
declare interface TaskFlowSummary {
/** 任务流程名 */
IntentName?: string | null;
/** 实体列表 */
UpdatedSlotValues?: ValueInfo[] | null;
/** 节点列表 */
RunNodes?: RunNodeInfo[] | null;
/** 意图判断 */
Purposes?: string[] | null;
}
/** 任务参数 */
declare interface TaskParams {
/** 下载地址,需要通过cos桶临时密钥去下载 */
CosPath?: string | null;
}
/** 当前执行的 token 统计信息 */
declare interface TokenStat {
/** 会话 ID */
SessionId?: string | null;
/** 请求 ID */
RequestId?: string | null;
/** 对应哪条会话, 会话 ID, 用于回答的消息存储使用, 可提前生成, 保存消息时使用 */
RecordId?: string | null;
/** token 已使用数 */
UsedCount?: number | null;
/** 免费 token 数 */
FreeCount?: number | null;
/** 订单总 token 数 */
OrderCount?: number | null;
/** 当前执行状态汇总, 常量: 使用中: processing, 成功: success, 失败: failed */
StatusSummary?: string | null;
/** 当前执行状态汇总后中文展示 */
StatusSummaryTitle?: string | null;
/** 当前请求执行时间, 单位 ms */
Elapsed?: number | null;
/** 当前请求消耗 token 数 */
TokenCount?: number | null;
/** 执行过程信息 */
Procedures?: Procedure[] | null;
/** 执行过程信息TraceId */
TraceId?: string | null;
}
/** 工具高级设置 */
declare interface ToolAdvanceConfig {
/** 工具调用结果是否直接返回给用户 */
EnableDirectResultReturn?: boolean;
/** 输出样式 1-文本 2-json 3-widget */
OutputType?: number;
/** 原始结构化JSON输出 */
RawStructuredOutput?: string;
/** 自定义文本输出,多行展示 */
CustomTextOutputs?: string;
/** Widget输出配置 */
OutputWidgetConfig?: OutputWidgetConfig;
}
/** 不满意回复 */
declare interface UnsatisfiedReply {
/** 不满意回复ID */
ReplyBizId?: string | null;
/** 消息记录ID */
RecordBizId?: string | null;
/** 用户问题 */
Question?: string | null;
/** 问题回复 */
Answer?: string | null;
/** 错误类型 */
Reasons?: string[] | null;
/** 处理状态,0:待处理,1:已拒答,2:已忽略,3:已纠错 */
Status?: number | null;
/** 创建时间,秒级时间戳 */
CreateTime?: string;
/** 更新时间,秒级时间戳 */
UpdateTime?: string;
/** 操作人 */
Operator?: string;
/** 自定义反馈 */
FeedbackContent?: string;
}
/** 更新时间策略 */
declare interface UpdatePeriodInfo {
/** 文档更新频率类型:0不更新 -H 小时粒度,当前仅支持24(1天),72(3天),168(7天) 仅source=2 腾讯文档类型有效 */
UpdatePeriodH?: number | null;
}
/** 用户基础信息 */
declare interface UserBaseInfo {
/** 用户ID */
UserBizId?: string;
/** 用户名称 */
UserName?: string | null;
}
/** 任务流程参数信息 */
declare interface ValueInfo {
/** 值ID */
Id?: string | null;
/** 名称 */
Name?: string | null;
/** 值类型:0:未知或者空, 1:string, 2:int, 3:float, 4:bool, 5:array(字符串数组), 6: object_array(结构体数组), 7: object(结构体) */
ValueType?: number | null;
/** string */
ValueStr?: string | null;
/** int(避免精度丢失使用字符串返回) */
ValueInt?: string | null;
/** float */
ValueFloat?: number | null;
/** bool */
ValueBool?: boolean | null;
/** array */
ValueStrArray?: string[] | null;
}
/** 音色参数 */
declare interface VoiceConfig {
/** 公有云音色id */
VoiceType?: number | null;
/** 音色key */
TimbreKey?: string | null;
/** 音色名称 */
VoiceName?: string | null;
}
/** 网页搜索内容 */
declare interface WebSearchContent {
/** 网页搜索结果,json格式的string */
Content?: string;
}
/** 联网检索内容参考详情 */
declare interface WebSearchReference {
/** 网页URL */
Url?: string;
}
/** 对话端Widget结构 */
declare interface Widget {
/** Widget配置ID */
WidgetId?: string;
/** Widget实例ID */
WidgetRunId?: string;
/** Widget状态数据 */
State?: string | null;
/** Widget位置 */
Position?: number | null;
/** Base64编码的Widget信息 */
EncodedWidget?: string | null;
/** 用户最近一次提交的payload */
Payload?: string | null;
}
/** 对话端Widget动作提交结构 */
declare interface WidgetAction {
/** Widget配置ID */
WidgetId?: string;
/** Widget实例ID */
WidgetRunId?: string | null;
/** Widget动作 */
ActionType?: string;
/** Widget动作提交的数据 */
Payload?: string | null;
}
/** Widget参数配置 */
declare interface WidgetParam {
/** 参数名称 */
Name?: string;
/** 参数类型 */
Type?: number;
/** 子参数 */
SubParams?: WidgetParam[];
/** 默认值, Input未指定时,使用该值 */
DefaultValue?: string;
/** 输入的值 */
Input?: AgentInput;
}
/** 工作流程调试信息 */
declare interface WorkFlowSummary {
/** 工作流ID */
WorkflowId?: string | null;
/** 工作流名称 */
WorkflowName?: string | null;
/** 工作流运行ID */
WorkflowRunId?: string | null;
/** 节点信息 */
RunNodes?: WorkflowRunNodeInfo[] | null;
/** 选项卡 */
OptionCards?: string[] | null;
/** 多气泡的输出结果 */
Outputs?: string[] | null;
/** 工作流发布时间,unix时间戳 */
WorkflowReleaseTime?: string | null;
/** 中间消息 */
PendingMessages?: string[];
/** 选项卡索引 */
OptionCardIndex?: OptionCardIndex;
/** 工作流多气泡输出 */
Contents?: Content[] | null;
}
/** 工作流信息 */
declare interface WorkflowInfo {
/** 工作流ID */
WorkflowId?: string | null;
/** 工作流名称 */
WorkflowName?: string | null;
/** 工作流运行ID */
WorkflowRunId?: string | null;
/** 选项卡 */
OptionCards?: string[] | null;
/** 多气泡的输出结果 */
Outputs?: string[] | null;
/** 工作流发布时间,unix时间戳 */
WorkflowReleaseTime?: string | null;
/** 工作流多气泡输出 */
Contents?: Content[] | null;
}
/** WorkflowRef详情 */
declare interface WorkflowRef {
/** 任务流ID */
WorkflowId?: string;
/** 任务流名称 */
WorkflowName?: string;
/** 任务流描述 */
WorkflowDesc?: string;
/** 应用ID */
AppBizId?: string;
/** 更新时间 */
UpdateTime?: number;
}
/** 工作流运行实例的基本信息 */
declare interface WorkflowRunBase {
/** 运行环境。0: 测试环境; 1: 正式环境 */
RunEnv?: number;
/** 应用ID */
AppBizId?: string;
/** 工作流运行实例的ID */
WorkflowRunId?: string;
/** 所属工作流ID */
WorkflowId?: string;
/** 名称 */
Name?: string;
/** 运行状态。0: 排队中;1: 运行中;2: 运行成功;3: 运行失败; 4: 已取消 */
State?: number;
/** 错误信息 */
FailMessage?: string;
/** 消耗的token总数 */
TotalTokens?: number;
/** 创建时间(毫秒时间戳) */
CreateTime?: string;
/** 开始时间(毫秒时间戳) */
StartTime?: string;
/** 结束时间(毫秒时间戳) */
EndTime?: string;
}
/** 工作流运行实例详情 */
declare interface WorkflowRunDetail {
/** 运行环境。0: 测试环境; 1: 正式环境 */
RunEnv?: number;
/** 应用ID */
AppBizId?: string;
/** 工作流运行实例的ID */
WorkflowRunId?: string;
/** 所属工作流ID */
WorkflowId?: string;
/** 名称 */
Name?: string;
/** 工作流输出 */
Output?: string;
/** 运行状态。0: 排队中;1: 运行中;2: 运行成功;3: 运行失败; 4: 已取消 */
State?: number;
/** 错误信息 */
FailMessage?: string;
/** 消耗的token总数 */
TotalTokens?: number;
/** 创建时间(毫秒时间戳) */
CreateTime?: string;
/** 开始时间(毫秒时间戳) */
StartTime?: string;
/** 结束时间(毫秒时间戳) */
EndTime?: string;
/** 工作流画布Json */
DialogJson?: string;
/** 用户的输入 */
Query?: string;
/** 主模型名称 */
MainModelName?: string;
/** API参数配置 */
CustomVariables?: CustomVariable[];
/** 工作流的流程图 */
WorkflowGraph?: string;
}
/** 工作流运行节点信息 */
declare interface WorkflowRunNodeInfo {
/** 节点ID */
NodeId?: string | null;
/** 节点类型 */
NodeType?: number | null;
/** 节点名称 */
NodeName?: string | null;
/** 状态 */
Status?: number | null;
/** 输入 */
Input?: string | null;
/** 输出 */
Output?: string | null;
/** 任务输出 */
TaskOutput?: string | null;
/** 错误信息 */
FailMessage?: string | null;
/** 花费时长 */
CostMilliSeconds?: number | null;
/** 大模型输出信息 */
StatisticInfos?: StatisticInfo[] | null;
/** 错误代码 */
FailCode?: string | null;
}
/** //智能体应用可见范围,public-所有人可见 private-仅自己可见 share-通过分享可见 */
declare interface YuanQi {
/** public-所有人可见 */
VisibleRange?: string;
}
declare interface CallbackWorkflowToolNodeRequest {
/** ADP调用外部API时,通过HTTP Header(X-ADP-Callback-Token)传递回调CallbackToken */
CallbackToken: string;
/** 回调结果,可选,为JSON字符串 */
Result: string;
/** 登录用户主账号(集成商模式必填) */
LoginUin?: string;
/** 登录用户子账号(集成商模式必填) */
LoginSubAccountUin?: string;
/** 应用ID */
AppBizId?: string;
}
declare interface CallbackWorkflowToolNodeResponse {
/** 状态码 */
Code?: number;
/** 状态详情 */
Msg?: string;
/** 唯一请求 ID,每次请求都会返回。 */
RequestId?: string;
}
declare interface CheckAttributeLabelExistRequest {
/** 应用ID,获取方法参看如何获取[BotBizId](https://cloud.tencent.com/document/product/1759/109469) */
BotBizId: string;
/** 标签名称 */
LabelName: string;
/** 标签ID */
AttributeBizId: string;
/** 登录用户主账号(集成商模式必填) */
LoginUin?: string;
/** 登录用户子账号(集成商模式必填) */
LoginSubAccountUin?: string;
/** 最后一个标签ID。用于滚动加载:是一种分批、滚动式的存在性检查机制。客户端需要持续调用接口,并每次传入上一次返回的最后一个记录的ID,直到接口明确返回“存在”或“已检查全部数据且不存在”为止。 */
LastLabelBizId?: string;
}
declare interface CheckAttributeLabelExistResponse {
/** 是否存在 */
IsExist?: boolean;
/** 唯一请求 ID,每次请求都会返回。 */
RequestId?: string;
}
declare interface CheckAttributeLabelReferRequest {
/** 应用ID,获取方法参看如何获取[BotBizId](https://cloud.tencent.com/document/product/1759/109469) */
BotBizId: string;
/** 登录用户主账号(集成商模式必填) */
LoginUin?: string;
/** 登录用户子账号(集成商模式必填) */
LoginSubAccountUin?: string;
/** 属性标签ID */
LabelBizId?: string;
/** 标签ID */
AttributeBizId?: string[];
}
declare interface CheckAttributeLabelReferResponse {
/** 是否引用 */
IsRefer?: boolean;
/** 引用的工作流详情 */
List?: AttributeLabelRefByWorkflow[] | null;
/** 唯一请求 ID,每次请求都会返回。 */
RequestId?: string;
}
declare interface CreateAppRequest {
/** 应用类型;knowledge_qa-知识问答管理 */
AppType: string;
/** 应用基础配置 */
BaseConfig: BaseConfig;
/** 应用模式 standard:标准模式, agent: agent模式,single_workflow:单工作流模式 */
Pattern?: string;
/** 智能体类型 dialogue 对话式智能体,wechat 公众号智能体 */
AgentType?: string;
}
declare interface CreateAppResponse {
/** 应用ID */
AppBizId?: string | null;
/** 判断账户应用列表权限是否是自定义的,用户交互提示 */
IsCustomList?: boolean | null;
/** 唯一请求 ID,每次请求都会返回。 */
RequestId?: string;
}
declare interface CreateAttributeLabelRequest {
/** 应用ID,获取方法参看如何获取[BotBizId](https://cloud.tencent.com/document/product/1759/109469) */
BotBizId: string;
/** 标签名 */
AttrName: string;
/** 标签值 */
Labels: AttributeLabel[];
/** 标签标识(不生效,无需填写) 已作废 */
AttrKey?: string;
/** 登录用户主账号(集成商模式必填) */
LoginUin?: string;
/** 登录用户子账号(集成商模式必填) */
LoginSubAccountUin?: string;
}
declare interface CreateAttributeLabelResponse {
/** 标签ID */
AttrBizId?: string;
/** 标签值ID与名称 */
Labels?: AttributeLabel[];
/** 唯一请求 ID,每次请求都会返回。 */
RequestId?: string;
}
declare interface CreateDocCateRequest {
/** 应用ID */
BotBizId: string;
/** 父级业务ID */
ParentBizId: string;
/** 分类名称 */
Name: string;
}
declare interface CreateDocCateResponse {
/** 是否可新增 */
CanAdd?: boolean;
/** 是否可编辑 */
CanEdit?: boolean;
/** 是否可删除 */
CanDelete?: boolean;
/** 分类业务ID */
CateBizId?: string;
/** 唯一请求 ID,每次请求都会返回。 */
RequestId?: string;
}
declare interface CreateQACateRequest {
/** 应用ID若要操作共享知识库,传KnowledgeBizId */
BotBizId: string;
/** 父级业务ID,创建顶级分类时传字符串"0" */
ParentBizId: string;
/** 创建的分类名称 */
Name: string;
}
declare interface CreateQACateResponse {
/** 是否可新增 */
CanAdd?: boolean;
/** 是否可编辑 */
CanEdit?: boolean;
/** 是否可删除 */
CanDelete?: boolean;
/** 分类业务ID */
CateBizId?: string;
/** 唯一请求 ID,每次请求都会返回。 */
RequestId?: string;
}
declare interface CreateQARequest {
/** 应用ID若要操作共享知识库,传KnowledgeBizId */
BotBizId: string;
/** 问题 */
Question: string;
/** 答案 */
Answer: string;
/** 标签适用范围 1:全部,2:按条件 */
AttrRange: number;
/** 自定义参数 */
CustomParam?: string;
/** 标签引用 */
AttrLabels?: AttrLabelRefer[];
/** 文档ID */
DocBizId?: string;
/** 分类ID */
CateBizId?: string;
/** 有效开始时间,单位是unix时间戳。默认值为0,表示问答为永久有效. */
ExpireStart?: string;
/** 有效结束时间,unix时间戳,0代表永久有效 */
ExpireEnd?: string;
/** 相似问内容 */
SimilarQuestions?: string[];
/** 问题描述 */
QuestionDesc?: string;
/** 问答生效域: 1-不生效;2-仅开发域生效;3-仅发布域生效;4-开发域和发布域均生效默认值:应用内默认知识库为2,共享知识库为4。 */
EnableScope?: number;
}
declare interface CreateQAResponse {
/** 问答ID */
QaBizId?: string;
/** 唯一请求 ID,每次请求都会返回。 */
RequestId?: string;
}
declare interface CreateRejectedQuestionRequest {
/** 应用ID, 获取方式参看如何获取[BotBizId](https://cloud.tencent.com/document/product/1759/109469) */
BotBizId: string;
/** 拒答问题 */
Question: string;
/** 拒答问题来源, 1- 来源于不满意回复; 2 - 来源于手动添加 */
BusinessSource: number;
/** 拒答问题来源的数据源唯一id */
BusinessId?: string;
}
declare interface CreateRejectedQuestionResponse {
/** 唯一请求 ID,每次请求都会返回。 */
RequestId?: string;
}
declare interface CreateReleaseRequest {
/** 应用ID */
BotBizId: string;
/** 发布描述 */
Desc?: string;
/** 渠道业务ID,从ListChannel接口的响应字段ChannelId获取 */
ChannelBizIds?: string[];
}
declare interface CreateReleaseResponse {
/** 发布ID */
ReleaseBizId?: string;
/** 唯一请求 ID,每次请求都会返回。 */
RequestId?: string;
}
declare interface CreateSharedKnowledgeRequest {
/** 共享知识库名称,字符数量范围:[1, 50] */
KnowledgeName: string;
/** 共享知识库描述,字符数量上限2000 */
KnowledgeDescription?: string;
/** Embedding模型,字符数量上限128 */
EmbeddingModel?: string;
/** 共享知识库类型,0普通,1公众号 */
KnowledgeType?: number;
}
declare interface CreateSharedKnowledgeResponse {
/** 共享知识库业务ID */
KnowledgeBizId?: string;
/** 唯一请求 ID,每次请求都会返回。 */
RequestId?: string;
}
declare interface CreateVarRequest {
/** 应用ID */
AppBizId: string;
/** 变量名称,不允许重复,最大支持50个字符 */
VarName: string;
/** 变量描述,最大支持120个字符 */
VarDesc?: string;
/** 变量类型定义,支持类型如下:(STRING,INT,FLOAT,BOOL,OBJECT,ARRAY_STRING,ARRAY_INT,ARRAY_FLOAT,ARRAY_BOOL,ARRAY_OBJECT,FILE,DOCUMENT,IMAGE,AUDIO);传输过程是json字符串,标签中仅支持"STRING"类型使用 */
VarType?: string;
/** 自定义变量默认值 */
VarDefaultValue?: string;
/** 自定义变量文件默认名称 */
VarDefaultFileName?: string;
/** 参数类型 */
VarModuleType?: number;
}
declare interface CreateVarResponse {
/** 变量ID */
VarId?: string;
/** 唯一请求 ID,每次请求都会返回。 */
RequestId?: string;
}
declare interface CreateWorkflowRunRequest {
/** 应用ID, 获取方法参看如何获取 [BotBizId](https://cloud.tencent.com/document/product/1759/109469) */
AppBizId: string;
/** 运行环境。0: 测试环境; 1: 正式环境 */
RunEnv?: number;
/** 用户输入的内容 */
Query?: string;
/** API参数配置 */
CustomVariables?: CustomVariable[];
}
declare interface CreateWorkflowRunResponse {
/** 应用ID */
AppBizId?: string;
/** 工作流运行实例的ID */
WorkflowRunId?: string;
/** 运行环境。0: 测试环境; 1: 正式环境 */
RunEnv?: number;
/** 用户输入的内容 */
Query?: string;
/** API参数配置 */
CustomVariables?: CustomVariable[];
/** 创建时间(毫秒时间戳) */
CreateTime?: string;
/** 唯一请求 ID,每次请求都会返回。 */
RequestId?: string;
}
declare interface DeleteAgentRequest {
/** Agent的ID */
AgentId: string;
/** 应用ID */
AppBizId?: string;
}
declare interface DeleteAgentResponse {
/** Agent的ID */
AgentId?: string;
/** 唯一请求 ID,每次请求都会返回。 */
RequestId?: string;
}
declare interface DeleteAppRequest {
/** 应用ID */
AppBizId: string;
/** 应用类型;knowledge_qa-知识问答管理;summary-知识摘要;classifys-知识标签提取 */
AppType: string;
}
declare interface DeleteAppResponse {
/** 唯一请求 ID,每次请求都会返回。 */
RequestId?: string;
}
declare interface DeleteAttributeLabelRequest {
/** 应用ID,获取方法参看如何获取[BotBizId](https://cloud.tencent.com/document/product/1759/109469) */
BotBizId: string;
/** 标签ID */
AttributeBizIds: string[];
/** 登录用户主账号(集成商模式必填) */
LoginUin?: string;
/** 登录用户子账号(集成商模式必填) */
LoginSubAccountUin?: string;
}
declare interface DeleteAttributeLabelResponse {
/** 唯一请求 ID,每次请求都会返回。 */
RequestId?: string;
}
declare interface DeleteDocCateRequest {
/** 应用ID */
BotBizId: string;
/** 分类业务ID */
CateBizId: string;
}
declare interface DeleteDocCateResponse {
/** 唯一请求 ID,每次请求都会返回。 */
RequestId?: string;
}
declare interface DeleteDocRequest {
/** 文档业务ID列表 */
DocBizIds: string[];
/** 应用ID */
BotBizId: string;
}
declare interface DeleteDocResponse {
/** 唯一请求 ID,每次请求都会返回。 */
RequestId?: string;
}
declare interface DeleteQACateRequest {
/** 应用ID */
BotBizId: string;
/** 分类业务ID */
CateBizId: string;
}
declare interface DeleteQACateResponse {
/** 唯一请求 ID,每次请求都会返回。 */
RequestId?: string;
}
declare interface DeleteQARequest {
/** 应用ID */
BotBizId: string;
/** 问答ID */
QaBizIds: string[];
}
declare interface DeleteQAResponse {
/** 唯一请求 ID,每次请求都会返回。 */
RequestId?: string;
}
declare interface DeleteRejectedQuestionRequest {
/** 应用ID, 获取方法参看如何获取 [BotBizId](https://cloud.tencent.com/document/product/1759/109469)。 */
BotBizId: string;
/** 拒答问题来源的数据源唯一id */
RejectedBizIds: string[];
}
declare interface DeleteRejectedQuestionResponse {
/** 唯一请求 ID,每次请求都会返回。 */
RequestId?: string;
}
declare interface DeleteSharedKnowledgeRequest {
/** 共享知识库业务ID */
KnowledgeBizId: string;
}
declare interface DeleteSharedKnowledgeResponse {
/** 共享知识库业务ID */
KnowledgeBizId?: string;
/** 唯一请求 ID,每次请求都会返回。 */
RequestId?: string;
}
declare interface DeleteVarRequest {
/** 应用ID */
AppBizId: string;
/** 变量ID */
VarId: string;
/** 参数类型 */
VarModuleType?: number;
}
declare interface DeleteVarResponse {
/** 唯一请求 ID,每次请求都会返回。 */
RequestId?: string;
}
declare interface DescribeAppAgentListRequest {
/** 应用ID */
AppBizId?: string;
}
declare interface DescribeAppAgentListResponse {
/** 入口启动AgentID */
StaringAgentId?: string;
/** 应用Agent信息列表 */
Agents?: Agent[];
/** Agent转交高级设置 */
HandoffAdvancedSetting?: AgentHandoffAdvancedSetting;
/** 唯一请求 ID,每次请求都会返回。 */
RequestId?: string;
}
declare interface DescribeAppRequest {
/** 应用ID */
AppBizId: string;
/** 应用类型;knowledge_qa-知识问答管理;summary-知识摘要;classifys-知识标签提取 */
AppType?: string;
/** 是否发布后的配置 */
IsRelease?: boolean;
}
declare interface DescribeAppResponse {
/** 应用 ID */
AppBizId?: string;
/** 应用类型;knowledge_qa-知识问答管理;summary-知识摘要;classifys-知识标签提取 */
AppType?: string;
/** 应用类型说明 */
AppTypeDesc?: string;
/** 应用类型说明 */
BaseConfig?: BaseConfig;
/** 应用配置 */
AppConfig?: AppConfig;
/** 头像是否在申诉中 */
AvatarInAppeal?: boolean;
/** 角色描述是否在申诉中 */
RoleInAppeal?: boolean;
/** 名称是否在申诉中 */
NameInAppeal?: boolean;
/** 欢迎语是否在申诉中 */
GreetingInAppeal?: boolean;
/** 未知问题回复语是否在申诉中 */
BareAnswerInAppeal?: boolean;
/** 应用appKey */
AppKey?: string;
/** 应用状态,1:未上线,2:运行中,3:停用 */
AppStatus?: number;
/** 状态说明 */
AppStatusDesc?: string;
/** 应用是否在复制中 */
IsCopying?: boolean;
/** 智能体类型 dialogue 对话式智能体,wechat 公众号智能体 */
AgentType?: string;
/** 唯一请求 ID,每次请求都会返回。 */
RequestId?: string;
}
declare interface DescribeAttributeLabelRequest {
/** 应用ID,获取方法参看如何获取[BotBizId](https://cloud.tencent.com/document/product/1759/109469) */
BotBizId: string;
/** 标签ID */
AttributeBizId: string;
/** 每次请求返回的最大标签数量,限制单次接口返回的标签数量,避免数据量过大。取值范围:大于0。 */
Limit: number;
/** 登录用户主账号(集成商模式必填) */
LoginUin?: string;
/** 登录用户子账号(集成商模式必填) */
LoginSubAccountUin?: string;
/** 搜索关键词,用于查询标签标准词或相似词 */
Query?: string;
/** 滚动加载游标,上一次请求返回的最后一个标签ID */
LastLabelBizId?: string;
/** 查询范围 all(或者传空):标准词和相似词 standard:标准词 similar:相似词 */
QueryScope?: string;
}
declare interface DescribeAttributeLabelResponse {
/** 属性ID */
AttributeBizId?: string;
/** 属性标识 */
AttrKey?: string;
/** 属性名称 */
AttrName?: string;
/** 标签数量 */
LabelNumber?: string;
/** 标签名称 */
Labels?: AttributeLabel[];
/** 唯一请求 ID,每次请求都会返回。 */
RequestId?: string;
}
declare interface DescribeCallStatsGraphRequest {
/** 子账号标识列表,支持批量查询多个子账号。不填时查询主账号下所有子账号的汇总数据 */
UinAccount?: string[];
/** 登录用户主账号(集成商模式必填) */
LoginUin?: string;
/** 登录用户子账号(集成商模式必填) */
LoginSubAccountUin?: string;
/** 子业务类型,用于筛选不同业务场景的调用统计 */
SubBizType?: string;
/** 模型标识 */
ModelName?: string;
/** 开始时间戳, 单位为秒(废弃) */
StartTime?: string;
/** 结束时间戳, 单位为秒(废弃) */
EndTime?: string;
/** 应用id列表 */
AppBizIds?: string[];
/** 筛选子场景(文档解析场景使用) */
SubScenes?: string[];
/** 应用类型(knowledge_qa应用管理, shared_knowlege 共享知识库) */
AppType?: string;
/** 空间ID,用于限定查询范围。不填时查询所有空间的数据 */
SpaceId?: string;
/** 开始时间。Unix 时间戳,单位是秒,默认为空。 */
StatStartTime?: number;
/** 结束时间。Unix 时间戳,单位是秒,默认为空。 */
StatEndTime?: number;
}
declare interface DescribeCallStatsGraphResponse {
/** 接口调用次数统计信息 */
List?: Stat[] | null;
/** 唯一请求 ID,每次请求都会返回。 */
RequestId?: string;
}
declare interface DescribeConcurrencyUsageGraphRequest {
/** 模型标识 */
ModelName: string;
/** 开始时间戳, 单位为秒(废弃) */
StartTime?: string;
/** 结束时间戳, 单位为秒(废弃) */
EndTime?: string;
/** uin */
UinAccount?: string[];
/** 登录用户主账号(集成商模式必填) */
LoginUin?: string;
/** 登录用户子账号(集成商模式必填) */
LoginSubAccountUin?: string;
/** 子业务类型 */
SubBizType?: string;
/** 应用id列表 */
AppBizIds?: string[];
/** 空间id */
SpaceId?: string;
/** 开始时间戳, 单位为秒 */
StatStartTime?: number;
/** 结束时间戳, 单位为秒 */
StatEndTime?: number;
}
declare interface DescribeConcurrencyUsageGraphResponse {
/** X轴: 时间区域;根据查询条件的粒度返回“分/小时/日”两种区间范围 */
X?: string[];
/** 可用并发y轴坐标 */
AvailableY?: number[];
/** 成功调用并发y轴坐标 */
SuccessCallY?: number[];
/** 唯一请求 ID,每次请求都会返回。 */
RequestId?: string;
}
declare interface DescribeConcurrencyUsageRequest {
/** 模型标识 */
ModelName: string;
/** 开始时间戳, 单位为秒(废弃) */
StartTime?: string;
/** 结束时间戳, 单位为秒(废弃) */
EndTime?: string;
/** 应用id列表 */
AppBizIds?: string[];
/** 空间id */
SpaceId?: string;
/** 开始时间戳, 单位为秒 */
StatStartTime?: number;
/** 结束时间戳, 单位为秒 */
StatEndTime?: number;
}
declare interface DescribeConcurrencyUsageResponse {
/** 可用并发数上限 */
AvailableConcurrency?: number;
/** 并发峰值 */
ConcurrencyPeak?: number;
/** 超出可用并发数上限的次数 */
ExceedUsageTime?: number;
/** 唯一请求 ID,每次请求都会返回。 */
RequestId?: string;
}
declare interface DescribeDocRequest {
/** 应用ID */
BotBizId: string;
/** 文档ID */
DocBizId: string;
}
declare interface DescribeDocResponse {
/** 文档ID */
DocBizId?: string;
/** 文件名称 */
FileName?: string;
/** 文件类型 */
FileType?: string;
/** cos路径 */
CosUrl?: string;
/** 更新时间 */
UpdateTime?: string;
/** 文档状态: 1-未生成 2-生成中 3-生成成功 4-生成失败 5-删除中 6-删除成功 7-审核中 8-审核失败 9-审核成功 10,12-导入完成 13-学习中 14-学习失败 15-更新中 16-更新失败 17-解析中 18-解析失败 19-导入失败 20-已过期 21-超量失效 22-超量失效恢复 */
Status?: number;
/** 文档状态描述 */
StatusDesc?: string;
/** 生成失败原因 */
Reason?: string;
/** 答案中是否引用 */
IsRefer?: boolean;
/** 问答对数量 */
QaNum?: number;
/** 是否删除 */
IsDeleted?: boolean;
/** 文档来源 */
Source?: number;
/** 文档来源描述 */
SourceDesc?: string;
/** 是否允许重新生成 */
IsAllowRestart?: boolean;
/** qa是否已删除 */
IsDeletedQa?: boolean;
/** 问答是否生成中 */
IsCreatingQa?: boolean;
/** 是否允许删除 */
IsAllowDelete?: boolean;
/** 是否允许操作引用开关 */
IsAllowRefer?: boolean;
/** 是否生成过问答 */
IsCreatedQa?: boolean;
/** 文档字符量 */
DocCharSize?: string;
/** 是否允许编辑 */
IsAllowEdit?: boolean;
/** 标签适用范围 1:全部,2:按条件范围 */
AttrRange?: number;
/** 标签 */
AttrLabels?: AttrLabel[];
/** 分类ID */
CateBizId?: string;
/** 文档是否停用,false:未停用,true:已停用 */
IsDisabled?: boolean;
/** 是否支持下载 */
IsDownload?: boolean | null;
/** 自定义切分规则 */
SplitRule?: string | null;
/** 文档更新频率 */
UpdatePeriodInfo?: UpdatePeriodInfo | null;
/** 从根节点开始的路径分类ID */
CateBizIdPath?: string[] | null;
/** 从根节点开始的路径分类名称 */
CateNamePath?: string[] | null;
/** 文档生效域: 1-不生效;2-仅开发域生效;3-仅发布域生效;4-开发域和发布域均生效 */
EnableScope?: number;
/** 唯一请求 ID,每次请求都会返回。 */
RequestId?: string;
}
declare interface DescribeKnowledgeUsagePieGraphRequest {
/** 应用ID数组 */
AppBizIds?: string[];
/** 空间ID,用于限定查询范围。不填时查询所有空间的数据 */
SpaceId?: string;
}
declare interface DescribeKnowledgeUsagePieGraphResponse {
/** 所有应用已用的字符总数 */
AvailableCharSize?: string;
/** 应用饼图详情列表 */
List?: KnowledgeCapacityPieGraphDetail[];
/** 唯一请求 ID,每次请求都会返回。 */
RequestId?: string;
}
declare interface DescribeKnowledgeUsageRequest {
}
declare interface DescribeKnowledgeUsageResponse {
/** 可用字符数上限 */
AvailableCharSize?: string;
/** 超过可用字符数上限的字符数 */
ExceedCharSize?: string;
/** 知识库使用字符总数 */
UsedCharSize?: string;
/** 唯一请求 ID,每次请求都会返回。 */
RequestId?: string;
}
declare interface DescribeNodeRunRequest {
/** 应用ID */
AppBizId: string;
/** 节点运行实例ID */
NodeRunId: string;
}
declare interface DescribeNodeRunResponse {
/** 节点运行实例详情 */
NodeRun?: NodeRunDetail;
/** 唯一请求 ID,每次请求都会返回。 */
RequestId?: string;
}
declare interface DescribeQARequest {
/** QA业务ID */
QaBizId: string;
/** 应用ID */
BotBizId: string;
}
declare interface DescribeQAResponse {
/** QA业务ID */
QaBizId?: string;
/** 问题 */
Question?: string;
/** 答案 */
Answer?: string;
/** 自定义参数 */
CustomParam?: string;
/** 来源 1-文档生成问答对 2-批量导入问答对 3-单条手动录入问答对 */
Source?: number;
/** 来源描述 */
SourceDesc?: string;
/** 更新时间 */
UpdateTime?: string;
/** 状态 1-未校验 2,4-导入完成 5-发布失败 6-不采纳 7-审核中 8-审核失败 9-审核失败申诉后人工审核中 11-审核失败申诉后人工审核不通过 12-已过期 13-超量失效 14-超量失效恢复 19-学习中 20-学习失败 */
Status?: number;
/** 状态描述 */
StatusDesc?: string;
/** 分类ID */
CateBizId?: string;
/** 是否允许校验 */
IsAllowAccept?: boolean;
/** 是否允许删除 */
IsAllowDelete?: boolean;
/** 是否允许编辑 */
IsAllowEdit?: boolean;
/** 文档id */
DocBizId?: string;
/** 文档名称 */
FileName?: string;
/** 文档类型 */
FileType?: string;
/** 分片ID */
SegmentBizId?: string;
/** 分片内容 */
PageContent?: string;
/** 分片高亮内容 */
Highlights?: Highlight[];
/** 分片内容 */
OrgData?: string;
/** 标签适用范围 */
AttrRange?: number;
/** 标签 */
AttrLabels?: AttrLabel[];
/** 有效开始时间,unix时间戳 */
ExpireStart?: string;
/** 有效结束时间,unix时间戳,0代表永久有效 */
ExpireEnd?: string;
/** 相似问列表信息 */
SimilarQuestions?: SimilarQuestion[];
/** 问题和答案文本审核状态 1审核失败 */
QaAuditStatus?: number;
/** 答案中的图片审核状态 1审核失败 */
PicAuditStatus?: number;
/** 答案中的视频审核状态 1审核失败 */
VideoAuditStatus?: number;
/** 问题描述 */
QuestionDesc?: string;
/** 问答是否停用,false:未停用,true已停用 */
IsDisabled?: boolean;
/** 从根节点开始的路径分类ID */
CateBizIdPath?: string[] | null;
/** 从根节点开始的路径分类名称 */
CateNamePath?: string[] | null;
/** 问答生效域: 1-不生效;2-仅开发域生效;3-仅发布域生效;4-开发域和发布域均生效 */
EnableScope?: number | null;
/** 问答关联的文档生效域:1-不生效;2-仅开发域生效;3-仅发布域生效;4-开发域和发布域均生效.若问答未关联文档,则该字段值同问答生效域 */
DocEnableScope?: number;
/** 唯一请求 ID,每次请求都会返回。 */
RequestId?: string;
}
declare interface DescribeReferRequest {
/** 应用ID */
BotBizId: string;
/** 引用ID */
ReferBizIds: string[];
/** 登录用户主账号(集成商模式必填) */
LoginUin?: string;
/** 登录用户子账号(集成商模式必填) */
LoginSubAccountUin?: string;
}
declare interface DescribeReferResponse {
/** 引用列表 */
List?: ReferDetail[];
/** 唯一请求 ID,每次请求都会返回。 */
RequestId?: string;
}
declare interface DescribeReleaseInfoRequest {
/** 应用ID */
BotBizId: string;
}
declare interface DescribeReleaseInfoResponse {
/** 最后发布时间 */
LastTime?: string;
/** 发布状态 , 1-待发布 , 2-发布中 , 3-发布成功 , 4-发布失败 , 5-审核中 , 6-审核成功 , 7-审核失败 , 8-发布成功回调处理中 , 9-发布暂停 , 10-申诉审核中 , 11-申诉审核通过 , 12-申诉审核不通过 */
Status?: number;
/** 是否编辑过, 当为true的时候表示可以发布 */
IsUpdated?: boolean;
/** 失败原因 */
Msg?: string;
/** 唯一请求 ID,每次请求都会返回。 */
RequestId?: string;
}
declare interface DescribeReleaseRequest {
/** 应用ID。获取方法参看如何获取 [BotBizId](https://cloud.tencent.com/document/product/1759/109469) */
BotBizId: string;
/** 发布ID */
ReleaseBizId?: string;
}
declare interface DescribeReleaseResponse {
/** 创建时间 */
CreateTime?: string;
/** 发布描述 */
Description?: string;
/** 发布状态(1待发布 2发布中 3发布成功 4发布失败 5发布中(审核中) 6发布中(审核完成) 7发布失败(审核失败) 9发布暂停) */
Status?: number;
/** 发布状态描述 */
StatusDesc?: string;
/** 唯一请求 ID,每次请求都会返回。 */
RequestId?: string;
}
declare interface DescribeRobotBizIDByAppKeyRequest {
/** 应用appkey */
AppKey: string;
}
declare interface DescribeRobotBizIDByAppKeyResponse {
/** 应用业务ID */
BotBizId?: string;
/** 唯一请求 ID,每次请求都会返回。 */
RequestId?: string;
}
declare interface DescribeSearchStatsGraphRequest {
/** 登录用户主账号(集成商模式必填) */
LoginUin?: string;
/** 登录用户子账号(集成商模式必填) */
LoginSubAccountUin?: string;
/** uin列表 */
UinAccount?: string[];
/** 子业务类型 */
SubBizType?: string;
/** 模型标识 */
ModelName?: string;
/** 开始时间戳, 单位为秒(废弃) */
StartTime?: string;
/** 结束时间戳, 单位为秒(废弃) */
EndTime?: string;
/** 应用id列表 */
AppBizIds?: string[];
/** 空间id */
SpaceId?: string;
/** 开始时间戳, 单位为秒 */
StatStartTime?: number;
/** 结束时间戳, 单位为秒 */
StatEndTime?: number;
}
declare interface DescribeSearchStatsGraphResponse {
/** 统计结果 */
List?: Stat[] | null;
/** 唯一请求 ID,每次请求都会返回。 */
RequestId?: string;
}
declare interface DescribeSegmentsRequest {
/** 应用ID */
BotBizId: string;
/** 文档片段ID */
SegBizId?: string[];
}
declare interface DescribeSegmentsResponse {
/** 片段列表 */
List?: DocSegment[] | null;
/** 唯一请求 ID,每次请求都会返回。 */
RequestId?: string;
}
declare interface DescribeSharedKnowledgeRequest {
/** 共享知识库业务ID */
KnowledgeBizId: string;
}
declare interface DescribeSharedKnowledgeResponse {
/** 知识库详情列表 */
Info?: KnowledgeDetailInfo | null;
/** 唯一请求 ID,每次请求都会返回。 */
RequestId?: string;
}
declare interface DescribeStorageCredentialRequest {
/** 应用ID,参数非必填不代表不需要填写,下面不同的参数组合会获取到不同的权限,具体请参考 https://cloud.tencent.com/document/product/1759/116238 */
BotBizId?: string;
/** 文件类型,正常的文件名类型后缀,例如 xlsx、pdf、 docx、png 等 */
FileType?: string;
/** IsPublic用于上传文件或图片时选择场景,当上传对话端图片时IsPublic为true,上传文件(包括文档库文件/图片等和对话端文件)时IsPublic为false */
IsPublic?: boolean;
/** 存储类型: offline:离线文件,realtime:实时文件;为空默认为offline */
TypeKey?: string;
}
declare interface DescribeStorageCredentialResponse {
/** 密钥信息 */
Credentials?: Credentials;
/** 失效时间 */
ExpiredTime?: number;
/** 开始时间 */
StartTime?: number;
/** 对象存储桶 */
Bucket?: string;
/** 对象存储可用区 */
Region?: string;
/** 文件存储目录 */
FilePath?: string;
/** 存储类型 */
Type?: string;
/** 主号 */
CorpUin?: string;
/** 图片存储目录 */
ImagePath?: string;
/** 上传存储路径,到具体文件 */
UploadPath?: string;
/** 唯一请求 ID,每次请求都会返回。 */
RequestId?: string;
}
declare interface DescribeTokenUsageGraphRequest {
/** 子账号标识列表,支持批量查询多个子账号。不填时查询主账号下所有子账号的汇总数据 */
UinAccount?: string[];
/** 知识引擎子业务类型: FileParse(文档解析)、Embedding、Rewrite(多轮改写)、 Concurrency(并发)、KnowledgeSummary(知识总结) KnowledgeQA(知识问答)、KnowledgeCapacity(知识库容量)、SearchEngine(搜索引擎) */
SubBizType?: string;
/** 模型标识 */
ModelName?: string;
/** 开始时间戳, 单位为秒(废弃) */
StartTime?: string;
/** 结束时间戳, 单位为秒(废弃) */
EndTime?: string;
/** 应用ID列表。不填时:若指定SpaceId则查该空间所有应用;否则查用户下所有应用 */
AppBizIds?: string[];
/** 应用类型。可选值:knowledge_qa(知识问答)/plugin_parsing_qa(插件)/shared_knowledge(知识库)/evaluate_test(评测)。不填时查所有类型 */
AppType?: string;
/** 筛选子场景 */
SubScenes?: string[];
/** 开始时间。Unix 时间戳,单位是秒,默认为空。 */
StatStartTime?: number;
/** 结束时间。Unix 时间戳,单位是秒,默认为空。 */
StatEndTime?: number;
}
declare interface DescribeTokenUsageGraphResponse {
/** Token消耗总量 */
Total?: Stat[];
/** 输入Token消耗量 */
Input?: Stat[];
/** 输出Token消耗量 */
Output?: Stat[];
/** 唯一请求 ID,每次请求都会返回。 */
RequestId?: string;
}
declare interface DescribeTokenUsageRequest {
/** 子账号标识列表,用于筛选指定子账号的统计数据,不填时查询主账号下所有子账号的汇总数据 */
UinAccount?: string[];
/** 登录用户主账号(集成商模式必填) */
LoginUin?: string;
/** 登录用户子账号(集成商模式必填) */
LoginSubAccountUin?: string;
/** 知识引擎子业务类型: FileParse(文档解析)、Embedding、Rewrite(多轮改写)、 Concurrency(并发)、KnowledgeSummary(知识总结) KnowledgeQA(知识问答)、KnowledgeCapacity(知识库容量)、SearchEngine(搜索引擎) */
SubBizType?: string;
/** 模型标识 */
ModelName?: string;
/** 开始时间戳, 单位为秒(默认值0)(废弃) */
StartTime?: string;
/** 结束时间戳, 单位为秒(默认值0, 必须大于开始时间戳)(废弃) */
EndTime?: string;
/** 应用id列表 */
AppBizIds?: string[];
/** 筛选子场景(文档解析场景使用) */
SubScenes?: string[];
/** 应用类型(knowledge_qa应用管理, shared_knowlege 共享知识库) */
AppType?: string;
/** 空间ID,用于限定查询范围。不填时查询所有空间的数据 */
SpaceId?: string;
/** 开始时间。Unix 时间戳,单位是秒,默认为空。 */
StatStartTime?: number;
/** 结束时间。Unix 时间戳,单位是秒,默认为空。 */
StatEndTime?: number;
}
declare interface DescribeTokenUsageResponse {
/** 总token消耗量 */
TotalTokenUsage?: number;
/** 输入token消耗 */
InputTokenUsage?: number;
/** 输出token消耗 */
OutputTokenUsage?: number;
/** 接口调用次数 */
ApiCallStats?: number;
/** 搜索服务调用次数 */
SearchUsage?: number;
/** 文档解析消耗页数 */
PageUsage?: number;
/** 拆分token消耗量 */
SplitTokenUsage?: number;
/** Rag检索次数 */
RagSearchUsage?: number;
/** 联网搜索次数 */
InternetSearchUsage?: number;
/** dosage配额限制 */
DosageTypeLimit?: number;
/** dosage当前用量 */
DosageTypeCurr?: number;
/** 唯一请求 ID,每次请求都会返回。 */
RequestId?: string;
}
declare interface DescribeUnsatisfiedReplyContextRequest {
/** 应用ID,获取方法参看如何获取[BotBizId](https://cloud.tencent.com/document/product/1759/109469) */
BotBizId: string;
/** 回复ID */
ReplyBizId: string;
/** 登录用户主账号(集成商模式必填) */
LoginUin?: string;
/** 登录用户子账号(集成商模式必填) */
LoginSubAccountUin?: string;
}
declare interface DescribeUnsatisfiedReplyContextResponse {
/** 不满意回复上下文 */
List?: Context[] | null;
/** 唯一请求 ID,每次请求都会返回。 */
RequestId?: string;
}
declare interface DescribeWorkflowRunRequest {
/** 应用ID, 获取方法参看如何获取 [BotBizId](https://cloud.tencent.com/document/product/1759/109469)。 */
AppBizId: string;
/** 工作流运行实例ID */
WorkflowRunId: string;
/** 指定的子工作流对应的NodePath。格式:`[[].]*[]`- 此路径用于定位一个具体的工作流实例(Workflow Run),可以是主工作流实例或某个子工作流节点产生的子实例。- 路径由点号(.)分隔的节点标识符组成,每个节点标识符格式为 `节点ID[实例索引]`。- **节点ID (node_id)**:子工作流所属的节点的ID。- **实例索引 (index)**:“实例索引” 在工作流节点的时候为空,循环、批处理节点非空,从1开始。示例:- "" 或 不设置 -> 查询主工作流实例 (父工作流)- "node_id_a" -> 查询由主工作流中工作流节点`node_id_a`对应的子工作流实例- "node_id_a.node_id_b[1]" -> 查询工作流节点`node_id_a`对应的子工作流的循环节点node_id_b的第1轮循环的子工作流运行状态 */
SubWorkflowNodePath?: string;
/** 是否需要返回工作流的流程图配置 */
IncludeWorkflowGraph?: boolean;
}
declare interface DescribeWorkflowRunResponse {
/** 工作流运行实例详情 */
WorkflowRun?: WorkflowRunDetail;
/** 节点列表 */
NodeRuns?: NodeRunBase[];
/** 子工作流对应的NodePath */
SubWorkflowNodePath?: string;
/** 唯一请求 ID,每次请求都会返回。 */
RequestId?: string;
}
declare interface ExportAttributeLabelRequest {
/** 应用ID,获取方法参看如何获取[BotBizId](https://cloud.tencent.com/document/product/1759/109469) */
BotBizId: string;
/** 登录用户主账号(集成商模式必填) */
LoginUin?: string;
/** 登录用户子账号(集成商模式必填) */
LoginSubAccountUin?: string;
/** 标签ID */
AttributeBizIds?: string[];
/** 根据筛选数据导出 */
Filters?: AttributeFilters;
}
declare interface ExportAttributeLabelResponse {
/** 导出任务ID */
TaskId?: string;
/** 唯一请求 ID,每次请求都会返回。 */
RequestId?: string;
}
declare interface ExportQAListRequest {
/** 应用ID若要操作共享知识库,传KnowledgeBizId */
BotBizId: string;
/** QA业务ID */
QaBizIds: string[];
/** 查询参数Filters.pageNumber范围是>0,00) */
PageNumber: number;
/** 每页大小(取值范围1-200) */
PageSize: number;
/** 查询问题输入特定标识 lke:system:untagged 将查询所有未关联标签的问答 */
Query?: string;
/** 校验状态(1未校验2采纳3不采纳)如果不填默认值为空数组,表示不筛选,返回所有状态 */
AcceptStatus?: number[];
/** 发布状态(2,4导入成功 7审核中 8审核失败 9人工申述中 11人工申述失败 12已过期 13超量失效 14超量失效恢复)如果不填默认值为空数组,表示不筛选返回所有状态 */
ReleaseStatus?: number[];
/** 文档ID */
DocBizId?: string;
/** 来源(1 文档生成 2 批量导入 3 手动添加)不填默认值为0,表示不过滤,返回所有状态 */
Source?: number;
/** 查询答案 */
QueryAnswer?: string;
/** 分类ID */
CateBizId?: string;
/** QA业务ID列表 */
QaBizIds?: string[];
/** 查询类型 filename 名称、 attribute 标签如果不填默认值为"filename" */
QueryType?: string;
/** 是否只展示当前分类的数据 0不是,1是 */
ShowCurrCate?: number;
/** 问答生效域检索,不检索不传。枚举值如下:1-不生效;2-仅开发域生效;3-仅发布域生效;4-开发域和发布域均生效。 */
EnableScope?: number;
}
declare interface ListQAResponse {
/** 问答数量 */
Total?: string;
/** 待校验问答数量 */
WaitVerifyTotal?: string;
/** 未采纳问答数量 */
NotAcceptedTotal?: string;
/** 已采纳问答数量 */
AcceptedTotal?: string;
/** 页码 */
PageNumber?: number;
/** 问答详情 */
List?: ListQaItem[];
/** 唯一请求 ID,每次请求都会返回。 */
RequestId?: string;
}
declare interface ListReferShareKnowledgeRequest {
/** 应用业务id */
AppBizId: string;
/** 登录用户主账号(集成商模式必填) */
LoginUin?: string;
/** 登录用户子账号(集成商模式必填) */
LoginSubAccountUin?: string;
}
declare interface ListReferShareKnowledgeResponse {
/** 共享知识库信息列表 */
List?: KnowledgeBaseInfo[];
/** 共享知识库数量 */
Total?: string | null;
/** 唯一请求 ID,每次请求都会返回。 */
RequestId?: string;
}
declare interface ListRejectedQuestionPreviewRequest {
/** 应用ID(获取方法参看如何获取 [BotBizId](https://cloud.tencent.com/document/product/1759/109469)) */
BotBizId: string;
/** 页码(必须大于0) */
PageNumber: number;
/** 每页数量(取值范围为1-200) */
PageSize: number;
/** 查询内容关键字,用于模糊查询,若未提供该参数,默认为查询全部。 */
Query?: string;
/** 发布单ID(可以通过[ListRelease](https://cloud.tencent.com/document/product/1759/105077)获得) */
ReleaseBizId?: string;
/** 状态(1新增2更新3删除) */
Actions?: number[];
/** 开始时间。Unix 时间戳,单位是秒,默认为空。 */
StartTime?: string;
/** 结束时间。Unix 时间戳,单位是秒,默认为空。 */
EndTime?: string;
}
declare interface ListRejectedQuestionPreviewResponse {
/** 文档数量 */
Total?: string;
/** 文档列表 */
List?: ReleaseRejectedQuestion[];
/** 唯一请求 ID,每次请求都会返回。 */
RequestId?: string;
}
declare interface ListRejectedQuestionRequest {
/** 应用ID, 获取方法参看如何获取 [BotBizId](https://cloud.tencent.com/document/product/1759/109469)。 */
BotBizId: string;
/** 页码(必须大于0) */
PageNumber: number;
/** 每页数量(取值范围1-200) */
PageSize: number;
/** 查询内容 */
Query?: string;
}
declare interface ListRejectedQuestionResponse {
/** 总数 */
Total?: string;
/** 拒答问题列表 */
List?: RejectedQuestion[];
/** 唯一请求 ID,每次请求都会返回。 */
RequestId?: string;
}
declare interface ListReleaseConfigPreviewRequest {
/** 应用ID(获取方法参看如何获取 [BotBizId](https://cloud.tencent.com/document/product/1759/109469)) */
BotBizId: string;
/** 页码(必须大于0) */
PageNumber: number;
/** 每页数量(取值范围为1-200) */
PageSize: number;
/** 查询内容关键字,用于模糊查询,若未提供该参数,默认为查询全部。 */
Query?: string;
/** 发布单ID(可以通过[ListRelease](https://cloud.tencent.com/document/product/1759/105077)获得) */
ReleaseBizId?: string;
/** 状态(1新增2更新3删除) */
Actions?: number[];
/** 开始时间。Unix 时间戳,单位是秒,默认为空。 */
StartTime?: string;
/** 结束时间。Unix 时间戳,单位是秒,默认为空。 */
EndTime?: string;
/** 发布状态(2 待发布 3 发布中 4 已发布 5 发布失败),默认为空 */
ReleaseStatus?: number[];
}
declare interface ListReleaseConfigPreviewResponse {
/** 数量 */
Total?: string;
/** 配置项列表 */
List?: ReleaseConfigs[];
/** 唯一请求 ID,每次请求都会返回。 */
RequestId?: string;
}
declare interface ListReleaseDocPreviewRequest {
/** 应用ID(获取方法参看如何获取 [BotBizId](https://cloud.tencent.com/document/product/1759/109469)) */
BotBizId: string;
/** 页码(必须大于0) */
PageNumber: number;
/** 每页数量(取值范围为1-200) */
PageSize: number;
/** 查询内容关键字,用于模糊查询,若未提供该参数,默认为查询全部。 */
Query?: string;
/** 发布单ID(可以通过[ListRelease](https://cloud.tencent.com/document/product/1759/105077)获得) */
ReleaseBizId?: string;
/** 开始时间。Unix 时间戳,单位是秒,默认为空。 */
StartTime?: string;
/** 结束时间。Unix 时间戳,单位是秒,默认为空。 */
EndTime?: string;
/** 状态(1新增2修改3删除),其和ReleaseStatus的区别为: Actions表示的是对数据/内容的操作状态,ReleaseStatus表示数据 / 内容本身的发布状态 */
Actions?: number[];
}
declare interface ListReleaseDocPreviewResponse {
/** 文档数量 */
Total?: string;
/** 文档列表 */
List?: ReleaseDoc[];
/** 唯一请求 ID,每次请求都会返回。 */
RequestId?: string;
}
declare interface ListReleaseQAPreviewRequest {
/** 应用ID(获取方法参看如何获取 [BotBizId](https://cloud.tencent.com/document/product/1759/109469)) */
BotBizId: string;
/** 页码(必须大于0) */
PageNumber: number;
/** 每页数量(取值范围为1-200) */
PageSize: number;
/** 查询内容关键字,用于模糊查询,若未提供该参数,默认为查询全部。 */
Query?: string;
/** 发布单ID(可以通过[ListRelease](https://cloud.tencent.com/document/product/1759/105077)获得) */
ReleaseBizId?: string;
/** 开始时间。Unix 时间戳,单位是秒,默认为空。 */
StartTime?: string;
/** 结束时间。Unix 时间戳,单位是秒,默认为空。 */
EndTime?: string;
/** 状态(1新增2修改3删除),其和ReleaseStatus的区别为:Actions表示的是对数据/内容的操作状态,ReleaseStatus表示数据/内容本身的发布状态 */
Actions?: number[];
/** 发布状态(4发布成功5发布失败)。其和Actions的区别为:Actions表示的是对数据/内容的操作状态,ReleaseStatus表示数据/内容本身的发布状态 */
ReleaseStatus?: number[];
}
declare interface ListReleaseQAPreviewResponse {
/** 文档数量 */
Total?: string;
/** 文档列表 */
List?: ReleaseQA[];
/** 唯一请求 ID,每次请求都会返回。 */
RequestId?: string;
}
declare interface ListReleaseRequest {
/** 应用ID(获取方法参看如何获取 [BotBizId](https://cloud.tencent.com/document/product/1759/109469)) */
BotBizId: string;
/** 页码(必须大于0) */
PageNumber: number;
/** 每页数量(取值范围为1-200) */
PageSize: number;
}
declare interface ListReleaseResponse {
/** 发布列表数量 */
Total?: string;
/** 发布列表 */
List?: ListReleaseItem[];
/** 唯一请求 ID,每次请求都会返回。 */
RequestId?: string;
}
declare interface ListSelectDocRequest {
/** 应用ID,获取方法参看如何获取[BotBizId](https://cloud.tencent.com/document/product/1759/109469) */
BotBizId: string;
/** 文档名称。可通过文档名称检索支持生成问答的文档,不支持xlsx、xls、csv格式 */
FileName?: string;
/** 文档状态筛选。文档状态对应码为7 审核中、8 审核失败、10 待发布、11 发布中、12 已发布、13 学习中、14 学习失败 20 已过期。其中仅状态为10 待发布、12 已发布的文档支持生成问答(未填写时默认值为空数组) */
Status?: number[];
}
declare interface ListSelectDocResponse {
/** 下拉框内容 */
List?: Option[];
/** 唯一请求 ID,每次请求都会返回。 */
RequestId?: string;
}
declare interface ListSharedKnowledgeRequest {
/** 分页序号,编码从1开始 */
PageNumber: number;
/** 分页大小,有效范围为[1,200] */
PageSize: number;
/** 搜索关键字 */
Keyword?: string;
/** 共享知识库类型,0普通,1公众号 */
KnowledgeTypes?: number[];
}
declare interface ListSharedKnowledgeResponse {
/** 累计数量 */
Total?: number;
/** 知识库列表 */
KnowledgeList?: KnowledgeDetailInfo[] | null;
/** 唯一请求 ID,每次请求都会返回。 */
RequestId?: string;
}
declare interface ListUnsatisfiedReplyRequest {
/** 应用ID,获取方法参看如何获取[BotBizId](https://cloud.tencent.com/document/product/1759/109469) */
BotBizId: string;
/** 页码,取值范围:大于0 */
PageNumber: number;
/** 分页数量,取值范围:大于0 */
PageSize: number;
/** 登录用户主账号(集成商模式必填) */
LoginUin?: string;
/** 登录用户子账号(集成商模式必填) */
LoginSubAccountUin?: string;
/** 用户请求(问题或答案),按关键词检索,可匹配用户问题或答案 */
Query?: string;
/** 按错误类型检索 */
Reasons?: string[];
/** 按操作状态检索 0-全部 1-待处理 2-已处理【包括答案纠错,拒答,忽略】,不填时默认值为0 */
Status?: number;
/** 处理状态 0-待处理 1-已拒答 2-已忽略 3-已添加为新问答 4-已添加为相似问 */
HandlingStatuses?: number[];
}
declare interface ListUnsatisfiedReplyResponse {
/** 总数 */
Total?: string;
/** 不满意回复列表 */
List?: UnsatisfiedReply[] | null;
/** 唯一请求 ID,每次请求都会返回。 */
RequestId?: string;
}
declare interface ListUsageCallDetailRequest {
/** 模型标识 */
ModelName: string;
/** 页码(从1开始) */
PageNumber: number;
/** 分页数量(最大值1000) */
PageSize: number;
/** 开始时间(废弃) */
StartTime?: string;
/** 结束时间(废弃) */
EndTime?: string;
/** uin列表 */
UinAccount?: string[];
/** 应用ID列表 */
AppBizIds?: string[];
/** 调用类型列表 */
CallType?: string;
/** 筛选子场景 */
SubScenes?: string[];
/** 应用类型(knowledge_qa应用管理, shared_knowlege 共享知识库) */
AppType?: string;
/** 账单明细对应的自定义tag */
BillingTag?: string;
/** 空间id */
SpaceId?: string;
/** 开始时间戳, 单位为秒 */
StatStartTime?: number;
/** 开始时间戳, 单位为秒 */
StatEndTime?: number;
}
declare interface ListUsageCallDetailResponse {
/** 列表总数 */
Total?: number;
/** 列表 */
List?: CallDetail[];
/** 唯一请求 ID,每次请求都会返回。 */
RequestId?: string;
}
declare interface ListWorkflowRunsRequest {
/** 应用ID, 获取方法参看如何获取 [BotBizId](https://cloud.tencent.com/document/product/1759/109469) */
AppBizId: string;
/** 每页数量(取值范围1-200) */
PageSize: number;
/** 运行环境。0: 测试环境; 1: 正式环境 */
RunEnv?: number;
/** 页码(必须大于0) */
Page?: number;
/** 登录用户主账号(集成商模式必填) */
LoginUin?: string;
/** 登录用户子账号(集成商模式必填) */
LoginSubAccountUin?: string;
}
declare interface ListWorkflowRunsResponse {
/** 总数 */
Total?: number;
/** 工作流运行列表 */
WorkflowRuns?: WorkflowRunBase[];
/** 唯一请求 ID,每次请求都会返回。 */
RequestId?: string;
}
declare interface ModifyAppRequest {
/** 应用ID, 获取方法参看如何获取 [BotBizId](https://cloud.tencent.com/document/product/1759/109469)。 */
AppBizId: string;
/** 应用类型;"knowledge_qa" 知识问答应用(包含标准模式 单工作流 Multi-Agent 等模式) */
AppType: string;
/** 应用基础配置 */
BaseConfig: BaseConfig;
/** 应用配置 */
AppConfig: AppConfig;
/** 登录用户子账号(集成商模式必填) */
LoginSubAccountUin?: string;
}
declare interface ModifyAppResponse {
/** 应用App */
AppBizId?: string | null;
/** 更新时间 */
UpdateTime?: string;
/** 唯一请求 ID,每次请求都会返回。 */
RequestId?: string;
}
declare interface ModifyAttributeLabelRequest {
/** 应用ID */
BotBizId: string;
/** 标签ID */
AttributeBizId: string;
/** 标签名称 */
AttrName: string;
/** 标签标识 (已作废) */
AttrKey?: string;
/** 登录用户主账号(集成商模式必填) */
LoginUin?: string;
/** 登录用户子账号(集成商模式必填) */
LoginSubAccountUin?: string;
/** 删除的标签值 */
DeleteLabelBizIds?: string[];
/** 新增或编辑的标签 */
Labels?: AttributeLabel[];
}
declare interface ModifyAttributeLabelResponse {
/** 任务ID */
TaskId?: string;
/** 标签ID与名称 */
Labels?: AttributeLabel[];
/** 唯一请求 ID,每次请求都会返回。 */
RequestId?: string;
}
declare interface ModifyDocAttrRangeRequest {
/** 应用ID,获取方法参看[如何获取 BotBizId](https://cloud.tencent.com/document/product/1759/109469) */
BotBizId: string;
/** 文档ID */
DocBizIds: string[];
/** 属性标签适用范围 1:全部,2:按条件 */
AttrRange: number;
/** 属性标签引用,LabelBizIds可通过 DescribeAttributeLabel 接口获取 */
AttrLabels: AttrLabelRefer[];
}
declare interface ModifyDocAttrRangeResponse {
/** 唯一请求 ID,每次请求都会返回。 */
RequestId?: string;
}
declare interface ModifyDocCateRequest {
/** 应用ID */
BotBizId: string;
/** 分类名称 */
Name: string;
/** 分类业务ID */
CateBizId: string;
}
declare interface ModifyDocCateResponse {
/** 唯一请求 ID,每次请求都会返回。 */
RequestId?: string;
}
declare interface ModifyDocRequest {
/** 应用ID,获取方法参看[如何获取 BotBizId](https://cloud.tencent.com/document/product/1759/109469) */
BotBizId: string;
/** 文档ID */
DocBizId: string;
/** 是否引用链接 */
IsRefer: boolean;
/** 标签适用范围,1:全部,2:按条件。默认为1。 */
AttrRange: number;
/** 登录用户主账号(集成商模式必填) */
LoginUin?: string;
/** 登录用户子账号(集成商模式必填) */
LoginSubAccountUin?: string;
/** 关联的标签 */
AttrLabels?: AttrLabelRefer[];
/** 网页(或自定义链接)地址 */
WebUrl?: string;
/** 外部引用链接类型 0:系统链接 1:自定义链接值为1时,WebUrl 字段不能为空,否则不生效。 */
ReferUrlType?: number;
/** 有效开始时间,单位为unix时间戳 */
ExpireStart?: string;
/** 有效结束时间,单位为unix时间戳,默认值为0代表永久有效 */
ExpireEnd?: string;
/** 分类ID */
CateBizId?: string;
/** 是否可下载,IsRefer为true并且ReferUrlType为0时,该值才有意义 */
IsDownload?: boolean;
/** 需要修改的内容类型 0 无效 1 更新文档cos信息 2 更新文档引用信息 3 更新文档刷新频率 4 腾讯文档刷新 */
ModifyTypes?: number[];
/** 文档更新频率 */
UpdatePeriodInfo?: UpdatePeriodInfo;
/** 自定义切分规则 */
SplitRule?: string;
/** 文档生效域: 1-不生效;2-仅开发域生效;3-仅发布域生效;4-开发域和发布域均生效。若不传,则不会修改文档生效域。 */
EnableScope?: number;
}
declare interface ModifyDocResponse {
/** 唯一请求 ID,每次请求都会返回。 */
RequestId?: string;
}
declare interface ModifyQAAttrRangeRequest {
/** 应用ID */
BotBizId: string;
/** 问答ID */
QaBizIds: string[];
/** 属性标签适用范围 1:全部,2:按条件 */
AttrRange: number;
/** 属性标签引用 */
AttrLabels: AttrLabelRefer[];
}
declare interface ModifyQAAttrRangeResponse {
/** 唯一请求 ID,每次请求都会返回。 */
RequestId?: string;
}
declare interface ModifyQACateRequest {
/** 应用ID */
BotBizId: string;
/** 分类名称 */
Name: string;
/** 分类业务ID */
CateBizId: string;
}
declare interface ModifyQACateResponse {
/** 唯一请求 ID,每次请求都会返回。 */
RequestId?: string;
}
declare interface ModifyQARequest {
/** 应用ID若要操作共享知识库,传KnowledgeBizId */
BotBizId: string;
/** 问答ID */
QaBizId: string;
/** 问题 */
Question: string;
/** 答案 */
Answer: string;
/** 自定义参数 */
CustomParam?: string;
/** 标签适用范围 1:全部,2:按条件默认值:当没有属性标签,labelRefers为空时,默认值为1有属性标签,labelRefers不为空,默认值为2 */
AttrRange?: number;
/** 标签引用 */
AttrLabels?: AttrLabelRefer[];
/** 文档ID */
DocBizId?: string;
/** 分类ID */
CateBizId?: string;
/** 有效开始时间,单位是unix时间戳,默认值为0,代表永久有效 */
ExpireStart?: string;
/** 有效结束时间,单位是unix时间戳,默认值为0,代表永久有效 */
ExpireEnd?: string;
/** 相似问修改信息(相似问没有修改则不传) */
SimilarQuestionModify?: SimilarQuestionModify;
/** 问题描述 */
QuestionDesc?: string;
/** 问答生效范围: 1-不生效;2-仅开发域生效;3-仅发布域生效;4-开发域和发布域均生效。若不传该字段,则不修改问答的生效范围。 */
EnableScope?: number;
}
declare interface ModifyQAResponse {
/** 唯一请求 ID,每次请求都会返回。 */
RequestId?: string;
}
declare interface ModifyRejectedQuestionRequest {
/** 应用ID, 获取方法参看如何获取 [BotBizId](https://cloud.tencent.com/document/product/1759/109469) */
BotBizId: string;
/** 拒答问题 */
Question: string;
/** 拒答问题来源的数据源唯一id, 通过调用ListRejectedQuestion接口获取 */
RejectedBizId: string;
}
declare interface ModifyRejectedQuestionResponse {
/** 唯一请求 ID,每次请求都会返回。 */
RequestId?: string;
}
declare interface RateMsgRecordRequest {
/** 应用appKey */
BotAppKey: string;
/** 消息ID 【大模型回复答案的RecordID】可以通过[GetMsgRecord](https://cloud.tencent.com/document/product/1759/105090)接口获取 */
RecordId: string;
/** 0: 取消前置状态 ; 1: 点赞; 2: 点踩; 注:(1) 评测端不支持点赞、点踩(2) 消息回复类型为欢迎语、并发超限、实时文档,不支持点赞、点踩(3) 点赞或者点踩之后,如果想要取消状态,传值为0即可 */
Score: number;
/** 支持通过API自定义,字符上限值为20字符;通过API 自定义标签,可以支持平台端用户在不满意问题错误类型中筛选、查看 */
Reasons?: string[];
/** 用户自定义反馈内容 */
FeedbackContent?: string;
}
declare interface RateMsgRecordResponse {
/** 唯一请求 ID,每次请求都会返回。 */
RequestId?: string;
}
declare interface ReferShareKnowledgeRequest {
/** 应用业务id */
AppBizId: string;
/** 共享知识库业务id列表 */
KnowledgeBizId: string[];
/** 登录用户主账号(集成商模式必填) */
LoginUin?: string;
/** 登录用户子账号(集成商模式必填) */
LoginSubAccountUin?: string;
}
declare interface ReferShareKnowledgeResponse {
/** 唯一请求 ID,每次请求都会返回。 */
RequestId?: string;
}
declare interface RenameDocRequest {
/** 登录用户主账号(集成商模式必填) */
LoginUin?: string;
/** 登录用户子账号(集成商模式必填) */
LoginSubAccountUin?: string;
/** 应用ID */
BotBizId?: string;
/** 文档ID */
DocBizId?: string;
/** 新文档名,需要带上后缀 */
NewName?: string;
}
declare interface RenameDocResponse {
/** 唯一请求 ID,每次请求都会返回。 */
RequestId?: string;
}
declare interface RetryDocAuditRequest {
/** 应用ID */
BotBizId: string;
/** 文档ID */
DocBizId: string;
}
declare interface RetryDocAuditResponse {
/** 唯一请求 ID,每次请求都会返回。 */
RequestId?: string;
}
declare interface RetryDocParseRequest {
/** 应用ID */
BotBizId: string;
/** 废弃 */
DocBizId?: string;
/** 集合最大上限50个,DocBizIds有值使用DocBizIds,为空时则使用DocBizId(兼容废弃字段) */
DocBizIds?: string[];
}
declare interface RetryDocParseResponse {
/** 唯一请求 ID,每次请求都会返回。 */
RequestId?: string;
}
declare interface RetryReleaseRequest {
/** 应用ID(获取方法参看如何获取 [BotBizId](https://cloud.tencent.com/document/product/1759/109469)) */
BotBizId: string;
/** 发布单ID(可以通过[ListRelease](https://cloud.tencent.com/document/product/1759/105077)获得) */
ReleaseBizId: string;
}
declare interface RetryReleaseResponse {
/** 唯一请求 ID,每次请求都会返回。 */
RequestId?: string;
}
declare interface SaveDocRequest {
/** 应用ID,获取方法参看[如何获取 BotBizId](https://cloud.tencent.com/document/product/1759/109469) */
BotBizId: string;
/** 文件名,需要包含文件扩展名 */
FileName: string;
/** 文档支持下面类型pdf、doc、docx、ppt、mhtml、pptx、wps、ppsx,单个文件不超过200MB;xlsx、xls、md、txt、csv、html,单个文件不超过20MB;图片支持下面类型:jpg、png、jpeg、tiff、bmp、gif,单个文件不超过50MB */
FileType: string;
/** 平台cos路径,与DescribeStorageCredential接口查询UploadPath参数保持一致 */
CosUrl: string;
/** ETag 全称为 Entity Tag,是对象被创建时标识对象内容的信息标签,可用于检查对象的内容是否发生变化 成功上传cos后,从返回头中获取 */
ETag: string;
/** cos_hash x-cos-hash-crc64ecma 头部中的 CRC64编码进行校验上传到云端的文件和本地文件的一致性 成功上传cos后,从返回头中获取请注意:cos_hash为文档唯一性标识,与文件名无关 相同的cos_hash会被判定为重复文档 */
CosHash: string;
/** 文件大小 */
Size: string;
/** 标签适用范围,1:全部,2:按条件。默认为1。 */
AttrRange?: number;
/** 来源(0 从本地文档导入),默认值为0 */
Source?: number;
/** 自定义链接地址, IsRefer为true的时候,该值才有意义 */
WebUrl?: string;
/** 标签引用 */
AttrLabels?: AttrLabelRefer[];
/** 外部引用链接类型 0:系统链接 1:自定义链接值为1时,WebUrl 字段不能为空,否则不生效。 */
ReferUrlType?: number;
/** 有效开始时间,unix秒级时间戳,默认为0 */
ExpireStart?: string;
/** 有效结束时间,unix秒级时间戳,默认为0代表永久有效 */
ExpireEnd?: string;
/** 是否显示引用的文档来源(false不显示 true显示)默认false */
IsRefer?: boolean;
/** 文档操作类型:1:批量导入(批量导入问答对);2:文档导入(正常导入单个文档) 默认为2 请注意,opt=1的时候请从腾讯云智能体开发平台页面下载excel模板 */
Opt?: number;
/** 分类ID */
CateBizId?: string;
/** 是否可下载,IsRefer为true并且ReferUrlType为0时,该值才有意义 */
IsDownload?: boolean;
/** 重复文档处理方式,按顺序匹配第一个满足条件的方式处理 */
DuplicateFileHandles?: DuplicateFileHandle[];
/** 自定义切分规则请求参数为一个 **JSON Object**,具体格式可参见接口示例值。包含以下主要字段:| 字段名 | 类型 | 说明 ||--------------------|--------|----------------------------------------|| `xlsx_splitter` | Object | **Excel(xlsx)文件切分策略配置**,仅当处理 Excel 文件时有效 || `common_splitter` | Object | **通用文件(如 txt、pdf 等)切分策略配置**,按页或按标签切分 || `table_style` | String | 表格内容的输出格式,如 HTML 或 Markdown |---## `xlsx_splitter`(Excel 切分策略)用于配置 **表格文件的切分方式**。**类型:Object**```json"xlsx_splitter": { "header_interval": [1, 2], "content_start": 10, "split_row": 2}```### 字段说明:| 字段名 | 类型 | 说明 ||-------------------|--------|----------------------------------------------------------------------|| `header_interval` | Array\ | 表头所在的行区间,格式为 `[起始行, 结束行]`,**行号从 1 开始计数**。例如 `[1, 2]` 表示第 1~2 行为表头。 || `content_start` | Number | **表格内容的起始行号(从 1 开始)**。 || `split_row` | Number | **切分行数**。 |---## `common_splitter`(通用文件切分策略)用于配置 **非 Excel 文件(如 TXT、PDF、DOCX 等)的切分方式**,支持两种策略:**按页切分(page)** 或 **按标识符切分(tag)**。**类型:Object**```json"common_splitter": { "splitter": "page", "page_splitter": { "chunk_length": 1000, "chunk_overlap_length": 100 }}```### 字段说明:| 字段名 | 类型 | 说明 ||-------------------|--------|---------------------------------------------------|| `splitter` | String | 切分策略类型,可选值为:`"page"`(按页切分) 或 `"tag"`(按标识符切分)。 || `page_splitter` | Object | **按页切分的配置**。 || `page_splitter.chunk_length` | 1000 | **切片最大长度**。 || `page_splitter.chunk_overlap_length` | 100 | **切片重叠长度**。 || `tag_splitter` | Object | **自定义切分配置**。 || `tag_splitter.tag` | Array\ | **切分标识符**。 || `tag_splitter.chunk_length`| Number | **切片最大长度**。 || `tag_splitter.chunk_overlap_length` | Number | **切块重叠长度**。 |🔹 **补充说明:**- `splitter` 字段的值可以是: - `"page"`:只使用按页切分逻辑,此时只需要关心 `page_splitter` 相关字段。 - `"tag"`:只使用按标识符(如分号、换行等)切分逻辑,此时关注 `tag_splitter`。---## `table_style`(表格输出样式)用于指定 **表格类内容(比如从 Excel 或 CSV 中提取的表格)最终以何种格式返回**,方便前端展示或后续处理。**类型:String**```json"table_style": "md"```### 字段说明:| 字段名 | 类型 | 说明 ||--------------|--------|----------------------------------------------------------------------|| `table_style` | String | 指定表格内容的输出格式。可用值:• `"html"`:以 HTML 表格形式返回,适合网页展示。• `"md"`:以 Markdown 表格语法返回,适合文档或 Markdown 渲染环境。| */
SplitRule?: string;
/** 文档更新频率,默认值为0不更新 */
UpdatePeriodInfo?: UpdatePeriodInfo;
/** 文档生效域: 1-不生效;2-仅开发域生效;3-仅发布域生效;4-开发域和发布域均生效默认值:应用内默认知识库为2,共享知识库为4。 */
EnableScope?: number;
}
declare interface SaveDocResponse {
/** 文档ID */
DocBizId?: string;
/** 导入错误信息 */
ErrorMsg?: string;
/** 错误链接 */
ErrorLink?: string;
/** 错误链接文本 */
ErrorLinkText?: string;
/** 重复类型,0:未重复,其他取值请参考入参DuplicateFileHandle结构体的CheckType字段 */
DuplicateFileCheckType?: number;
/** 唯一请求 ID,每次请求都会返回。 */
RequestId?: string;
}
declare interface StopDocParseRequest {
/** 应用ID */
BotBizId: string;
/** 文档ID */
DocBizId: string;
}
declare interface StopDocParseResponse {
/** 唯一请求 ID,每次请求都会返回。 */
RequestId?: string;
}
declare interface StopWorkflowRunRequest {
/** 应用ID */
AppBizId: string;
/** 工作流运行实例ID */
WorkflowRunId: string;
}
declare interface StopWorkflowRunResponse {
/** 唯一请求 ID,每次请求都会返回。 */
RequestId?: string;
}
declare interface UpdateSharedKnowledgeRequest {
/** 共享知识库业务ID */
KnowledgeBizId: string;
/** 共享知识库更新信息 */
Info?: KnowledgeUpdateInfo;
}
declare interface UpdateSharedKnowledgeResponse {
/** 共享知识库业务ID */
KnowledgeBizId?: string;
/** 唯一请求 ID,每次请求都会返回。 */
RequestId?: string;
}
declare interface UpdateVarRequest {
/** 应用ID */
AppBizId: string;
/** 变量ID */
VarId: string;
/** 变量名称,最大支持50个字符 */
VarName: string;
/** 参数描述 */
VarDesc?: string;
/** 参数类型 */
VarType?: string;
/** 自定义变量默认值 */
VarDefaultValue?: string;
/** 自定义变量文件默认名称 */
VarDefaultFileName?: string;
/** 变量类型 */
VarModuleType?: number;
}
declare interface UpdateVarResponse {
/** 变量ID */
VarId?: string;
/** 唯一请求 ID,每次请求都会返回。 */
RequestId?: string;
}
declare interface UploadAttributeLabelRequest {
/** 应用ID */
BotBizId: string;
/** 文件名 */
FileName: string;
/** cos路径 */
CosUrl: string;
/** x-cos-hash-crc64ecma 头部中的 CRC64编码进行校验上传到云端的文件和本地文件的一致性 */
CosHash: string;
/** 文件大小 */
Size: string;
/** 登录用户主账号(集成商模式必填) */
LoginUin?: string;
/** 登录用户子账号(集成商模式必填) */
LoginSubAccountUin?: string;
}
declare interface UploadAttributeLabelResponse {
/** 导入错误 */
ErrorMsg?: string;
/** 错误链接 */
ErrorLink?: string;
/** 错误链接文本 */
ErrorLinkText?: string;
/** 唯一请求 ID,每次请求都会返回。 */
RequestId?: string;
}
declare interface VerifyQARequest {
/** 问答列表 */
List: QAList[];
/** 应用ID */
BotBizId: string;
/** 登录用户主账号(集成商模式必填) */
LoginUin?: string;
/** 登录用户子账号(集成商模式必填) */
LoginSubAccountUin?: string;
/** 用于操作共享知识库 */
KnowledgeBizId?: string;
}
declare interface VerifyQAResponse {
/** 唯一请求 ID,每次请求都会返回。 */
RequestId?: string;
}
/** {@link Lke 腾讯云智能体开发平台} */
declare interface Lke {
(): Versions;
/** 工作流工具节点异步调用回调 {@link CallbackWorkflowToolNodeRequest} {@link CallbackWorkflowToolNodeResponse} */
CallbackWorkflowToolNode(data: CallbackWorkflowToolNodeRequest, config?: AxiosRequestConfig): AxiosPromise;
/** 检查标签下的标签值是否存在 {@link CheckAttributeLabelExistRequest} {@link CheckAttributeLabelExistResponse} */
CheckAttributeLabelExist(data: CheckAttributeLabelExistRequest, config?: AxiosRequestConfig): AxiosPromise;
/** 检查标签引用 {@link CheckAttributeLabelReferRequest} {@link CheckAttributeLabelReferResponse} */
CheckAttributeLabelRefer(data: CheckAttributeLabelReferRequest, config?: AxiosRequestConfig): AxiosPromise;
/** 创建应用 {@link CreateAppRequest} {@link CreateAppResponse} */
CreateApp(data: CreateAppRequest, config?: AxiosRequestConfig): AxiosPromise;
/** 创建标签 {@link CreateAttributeLabelRequest} {@link CreateAttributeLabelResponse} */
CreateAttributeLabel(data: CreateAttributeLabelRequest, config?: AxiosRequestConfig): AxiosPromise;
/** 创建Doc分类 {@link CreateDocCateRequest} {@link CreateDocCateResponse} */
CreateDocCate(data: CreateDocCateRequest, config?: AxiosRequestConfig): AxiosPromise;
/** 录入问答 {@link CreateQARequest} {@link CreateQAResponse} */
CreateQA(data: CreateQARequest, config?: AxiosRequestConfig): AxiosPromise;
/** 创建QA分类 {@link CreateQACateRequest} {@link CreateQACateResponse} */
CreateQACate(data: CreateQACateRequest, config?: AxiosRequestConfig): AxiosPromise;
/** 创建拒答问题 {@link CreateRejectedQuestionRequest} {@link CreateRejectedQuestionResponse} */
CreateRejectedQuestion(data: CreateRejectedQuestionRequest, config?: AxiosRequestConfig): AxiosPromise;
/** 创建发布 {@link CreateReleaseRequest} {@link CreateReleaseResponse} */
CreateRelease(data: CreateReleaseRequest, config?: AxiosRequestConfig): AxiosPromise;
/** 创建共享知识库 {@link CreateSharedKnowledgeRequest} {@link CreateSharedKnowledgeResponse} */
CreateSharedKnowledge(data: CreateSharedKnowledgeRequest, config?: AxiosRequestConfig): AxiosPromise;
/** 创建变量 {@link CreateVarRequest} {@link CreateVarResponse} */
CreateVar(data: CreateVarRequest, config?: AxiosRequestConfig): AxiosPromise;
/** 创建工作流的异步运行实例 {@link CreateWorkflowRunRequest} {@link CreateWorkflowRunResponse} */
CreateWorkflowRun(data: CreateWorkflowRunRequest, config?: AxiosRequestConfig): AxiosPromise;
/** 删除Agent {@link DeleteAgentRequest} {@link DeleteAgentResponse} */
DeleteAgent(data: DeleteAgentRequest, config?: AxiosRequestConfig): AxiosPromise;
/** 删除应用 {@link DeleteAppRequest} {@link DeleteAppResponse} */
DeleteApp(data: DeleteAppRequest, config?: AxiosRequestConfig): AxiosPromise;
/** 删除标签 {@link DeleteAttributeLabelRequest} {@link DeleteAttributeLabelResponse} */
DeleteAttributeLabel(data: DeleteAttributeLabelRequest, config?: AxiosRequestConfig): AxiosPromise;
/** 删除文档 {@link DeleteDocRequest} {@link DeleteDocResponse} */
DeleteDoc(data: DeleteDocRequest, config?: AxiosRequestConfig): AxiosPromise;
/** Doc分类删除 {@link DeleteDocCateRequest} {@link DeleteDocCateResponse} */
DeleteDocCate(data: DeleteDocCateRequest, config?: AxiosRequestConfig): AxiosPromise;
/** 删除问答 {@link DeleteQARequest} {@link DeleteQAResponse} */
DeleteQA(data: DeleteQARequest, config?: AxiosRequestConfig): AxiosPromise;
/** 分类删除 {@link DeleteQACateRequest} {@link DeleteQACateResponse} */
DeleteQACate(data: DeleteQACateRequest, config?: AxiosRequestConfig): AxiosPromise;
/** 删除拒答问题 {@link DeleteRejectedQuestionRequest} {@link DeleteRejectedQuestionResponse} */
DeleteRejectedQuestion(data: DeleteRejectedQuestionRequest, config?: AxiosRequestConfig): AxiosPromise;
/** 删除共享知识库 {@link DeleteSharedKnowledgeRequest} {@link DeleteSharedKnowledgeResponse} */
DeleteSharedKnowledge(data: DeleteSharedKnowledgeRequest, config?: AxiosRequestConfig): AxiosPromise;
/** 删除变量 {@link DeleteVarRequest} {@link DeleteVarResponse} */
DeleteVar(data: DeleteVarRequest, config?: AxiosRequestConfig): AxiosPromise;
/** 获取企业下应用详情 {@link DescribeAppRequest} {@link DescribeAppResponse} */
DescribeApp(data: DescribeAppRequest, config?: AxiosRequestConfig): AxiosPromise;
/** 拉取应用下Agent列表 {@link DescribeAppAgentListRequest} {@link DescribeAppAgentListResponse} */
DescribeAppAgentList(data?: DescribeAppAgentListRequest, config?: AxiosRequestConfig): AxiosPromise;
/** 查询标签详情 {@link DescribeAttributeLabelRequest} {@link DescribeAttributeLabelResponse} */
DescribeAttributeLabel(data: DescribeAttributeLabelRequest, config?: AxiosRequestConfig): AxiosPromise;
/** 接口调用调用量统计 {@link DescribeCallStatsGraphRequest} {@link DescribeCallStatsGraphResponse} */
DescribeCallStatsGraph(data?: DescribeCallStatsGraphRequest, config?: AxiosRequestConfig): AxiosPromise;
/** 并发调用 {@link DescribeConcurrencyUsageRequest} {@link DescribeConcurrencyUsageResponse} */
DescribeConcurrencyUsage(data: DescribeConcurrencyUsageRequest, config?: AxiosRequestConfig): AxiosPromise;
/** 并发调用折线图 {@link DescribeConcurrencyUsageGraphRequest} {@link DescribeConcurrencyUsageGraphResponse} */
DescribeConcurrencyUsageGraph(data: DescribeConcurrencyUsageGraphRequest, config?: AxiosRequestConfig): AxiosPromise;
/** 文档详情 {@link DescribeDocRequest} {@link DescribeDocResponse} */
DescribeDoc(data: DescribeDocRequest, config?: AxiosRequestConfig): AxiosPromise;
/** 查询知识库用量 {@link DescribeKnowledgeUsageRequest} {@link DescribeKnowledgeUsageResponse} */
DescribeKnowledgeUsage(data?: DescribeKnowledgeUsageRequest, config?: AxiosRequestConfig): AxiosPromise;
/** 查询知识库容量分布统计 {@link DescribeKnowledgeUsagePieGraphRequest} {@link DescribeKnowledgeUsagePieGraphResponse} */
DescribeKnowledgeUsagePieGraph(data?: DescribeKnowledgeUsagePieGraphRequest, config?: AxiosRequestConfig): AxiosPromise;
/** 查看工作流异步运行实例的节点的运行详情 {@link DescribeNodeRunRequest} {@link DescribeNodeRunResponse} */
DescribeNodeRun(data: DescribeNodeRunRequest, config?: AxiosRequestConfig): AxiosPromise;
/** 问答详情 {@link DescribeQARequest} {@link DescribeQAResponse} */
DescribeQA(data: DescribeQARequest, config?: AxiosRequestConfig): AxiosPromise;
/** 获取来源详情列表 {@link DescribeReferRequest} {@link DescribeReferResponse} */
DescribeRefer(data: DescribeReferRequest, config?: AxiosRequestConfig): AxiosPromise;
/** 发布详情 {@link DescribeReleaseRequest} {@link DescribeReleaseResponse} */
DescribeRelease(data: DescribeReleaseRequest, config?: AxiosRequestConfig): AxiosPromise;
/** 拉取发布按钮状态、最后发布时间 {@link DescribeReleaseInfoRequest} {@link DescribeReleaseInfoResponse} */
DescribeReleaseInfo(data: DescribeReleaseInfoRequest, config?: AxiosRequestConfig): AxiosPromise;
/** 通过appKey获取应用业务ID {@link DescribeRobotBizIDByAppKeyRequest} {@link DescribeRobotBizIDByAppKeyResponse} */
DescribeRobotBizIDByAppKey(data: DescribeRobotBizIDByAppKeyRequest, config?: AxiosRequestConfig): AxiosPromise;
/** 查询搜索服务调用折线图 {@link DescribeSearchStatsGraphRequest} {@link DescribeSearchStatsGraphResponse} */
DescribeSearchStatsGraph(data?: DescribeSearchStatsGraphRequest, config?: AxiosRequestConfig): AxiosPromise;
/** 获取片段详情 {@link DescribeSegmentsRequest} {@link DescribeSegmentsResponse} */
DescribeSegments(data: DescribeSegmentsRequest, config?: AxiosRequestConfig): AxiosPromise;
/** 查询共享知识库 {@link DescribeSharedKnowledgeRequest} {@link DescribeSharedKnowledgeResponse} */
DescribeSharedKnowledge(data: DescribeSharedKnowledgeRequest, config?: AxiosRequestConfig): AxiosPromise;
/** 获取文件上传临时密钥 {@link DescribeStorageCredentialRequest} {@link DescribeStorageCredentialResponse} */
DescribeStorageCredential(data?: DescribeStorageCredentialRequest, config?: AxiosRequestConfig): AxiosPromise;
/** 接口调用token详情 {@link DescribeTokenUsageRequest} {@link DescribeTokenUsageResponse} */
DescribeTokenUsage(data?: DescribeTokenUsageRequest, config?: AxiosRequestConfig): AxiosPromise;
/** 接口调用token调用量统计 {@link DescribeTokenUsageGraphRequest} {@link DescribeTokenUsageGraphResponse} */
DescribeTokenUsageGraph(data?: DescribeTokenUsageGraphRequest, config?: AxiosRequestConfig): AxiosPromise;
/** 获取不满意回复上下文 {@link DescribeUnsatisfiedReplyContextRequest} {@link DescribeUnsatisfiedReplyContextResponse} */
DescribeUnsatisfiedReplyContext(data: DescribeUnsatisfiedReplyContextRequest, config?: AxiosRequestConfig): AxiosPromise;
/** 查询工作流异步运行实例的详情 {@link DescribeWorkflowRunRequest} {@link DescribeWorkflowRunResponse} */
DescribeWorkflowRun(data: DescribeWorkflowRunRequest, config?: AxiosRequestConfig): AxiosPromise;
/** 导出标签 {@link ExportAttributeLabelRequest} {@link ExportAttributeLabelResponse} */
ExportAttributeLabel(data: ExportAttributeLabelRequest, config?: AxiosRequestConfig): AxiosPromise;
/** 导出QA列表 {@link ExportQAListRequest} {@link ExportQAListResponse} */
ExportQAList(data: ExportQAListRequest, config?: AxiosRequestConfig): AxiosPromise;
/** 导出不满意回复 {@link ExportUnsatisfiedReplyRequest} {@link ExportUnsatisfiedReplyResponse} */
ExportUnsatisfiedReply(data: ExportUnsatisfiedReplyRequest, config?: AxiosRequestConfig): AxiosPromise;
/** 文档生成问答 {@link GenerateQARequest} {@link GenerateQAResponse} */
GenerateQA(data: GenerateQARequest, config?: AxiosRequestConfig): AxiosPromise;
/** 回答类型数据统计 {@link GetAnswerTypeDataCountRequest} {@link GetAnswerTypeDataCountResponse} */
GetAnswerTypeDataCount(data: GetAnswerTypeDataCountRequest, config?: AxiosRequestConfig): AxiosPromise;
/** 获取知识问答个数 {@link GetAppKnowledgeCountRequest} {@link GetAppKnowledgeCountResponse} */
GetAppKnowledgeCount(data: GetAppKnowledgeCountRequest, config?: AxiosRequestConfig): AxiosPromise;
/** 获取应用密钥 {@link GetAppSecretRequest} {@link GetAppSecretResponse} */
GetAppSecret(data: GetAppSecretRequest, config?: AxiosRequestConfig): AxiosPromise;
/** 获取文档预览信息 {@link GetDocPreviewRequest} {@link GetDocPreviewResponse} */
GetDocPreview(data: GetDocPreviewRequest, config?: AxiosRequestConfig): AxiosPromise;
/** 点踩点赞数据统计 {@link GetLikeDataCountRequest} {@link GetLikeDataCountResponse} */
GetLikeDataCount(data: GetLikeDataCountRequest, config?: AxiosRequestConfig): AxiosPromise;
/** 获取聊天历史 {@link GetMsgRecordRequest} {@link GetMsgRecordResponse} */
GetMsgRecord(data: GetMsgRecordRequest, config?: AxiosRequestConfig): AxiosPromise;
/** 查询任务状态 {@link GetTaskStatusRequest} {@link GetTaskStatusResponse} */
GetTaskStatus(data: GetTaskStatusRequest, config?: AxiosRequestConfig): AxiosPromise;
/** 获取变量列表 {@link GetVarListRequest} {@link GetVarListResponse} */
GetVarList(data: GetVarListRequest, config?: AxiosRequestConfig): AxiosPromise;
/** 获取ws token {@link GetWsTokenRequest} {@link GetWsTokenResponse} */
GetWsToken(data: GetWsTokenRequest, config?: AxiosRequestConfig): AxiosPromise;
/** Doc分组 {@link GroupDocRequest} {@link GroupDocResponse} */
GroupDoc(data: GroupDocRequest, config?: AxiosRequestConfig): AxiosPromise;
/** QA分组 {@link GroupQARequest} {@link GroupQAResponse} */
GroupQA(data: GroupQARequest, config?: AxiosRequestConfig): AxiosPromise;
/** 忽略不满意回复 {@link IgnoreUnsatisfiedReplyRequest} {@link IgnoreUnsatisfiedReplyResponse} */
IgnoreUnsatisfiedReply(data: IgnoreUnsatisfiedReplyRequest, config?: AxiosRequestConfig): AxiosPromise;
/** 是否意图转人工 {@link IsTransferIntentRequest} {@link IsTransferIntentResponse} */
IsTransferIntent(data: IsTransferIntentRequest, config?: AxiosRequestConfig): AxiosPromise;
/** 获取企业下应用列表 {@link ListAppRequest} {@link ListAppResponse} */
ListApp(data?: ListAppRequest, config?: AxiosRequestConfig): AxiosPromise;
/** 列表查询知识库容量详情 {@link ListAppKnowledgeDetailRequest} {@link ListAppKnowledgeDetailResponse} */
ListAppKnowledgeDetail(data: ListAppKnowledgeDetailRequest, config?: AxiosRequestConfig): AxiosPromise;
/** 查询标签列表 {@link ListAttributeLabelRequest} {@link ListAttributeLabelResponse} */
ListAttributeLabel(data: ListAttributeLabelRequest, config?: AxiosRequestConfig): AxiosPromise;
/** 获取发布渠道列表 {@link ListChannelRequest} {@link ListChannelResponse} */
ListChannel(data: ListChannelRequest, config?: AxiosRequestConfig): AxiosPromise;
/** 文档列表 {@link ListDocRequest} {@link ListDocResponse} */
ListDoc(data: ListDocRequest, config?: AxiosRequestConfig): AxiosPromise;
/** 获取文档分类 {@link ListDocCateRequest} {@link ListDocCateResponse} */
ListDocCate(data: ListDocCateRequest, config?: AxiosRequestConfig): AxiosPromise;
/** 获取模型列表 {@link ListModelRequest} {@link ListModelResponse} */
ListModel(data: ListModelRequest, config?: AxiosRequestConfig): AxiosPromise;
/** 问答列表 {@link ListQARequest} {@link ListQAResponse} */
ListQA(data: ListQARequest, config?: AxiosRequestConfig): AxiosPromise;
/** 获取QA分类 {@link ListQACateRequest} {@link ListQACateResponse} */
ListQACate(data: ListQACateRequest, config?: AxiosRequestConfig): AxiosPromise;
/** 查看应用引用的共享知识库列表 {@link ListReferShareKnowledgeRequest} {@link ListReferShareKnowledgeResponse} */
ListReferShareKnowledge(data: ListReferShareKnowledgeRequest, config?: AxiosRequestConfig): AxiosPromise;
/** 获取拒答问题 {@link ListRejectedQuestionRequest} {@link ListRejectedQuestionResponse} */
ListRejectedQuestion(data: ListRejectedQuestionRequest, config?: AxiosRequestConfig): AxiosPromise;
/** 发布拒答问题预览 {@link ListRejectedQuestionPreviewRequest} {@link ListRejectedQuestionPreviewResponse} */
ListRejectedQuestionPreview(data: ListRejectedQuestionPreviewRequest, config?: AxiosRequestConfig): AxiosPromise;
/** 发布列表 {@link ListReleaseRequest} {@link ListReleaseResponse} */
ListRelease(data: ListReleaseRequest, config?: AxiosRequestConfig): AxiosPromise;
/** 发布配置项预览 {@link ListReleaseConfigPreviewRequest} {@link ListReleaseConfigPreviewResponse} */
ListReleaseConfigPreview(data: ListReleaseConfigPreviewRequest, config?: AxiosRequestConfig): AxiosPromise;
/** 发布文档预览 {@link ListReleaseDocPreviewRequest} {@link ListReleaseDocPreviewResponse} */
ListReleaseDocPreview(data: ListReleaseDocPreviewRequest, config?: AxiosRequestConfig): AxiosPromise;
/** 发布问答预览 {@link ListReleaseQAPreviewRequest} {@link ListReleaseQAPreviewResponse} */
ListReleaseQAPreview(data: ListReleaseQAPreviewRequest, config?: AxiosRequestConfig): AxiosPromise;
/** 获取文档生成问答可选文档列表 {@link ListSelectDocRequest} {@link ListSelectDocResponse} */
ListSelectDoc(data: ListSelectDocRequest, config?: AxiosRequestConfig): AxiosPromise;
/** 列举共享知识库 {@link ListSharedKnowledgeRequest} {@link ListSharedKnowledgeResponse} */
ListSharedKnowledge(data: ListSharedKnowledgeRequest, config?: AxiosRequestConfig): AxiosPromise;
/** 查询不满意回复列表 {@link ListUnsatisfiedReplyRequest} {@link ListUnsatisfiedReplyResponse} */
ListUnsatisfiedReply(data: ListUnsatisfiedReplyRequest, config?: AxiosRequestConfig): AxiosPromise;
/** 列表查询单次调用明细 {@link ListUsageCallDetailRequest} {@link ListUsageCallDetailResponse} */
ListUsageCallDetail(data: ListUsageCallDetailRequest, config?: AxiosRequestConfig): AxiosPromise;
/** 查询工作流异步运行实例的列表 {@link ListWorkflowRunsRequest} {@link ListWorkflowRunsResponse} */
ListWorkflowRuns(data: ListWorkflowRunsRequest, config?: AxiosRequestConfig): AxiosPromise;
/** 修改应用请求结构体 {@link ModifyAppRequest} {@link ModifyAppResponse} */
ModifyApp(data: ModifyAppRequest, config?: AxiosRequestConfig): AxiosPromise;
/** 编辑标签 {@link ModifyAttributeLabelRequest} {@link ModifyAttributeLabelResponse} */
ModifyAttributeLabel(data: ModifyAttributeLabelRequest, config?: AxiosRequestConfig): AxiosPromise;
/** 修改文档 {@link ModifyDocRequest} {@link ModifyDocResponse} */
ModifyDoc(data: ModifyDocRequest, config?: AxiosRequestConfig): AxiosPromise;
/** 批量修改文档适用范围 {@link ModifyDocAttrRangeRequest} {@link ModifyDocAttrRangeResponse} */
ModifyDocAttrRange(data: ModifyDocAttrRangeRequest, config?: AxiosRequestConfig): AxiosPromise;
/** 修改Doc分类 {@link ModifyDocCateRequest} {@link ModifyDocCateResponse} */
ModifyDocCate(data: ModifyDocCateRequest, config?: AxiosRequestConfig): AxiosPromise;
/** 更新问答 {@link ModifyQARequest} {@link ModifyQAResponse} */
ModifyQA(data: ModifyQARequest, config?: AxiosRequestConfig): AxiosPromise;
/** 批量修改问答适用范围 {@link ModifyQAAttrRangeRequest} {@link ModifyQAAttrRangeResponse} */
ModifyQAAttrRange(data: ModifyQAAttrRangeRequest, config?: AxiosRequestConfig): AxiosPromise;
/** 更新QA分类 {@link ModifyQACateRequest} {@link ModifyQACateResponse} */
ModifyQACate(data: ModifyQACateRequest, config?: AxiosRequestConfig): AxiosPromise;
/** 修改拒答问题 {@link ModifyRejectedQuestionRequest} {@link ModifyRejectedQuestionResponse} */
ModifyRejectedQuestion(data: ModifyRejectedQuestionRequest, config?: AxiosRequestConfig): AxiosPromise;
/** 评价消息【点赞点踩】 {@link RateMsgRecordRequest} {@link RateMsgRecordResponse} */
RateMsgRecord(data: RateMsgRecordRequest, config?: AxiosRequestConfig): AxiosPromise;
/** 引用共享知识库接口 {@link ReferShareKnowledgeRequest} {@link ReferShareKnowledgeResponse} */
ReferShareKnowledge(data: ReferShareKnowledgeRequest, config?: AxiosRequestConfig): AxiosPromise;
/** 文档重命名 {@link RenameDocRequest} {@link RenameDocResponse} */
RenameDoc(data?: RenameDocRequest, config?: AxiosRequestConfig): AxiosPromise;
/** 文档审核重试 {@link RetryDocAuditRequest} {@link RetryDocAuditResponse} */
RetryDocAudit(data: RetryDocAuditRequest, config?: AxiosRequestConfig): AxiosPromise;
/** 文档解析重试 {@link RetryDocParseRequest} {@link RetryDocParseResponse} */
RetryDocParse(data: RetryDocParseRequest, config?: AxiosRequestConfig): AxiosPromise;
/** 发布暂停后重试 {@link RetryReleaseRequest} {@link RetryReleaseResponse} */
RetryRelease(data: RetryReleaseRequest, config?: AxiosRequestConfig): AxiosPromise;
/** 知识库文档录入 {@link SaveDocRequest} {@link SaveDocResponse} */
SaveDoc(data: SaveDocRequest, config?: AxiosRequestConfig): AxiosPromise;
/** 终止文档解析 {@link StopDocParseRequest} {@link StopDocParseResponse} */
StopDocParse(data: StopDocParseRequest, config?: AxiosRequestConfig): AxiosPromise;
/** 停止工作流异步运行实例 {@link StopWorkflowRunRequest} {@link StopWorkflowRunResponse} */
StopWorkflowRun(data: StopWorkflowRunRequest, config?: AxiosRequestConfig): AxiosPromise;
/** 更新共享知识库 {@link UpdateSharedKnowledgeRequest} {@link UpdateSharedKnowledgeResponse} */
UpdateSharedKnowledge(data: UpdateSharedKnowledgeRequest, config?: AxiosRequestConfig): AxiosPromise;
/** 修改变量 {@link UpdateVarRequest} {@link UpdateVarResponse} */
UpdateVar(data: UpdateVarRequest, config?: AxiosRequestConfig): AxiosPromise;
/** 上传导入标签 {@link UploadAttributeLabelRequest} {@link UploadAttributeLabelResponse} */
UploadAttributeLabel(data: UploadAttributeLabelRequest, config?: AxiosRequestConfig): AxiosPromise;
/** 校验问答 {@link VerifyQARequest} {@link VerifyQAResponse} */
VerifyQA(data: VerifyQARequest, config?: AxiosRequestConfig): AxiosPromise;
}
export declare type Versions = ["2023-11-30"];
export default Lke;