tencentcloud-sdk-nodejs
Version:
2,490 lines (2,476 loc) • 276 kB
TypeScript
/**
* GetWsToken返回参数结构体
*/
export interface GetWsTokenResponse {
/**
* token值（有效期60s，仅一次有效，多次校验会报错）
*/
Token?: string;
/**
* 余额; 余额大于 0 时表示有效
注意：此字段可能返回 null，表示取不到有效值。
*/
Balance?: number;
/**
* 对话窗输入字符限制
*/
InputLenLimit?: number;
/**
* 应用模式，standard:标准模式, agent: agent模式，single_workflow：单工作流模式
*/
Pattern?: string;
/**
* SingleWorkflow
*/
SingleWorkflow?: KnowledgeQaSingleWorkflow;
/**
* 使用视觉模型时对话窗口输入字符限制
注意：此字段可能返回 null，表示取不到有效值。
*/
VisionModelInputLimit?: number;
/**
* 唯一请求 ID，由服务端生成，每次请求都会返回（若请求因其他原因未能抵达服务端，则该次请求不会获得 RequestId）。定位问题时需要提供该次请求的 RequestId。
*/
RequestId?: string;
}
/**
* GetAppSecret请求参数结构体
*/
export interface GetAppSecretRequest {
/**
* 应用ID
*/
AppBizId: string;
}
/**
* 扩展信息
*/
export interface ExtraInfo {
/**
* ECharts信息
注意：此字段可能返回 null，表示取不到有效值。
*/
EChartsInfo?: Array<string>;
}
/**
* ListSelectDoc返回参数结构体
*/
export interface ListSelectDocResponse {
/**
* 下拉框内容
*/
List?: Array<Option>;
/**
* 唯一请求 ID，由服务端生成，每次请求都会返回（若请求因其他原因未能抵达服务端，则该次请求不会获得 RequestId）。定位问题时需要提供该次请求的 RequestId。
*/
RequestId?: string;
}
/**
* DeleteDoc请求参数结构体
*/
export interface DeleteDocRequest {
/**
* 文档业务ID列表
*/
DocBizIds: Array<string>;
/**
* 应用ID。
删除知识库文档时，该参数填入知识库ID。
*/
BotBizId: string;
}
/**
* Agent高级设置
*/
export interface AgentAdvancedConfig {
/**
* 是否开启澄清询问
*/
EnableClarification?: boolean;
/**
* 思考模式，0为效果优先，1为速度优先
*/
ThinkingMode?: number;
/**
* 最大推理轮数
*/
MaxReasoningRound?: number;
/**
* 上下文轮数
*/
HistoryLimit?: number;
/**
* 是否开启结构化输出
*/
EnableStructuredOutput?: boolean;
/**
* 结构化输出配置
*/
StructuredOutputConfig?: StructuredOutputConfig;
/**
* Agent输出配置
*/
AgentOutputConfig?: AgentOutputConfig;
/**
* 澄清询问配置
*/
ClarificationConfig?: ClarificationConfig;
}
/**
* 工作流信息
*/
export interface WorkflowInfo {
/**
* <p>工作流ID</p>
注意：此字段可能返回 null，表示取不到有效值。
*/
WorkflowId?: string;
/**
* <p>工作流名称</p>
注意：此字段可能返回 null，表示取不到有效值。
*/
WorkflowName?: string;
/**
* <p>工作流运行ID</p>
注意：此字段可能返回 null，表示取不到有效值。
*/
WorkflowRunId?: string;
/**
* <p>选项卡</p>
注意：此字段可能返回 null，表示取不到有效值。
*/
OptionCards?: Array<string>;
/**
* <p>多气泡的输出结果</p>
注意：此字段可能返回 null，表示取不到有效值。
*/
Outputs?: Array<string>;
/**
* <p>工作流发布时间，unix时间戳</p>
注意：此字段可能返回 null，表示取不到有效值。
*/
WorkflowReleaseTime?: string;
/**
* <p>工作流多气泡输出</p>
注意：此字段可能返回 null，表示取不到有效值。
*/
Contents?: Array<Content>;
/**
* <p>标识选项卡为单选还是双选</p><p>枚举值：</p><ul><li>0： 单选</li><li>1： 多选</li></ul>
*/
OptionMode?: number;
}
/**
* 文档类参考来源信息
*/
export interface DocReference {
/**
* 文档业务ID
*/
DocBizId?: number;
/**
* 文档片段参考ID
注意：此字段可能返回 null，表示取不到有效值。
*/
ReferBizId?: number;
/**
* 文档名称
注意：此字段可能返回 null，表示取不到有效值。
*/
DocName?: string;
/**
* 文档所在知识库业务ID
注意：此字段可能返回 null，表示取不到有效值。
*/
KnowledgeBizId?: number;
/**
* 文档所在知识库名称
注意：此字段可能返回 null，表示取不到有效值。
*/
KnowledgeName?: string;
/**
* 文档访问地址
注意：此字段可能返回 null，表示取不到有效值。
*/
Url?: string;
}
/**
* GetAppSecret返回参数结构体
*/
export interface GetAppSecretResponse {
/**
* 应用密钥
*/
AppKey?: string;
/**
* 创建时间
*/
CreateTime?: string;
/**
* 是否发布
*/
IsRelease?: boolean;
/**
* 是否有查看权限
*/
HasPermission?: boolean;
/**
* 唯一请求 ID，由服务端生成，每次请求都会返回（若请求因其他原因未能抵达服务端，则该次请求不会获得 RequestId）。定位问题时需要提供该次请求的 RequestId。
*/
RequestId?: string;
}
/**
* UploadAttributeLabel返回参数结构体
*/
export interface UploadAttributeLabelResponse {
/**
* 导入错误
*/
ErrorMsg?: string;
/**
* 错误链接
*/
ErrorLink?: string;
/**
* 错误链接文本
*/
ErrorLinkText?: string;
/**
* 唯一请求 ID，由服务端生成，每次请求都会返回（若请求因其他原因未能抵达服务端，则该次请求不会获得 RequestId）。定位问题时需要提供该次请求的 RequestId。
*/
RequestId?: string;
}
/**
* CreateSharedKnowledge请求参数结构体
*/
export interface CreateSharedKnowledgeRequest {
/**
* <p>共享知识库名称，字符数量范围：[1, 50]</p>
*/
KnowledgeName: string;
/**
* <p>共享知识库描述，字符数量上限2000</p>
*/
KnowledgeDescription?: string;
/**
* <p>Embedding模型，字符数量上限128</p>
* @deprecated
*/
EmbeddingModel?: string;
/**
* <p>共享知识库类型，0普通，1公众号</p>
*/
KnowledgeType?: number;
/**
* <p>ES存储配置</p>
*/
EsConfig?: ESConfig;
}
/**
* 标签引用信息
*/
export interface AttrLabelRefer {
/**
* 标签来源，1：标签。
使用标签引用信息时，Source、AttributeBizId和LabelBizIds都需填写。
*/
Source?: number;
/**
* 标签ID
*/
AttributeBizId?: string;
/**
* 标签值ID
*/
LabelBizIds?: Array<string>;
}
/**
* 工作流的API参数
*/
export interface CustomVariable {
/**
* 参数名称
*/
Name?: string;
/**
* 参数的值
*/
Value?: string;
}
/**
* 应用配置关联的agent信息
*/
export interface KnowledgeQaAgent {
/**
* 协同方式，1：自由转交，2：工作流编排，3：Plan-and-Execute
注意：此字段可能返回 null，表示取不到有效值。
*/
AgentCollaboration?: number;
/**
* 应用配置agent关联的工作流
注意：此字段可能返回 null，表示取不到有效值。
*/
Workflow?: KnowledgeQaWorkflowInfo;
}
/**
* 标签详情信息
*/
export interface AttrLabel {
/**
* 标签来源
注意：此字段可能返回 null，表示取不到有效值。
*/
Source?: number;
/**
* 标签ID
注意：此字段可能返回 null，表示取不到有效值。
*/
AttrBizId?: string;
/**
* 标签标识
注意：此字段可能返回 null，表示取不到有效值。
*/
AttrKey?: string;
/**
* 标签名称
注意：此字段可能返回 null，表示取不到有效值。
*/
AttrName?: string;
/**
* 标签值
注意：此字段可能返回 null，表示取不到有效值。
*/
Labels?: Array<Label>;
}
/**
* 发布文档详情
*/
export interface ReleaseDoc {
/**
* 文件名
*/
FileName?: string;
/**
* 文件类型
*/
FileType?: string;
/**
* 更新时间
*/
UpdateTime?: string;
/**
* 状态
*/
Action?: number;
/**
* 状态描述
*/
ActionDesc?: string;
/**
* 失败原因
*/
Message?: string;
/**
* 文档业务ID
*/
DocBizId?: string;
}
/**
* DescribeKnowledgeUsage返回参数结构体
*/
export interface DescribeKnowledgeUsageResponse {
/**
* 可用字符数上限
*/
AvailableCharSize?: string;
/**
* 超过可用字符数上限的字符数
*/
ExceedCharSize?: string;
/**
* 知识库使用字符总数
*/
UsedCharSize?: string;
/**
* 唯一请求 ID，由服务端生成，每次请求都会返回（若请求因其他原因未能抵达服务端，则该次请求不会获得 RequestId）。定位问题时需要提供该次请求的 RequestId。
*/
RequestId?: string;
}
/**
* DeleteSharedKnowledge返回参数结构体
*/
export interface DeleteSharedKnowledgeResponse {
/**
* 共享知识库业务ID
*/
KnowledgeBizId?: string;
/**
* 唯一请求 ID，由服务端生成，每次请求都会返回（若请求因其他原因未能抵达服务端，则该次请求不会获得 RequestId）。定位问题时需要提供该次请求的 RequestId。
*/
RequestId?: string;
}
/**
* ListUnsatisfiedReply请求参数结构体
*/
export interface ListUnsatisfiedReplyRequest {
/**
* 应用ID，获取方法参看如何获取[BotBizId](https://cloud.tencent.com/document/product/1759/109469#4eecb8c1-6ce4-45f5-8fa2-b269449d8efa)
*/
BotBizId: string;
/**
* 页码，取值范围：大于0
*/
PageNumber: number;
/**
* 分页数量，取值范围：大于0
*/
PageSize: number;
/**
* 登录用户主账号(集成商模式必填)
*/
LoginUin?: string;
/**
* 登录用户子账号(集成商模式必填)
*/
LoginSubAccountUin?: string;
/**
* 用户请求(问题或答案)，按关键词检索，可匹配用户问题或答案
*/
Query?: string;
/**
* 按错误类型检索
*/
Reasons?: Array<string>;
/**
* 按操作状态检索 0-全部 1-待处理 2-已处理【包括答案纠错，拒答，忽略】，不填时默认值为0
*/
Status?: number;
/**
* 处理状态 0-待处理 1-已拒答 2-已忽略 3-已添加为新问答 4-已添加为相似问
*/
HandlingStatuses?: Array<number | bigint>;
}
/**
* DeleteQA请求参数结构体
*/
export interface DeleteQARequest {
/**
* 应用ID
*/
BotBizId: string;
/**
* 问答ID
*/
QaBizIds: Array<string>;
}
/**
* CreateDocCate请求参数结构体
*/
export interface CreateDocCateRequest {
/**
* 应用ID
*/
BotBizId: string;
/**
* 父级业务ID
*/
ParentBizId: string;
/**
* 分类名称
*/
Name: string;
}
/**
* ListRejectedQuestionPreview返回参数结构体
*/
export interface ListRejectedQuestionPreviewResponse {
/**
* 文档数量
*/
Total?: string;
/**
* 文档列表
*/
List?: Array<ReleaseRejectedQuestion>;
/**
* 唯一请求 ID，由服务端生成，每次请求都会返回（若请求因其他原因未能抵达服务端，则该次请求不会获得 RequestId）。定位问题时需要提供该次请求的 RequestId。
*/
RequestId?: string;
}
/**
* ES存储配置
*/
export interface ESConfig {
/**
* <p>存储类型，0: 未知类型， 1:默认存储(平台提供)，2: 自定义存储(用户自建ES)</p>
*/
StorageType?: number;
/**
* <p>ES集群名称(自定义存储时必填)</p>
*/
InstanceName?: string;
/**
* <p>ES集群ID(自定义存储时必填)</p>
*/
InstanceId?: string;
/**
* <p>ES用户名(自定义存储时必填)</p>
*/
Username?: string;
/**
* <p>ES密码(自定义存储时必填)</p>
*/
Password?: string;
/**
* <p>允许修改存储方式</p>
*/
CanModify?: boolean;
}
/**
* DeleteAttributeLabel请求参数结构体
*/
export interface DeleteAttributeLabelRequest {
/**
* 应用ID，获取方法参看如何获取[BotBizId](https://cloud.tencent.com/document/product/1759/109469#4eecb8c1-6ce4-45f5-8fa2-b269449d8efa)
*/
BotBizId: string;
/**
* 标签ID
*/
AttributeBizIds: Array<string>;
/**
* 登录用户主账号(集成商模式必填)
*/
LoginUin?: string;
/**
* 登录用户子账号(集成商模式必填)
*/
LoginSubAccountUin?: string;
}
/**
* DescribeRobotBizIDByAppKey返回参数结构体
*/
export interface DescribeRobotBizIDByAppKeyResponse {
/**
* 应用业务ID
*/
BotBizId?: string;
/**
* 唯一请求 ID，由服务端生成，每次请求都会返回（若请求因其他原因未能抵达服务端，则该次请求不会获得 RequestId）。定位问题时需要提供该次请求的 RequestId。
*/
RequestId?: string;
}
/**
* ListDocCate请求参数结构体
*/
export interface ListDocCateRequest {
/**
* 应用ID
*/
BotBizId: string;
/**
* 分类查询类型：0-全量查询整棵标签树，1-根据父节点BizId分页查询子节点，2-关键词检索所有匹配的分类链路
*/
QueryType?: number;
/**
* QueryType=1时，父节点分类ID
*/
ParentCateBizId?: string;
/**
* QueryType=1时，页码（从1开始）
*/
PageNumber?: number;
/**
* 每页数量（默认10）
*/
PageSize?: number;
/**
* QueryType=2时，搜索内容
*/
Query?: string;
}
/**
* DescribeDoc返回参数结构体
*/
export 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?: Array<AttrLabel>;
/**
* 分类ID
*/
CateBizId?: string;
/**
* 文档是否停用，false:未停用，true:已停用
*/
IsDisabled?: boolean;
/**
* 是否支持下载
注意：此字段可能返回 null，表示取不到有效值。
*/
IsDownload?: boolean;
/**
* 自定义切分规则
注意：此字段可能返回 null，表示取不到有效值。
*/
SplitRule?: string;
/**
* 文档更新频率
注意：此字段可能返回 null，表示取不到有效值。
*/
UpdatePeriodInfo?: UpdatePeriodInfo;
/**
* 从根节点开始的路径分类ID
注意：此字段可能返回 null，表示取不到有效值。
*/
CateBizIdPath?: Array<string>;
/**
* 从根节点开始的路径分类名称
注意：此字段可能返回 null，表示取不到有效值。
*/
CateNamePath?: Array<string>;
/**
* 文档生效域: 1-不生效；2-仅开发域生效；3-仅发布域生效；4-开发域和发布域均生效
*/
EnableScope?: number;
/**
* 唯一请求 ID，由服务端生成，每次请求都会返回（若请求因其他原因未能抵达服务端，则该次请求不会获得 RequestId）。定位问题时需要提供该次请求的 RequestId。
*/
RequestId?: string;
}
/**
* 标签ID
*/
export interface Label {
/**
* 标签ID
注意：此字段可能返回 null，表示取不到有效值。
*/
LabelBizId?: string;
/**
* 标签名称
注意：此字段可能返回 null，表示取不到有效值。
*/
LabelName?: string;
}
/**
* 字符串KV信息
*/
export interface StrValue {
/**
* 名称
注意：此字段可能返回 null，表示取不到有效值。
*/
Name?: string;
/**
* 值
注意：此字段可能返回 null，表示取不到有效值。
*/
Value?: string;
}
/**
* ListQACate返回参数结构体
*/
export interface ListQACateResponse {
/**
* 列表
*/
List?: Array<QACate>;
/**
* 唯一请求 ID，由服务端生成，每次请求都会返回（若请求因其他原因未能抵达服务端，则该次请求不会获得 RequestId）。定位问题时需要提供该次请求的 RequestId。
*/
RequestId?: string;
}
/**
* CreateSharedKnowledge返回参数结构体
*/
export interface CreateSharedKnowledgeResponse {
/**
* <p>共享知识库业务ID</p>
*/
KnowledgeBizId?: string;
/**
* 唯一请求 ID，由服务端生成，每次请求都会返回（若请求因其他原因未能抵达服务端，则该次请求不会获得 RequestId）。定位问题时需要提供该次请求的 RequestId。
*/
RequestId?: string;
}
/**
* 问答列表
*/
export interface QAList {
/**
* 问答ID
*/
QaBizId: string;
/**
* 是否采纳
*/
IsAccepted?: boolean;
/**
* 分类ID
*/
CateBizId?: string;
/**
* 问题
*/
Question?: string;
/**
* 答案
*/
Answer?: string;
}
/**
* 标签值
*/
export interface AttributeLabel {
/**
* 标准词ID
注意：此字段可能返回 null，表示取不到有效值。
*/
LabelBizId?: string;
/**
* 标准词名称
注意：此字段可能返回 null，表示取不到有效值。
*/
LabelName?: string;
/**
* 同义词名称
注意：此字段可能返回 null，表示取不到有效值。
*/
SimilarLabels?: Array<string>;
}
/**
* Agent的工具信息
*/
export interface AgentToolInfo {
/**
* <p>插件id</p>
*/
PluginId?: string;
/**
* <p>插件名称</p>
*/
PluginName?: string;
/**
* <p>插件图标url</p>
*/
IconUrl?: string;
/**
* <p>0 自定义插件<br>1 官方插件<br>2 第三方插件 目前用于第三方实现的mcp server</p>
*/
PluginType?: number;
/**
* <p>工具id</p>
*/
ToolId?: string;
/**
* <p>工具名称</p>
*/
ToolName?: string;
/**
* <p>工具描述</p>
*/
ToolDesc?: string;
/**
* <p>输入参数</p>
*/
Inputs?: Array<AgentToolReqParam>;
/**
* <p>输出参数</p>
*/
Outputs?: Array<AgentToolRspParam>;
/**
* <p>创建方式，0:服务创建，1:代码创建，2:MCP创建</p>
*/
CreateType?: number;
/**
* <p>MCP插件的配置信息</p>
*/
McpServer?: AgentMCPServerInfo;
/**
* <p>该工具是否和知识库绑定</p>
*/
IsBindingKnowledge?: boolean;
/**
* <p>插件状态，1:可用，2:不可用</p>
*/
Status?: number;
/**
* <p>header信息</p>
*/
Headers?: Array<AgentPluginHeader>;
/**
* <p>NON_STREAMING: 非流式 STREAMIN: 流式</p>
注意：此字段可能返回 null，表示取不到有效值。
*/
CallingMethod?: string;
/**
* <p>query信息</p>
*/
Query?: Array<AgentPluginQuery>;
/**
* <p>工具计费状态 0-不计费 1-可用 2-不可用（欠费、无资源等）</p>
*/
FinanceStatus?: number;
/**
* <p>工具来源: 0-来自插件，1-来自工作流</p>
*/
ToolSource?: number;
/**
* <p>计费状态；0-不计费，1-限时免费，2-官方收费</p>
*/
FinanceType?: number;
/**
* <p>工具高级设置</p>
*/
ToolAdvanceConfig?: ToolAdvanceConfig;
/**
* <p>授权模式； 0-开发者授权；1-使用者授权</p>
*/
AuthMode?: number;
/**
* <p>授权类型; 0-无鉴权；1-APIKey；2-CAM授权；3-Oauth2.0授权；</p>
*/
AuthType?: number;
/**
* <p>工具授权配置状态；0：不需要授权，1：需要授权-未配置，2：需要授权-已配置</p>
*/
AuthConfigStatus?: number;
/**
* <p>连接器工具 API 类型</p><p>枚举值：</p><ul><li>1： 只读</li><li>2： 写/删除</li></ul>
*/
ToolAccessMode?: number;
/**
* <p>是否禁用该工具</p>
*/
IsDisabled?: boolean;
}
/**
* RenameDoc请求参数结构体
*/
export interface RenameDocRequest {
/**
* 登录用户主账号(集成商模式必填)
*/
LoginUin?: string;
/**
* 登录用户子账号(集成商模式必填)
*/
LoginSubAccountUin?: string;
/**
* 应用ID，获取方法参看[如何获取 BotBizId](https://cloud.tencent.com/document/product/1759/109469#4eecb8c1-6ce4-45f5-8fa2-b269449d8efa)。
重命名知识库文档时，该参数填入知识库ID。
*/
BotBizId?: string;
/**
* 文档ID
*/
DocBizId?: string;
/**
* 新文档名，需要带上后缀
*/
NewName?: string;
}
/**
* StopWorkflowRun返回参数结构体
*/
export interface StopWorkflowRunResponse {
/**
* 唯一请求 ID，由服务端生成，每次请求都会返回（若请求因其他原因未能抵达服务端，则该次请求不会获得 RequestId）。定位问题时需要提供该次请求的 RequestId。
*/
RequestId?: string;
}
/**
* 任务流程信息
*/
export interface TaskFlowInfo {
/**
* 任务流程ID
注意：此字段可能返回 null，表示取不到有效值。
*/
TaskFlowId?: string;
/**
* 任务流程名称
注意：此字段可能返回 null，表示取不到有效值。
*/
TaskFlowName?: string;
/**
* Query 重写结果
注意：此字段可能返回 null，表示取不到有效值。
*/
QueryRewrite?: string;
/**
* 命中意图
注意：此字段可能返回 null，表示取不到有效值。
*/
HitIntent?: string;
/**
* 任务流程回复类型
0: 任务流回复
1: 任务流静默
2: 任务流拉回话术
3: 任务流自定义回复
注意：此字段可能返回 null，表示取不到有效值。
*/
Type?: number;
}
/**
* GenerateQA返回参数结构体
*/
export interface GenerateQAResponse {
/**
* 唯一请求 ID，由服务端生成，每次请求都会返回（若请求因其他原因未能抵达服务端，则该次请求不会获得 RequestId）。定位问题时需要提供该次请求的 RequestId。
*/
RequestId?: string;
}
/**
* 系统参数
*/
export interface AgentInputSystemVariable {
/**
* 系统参数名
*/
Name?: string;
/**
* 对话历史轮数的配置；如果Input是系统变量中的“对话历史”时才使用；
*/
DialogHistoryLimit?: number;
}
/**
* 澄清询问配置
*/
export interface ClarificationConfig {
/**
* 输出类型，1-文本 3-widget
*/
OutputType?: number;
/**
* 澄清widget配置
*/
WidgetConfigs?: Array<ClarificationWidgetConfig>;
}
/**
* SaveDoc请求参数结构体
*/
export interface SaveDocRequest {
/**
* <p>应用ID。应用ID 获取方法参看<a href="https://cloud.tencent.com/document/product/1759/109469#4eecb8c1-6ce4-45f5-8fa2-b269449d8efa">如何获取 BotBizId</a><br>导入知识库文档时，该参数填入知识库 ID。</p>
*/
BotBizId: string;
/**
* <p>文件名，需要包含文件扩展名</p>
*/
FileName: string;
/**
* <p>文档支持下面类型<br>pdf、doc、docx、ppt、mhtml、pptx、wps、ppsx，单个文件不超过200MB；<br>xlsx、xls、md、txt、csv、html，单个文件不超过20MB；</p><p>图片支持下面类型：<br>jpg、png、jpeg、tiff、bmp、gif，单个文件不超过50MB</p>
*/
FileType: string;
/**
* <p>平台cos路径，与DescribeStorageCredential接口查询UploadPath参数保持一致</p>
*/
CosUrl: string;
/**
* <p>ETag 全称为 Entity Tag，是对象被创建时标识对象内容的信息标签，可用于检查对象的内容是否发生变化 成功上传cos后，从返回头中获取</p>
*/
ETag: string;
/**
* <p>cos_hash x-cos-hash-crc64ecma 头部中的 CRC64编码进行校验上传到云端的文件和本地文件的一致性<br>成功上传cos后，从返回头中获取</p><p>请注意：<br>cos_hash为文档唯一性标识，与文件名无关 相同的cos_hash会被判定为重复文档</p>
*/
CosHash: string;
/**
* <p>文件大小</p>
*/
Size: string;
/**
* <p>标签适用范围，1:全部，2:按条件。默认为1。</p>
*/
AttrRange?: number;
/**
* <p>来源（0 从本地文档导入），默认值为0</p>
*/
Source?: number;
/**
* <p>自定义链接地址, IsRefer为true的时候，该值才有意义</p>
*/
WebUrl?: string;
/**
* <p>标签引用</p>
*/
AttrLabels?: Array<AttrLabelRefer>;
/**
* <p>外部引用链接类型 0：系统链接 1：自定义链接<br>值为1时，WebUrl 字段不能为空，否则不生效。</p>
*/
ReferUrlType?: number;
/**
* <p>有效开始时间，unix秒级时间戳，默认为0</p>
*/
ExpireStart?: string;
/**
* <p>有效结束时间，unix秒级时间戳，默认为0代表永久有效</p>
*/
ExpireEnd?: string;
/**
* <p>是否显示引用的文档来源(false不显示 true显示）默认false</p>
*/
IsRefer?: boolean;
/**
* <p>文档操作类型：1：批量导入（批量导入问答对）；2:文档导入（正常导入单个文档） 默认为2 <br> 请注意，opt=1的时候请从腾讯云智能体开发平台页面下载excel模板</p>
*/
Opt?: number;
/**
* <p>分类ID</p>
*/
CateBizId?: string;
/**
* <p>是否可下载，IsRefer为true并且ReferUrlType为0时，该值才有意义</p>
*/
IsDownload?: boolean;
/**
* <p>重复文档处理方式，按顺序匹配第一个满足条件的方式处理</p>
*/
DuplicateFileHandles?: Array<DuplicateFileHandle>;
/**
* <p>自定义切分规则</p><p>请求参数为一个 <strong>JSON Object</strong>，具体格式可参见接口示例值。包含以下主要字段：</p><table><thead><tr><th>字段名</th><th>类型</th><th>说明</th></tr></thead><tbody><tr><td><code>xlsx_splitter</code></td><td>Object</td><td><strong>Excel（xlsx）文件切分策略配置</strong>，仅当处理 Excel 文件时有效</td></tr><tr><td><code>common_splitter</code></td><td>Object</td><td><strong>通用文件（如 txt、pdf 等）切分策略配置</strong>，按页或按标签切分</td></tr><tr><td><code>table_style</code></td><td>String</td><td>表格内容的输出格式，如 HTML 或 Markdown</td></tr></tbody></table><hr><h2 id=".3Cdx-inline-code-holder.3E.3C.2Fdx-inline-code-holder.3E.EF.BC.88Excel-.E5.88.87.E5.88.86.E7.AD.96.E7.95.A5.EF.BC.89"><code>xlsx_splitter</code>（Excel 切分策略）</h2><p>用于配置 <strong>表格文件的切分方式</strong>。<br><strong>类型：Object</strong></p><p><pre><code class="language-json"><span class="hljs-attr">"xlsx_splitter"</span><span class="hljs-punctuation">:</span> <span class="hljs-punctuation">{</span> <span class="hljs-attr">"header_interval"</span><span class="hljs-punctuation">:</span> <span class="hljs-punctuation">[</span><span class="hljs-number">1</span><span class="hljs-punctuation">,</span> <span class="hljs-number">2</span><span class="hljs-punctuation">]</span><span class="hljs-punctuation">,</span> <span class="hljs-attr">"content_start"</span><span class="hljs-punctuation">:</span> <span class="hljs-number">10</span><span class="hljs-punctuation">,</span> <span class="hljs-attr">"split_row"</span><span class="hljs-punctuation">:</span> <span class="hljs-number">2</span><span class="hljs-punctuation">}</span></code></pre></p><h3 id=".E5.AD.97.E6.AE.B5.E8.AF.B4.E6.98.8E.EF.BC.9A">字段说明：</h3><table><thead><tr><th>字段名</th><th>类型</th><th>说明</th></tr></thead><tbody><tr><td><code>header_interval</code></td><td>Array<Number></td><td>表头所在的行区间，格式为 <code>[起始行, 结束行]</code>，<strong>行号从 1 开始计数</strong>。例如 <code>[1, 2]</code> 表示第 1~2 行为表头。</td></tr><tr><td><code>content_start</code></td><td>Number</td><td><strong>表格内容的起始行号（从 1 开始）</strong>。</td></tr><tr><td><code>split_row</code></td><td>Number</td><td><strong>切分行数</strong>。</td></tr></tbody></table><hr><h2 id=".3Cdx-inline-code-holder.3E.3C.2Fdx-inline-code-holder.3E.EF.BC.88.E9.80.9A.E7.94.A8.E6.96.87.E4.BB.B6.E5.88.87.E5.88.86.E7.AD.96.E7.95.A5.EF.BC.89"><code>common_splitter</code>（通用文件切分策略）</h2><p>用于配置 <strong>非 Excel 文件（如 TXT、PDF、DOCX 等）的切分方式</strong>，支持两种策略：<strong>按页切分（page）</strong> 或 <strong>按标识符切分（tag）</strong>。</p><p><strong>类型：Object</strong></p><p><pre><code class="language-json"><span class="hljs-attr">"common_splitter"</span><span class="hljs-punctuation">:</span> <span class="hljs-punctuation">{</span> <span class="hljs-attr">"splitter"</span><span class="hljs-punctuation">:</span> <span class="hljs-string">"page"</span><span class="hljs-punctuation">,</span> <span class="hljs-attr">"page_splitter"</span><span class="hljs-punctuation">:</span> <span class="hljs-punctuation">{</span> <span class="hljs-attr">"chunk_length"</span><span class="hljs-punctuation">:</span> <span class="hljs-number">1000</span><span class="hljs-punctuation">,</span> <span class="hljs-attr">"chunk_overlap_length"</span><span class="hljs-punctuation">:</span> <span class="hljs-number">100</span> <span class="hljs-punctuation">}</span><span class="hljs-punctuation">}</span></code></pre></p><h3 id=".E5.AD.97.E6.AE.B5.E8.AF.B4.E6.98.8E.EF.BC.9A2">字段说明：</h3><table><thead><tr><th>字段名</th><th>类型</th><th>说明</th></tr></thead><tbody><tr><td><code>splitter</code></td><td>String</td><td>切分策略类型，可选值为：<code>"page"</code>（按页切分） 或 <code>"tag"</code>（按标识符切分）。</td></tr><tr><td><code>page_splitter</code></td><td>Object</td><td><strong>按页切分的配置</strong>。</td></tr><tr><td><code>page_splitter.chunk_length</code></td><td>1000</td><td><strong>切片最大长度</strong>。</td></tr><tr><td><code>page_splitter.chunk_overlap_length</code></td><td>100</td><td><strong>切片重叠长度</strong>。</td></tr><tr><td><code>tag_splitter</code></td><td>Object</td><td><strong>自定义切分配置</strong>。</td></tr><tr><td><code>tag_splitter.tag</code></td><td>Array<String></td><td><strong>切分标识符</strong>。</td></tr><tr><td><code>tag_splitter.chunk_length</code></td><td>Number</td><td><strong>切片最大长度</strong>。</td></tr><tr><td><code>tag_splitter.chunk_overlap_length</code></td><td>Number</td><td><strong>切块重叠长度</strong>。</td></tr></tbody></table><p>???? <strong>补充说明：</strong></p><ul><li><code>splitter</code> 字段的值可以是：<ul><li><code>"page"</code>：只使用按页切分逻辑，此时只需要关心 <code>page_splitter</code> 相关字段。</li><li><code>"tag"</code>：只使用按标识符（如分号、换行等）切分逻辑，此时关注 <code>tag_splitter</code>。</li></ul></li></ul><hr><h2 id=".3Cdx-inline-code-holder.3E.3C.2Fdx-inline-code-holder.3E.EF.BC.88.E8.A1.A8.E6.A0.BC.E8.BE.93.E5.87.BA.E6.A0.B7.E5.BC.8F.EF.BC.89"><code>table_style</code>（表格输出样式）</h2><p>用于指定 <strong>表格类内容（比如从 Excel 或 CSV 中提取的表格）最终以何种格式返回</strong>，方便前端展示或后续处理。</p><p><strong>类型：String</strong></p><p><pre><code class="language-json"><span class="hljs-attr">"table_style"</span><span class="hljs-punctuation">:</span> <span class="hljs-string">"md"</span></code></pre></p><h3 id=".E5.AD.97.E6.AE.B5.E8.AF.B4.E6.98.8E.EF.BC.9A3">字段说明：</h3><table><thead><tr><th>字段名</th><th>类型</th><th>说明</th></tr></thead><tbody><tr><td><code>table_style</code></td><td>String</td><td>指定表格内容的输出格式。可用值：<br>• <code>"html"</code>：以 HTML 表格形式返回，适合网页展示。<br>• <code>"md"</code>：以 Markdown 表格语法返回，适合文档或 Markdown 渲染环境。</td></tr></tbody></table>
*/
SplitRule?: string;
/**
* <p>文档更新频率，默认值为0不更新</p>
*/
UpdatePeriodInfo?: UpdatePeriodInfo;
/**
* <p>文档生效域: 1-不生效；2-仅开发域生效；3-仅发布域生效；4-开发域和发布域均生效<br>默认值：应用内默认知识库为2，共享知识库为4。</p>
*/
EnableScope?: number;
/**
* <p>文件url 文件的 FileUrl、CosUrl必须提供一个，如果都提供，只使用CosUrl</p>
*/
FileUrl?: string;
}
/**
* ListSharedKnowledge返回参数结构体
*/
export interface ListSharedKnowledgeResponse {
/**
* 累计数量
*/
Total?: number;
/**
* 知识库列表
注意：此字段可能返回 null，表示取不到有效值。
*/
KnowledgeList?: Array<KnowledgeDetailInfo>;
/**
* 唯一请求 ID，由服务端生成，每次请求都会返回（若请求因其他原因未能抵达服务端，则该次请求不会获得 RequestId）。定位问题时需要提供该次请求的 RequestId。
*/
RequestId?: string;
}
/**
* DescribeAttributeLabel返回参数结构体
*/
export interface DescribeAttributeLabelResponse {
/**
* 属性ID
*/
AttributeBizId?: string;
/**
* 属性标识
*/
AttrKey?: string;
/**
* 属性名称
*/
AttrName?: string;
/**
* 标签数量
*/
LabelNumber?: string;
/**
* 标签名称
*/
Labels?: Array<AttributeLabel>;
/**
* 唯一请求 ID，由服务端生成，每次请求都会返回（若请求因其他原因未能抵达服务端，则该次请求不会获得 RequestId）。定位问题时需要提供该次请求的 RequestId。
*/
RequestId?: string;
}
/**
* ModifyAttributeLabel返回参数结构体
*/
export interface ModifyAttributeLabelResponse {
/**
* 任务ID
*/
TaskId?: string;
/**
* 标签ID与名称
*/
Labels?: Array<AttributeLabel>;
/**
* 唯一请求 ID，由服务端生成，每次请求都会返回（若请求因其他原因未能抵达服务端，则该次请求不会获得 RequestId）。定位问题时需要提供该次请求的 RequestId。
*/
RequestId?: string;
}
/**
* 问答知识库单工作流模式下指定单工作流配置
*/
export interface KnowledgeQaSingleWorkflow {
/**
* 工作流ID
*/
WorkflowId?: string;
/**
* 工作流名称
*/
WorkflowName?: string;
/**
* 工作流描述
*/
WorkflowDesc?: string;
/**
* 工作流状态，发布状态(UNPUBLISHED: 待发布 PUBLISHING: 发布中 PUBLISHED: 已发布 FAIL:发布失败)
*/
Status?: string;
/**
* 工作流是否启用
*/
IsEnable?: boolean;
/**
* 是否开启异步调用工作流
*/
AsyncWorkflow?: boolean;
}
/**
* CallbackWorkflowToolNode请求参数结构体
*/
export interface CallbackWorkflowToolNodeRequest {
/**
* ADP调用外部API时,通过HTTP Header(X-ADP-Callback-Token)传递回调CallbackToken
*/
CallbackToken: string;
/**
* 回调结果,可选,为JSON字符串
*/
Result: string;
/**
* 登录用户主账号(集成商模式必填)
*/
LoginUin?: string;
/**
* 登录用户子账号(集成商模式必填)
*/
LoginSubAccountUin?: string;
/**
* 应用ID
*/
AppBizId?: string;
}
/**
* RetryDocParse返回参数结构体
*/
export interface RetryDocParseResponse {
/**
* 唯一请求 ID，由服务端生成，每次请求都会返回（若请求因其他原因未能抵达服务端，则该次请求不会获得 RequestId）。定位问题时需要提供该次请求的 RequestId。
*/
RequestId?: string;
}
/**
* DeleteAgent返回参数结构体
*/
export interface DeleteAgentResponse {
/**
* Agent的ID
*/
AgentId?: string;
/**
* 唯一请求 ID，由服务端生成，每次请求都会返回（若请求因其他原因未能抵达服务端，则该次请求不会获得 RequestId）。定位问题时需要提供该次请求的 RequestId。
*/
RequestId?: string;
}
/**
* GroupQA返回参数结构体
*/
export interface GroupQAResponse {
/**
* 唯一请求 ID，由服务端生成，每次请求都会返回（若请求因其他原因未能抵达服务端，则该次请求不会获得 RequestId）。定位问题时需要提供该次请求的 RequestId。
*/
RequestId?: string;
}
/**
* RetryRelease请求参数结构体
*/
export interface RetryReleaseRequest {
/**
* 应用ID（获取方法参看如何获取 [BotBizId](https://cloud.tencent.com/document/product/1759/109469#4eecb8c1-6ce4-45f5-8fa2-b269449d8efa)）
*/
BotBizId: string;
/**
* 发布单ID（可以通过[ListRelease](https://cloud.tencent.com/document/product/1759/105077)获得）
*/
ReleaseBizId: string;
}
/**
* 应用配置
*/
export interface AppConfig {
/**
* 知识问答管理应用配置
注意：此字段可能返回 null，表示取不到有效值。
*/
KnowledgeQa?: KnowledgeQaConfig;
/**
* 知识摘要应用配置
注意：此字段可能返回 null，表示取不到有效值。
*/
Summary?: SummaryConfig;
/**
* 标签提取应用配置
注意：此字段可能返回 null，表示取不到有效值。
*/
Classify?: ClassifyConfig;
}
/**
* 会话内容参考文献信息
*/
export interface ContentReference {
/**
* 引用来源索引ID
注意：此字段可能返回 null，表示取不到有效值。
*/
Index?: number;
/**
* 参考来源名称
*/
Name?: string;
/**
* 参考来源类型
1：问答
2：文档片段
4：联网检索到的内容
*/
Type?: number;
/**
* 文档片段参考信息
注意：此字段可能返回 null，表示取不到有效值。
*/
DocRefer?: DocReference;
/**
* 问答参考信息
注意：此字段可能返回 null，表示取不到有效值。
*/
QaRefer?: QaReference;
/**
* 联网检索内容参考信息
注意：此字段可能返回 null，表示取不到有效值。
*/
WebSearchRefer?: WebSearchReference;
}
/**
* Agent工具的请求参数定义
*/
export 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?: Array<AgentToolReqParam>;
/**
* 是否隐藏不可见
*/
GlobalHidden?: boolean;
/**
* agent模式下模型是否可见
*/
AgentHidden?: boolean;
/**
* 其中任意
*/
AnyOf?: Array<AgentToolReqParam>;
/**
* 其中一个
*/
OneOf?: Array<AgentToolReqParam>;
/**
* 输入
*/
Input?: AgentInput;
}
/**
* 问答对参考信息
*/
export interface QaReference {
/**
* 问答业务ID
*/
QaBizId?: number;
/**
* 文档片段参考ID
注意：此字段可能返回 null，表示取不到有效值。
*/
ReferBizId?: number;
/**
* 问答所在知识库业务ID
注意：此字段可能返回 null，表示取不到有效值。
*/
KnowledgeBizId?: number;
/**
* 问答所在知识库名称
注意：此字段可能返回 null，表示取不到有效值。
*/
KnowledgeName?: string;
}
/**
* 标签详情
*/
export interface AttrLabelDetail {
/**
* 标签ID
注意：此字段可能返回 null，表示取不到有效值。
*/
AttrBizId?: string;
/**
* 标签标识
注意：此字段可能返回 null，表示取不到有效值。
* @deprecated
*/
AttrKey?: string;
/**
* 标签名称
注意：此字段可能返回 null，表示取不到有效值。
*/
AttrName?: string;
/**
* 标签值名称
注意：此字段可能返回 null，表示取不到有效值。
*/
LabelNames?: Array<string>;
/**
* 标签是否在更新中
注意：此字段可能返回 null，表示取不到有效值。
*/
IsUpdating?: boolean;
/**
* 发布状态(1 待发布 2 发布中 3 已发布 4 发布失败)
注意：此字段可能返回 null，表示取不到有效值。
*/
Status?: number;
/**
* 状态描述
注意：此字段可能返回 null，表示取不到有效值。
*/
StatusDesc?: string;
/**
* 标签值总数
*/
LabelTotalCount?: string;
}
/**
* QA查询参数
*/
export interface QAQuery {
/**
* <p>页码 从1开始</p>
*/
PageNumber: number;
/**
* <p>页大小 默认15 最大100</p>
*/
PageSize: number;
/**
* <p>应用ID</p>
*/
BotBizId: string;
/**
* <p>查询内容</p>
*/
Query?: string;
/**
* <p>分类ID</p>
*/
CateBizId?: string;
/**
* <p>校验状态的枚举值</p>
*/
AcceptStatus?: Array<number | bigint>;
/**
* <p>发布状态的枚举值</p>
*/
ReleaseStatus?: Array<number | bigint>;
/**
* <p>文档ID</p>
*/
DocBizId?: string;
/**
* <p>QAID</p>
*/
QaBizId?: string;
/**
* <p>来源</p>
*/
Source?: number;
/**
* <p>查询答案</p>
*/
QueryAnswer?: string;
/**
* <p>查询类型 filename 名称、 attribute 标签</p>
*/
QueryType?: string;
/**
* <p>问答生效域检索，不检索不传。枚举值如下：<br>1-不生效；2-仅开发域生效；3-仅发布域生效；4-开发域和发布域均生效。</p>
*/
EnableScope?: number;
/**
* <p>创建时间范围</p>
*/
CreateTime?: TimeRange;
/**
* <p>更新时间范围</p>
*/
UpdateTime?: TimeRange;
}
/**
* DescribeKnowledgeUsage请求参数结构体
*/
export type DescribeKnowledgeUsageRequest = null;
/**
* DeleteSharedKnowledge请求参数结构体
*/
export interface DeleteSharedKnowledgeRequest {
/**
* 共享知识库业务ID
*/
KnowledgeBizId: string;
}
/**
* 任务参数
*/
export interface TaskParams {
/**
* 下载地址,需要通过cos桶临时密钥去下载
注意：此字段可能返回 null，表示取不到有效值。
*/
CosPath?: string;
}
/**
* 文档列表详情描述
*/
export interface ListDocItem {
/**
* 文档ID
注意：此字段可能返回 null，表示取不到有效值。
*/
DocBizId?: string;
/**
* 文件名称
注意：此字段可能返回 null，表示取不到有效值。
*/
FileName?: string;
/**
* 重命名的新文档名称，在重命名提交之后，文档发布之前都是这个名称
*/
NewName?: string;
/**
* 文件类型
注意：此字段可能返回 null，表示取不到有效值。
*/
FileType?: string;
/**
* cos路径
注意：此字段可能返回 null，表示取不到有效值。
*/
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;
/**
* qa是否已删除
注意：此字段可能返回 null，表示取不到有效值。
*/
IsDeletedQa?: boolean;
/**
* 问答是否生成中
注意：此字段可能返回 null，表示取不到有效值。
*/
IsCreatingQa?: boolean;
/**
* 是否允许删除
注意：此字段可能返回 null，表示取不到有效值。
*/
IsAllowDelete?: boolean;
/**
* 是否允许操作引用开关
注意：此字段可能返回 null，表示取不到有效值。
*/
IsAllowRefer?: boolean;
/**
* 问答是否生成过
注意：此字段可能返回 null，表示取不到有效值。
*/
IsCreatedQa?: boolean;
/**
* 文档字符量
注意：此字段可能返回 null，表示取不到有效值。
*/
DocCharSize?: string;
/**
* 属性标签适用范围
注意：此字段可能返回 null，表示取不到有效值。
*/
AttrRange?: number;
/**
* 属性标签
注意：此字段可能返回 null，表示取不到有效值。
*/
AttrLabels?: Array<AttrLabel>;
/**
* 是否允许编辑
注意：此字段可能返回 null，表示取不到有效值。
*/
IsAllowEdit?: boolean;
/**
* 外部引用链接类型 0：系统链接 1：自定义链接
值为1时，WebUrl 字段不能为空，否则不生效。
注意：此字段可能返回 null，表示取不到有效值。
*/
ReferUrlType?: number;
/**
* 网页(或自定义链接)地址
注意：此字段可能返回 null，表示取不到有效值。
*/
WebUrl?: string;
/**
* 有效开始时间，unix时间戳
注意：此字段可能返回 null，表示取不到有效值。
*/
ExpireStart?: string;
/**
* 有效结束时间，unix时间戳，0代表永久有效
注意：此字段可能返回 null，表示取不到有效值。
*/
ExpireEnd?: string;
/**
* 是否允许重试，0：否，1：是
注意：此字段可能返回 null，表示取不到有效值。
*/
IsAllowRetry?: boolean;
/**
* 0:文档比对处理 1:文档生成问答
注意：此字段可能返回 null，表示取不到有效值。
*/
Processing?: Array<number | bigint>;
/**
* 文档创建落库时间
注意：此字段可能返回 null，表示取不到有效值。
*/
CreateTime?: string;
/**
* 文档所属分类ID
*/
CateBizId?: string;
/**
* 文档的用户自定义ID
*/
CustomerKnowledgeId?: string;
/**
* 文档的属性标记，0: 不做用户外部权限校验
*/
AttributeFlags?: Array<number | bigint>;
/**
* false:未停用，ture:已停用
*/
IsDisabled?: boolean;
/**
* 员工名称
*/
StaffName?: string;
/**
* 文档生效域: 1-不生效；2-仅开发域生效；3-仅发布域生效；4-开发域和发布域均生效
注意：此字段可能返回 null，表示取不到有效值。
*/
EnableScope?: number;
/**
* 文档大小，单位：字节
*/
DocSize?: string;
}
/**
* 计费统计信息
*/
export interface Stat {
/**
* X轴: 时间区域；根据查询条件的粒度返回“分/小时/日”三种区间范围
注意：此字段可能返回 null，表示取不到有效值。
*/
X?: string;
/**
* Y轴: 该时间区域内的统计值，如token消耗量，调用次数或使用量等信息
注意：此字段可能返回 null，表示取不到有效值。
*/
Y?: number;
}
/**
* 大模型token统计信息
*/
export interface StatisticInfo {
/**
* <p>模型名称</p>
注意：此字段可能返回 null，表示取不到有效值。
*/
ModelName?: string;
/**
* <p>首Token耗时</p><p>单位：ms</p>
注意：此字段可能返回 null，表示取不到有效值。
*/
FirstTokenCost?: number;
/**
* <p>总耗时</p><p>单位：ms</p>
注意：此字段可能返回 null，表示取不到有效值。
*/
TotalCost?: number;
/**
* <p>输入Token数量</p>
注意：此字段可能返回 null，表示取不到有效值。
*/
InputTokens?: number;
/**
* <p>输出Token数量</p>
注意：此字段可能返回 null，表示取不到有效值。
*/
OutputTokens?: number;
/**
* <p>总Token数量</p>
注意：此字段可能返回 null，表示取不到有效值。
*/
TotalTokens?: number;
}
/**
* CreateAttributeLabel请求参数结构体
*/
export interface CreateAttributeLabelRequest {
/**
* 应用ID，获取方法参看如何获取[BotBizId](https://cloud.tencent.com/document/product/1759/109469#4eecb8c1-6ce4-45f5-8fa2-b269449d8efa)
*/
BotBizId: string;
/**
* 标签名
*/
AttrName: string;
/**
* 标签值
*/
Labels: Array<AttributeLabel>;
/**
* 标签标识（不生效，无需填写） 已作废
*/
AttrKey?: string;
/**
* 登录用户主账号(集成商模式必填)
*/
LoginUin?: string;
/**
* 登录用户子账号(集成商模式必填)
*/
LoginSubAccountUin?: string;
}
/**
* ListApp返回参数结构体
*/
export interface ListAppResponse {
/**
* 数量
*/
Total?: string;
/**
* 应用列表
*/
List?: Array<AppInfo>;
/**
* 唯一请求 ID，由服务端生成，每次请求都会返回（若请求因其他原因未能抵达服务端，则该次请求不会获得 RequestId）。定位问题时需要提供该次请求的 RequestId。
*/
RequestId?: string;
}
/**
* 任务流程参数信息
*/
export interface ValueInfo {
/**
* 值ID
注意：此字段可能返回 null，表示取不到有效值。
*/
Id?: string;
/**
* 名称
注意：此字段可能返回 null，表示取不到有效值。
*/
Name?: string;
/**
* 值类型：0:未知或者空, 1:string, 2:int, 3:float, 4:bool, 5:array(字符串数组), 6: object_array(结构体数组), 7: object(结构体)
注意：此字段可能返回 null，表示取不到有效值。
*/
ValueType?: number;
/**
* string
注意：此字段可能返回 null，表示取不到有效值。
*/
ValueStr?: string;
/**
* int（避免精度丢失使用字符串返回）
注意：此字段可能返回 null，表示取不到有效值。
*/
ValueInt?: string;
/**
* float
注意：此字段可能返回 null，表示取不到有效值。
*/
ValueFloat?: number;
/**
* bool
注意：此字段可能返回 null，表示取不到有效值。
*/
ValueBool?: boolean;
/**
* array
注意：此字段可能返回 null，表示取不到有效值。
*/
ValueStrArray?: Array<string>;
}
/**
* 发布拒答
*/
export interface RejectedQuestion {
/**
* 拒答问题ID
注意：此字段可能返回 null，表示取不到有效值。
*/
RejectedBizId?: string;
/**
* 被拒答的问题
注意：此字段可能返回 null，表示取不到有效值。
*/
Question?: string;
/**
* 发布状态(1 待发布 2 发布中 3 已发布 4 发布失败)
注意：此字段可能返回 null，表示取不到有效值。
*/
Status?: number;
/**
* 状态描述
注意：此字段可能返回 null，表示取不到有效值。
*/
StatusDesc?: string;
/**
* 更新时间, 秒级时间戳
注意：此字段可能返回 null，表示取不到有效值。
*/
UpdateTime?: string;
/**
* 是否允许编辑
注意：此字段可能返回 null，表示取不到有效值。
*/
IsAllowEdit?: boolean;
/**
* 是否允许删除
注意：此字段可能返回 null，表示取不到有效值。
*/
IsAllowDelete?: boolean;
/**
* 操作人
注意：此字段可能返回 null，表示取不到有效值。
*/
Operator?: string;
/**
* 拒答生效域: 1-不生效；2-仅开发域生效；3-仅发布域生效；4-开发域和发布域均生效
注意：此字段可能返回 null，表示取不到有效值。
*/
EnableScope?: number;
}
/**
* ExportQAList请求参数结构体
*/
export interface ExportQAListRequest {
/**
* 应用ID
若要操作共享知识库，传KnowledgeBizId
*/
BotBizId: string;
/**
* QA业务ID
*/
QaBizIds: Array<string>;
/**
* 查询参数
Filters.pageNumber范围是>0,0<Filters.pageSize<=200
Filters.query用于内容检索，模糊匹配
Filters.AcceptStatus默认值是0，表示不筛选，返回所有状态
Filters.ReleaseStatus默认值是0，表示不筛选，返回所有状态
Filters.Source默认值是0，表示不筛选，返回所有来源。表示来源(1 文档生成 2 批量导入 3 手动添加)。
Filter.QueryType默认值是"filename"，表示查询类型。
ShowCurrCate表示，是否只展示当前分类的数据 0不是，1是
*/
Filters?: QAQuery;
}
/**
* 执行过程信息记录
*/
export interface Procedure {
/**
* 执行过程英语名
注意：此字段可能返回 null，表示取不到有效值。
*/
Name?: string;
/**
* 中文名, 用于展示
注意：此字段可能返回 null，表示取不到有效值。
*/
Title?: string;
/**
* 状态常量: 使用中: processing, 成功: success, 失败: failed
注意：此字段可能返回 null，表示取不到有效值。
*/
Status?: string;
/**
* 消耗 token 数
注意：此字段可能返回 null，表示取不到有效值。
*/
Count?: number;
/**
* 调试信息
注意：此字段可能返回 null，表示取不到有效值。
*/
Debugging?: ProcedureDebugging;
/**
* 计费资源状态，1：可用，2：不可用
注意：此字段可能返回 null，表示取不到有效值。
*/
ResourceStatus?: number;
/**
* 输入消耗 token 数
*/
InputCount?: number;
/**
* 输出消耗 token 数
*/
OutputCount?: number;
}
/**
* CreateRelease返回参数结构体
*/
export interface CreateReleaseResponse {
/**
* 发布ID
*/
ReleaseBizId?: string;
/**
* 唯一请求 ID，由服务端生成，每次请求都会返回（若请求因其他原因未能抵达服务端，则该次请求不会获得 RequestId）。定位问题时需要提供该次请求的 RequestId。
*/
RequestId?: string;
}
/**
* 应用使用知识库容量详情
*/
export interface KnowledgeDetail {
/**
* 应用名称
注意：此字段可能返回 null，表示取不到有效值。
*/
AppName?: string;
/**
* 已用字符数
注意：此字段可能返回 null，表示取不到有效值。
*/
UsedCharSize?: string;
/**
* 使用占比
注意：此字段可能返回 null，表示取不到有效值。
*/
Proportion?: number;
/**
* 超量字符数
注意：此字段可能返回 null，表示取不到有效值。
*/
ExceedCharSize?: string;
/**
* 废弃
注意：此字段可能返回 null，表示取不到有效值。
*/
IsSharedKnowledge?: boolean;
/**
* 知识库类型:0默认1共享
*/
KnowledgeType?: number;
}
/**
* 文件信息内容
*/
export interface FileInfoContent {
/**
* <p>实时文档解析接口返回的 DocBizId</p>
注意：此字段可能返回 null，表示取不到有效值。
* @deprecated
*/
DocBizId?: string;
/**
* <p>文件名称</p>
注意：此字段可能返回 null，表示取不到有效值。
*/
FileName?: string;
/**
* <p>文件类型</p>
注意：此字段可能返回 null，表示取不到有效值。
*/
FileType?: string;
/**
* <p>文件大小，单位为Byte</p>
注意：此字段可能返回 null，表示取不到有效值。
*/
FileSize?: string;
/**
* <p>文件 URL</p>
注意：此字段可能返回 null，表示取不到有效值。
*/
FileUrl?: string;
/**
* <p>实时文档解析接口返回的 doc_id。</p>
注意：此字段可能返回 null，表示取不到有效值。
*/
DocId?: string;
/**
* <p>文件创建时间</p>
注意：此字段可能返回 null，表示取不到有效值。
*/
CreateTime?: string;
}
/**
* GenerateQA请求参数结构体
*/
export interface GenerateQARequest {
/**
* 应用ID,获取方法参看如何获取[BotBizId](https://cloud.tencent.com/document/product/1759/109469#4eecb8c1-6ce4-45f5-8fa2-b269449d8efa)
*/
BotBizId: string;
/**
* 文档ID
*/
DocBizIds: Array<string>;
}
/**
* ListReferShareKnowledge请求参数结构体
*/
export interface ListReferShareKnowledgeRequest {
/**
* 应用业务id
*/
AppBizId: string;
/**
* 登录用户主账号(集成商模式必填)
*/
LoginUin?: string;
/**
* 登录用户子账号(集成商模式必填)
*/
LoginSubAccountUin?: string;
}
/**
* ListAttributeLabel请求参数结构体
*/
export interface ListAttributeLabelRequest {
/**
* 应用ID，获取方法参看如何获取[BotBizId](https://cloud.tencent.com/document/product/1759/109469#4eecb8c1-6ce4-45f5-8fa2-b269449d8efa)
*/
BotBizId: string;
/**
* 页码，取值范围：大于0
*/
PageNumber: number;
/**
* 每页数量，取值范围：大于0
*/
PageSize: number;
/**
* 登录用户主账号(集成商模式必填)
*/
LoginUin?: string;
/**
* 登录用户子账号(集成商模式必填)
*/
LoginSubAccountUin?: string;
/**
* 查询内容，同时匹配标签内容和标签值内容
*/
Query?: string;
/**
* 每个标签同步拉取的标签值数量。即在展示标签列表时，为每一个标签加载多少个具体的标签值。
*/
LabelSize?: number;
}
/**
* Agent输出配置
*/
export interface AgentOutputConfig {
/**
* 输出类型，1-文本 2-json 3-widget
*/
OutputType?: number;
/**
* Json结构化输出参数列表
*/
StructuredOutputParams?: Array<ParameterConfig>;
/**
* widget id
*/
WidgetId?: string;
}
/**
* Agent中的参考来源
*/
export interface AgentReference {
/**
* <p>来源文档ID</p>
注意：此字段可能返回 null，表示取不到有效值。
*/
DocId?: string;
/**
* <p>id</p>
注意：此字段可能返回 null，表示取不到有效值。
*/
Id?: string;
/**
* <p>名称</p>
注意：此字段可能返回 null，表示取不到有效值。
*/
Name?: string;
/**
* <p>类型</p><p>枚举值：</p><ul><li>1： 问答</li><li>2： 文档片段</li><li>4： 联网检索到的内容</li></ul>
注意：此字段可能返回 null，表示取不到有效值。
*/
Type?: number;
/**
* <p>链接</p>
注意：此字段可能返回 null，表示取不到有效值。
*/
Url?: string;
/**
* <p>文档业务ID</p>
注意：此字段可能返回 null，表示取不到有效值。
*/
DocBizId?: string;
/**
* <p>文档名称</p>
注意：此字段可能返回 null，表示取不到有效值。
*/
DocName?: string;
/**
* <p>问答业务ID</p>
注意：此字段可能返回 null，表示取不到有效值。
*/
QaBizId?: string;
/**
* <p>搜索引擎索引</p>
注意：此字段可能返回 null，表示取不到有效值。
*/
Index?: number;
/**
* <p>标题</p>
注意：此字段可能返回 null，表示取不到有效值。
*/
Title?: string;
/**
* <p>知识库名称</p>
注意：此字段可能返回 null，表示取不到有效值。
*/
KnowledgeName?: string;
/**
* <p>知识库标识</p>
注意：此字段可能返回 null，表示取不到有效值。
*/
KnowledgeBizId?: string;
}
/**
* DeleteDoc返回参数结构体
*/
export interface DeleteDocResponse {
/**
* 唯一请求 ID，由服务端生成，每次请求都会返回（若请求因其他原因未能抵达服务端，则该次请求不会获得 RequestId）。定位问题时需要提供该次请求的 RequestId。
*/
RequestId?: string;
}
/**
* DescribeSegments返回参数结构体
*/
export interface DescribeSegmentsResponse {
/**
* 片段列表
注意：此字段可能返回 null，表示取不到有效值。
*/
List?: Array<DocSegment>;
/**
* 唯一请求 ID，由服务端生成，每次请求都会返回（若请求因其他原因未能抵达服务端，则该次请求不会获得 RequestId）。定位问题时需要提供该次请求的 RequestId。
*/
RequestId?: string;
}
/**
* UploadAttributeLabel请求参数结构体
*/
export interface UploadAttributeLabelRequest {
/**
* 应用ID
*/
BotBizId: string;
/**
* 文件名
*/
FileName: string;
/**
* cos路径
*/
CosUrl: string;
/**
* x-cos-hash-crc64ecma 头部中的 CRC64编码进行校验上传到云端的文件和本地文件的一致性
*/
CosHash: string;
/**
* 文件大小
*/
Size: string;
/**
* 登录用户主账号(集成商模式必填)
*/
LoginUin?: string;
/**
* 登录用户子账号(集成商模式必填)
*/
LoginSubAccountUin?: string;
}
/**
* DescribeAppAgentList请求参数结构体
*/
export interface DescribeAppAgentListRequest {
/**
* 应用ID
*/
AppBizId?: string;
}
/**
* CreateQA返回参数结构体
*/
export interface CreateQAResponse {
/**
* 问答ID
*/
QaBizId?: string;
/**
* 唯一请求 ID，由服务端生成，每次请求都会返回（若请求因其他原因未能抵达服务端，则该次请求不会获得 RequestId）。定位问题时需要提供该次请求的 RequestId。
*/
RequestId?: string;
}
/**
* 背景图相关配置
*/
export interface BackgroundImageConfig {
/**
* 横图(pc)
*/
LandscapeImageUrl?: string;
/**
* 原始图
*/
OriginalImageUrl?: string;
/**
* 长图(手机)
*/
PortraitImageUrl?: string;
/**
* 主题色
*/
ThemeColor?: string;
/**
* 亮度值
*/
Brightness?: number;
}
/**
* DescribeReleaseInfo返回参数结构体
*/
export 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）。定位问题时需要提供该次请求的 RequestId。
*/
RequestId?: string;
}
/**
* ModifyRejectedQuestion请求参数结构体
*/
export interface ModifyRejectedQuestionRequest {
/**
* 应用ID, 获取方法参看如何获取 [BotBizId](https://cloud.tencent.com/document/product/1759/109469#4eecb8c1-6ce4-45f5-8fa2-b269449d8efa)
*/
BotBizId: string;
/**
* 拒答问题
*/
Question: string;
/**
* 拒答问题来源的数据源唯一id, 通过调用ListRejectedQuestion接口获取
*/
RejectedBizId: string;
/**
* 拒答生效域: 1-不生效；2-仅开发域生效；3-仅发布域生效；4-开发域和发布域均生效
*/
EnableScope?: number;
}
/**
* DescribeWorkflowRun返回参数结构体
*/
export interface DescribeWorkflowRunResponse {
/**
* 工作流运行实例详情
*/
WorkflowRun?: WorkflowRunDetail;
/**
* 节点列表
*/
NodeRuns?: Array<NodeRunBase>;
/**
* 子工作流对应的NodePath
*/
SubWorkflowNodePath?: string;
/**
* 唯一请求 ID，由服务端生成，每次请求都会返回（若请求因其他原因未能抵达服务端，则该次请求不会获得 RequestId）。定位问题时需要提供该次请求的 RequestId。
*/
RequestId?: string;
}
/**
* 选项卡索引
*/
export interface OptionCardIndex {
/**
* 唯一标识
*/
RecordId?: string;
/**
* 选项卡索引
*/
Index?: number;
}
/**
* 当前执行的 token 统计信息
*/
export interface TokenStat {
/**
* 会话 ID
注意：此字段可能返回 null，表示取不到有效值。
*/
SessionId?: string;
/**
* 请求 ID
注意：此字段可能返回 null，表示取不到有效值。
*/
RequestId?: string;
/**
* 对应哪条会话, 会话 ID, 用于回答的消息存储使用, 可提前生成, 保存消息时使用
注意：此字段可能返回 null，表示取不到有效值。
*/
RecordId?: string;
/**
* token 已使用数
注意：此字段可能返回 null，表示取不到有效值。
*/
UsedCount?: number;
/**
* 免费 token 数
注意：此字段可能返回 null，表示取不到有效值。
*/
FreeCount?: number;
/**
* 订单总 token 数
注意：此字段可能返回 null，表示取不到有效值。
*/
OrderCount?: number;
/**
* 当前执行状态汇总, 常量: 使用中: processing, 成功: success, 失败: failed
注意：此字段可能返回 null，表示取不到有效值。
*/
StatusSummary?: string;
/**
* 当前执行状态汇总后中文展示
注意：此字段可能返回 null，表示取不到有效值。
*/
StatusSummaryTitle?: string;
/**
* 当前请求执行时间, 单位 ms
注意：此字段可能返回 null，表示取不到有效值。
*/
Elapsed?: number;
/**
* 当前请求消耗 token 数