tencentcloud-sdk-nodejs
Version:
7,266 lines • 177 kB
TypeScript
/**
* 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;
}
/**
* 获取ws token label
*/
export interface GetWsTokenReq_Label {
/**
* 标签名
*/
Name?: string;
/**
* 标签值
*/
Values?: 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>;
}
/**
* DescribeApp返回参数结构体
*/
export 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;
/**
* 唯一请求 ID，由服务端生成，每次请求都会返回（若请求因其他原因未能抵达服务端，则该次请求不会获得 RequestId）。定位问题时需要提供该次请求的 RequestId。
*/
RequestId?: 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;
}
/**
* 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>;
}
/**
* ListRejectedQuestion返回参数结构体
*/
export interface ListRejectedQuestionResponse {
/**
* 总数
*/
Total?: string;
/**
* 拒答问题列表
*/
List?: Array<RejectedQuestion>;
/**
* 唯一请求 ID，由服务端生成，每次请求都会返回（若请求因其他原因未能抵达服务端，则该次请求不会获得 RequestId）。定位问题时需要提供该次请求的 RequestId。
*/
RequestId?: 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>;
}
/**
* 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;
}
/**
* 自定义变量和标签关系数据
*/
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编码进行校验上传到云端的文件和本地文件的一致性 <br> 成功上传cos后，从返回头中获取
*/
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返回参数结构体
*/
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，由服务端生成，每次请求都会返回（若请求因其他原因未能抵达服务端，则该次请求不会获得 RequestId）。定位问题时需要提供该次请求的 RequestId。
*/
RequestId?: string;
}
/**
* 问答知识库单工作流模式下指定单工作流配置
*/
export interface KnowledgeQaSingleWorkflow {
/**
* 工作流ID
*/
WorkflowId?: string;
/**
* 工作流名称
*/
WorkflowName?: string;
/**
* 工作流描述
*/
WorkflowDesc?: string;
/**
* 工作流状态，发布状态(UNPUBLISHED: 待发布 PUBLISHING: 发布中 PUBLISHED: 已发布 FAIL:发布失败)
*/
Status?: string;
/**
* 工作流是否启用
*/
IsEnable?: boolean;
}
/**
* ListQACate返回参数结构体
*/
export interface ListQACateResponse {
/**
* 列表
*/
List?: Array<QACate>;
/**
* 唯一请求 ID，由服务端生成，每次请求都会返回（若请求因其他原因未能抵达服务端，则该次请求不会获得 RequestId）。定位问题时需要提供该次请求的 RequestId。
*/
RequestId?: string;
}
/**
* GetVarList请求参数结构体
*/
export interface GetVarListRequest {
/**
* 应用ID
*/
AppBizId: string;
/**
* 变量ID数组
*/
VarIds?: Array<string>;
/**
* 按变量名称关键词搜索
*/
Keyword?: string;
/**
* 起始偏移量（默认0）
*/
Offset?: number;
/**
* 限定数量（默认15）
*/
Limit?: number;
/**
* 按变量类型过滤，默认查询所有类型(STRING,INT,FLOAT,BOOL,OBJECT,ARRAY_STRING,ARRAY_INT,ARRAY_FLOAT,ARRAY_BOOL,ARRAY_OBJECT,FILE,DOCUMENT,IMAGE,AUDIO)
*/
VarType?: string;
}
/**
* RetryDocParse返回参数结构体
*/
export interface RetryDocParseResponse {
/**
* 唯一请求 ID，由服务端生成，每次请求都会返回（若请求因其他原因未能抵达服务端，则该次请求不会获得 RequestId）。定位问题时需要提供该次请求的 RequestId。
*/
RequestId?: string;
}
/**
* CreateRejectedQuestion返回参数结构体
*/
export interface CreateRejectedQuestionResponse {
/**
* 唯一请求 ID，由服务端生成，每次请求都会返回（若请求因其他原因未能抵达服务端，则该次请求不会获得 RequestId）。定位问题时需要提供该次请求的 RequestId。
*/
RequestId?: string;
}
/**
* ReconstructDocument配置选项
*/
export interface ReconstructDocumentConfig {
/**
* 生成的Markdown中是否嵌入图片
*/
EnableInsetImage?: boolean;
}
/**
* GetEmbedding返回参数结构体
*/
export interface GetEmbeddingResponse {
/**
* 特征
*/
Data?: Array<EmbeddingObject>;
/**
* 消耗量，返回TotalToken
*/
Usage?: Usage;
/**
* 唯一请求 ID，由服务端生成，每次请求都会返回（若请求因其他原因未能抵达服务端，则该次请求不会获得 RequestId）。定位问题时需要提供该次请求的 RequestId。
*/
RequestId?: string;
}
/**
* ExportUnsatisfiedReply请求参数结构体
*/
export interface ExportUnsatisfiedReplyRequest {
/**
* 应用ID
*/
BotBizId: string;
/**
* 勾选导出ID列表
*/
ReplyBizIds: Array<string>;
/**
* 登录用户主账号(集成商模式必填)
*/
LoginUin?: string;
/**
* 登录用户子账号(集成商模式必填)
*/
LoginSubAccountUin?: string;
/**
* 检索过滤器
*/
Filters?: Filters;
}
/**
* GroupQA返回参数结构体
*/
export interface GroupQAResponse {
/**
* 唯一请求 ID，由服务端生成，每次请求都会返回（若请求因其他原因未能抵达服务端，则该次请求不会获得 RequestId）。定位问题时需要提供该次请求的 RequestId。
*/
RequestId?: string;
}
/**
* 搜索引擎参考来源索引
*/
export interface QuoteInfo {
/**
* 参考来源位置
注意：此字段可能返回 null，表示取不到有效值。
*/
Position?: number;
/**
* 参考来源索引顺序
注意：此字段可能返回 null，表示取不到有效值。
*/
Index?: string;
}
/**
* CreateApp请求参数结构体
*/
export interface CreateAppRequest {
/**
* 应用类型；knowledge_qa-知识问答管理
*/
AppType: string;
/**
* 应用基础配置
*/
BaseConfig: BaseConfig;
}
/**
* 应用配置
*/
export interface AppConfig {
/**
* 知识问答管理应用配置
注意：此字段可能返回 null，表示取不到有效值。
*/
KnowledgeQa?: KnowledgeQaConfig;
/**
* 知识摘要应用配置
注意：此字段可能返回 null，表示取不到有效值。
*/
Summary?: SummaryConfig;
/**
* 标签提取应用配置
注意：此字段可能返回 null，表示取不到有效值。
*/
Classify?: ClassifyConfig;
}
/**
* DescribeRelease请求参数结构体
*/
export interface DescribeReleaseRequest {
/**
* 应用ID
*/
BotBizId: string;
/**
* 发布详情
*/
ReleaseBizId?: string;
}
/**
* 发布问答
*/
export 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;
}
/**
* ListAppCategory请求参数结构体
*/
export declare type ListAppCategoryRequest = null;
/**
* ListReleaseConfigPreview请求参数结构体
*/
export interface ListReleaseConfigPreviewRequest {
/**
* 机器人ID
*/
BotBizId: string;
/**
* 页码
*/
PageNumber: number;
/**
* 每页数量
*/
PageSize: number;
/**
* 查询内容
*/
Query?: string;
/**
* 发布单ID
*/
ReleaseBizId?: string;
/**
* 状态(1新增2更新3删除)
*/
Actions?: Array<number | bigint>;
/**
* 开始时间
*/
StartTime?: string;
/**
* 结束时间
*/
EndTime?: string;
/**
* 发布状态
*/
ReleaseStatus?: Array<number | bigint>;
}
/**
* 调用类型
*/
export interface CallDetail {
/**
* 关联ID
注意：此字段可能返回 null，表示取不到有效值。
*/
Id?: string;
/**
* 调用时间
注意：此字段可能返回 null，表示取不到有效值。
*/
CallTime?: string;
/**
* 总token消耗
注意：此字段可能返回 null，表示取不到有效值。
*/
TotalTokenUsage?: number;
/**
* 输入token消耗
注意：此字段可能返回 null，表示取不到有效值。
*/
InputTokenUsage?: number;
/**
* 输出token消耗
注意：此字段可能返回 null，表示取不到有效值。
*/
OutputTokenUsage?: number;
/**
* 搜索服务调用次数
注意：此字段可能返回 null，表示取不到有效值。
*/
SearchUsage?: number;
/**
* 模型名称
注意：此字段可能返回 null，表示取不到有效值。
*/
ModelName?: string;
/**
* 调用类型
注意：此字段可能返回 null，表示取不到有效值。
*/
CallType?: string;
/**
* 账号
注意：此字段可能返回 null，表示取不到有效值。
*/
UinAccount?: string;
/**
* 应用名称
注意：此字段可能返回 null，表示取不到有效值。
*/
AppName?: string;
/**
* 总消耗页数
注意：此字段可能返回 null，表示取不到有效值。
*/
PageUsage?: number;
/**
* 筛选子场景
注意：此字段可能返回 null，表示取不到有效值。
*/
SubScene?: string;
}
/**
* ModifyRejectedQuestion返回参数结构体
*/
export interface ModifyRejectedQuestionResponse {
/**
* 唯一请求 ID，由服务端生成，每次请求都会返回（若请求因其他原因未能抵达服务端，则该次请求不会获得 RequestId）。定位问题时需要提供该次请求的 RequestId。
*/
RequestId?: string;
}
/**
* ListReleaseDocPreview请求参数结构体
*/
export interface ListReleaseDocPreviewRequest {
/**
* 应用ID
*/
BotBizId: string;
/**
* 页码
*/
PageNumber: number;
/**
* 每页数量
*/
PageSize: number;
/**
* 查询内容
*/
Query?: string;
/**
* 发布单ID
*/
ReleaseBizId?: string;
/**
* 开始时间
*/
StartTime?: string;
/**
* 结束时间
*/
EndTime?: string;
/**
* 状态(1新增2修改3删除)
*/
Actions?: Array<number | bigint>;
}
/**
* 当前执行的 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 数
注意：此字段可能返回 null，表示取不到有效值。
*/
TokenCount?: number;
/**
* 执行过程信息
注意：此字段可能返回 null，表示取不到有效值。
*/
Procedures?: Array<Procedure>;
/**
* 执行过程信息TraceId
注意：此字段可能返回 null，表示取不到有效值。
*/
TraceId?: string;
}
/**
* 文档片段
*/
export interface DocSegment {
/**
* 片段ID
注意：此字段可能返回 null，表示取不到有效值。
*/
Id?: string;
/**
* 业务ID
注意：此字段可能返回 null，表示取不到有效值。
*/
BusinessId?: string;
/**
* 文件类型(markdown,word,txt)
注意：此字段可能返回 null，表示取不到有效值。
*/
FileType?: string;
/**
* 文档切片类型(segment-文档切片 table-表格)
注意：此字段可能返回 null，表示取不到有效值。
*/
SegmentType?: string;
/**
* 标题
注意：此字段可能返回 null，表示取不到有效值。
*/
Title?: string;
/**
* 段落内容
注意：此字段可能返回 null，表示取不到有效值。
*/
PageContent?: string;
/**
* 段落原文
注意：此字段可能返回 null，表示取不到有效值。
*/
OrgData?: string;
/**
* 文章ID
注意：此字段可能返回 null，表示取不到有效值。
*/
DocId?: string;
/**
* 文档业务ID
注意：此字段可能返回 null，表示取不到有效值。
*/
DocBizId?: string;
/**
* 文档链接
注意：此字段可能返回 null，表示取不到有效值。
*/
DocUrl?: string;
}
/**
* 不满意回复
*/
export interface UnsatisfiedReply {
/**
* 不满意回复ID
注意：此字段可能返回 null，表示取不到有效值。
*/
ReplyBizId?: string;
/**
* 消息记录ID
注意：此字段可能返回 null，表示取不到有效值。
*/
RecordBizId?: string;
/**
* 用户问题
注意：此字段可能返回 null，表示取不到有效值。
*/
Question?: string;
/**
* 应用回复
注意：此字段可能返回 null，表示取不到有效值。
*/
Answer?: string;
/**
* 错误类型
注意：此字段可能返回 null，表示取不到有效值。
*/
Reasons?: Array<string>;
}
/**
* DescribeUnsatisfiedReplyContext返回参数结构体
*/
export interface DescribeUnsatisfiedReplyContextResponse {
/**
* 不满意回复上下文
注意：此字段可能返回 null，表示取不到有效值。
*/
List?: Array<Context>;
/**
* 唯一请求 ID，由服务端生成，每次请求都会返回（若请求因其他原因未能抵达服务端，则该次请求不会获得 RequestId）。定位问题时需要提供该次请求的 RequestId。
*/
RequestId?: string;
}
/**
* 一条message代表一条对话记录
role表示角色 user或者assistant
content表示对话内容
*/
export interface Message {
/**
* role表示角色 user标识用户提问，assistant标识返回的答案
注意：此字段可能返回 null，表示取不到有效值。
*/
Role: string;
/**
* 对话内容
注意：此字段可能返回 null，表示取不到有效值。
*/
Content: string;
}
/**
* CreateRejectedQuestion请求参数结构体
*/
export interface CreateRejectedQuestionRequest {
/**
* 应用ID
*/
BotBizId: string;
/**
* 拒答问题
*/
Question: string;
/**
* 拒答问题来源的数据源唯一id， - 拒答来源于不满意回复 2 - 拒答来源于手动添加
*/
BusinessSource: number;
/**
* 拒答问题来源的数据源唯一id
*/
BusinessId?: string;
}
/**
* DescribeKnowledgeUsagePieGraph请求参数结构体
*/
export interface DescribeKnowledgeUsagePieGraphRequest {
/**
* 应用ID数组
*/
AppBizIds?: Array<string>;
}
/**
* 标签详情
*/
export interface AttrLabelDetail {
/**
* 标签ID
注意：此字段可能返回 null，表示取不到有效值。
*/
AttrBizId?: string;
/**
* 标签标识
注意：此字段可能返回 null，表示取不到有效值。
*/
AttrKey?: string;
/**
* 标签名称
注意：此字段可能返回 null，表示取不到有效值。
*/
AttrName?: string;
/**
* 标签值名称
注意：此字段可能返回 null，表示取不到有效值。
*/
LabelNames?: Array<string>;
/**
* 标签是否在更新中
注意：此字段可能返回 null，表示取不到有效值。
*/
IsUpdating?: boolean;
/**
* 状态
注意：此字段可能返回 null，表示取不到有效值。
*/
Status?: number;
/**
* 状态描述
注意：此字段可能返回 null，表示取不到有效值。
*/
StatusDesc?: string;
}
/**
* DescribeRefer返回参数结构体
*/
export interface DescribeReferResponse {
/**
* 引用列表
*/
List?: Array<ReferDetail>;
/**
* 唯一请求 ID，由服务端生成，每次请求都会返回（若请求因其他原因未能抵达服务端，则该次请求不会获得 RequestId）。定位问题时需要提供该次请求的 RequestId。
*/
RequestId?: string;
}
/**
* 获取不满意回复上下文响
*/
export interface Context {
/**
* 消息记录ID信息
注意：此字段可能返回 null，表示取不到有效值。
*/
RecordBizId?: string;
/**
* 是否为用户
注意：此字段可能返回 null，表示取不到有效值。
*/
IsVisitor?: boolean;
/**
* 昵称
注意：此字段可能返回 null，表示取不到有效值。
*/
NickName?: string;
/**
* 头像
注意：此字段可能返回 null，表示取不到有效值。
*/
Avatar?: string;
/**
* 消息内容
注意：此字段可能返回 null，表示取不到有效值。
*/
Content?: string;
/**
* 文档信息
注意：此字段可能返回 null，表示取不到有效值。
*/
FileInfos?: Array<MsgFileInfo>;
/**
* 回复方式，15：澄清确认回复
注意：此字段可能返回 null，表示取不到有效值。
*/
ReplyMethod?: number;
}
/**
* ListDoc请求参数结构体
*/
export interface ListDocRequest {
/**
* 应用ID
*/
BotBizId: string;
/**
* 页码
*/
PageNumber: number;
/**
* 每页数量
*/
PageSize: number;
/**
* 查询内容
*/
Query?: string;
/**
* 文档状态： 1-未生成 2-生成中 3-生成成功 4-生成失败 5-删除中 6-删除成功 7-审核中 8-审核失败 9-审核成功 10-待发布 11-发布中 12-已发布 13-学习中 14-学习失败 15-更新中 16-更新失败 17-解析中 18-解析失败 19-导入失败 20-已过期 21-超量失效 22-超量失效恢复
*/
Status?: Array<number | bigint>;
/**
* 查询类型 filename 文档、 attribute 标签
*/
QueryType?: string;
/**
* 分类ID
*/
CateBizId?: string;
}
/**
* ReconstructDocument请求参数结构体
*/
export interface ReconstructDocumentRequest {
/**
* 文件的 Base64 值。 支持的文件格式：PNG、JPG、JPEG、PDF。 支持的文件大小：所下载文件经Base64编码后不超过 8M。文件下载时间不超过 3 秒。 支持的图片像素：单边介于20-10000px之间。 文件的 FileUrl、FileBase64 必须提供一个，如果都提供，只使用 FileUrl。
*/
FileBase64?: string;
/**
* 文件的 Url 地址。 支持的文件格式：PNG、JPG、JPEG、PDF。 支持的文件大小：所下载文件经 Base64 编码后不超过 8M。文件下载时间不超过 3 秒。 支持的图片像素：单边介于20-10000px之间。 文件存储于腾讯云的 Url 可保障更高的下载速度和稳定性，建议文件存储于腾讯云。 非腾讯云存储的 Url 速度和稳定性可能受一定影响。
*/
FileUrl?: string;
/**
* 当传入文件是PDF类型时，用来指定pdf识别的起始页码，识别的页码包含当前值。默认为1，表示从pdf文件的第1页开始识别。
*/
FileStartPageNumber?: number;
/**
* 当传入文件是PDF类型时，用来指定pdf识别的结束页码，识别的页码包含当前值。默认为10，表示识别到pdf文件的第10页。单次调用最多支持识别10页内容，即FileEndPageNumber-FileStartPageNumber需要不大于10。
*/
FileEndPageNumber?: number;
/**
* 配置选项，支持配置是否在生成的Markdown中是否嵌入图片
*/
Config?: ReconstructDocumentConfig;
}
/**
* GetEmbedding请求参数结构体
*/
export interface GetEmbeddingRequest {
/**
* 模型名称
*/
Model: string;
/**
* 需要 embedding 的文本, 单条文本最大长度500个字符, 总条数最大7条
*/
Inputs: Array<string>;
/**
* 是否在线, 后台异步任务使用离线, 实时任务使用在线, 默认值: false
*/
Online?: boolean;
}
/**
* GroupQA请求参数结构体
*/
export interface GroupQARequest {
/**
* 应用ID
*/
BotBizId: string;
/**
* QaBizID列表
*/
QaBizIds: Array<string>;
/**
* 分组 ID
*/
CateBizId: string;
}
/**
* RateMsgRecord请求参数结构体
*/
export interface RateMsgRecordRequest {
/**
* 应用appKey
*/
BotAppKey: string;
/**
* 消息ID
*/
RecordId: string;
/**
* 1点赞2点踩
*/
Score: number;
/**
* 原因
*/
Reasons?: Array<string>;
}
/**
* DescribeCallStatsGraph请求参数结构体
*/
export interface DescribeCallStatsGraphRequest {
/**
* uin
*/
UinAccount?: Array<string>;
/**
* 登录用户主账号(集成商模式必填)
*/
LoginUin?: string;
/**
* 登录用户子账号(集成商模式必填)
*/
LoginSubAccountUin?: string;
/**
* 子业务类型
*/
SubBizType?: string;
/**
* 模型标识
*/
ModelName?: string;
/**
* 开始时间戳, 单位为秒
*/
StartTime?: string;
/**
* 结束时间戳, 单位为秒
*/
EndTime?: string;
/**
* 应用id列表
*/
AppBizIds?: Array<string>;
/**
* 筛选子场景(文档解析场景使用)
*/
SubScenes?: Array<string>;
}
/**
* GetMsgRecord返回参数结构体
*/
export interface GetMsgRecordResponse {
/**
* 会话记录
*/
Records?: Array<MsgRecord>;
/**
* session 清除关联上下文时间, 单位 ms
注意：此字段可能返回 null，表示取不到有效值。
*/
SessionDisassociatedTimestamp?: string;
/**
* 唯一请求 ID，由服务端生成，每次请求都会返回（若请求因其他原因未能抵达服务端，则该次请求不会获得 RequestId）。定位问题时需要提供该次请求的 RequestId。
*/
RequestId?: string;
}
/**
* DescribeApp请求参数结构体
*/
export interface DescribeAppRequest {
/**
* 应用ID
*/
AppBizId: string;
/**
* 应用类型；knowledge_qa-知识问答管理；summary-知识摘要；classifys-知识标签提取
*/
AppType?: string;
/**
* 是否发布后的配置
*/
IsRelease?: boolean;
}
/**
* GetReconstructDocumentResult请求参数结构体
*/
export interface GetReconstructDocumentResultRequest {
/**
* 任务唯一Id。[CreateReconstructDocumentFlow](https://cloud.tencent.com/document/product/1759/107506) 返回的TaskId。
*/
TaskId: string;
}
/**
* DescribeKnowledgeUsage请求参数结构体
*/
export declare type DescribeKnowledgeUsageRequest = null;
/**
* ListQA返回参数结构体
*/
export interface ListQAResponse {
/**
* 问答数量
*/
Total?: string;
/**
* 待校验问答数量
*/
WaitVerifyTotal?: string;
/**
* 未采纳问答数量
*/
NotAcceptedTotal?: string;
/**
* 已采纳问答数量
*/
AcceptedTotal?: string;
/**
* 页码
*/
PageNumber?: number;
/**
* 问答详情
*/
List?: Array<ListQaItem>;
/**
* 唯一请求 ID，由服务端生成，每次请求都会返回（若请求因其他原因未能抵达服务端，则该次请求不会获得 RequestId）。定位问题时需要提供该次请求的 RequestId。
*/
RequestId?: string;
}
/**
* IgnoreUnsatisfiedReply请求参数结构体
*/
export interface IgnoreUnsatisfiedReplyRequest {
/**
* 应用ID
*/
BotBizId: string;
/**
* 不满意回复ID
*/
ReplyBizIds: Array<string>;
/**
* 登录用户主账号(集成商模式必填)
*/
LoginUin?: string;
/**
* 登录用户子账号(集成商模式必填)
*/
LoginSubAccountUin?: string;
}
/**
* DescribeRelease返回参数结构体
*/
export interface DescribeReleaseResponse {
/**
* 创建时间
*/
CreateTime?: string;
/**
* 发布描述
*/
Description?: string;
/**
* 发布状态(1待发布 2发布中 3发布成功 4发布失败 5发布中(审核中) 6发布中(审核完成) 7发布失败(审核失败) 9发布暂停)
*/
Status?: number;
/**
* 发布状态描述
*/
StatusDesc?: string;
/**
* 唯一请求 ID，由服务端生成，每次请求都会返回（若请求因其他原因未能抵达服务端，则该次请求不会获得 RequestId）。定位问题时需要提供该次请求的 RequestId。
*/
RequestId?: string;
}
/**
* DescribeConcurrencyUsageGraph返回参数结构体
*/
export interface DescribeConcurrencyUsageGraphResponse {
/**
* X轴: 时间区域；根据查询条件的粒度返回“分/小时/日”两种区间范围
*/
X?: Array<string>;
/**
* 可用并发y轴坐标
*/
AvailableY?: Array<number | bigint>;
/**
* 成功调用并发y轴坐标
*/
SuccessCallY?: Array<number | bigint>;
/**
* 唯一请求 ID，由服务端生成，每次请求都会返回（若请求因其他原因未能抵达服务端，则该次请求不会获得 RequestId）。定位问题时需要提供该次请求的 RequestId。
*/
RequestId?: 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;
}
/**
* VerifyQA请求参数结构体
*/
export interface VerifyQARequest {
/**
* 问答列表
*/
List: Array<QAList>;
/**
* 应用ID
*/
BotBizId: string;
/**
* 登录用户主账号(集成商模式必填)
*/
LoginUin?: string;
/**
* 登录用户子账号(集成商模式必填)
*/
LoginSubAccountUin?: string;
}
/**
* 文本的坐标，以四个顶点坐标表示
注意：此字段可能返回 null，表示取不到有效值
*/
export interface Polygon {
/**
* 左上顶点坐标
*/
LeftTop?: Coord;
/**
* 右上顶点坐标
*/
RightTop?: Coord;
/**
* 右下顶点坐标
*/
RightBottom?: Coord;
/**
* 左下顶点坐标
*/
LeftBottom?: Coord;
}
/**
* 应用模型配置
*/
export interface AppModel {
/**
* 模型名称
注意：此字段可能返回 null，表示取不到有效值。
*/
Name?: string;
/**
* 模型描述
注意：此字段可能返回 null，表示取不到有效值。
*/
Desc?: string;
/**
* 上下文指代轮次
注意：此字段可能返回 null，表示取不到有效值。
*/
ContextLimit?: number;
/**
* 模型别名
注意：此字段可能返回 null，表示取不到有效值。
*/
AliasName?: string;
/**
* token余量
注意：此字段可能返回 null，表示取不到有效值。
*/
TokenBalance?: number;
/**
* 是否使用上下文指代轮次
注意：此字段可能返回 null，表示取不到有效值。
*/
IsUseContext?: boolean;
/**
* 上下文记忆轮数
注意：此字段可能返回 null，表示取不到有效值。
*/
HistoryLimit?: number;
/**
* 使用类型
注意：此字段可能返回 null，表示取不到有效值。
*/
UsageType?: string;
/**
* 模型温度
注意：此字段可能返回 null，表示取不到有效值。
*/
Temperature?: string;
/**
* 模型TopP
注意：此字段可能返回 null，表示取不到有效值。
*/
TopP?: string;
/**
* 模型资源状态 1：资源可用；2：资源已用尽
注意：此字段可能返回 null，表示取不到有效值。
*/
ResourceStatus?: number;
}
/**
* 计费统计信息
*/
export interface Stat {
/**
* X轴: 时间区域；根据查询条件的粒度返回“分/小时/日”三种区间范围
注意：此字段可能返回 null，表示取不到有效值。
*/
X?: string;
/**
* Y轴: 该时间区域内的统计值，如token消耗量，调用次数或使用量等信息
注意：此字段可能返回 null，表示取不到有效值。
*/
Y?: number;
}
/**
* DescribeKnowledgeUsagePieGraph返回参数结构体
*/
export interface DescribeKnowledgeUsagePieGraphResponse {
/**
* 所有应用已用的字符总数
*/
AvailableCharSize?: string;
/**
* 应用饼图详情列表
*/
List?: Array<KnowledgeCapacityPieGraphDetail>;
/**
* 唯一请求 ID，由服务端生成，每次请求都会返回（若请求因其他原因未能抵达服务端，则该次请求不会获得 RequestId）。定位问题时需要提供该次请求的 RequestId。
*/
RequestId?: string;
}
/**
* 标签信息
*/
export interface ClassifyLabel {
/**
* 标签名称
注意：此字段可能返回 null，表示取不到有效值。
*/
Name?: string;
/**
* 标签描述
注意：此字段可能返回 null，表示取不到有效值。
*/
Description?: string;
/**
* 标签取值范围
注意：此字段可能返回 null，表示取不到有效值。
*/
Values?: Array<string>;
}
/**
* ListReleaseQAPreview返回参数结构体
*/
export interface ListReleaseQAPreviewResponse {
/**
* 文档数量
*/
Total?: string;
/**
* 文档列表
*/
List?: Array<ReleaseQA>;
/**
* 唯一请求 ID，由服务端生成，每次请求都会返回（若请求因其他原因未能抵达服务端，则该次请求不会获得 RequestId）。定位问题时需要提供该次请求的 RequestId。
*/
RequestId?: string;
}
/**
* DescribeTokenUsageGraph返回参数结构体
*/
export interface DescribeTokenUsageGraphResponse {
/**
* Token消耗总量
*/
Total?: Array<Stat>;
/**
* 输入Token消耗量
*/
Input?: Array<Stat>;
/**
* 输出Token消耗量
*/
Output?: Array<Stat>;
/**
* 唯一请求 ID，由服务端生成，每次请求都会返回（若请求因其他原因未能抵达服务端，则该次请求不会获得 RequestId）。定位问题时需要提供该次请求的 RequestId。
*/
RequestId?: string;
}
/**
* 相似问修改(更新)信息
*/
export interface SimilarQuestionModify {
/**
* 需要添加的相似问(内容)列表
*/
AddQuestions?: Array<string>;
/**
* 需要更新的相似问列表
*/
UpdateQuestions?: Array<SimilarQuestion>;
/**
* 需要删除的相似问列表
*/
DeleteQuestions?: Array<SimilarQuestion>;
}
/**
* 工作流运行节点信息
*/
export interface WorkflowRunNodeInfo {
/**
* 节点ID
注意：此字段可能返回 null，表示取不到有效值。
*/
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?: Array<StatisticInfo>;
}
/**
* 大模型token统计信息
*/
export interface StatisticInfo {
/**
* 模型名称
注意：此字段可能返回 null，表示取不到有效值。
*/
ModelName?: string;
/**
* 首Token耗时
注意：此字段可能返回 null，表示取不到有效值。
*/
FirstTokenCost?: number;
/**
* 总耗时
注意：此字段可能返回 null，表示取不到有效值。
*/
TotalCost?: number;
/**
* 输入Token数量
注意：此字段可能返回 null，表示取不到有效值。
*/
InputTokens?: number;
/**
* 输出Token数量
注意：此字段可能返回 null，表示取不到有效值。
*/
OutputTokens?: number;
/**
* 总Token数量
注意：此字段可能返回 null，表示取不到有效值。
*/
TotalTokens?: number;
}
/**
* RetryDocAudit返回参数结构体
*/
export interface RetryDocAuditResponse {
/**
* 唯一请求 ID，由服务端生成，每次请求都会返回（若请求因其他原因未能抵达服务端，则该次请求不会获得 RequestId）。定位问题时需要提供该次请求的 RequestId。
*/
RequestId?: string;
}
/**
* GetReconstructDocumentResult返回参数结构体
*/
export interface GetReconstructDocumentResultResponse {
/**
* 任务状态: Success->执行完成；Processing->执行中；Failed->执行失败；WaitExecute->等待执行。
*/
Status?: string;
/**
* 本次文档解析的结果文件，存储在腾讯云COS的下载URL，下载URL的有效期为10分钟。
*/
DocumentRecognizeResultUrl?: string;
/**
* 本次文档解析失败的页码信息。
*/
FailedPages?: Array<ReconstructDocumentFailedPage>;
/**
* 唯一请求 ID，由服务端生成，每次请求都会返回（若请求因其他原因未能抵达服务端，则该次请求不会获得 RequestId）。定位问题时需要提供该次请求的 RequestId。
*/
RequestId?: string;
}
/**
* ModifyDocCate请求参数结构体
*/
export interface ModifyDocCateRequest {
/**
* 应用ID
*/
BotBizId: string;
/**
* 分类名称
*/
Name: string;
/**
* 分类业务ID
*/
CateBizId: string;
}
/**
* 发布拒答
*/
export interface RejectedQuestion {
/**
* 拒答问题ID
注意：此字段可能返回 null，表示取不到有效值。
*/
RejectedBizId?: string;
/**
* 被拒答的问题
注意：此字段可能返回 null，表示取不到有效值。
*/
Question?: string;
/**
* 状态
注意：此字段可能返回 null，表示取不到有效值。
*/
Status?: number;
/**
* 状态描述
注意：此字段可能返回 null，表示取不到有效值。
*/
StatusDesc?: string;
/**
* 更新时间
注意：此字段可能返回 null，表示取不到有效值。
*/
UpdateTime?: string;
/**
* 是否允许编辑
注意：此字段可能返回 null，表示取不到有效值。
*/
IsAllowEdit?: boolean;
/**
* 是否允许删除
注意：此字段可能返回 null，表示取不到有效值。
*/
IsAllowDelete?: boolean;
}
/**
* GetLikeDataCount请求参数结构体
*/
export interface GetLikeDataCountRequest {
/**
* 开始日期
*/
StartTime: number;
/**
* 结束日期
*/
EndTime: number;
/**
* 应用id
*/
AppBizId?: Array<string>;
/**
* 消息来源(1、分享用户端 2、对话API)
*/
Type?: number;
/**
* 登录用户主账号(集成商模式必填)
*/
LoginUin?: string;
/**
* 登录用户子账号(集成商模式必填)
*/
LoginSubAccountUin?: string;
}
/**
* DeleteRejectedQuestion返回参数结构体
*/
export interface DeleteRejectedQuestionResponse {
/**
* 唯一请求 ID，由服务端生成，每次请求都会返回（若请求因其他原因未能抵达服务端，则该次请求不会获得 RequestId）。定位问题时需要提供该次请求的 RequestId。
*/
RequestId?: string;
}
/**
* 临时密钥结构
*/
export interface Credentials {
/**
* token
注意：此字段可能返回 null，表示取不到有效值。
*/
Token?: string;
/**
* 临时证书密钥ID
注意：此字段可能返回 null，表示取不到有效值。
*/
TmpSecretId?: string;
/**
* 临时证书密钥Key
注意：此字段可能返回 null，表示取不到有效值。
*/
TmpSecretKey?: string;
}
/**
* 文档信息
*/
export interface MsgFileInfo {
/**
* 文档名称
注意：此字段可能返回 null，表示取不到有效值。
*/
FileName?: string;
/**
* 文档大小
注意：此字段可能返回 null，表示取不到有效值。
*/
FileSize?: string;
/**
* 文档URL
注意：此字段可能返回 null，表示取不到有效值。
*/
FileUrl?: string;
/**
* 文档类型
注意：此字段可能返回 null，表示取不到有效值。
*/
FileType?: string;
/**
* 文档ID
注意：此字段可能返回 null，表示取不到有效值。
*/
DocId?: string;
}
/**
* CreateAttributeLabel请求参数结构体
*/
export interface CreateAttributeLabelRequest {
/**
* 应用ID
*/
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 AppInfo {
/**
* 应用类型；knowledge_qa-知识问答管理；summary-知识摘要；classifys-知识标签提取
注意：此字段可能返回 null，表示取不到有效值。
*/
AppType?: string;
/**
* 应用类型描述
注意：此字段可能返回 null，表示取不到有效值。
*/
AppTypeDesc?: string;
/**
* 应用ID
注意：此字段可能返回 null，表示取不到有效值。
*/
AppBizId?: string;
/**
* 应用名称
注意：此字段可能返回 null，表示取不到有效值。
*/
Name?: string;
/**
* 应用头像
注意：此字段可能返回 null，表示取不到有效值。
*/
Avatar?: string;
/**
* 应用描述
注意：此字段可能返回 null，表示取不到有效值。
*/
Desc?: string;
/**
* 应用状态，1：未上线，2：运行中，3：停用
注意：此字段可能返回 null，表示取不到有效值。
*/
AppStatus?: number;
/**
* 状态说明
注意：此字段可能返回 null，表示取不到有效值。
*/
AppStatusDesc?: string;
/**
* 修改时间
注意：此字段可能返回 null，表示取不到有效值。
*/
UpdateTime?: string;
/**
* 最后修改人
注意：此字段可能返回 null，表示取不到有效值。
*/
Operator?: string;
/**
* 模型名称
注意：此字段可能返回 null，表示取不到有效值。
*/
ModelName?: string;
/**
* 生成模型别名
注意：此字段可能返回 null，表示取不到有效值。
*/
ModelAliasName?: string;
/**
* 应用模式 standard:标准模式, agent: agent模式，single_workflow：单工作流模式
注意：此字段可能返回 null，表示取不到有效值。
*/
Pattern?: string;
/**
* 思考模型别名
注意：此字段可能返回 null，表示取不到有效值。
*/
ThoughtModelAliasName?: string;
}
/**
* 分类信息
*/
export interface CateInfo {
/**
* 分类ID
注意：此字段可能返回 null，表示取不到有效值。
*/
CateBizId?: string;
/**
* 分类名称
注意：此字段可能返回 null，表示取不到有效值。
*/
Name?: string;
/**
* 分类下的Record（如文档、同义词等）数量
注意：此字段可能返回 null，表示取不到有效值。
*/
Total?: number;
/**
* 是否可新增
注意：此字段可能返回 null，表示取不到有效值。
*/
CanAdd?: boolean;
/**
* 是否可编辑
注意：此字段可能返回 null，表示取不到有效值。
*/
CanEdit?: boolean;
/**
* 是否可删除
注意：此字段可能返回 null，表示取不到有效值。
*/
CanDelete?: boolean;
/**
* 子分类
注意：此字段可能返回 null，表示取不到有效值。
*/
Children?: Array<CateInfo>;
}
/**
* CreateReconstructDocumentFlow请求参数结构体
*/
export interface CreateReconstructDocumentFlowRequest {
/**
* 文件类型。支持的文件类型：PDF、DOC、DOCX、PPT、PPTX、MD、TXT、XLS、XLSX、CSV、PNG、JPG、JPEG、BMP、GIF、WEBP、HEIC、EPS、ICNS、IM、PCX、PPM、TIFF、XBM、HEIF、JP2。
*/
FileType?: string;
/**
* 文件的 Base64 值。支持的文件大小：所下载文件经Base64编码后不超过 8M。文件下载时间不超过 3 秒。支持的图片像素：单边介于20-10000px之间。文件的 FileUrl、FileBase64 必须提供一个，如果都提供，只使用 FileUrl。
*/
FileBase64?: string;
/**
* <p>文件的Url地址。文件下载时间不超过15秒。支持的图片像素：单边介于20-10000px之间。文件存储于腾讯云的Url可保障更高的下载速度和稳定性，建议文件存储于腾讯云。非腾讯云存储的 Url 速度和稳定性可能受一定影响。所下载文件经 Base64 编码后不超过支持的文件大小：</p><table> <tbody> <tr> <td>文件类型</td> <td>支持的文件大小</td> </tr> <tr> <td>PDF</td> <td>200M</td> </tr> <tr> <td>DOC</td> <td>200M</td> </tr> <tr> <td>DOCX</td> <td>200M</td> </tr> <tr> <td>PPT</td> <td>200M</td> </tr> <tr> <td>PPTX</td> <td>200M</td> </tr> <tr> <td>MD</td> <td>10M</td> </tr> <tr> <td>TXT</td> <td>10M</td> </tr> <tr> <td>XLS</td> <td>20M</td> </tr> <tr> <td>XLSX</td> <td>20M</td> </tr> <tr> <td>CSV</td> <td>20M</td> </tr> <tr> <td>PNG</td> <td>20M</td> </tr> <tr> <td>JPG</td> <td>20M</td> </tr> <tr> <td>JPEG</td> <td>20M</td> </tr> <tr> <td>BMP</td> <td>20M</td> </tr> <tr> <td>GIF</td> <td>20M</td> </tr> <tr> <td>WEBP</td> <td>20M</td> </tr> <tr> <td>HEIC</td> <td>20M</td> </tr> <tr> <td>EPS</td> <td>20M</td> </tr> <tr> <td>ICNS</td> <td>20M</td> </tr> <tr> <td>IM</td> <td>20M</td> </tr> <tr> <td>PCX</td> <td>20M</td> </tr> <tr> <td>PPM</td> <td>20M</td> </tr> <tr> <td>TIFF</td> <td>20M</td> </tr> <tr> <td>XBM</td> <td>20M</td> </tr> <tr> <td>HEIF</td> <td>20M</td> </tr> <tr> <td>JP2</td> <td>20M</td> </tr> </tbody> <colgroup> <col> <col> </colgroup></table>
*/
FileUrl?: string;
/**
* 当传入文件类型为PDF、DOC、DOCX、PPT、PPTX，用来指定文件识别的起始页码，识别的页码包含当前值。默认为1，表示从文件的第1页开始识别。
*/
FileStartPageNumber?: number;
/**
* 当传入文件类型为PDF、DOC、DOCX、PPT、PPTX，用来指定文件识别的结束页码，识别的页码包含当前值。默认为100，表示识别到文件的第100页。单次调用最多支持识别1000页内容，即FileEndPageNumber-FileStartPageNumber需要不大于1000。
*/
FileEndPageNumber?: number;
/**
* 创建文档解析任务配置信息。
*/
Config?: CreateReconstructDocumentFlowConfig;
}
/**
* RunReRank返回参数结构体
*/
export interface RunReRankResponse {
/**
* 相关性, 数值越大越相关
*/
ScoreList?: Array<number>;
/**
* 消耗量，仅返回TotalToken
*/
Usage?: Usage;
/**
* 唯一请求 ID，由服务端生成，每次请求都会返回（若请求因其他原因未能抵达服务端，则该次请求不会获得 RequestId）。定位问题时需要提供该次请求的 RequestId。
*/
RequestId?: string;
}
/**
* 调试信息
*/
export interface ProcedureDebugging {
/**
* 检索query
注意：此字段可能返回 null，表示取不到有效值。
*/
Content?: string;
/**
* 系统prompt
注意：此字段可能返回 null，表示取不到有效值。
*/
System?: string;
/**
* 多轮历史信息
注意：此字段可能返回 null，表示取不到有效值。
*/
Histories?: Array<HistorySummary>;
/**
* 检索知识
注意：此字段可能返回 null，表示取不到有效值。
*/
Knowledge?: Array<KnowledgeSummary>;
/**
* 任务流程
注意：此字段可能返回 null，表示取不到有效值。
*/
TaskFlow?: TaskFlowSummary;
/**
* 工作流调试信息
注意：此字段可能返回 null，表示取不到有效值。
*/
WorkFlow?: WorkFlowSummary;
}
/**
* 知识问答配置
*/
export interface KnowledgeQaConfig {
/**
* 欢迎语，200字符以内
注意：此字段可能返回 null，表示取不到有效值。
*/
Greeting?: string;
/**
* 角色描述，300字符以内
注意：此字段可能返回 null，表示取不到有效值。
*/
RoleDescription?: string;
/**
* 生成模型配置
注意：此字段可能返回 null，表示取不到有效值。
*/
Model?: AppModel;
/**
* 知识搜索配置
注意：此字段可能返回 null，表示取不到有效值。
*/
Search?: Array<KnowledgeQaSearch>;
/**
* 知识管理输出配置
注意：此字段可能返回 null，表示取不到有效值。
*/
Output?: KnowledgeQaOutput;
/**
* 工作流程配置
注意：此字段可能返回 null，表示取不到有效值。
*/
Workflow?: KnowledgeWorkflow;
/**
* 检索范围
注意：此字段可能返回 null，表示取不到有效值。
*/
SearchRange?: SearchRange;
/**
* 应用模式，standard:标准模式, agent: agent模式，single_workflow：单工作流模式
注意：此字段可能返回 null，表示取不到有效值。
*/
Pattern?: string;
/**
* 检索策略
注意：此字段可能返回 null，表示取不到有效值。
*/
SearchStrategy?: SearchStrategy;
/**
* 单工作流ID，Pattern为single_workflow时传入
注意：此字段可能返回 null，表示取不到有效值。
*/
SingleWorkflow?: KnowledgeQaSingleWorkflow;
/**
* 应用关联插件
注意：此字段可能返回 null，表示取不到有效值。
*/
Plugins?: Array<KnowledgeQaPlugin>;
/**
* 思考模型配置
注意：此字段可能返回 null，表示取不到有效值。
*/
ThoughtModel?: AppModel;
}
/**
* 坐标
*/
export interface Coord {
/**
* 横坐标
*/
X?: number;
/**
* 纵坐标
*/
Y?: number;
}
/**
* 聊天详情Refer
*/
export interface MsgRecordReference {
/**
* id
*/
Id?: string;
/**
* 链接
*/
Url?: string;
/**
* 类型
*/
Type?: number;
/**
* 名称
*/
Name?: string;
/**
* 来源文档ID
*/
DocId?: string;
}
/**
* ListRejectedQuestionPreview请求参数结构体
*/
export interface ListRejectedQuestionPreviewRequest {
/**
* 应用ID
*/
BotBizId: string;
/**
* 页码
*/
PageNumber: number;
/**
* 每页数量
*/
PageSize: number;
/**
* 查询内容
*/
Query?: string;
/**
* 发布单ID
*/
ReleaseBizId?: string;
/**
* 状态(1新增2更新3删除)
*/
Actions?: Array<number | bigint>;
/**
* 开始时间
*/
StartTime?: string;
/**
* 结束时间
*/
EndTime?: string;
}
/**
* ListReleaseConfigPreview返回参数结构体
*/
export interface ListReleaseConfigPreviewResponse {
/**
* 数量
*/
Total?: string;
/**
* 配置项列表
*/
List?: Array<ReleaseConfigs>;
/**
* 唯一请求 ID，由服务端生成，每次请求都会返回（若请求因其他原因未能抵达服务端，则该次请求不会获得 RequestId）。定位问题时需要提供该次请求的 RequestId。
*/
RequestId?: string;
}
/**
* 模型信息
*/
export interface ModelInfo {
/**
* 模型名称
注意：此字段可能返回 null，表示取不到有效值。
*/
ModelName?: string;
/**
* 模型描述
注意：此字段可能返回 null，表示取不到有效值。
*/
ModelDesc?: string;
/**
* 模型名称
注意：此字段可能返回 null，表示取不到有效值。
*/
AliasName?: string;
/**
* 资源状态 1：资源可用；2：资源已用尽
注意：此字段可能返回 null，表示取不到有效值。
*/
ResourceStatus?: number;
/**
* 提示词内容字符限制
注意：此字段可能返回 null，表示取不到有效值。
*/
PromptWordsLimit?: string;
/**
* 通过核心采样控制内容生成的多样性，较高的Top P值会导致生成更多样的内容
注意：此字段可能返回 null，表示取不到有效值。
*/
TopP?: ModelParameter;
/**
* 温度控制随机性
注意：此字段可能返回 null，表示取不到有效值。
*/
Temperature?: ModelParameter;
/**
* 最多能生成的token数量
注意：此字段可能返回 null，表示取不到有效值。
*/
MaxTokens?: ModelParameter;
/**
* 模型来源 Hunyuan：腾讯混元大模型,Industry：腾讯云行业大模型,Experience：新模型体验,Custom自定义模型
*/
Source?: string;
/**
* 模型图标
*/
Icon?: string;
/**
* 是否免费
*/
IsFree?: boolean;
/**
* 模型对话框可输入的上限
注意：此字段可能返回 null，表示取不到有效值。
*/
InputLenLimit?: number;
/**
* 支持工作流的类型 0:模型不支持; 1: 模型支持工作流； 2： 模型支持效果不佳；
注意：此字段可能返回 null，表示取不到有效值。
*/
SupportWorkflowStatus?: number;
/**
* 模型类别 generate：生成模型，thought：思考模型
*/
ModelCategory?: string;
}
/**
* DeleteRejectedQuestion请求参数结构体
*/
export interface DeleteRejectedQuestionRequest {
/**
* 应用ID
*/
BotBizId: string;
/**
* 拒答问题来源的数据源唯一id
*/
RejectedBizIds: Array<string>;
}
/**
* 分片高亮内容
*/
export interface Highlight {
/**
* 高亮起始位置
注意：此字段可能返回 null，表示取不到有效值。
*/
StartPos?: string;
/**
* 高亮结束位置
注意：此字段可能返回 null，表示取不到有效值。
*/
EndPos?: string;
/**
* 高亮子文本
注意：此字段可能返回 null，表示取不到有效值。
*/
Text?: string;
}
/**
* 实时上传的文件信息
*/
export interface FileInfo {
/**
* 文件名称
注意：此字段可能返回 null，表示取不到有效值。
*/
FileName?: string;
/**
* 文件大小
注意：此字段可能返回 null，表示取不到有效值。
*/
FileSize?: string;
/**
* 文件的URL地址，COS地址
注意：此字段可能返回 null，表示取不到有效值。
*/
FileUrl?: string;
/**
* 文件类型
注意：此字段可能返回 null，表示取不到有效值。
*/
FileType?: string;
/**
* 解析后返回的DocID
注意：此字段可能返回 null，表示取不到有效值。
*/
DocId?: string;
}
/**
* ExportQAList请求参数结构体
*/
export interface ExportQAListRequest {
/**
* 应用ID
*/
BotBizId: string;
/**
* QA业务ID
*/
QaBizIds: Array<string>;
/**
* 查询参数
*/
Filters?: QAQuery;
}
/**
* GetDocPreview返回参数结构体
*/
export interface GetDocPreviewResponse {
/**
* 文件名, 发布端固定使用这个名称
*/
FileName?: string;
/**
* 文件类型
*/
FileType?: string;
/**
* cos路径
*/
CosUrl?: string;
/**
* cos临时地址
*/
Url?: string;
/**
* cos桶
*/
Bucket?: string;
/**
* 存在文档重命名情况下的新名称, 评测端优先使用这个名称
*/
NewName?: string;
/**
* 唯一请求 ID，由服务端生成，每次请求都会返回（若请求因其他原因未能抵达服务端，则该次请求不会获得 RequestId）。定位问题时需要提供该次请求的 RequestId。
*/
RequestId?: string;
}
/**
* DescribeConcurrencyUsage返回参数结构体
*/
export interface DescribeConcurrencyUsageResponse {
/**
* 可用并发数上限
*/
AvailableConcurrency?: number;
/**
* 并发峰值
*/
ConcurrencyPeak?: number;
/**
* 超出可用并发数上限的次数
*/
ExceedUsageTime?: number;
/**
* 唯一请求 ID，由服务端生成，每次请求都会返回（若请求因其他原因未能抵达服务端，则该次请求不会获得 RequestId）。定位问题时需要提供该次请求的 RequestId。
*/
RequestId?: string;
}
/**
* 变量详情
*/
export interface TaskFLowVar {
/**
* 变量ID
注意：此字段可能返回 null，表示取不到有效值。
*/
VarId?: string;
/**
* 变量名称
注意：此字段可能返回 null，表示取不到有效值。
*/
VarName?: string;
/**
* 变量描述（默认为"-"）
*/
VarDesc?: string;
/**
* 变量类型 (STRING,INT,FLOAT,BOOL,OBJECT,ARRAY_STRING,ARRAY_INT,ARRAY_FLOAT,ARRAY_BOOL,ARRAY_OBJECT,FILE,DOCUMENT,IMAGE,AUDIO)
*/
VarType?: string;
}
/**
* CreateRelease返回参数结构体
*/
export interface CreateReleaseResponse {
/**
* 发布ID
*/
ReleaseBizId?: string;
/**
* 唯一请求 ID，由服务端生成，每次请求都会返回（若请求因其他原因未能抵达服务端，则该次请求不会获得 RequestId）。定位问题时需要提供该次请求的 RequestId。
*/
RequestId?: string;
}
/**
* QueryRewrite请求参数结构体
*/
export interface QueryRewriteRequest {
/**
* 需要改写的问题
*/
Question: string;
/**
* 需要改写的多轮历史会话
*/
Messages: Array<Message>;
/**
* 模型名称
*/
Model?: string;
}
/**
* ModifyApp请求参数结构体
*/
export interface ModifyAppRequest {
/**
* 应用 ID
*/
AppBizId: string;
/**
* 应用类型；knowledge_qa-知识问答管理；summary-知识摘要；classifys-知识标签提取
*/
AppType: string;
/**
* 应用基础配置
*/
BaseConfig: BaseConfig;
/**
* 应用配置
*/
AppConfig: AppConfig;
/**
* 登录用户子账号(集成商模式必填)
*/
LoginSubAccountUin?: string;
}
/**
* RunReRank请求参数结构体
*/
export interface RunReRankRequest {
/**
* 查询内容，必填
*/
Query?: string;
/**
* 文档列表，必填，最多20个
*/
Docs?: Array<string>;
/**
* 模型名称, 非必填，默认: lke-reranker-base
*/
Model?: string;
/**
* 需要计算关联性的2段内容
* @deprecated
*/
DataList?: Array<ReRankDataObject>;
/**
* 是否在线, 后台异步任务使用离线, 实时任务使用在线, 默认值: false
* @deprecated
*/
Online?: boolean;
}
/**
* 应用使用知识库容量详情
*/
export interface KnowledgeDetail {
/**
* 应用名称
注意：此字段可能返回 null，表示取不到有效值。
*/
AppName?: string;
/**
* 已用字符数
注意：此字段可能返回 null，表示取不到有效值。
*/
UsedCharSize?: string;
/**
* 使用占比
注意：此字段可能返回 null，表示取不到有效值。
*/
Proportion?: number;
/**
* 超量字符数
注意：此字段可能返回 null，表示取不到有效值。
*/
ExceedCharSize?: string;
}
/**
* DeleteAttributeLabel返回参数结构体
*/
export interface DeleteAttributeLabelResponse {
/**
* 唯一请求 ID，由服务端生成，每次请求都会返回（若请求因其他原因未能抵达服务端，则该次请求不会获得 RequestId）。定位问题时需要提供该次请求的 RequestId。
*/
RequestId?: string;
}
/**
* RetryRelease请求参数结构体
*/
export interface RetryReleaseRequest {
/**
* 机器人ID
*/
BotBizId: string;
/**
* 发布业务ID
*/
ReleaseBizId: string;
}
/**
* 应用关联插件信息
*/
export interface KnowledgeQaPlugin {
/**
* 插件ID
注意：此字段可能返回 null，表示取不到有效值。
*/
PluginId?: string;
/**
* 插件名称
*/
PluginName?: string;
/**
* 插件图标
*/
PluginIcon?: string;
/**
* 工具ID
*/
ToolId?: string;
/**
* 工具名称
*/
ToolName?: string;
/**
* 工具描述
*/
ToolDesc?: string;
/**
* 工具输入参数
*/
Inputs?: Array<PluginToolReqParam>;
/**
* 插件是否和知识库绑定
*/
IsBindingKnowledge?: boolean;
}
/**
* DeleteQACate请求参数结构体
*/
export interface DeleteQACateRequest {
/**
* 应用ID
*/
BotBizId: string;
/**
* 分类业务ID
*/
CateBizId: string;
}
/**
* GenerateQA请求参数结构体
*/
export interface GenerateQARequest {
/**
* 应用ID
*/
BotBizId: string;
/**
* 文档ID
*/
DocBizIds?: Array<string>;
}
/**
* GetWsToken请求参数结构体
*/
export interface GetWsTokenRequest {
/**
* 接入类型，当前请填写5
*/
Type: number;
/**
* 当Type=5时，必填；应用AppKey（应用发布后在应用页面[发布管理]-[调用信息]-[API管理]处获取）
*/
BotAppKey?: string;
/**
* 访客ID（外部输入，建议唯一，标识当前接入会话的用户）
*/
VisitorBizId?: string;
/**
* 知识标签，用于知识库中知识的检索过滤。该字段即将下线，请使用对话端接口中的 custom_variables 字段替代该字段。
*/
VisitorLabels?: Array<GetWsTokenReq_Label>;
}
/**
* 获取QA分类分组
*/
export interface QACate {
/**
* QA分类的业务ID
注意：此字段可能返回 null，表示取不到有效值。
*/
CateBizId?: string;
/**
* 分类名称
注意：此字段可能返回 null，表示取不到有效值。
*/
Name?: string;
/**
* 分类下QA数量
注意：此字段可能返回 null，表示取不到有效值。
*/
Total?: number;
/**
* 是否可新增
注意：此字段可能返回 null，表示取不到有效值。
*/
CanAdd?: boolean;
/**
* 是否可编辑
注意：此字段可能返回 null，表示取不到有效值。
*/
CanEdit?: boolean;
/**
* 是否可删除
注意：此字段可能返回 null，表示取不到有效值。
*/
CanDelete?: boolean;
/**
* 子分类
注意：此字段可能返回 null，表示取不到有效值。
*/
Children?: Array<QACate>;
}
/**
* 向量
*/
export interface EmbeddingObject {
/**
* 向量
*/
Embedding?: Array<number>;
}
/**
* ModifyDoc请求参数结构体
*/
export interface ModifyDocRequest {
/**
* 应用ID
*/
BotBizId: string;
/**
* 文档ID
*/
DocBizId: string;
/**
* 是否引用链接
*/
IsRefer: boolean;
/**
* 标签适用范围 1：全部，2：按条件
*/
AttrRange: number;
/**
* 登录用户主账号(集成商模式必填)
*/
LoginUin?: string;
/**
* 登录用户子账号(集成商模式必填)
*/
LoginSubAccountUin?: string;
/**
* 关联的标签
*/
AttrLabels?: Array<AttrLabelRefer>;
/**
* 网页(或自定义链接)地址
*/
WebUrl?: string;
/**
* 外部引用链接类型 0：系统链接 1：自定义链接
值为1时，WebUrl 字段不能为空，否则不生效。
*/
ReferUrlType?: number;
/**
* 有效开始时间，unix时间戳
*/
ExpireStart?: string;
/**
* 有效结束时间，unix时间戳，0代表永久有效
*/
ExpireEnd?: string;
/**
* 分类ID
*/
CateBizId?: string;
}
/**
* DescribeTokenUsage返回参数结构体
*/
export 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;
/**
* 唯一请求 ID，由服务端生成，每次请求都会返回（若请求因其他原因未能抵达服务端，则该次请求不会获得 RequestId）。定位问题时需要提供该次请求的 RequestId。
*/
RequestId?: string;
}
/**
* DeleteApp返回参数结构体
*/
export interface DeleteAppResponse {
/**
* 唯一请求 ID，由服务端生成，每次请求都会返回（若请求因其他原因未能抵达服务端，则该次请求不会获得 RequestId）。定位问题时需要提供该次请求的 RequestId。
*/
RequestId?: string;
}
/**
* 检索范围配置
*/
export interface SearchRange {
/**
* 检索条件and/or
注意：此字段可能返回 null，表示取不到有效值。
*/
Condition?: string;
/**
* 自定义变量和标签关系数据
注意：此字段可能返回 null，表示取不到有效值。
*/
ApiVarAttrInfos?: Array<ApiVarAttrInfo>;
}
/**
* ListAttributeLabel请求参数结构体
*/
export interface ListAttributeLabelRequest {
/**
* 应用ID
*/
BotBizId: string;
/**
* 页码
*/
PageNumber: number;
/**
* 每页数量
*/
PageSize: number;
/**
* 登录用户主账号(集成商模式必填)
*/
LoginUin?: string;
/**
* 登录用户子账号(集成商模式必填)
*/
LoginSubAccountUin?: string;
/**
* 查询内容
*/
Query?: string;
}
/**
* DeleteDocCate请求参数结构体
*/
export interface DeleteDocCateRequest {
/**
* 应用ID
*/
BotBizId: string;
/**
* 分类业务ID
*/
CateBizId: string;
}
/**
* Agent中的参考来源
*/
export interface AgentReference {
/**
* 来源文档ID
注意：此字段可能返回 null，表示取不到有效值。
*/
DocId?: string;
/**
* id
注意：此字段可能返回 null，表示取不到有效值。
*/
Id?: string;
/**
* 名称
注意：此字段可能返回 null，表示取不到有效值。
*/
Name?: string;
/**
* 类型
注意：此字段可能返回 null，表示取不到有效值。
*/
Type?: number;
/**
* 链接
注意：此字段可能返回 null，表示取不到有效值。
*/
Url?: string;
/**
* 文档业务ID
注意：此字段可能返回 null，表示取不到有效值。
*/
DocBizId?: string;
/**
* 文档名称
注意：此字段可能返回 null，表示取不到有效值。
*/
DocName?: string;
/**
* 问答业务ID
注意：此字段可能返回 null，表示取不到有效值。
*/
QaBizId?: string;
/**
* 搜索引擎索引
注意：此字段可能返回 null，表示取不到有效值。
*/
Index?: number;
/**
* 标题
注意：此字段可能返回 null，表示取不到有效值。
*/
Title?: string;
}
/**
* DeleteDoc返回参数结构体
*/
export interface DeleteDocResponse {
/**
* 唯一请求 ID，由服务端生成，每次请求都会返回（若请求因其他原因未能抵达服务端，则该次请求不会获得 RequestId）。定位问题时需要提供该次请求的 RequestId。
*/
RequestId?: string;
}
/**
* 文档元素字段
*/
export interface DocumentElement {
/**
* 文档元素索引
注意：此字段可能返回 null，表示取不到有效值。
*/
Index?: number;
/**
* 元素类型，包括paragraph、table、formula、figure、title、header、footer、figure_text
注意：此字段可能返回 null，表示取不到有效值。
*/
Type?: string;
/**
* 元素内容，当type为figure或formula(公式识别关闭)时该字段内容为图片的位置
注意：此字段可能返回 null，表示取不到有效值。
*/
Text?: string;
/**
* 元素坐标，左上角(x1, y1)，右上角(x2, y2)，右下角(x3, y3)，左下角(x4, y4)
注意：此字段可能返回 null，表示取不到有效值。
*/
Polygon?: Polygon;
/**
* 元素层级
注意：此字段可能返回 null，表示取不到有效值。
*/
Level?: number;
/**
* 入参开启EnableInsetImage后返回，表示在InsetImagePackage中的内嵌图片名称
注意：此字段可能返回 null，表示取不到有效值。
*/
InsetImageName?: string;
/**
* 嵌套的文档元素信息，一般包含的是文档内嵌入图片的文字识别结果
注意：此字段可能返回 null，表示取不到有效值。
*/
Elements?: Array<DocumentElement>;
}
/**
* 应用基础配置
*/
export interface BaseConfig {
/**
* 应用名称
*/
Name: string;
/**
* 应用头像url，在CreateApp和ModifyApp中作为入参必填。
作为入参传入说明：
1. 传入的url图片限制为jpeg和png，大小限制为500KB，url链接需允许head请求。
2. 如果用户没有对象存储，可使用“获取文件上传临时密钥”(DescribeStorageCredential)接口，获取cos临时密钥和上传路径，自行上传头像至cos中并获取访问链接。
*/
Avatar: string;
/**
* 应用描述
*/
Desc?: string;
}
/**
* DescribeSegments返回参数结构体
*/
export interface DescribeSegmentsResponse {
/**
* 片段列表
注意：此字段可能返回 null，表示取不到有效值。
*/
List?: Array<DocSegment>;
/**
* 唯一请求 ID，由服务端生成，每次请求都会返回（若请求因其他原因未能抵达服务端，则该次请求不会获得 RequestId）。定位问题时需要提供该次请求的 RequestId。
*/
RequestId?: string;
}
/**
* 相似问信息
*/
export interface SimilarQuestion {
/**
* 相似问ID
注意：此字段可能返回 null，表示取不到有效值。
*/
SimBizId?: string;
/**
* 相似问内容
注意：此字段可能返回 null，表示取不到有效值。
*/
Question?: string;
/**
* 相似问审核状态，1审核失败
注意：此字段可能返回 null，表示取不到有效值。
*/
AuditStatus?: number;
}
/**
* 标签提取配置
*/
export interface ClassifyConfig {
/**
* 模型配置
注意：此字段可能返回 null，表示取不到有效值。
*/
Model?: AppModel;
/**
* 标签列表
注意：此字段可能返回 null，表示取不到有效值。
*/
Labels?: Array<ClassifyLabel>;
/**
* 欢迎语，200字符以内
注意：此字段可能返回 null，表示取不到有效值。
*/
Greeting?: string;
}
/**
* DescribeConcurrencyUsage请求参数结构体
*/
export interface DescribeConcurrencyUsageRequest {
/**
* 模型标识
*/
ModelName: string;
/**
* 开始时间戳, 单位为秒
*/
StartTime: string;
/**
* 结束时间戳, 单位为秒
*/
EndTime: string;
/**
* 应用id列表
*/
AppBizIds?: Array<string>;
}
/**
* GroupDoc返回参数结构体
*/
export interface GroupDocResponse {
/**
* 唯一请求 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;
}
/**
* ListUsageCallDetail返回参数结构体
*/
export interface ListUsageCallDetailResponse {
/**
* 列表总数
*/
Total?: number;
/**
* 列表
*/
List?: Array<CallDetail>;
/**
* 唯一请求 ID，由服务端生成，每次请求都会返回（若请求因其他原因未能抵达服务端，则该次请求不会获得 RequestId）。定位问题时需要提供该次请求的 RequestId。
*/
RequestId?: string;
}
/**
* ExportAttributeLabel请求参数结构体
*/
export interface ExportAttributeLabelRequest {
/**
* 应用ID
*/
BotBizId: string;
/**
* 登录用户主账号(集成商模式必填)
*/
LoginUin?: string;
/**
* 登录用户子账号(集成商模式必填)
*/
LoginSubAccountUin?: string;
/**
* 属性ID
*/
AttributeBizIds?: Array<string>;
/**
* 根据筛选数据导出
*/
Filters?: AttributeFilters;
}
/**
* DescribeTokenUsage请求参数结构体
*/
export interface DescribeTokenUsageRequest {
/**
* 腾讯云主账号
*/
UinAccount?: Array<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?: Array<string>;
/**
* 筛选子场景(文档解析场景使用)
*/
SubScenes?: Array<string>;
}
/**
* GetAppKnowledgeCount返回参数结构体
*/
export interface GetAppKnowledgeCountResponse {
/**
* 总数
注意：此字段可能返回 null，表示取不到有效值。
*/
Total?: string;
/**
* 唯一请求 ID，由服务端生成，每次请求都会返回（若请求因其他原因未能抵达服务端，则该次请求不会获得 RequestId）。定位问题时需要提供该次请求的 RequestId。
*/
RequestId?: string;
}
/**
* RetryRelease返回参数结构体
*/
export interface RetryReleaseResponse {
/**
* 唯一请求 ID，由服务端生成，每次请求都会返回（若请求因其他原因未能抵达服务端，则该次请求不会获得 RequestId）。定位问题时需要提供该次请求的 RequestId。
*/
RequestId?: string;
}
/**
* CreateAttributeLabel返回参数结构体
*/
export interface CreateAttributeLabelResponse {
/**
* 标签ID
*/
AttrBizId?: string;
/**
* 唯一请求 ID，由服务端生成，每次请求都会返回（若请求因其他原因未能抵达服务端，则该次请求不会获得 RequestId）。定位问题时需要提供该次请求的 RequestId。
*/
RequestId?: string;
}
/**
* ListAppKnowledgeDetail请求参数结构体
*/
export interface ListAppKnowledgeDetailRequest {
/**
* 页码
*/
PageNumber: number;
/**
* 页面大小
*/
PageSize: number;
/**
* 应用ID列表
*/
AppBizIds?: Array<string>;
}
/**
* CreateQA返回参数结构体
*/
export interface CreateQAResponse {
/**
* 问答ID
*/
QaBizId?: string;
/**
* 唯一请求 ID，由服务端生成，每次请求都会返回（若请求因其他原因未能抵达服务端，则该次请求不会获得 RequestId）。定位问题时需要提供该次请求的 RequestId。
*/
RequestId?: string;
}
/**
* 重排数据, 计算2段内容的关联性
*/
export interface ReRankDataObject {
/**
* 第一段内容
*/
PromptA: string;
/**
* 第二段内容
*/
PromptB: string;
}
/**
* ListQACate请求参数结构体
*/
export interface ListQACateRequest {
/**
* 应用ID
*/
BotBizId: string;
}
/**
* ListReleaseQAPreview请求参数结构体
*/
export interface ListReleaseQAPreviewRequest {
/**
* 应用ID
*/
BotBizId: string;
/**
* 页码
*/
PageNumber: number;
/**
* 每页数量
*/
PageSize: number;
/**
* 查询内容
*/
Query?: string;
/**
* 发布单ID
*/
ReleaseBizId?: string;
/**
* 开始时间
*/
StartTime?: string;
/**
* 结束时间
*/
EndTime?: string;
/**
* 状态(1新增2修改3删除)
*/
Actions?: Array<number | bigint>;
/**
* 发布状态(4发布成功5发布失败)
*/
ReleaseStatus?: Array<number | bigint>;
}
/**
* 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;
}
/**
* IsTransferIntent请求参数结构体
*/
export interface IsTransferIntentRequest {
/**
* 内容
*/
Content: string;
/**
* 应用appKey
*/
BotAppKey: string;
}
/**
* DescribeRefer请求参数结构体
*/
export interface DescribeReferRequest {
/**
* 应用ID
*/
BotBizId: string;
/**
* 引用ID
*/
ReferBizIds: Array<string>;
/**
* 登录用户主账号(集成商模式必填)
*/
LoginUin?: string;
/**
* 登录用户子账号(集成商模式必填)
*/
LoginSubAccountUin?: string;
}
/**
* DeleteApp请求参数结构体
*/
export interface DeleteAppRequest {
/**
* 应用ID
*/
AppBizId: string;
/**
* 应用类型；knowledge_qa-知识问答管理；summary-知识摘要；classifys-知识标签提取
*/
AppType: string;
}
/**
* GetVarList返回参数结构体
*/
export interface GetVarListResponse {
/**
* 变量总数
*/
Total?: number;
/**
* 变量信息列表
*/
List?: Array<TaskFLowVar>;
/**
* 唯一请求 ID，由服务端生成，每次请求都会返回（若请求因其他原因未能抵达服务端，则该次请求不会获得 RequestId）。定位问题时需要提供该次请求的 RequestId。
*/
RequestId?: string;
}
/**
* 工作流程调试信息
*/
export interface WorkFlowSummary {
/**
* 工作流ID
注意：此字段可能返回 null，表示取不到有效值。
*/
WorkflowId?: string;
/**
* 工作流名称
注意：此字段可能返回 null，表示取不到有效值。
*/
WorkflowName?: string;
/**
* 工作流运行ID
注意：此字段可能返回 null，表示取不到有效值。
*/
WorkflowRunId?: string;
/**
* 节点信息
注意：此字段可能返回 null，表示取不到有效值。
*/
RunNodes?: Array<WorkflowRunNodeInfo>;
}
/**
* 任务参数
*/
export interface TaskParams {
/**
* 下载地址,需要通过cos桶临时密钥去下载
注意：此字段可能返回 null，表示取不到有效值。
*/
CosPath?: string;
}
/**
* 应用类型详情
*/
export interface ListAppCategoryRspOption {
/**
* 类型名称
注意：此字段可能返回 null，表示取不到有效值。
*/
Text?: string;
/**
* 类型值
注意：此字段可能返回 null，表示取不到有效值。
*/
Value?: string;
/**
* 类型log
注意：此字段可能返回 null，表示取不到有效值。
*/
Logo?: 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>;
}
/**
* DescribeStorageCredential请求参数结构体
*/
export 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;
}
/**
* 问答列表
*/
export interface QAList {
/**
* 问答ID
*/
QaBizId: string;
/**
* 是否采纳
*/
IsAccepted?: boolean;
/**
* 分类ID
*/
CateBizId?: string;
/**
* 问题
*/
Question?: string;
/**
* 答案
*/
Answer?: string;
}
/**
* DescribeCorp返回参数结构体
*/
export interface DescribeCorpResponse {
/**
* 企业ID
*/
CorpBizId?: string;
/**
* 应用配额
*/
RobotQuota?: number;
/**
* 企业全称
*/
FullName?: string;
/**
* 是否试用
*/
IsTrial?: boolean;
/**
* 是否试用过期
*/
IsTrialExpired?: boolean;
/**
* 可用应用数量
*/
AvailableAppQuota?: number;
/**
* 是否支持自定义模型配置
*/
IsSupportCustomModel?: boolean;
/**
* 唯一请求 ID，由服务端生成，每次请求都会返回（若请求因其他原因未能抵达服务端，则该次请求不会获得 RequestId）。定位问题时需要提供该次请求的 RequestId。
*/
RequestId?: string;
}
/**
* ModifyDocCate返回参数结构体
*/
export interface ModifyDocCateResponse {
/**
* 唯一请求 ID，由服务端生成，每次请求都会返回（若请求因其他原因未能抵达服务端，则该次请求不会获得 RequestId）。定位问题时需要提供该次请求的 RequestId。
*/
RequestId?: string;
}
/**
* ListRelease返回参数结构体
*/
export interface ListReleaseResponse {
/**
* 发布列表数量
*/
Total?: string;
/**
* 发布列表
*/
List?: Array<ListReleaseItem>;
/**
* 唯一请求 ID，由服务端生成，每次请求都会返回（若请求因其他原因未能抵达服务端，则该次请求不会获得 RequestId）。定位问题时需要提供该次请求的 RequestId。
*/
RequestId?: string;
}
/**
* ListModel返回参数结构体
*/
export interface ListModelResponse {
/**
* 模型列表
*/
List?: Array<ModelInfo>;
/**
* 唯一请求 ID，由服务端生成，每次请求都会返回（若请求因其他原因未能抵达服务端，则该次请求不会获得 RequestId）。定位问题时需要提供该次请求的 RequestId。
*/
RequestId?: string;
}
/**
* ListAttributeLabel返回参数结构体
*/
export interface ListAttributeLabelResponse {
/**
* 总数
*/
Total?: string;
/**
* 列表
*/
List?: Array<AttrLabelDetail>;
/**
* 唯一请求 ID，由服务端生成，每次请求都会返回（若请求因其他原因未能抵达服务端，则该次请求不会获得 RequestId）。定位问题时需要提供该次请求的 RequestId。
*/
RequestId?: string;
}
/**
* 发布列表详情
*/
export interface ListReleaseItem {
/**
* 版本ID
*/
ReleaseBizId?: string;
/**
* 发布人
*/
Operator?: string;
/**
* 发布描述
*/
Desc?: string;
/**
* 更新时间
*/
UpdateTime?: string;
/**
* 发布状态
*/
Status?: number;
/**
* 发布状态描述
*/
StatusDesc?: string;
/**
* 失败原因
*/
Reason?: string;
/**
* 发布成功数
*/
SuccessCount?: number;
/**
* 发布失败数
*/
FailCount?: number;
}
/**
* ModifyQA返回参数结构体
*/
export interface ModifyQAResponse {
/**
* 唯一请求 ID，由服务端生成，每次请求都会返回（若请求因其他原因未能抵达服务端，则该次请求不会获得 RequestId）。定位问题时需要提供该次请求的 RequestId。
*/
RequestId?: string;
}
/**
* DeleteQA返回参数结构体
*/
export interface DeleteQAResponse {
/**
* 唯一请求 ID，由服务端生成，每次请求都会返回（若请求因其他原因未能抵达服务端，则该次请求不会获得 RequestId）。定位问题时需要提供该次请求的 RequestId。
*/
RequestId?: string;
}
/**
* DescribeCallStatsGraph返回参数结构体
*/
export interface DescribeCallStatsGraphResponse {
/**
* 接口调用次数统计信息
注意：此字段可能返回 null，表示取不到有效值。
*/
List?: Array<Stat>;
/**
* 唯一请求 ID，由服务端生成，每次请求都会返回（若请求因其他原因未能抵达服务端，则该次请求不会获得 RequestId）。定位问题时需要提供该次请求的 RequestId。
*/
RequestId?: string;
}
/**
* GetMsgRecord请求参数结构体
*/
export interface GetMsgRecordRequest {
/**
* 类型
*/
Type: number;
/**
* 数量
*/
Count: number;
/**
* 会话sessionid
*/
SessionId: string;
/**
* 最后一条记录ID
*/
LastRecordId?: string;
/**
* 应用AppKey, 当Type=5[API访客]时, 该字段必填
*/
BotAppKey?: string;
/**
* 场景, 体验: 1; 正式: 2
*/
Scene?: number;
}
/**
* DescribeStorageCredential返回参数结构体
*/
export interface DescribeStorageCredentialResponse {
/**
* 密钥信息
*/
Credentials?: Credentials;
/**
* 失效时间
*/
ExpiredTime?: number;
/**
* 开始时间
*/
StartTime?: number;
/**
* 对象存储桶
*/
Bucket?: string;
/**
* 对象存储可用区
*/
Region?: string;
/**
* 文件存储目录
*/
FilePath?: string;
/**
* 存储类型
*/
Type?: string;
/**
* 主号
*/
CorpUin?: string;
/**
* 图片存储目录
*/
ImagePath?: string;
/**
* 上传存储路径，到具体文件
*/
UploadPath?: string;
/**
* 唯一请求 ID，由服务端生成，每次请求都会返回（若请求因其他原因未能抵达服务端，则该次请求不会获得 RequestId）。定位问题时需要提供该次请求的 RequestId。
*/
RequestId?: string;
}
/**
* CheckAttributeLabelExist返回参数结构体
*/
export interface CheckAttributeLabelExistResponse {
/**
* 是否存在
*/
IsExist?: boolean;
/**
* 唯一请求 ID，由服务端生成，每次请求都会返回（若请求因其他原因未能抵达服务端，则该次请求不会获得 RequestId）。定位问题时需要提供该次请求的 RequestId。
*/
RequestId?: string;
}
/**
* 字符串KV信息
*/
export interface StrValue {
/**
* 名称
注意：此字段可能返回 null，表示取不到有效值。
*/
Name?: string;
/**
* 值
注意：此字段可能返回 null，表示取不到有效值。
*/
Value?: string;
}
/**
* GetTaskStatus请求参数结构体
*/
export interface GetTaskStatusRequest {
/**
* 任务ID
*/
TaskId: string;
/**
* 任务类型
*/
TaskType: string;
/**
* 应用ID
*/
BotBizId: string;
}
/**
* CheckAttributeLabelRefer返回参数结构体
*/
export interface CheckAttributeLabelReferResponse {
/**
* 是否引用
*/
IsRefer?: boolean;
/**
* 唯一请求 ID，由服务端生成，每次请求都会返回（若请求因其他原因未能抵达服务端，则该次请求不会获得 RequestId）。定位问题时需要提供该次请求的 RequestId。
*/
RequestId?: string;
}
/**
* RateMsgRecord返回参数结构体
*/
export interface RateMsgRecordResponse {
/**
* 唯一请求 ID，由服务端生成，每次请求都会返回（若请求因其他原因未能抵达服务端，则该次请求不会获得 RequestId）。定位问题时需要提供该次请求的 RequestId。
*/
RequestId?: string;
}
/**
* CreateVar返回参数结构体
*/
export interface CreateVarResponse {
/**
* 变量ID
*/
VarId?: string;
/**
* 唯一请求 ID，由服务端生成，每次请求都会返回（若请求因其他原因未能抵达服务端，则该次请求不会获得 RequestId）。定位问题时需要提供该次请求的 RequestId。
*/
RequestId?: string;
}
/**
* ModifyDocAttrRange请求参数结构体
*/
export interface ModifyDocAttrRangeRequest {
/**
* 应用ID
*/
BotBizId: string;
/**
* 文档ID
*/
DocBizIds: Array<string>;
/**
* 属性标签适用范围 1：全部，2：按条件
*/
AttrRange: number;
/**
* 属性标签引用
*/
AttrLabels: Array<AttrLabelRefer>;
}
/**
* 发布拒答
*/
export interface ReleaseRejectedQuestion {
/**
* 问题
注意：此字段可能返回 null，表示取不到有效值。
*/
Question?: string;
/**
* 更新时间
注意：此字段可能返回 null，表示取不到有效值。
*/
UpdateTime?: string;
/**
* 状态
注意：此字段可能返回 null，表示取不到有效值。
*/
Action?: number;
/**
* 状态描述
注意：此字段可能返回 null，表示取不到有效值。
*/
ActionDesc?: string;
/**
* 失败原因
注意：此字段可能返回 null，表示取不到有效值。
*/
Message?: string;
}
/**
* CreateQACate请求参数结构体
*/
export interface CreateQACateRequest {
/**
* 应用ID
*/
BotBizId: string;
/**
* 父级业务ID，创建顶级分类时传字符串"0"
*/
ParentBizId: string;
/**
* 分类名称
*/
Name: string;
}
/**
* DescribeRobotBizIDByAppKey请求参数结构体
*/
export interface DescribeRobotBizIDByAppKeyRequest {
/**
* 应用appkey
*/
AppKey: string;
}
/**
* CreateVar请求参数结构体
*/
export 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;
}
/**
* 单页文档识别的内容
*/
export interface DocumentRecognizeInfo {
/**
* 输入PDF文件的页码，从1开始。输入图片的话值始终为1
注意：此字段可能返回 null，表示取不到有效值。
*/
PageNumber?: number;
/**
* 旋转角度
注意：此字段可能返回 null，表示取不到有效值。
*/
Angle?: number;
/**
* AI算法识别处理后的图片高度
注意：此字段可能返回 null，表示取不到有效值。
*/
Height?: number;
/**
* AI算法识别处理后的图片宽度
注意：此字段可能返回 null，表示取不到有效值。
*/
Width?: number;
/**
* 图片的原始高度，输入PDF文件则表示单页PDF转图片之后的图片高度
注意：此字段可能返回 null，表示取不到有效值。
*/
OriginHeight?: number;
/**
* 图片的原始宽度，输入PDF文件则表示单页PDF转图片之后的图片宽度
注意：此字段可能返回 null，表示取不到有效值。
*/
OriginWidth?: number;
/**
* 文档元素信息
注意：此字段可能返回 null，表示取不到有效值。
*/
Elements?: Array<DocumentElement>;
/**
* 旋转角度
注意：此字段可能返回 null，表示取不到有效值。
*/
RotatedAngle?: number;
}
/**
* CreateReconstructDocumentFlow返回参数结构体
*/
export interface CreateReconstructDocumentFlowResponse {
/**
* 任务唯一ID。30天内可以通过[GetReconstructDocumentResult](https://cloud.tencent.com/document/product/1759/107505)接口查询TaskId对应的处理结果。
*/
TaskId?: string;
/**
* 唯一请求 ID，由服务端生成，每次请求都会返回（若请求因其他原因未能抵达服务端，则该次请求不会获得 RequestId）。定位问题时需要提供该次请求的 RequestId。
*/
RequestId?: string;
}
/**
* 多轮历史信息
*/
export interface HistorySummary {
/**
* 助手
注意：此字段可能返回 null，表示取不到有效值。
*/
Assistant?: string;
/**
* 用户
注意：此字段可能返回 null，表示取不到有效值。
*/
User?: string;
}
/**
* VerifyQA返回参数结构体
*/
export interface VerifyQAResponse {
/**
* 唯一请求 ID，由服务端生成，每次请求都会返回（若请求因其他原因未能抵达服务端，则该次请求不会获得 RequestId）。定位问题时需要提供该次请求的 RequestId。
*/
RequestId?: string;
}
/**
* 发布配置项
*/
export interface ReleaseConfigs {
/**
* 配置项描述
注意：此字段可能返回 null，表示取不到有效值。
*/
ConfigItem?: string;
/**
* 更新时间
注意：此字段可能返回 null，表示取不到有效值。
*/
UpdateTime?: string;
/**
* 状态
注意：此字段可能返回 null，表示取不到有效值。
*/
Action?: number;
/**
* 变更后的内容
注意：此字段可能返回 null，表示取不到有效值。
*/
Value?: string;
/**
* 变更前的内容
注意：此字段可能返回 null，表示取不到有效值。
*/
LastValue?: string;
/**
* 变更内容(优先级展示content内容,content为空取value内容)
注意：此字段可能返回 null，表示取不到有效值。
*/
Content?: string;
/**
* 失败原因
注意：此字段可能返回 null，表示取不到有效值。
*/
Message?: string;
}
/**
* DescribeSegments请求参数结构体
*/
export interface DescribeSegmentsRequest {
/**
* 应用ID
*/
BotBizId: string;
/**
* 文档片段ID
*/
SegBizId?: Array<string>;
}
/**
* DescribeSearchStatsGraph请求参数结构体
*/
export interface DescribeSearchStatsGraphRequest {
/**
* 登录用户主账号(集成商模式必填)
*/
LoginUin?: string;
/**
* 登录用户子账号(集成商模式必填)
*/
LoginSubAccountUin?: string;
/**
* uin列表
*/
UinAccount?: Array<string>;
/**
* 子业务类型
*/
SubBizType?: string;
/**
* 模型标识
*/
ModelName?: string;
/**
* 开始时间戳, 单位为秒
*/
StartTime?: string;
/**
* 结束时间戳, 单位为秒
*/
EndTime?: string;
/**
* 应用id列表
*/
AppBizIds?: Array<string>;
}
/**
* DescribeSearchStatsGraph返回参数结构体
*/
export interface DescribeSearchStatsGraphResponse {
/**
* 统计结果
注意：此字段可能返回 null，表示取不到有效值。
*/
List?: Array<Stat>;
/**
* 唯一请求 ID，由服务端生成，每次请求都会返回（若请求因其他原因未能抵达服务端，则该次请求不会获得 RequestId）。定位问题时需要提供该次请求的 RequestId。
*/
RequestId?: string;
}
/**
* 不满意回复检索过滤
*/
export interface Filters {
/**
* 检索，用户问题或答案
*/
Query?: string;
/**
* 错误类型检索
*/
Reasons?: Array<string>;
}
/**
* ModifyRejectedQuestion请求参数结构体
*/
export interface ModifyRejectedQuestionRequest {
/**
* 应用ID
*/
BotBizId: string;
/**
* 拒答问题
*/
Question: string;
/**
* 拒答问题来源的数据源唯一id
*/
RejectedBizId: string;
}
/**
* IgnoreUnsatisfiedReply返回参数结构体
*/
export interface IgnoreUnsatisfiedReplyResponse {
/**
* 唯一请求 ID，由服务端生成，每次请求都会返回（若请求因其他原因未能抵达服务端，则该次请求不会获得 RequestId）。定位问题时需要提供该次请求的 RequestId。
*/
RequestId?: string;
}
/**
* StopDocParse请求参数结构体
*/
export interface StopDocParseRequest {
/**
* 应用ID
*/
BotBizId: string;
/**
* 文档ID
*/
DocBizId: string;
}
/**
* 问答知识库工作流配置
*/
export interface KnowledgeWorkflow {
/**
* 是否启用工作流
注意：此字段可能返回 null，表示取不到有效值。
*/
IsEnabled?: boolean;
/**
* 是否启用PDL
注意：此字段可能返回 null，表示取不到有效值。
*/
UsePdl?: boolean;
}
/**
* ListModel请求参数结构体
*/
export interface ListModelRequest {
/**
* 应用类型；knowledge_qa-知识问答管理；summary-知识摘要；classifys-知识标签提取
*/
AppType: string;
/**
* 应用模式 standard:标准模式, agent: agent模式，single_workflow：单工作流模式
*/
Pattern?: string;
/**
* 模型类别 generate：生成模型，thought：思考模型
*/
ModelCategory?: string;
/**
* 登录用户主账号(集成商模式必填)
*/
LoginUin?: string;
/**
* 登录用户子账号(集成商模式必填)
*/
LoginSubAccountUin?: string;
}
/**
* ListSelectDoc请求参数结构体
*/
export interface ListSelectDocRequest {
/**
* 应用ID
*/
BotBizId: string;
/**
* 文档名称
*/
FileName?: string;
/**
* 文档状态： 7 审核中、8 审核失败、10 待发布、11 发布中、12 已发布、13 学习中、14 学习失败 20 已过期
*/
Status?: Array<number | bigint>;
}