tencentcloud-sdk-nodejs

/** * ModifyQAAttrRange返回参数结构体 */ export interface ModifyQAAttrRangeResponse { /** * 唯一请求 ID，由服务端生成，每次请求都会返回（若请求因其他原因未能抵达服务端，则该次请求不会获得 RequestId）。定位问题时需要提供该次请求的 RequestId。 */ RequestId?: string; } /** * GetWsToken返回参数结构体 */ export interface GetWsTokenResponse { /** * token值（有效期60s，仅一次有效，多次校验会报错） */ Token?: string; /** * 余额; 余额大于 0 时表示有效注意：此字段可能返回 null，表示取不到有效值。 */ Balance?: number; /** * 对话窗输入字符限制 */ InputLenLimit?: number; /** * 应用模式，standard:标准模式, agent: agent模式，single_workflow：单工作流模式 */ Pattern?: string; /** * SingleWorkflow */ SingleWorkflow?: KnowledgeQaSingleWorkflow; /** * 唯一请求 ID，由服务端生成，每次请求都会返回（若请求因其他原因未能抵达服务端，则该次请求不会获得 RequestId）。定位问题时需要提供该次请求的 RequestId。 */ RequestId?: string; } /** * ListUsageCallDetail请求参数结构体 */ export interface ListUsageCallDetailRequest { /** * 模型标识 */ ModelName: string; /** * 开始时间 */ StartTime: string; /** * 结束时间 */ EndTime: string; /** * 页码 */ PageNumber: number; /** * 分页数量 */ PageSize: number; /** * uin列表 */ UinAccount?: Array<string>; /** * 应用ID列表 */ AppBizIds?: Array<string>; /** * 调用类型列表 */ CallType?: string; /** * 筛选子场景 */ SubScenes?: Array<string>; } /** * CheckAttributeLabelExist请求参数结构体 */ export interface CheckAttributeLabelExistRequest { /** * 应用ID */ BotBizId: string; /** * 属性名称 */ LabelName: string; /** * 属性ID */ AttributeBizId: string; /** * 登录用户主账号(集成商模式必填) */ LoginUin?: string; /** * 登录用户子账号(集成商模式必填) */ LoginSubAccountUin?: string; /** * 滚动加载，最后一个属性标签ID */ LastLabelBizId?: string; } /** * 导出知识标签过滤器 */ export interface AttributeFilters { /** * 检索，属性或标签名称 */ Query?: string; } /** * DescribeQA返回参数结构体 */ export interface DescribeQAResponse { /** * QA业务ID */ QaBizId?: string; /** * 问题 */ Question?: string; /** * 答案 */ Answer?: string; /** * 自定义参数 */ CustomParam?: string; /** * 来源 1-文档生成问答对 2-批量导入问答对 3-单条手动录入问答对 */ Source?: number; /** * 来源描述 */ SourceDesc?: string; /** * 更新时间 */ UpdateTime?: string; /** * 状态 <br>1-未校验 2-未发布 3-发布中 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?: Array<Highlight>; /** * 分片内容 */ OrgData?: string; /** * 标签适用范围 */ AttrRange?: number; /** * 标签 */ AttrLabels?: Array<AttrLabel>; /** * 有效开始时间，unix时间戳 */ ExpireStart?: string; /** * 有效结束时间，unix时间戳，0代表永久有效 */ ExpireEnd?: string; /** * 相似问列表信息 */ SimilarQuestions?: Array<SimilarQuestion>; /** * 问题和答案文本审核状态 1审核失败 */ QaAuditStatus?: number; /** * 答案中的图片审核状态 1审核失败 */ PicAuditStatus?: number; /** * 答案中的视频审核状态 1审核失败 */ VideoAuditStatus?: number; /** * 问题描述 */ QuestionDesc?: string; /** * 唯一请求 ID，由服务端生成，每次请求都会返回（若请求因其他原因未能抵达服务端，则该次请求不会获得 RequestId）。定位问题时需要提供该次请求的 RequestId。 */ RequestId?: string; } /** * 扩展信息 */ export interface ExtraInfo { /** * ECharts信息注意：此字段可能返回 null，表示取不到有效值。 */ EChartsInfo?: Array<string>; } /** * GetAppKnowledgeCount请求参数结构体 */ export interface GetAppKnowledgeCountRequest { /** * 类型：doc-文档；qa-问答对 */ Type: string; /** * 应用ID */ AppBizId: string; /** * 登录用户主账号(集成商模式必填) */ LoginUin?: string; /** * 登录用户子账号(集成商模式必填) */ LoginSubAccountUin?: string; } /** * StopDocParse返回参数结构体 */ export interface StopDocParseResponse { /** * 唯一请求 ID，由服务端生成，每次请求都会返回（若请求因其他原因未能抵达服务端，则该次请求不会获得 RequestId）。定位问题时需要提供该次请求的 RequestId。 */ RequestId?: string; } /** * ListSelectDoc返回参数结构体 */ export interface ListSelectDocResponse { /** * 下拉框内容 */ List?: Array<Option>; /** * 唯一请求 ID，由服务端生成，每次请求都会返回（若请求因其他原因未能抵达服务端，则该次请求不会获得 RequestId）。定位问题时需要提供该次请求的 RequestId。 */ RequestId?: string; } /** * DescribeReleaseInfo请求参数结构体 */ export interface DescribeReleaseInfoRequest { /** * 应用ID */ BotBizId: string; } /** * DeleteDoc请求参数结构体 */ export interface DeleteDocRequest { /** * 文档业务ID列表 */ DocBizIds: Array<string>; /** * 应用ID */ BotBizId: string; } /** * GetAnswerTypeDataCount请求参数结构体 */ export interface GetAnswerTypeDataCountRequest { /** * 开始日期 */ StartTime: number; /** * 结束日期 */ EndTime: number; /** * 应用id */ AppBizId?: Array<string>; /** * 消息来源(1、分享用户端 2、对话API 3、对话测试 4、应用评测) */ Type?: number; /** * 登录用户主账号(集成商模式必填) */ LoginUin?: string; /** * 登录用户子账号(集成商模式必填) */ LoginSubAccountUin?: string; } /** * 节点信息 */ export interface RunNodeInfo { /** * 节点类型，0:未指定，1:开始节点，2:API节点，3:询问节点，4:答案节点注意：此字段可能返回 null，表示取不到有效值。 */ NodeType?: number; /** * 节点ID 注意：此字段可能返回 null，表示取不到有效值。 */ NodeId?: string; /** * 节点名称注意：此字段可能返回 null，表示取不到有效值。 */ NodeName?: string; /** * 请求的API 注意：此字段可能返回 null，表示取不到有效值。 */ InvokeApi?: InvokeAPI; /** * 当前节点的所有槽位的值，key：SlotID。没有值的时候也要返回空。注意：此字段可能返回 null，表示取不到有效值。 */ SlotValues?: Array<ValueInfo>; } /** * Agent调试信息 */ export interface AgentDebugInfo { /** * 工具、大模型的输入信息，json 注意：此字段可能返回 null，表示取不到有效值。 */ Input?: string; /** * 工具、大模型的输出信息，json 注意：此字段可能返回 null，表示取不到有效值。 */ Output?: string; } /** * UploadAttributeLabel返回参数结构体 */ export interface UploadAttributeLabelResponse { /** * 导入错误 */ ErrorMsg?: string; /** * 错误链接 */ ErrorLink?: string; /** * 错误链接文本 */ ErrorLinkText?: string; /** * 唯一请求 ID，由服务端生成，每次请求都会返回（若请求因其他原因未能抵达服务端，则该次请求不会获得 RequestId）。定位问题时需要提供该次请求的 RequestId。 */ RequestId?: string; } /** * 消息详情 */ export interface MsgRecord { /** * 内容 */ Content?: string; /** * 当前记录所对应的 Session ID 注意：此字段可能返回 null，表示取不到有效值。 */ SessionId?: string; /** * 记录ID */ RecordId?: string; /** * 关联记录ID */ RelatedRecordId?: string; /** * 是否来自自己 */ IsFromSelf?: boolean; /** * 发送者名称 */ FromName?: string; /** * 发送者头像 */ FromAvatar?: string; /** * 时间戳 */ Timestamp?: string; /** * 是否已读 */ HasRead?: boolean; /** * 评价 */ Score?: number; /** * 是否评分 */ CanRating?: boolean; /** * 是否展示反馈按钮注意：此字段可能返回 null，表示取不到有效值。 */ CanFeedback?: boolean; /** * 记录类型 */ Type?: number; /** * 引用来源 */ References?: Array<MsgRecordReference>; /** * 评价原因 */ Reasons?: Array<string>; /** * 是否大模型 */ IsLlmGenerated?: boolean; /** * 图片链接，可公有读注意：此字段可能返回 null，表示取不到有效值。 */ ImageUrls?: Array<string>; /** * 当次 token 统计信息注意：此字段可能返回 null，表示取不到有效值。 */ TokenStat?: TokenStat; /** * 回复方式 1:大模型直接回复; 2:保守回复, 未知问题回复; 3:拒答问题回复; 4:敏感回复; 5:问答对直接回复, 已采纳问答对优先回复; 6:欢迎语回复; 7:并发超限回复; 8:全局干预知识; 9:任务流程过程回复, 当历史记录中 task_flow.type = 0 时, 为大模型回复; 10:任务流程答案回复; 11:搜索引擎回复; 12:知识润色后回复; 13:图片理解回复; 14:实时文档回复; 注意：此字段可能返回 null，表示取不到有效值。 */ ReplyMethod?: number; /** * 选项卡, 用于多轮对话注意：此字段可能返回 null，表示取不到有效值。 */ OptionCards?: Array<string>; /** * 任务信息注意：此字段可能返回 null，表示取不到有效值。 */ TaskFlow?: TaskFlowInfo; /** * 用户传入的文件信息注意：此字段可能返回 null，表示取不到有效值。 */ FileInfos?: Array<FileInfo>; /** * 参考来源引用位置信息注意：此字段可能返回 null，表示取不到有效值。 */ QuoteInfos?: Array<QuoteInfo>; /** * Agent的思考过程信息注意：此字段可能返回 null，表示取不到有效值。 */ AgentThought?: AgentThought; /** * 扩展信息注意：此字段可能返回 null，表示取不到有效值。 */ ExtraInfo?: ExtraInfo; } /** * CreateDocCate返回参数结构体 */ export interface CreateDocCateResponse { /** * 是否可新增 */ CanAdd?: boolean; /** * 是否可编辑 */ CanEdit?: boolean; /** * 是否可删除 */ CanDelete?: boolean; /** * 分类业务ID */ CateBizId?: string; /** * 唯一请求 ID，由服务端生成，每次请求都会返回（若请求因其他原因未能抵达服务端，则该次请求不会获得 RequestId）。定位问题时需要提供该次请求的 RequestId。 */ RequestId?: string; } /** * DeleteDocCate返回参数结构体 */ export interface DeleteDocCateResponse { /** * 唯一请求 ID，由服务端生成，每次请求都会返回（若请求因其他原因未能抵达服务端，则该次请求不会获得 RequestId）。定位问题时需要提供该次请求的 RequestId。 */ RequestId?: string; } /** * ExportAttributeLabel返回参数结构体 */ export interface ExportAttributeLabelResponse { /** * 导出任务ID */ TaskId?: string; /** * 唯一请求 ID，由服务端生成，每次请求都会返回（若请求因其他原因未能抵达服务端，则该次请求不会获得 RequestId）。定位问题时需要提供该次请求的 RequestId。 */ RequestId?: string; } /** * 知识库容量饼图详情 */ export interface KnowledgeCapacityPieGraphDetail { /** * 当前应用名称注意：此字段可能返回 null，表示取不到有效值。 */ AppName?: string; /** * 当前应用使用的字符数注意：此字段可能返回 null，表示取不到有效值。 */ UsedCharSize?: string; /** * 当前应用对于总用量的占比注意：此字段可能返回 null，表示取不到有效值。 */ Proportion?: number; } /** * ExportQAList返回参数结构体 */ export interface ExportQAListResponse { /** * 唯一请求 ID，由服务端生成，每次请求都会返回（若请求因其他原因未能抵达服务端，则该次请求不会获得 RequestId）。定位问题时需要提供该次请求的 RequestId。 */ RequestId?: string; } /** * GetAppSecret返回参数结构体 */ export interface GetAppSecretResponse { /** * 应用密钥 */ AppKey?: string; /** * 创建时间 */ CreateTime?: string; /** * 是否发布 */ IsRelease?: boolean; /** * 是否有查看权限 */ HasPermission?: boolean; /** * 唯一请求 ID，由服务端生成，每次请求都会返回（若请求因其他原因未能抵达服务端，则该次请求不会获得 RequestId）。定位问题时需要提供该次请求的 RequestId。 */ RequestId?: string; } /** * ListRejectedQuestion请求参数结构体 */ export interface ListRejectedQuestionRequest { /** * 应用ID */ BotBizId: string; /** * 页码 */ PageNumber: number; /** * 每页数量 */ PageSize: number; /** * 查询内容 */ Query?: string; } /** * CreateQACate返回参数结构体 */ export interface CreateQACateResponse { /** * 是否可新增 */ CanAdd?: boolean; /** * 是否可编辑 */ CanEdit?: boolean; /** * 是否可删除 */ CanDelete?: boolean; /** * 分类业务ID */ CateBizId?: string; /** * 唯一请求 ID，由服务端生成，每次请求都会返回（若请求因其他原因未能抵达服务端，则该次请求不会获得 RequestId）。定位问题时需要提供该次请求的 RequestId。 */ RequestId?: string; } /** * ModifyDocAttrRange返回参数结构体 */ export interface ModifyDocAttrRangeResponse { /** * 唯一请求 ID，由服务端生成，每次请求都会返回（若请求因其他原因未能抵达服务端，则该次请求不会获得 RequestId）。定位问题时需要提供该次请求的 RequestId。 */ RequestId?: string; } /** * GetAnswerTypeDataCount返回参数结构体 */ export interface GetAnswerTypeDataCountResponse { /** * 总消息数 */ Total?: number; /** * 大模型直接回复总数 */ ModelReplyCount?: number; /** * 知识型回复总数 */ KnowledgeCount?: number; /** * 任务流回复总数 */ TaskFlowCount?: number; /** * 搜索引擎回复总数 */ SearchEngineCount?: number; /** * 图片理解回复总数 */ ImageUnderstandingCount?: number; /** * 拒答回复总数 */ RejectCount?: number; /** * 敏感回复总数 */ SensitiveCount?: number; /** * 并发超限回复总数 */ ConcurrentLimitCount?: number; /** * 未知问题回复总数 */ UnknownIssuesCount?: number; /** * 唯一请求 ID，由服务端生成，每次请求都会返回（若请求因其他原因未能抵达服务端，则该次请求不会获得 RequestId）。定位问题时需要提供该次请求的 RequestId。 */ RequestId?: string; } /** * DescribeQA请求参数结构体 */ export interface DescribeQARequest { /** * QA业务ID */ QaBizId: string; /** * 应用ID */ BotBizId: string; } /** * 标签引用信息 */ export interface AttrLabelRefer { /** * 标签来源，1：标签 */ Source?: number; /** * 标签ID */ AttributeBizId?: string; /** * 标签值ID */ LabelBizIds?: Array<string>; } /** * 创建智能文档解析任务的配置信息 */ export interface CreateReconstructDocumentFlowConfig { /** * Markdown文件中表格返回的形式 0，表格以MD形式返回 1，表格以HTML形式返回默认为1 */ TableResultType?: string; /** * 智能文档解析返回结果的格式 0：只返回全文MD； 1：只返回每一页的OCR原始Json； 2：只返回每一页的MD， 3：返回全文MD + 每一页的OCR原始Json； 4：返回全文MD + 每一页的MD，默认值为3（返回全文MD + 每一页的OCR原始Json） */ ResultType?: string; } /** * DescribeUnsatisfiedReplyContext请求参数结构体 */ export interface DescribeUnsatisfiedReplyContextRequest { /** * 应用ID */ BotBizId: string; /** * 回复ID */ ReplyBizId: string; /** * 登录用户主账号(集成商模式必填) */ LoginUin?: string; /** * 登录用户子账号(集成商模式必填) */ LoginSubAccountUin?: string; } /** * 执行过程信息记录 */ 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; } /** * QA查询参数 */ export interface QAQuery { /** * 页码 */ PageNumber: number; /** * 每页数量 */ PageSize: number; /** * 应用ID */ BotBizId: string; /** * 查询内容 */ Query?: string; /** * 分类ID */ CateBizId?: string; /** * 校验状态 */ AcceptStatus?: Array<number | bigint>; /** * 发布状态 */ ReleaseStatus?: Array<number | bigint>; /** * 文档ID */ DocBizId?: string; /** * QAID */ QaBizId?: string; /** * 来源 */ Source?: number; /** * 查询答案 */ QueryAnswer?: string; /** * 查询类型 filename 名称、 attribute 标签 */ QueryType?: string; } /** * ListApp请求参数结构体 */ export interface ListAppRequest { /** * 应用类型；knowledge_qa-知识问答管理；summary-知识摘要；classifys-知识标签提取 */ AppType?: string; /** * 每页数目，整型 */ PageSize?: number; /** * 页码，整型 */ PageNumber?: number; /** * 关键词：应用/修改人 */ Keyword?: string; /** * 登录用户子账号(集成商模式必填) */ LoginSubAccountUin?: string; } /** * 标签详情信息 */ export interface AttrLabel { /** * 标签来源注意：此字段可能返回 null，表示取不到有效值。 */ Source?: number; /** * 标签ID 注意：此字段可能返回 null，表示取不到有效值。 */ AttrBizId?: string; /** * 标签标识注意：此字段可能返回 null，表示取不到有效值。 */ AttrKey?: string; /** * 标签名称注意：此字段可能返回 null，表示取不到有效值。 */ AttrName?: string; /** * 标签值注意：此字段可能返回 null，表示取不到有效值。 */ Labels?: Array<Label>; } /** * ModifyQAAttrRange请求参数结构体 */ export interface ModifyQAAttrRangeRequest { /** * 应用ID */ BotBizId: string; /** * 问答ID */ QaBizIds: Array<string>; /** * 属性标签适用范围 1：全部，2：按条件 */ AttrRange: number; /** * 属性标签引用 */ AttrLabels: Array<AttrLabelRefer>; } /** * 获取ws token label */ export interface GetWsTokenReq_Label { /** * 标签名 */ Name?: string; /** * 标签值 */ Values?: Array<string>; } /** * ModifyDoc返回参数结构体 */ export interface ModifyDocResponse { /** * 唯一请求 ID，由服务端生成，每次请求都会返回（若请求因其他原因未能抵达服务端，则该次请求不会获得 RequestId）。定位问题时需要提供该次请求的 RequestId。 */ RequestId?: string; } /** * 发布文档详情 */ export interface ReleaseDoc { /** * 文件名 */ FileName?: string; /** * 文件类型 */ FileType?: string; /** * 更新时间 */ UpdateTime?: string; /** * 状态 */ Action?: number; /** * 状态描述 */ ActionDesc?: string; /** * 失败原因 */ Message?: string; /** * 文档业务ID */ DocBizId?: string; } /** * 检索配置 */ export interface KnowledgeQaSearch { /** * 知识来源 doc：文档，qa：问答 taskflow：业务流程，search：搜索增强注意：此字段可能返回 null，表示取不到有效值。 */ Type?: string; /** * 问答-回复灵活度 1：已采纳答案直接回复 2：已采纳润色后回复注意：此字段可能返回 null，表示取不到有效值。 */ ReplyFlexibility?: number; /** * 搜索增强-搜索引擎状态注意：此字段可能返回 null，表示取不到有效值。 */ UseSearchEngine?: boolean; /** * 是否显示搜索引擎检索状态注意：此字段可能返回 null，表示取不到有效值。 */ ShowSearchEngine?: boolean; /** * 知识来源，是否选择注意：此字段可能返回 null，表示取不到有效值。 */ IsEnabled?: boolean; /** * 问答最大召回数量, 默认2，限制5 注意：此字段可能返回 null，表示取不到有效值。 */ QaTopN?: number; /** * 文档最大召回数量, 默认3，限制5 注意：此字段可能返回 null，表示取不到有效值。 */ DocTopN?: number; /** * 检索置信度，针对文档和问答有效，最小0.01，最大0.99 注意：此字段可能返回 null，表示取不到有效值。 */ Confidence?: number; /** * 资源状态 1：资源可用；2：资源已用尽注意：此字段可能返回 null，表示取不到有效值。 */ ResourceStatus?: number; } /** * CreateCorp返回参数结构体 */ export interface CreateCorpResponse { /** * 企业ID */ CorpBizId?: string; /** * 唯一请求 ID，由服务端生成，每次请求都会返回（若请求因其他原因未能抵达服务端，则该次请求不会获得 RequestId）。定位问题时需要提供该次请求的 RequestId。 */ RequestId?: string; } /** * ListQA请求参数结构体 */ export interface ListQARequest { /** * 应用ID */ BotBizId: string; /** * 页码 */ PageNumber: number; /** * 每页大小 */ PageSize: number; /** * 查询问题 */ Query?: string; /** * 校验状态(1未校验2采纳3不采纳) */ AcceptStatus?: Array<number | bigint>; /** * 发布状态(2待发布 3发布中 4已发布 7审核中 8审核失败 9人工申述中 11人工申述失败 12已过期 13超量失效 14超量失效恢复) */ ReleaseStatus?: Array<number | bigint>; /** * 文档ID */ DocBizId?: string; /** * 来源(1 文档生成 2 批量导入 3 手动添加) */ Source?: number; /** * 查询答案 */ QueryAnswer?: string; /** * 分类ID */ CateBizId?: string; /** * QA业务ID列表 */ QaBizIds?: Array<string>; /** * 查询类型 filename 名称、 attribute 标签 */ QueryType?: string; } /** * DescribeKnowledgeUsage返回参数结构体 */ export interface DescribeKnowledgeUsageResponse { /** * 可用字符数上限 */ AvailableCharSize?: string; /** * 超过可用字符数上限的字符数 */ ExceedCharSize?: string; /** * 知识库使用字符总数 */ UsedCharSize?: string; /** * 唯一请求 ID，由服务端生成，每次请求都会返回（若请求因其他原因未能抵达服务端，则该次请求不会获得 RequestId）。定位问题时需要提供该次请求的 RequestId。 */ RequestId?: string; } /** * 引用来源详情 */ export interface ReferDetail { /** * 引用ID 注意：此字段可能返回 null，表示取不到有效值。 */ ReferBizId?: string; /** * 文档类型 (1 QA, 2 文档段) 注意：此字段可能返回 null，表示取不到有效值。 */ DocType?: number; /** * 文档名称注意：此字段可能返回 null，表示取不到有效值。 */ DocName?: string; /** * 分片内容注意：此字段可能返回 null，表示取不到有效值。 */ PageContent?: string; /** * 问题注意：此字段可能返回 null，表示取不到有效值。 */ Question?: string; /** * 答案注意：此字段可能返回 null，表示取不到有效值。 */ Answer?: string; /** * 置信度注意：此字段可能返回 null，表示取不到有效值。 */ Confidence?: number; /** * 标记注意：此字段可能返回 null，表示取不到有效值。 */ Mark?: number; /** * 分片高亮内容注意：此字段可能返回 null，表示取不到有效值。 */ Highlights?: Array<Highlight>; /** * 原始内容注意：此字段可能返回 null，表示取不到有效值。 */ OrgData?: string; /** * 页码信息注意：此字段可能返回 null，表示取不到有效值。 */ PageInfos?: Array<number | bigint>; /** * sheet信息注意：此字段可能返回 null，表示取不到有效值。 */ SheetInfos?: Array<string>; /** * 文档ID 注意：此字段可能返回 null，表示取不到有效值。 */ DocBizId?: string; } /** * ListUnsatisfiedReply请求参数结构体 */ export interface ListUnsatisfiedReplyRequest { /** * 应用ID */ BotBizId: string; /** * 页码 */ PageNumber: number; /** * 分页数量 */ PageSize: number; /** * 登录用户主账号(集成商模式必填) */ LoginUin?: string; /** * 登录用户子账号(集成商模式必填) */ LoginSubAccountUin?: string; /** * 用户请求(问题或答案) */ Query?: string; /** * 错误类型检索 */ Reasons?: Array<string>; } /** * DeleteQA请求参数结构体 */ export interface DeleteQARequest { /** * 应用ID */ BotBizId: string; /** * 问答ID */ QaBizIds: Array<string>; } /** * GetLikeDataCount返回参数结构体 */ export interface GetLikeDataCountResponse { /** * 可评价消息数 */ Total?: number; /** * 评价数 */ AppraisalTotal?: number; /** * 参评率 */ ParticipationRate?: number; /** * 点赞数 */ LikeTotal?: number; /** * 点赞率 */ LikeRate?: number; /** * 点踩数 */ DislikeTotal?: number; /** * 点踩率 */ DislikeRate?: number; /** * 唯一请求 ID，由服务端生成，每次请求都会返回（若请求因其他原因未能抵达服务端，则该次请求不会获得 RequestId）。定位问题时需要提供该次请求的 RequestId。 */ RequestId?: string; } /** * ListRelease请求参数结构体 */ export interface ListReleaseRequest { /** * 机器人ID */ BotBizId: string; /** * 页码 */ PageNumber: number; /** * 每页数量 */ PageSize: number; } /** * IsTransferIntent返回参数结构体 */ export interface IsTransferIntentResponse { /** * 是否意图转人工 */ Hit?: boolean; /** * 唯一请求 ID，由服务端生成，每次请求都会返回（若请求因其他原因未能抵达服务端，则该次请求不会获得 RequestId）。定位问题时需要提供该次请求的 RequestId。 */ RequestId?: string; } /** * CreateDocCate请求参数结构体 */ export interface CreateDocCateRequest { /** * 应用ID */ BotBizId: string; /** * 父级业务ID */ ParentBizId: string; /** * 分类名称 */ Name: string; } /** * 请求的API信息 */ export interface InvokeAPI { /** * 请求方法，如GET/POST等注意：此字段可能返回 null，表示取不到有效值。 */ Method?: string; /** * 请求地址注意：此字段可能返回 null，表示取不到有效值。 */ Url?: string; /** * header参数注意：此字段可能返回 null，表示取不到有效值。 */ HeaderValues?: Array<StrValue>; /** * 入参Query 注意：此字段可能返回 null，表示取不到有效值。 */ QueryValues?: Array<StrValue>; /** * Post请求的原始数据注意：此字段可能返回 null，表示取不到有效值。 */ RequestPostBody?: string; /** * 返回的原始数据注意：此字段可能返回 null，表示取不到有效值。 */ ResponseBody?: string; /** * 出参注意：此字段可能返回 null，表示取不到有效值。 */ ResponseValues?: Array<ValueInfo>; /** * 异常信息注意：此字段可能返回 null，表示取不到有效值。 */ FailMessage?: string; } /** * 知识摘要输出配置 */ export interface SummaryOutput { /** * 输出方式 1：流式 2：非流式注意：此字段可能返回 null，表示取不到有效值。 */ Method?: number; /** * 输出要求 1：文本总结 2：自定义要求注意：此字段可能返回 null，表示取不到有效值。 */ Requirement?: number; /** * 自定义要求指令注意：此字段可能返回 null，表示取不到有效值。 */ RequireCommand?: string; } /** * ModifyApp返回参数结构体 */ export interface ModifyAppResponse { /** * 应用App 注意：此字段可能返回 null，表示取不到有效值。 */ AppBizId?: string; /** * 更新时间 */ UpdateTime?: string; /** * 唯一请求 ID，由服务端生成，每次请求都会返回（若请求因其他原因未能抵达服务端，则该次请求不会获得 RequestId）。定位问题时需要提供该次请求的 RequestId。 */ RequestId?: string; } /** * ListDoc返回参数结构体 */ export interface ListDocResponse { /** * 文档数量 */ Total?: string; /** * 文档列表 */ List?: Array<ListDocItem>; /** * 唯一请求 ID，由服务端生成，每次请求都会返回（若请求因其他原因未能抵达服务端，则该次请求不会获得 RequestId）。定位问题时需要提供该次请求的 RequestId。 */ RequestId?: string; } /** * GetDocPreview请求参数结构体 */ export interface GetDocPreviewRequest { /** * 文档BizID */ DocBizId: string; /** * 应用ID */ BotBizId: string; /** * 存储类型: offline:离线文件，realtime:实时文件；为空默认为offline */ TypeKey?: string; } /** * ModifyQA请求参数结构体 */ export interface ModifyQARequest { /** * 应用ID */ BotBizId: string; /** * 问答ID */ QaBizId: string; /** * 问题 */ Question: string; /** * 答案 */ Answer: string; /** * 自定义参数 */ CustomParam?: string; /** * 标签适用范围 1：全部，2：按条件 */ AttrRange?: number; /** * 标签引用 */ AttrLabels?: Array<AttrLabelRefer>; /** * 文档ID */ DocBizId?: string; /** * 分类ID */ CateBizId?: string; /** * 有效开始时间，unix时间戳 */ ExpireStart?: string; /** * 有效结束时间，unix时间戳，0代表永久有效 */ ExpireEnd?: string; /** * 相似问修改信息(相似问没有修改则不传) */ SimilarQuestionModify?: SimilarQuestionModify; /** * 问题描述 */ QuestionDesc?: 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; } /** * ExportUnsatisfiedReply返回参数结构体 */ export interface ExportUnsatisfiedReplyResponse { /** * 唯一请求 ID，由服务端生成，每次请求都会返回（若请求因其他原因未能抵达服务端，则该次请求不会获得 RequestId）。定位问题时需要提供该次请求的 RequestId。 */ RequestId?: string; } /** * ListDocCate返回参数结构体 */ export interface ListDocCateResponse { /** * 列表 */ List?: Array<CateInfo>; /** * 唯一请求 ID，由服务端生成，每次请求都会返回（若请求因其他原因未能抵达服务端，则该次请求不会获得 RequestId）。定位问题时需要提供该次请求的 RequestId。 */ RequestId?: string; } /** * ListRejectedQuestionPreview返回参数结构体 */ export interface ListRejectedQuestionPreviewResponse { /** * 文档数量 */ Total?: string; /** * 文档列表 */ List?: Array<ReleaseRejectedQuestion>; /** * 唯一请求 ID，由服务端生成，每次请求都会返回（若请求因其他原因未能抵达服务端，则该次请求不会获得 RequestId）。定位问题时需要提供该次请求的 RequestId。 */ RequestId?: string; } /** * DescribeCorp请求参数结构体 */ export declare type DescribeCorpRequest = null; /** * ListAppCategory返回参数结构体 */ export interface ListAppCategoryResponse { /** * 应用类型列表注意：此字段可能返回 null，表示取不到有效值。 */ List?: Array<ListAppCategoryRspOption>; /** * 唯一请求 ID，由服务端生成，每次请求都会返回（若请求因其他原因未能抵达服务端，则该次请求不会获得 RequestId）。定位问题时需要提供该次请求的 RequestId。 */ RequestId?: string; } /** * CreateApp返回参数结构体 */ export interface CreateAppResponse { /** * 应用ID 注意：此字段可能返回 null，表示取不到有效值。 */ AppBizId?: string; /** * 判断账户应用列表权限是否是自定义的，用户交互提示注意：此字段可能返回 null，表示取不到有效值。 */ IsCustomList?: boolean; /** * 唯一请求 ID，由服务端生成，每次请求都会返回（若请求因其他原因未能抵达服务端，则该次请求不会获得 RequestId）。定位问题时需要提供该次请求的 RequestId。 */ RequestId?: string; } /** * DescribeAttributeLabel请求参数结构体 */ export interface DescribeAttributeLabelRequest { /** * 应用ID */ BotBizId: string; /** * 属性ID */ AttributeBizId: string; /** * 每次加载的数量 */ Limit: number; /** * 登录用户主账号(集成商模式必填) */ LoginUin?: string; /** * 登录用户子账号(集成商模式必填) */ LoginSubAccountUin?: string; /** * 查询标签或相似标签 */ Query?: string; /** * 滚动加载游标的标签ID */ LastLabelBizId?: string; } /** * CreateQA请求参数结构体 */ export interface CreateQARequest { /** * 应用ID */ BotBizId: string; /** * 问题 */ Question: string; /** * 答案 */ Answer: string; /** * 标签适用范围 1：全部，2：按条件 */ AttrRange: number; /** * 自定义参数 */ CustomParam?: string; /** * 标签引用 */ AttrLabels?: Array<AttrLabelRefer>; /** * 文档ID */ DocBizId?: string; /** * 分类ID */ CateBizId?: string; /** * 有效开始时间，unix时间戳 */ ExpireStart?: string; /** * 有效结束时间，unix时间戳，0代表永久有效 */ ExpireEnd?: string; /** * 相似问内容 */ SimilarQuestions?: Array<string>; /** * 问题描述 */ QuestionDesc?: string; } /** * 检索知识 */ export interface KnowledgeSummary { /** * 1是问答 2是文档片段注意：此字段可能返回 null，表示取不到有效值。 */ Type?: number; /** * 知识内容注意：此字段可能返回 null，表示取不到有效值。 */ Content?: string; } /** * 任务流程调试信息 */ export interface TaskFlowSummary { /** * 任务流程名注意：此字段可能返回 null，表示取不到有效值。 */ IntentName?: string; /** * 实体列表注意：此字段可能返回 null，表示取不到有效值。 */ UpdatedSlotValues?: Array<ValueInfo>; /** * 节点列表注意：此字段可能返回 null，表示取不到有效值。 */ RunNodes?: Array<RunNodeInfo>; /** * 意图判断注意：此字段可能返回 null，表示取不到有效值。 */ Purposes?: Array<string>; } /** * CreateCorp请求参数结构体 */ export interface CreateCorpRequest { /** * 企业全称 */ FullName: string; /** * 联系人名称 */ ContactName: string; /** * 联系人邮箱 */ Email?: string; /** * 联系人手机号 */ Telephone?: string; } /** * 插件参数请求结构 */ export 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 */ Type?: number; /** * 参数是否必填 */ IsRequired?: boolean; /** * 参数默认值 */ DefaultValue?: string; /** * 子参数,ParamType 是OBJECT 或 ARRAY<>类型有用 */ SubParams?: Array<PluginToolReqParam>; /** * 插件参数配置是否隐藏不可见，true-隐藏不可见，false-可见 */ GlobalHidden?: boolean; } /** * QueryRewrite返回参数结构体 */ export interface QueryRewriteResponse { /** * 改写结果 */ Content?: string; /** * 消耗量，返回输入token数，输出token数以及总token数 */ Usage?: Usage; /** * 唯一请求 ID，由服务端生成，每次请求都会返回（若请求因其他原因未能抵达服务端，则该次请求不会获得 RequestId）。定位问题时需要提供该次请求的 RequestId。 */ RequestId?: string; } /** * 问答详情数据 */ export 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?: Array<AttrLabel>; /** * 相似问个数 */ SimilarQuestionNum?: number; /** * 返回问答关联的相似问,联动搜索,仅展示一条 */ SimilarQuestionTips?: string; } /** * DeleteAttributeLabel请求参数结构体 */ export interface DeleteAttributeLabelRequest { /** * 应用ID */ BotBizId: string; /** * 标签ID */ AttributeBizIds: Array<string>; /** * 登录用户主账号(集成商模式必填) */ LoginUin?: string; /** * 登录用户子账号(集成商模式必填) */ LoginSubAccountUin?: string; } /** * DescribeRobotBizIDByAppKey返回参数结构体 */ export interface DescribeRobotBizIDByAppKeyResponse { /** * 应用业务ID */ BotBizId?: string; /** * 唯一请求 ID，由服务端生成，每次请求都会返回（若请求因其他原因未能抵达服务端，则该次请求不会获得 RequestId）。定位问题时需要提供该次请求的 RequestId。 */ RequestId?: string; } /** * RenameDoc返回参数结构体 */ export interface RenameDocResponse { /** * 唯一请求 ID，由服务端生成，每次请求都会返回（若请求因其他原因未能抵达服务端，则该次请求不会获得 RequestId）。定位问题时需要提供该次请求的 RequestId。 */ RequestId?: string; } /** * ReconstructDocument返回参数结构体 */ export interface ReconstructDocumentResponse { /** * 识别生成的Markdown文件base64编码的字符串注意：此字段可能返回 null，表示取不到有效值。 */ MarkdownBase64?: string; /** * 输入文件中嵌入的图片放在一个文件夹中打包为.zip压缩文件，识别生成的Markdown文件通过路径关联插入本文件夹中的图片。注意：此字段可能返回 null，表示取不到有效值。 */ InsetImagePackage?: string; /** * 输入文件中嵌入的图片中文字内容的识别结果注意：此字段可能返回 null，表示取不到有效值。 */ DocumentRecognizeInfo?: Array<DocumentRecognizeInfo>; /** * 唯一请求 ID，由服务端生成，每次请求都会返回（若请求因其他原因未能抵达服务端，则该次请求不会获得 RequestId）。定位问题时需要提供该次请求的 RequestId。 */ RequestId?: string; } /** * ListDocCate请求参数结构体 */ export interface ListDocCateRequest { /** * 应用ID */ BotBizId: 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-待发布 11-发布中 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; /** * 唯一请求 ID，由服务端生成，每次请求都会返回（若请求因其他原因未能抵达服务端，则该次请求不会获得 RequestId）。定位问题时需要提供该次请求的 RequestId。 */ RequestId?: string; } /** * CreateRelease请求参数结构体 */ export interface CreateReleaseRequest { /** * 应用ID */ BotBizId: string; /** * 发布描述 */ Desc?: string; } /** * 标签ID */ export interface Label { /** * 标签ID 注意：此字段可能返回 null，表示取不到有效值。 */ LabelBizId?: string; /** * 标签名称注意：此字段可能返回 null，表示取不到有效值。 */ LabelName?: string; } /** * 思考事件过程信息 */ export interface AgentProcedure { /** * 索引注意：此字段可能返回 null，表示取不到有效值。 */ Index?: number; /** * 执行过程英语名注意：此字段可能返回 null，表示取不到有效值。 */ Name?: string; /** * 中文名, 用于展示注意：此字段可能返回 null，表示取不到有效值。 */ Title?: string; /** * 状态常量: 使用中: processing, 成功: success, 失败: failed 注意：此字段可能返回 null，表示取不到有效值。 */ Status?: string; /** * 图标注意：此字段可能返回 null，表示取不到有效值。 */ Icon?: string; /** * Agent调试信息注意：此字段可能返回 null，表示取不到有效值。 */ Debugging?: AgentProcedureDebugging; /** * 是否切换Agent，取值为"main"或者"workflow",不切换为空注意：此字段可能返回 null，表示取不到有效值。 */ Switch?: string; /** * 工作流名称注意：此字段可能返回 null，表示取不到有效值。 */ WorkflowName?: string; /** * 当前请求执行时间, 单位 ms 注意：此字段可能返回 null，表示取不到有效值。 */ Elapsed?: number; /** * 工作流节点名称注意：此字段可能返回 null，表示取不到有效值。 */ NodeName?: string; /** * 用于展示思考放在哪个回复气泡中注意：此字段可能返回 null，表示取不到有效值。 */ ReplyIndex?: number; } /** * 应用管理输出配置 */ export interface KnowledgeQaOutput { /** * 输出方式 1：流式 2：非流式注意：此字段可能返回 null，表示取不到有效值。 */ Method?: number; /** * 通用模型回复注意：此字段可能返回 null，表示取不到有效值。 */ UseGeneralKnowledge?: boolean; /** * 未知回复语，300字符以内注意：此字段可能返回 null，表示取不到有效值。 */ BareAnswer?: string; /** * 是否展示问题澄清开关注意：此字段可能返回 null，表示取不到有效值。 */ ShowQuestionClarify?: boolean; /** * 是否打开问题澄清注意：此字段可能返回 null，表示取不到有效值。 */ UseQuestionClarify?: boolean; /** * 问题澄清关键词列表注意：此字段可能返回 null，表示取不到有效值。 */ QuestionClarifyKeywords?: Array<string>; /** * 是否打开推荐问题开关注意：此字段可能返回 null，表示取不到有效值。 */ UseRecommended?: boolean; } /** * ModifyRejectedQuestion请求参数结构体 */ export interface ModifyRejectedQuestionRequest { /** * 应用ID */ BotBizId: string; /** * 拒答问题 */ Question: string; /** * 拒答问题来源的数据源唯一id */ RejectedBizId: string; } /** * 自定义变量和标签关系数据 */ export interface ApiVarAttrInfo { /** * 自定义变量id 注意：此字段可能返回 null，表示取不到有效值。 */ ApiVarId?: string; /** * 标签id 注意：此字段可能返回 null，表示取不到有效值。 */ AttrBizId?: string; } /** * Agent的思考过程 */ export interface AgentThought { /** * 会话 ID 注意：此字段可能返回 null，表示取不到有效值。 */ SessionId?: string; /** * 请求 ID 注意：此字段可能返回 null，表示取不到有效值。 */ RequestId?: string; /** * 对应哪条会话, 会话 ID, 用于回答的消息存储使用, 可提前生成, 保存消息时使用注意：此字段可能返回 null，表示取不到有效值。 */ RecordId?: string; /** * 当前请求执行时间, 单位 ms 注意：此字段可能返回 null，表示取不到有效值。 */ Elapsed?: number; /** * 当前是否为工作流注意：此字段可能返回 null，表示取不到有效值。 */ IsWorkflow?: boolean; /** * 如果当前是工作流，工作流名称注意：此字段可能返回 null，表示取不到有效值。 */ WorkflowName?: string; /** * 具体思考过程详情注意：此字段可能返回 null，表示取不到有效值。 */ Procedures?: Array<AgentProcedure>; /** * TraceId 注意：此字段可能返回 null，表示取不到有效值。 */ TraceId?: string; } /** * GroupDoc请求参数结构体 */ export interface GroupDocRequest { /** * 应用ID */ BotBizId: string; /** * 操作对象的业务ID列表 */ BizIds: Array<string>; /** * 分组 ID */ CateBizId: string; } /** * CheckAttributeLabelRefer请求参数结构体 */ export interface CheckAttributeLabelReferRequest { /** * 应用ID */ BotBizId: string; /** * 登录用户主账号(集成商模式必填) */ LoginUin?: string; /** * 登录用户子账号(集成商模式必填) */ LoginSubAccountUin?: string; /** * 属性标签 */ LabelBizId?: string; /** * 属性ID */ AttributeBizId?: Array<string>; } /** * ModifyQACate请求参数结构体 */ export interface ModifyQACateRequest { /** * 应用ID */ BotBizId: string; /** * 分类名称 */ Name: string; /** * 分类业务ID */ CateBizId: string; } /** * 知识库检索策略 */ export interface SearchStrategy { /** * 检索策略类型 0:混合检索，1：语义检索注意：此字段可能返回 null，表示取不到有效值。 */ StrategyType?: number; /** * Excel检索增强开关注意：此字段可能返回 null，表示取不到有效值。 */ TableEnhancement?: boolean; } /** * ModifyAttributeLabel请求参数结构体 */ export interface ModifyAttributeLabelRequest { /** * 应用ID */ BotBizId: string; /** * 标签ID */ AttributeBizId: string; /** * 标签名称 */ AttrName: string; /** * 标签标识（已作废） */ AttrKey?: string; /** * 登录用户主账号(集成商模式必填) */ LoginUin?: string; /** * 登录用户子账号(集成商模式必填) */ LoginSubAccountUin?: string; /** * 删除的标签值 */ DeleteLabelBizIds?: Array<string>; /** * 新增或编辑的标签 */ Labels?: Array<AttributeLabel>; } /** * ConvertDocument请求参数结构体 */ export interface ConvertDocumentRequest { /** * 图片的 Url 地址。支持的图片格式：PNG、JPG、JPEG、PDF，暂不支持 GIF 格式。支持的图片大小：所下载图片经 Base64 编码后不超过 8M。图片下载时间不超过 3 秒。支持的图片像素：单边介于20-10000px之间。图片存储于腾讯云的 Url 可保障更高的下载速度和稳定性，建议图片存储于腾讯云。非腾讯云存储的 Url 速度和稳定性可能受一定影响。 */ FileUrl?: string; /** * 图片的 Base64 值。支持的图片格式：PNG、JPG、JPEG、PDF，暂不支持 GIF 格式。支持的图片大小：所下载图片经Base64编码后不超过 8M。图片下载时间不超过 3 秒。支持的图片像素：单边介于20-10000px之间。图片的 ImageUrl、ImageBase64 必须提供一个，如果都提供，只使用 ImageUrl。 */ FileBase64?: string; /** * 当传入文件是PDF类型（FileType=PDF）时，用来指定pdf识别的起始页码，识别的页码包含当前值。 */ FileStartPageNumber?: number; /** * 当传入文件是PDF类型（FileType=PDF）时，用来指定pdf识别的结束页码，识别的页码包含当前值。建议一次请求的页面不超过3页。 */ FileEndPageNumber?: number; } /** * 标签值 */ export interface AttributeLabel { /** * 标准词ID 注意：此字段可能返回 null，表示取不到有效值。 */ LabelBizId?: string; /** * 标准词名称注意：此字段可能返回 null，表示取不到有效值。 */ LabelName?: string; /** * 同义词名称注意：此字段可能返回 null，表示取不到有效值。 */ SimilarLabels?: Array<string>; } /** * 下拉框选项 */ export interface Option { /** * 文本注意：此字段可能返回 null，表示取不到有效值。 */ Text?: string; /** * 值注意：此字段可能返回 null，表示取不到有效值。 */ Value?: string; /** * 文件字符数注意：此字段可能返回 null，表示取不到有效值。 */ CharSize?: string; /** * 文件类型注意：此字段可能返回 null，表示取不到有效值。 */ FileType?: string; } /** * 消耗量 */ export interface Usage { /** * 文档页数 */ TotalPages?: number; /** * 输入token数 */ InputTokens?: number; /** * 输出token数 */ OutputTokens?: number; /** * 总token数 */ TotalTokens?: number; } /** * ListUnsatisfiedReply返回参数结构体 */ export interface ListUnsatisfiedReplyResponse { /** * 总数 */ Total?: string; /** * 不满意回复列表注意：此字段可能返回 null，表示取不到有效值。 */ List?: Array<UnsatisfiedReply>; /** * 唯一请求 ID，由服务端生成，每次请求都会返回（若请求因其他原因未能抵达服务端，则该次请求不会获得 RequestId）。定位问题时需要提供该次请求的 RequestId。 */ RequestId?: string; } /** * GetAppSecret请求参数结构体 */ export interface GetAppSecretRequest { /** * 应用ID */ AppBizId: string; } /** * 模型参数范围 */ export interface ModelParameter { /** * 默认值注意：此字段可能返回 null，表示取不到有效值。 */ Default?: number; /** * 最小值注意：此字段可能返回 null，表示取不到有效值。 */ Min?: number; /** * 最大值注意：此字段可能返回 null，表示取不到有效值。 */ Max?: number; } /** * DeleteQACate返回参数结构体 */ export interface DeleteQACateResponse { /** * 唯一请求 ID，由服务端生成，每次请求都会返回（若请求因其他原因未能抵达服务端，则该次请求不会获得 RequestId）。定位问题时需要提供该次请求的 RequestId。 */ RequestId?: string; } /** * SaveDoc返回参数结构体 */ export interface SaveDocResponse { /** * 文档ID */ DocBizId?: string; /** * 导入错误信息 */ ErrorMsg?: string; /** * 错误链接 */ ErrorLink?: string; /** * 错误链接文本 */ ErrorLinkText?: string; /** * 唯一请求 ID，由服务端生成，每次请求都会返回（若请求因其他原因未能抵达服务端，则该次请求不会获得 RequestId）。定位问题时需要提供该次请求的 RequestId。 */ RequestId?: string; } /** * ListReleaseDocPreview返回参数结构体 */ export interface ListReleaseDocPreviewResponse { /** * 文档数量 */ Total?: string; /** * 文档列表 */ List?: Array<ReleaseDoc>; /** * 唯一请求 ID，由服务端生成，每次请求都会返回（若请求因其他原因未能抵达服务端，则该次请求不会获得 RequestId）。定位问题时需要提供该次请求的 RequestId。 */ RequestId?: string; } /** * 解析为 word 文档的结果 */ export interface WordRecognizeInfo { /** * 输入文件的页码数注意：此字段可能返回 null，表示取不到有效值。 */ PageNumber?: number; /** * word的base64 注意：此字段可能返回 null，表示取不到有效值。 */ WordBase64?: string; } /** * RenameDoc请求参数结构体 */ export interface RenameDocRequest { /** * 登录用户主账号(集成商模式必填) */ LoginUin?: string; /** * 登录用户子账号(集成商模式必填) */ LoginSubAccountUin?: string; /** * 应用ID */ BotBizId?: string; /** * 文档ID */ DocBizId?: string; /** * 新文档名，需要带上后缀 */ NewName?: string; } /** * 知识摘要应用配置 */ export interface SummaryConfig { /** * 模型配置注意：此字段可能返回 null，表示取不到有效值。 */ Model?: AppModel; /** * 知识摘要输出配置注意：此字段可能返回 null，表示取不到有效值。 */ Output?: SummaryOutput; /** * 欢迎语，200字符以内注意：此字段可能返回 null，表示取不到有效值。 */ Greeting?: string; } /** * GenerateQA返回参数结构体 */ export interface GenerateQAResponse { /** * 唯一请求 ID，由服务端生成，每次请求都会返回（若请求因其他原因未能抵达服务端，则该次请求不会获得 RequestId）。定位问题时需要提供该次请求的 RequestId。 */ RequestId?: string; } /** * GetTaskStatus返回参数结构体 */ export interface GetTaskStatusResponse { /** * 任务ID */ TaskId?: string; /** * 任务类型 */ TaskType?: string; /** * 任务状态注意：此字段可能返回 null，表示取不到有效值。 */ Status?: string; /** * 任务消息注意：此字段可能返回 null，表示取不到有效值。 */ Message?: string; /** * 任务参数注意：此字段可能返回 null，表示取不到有效值。 */ Params?: TaskParams; /** * 唯一请求 ID，由服务端生成，每次请求都会返回（若请求因其他原因未能抵达服务端，则该次请求不会获得 RequestId）。定位问题时需要提供该次请求的 RequestId。 */ RequestId?: string; } /** * DescribeConcurrencyUsageGraph请求参数结构体 */ export interface DescribeConcurrencyUsageGraphRequest { /** * 模型标识 */ ModelName: string; /** * 开始时间戳, 单位为秒 */ StartTime: string; /** * 结束时间戳, 单位为秒 */ EndTime: string; /** * uin */ UinAccount?: Array<string>; /** * 登录用户主账号(集成商模式必填) */ LoginUin?: string; /** * 登录用户子账号(集成商模式必填) */ LoginSubAccountUin?: string; /** * 子业务类型 */ SubBizType?: string; /** * 应用id列表 */ AppBizIds?: Array<string>; } /** * DescribeDoc请求参数结构体 */ export interface DescribeDocRequest { /** * 应用ID */ BotBizId: string; /** * 文档ID */ DocBizId: string; } /** * Agent思考过程调试信息 */ export interface AgentProcedureDebugging { /** * 模型思考内容注意：此字段可能返回 null，表示取不到有效值。 */ Content?: string; /** * 展示的具体文本内容注意：此字段可能返回 null，表示取不到有效值。 */ DisplayContent?: string; /** * 展示类型注意：此字段可能返回 null，表示取不到有效值。 */ DisplayType?: number; /** * 搜索引擎展示的索引注意：此字段可能返回 null，表示取不到有效值。 */ QuoteInfos?: Array<QuoteInfo>; /** * 具体的参考来源注意：此字段可能返回 null，表示取不到有效值。 */ References?: Array<AgentReference>; } /** * DescribeTokenUsageGraph请求参数结构体 */ export interface DescribeTokenUsageGraphRequest { /** * 腾讯云主账号 */ UinAccount?: Array<string>; /** * 知识引擎子业务类型: FileParse(文档解析)、Embedding、Rewrite(多轮改写)、 Concurrency(并发)、KnowledgeSummary(知识总结) KnowledgeQA(知识问答)、KnowledgeCapacity(知识库容量)、SearchEngine(搜索引擎) */ SubBizType?: string; /** * 模型标识 */ ModelName?: string; /** * 开始时间戳, 单位为秒 */ StartTime?: string; /** * 结束时间戳, 单位为秒 */ EndTime?: string; /** * 应用id列表 */ AppBizIds?: Array<string>; } /** * ConvertDocument返回参数结构体 */ export interface ConvertDocumentResponse { /** * 识别生成的word文件base64编码的字符串注意：此字段可能返回 null，表示取不到有效值。 */ WordRecognizeInfo?: Array<WordRecognizeInfo>; /** * 唯一请求 ID，由服务端生成，每次请求都会返回（若请求因其他原因未能抵达服务端，则该次请求不会获得 RequestId）。定位问题时需要提供该次请求的 RequestId。 */ RequestId?: string; } /** * RetryDocAudit请求参数结构体 */ export interface RetryDocAuditRequest { /** * 应用ID */ BotBizId: string; /** * 文档ID */ DocBizId: string; } /** * SaveDoc请求参数结构体 */ export interface SaveDocRequest { /** * 应用ID */ BotBizId: string; /** * 文件名 */ FileName: string; /** * 文件类型(md|txt|docx|pdf|xlsx) */ 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 */ AttrRange?: number; /** * 来源(0 源文件导入 1 网页导入) */ Source?: number; /** * 网页(或自定义链接)地址 */ WebUrl?: string; /** * 标签引用 */ AttrLabels?: Array<AttrLabelRefer>; /** * 外部引用链接类型 0：系统链接 1：自定义链接值为1时，WebUrl 字段不能为空，否则不生效。 */ ReferUrlType?: number; /** * 有效开始时间，unix时间戳 */ ExpireStart?: string; /** * 有效结束时间，unix时间戳，0代表永久有效 */ ExpireEnd?: string; /** * 是否引用链接 */ IsRefer?: boolean; /** * 文档操作类型：1：批量导入（批量导入问答对）；2:文档导入（正常导入单个文档）默认为1 <br> 请注意，opt=1的时候请从知识引擎页面下载excel模板 */ Opt?: number; /** * 分类ID */ CateBizId?: string; } /** * RetryDocParse请求参数结构体 */ export interface RetryDocParseRequest { /** * 应用ID */ BotBizId: string; /** * 文档ID */ DocBizId: string; } /** * 文档解析失败记录 */ export interface ReconstructDocumentFailedPage { /** * 失败页码注意：此字段可能返回 null，表示取不到有效值。 */ PageNumber?: number; } /** * ListAppKnowledgeDetail返回参数结构体 */ export interface ListAppKnowledgeDetailResponse { /** * 列表总数 */ Total?: number; /** * 应用使用知识库容量详情 */ List?: Array<KnowledgeDetail>; /** * 唯一请求 ID，由服务端生成，每次请求都会返回（若请求因其他原因未能抵达服务端，则该次请求不会获得 RequestId）。定位问题时需要提供该次请求的 RequestId。 */ RequestId?: string; } /** * ModifyQACate返回参数结构体 */ export interface ModifyQACateResponse { /** * 唯一请求 ID，由服务端生成，每次请求都会返回（若请求因其他原因未能抵达服务端，则该次请求不会获得 RequestId）。定位问题时需要提供该次请求的 RequestId。 */ RequestId?: string; } /** * DescribeAttributeLabel返回参数结构体 */ ex