/**
* GetWsToken返回参数结构体
*/
export interface GetWsTokenResponse {
/**
* token值(有效期60s,仅一次有效,多次校验会报错)
*/
Token?: string;
/**
* 余额; 余额大于 0 时表示有效
注意:此字段可能返回 null,表示取不到有效值。
*/
Balance?: number;
/**
* 对话窗输入字符限制
*/
InputLenLimit?: number;
/**
* 应用模式,standard:标准模式, agent: agent模式,single_workflow:单工作流模式
*/
Pattern?: string;
/**
* SingleWorkflow
*/
SingleWorkflow?: KnowledgeQaSingleWorkflow;
/**
* 使用视觉模型时对话窗口输入字符限制
注意:此字段可能返回 null,表示取不到有效值。
*/
VisionModelInputLimit?: number;
/**
* 唯一请求 ID,由服务端生成,每次请求都会返回(若请求因其他原因未能抵达服务端,则该次请求不会获得 RequestId)。定位问题时需要提供该次请求的 RequestId。
*/
RequestId?: string;
}
/**
* GetAppSecret请求参数结构体
*/
export interface GetAppSecretRequest {
/**
* 应用ID
*/
AppBizId: string;
}
/**
* 扩展信息
*/
export interface ExtraInfo {
/**
* ECharts信息
注意:此字段可能返回 null,表示取不到有效值。
*/
EChartsInfo?: Array;
}
/**
* ListSelectDoc返回参数结构体
*/
export interface ListSelectDocResponse {
/**
* 下拉框内容
*/
List?: Array
注意:此字段可能返回 null,表示取不到有效值。
* @deprecated
*/
DocBizId?: string;
/**
* 文件名称
注意:此字段可能返回 null,表示取不到有效值。
*/
FileName?: string;
/**
* 文件类型
注意:此字段可能返回 null,表示取不到有效值。
*/
FileType?: string;
/**
* 文件大小,单位为Byte
注意:此字段可能返回 null,表示取不到有效值。
*/
FileSize?: string;
/**
* 文件 URL
注意:此字段可能返回 null,表示取不到有效值。
*/
FileUrl?: string;
/**
* 实时文档解析接口返回的 doc_id。
注意:此字段可能返回 null,表示取不到有效值。
*/
DocId?: string;
/**
* 文件创建时间
注意:此字段可能返回 null,表示取不到有效值。
*/
CreateTime?: string;
}
/**
* GenerateQA请求参数结构体
*/
export interface GenerateQARequest {
/**
* 应用ID,获取方法参看如何获取[BotBizId](https://cloud.tencent.com/document/product/1759/109469#4eecb8c1-6ce4-45f5-8fa2-b269449d8efa)
*/
BotBizId: string;
/**
* 文档ID
*/
DocBizIds: Array;
}
/**
* ListReferShareKnowledge请求参数结构体
*/
export interface ListReferShareKnowledgeRequest {
/**
* 应用业务id
*/
AppBizId: string;
/**
* 登录用户主账号(集成商模式必填)
*/
LoginUin?: string;
/**
* 登录用户子账号(集成商模式必填)
*/
LoginSubAccountUin?: string;
}
/**
* ListAttributeLabel请求参数结构体
*/
export interface ListAttributeLabelRequest {
/**
* 应用ID,获取方法参看如何获取[BotBizId](https://cloud.tencent.com/document/product/1759/109469#4eecb8c1-6ce4-45f5-8fa2-b269449d8efa)
*/
BotBizId: string;
/**
* 页码,取值范围:大于0
*/
PageNumber: number;
/**
* 每页数量,取值范围:大于0
*/
PageSize: number;
/**
* 登录用户主账号(集成商模式必填)
*/
LoginUin?: string;
/**
* 登录用户子账号(集成商模式必填)
*/
LoginSubAccountUin?: string;
/**
* 查询内容,同时匹配标签内容和标签值内容
*/
Query?: string;
/**
* 每个标签同步拉取的标签值数量。即在展示标签列表时,为每一个标签加载多少个具体的标签值。
*/
LabelSize?: number;
}
/**
* Agent输出配置
*/
export interface AgentOutputConfig {
/**
* 输出类型,1-文本 2-json 3-widget
*/
OutputType?: number;
/**
* Json结构化输出参数列表
*/
StructuredOutputParams?: Array;
/**
* widget id
*/
WidgetId?: 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;
/**
* 知识库名称
注意:此字段可能返回 null,表示取不到有效值。
*/
KnowledgeName?: string;
/**
* 知识库标识
注意:此字段可能返回 null,表示取不到有效值。
*/
KnowledgeBizId?: string;
}
/**
* DeleteDoc返回参数结构体
*/
export interface DeleteDocResponse {
/**
* 唯一请求 ID,由服务端生成,每次请求都会返回(若请求因其他原因未能抵达服务端,则该次请求不会获得 RequestId)。定位问题时需要提供该次请求的 RequestId。
*/
RequestId?: string;
}
/**
* DescribeSegments返回参数结构体
*/
export interface DescribeSegmentsResponse {
/**
* 片段列表
注意:此字段可能返回 null,表示取不到有效值。
*/
List?: Array;
/**
* 唯一请求 ID,由服务端生成,每次请求都会返回(若请求因其他原因未能抵达服务端,则该次请求不会获得 RequestId)。定位问题时需要提供该次请求的 RequestId。
*/
RequestId?: string;
}
/**
* UploadAttributeLabel请求参数结构体
*/
export interface UploadAttributeLabelRequest {
/**
* 应用ID
*/
BotBizId: string;
/**
* 文件名
*/
FileName: string;
/**
* cos路径
*/
CosUrl: string;
/**
* x-cos-hash-crc64ecma 头部中的 CRC64编码进行校验上传到云端的文件和本地文件的一致性
*/
CosHash: string;
/**
* 文件大小
*/
Size: string;
/**
* 登录用户主账号(集成商模式必填)
*/
LoginUin?: string;
/**
* 登录用户子账号(集成商模式必填)
*/
LoginSubAccountUin?: string;
}
/**
* DescribeAppAgentList请求参数结构体
*/
export interface DescribeAppAgentListRequest {
/**
* 应用ID
*/
AppBizId?: string;
}
/**
* CreateQA返回参数结构体
*/
export interface CreateQAResponse {
/**
* 问答ID
*/
QaBizId?: string;
/**
* 唯一请求 ID,由服务端生成,每次请求都会返回(若请求因其他原因未能抵达服务端,则该次请求不会获得 RequestId)。定位问题时需要提供该次请求的 RequestId。
*/
RequestId?: string;
}
/**
* 背景图相关配置
*/
export interface BackgroundImageConfig {
/**
* 横图(pc)
*/
LandscapeImageUrl?: string;
/**
* 原始图
*/
OriginalImageUrl?: string;
/**
* 长图(手机)
*/
PortraitImageUrl?: string;
/**
* 主题色
*/
ThemeColor?: string;
/**
* 亮度值
*/
Brightness?: number;
}
/**
* DescribeReleaseInfo返回参数结构体
*/
export interface DescribeReleaseInfoResponse {
/**
* 最后发布时间
*/
LastTime?: string;
/**
* 发布状态 , 1-待发布 , 2-发布中 , 3-发布成功 , 4-发布失败 , 5-审核中 , 6-审核成功 , 7-审核失败 , 8-发布成功回调处理中 , 9-发布暂停 , 10-申诉审核中 , 11-申诉审核通过 , 12-申诉审核不通过
*/
Status?: number;
/**
* 是否编辑过, 当为true的时候表示可以发布
*/
IsUpdated?: boolean;
/**
* 失败原因
*/
Msg?: string;
/**
* 唯一请求 ID,由服务端生成,每次请求都会返回(若请求因其他原因未能抵达服务端,则该次请求不会获得 RequestId)。定位问题时需要提供该次请求的 RequestId。
*/
RequestId?: string;
}
/**
* ModifyRejectedQuestion请求参数结构体
*/
export interface ModifyRejectedQuestionRequest {
/**
* 应用ID, 获取方法参看如何获取 [BotBizId](https://cloud.tencent.com/document/product/1759/109469#4eecb8c1-6ce4-45f5-8fa2-b269449d8efa)
*/
BotBizId: string;
/**
* 拒答问题
*/
Question: string;
/**
* 拒答问题来源的数据源唯一id, 通过调用ListRejectedQuestion接口获取
*/
RejectedBizId: string;
}
/**
* DescribeWorkflowRun返回参数结构体
*/
export interface DescribeWorkflowRunResponse {
/**
* 工作流运行实例详情
*/
WorkflowRun?: WorkflowRunDetail;
/**
* 节点列表
*/
NodeRuns?: Array;
/**
* 子工作流对应的NodePath
*/
SubWorkflowNodePath?: string;
/**
* 唯一请求 ID,由服务端生成,每次请求都会返回(若请求因其他原因未能抵达服务端,则该次请求不会获得 RequestId)。定位问题时需要提供该次请求的 RequestId。
*/
RequestId?: string;
}
/**
* 选项卡索引
*/
export interface OptionCardIndex {
/**
* 唯一标识
*/
RecordId?: string;
/**
* 选项卡索引
*/
Index?: number;
}
/**
* 当前执行的 token 统计信息
*/
export interface TokenStat {
/**
* 会话 ID
注意:此字段可能返回 null,表示取不到有效值。
*/
SessionId?: string;
/**
* 请求 ID
注意:此字段可能返回 null,表示取不到有效值。
*/
RequestId?: string;
/**
* 对应哪条会话, 会话 ID, 用于回答的消息存储使用, 可提前生成, 保存消息时使用
注意:此字段可能返回 null,表示取不到有效值。
*/
RecordId?: string;
/**
* token 已使用数
注意:此字段可能返回 null,表示取不到有效值。
*/
UsedCount?: number;
/**
* 免费 token 数
注意:此字段可能返回 null,表示取不到有效值。
*/
FreeCount?: number;
/**
* 订单总 token 数
注意:此字段可能返回 null,表示取不到有效值。
*/
OrderCount?: number;
/**
* 当前执行状态汇总, 常量: 使用中: processing, 成功: success, 失败: failed
注意:此字段可能返回 null,表示取不到有效值。
*/
StatusSummary?: string;
/**
* 当前执行状态汇总后中文展示
注意:此字段可能返回 null,表示取不到有效值。
*/
StatusSummaryTitle?: string;
/**
* 当前请求执行时间, 单位 ms
注意:此字段可能返回 null,表示取不到有效值。
*/
Elapsed?: number;
/**
* 当前请求消耗 token 数
注意:此字段可能返回 null,表示取不到有效值。
*/
TokenCount?: number;
/**
* 执行过程信息
注意:此字段可能返回 null,表示取不到有效值。
*/
Procedures?: Array;
/**
* 执行过程信息TraceId
注意:此字段可能返回 null,表示取不到有效值。
*/
TraceId?: string;
}
/**
* 应用配置MCP插件header信息
*/
export interface AgentPluginHeader {
/**
* 参数名称
*/
ParamName?: string;
/**
* 参数值
*/
ParamValue?: string;
/**
* header参数配置是否隐藏不可见
*/
GlobalHidden?: boolean;
/**
* 输入的值
*/
Input?: AgentInput;
/**
* 参数是否可以为空
*/
IsRequired?: boolean;
}
/**
* DescribeStorageCredential请求参数结构体
*/
export interface DescribeStorageCredentialRequest {
/**
* 应用ID,参数非必填不代表不需要填写,下面不同的参数组合会获取到不同的权限,具体请参考 https://cloud.tencent.com/document/product/1759/116238
*/
BotBizId?: string;
/**
* 文件类型,正常的文件名类型后缀,支持 docx、doc、pdf、txt、md、wps、pages、html、mhtml、epub、xml、json、log、xlsx、xls、csv、tsv、numbers、pptx、ppt、ppsx、ppsm、key、png、jpg、jpeg、gif、bmp、tiff、webp、heif、heic、jp2、eps、icns、im、pcx、ppm、xbm、xmind
*/
FileType?: string;
/**
* IsPublic用于上传文件或图片时选择场景,当上传对话端图片时IsPublic为true,上传文件(包括文档库文件/图片等和对话端文件)时IsPublic为false
*/
IsPublic?: boolean;
/**
* 存储类型: offline:离线文件,realtime:实时文件;为空默认为offline
*/
TypeKey?: string;
}
/**
* 知识库检索策略
*/
export interface SearchStrategy {
/**
* 检索策略类型 0:混合检索,1:语义检索
注意:此字段可能返回 null,表示取不到有效值。
*/
StrategyType?: number;
/**
* Excel检索增强开关, false关闭,true打开
注意:此字段可能返回 null,表示取不到有效值。
*/
TableEnhancement?: boolean;
/**
* 向量模型
注意:此字段可能返回 null,表示取不到有效值。
*/
EmbeddingModel?: string;
/**
* 结果重排序开关, on打开,off关闭
注意:此字段可能返回 null,表示取不到有效值。
*/
RerankModelSwitch?: string;
/**
* 结果重排序模型
注意:此字段可能返回 null,表示取不到有效值。
*/
RerankModel?: string;
/**
* NL2SQL模型配置
注意:此字段可能返回 null,表示取不到有效值。
*/
NatureLanguageToSqlModelConfig?: NL2SQLModelConfig;
/**
* 是否开启图谱检索
*/
GraphRetrieval?: boolean;
}
/**
* Widget输出参数配置
*/
export interface OutputWidgetConfig {
/**
* widget id
*/
WidgetId?: string;
/**
* widget名字
*/
WidgetName?: string;
/**
* 展示结果
*/
WidgetParam?: Array;
}
/**
* ListRelease返回参数结构体
*/
export interface ListReleaseResponse {
/**
* 发布列表数量
*/
Total?: string;
/**
* 发布列表
*/
List?: Array;
/**
* 唯一请求 ID,由服务端生成,每次请求都会返回(若请求因其他原因未能抵达服务端,则该次请求不会获得 RequestId)。定位问题时需要提供该次请求的 RequestId。
*/
RequestId?: string;
}
/**
* ListModel返回参数结构体
*/
export interface ListModelResponse {
/**
* 模型列表
*/
List?: Array;
/**
* 唯一请求 ID,由服务端生成,每次请求都会返回(若请求因其他原因未能抵达服务端,则该次请求不会获得 RequestId)。定位问题时需要提供该次请求的 RequestId。
*/
RequestId?: string;
}
/**
* 文档列表筛选标识位
*/
export interface DocFilterFlag {
/**
* 标识位
*/
Flag?: string;
/**
* 标识值
*/
Value?: boolean;
}
/**
* CreateVar返回参数结构体
*/
export interface CreateVarResponse {
/**
* 变量ID
*/
VarId?: string;
/**
* 唯一请求 ID,由服务端生成,每次请求都会返回(若请求因其他原因未能抵达服务端,则该次请求不会获得 RequestId)。定位问题时需要提供该次请求的 RequestId。
*/
RequestId?: string;
}
/**
* CreateQACate请求参数结构体
*/
export interface CreateQACateRequest {
/**
* 应用ID
若要操作共享知识库,传KnowledgeBizId
*/
BotBizId: string;
/**
* 父级业务ID,创建顶级分类时传字符串"0"
*/
ParentBizId: string;
/**
* 创建的分类名称
*/
Name: string;
}
/**
* 共享知识库配置
*/
export interface ShareKnowledgeBase {
/**
* 共享知识库ID
注意:此字段可能返回 null,表示取不到有效值。
*/
KnowledgeBizId?: string;
/**
* 检索范围
注意:此字段可能返回 null,表示取不到有效值。
*/
SearchRange?: SearchRange;
/**
* 知识库模型设置
注意:此字段可能返回 null,表示取不到有效值。
*/
KnowledgeModelConfig?: KnowledgeModelConfig;
/**
* 检索策略配置
注意:此字段可能返回 null,表示取不到有效值。
*/
SearchStrategy?: SearchStrategy;
/**
* 检索配置
注意:此字段可能返回 null,表示取不到有效值。
*/
Search?: Array;
/**
* // 问答-回复灵活度 1:已采纳答案直接回复 2:已采纳润色后回复
注意:此字段可能返回 null,表示取不到有效值。
*/
ReplyFlexibility?: number;
/**
* 共享知识库名称
注意:此字段可能返回 null,表示取不到有效值。
*/
KnowledgeName?: string;
}
/**
* 多轮历史信息
*/
export interface HistorySummary {
/**
* 助手
注意:此字段可能返回 null,表示取不到有效值。
*/
Assistant?: string;
/**
* 用户
注意:此字段可能返回 null,表示取不到有效值。
*/
User?: string;
}
/**
* DescribeSearchStatsGraph请求参数结构体
*/
export interface DescribeSearchStatsGraphRequest {
/**
* 登录用户主账号(集成商模式必填)
*/
LoginUin?: string;
/**
* 登录用户子账号(集成商模式必填)
*/
LoginSubAccountUin?: string;
/**
* uin列表
*/
UinAccount?: Array;
/**
* 子业务类型
*/
SubBizType?: string;
/**
* 模型标识
*/
ModelName?: string;
/**
* 开始时间戳, 单位为秒(废弃)
*/
StartTime?: string;
/**
* 结束时间戳, 单位为秒(废弃)
*/
EndTime?: string;
/**
* 应用id列表
*/
AppBizIds?: Array;
/**
* 空间id
*/
SpaceId?: string;
/**
* 开始时间戳, 单位为秒
*/
StatStartTime?: number;
/**
* 结束时间戳, 单位为秒
*/
StatEndTime?: number;
}
/**
* RateMsgRecord返回参数结构体
*/
export interface RateMsgRecordResponse {
/**
* 唯一请求 ID,由服务端生成,每次请求都会返回(若请求因其他原因未能抵达服务端,则该次请求不会获得 RequestId)。定位问题时需要提供该次请求的 RequestId。
*/
RequestId?: string;
}
/**
* DescribeRefer请求参数结构体
*/
export interface DescribeReferRequest {
/**
* 应用ID
*/
BotBizId: string;
/**
* 引用ID
*/
ReferBizIds: Array;
/**
* 登录用户主账号(集成商模式必填)
*/
LoginUin?: string;
/**
* 登录用户子账号(集成商模式必填)
*/
LoginSubAccountUin?: string;
}
/**
* 问答知识库工作流配置
*/
export interface KnowledgeWorkflow {
/**
* 是否启用工作流
注意:此字段可能返回 null,表示取不到有效值。
*/
IsEnabled?: boolean;
/**
* 是否启用PDL
注意:此字段可能返回 null,表示取不到有效值。
*/
UsePdl?: boolean;
}
/**
* ReferShareKnowledge请求参数结构体
*/
export interface ReferShareKnowledgeRequest {
/**
* 应用业务id
*/
AppBizId: string;
/**
* 共享知识库业务id列表
*/
KnowledgeBizId: Array;
/**
* 登录用户主账号(集成商模式必填)
*/
LoginUin?: string;
/**
* 登录用户子账号(集成商模式必填)
*/
LoginSubAccountUin?: string;
}
/**
* GetAppKnowledgeCount请求参数结构体
*/
export interface GetAppKnowledgeCountRequest {
/**
* 类型:doc-文档;qa-问答对
*/
Type: string;
/**
* 应用ID
*/
AppBizId: string;
/**
* 登录用户主账号(集成商模式必填)
*/
LoginUin?: string;
/**
* 登录用户子账号(集成商模式必填)
*/
LoginSubAccountUin?: string;
}
/**
* CreateWorkflowRun返回参数结构体
*/
export interface CreateWorkflowRunResponse {
/**
* 应用ID
*/
AppBizId?: string;
/**
* 工作流运行实例的ID
*/
WorkflowRunId?: string;
/**
* 运行环境。0: 测试环境; 1: 正式环境
*/
RunEnv?: number;
/**
* 用户输入的内容
*/
Query?: string;
/**
* API参数配置
*/
CustomVariables?: Array;
/**
* 创建时间(毫秒时间戳)
*/
CreateTime?: string;
/**
* 唯一请求 ID,由服务端生成,每次请求都会返回(若请求因其他原因未能抵达服务端,则该次请求不会获得 RequestId)。定位问题时需要提供该次请求的 RequestId。
*/
RequestId?: string;
}
/**
* GetAnswerTypeDataCount请求参数结构体
*/
export interface GetAnswerTypeDataCountRequest {
/**
* 开始日期
*/
StartTime: number;
/**
* 结束日期
*/
EndTime: number;
/**
* 应用id
*/
AppBizId?: Array;
/**
* 消息来源(1、分享用户端 2、对话API 3、对话测试 4、应用评测)
*/
Type?: number;
/**
* 登录用户主账号(集成商模式必填)
*/
LoginUin?: string;
/**
* 登录用户子账号(集成商模式必填)
*/
LoginSubAccountUin?: 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;
/**
* 相似问个数
*/
SimilarQuestionNum?: number;
/**
* 返回问答关联的相似问,联动搜索,仅展示一条
*/
SimilarQuestionTips?: string;
/**
* 问答是否停用,false:未停用,ture:已停用
*/
IsDisabled?: boolean;
/**
* 员工名称
*/
StaffName?: string;
/**
* 问答生效域: 1-不生效;2-仅开发域生效;3-仅发布域生效;4-开发域和发布域均生效
注意:此字段可能返回 null,表示取不到有效值。
*/
EnableScope?: number;
/**
* 问答关联的文档生效域:1-不生效;2-仅开发域生效;3-仅发布域生效;4-开发域和发布域均生效。
若问答未关联文档,则该字段值同问答生效域。
*/
DocEnableScope?: number;
/**
* 问答大小(含相似问),单位:字节
*/
QaSize?: string;
}
/**
* ListUnsatisfiedReply返回参数结构体
*/
export interface ListUnsatisfiedReplyResponse {
/**
* 总数
*/
Total?: string;
/**
* 不满意回复列表
注意:此字段可能返回 null,表示取不到有效值。
*/
List?: Array;
/**
* 唯一请求 ID,由服务端生成,每次请求都会返回(若请求因其他原因未能抵达服务端,则该次请求不会获得 RequestId)。定位问题时需要提供该次请求的 RequestId。
*/
RequestId?: string;
}
/**
* 对话端Widget结构
*/
export interface Widget {
/**
* Widget配置ID
*/
WidgetId?: string;
/**
* Widget实例ID
*/
WidgetRunId?: string;
/**
* Widget显示数据
注意:此字段可能返回 null,表示取不到有效值。
*/
View?: string;
/**
* Widget状态数据
注意:此字段可能返回 null,表示取不到有效值。
*/
State?: string;
/**
* Widget位置
注意:此字段可能返回 null,表示取不到有效值。
*/
Position?: number;
/**
* Base64编码的Widget信息
注意:此字段可能返回 null,表示取不到有效值。
*/
EncodedWidget?: string;
/**
* 用户最近一次提交的payload
注意:此字段可能返回 null,表示取不到有效值。
*/
Payload?: string;
}
/**
* CreateWorkflowRun请求参数结构体
*/
export interface CreateWorkflowRunRequest {
/**
* 应用ID, 获取方法参看如何获取 [BotBizId](https://cloud.tencent.com/document/product/1759/109469#4eecb8c1-6ce4-45f5-8fa2-b269449d8efa)
*/
AppBizId: string;
/**
* 运行环境。0: 测试环境; 1: 正式环境
*/
RunEnv?: number;
/**
* 用户输入的内容
*/
Query?: string;
/**
* API参数配置
*/
CustomVariables?: Array;
/**
* 用户ID
*/
VisitorId?: string;
}
/**
* DescribeQA请求参数结构体
*/
export interface DescribeQARequest {
/**
* QA业务ID
*/
QaBizId: string;
/**
* 应用ID
*/
BotBizId: string;
}
/**
* Widget参数配置
*/
export interface WidgetParam {
/**
* 参数名称
*/
Name?: string;
/**
* 参数类型
*/
Type?: number;
/**
* 子参数
*/
SubParams?: Array;
/**
* 默认值, Input未指定时,使用该值
*/
DefaultValue?: string;
/**
* 输入的值
*/
Input?: AgentInput;
}
/**
* 联网检索内容参考详情
*/
export interface WebSearchReference {
/**
* 网页URL
*/
Url?: string;
}
/**
* ListQA请求参数结构体
*/
export interface ListQARequest {
/**
* 应用ID
若要操作共享知识库,传KnowledgeBizId
*/
BotBizId: string;
/**
* 页码(取值范围>0)
*/
PageNumber: number;
/**
* 每页大小(取值范围1-200)
*/
PageSize: number;
/**
* 查询问题
输入特定标识 lke:system:untagged 将查询所有未关联标签的问答
*/
Query?: string;
/**
* 校验状态(1未校验2采纳3不采纳)
如果不填默认值为空数组,表示不筛选,返回所有状态
*/
AcceptStatus?: Array;
/**
* 发布状态(2,4导入成功 7审核中 8审核失败 9人工申述中 11人工申述失败 12已过期 13超量失效 14超量失效恢复)
如果不填默认值为空数组,表示不筛选返回所有状态
*/
ReleaseStatus?: Array;
/**
* 文档ID
*/
DocBizId?: string;
/**
* 来源(1 文档生成 2 批量导入 3 手动添加)
不填默认值为0,表示不过滤,返回所有状态
*/
Source?: number;
/**
* 查询答案
*/
QueryAnswer?: string;
/**
* 分类ID
*/
CateBizId?: string;
/**
* QA业务ID列表
*/
QaBizIds?: Array;
/**
* 查询类型 filename 名称、 attribute 标签
如果不填默认值为"filename"
*/
QueryType?: string;
/**
* 是否只展示当前分类的数据 0不是,1是
*/
ShowCurrCate?: number;
/**
* 问答生效域检索,不检索不传。枚举值如下:
1-不生效;2-仅开发域生效;3-仅发布域生效;4-开发域和发布域均生效。
*/
EnableScope?: number;
}
/**
* 知识库容量饼图详情
*/
export interface KnowledgeCapacityPieGraphDetail {
/**
* 当前应用名称
注意:此字段可能返回 null,表示取不到有效值。
*/
AppName?: string;
/**
* 当前应用使用的字符数
注意:此字段可能返回 null,表示取不到有效值。
*/
UsedCharSize?: string;
/**
* 当前应用对于总用量的占比
注意:此字段可能返回 null,表示取不到有效值。
*/
Proportion?: number;
/**
* 知识库类型:0默认1共享
*/
KnowledgeType?: number;
}
/**
* 模型参数范围
*/
export interface ModelParameter {
/**
* 超参名称
注意:此字段可能返回 null,表示取不到有效值。
*/
Name?: string;
/**
* 类型
*/
Type?: string;
/**
* 默认值
*/
DefaultValue?: string;
/**
* 枚举值
*/
EnumValues?: Array;
/**
* 默认值
注意:此字段可能返回 null,表示取不到有效值。
*/
Default?: number;
/**
* 最小值
注意:此字段可能返回 null,表示取不到有效值。
*/
Min?: number;
/**
* 最大值
注意:此字段可能返回 null,表示取不到有效值。
*/
Max?: number;
}
/**
* 请求的API信息
*/
export interface InvokeAPI {
/**
* 请求方法,如GET/POST等
注意:此字段可能返回 null,表示取不到有效值。
*/
Method?: string;
/**
* 请求地址
注意:此字段可能返回 null,表示取不到有效值。
*/
Url?: string;
/**
* header参数
注意:此字段可能返回 null,表示取不到有效值。
*/
HeaderValues?: Array;
/**
* 入参Query
注意:此字段可能返回 null,表示取不到有效值。
*/
QueryValues?: Array;
/**
* Post请求的原始数据
注意:此字段可能返回 null,表示取不到有效值。
*/
RequestPostBody?: string;
/**
* 返回的原始数据
注意:此字段可能返回 null,表示取不到有效值。
*/
ResponseBody?: string;
/**
* 出参
注意:此字段可能返回 null,表示取不到有效值。
*/
ResponseValues?: Array;
/**
* 异常信息
注意:此字段可能返回 null,表示取不到有效值。
*/
FailMessage?: string;
}
/**
* mcp的服务信息
*/
export interface AgentMCPServerInfo {
/**
* mcp server URL地址
*/
McpServerUrl?: string;
/**
* mcp server header信息
*/
Headers?: Array;
/**
* 超时时间,单位秒
*/
Timeout?: number;
/**
* sse服务超时时间,单位秒
*/
SseReadTimeout?: number;
/**
* mcp server query信息
*/
Query?: Array;
}
/**
* ModifyApp返回参数结构体
*/
export interface ModifyAppResponse {
/**
* 应用App
注意:此字段可能返回 null,表示取不到有效值。
*/
AppBizId?: string;
/**
* 更新时间
*/
UpdateTime?: string;
/**
* 唯一请求 ID,由服务端生成,每次请求都会返回(若请求因其他原因未能抵达服务端,则该次请求不会获得 RequestId)。定位问题时需要提供该次请求的 RequestId。
*/
RequestId?: string;
}
/**
* IgnoreUnsatisfiedReply请求参数结构体
*/
export interface IgnoreUnsatisfiedReplyRequest {
/**
* 应用ID
*/
BotBizId: string;
/**
* 不满意回复ID
*/
ReplyBizIds: Array;
/**
* 登录用户主账号(集成商模式必填)
*/
LoginUin?: string;
/**
* 登录用户子账号(集成商模式必填)
*/
LoginSubAccountUin?: string;
}
/**
* ListReleaseConfigPreview返回参数结构体
*/
export interface ListReleaseConfigPreviewResponse {
/**
* 数量
*/
Total?: string;
/**
* 配置项列表
*/
List?: Array;
/**
* 唯一请求 ID,由服务端生成,每次请求都会返回(若请求因其他原因未能抵达服务端,则该次请求不会获得 RequestId)。定位问题时需要提供该次请求的 RequestId。
*/
RequestId?: 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;
}
/**
* 标签过滤器
*/
export interface AgentKnowledgeFilterTag {
/**
* 标签之间的关系;0:AND, 1:OR
*/
Operator?: number;
/**
* 标签
*/
Labels?: Array;
}
/**
* 自定义变量和标签关系数据
*/
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;
/**
* TraceId
注意:此字段可能返回 null,表示取不到有效值。
*/
TraceId?: string;
/**
* 文件信息
注意:此字段可能返回 null,表示取不到有效值。
*/
Files?: Array;
}
/**
* CheckAttributeLabelRefer请求参数结构体
*/
export interface CheckAttributeLabelReferRequest {
/**
* 应用ID,获取方法参看如何获取[BotBizId](https://cloud.tencent.com/document/product/1759/109469#4eecb8c1-6ce4-45f5-8fa2-b269449d8efa)
*/
BotBizId: string;
/**
* 登录用户主账号(集成商模式必填)
*/
LoginUin?: string;
/**
* 登录用户子账号(集成商模式必填)
*/
LoginSubAccountUin?: string;
/**
* 属性标签ID
*/
LabelBizId?: string;
/**
* 标签ID
*/
AttributeBizId?: Array;
}
/**
* Agent 知识库检索插件支持多知识库搜索
*/
export interface AgentKnowledge {
/**
* 知识库id
*/
KnowledgeBizId?: string;
/**
* 0-应用内知识库
1-共享知识库
*/
KnowledgeType?: number;
/**
* 0-全部知识
1-按文档和问答
2-按标签
*/
Filter?: number;
/**
* 文档id
*/
DocBizIds?: Array;
/**
* true:包含所有问答
false:不包含问答
*/
AllQa?: boolean;
/**
* 文档标签过滤器
*/
Tag?: AgentKnowledgeFilterTag;
}
/**
* UpdateVar返回参数结构体
*/
export interface UpdateVarResponse {
/**
* 变量ID
*/
VarId?: string;
/**
* 唯一请求 ID,由服务端生成,每次请求都会返回(若请求因其他原因未能抵达服务端,则该次请求不会获得 RequestId)。定位问题时需要提供该次请求的 RequestId。
*/
RequestId?: string;
}
/**
* ListWorkflowRuns请求参数结构体
*/
export interface ListWorkflowRunsRequest {
/**
* 应用ID, 获取方法参看如何获取 [BotBizId](https://cloud.tencent.com/document/product/1759/109469#4eecb8c1-6ce4-45f5-8fa2-b269449d8efa)
*/
AppBizId: string;
/**
* 每页数量(取值范围1-200)
*/
PageSize: number;
/**
* 运行环境。0: 测试环境; 1: 正式环境
*/
RunEnv?: number;
/**
* 页码(必须大于0)
*/
Page?: number;
/**
* 登录用户主账号(集成商模式必填)
*/
LoginUin?: string;
/**
* 登录用户子账号(集成商模式必填)
*/
LoginSubAccountUin?: string;
}
/**
* ListReleaseDocPreview返回参数结构体
*/
export interface ListReleaseDocPreviewResponse {
/**
* 文档数量
*/
Total?: string;
/**
* 文档列表
*/
List?: Array;
/**
* 唯一请求 ID,由服务端生成,每次请求都会返回(若请求因其他原因未能抵达服务端,则该次请求不会获得 RequestId)。定位问题时需要提供该次请求的 RequestId。
*/
RequestId?: string;
}
/**
* 任务流程调试信息
*/
export interface TaskFlowSummary {
/**
* 任务流程名
注意:此字段可能返回 null,表示取不到有效值。
*/
IntentName?: string;
/**
* 实体列表
注意:此字段可能返回 null,表示取不到有效值。
*/
UpdatedSlotValues?: Array;
/**
* 节点列表
注意:此字段可能返回 null,表示取不到有效值。
*/
RunNodes?: Array;
/**
* 意图判断
注意:此字段可能返回 null,表示取不到有效值。
*/
Purposes?: Array;
}
/**
* 重复文档处理方式
*/
export interface DuplicateFileHandle {
/**
* 重复文档判断方式,1:按文档内容,即cos_hash字段判断是否重复
*/
CheckType?: number;
/**
* 重复文档处理方式,1:返回报错,2:跳过,返回重复的文档业务ID
*/
HandleType?: number;
}
/**
* 标签值引用的工作流详情
*/
export interface AttributeLabelRefByWorkflow {
/**
* 标签值id
*/
AttributeLabelBizId?: string;
/**
* 标签值引用的工作流列表
*/
WorkflowList?: Array;
}
/**
* RetryDocAudit请求参数结构体
*/
export interface RetryDocAuditRequest {
/**
* 应用ID
*/
BotBizId: string;
/**
* 文档ID
*/
DocBizId: string;
}
/**
* ExportUnsatisfiedReply请求参数结构体
*/
export interface ExportUnsatisfiedReplyRequest {
/**
* 应用ID
若要操作共享知识库,传KnowledgeBizId
*/
BotBizId: string;
/**
* 勾选导出不满意回复的ID列表
*/
ReplyBizIds: Array;
/**
* 登录用户主账号(集成商模式必填)
*/
LoginUin?: string;
/**
* 登录用户子账号(集成商模式必填)
*/
LoginSubAccountUin?: string;
/**
* 检索过滤器
*/
Filters?: Filters;
}
/**
* 文件收集信息
*/
export interface FileCollection {
/**
* 最大上传文件的数量
*/
MaxFileCount: number;
/**
* 支持的上传文件类型
注意:此字段可能返回 null,表示取不到有效值。
*/
SupportedFileTypes: Array;
}
/**
* ListReleaseDocPreview请求参数结构体
*/
export interface ListReleaseDocPreviewRequest {
/**
* 应用ID(获取方法参看如何获取 [BotBizId](https://cloud.tencent.com/document/product/1759/109469#4eecb8c1-6ce4-45f5-8fa2-b269449d8efa))
*/
BotBizId: string;
/**
* 页码(必须大于0)
*/
PageNumber: number;
/**
* 每页数量(取值范围为1-200)
*/
PageSize: number;
/**
* 查询内容关键字,用于模糊查询,若未提供该参数,默认为查询全部。
*/
Query?: string;
/**
* 发布单ID(可以通过[ListRelease](https://cloud.tencent.com/document/product/1759/105077)获得)
*/
ReleaseBizId?: string;
/**
* 开始时间。Unix 时间戳,单位是秒,默认为空。
*/
StartTime?: string;
/**
* 结束时间。Unix 时间戳,单位是秒,默认为空。
*/
EndTime?: string;
/**
* 状态(1新增2修改3删除),其和ReleaseStatus的区别为: Actions表示的是对数据/内容的操作状态,ReleaseStatus表示数据 / 内容本身的发布状态
*/
Actions?: Array;
}
/**
* 问题可选项
*/
export interface QuestionOption {
/**
* 选项的标签
*/
Label?: string;
/**
* 选项的描述
*/
Description?: string;
}
/**
* 数智人配置
*/
export interface DigitalHumanConfig {
/**
* 数智人资产key
*/
AssetKey?: string;
/**
* 数智人名称
*/
Name?: string;
/**
* 图像
*/
Avatar?: string;
/**
* 预览图
*/
PreviewUrl?: string;
}
/**
* ExportUnsatisfiedReply返回参数结构体
*/
export interface ExportUnsatisfiedReplyResponse {
/**
* 唯一请求 ID,由服务端生成,每次请求都会返回(若请求因其他原因未能抵达服务端,则该次请求不会获得 RequestId)。定位问题时需要提供该次请求的 RequestId。
*/
RequestId?: string;
}
/**
* DescribeStorageCredential返回参数结构体
*/
export interface DescribeStorageCredentialResponse {
/**
* 密钥信息
*/
Credentials?: Credentials;
/**
* 失效时间
*/
ExpiredTime?: number;
/**
* 开始时间
*/
StartTime?: number;
/**
* 对象存储桶
*/
Bucket?: string;
/**
* 对象存储可用区
*/
Region?: string;
/**
* 文件存储目录
*/
FilePath?: string;
/**
* 存储类型
*/
Type?: string;
/**
* 企业主账号
*/
CorpUin?: string;
/**
* 图片存储目录
*/
ImagePath?: string;
/**
* 上传存储路径,到具体文件
*/
UploadPath?: string;
/**
* 文件上传地址,使用put请求上传文件到该地址
*/
UploadUrl?: string;
/**
* 文件的预签名地址,支持下载
*/
FileUrl?: string;
/**
* 唯一请求 ID,由服务端生成,每次请求都会返回(若请求因其他原因未能抵达服务端,则该次请求不会获得 RequestId)。定位问题时需要提供该次请求的 RequestId。
*/
RequestId?: string;
}
/**
* DescribeRefer返回参数结构体
*/
export interface DescribeReferResponse {
/**
* 引用列表
*/
List?: Array;
/**
* 唯一请求 ID,由服务端生成,每次请求都会返回(若请求因其他原因未能抵达服务端,则该次请求不会获得 RequestId)。定位问题时需要提供该次请求的 RequestId。
*/
RequestId?: string;
}
/**
* WorkflowRef详情
*/
export interface WorkflowRef {
/**
* 任务流ID
*/
WorkflowId?: string;
/**
* 任务流名称
*/
WorkflowName?: string;
/**
* 任务流描述
*/
WorkflowDesc?: string;
/**
* 应用ID
*/
AppBizId?: string;
/**
* 更新时间
*/
UpdateTime?: number;
}
/**
* ListDocCate返回参数结构体
*/
export interface ListDocCateResponse {
/**
* 列表
*/
List?: Array;
/**
* 唯一请求 ID,由服务端生成,每次请求都会返回(若请求因其他原因未能抵达服务端,则该次请求不会获得 RequestId)。定位问题时需要提供该次请求的 RequestId。
*/
RequestId?: string;
}
/**
* 问卷的问题
*/
export interface QuestionnaireQuestion {
/**
* 问题的序号
*/
Index?: number;
/**
* 问题的内容
*/
Question?: string;
/**
* 问题类型
*/
Type?: number;
/**
* 是否必选
*/
Required?: boolean;
/**
* 问题的选项
*/
Options?: Array;
}
/**
* 知识检索筛选范围
*/
export interface AgentKnowledgeFilter {
/**
* 知识检索筛选方式; 0: 全部知识; 1:按文档和问答; 2: 按标签
*/
FilterType?: number;
/**
* 文档和问答过滤器
*/
DocAndAnswer?: AgentKnowledgeFilterDocAndAnswer;
/**
* 标签过滤器
*/
Tag?: AgentKnowledgeFilterTag;
/**
* 知识库列表
*/
KnowledgeList?: Array;
/**
* 是否检索全部知识
*/
AllKnowledge?: boolean;
}
/**
* 应用管理输出配置
*/
export interface KnowledgeQaOutput {
/**
* 输出方式 1:流式 2:非流式
注意:此字段可能返回 null,表示取不到有效值。
*/
Method?: number;
/**
* 通用模型回复
注意:此字段可能返回 null,表示取不到有效值。
*/
UseGeneralKnowledge?: boolean;
/**
* 未知回复语,300字符以内
注意:此字段可能返回 null,表示取不到有效值。
*/
BareAnswer?: string;
/**
* 是否展示问题澄清开关
注意:此字段可能返回 null,表示取不到有效值。
*/
ShowQuestionClarify?: boolean;
/**
* 是否打开问题澄清
注意:此字段可能返回 null,表示取不到有效值。
*/
UseQuestionClarify?: boolean;
/**
* 问题澄清关键词列表
注意:此字段可能返回 null,表示取不到有效值。
*/
QuestionClarifyKeywords?: Array;
/**
* 是否打开推荐问题开关
注意:此字段可能返回 null,表示取不到有效值。
*/
UseRecommended?: boolean;
/**
* 推荐问模式,0.结合知识库&对话历史推荐问题Prompt(默认) 1.仅结合知识库输出推荐问的prompt
注意:此字段可能返回 null,表示取不到有效值。
*/
RecommendedPromptMode?: number;
/**
* 输入框按钮配置
*/
InputBoxConfig?: InputBoxConfig;
}
/**
* 工作流运行实例的基本信息
*/
export interface WorkflowRunBase {
/**
* 运行环境。0: 测试环境; 1: 正式环境
*/
RunEnv?: number;
/**
* 应用ID
*/
AppBizId?: string;
/**
* 工作流运行实例的ID
*/
WorkflowRunId?: string;
/**
* 所属工作流ID
*/
WorkflowId?: string;
/**
* 名称
*/
Name?: string;
/**
* 运行状态。0: 排队中;1: 运行中;2: 运行成功;3: 运行失败; 4: 已取消
*/
State?: number;
/**
* 错误信息
*/
FailMessage?: string;
/**
* 消耗的token总数
*/
TotalTokens?: number;
/**
* 创建时间(毫秒时间戳)
*/
CreateTime?: string;
/**
* 开始时间(毫秒时间戳)
*/
StartTime?: string;
/**
* 结束时间(毫秒时间戳)
*/
EndTime?: string;
}
/**
* 应用模型配置
*/
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;
/**
* 模型参数
注意:此字段可能返回 null,表示取不到有效值。
*/
ModelParams?: ModelParams;
}
/**
* 工作流运行节点信息
*/
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;
/**
* 错误代码
注意:此字段可能返回 null,表示取不到有效值。
*/
FailCode?: string;
}
/**
* GetLikeDataCount请求参数结构体
*/
export interface GetLikeDataCountRequest {
/**
* 开始日期
*/
StartTime: number;
/**
* 结束日期
*/
EndTime: number;
/**
* 应用id
*/
AppBizId?: Array;
/**
* 消息来源(1、分享用户端 2、对话API)
*/
Type?: number;
/**
* 登录用户主账号(集成商模式必填)
*/
LoginUin?: string;
/**
* 登录用户子账号(集成商模式必填)
*/
LoginSubAccountUin?: string;
}
/**
* ListAttributeLabel返回参数结构体
*/
export interface ListAttributeLabelResponse {
/**
* 总数
*/
Total?: string;
/**
* 列表
*/
List?: Array;
/**
* 唯一请求 ID,由服务端生成,每次请求都会返回(若请求因其他原因未能抵达服务端,则该次请求不会获得 RequestId)。定位问题时需要提供该次请求的 RequestId。
*/
RequestId?: string;
}
/**
* ModifyQAAttrRange请求参数结构体
*/
export interface ModifyQAAttrRangeRequest {
/**
* 应用ID
*/
BotBizId: string;
/**
* 问答ID
*/
QaBizIds: Array;
/**
* 属性标签适用范围 1:全部,2:按条件
*/
AttrRange: number;
/**
* 属性标签引用
*/
AttrLabels: Array;
}
/**
* 分类信息
*/
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;
/**
* 是否为叶子节点
注意:此字段可能返回 null,表示取不到有效值。
*/
IsLeaf?: boolean;
}
/**
* 网页搜索内容
*/
export interface WebSearchContent {
/**
* 网页搜索结果,json格式的string
*/
Content?: string;
}
/**
* DeleteRejectedQuestion返回参数结构体
*/
export interface DeleteRejectedQuestionResponse {
/**
* 唯一请求 ID,由服务端生成,每次请求都会返回(若请求因其他原因未能抵达服务端,则该次请求不会获得 RequestId)。定位问题时需要提供该次请求的 RequestId。
*/
RequestId?: string;
}
/**
* ListRejectedQuestionPreview请求参数结构体
*/
export interface ListRejectedQuestionPreviewRequest {
/**
* 应用ID(获取方法参看如何获取 [BotBizId](https://cloud.tencent.com/document/product/1759/109469#4eecb8c1-6ce4-45f5-8fa2-b269449d8efa))
*/
BotBizId: string;
/**
* 页码(必须大于0)
*/
PageNumber: number;
/**
* 每页数量(取值范围为1-200)
*/
PageSize: number;
/**
* 查询内容关键字,用于模糊查询,若未提供该参数,默认为查询全部。
*/
Query?: string;
/**
* 发布单ID(可以通过[ListRelease](https://cloud.tencent.com/document/product/1759/105077)获得)
*/
ReleaseBizId?: string;
/**
* 状态(1新增2更新3删除)
*/
Actions?: Array;
/**
* 开始时间。Unix 时间戳,单位是秒,默认为空。
*/
StartTime?: string;
/**
* 结束时间。Unix 时间戳,单位是秒,默认为空。
*/
EndTime?: string;
}
/**
* ListSelectDoc请求参数结构体
*/
export interface ListSelectDocRequest {
/**
* 应用ID,获取方法参看如何获取[BotBizId](https://cloud.tencent.com/document/product/1759/109469#4eecb8c1-6ce4-45f5-8fa2-b269449d8efa)
*/
BotBizId: string;
/**
* 文档名称。可通过文档名称检索支持生成问答的文档,不支持xlsx、xls、csv格式
*/
FileName?: string;
/**
* 文档状态筛选。文档状态对应码为7 审核中、8 审核失败、10 待发布、11 发布中、12 已发布、13 学习中、14 学习失败 20 已过期。其中仅状态为10 待发布、12 已发布的文档支持生成问答(未填写时默认值为空数组)
*/
Status?: Array;
}
/**
* 工具高级设置
*/
export interface ToolAdvanceConfig {
/**
* 工具调用结果是否直接返回给用户
*/
EnableDirectResultReturn?: boolean;
/**
* 输出样式 1-文本 2-json 3-widget
*/
OutputType?: number;
/**
* 原始结构化JSON输出
*/
RawStructuredOutput?: string;
/**
* 自定义文本输出,多行展示
*/
CustomTextOutputs?: string;
/**
* Widget输出配置
*/
OutputWidgetConfig?: OutputWidgetConfig;
}
/**
* 实时上传的文件信息
*/
export interface FileInfo {
/**
* 文件名称
注意:此字段可能返回 null,表示取不到有效值。
*/
FileName?: string;
/**
* 文件大小
注意:此字段可能返回 null,表示取不到有效值。
*/
FileSize?: string;
/**
* 文件的URL地址,COS地址
注意:此字段可能返回 null,表示取不到有效值。
*/
FileUrl?: string;
/**
* 文件类型
注意:此字段可能返回 null,表示取不到有效值。
*/
FileType?: string;
/**
* 解析后返回的DocID
注意:此字段可能返回 null,表示取不到有效值。
*/
DocId?: string;
/**
* 创建时间
注意:此字段可能返回 null,表示取不到有效值。
*/
CreatedAt?: string;
}
/**
* ModifyApp请求参数结构体
*/
export interface ModifyAppRequest {
/**
* 应用ID, 获取方法参看如何获取 [BotBizId](https://cloud.tencent.com/document/product/1759/109469#4eecb8c1-6ce4-45f5-8fa2-b269449d8efa)。
*/
AppBizId: string;
/**
* 应用类型;"knowledge_qa" 知识问答应用(包含标准模式 单工作流 Multi-Agent 等模式)
*/
AppType: string;
/**
* 应用基础配置
*/
BaseConfig: BaseConfig;
/**
* 应用配置
*/
AppConfig: AppConfig;
/**
* 登录用户子账号(集成商模式必填)
*/
LoginSubAccountUin?: string;
}
/**
* DeleteVar返回参数结构体
*/
export interface DeleteVarResponse {
/**
* 唯一请求 ID,由服务端生成,每次请求都会返回(若请求因其他原因未能抵达服务端,则该次请求不会获得 RequestId)。定位问题时需要提供该次请求的 RequestId。
*/
RequestId?: string;
}
/**
* 用户手写输入
*/
export interface AgentInputUserInputValue {
/**
* 用户输入的值
*/
Values?: Array;
}
/**
* 参数配置列表
*/
export interface ParameterConfig {
/**
* 字段名称
*/
Name?: string;
/**
* 字段描述
*/
Description?: string;
/**
* 字段类型
*/
Type?: number;
/**
* 是否必填
*/
IsRequired?: boolean;
/**
* 子参数
*/
SubParams?: Array;
/**
* OneOf类型的参数
*/
OneOf?: Array;
/**
* AnyOf类型的参数
*/
AnyOf?: Array;
}
/**
* DeleteDocCate请求参数结构体
*/
export interface DeleteDocCateRequest {
/**
* 应用ID
*/
BotBizId: string;
/**
* 分类业务ID
*/
CateBizId: string;
}
/**
* 标签提取配置
*/
export interface ClassifyConfig {
/**
* 模型配置
注意:此字段可能返回 null,表示取不到有效值。
*/
Model?: AppModel;
/**
* 标签列表
注意:此字段可能返回 null,表示取不到有效值。
*/
Labels?: Array;
/**
* 欢迎语,200字符以内
注意:此字段可能返回 null,表示取不到有效值。
*/
Greeting?: string;
}
/**
* DescribeConcurrencyUsage请求参数结构体
*/
export interface DescribeConcurrencyUsageRequest {
/**
* 模型标识
*/
ModelName: string;
/**
* 开始时间戳, 单位为秒(废弃)
*/
StartTime?: string;
/**
* 结束时间戳, 单位为秒(废弃)
*/
EndTime?: string;
/**
* 应用id列表
*/
AppBizIds?: Array;
/**
* 空间id
*/
SpaceId?: string;
/**
* 开始时间戳, 单位为秒
*/
StatStartTime?: number;
/**
* 结束时间戳, 单位为秒
*/
StatEndTime?: number;
}
/**
* ListQACate请求参数结构体
*/
export interface ListQACateRequest {
/**
* 应用ID
若要操作共享知识库,传KnowledgeBizId
*/
BotBizId: string;
/**
* 分类查询类型:0-全量查询整棵标签树,1-根据父节点BizId分页查询子节点,2-关键词检索所有匹配的分类链路
*/
QueryType?: number;
/**
* QueryType=1时,父节点分类ID
*/
ParentCateBizId?: string;
/**
* QueryType=1时,页码(从1开始)
*/
PageNumber?: number;
/**
* 每页数量(默认10)
*/
PageSize?: number;
/**
* QueryType=2时,搜索内容
*/
Query?: string;
}
/**
* ListReleaseQAPreview请求参数结构体
*/
export interface ListReleaseQAPreviewRequest {
/**
* 应用ID(获取方法参看如何获取 [BotBizId](https://cloud.tencent.com/document/product/1759/109469#4eecb8c1-6ce4-45f5-8fa2-b269449d8efa))
*/
BotBizId: string;
/**
* 页码(必须大于0)
*/
PageNumber: number;
/**
* 每页数量(取值范围为1-200)
*/
PageSize: number;
/**
* 查询内容关键字,用于模糊查询,若未提供该参数,默认为查询全部。
*/
Query?: string;
/**
* 发布单ID(可以通过[ListRelease](https://cloud.tencent.com/document/product/1759/105077)获得)
*/
ReleaseBizId?: string;
/**
* 开始时间。Unix 时间戳,单位是秒,默认为空。
*/
StartTime?: string;
/**
* 结束时间。Unix 时间戳,单位是秒,默认为空。
*/
EndTime?: string;
/**
* 状态(1新增2修改3删除),其和ReleaseStatus的区别为:Actions表示的是对数据/内容的操作状态,ReleaseStatus表示数据/内容本身的发布状态
*/
Actions?: Array;
/**
* 发布状态(4发布成功5发布失败)。其和Actions的区别为:Actions表示的是对数据/内容的操作状态,ReleaseStatus表示数据/内容本身的发布状态
*/
ReleaseStatus?: Array;
}
/**
* 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;
/**
* 应用是否在复制中
*/
IsCopying?: boolean;
/**
* 智能体类型 dialogue 对话式智能体,wechat 公众号智能体
*/
AgentType?: string;
/**
* 唯一请求 ID,由服务端生成,每次请求都会返回(若请求因其他原因未能抵达服务端,则该次请求不会获得 RequestId)。定位问题时需要提供该次请求的 RequestId。
*/
RequestId?: string;
}
/**
* DeleteApp请求参数结构体
*/
export interface DeleteAppRequest {
/**
* 应用ID,获取方法参看如何获取 [BotBizId](https://cloud.tencent.com/document/product/1759/109469#4eecb8c1-6ce4-45f5-8fa2-b269449d8efa)。
*/
AppBizId: string;
/**
* 应用类型;`"knowledge_qa"` 知识问答应用(包含标准模式 单工作流 Multi-Agent 等模式)
*/
AppType?: string;
}
/**
* GetVarList返回参数结构体
*/
export interface GetVarListResponse {
/**
* 变量总数
*/
Total?: number;
/**
* 变量信息列表
*/
List?: Array;
/**
* 唯一请求 ID,由服务端生成,每次请求都会返回(若请求因其他原因未能抵达服务端,则该次请求不会获得 RequestId)。定位问题时需要提供该次请求的 RequestId。
*/
RequestId?: string;
}
/**
* 工作流程调试信息
*/
export interface WorkFlowSummary {
/**
* 工作流ID
注意:此字段可能返回 null,表示取不到有效值。
*/
WorkflowId?: string;
/**
* 工作流名称
注意:此字段可能返回 null,表示取不到有效值。
*/
WorkflowName?: string;
/**
* 工作流运行ID
注意:此字段可能返回 null,表示取不到有效值。
*/
WorkflowRunId?: string;
/**
* 节点信息
注意:此字段可能返回 null,表示取不到有效值。
*/
RunNodes?: Array;
/**
* 选项卡
注意:此字段可能返回 null,表示取不到有效值。
*/
OptionCards?: Array;
/**
* 多气泡的输出结果
注意:此字段可能返回 null,表示取不到有效值。
*/
Outputs?: Array;
/**
* 工作流发布时间,unix时间戳
注意:此字段可能返回 null,表示取不到有效值。
*/
WorkflowReleaseTime?: string;
/**
* 中间消息
*/
PendingMessages?: Array;
/**
* 选项卡索引
*/
OptionCardIndex?: OptionCardIndex;
/**
* 工作流多气泡输出
注意:此字段可能返回 null,表示取不到有效值。
*/
Contents?: Array;
}
/**
* DescribeNodeRun返回参数结构体
*/
export interface DescribeNodeRunResponse {
/**
* 节点运行实例详情
*/
NodeRun?: NodeRunDetail;
/**
* 唯一请求 ID,由服务端生成,每次请求都会返回(若请求因其他原因未能抵达服务端,则该次请求不会获得 RequestId)。定位问题时需要提供该次请求的 RequestId。
*/
RequestId?: string;
}
/**
* ModifyQA返回参数结构体
*/
export interface ModifyQAResponse {
/**
* 唯一请求 ID,由服务端生成,每次请求都会返回(若请求因其他原因未能抵达服务端,则该次请求不会获得 RequestId)。定位问题时需要提供该次请求的 RequestId。
*/
RequestId?: string;
}
/**
* DeleteQA返回参数结构体
*/
export interface DeleteQAResponse {
/**
* 唯一请求 ID,由服务端生成,每次请求都会返回(若请求因其他原因未能抵达服务端,则该次请求不会获得 RequestId)。定位问题时需要提供该次请求的 RequestId。
*/
RequestId?: string;
}
/**
* UpdateSharedKnowledge请求参数结构体
*/
export interface UpdateSharedKnowledgeRequest {
/**
* 共享知识库业务ID
*/
KnowledgeBizId: string;
/**
* 共享知识库更新信息
*/
Info?: KnowledgeUpdateInfo;
}
/**
* GetMsgRecord请求参数结构体
*/
export interface GetMsgRecordRequest {
/**
* 接入类型, 5-API 访客,目前仅支持传5
*/
Type: number;
/**
* 数量, 数量需大于2, 最大1000
*/
Count: number;
/**
* 会话sessionid。
*/
SessionId: string;
/**
* 应用AppKey, 当Type=5[API访客]时, 该字段必填 : 获取方式: 1、应用发布后在应用页面[发布管理]-[调用信息]-[API管理]处获取 2、参考 https://cloud.tencent.com/document/product/1759/109469 第二项
*/
BotAppKey?: string;
/**
* 场景, 体验: 1; 正式: 2 。
体验用于创建应用测试的时候使用,正式是应用发布后对外的时候使用
*/
Scene?: number;
/**
* 最后一条记录ID, 消息从后往前获取
MidRecordId与LastRecordId只能选择一个
LastRecordId 和MidRecordId都不填的时候,默认从最新的消息ID开始取。
*/
LastRecordId?: string;
/**
* 传该值,代表拉取该记录id的前后总共count条消息记录
MidRecordId与LastRecordId只能选择一个
LastRecordId 和MidRecordId都不填的时候,默认从最新的消息Id开始取
*/
MidRecordId?: string;
}
/**
* 音频转录的文本内容
*/
export interface AudioTranscript {
/**
* 音频的发言者
注意:此字段可能返回 null,表示取不到有效值。
*/
Speaker?: string;
/**
* 音频转录为文字后的内容
注意:此字段可能返回 null,表示取不到有效值。
*/
Transcript?: string;
}
/**
* UpdateSharedKnowledge返回参数结构体
*/
export interface UpdateSharedKnowledgeResponse {
/**
* 共享知识库业务ID
*/
KnowledgeBizId?: string;
/**
* 唯一请求 ID,由服务端生成,每次请求都会返回(若请求因其他原因未能抵达服务端,则该次请求不会获得 RequestId)。定位问题时需要提供该次请求的 RequestId。
*/
RequestId?: string;
}
/**
* 输入框配置
*/
export interface InputBoxConfig {
/**
* 输入框按钮,1:上传图片、2:上传文档,3:腾讯文档,4:联网搜索
*/
InputBoxButtons?: Array;
}
/**
* 发布配置项
*/
export interface ReleaseConfigs {
/**
* 配置项描述
注意:此字段可能返回 null,表示取不到有效值。
*/
ConfigItem?: string;
/**
* 更新时间
注意:此字段可能返回 null,表示取不到有效值。
*/
UpdateTime?: string;
/**
* 状态
2:待发布
3:发布中
4:已发布
5:发布失败
注意:此字段可能返回 null,表示取不到有效值。
*/
Action?: number;
/**
* 变更后的内容
注意:此字段可能返回 null,表示取不到有效值。
*/
Value?: string;
/**
* 变更前的内容
注意:此字段可能返回 null,表示取不到有效值。
*/
LastValue?: string;
/**
* 变更内容(优先级展示content内容,content为空取value内容)
注意:此字段可能返回 null,表示取不到有效值。
*/
Content?: string;
/**
* 失败原因
注意:此字段可能返回 null,表示取不到有效值。
*/
Message?: string;
}
/**
* DescribeSearchStatsGraph返回参数结构体
*/
export interface DescribeSearchStatsGraphResponse {
/**
* 统计结果
注意:此字段可能返回 null,表示取不到有效值。
*/
List?: Array;
/**
* 唯一请求 ID,由服务端生成,每次请求都会返回(若请求因其他原因未能抵达服务端,则该次请求不会获得 RequestId)。定位问题时需要提供该次请求的 RequestId。
*/
RequestId?: string;
}
/**
* ModifyQAAttrRange返回参数结构体
*/
export interface ModifyQAAttrRangeResponse {
/**
* 唯一请求 ID,由服务端生成,每次请求都会返回(若请求因其他原因未能抵达服务端,则该次请求不会获得 RequestId)。定位问题时需要提供该次请求的 RequestId。
*/
RequestId?: string;
}
/**
* StopDocParse返回参数结构体
*/
export interface StopDocParseResponse {
/**
* 唯一请求 ID,由服务端生成,每次请求都会返回(若请求因其他原因未能抵达服务端,则该次请求不会获得 RequestId)。定位问题时需要提供该次请求的 RequestId。
*/
RequestId?: string;
}
/**
* DescribeAppAgentList返回参数结构体
*/
export interface DescribeAppAgentListResponse {
/**
* 入口启动AgentID
*/
StaringAgentId?: string;
/**
* 应用Agent信息列表
*/
Agents?: Array;
/**
* Agent转交高级设置
*/
HandoffAdvancedSetting?: AgentHandoffAdvancedSetting;
/**
* Agent数量上限
*/
MaxAgentCount?: number;
/**
* 唯一请求 ID,由服务端生成,每次请求都会返回(若请求因其他原因未能抵达服务端,则该次请求不会获得 RequestId)。定位问题时需要提供该次请求的 RequestId。
*/
RequestId?: string;
}
/**
* DescribeQA返回参数结构体
*/
export interface DescribeQAResponse {
/**
* QA业务ID
*/
QaBizId?: string;
/**
* 问题
*/
Question?: string;
/**
* 答案
*/
Answer?: string;
/**
* 自定义参数
*/
CustomParam?: string;
/**
* 来源 1-文档生成问答对 2-批量导入问答对 3-单条手动录入问答对
*/
Source?: number;
/**
* 来源描述
*/
SourceDesc?: string;
/**
* 更新时间
*/
UpdateTime?: string;
/**
* 状态
1-未校验 2,4-导入完成 5-发布失败 6-不采纳 7-审核中 8-审核失败 9-审核失败申诉后人工审核中 11-审核失败申诉后人工审核不通过 12-已过期 13-超量失效 14-超量失效恢复 19-学习中 20-学习失败
*/
Status?: number;
/**
* 状态描述
*/
StatusDesc?: string;
/**
* 分类ID
*/
CateBizId?: string;
/**
* 是否允许校验
*/
IsAllowAccept?: boolean;
/**
* 是否允许删除
*/
IsAllowDelete?: boolean;
/**
* 是否允许编辑
*/
IsAllowEdit?: boolean;
/**
* 文档id
*/
DocBizId?: string;
/**
* 文档名称
*/
FileName?: string;
/**
* 文档类型
*/
FileType?: string;
/**
* 分片ID
*/
SegmentBizId?: string;
/**
* 分片内容
*/
PageContent?: string;
/**
* 分片高亮内容
*/
Highlights?: Array;
/**
* 分片内容
*/
OrgData?: string;
/**
* 标签适用范围
*/
AttrRange?: number;
/**
* 标签
*/
AttrLabels?: Array;
/**
* 有效开始时间,unix时间戳
*/
ExpireStart?: string;
/**
* 有效结束时间,unix时间戳,0代表永久有效
*/
ExpireEnd?: string;
/**
* 相似问列表信息
*/
SimilarQuestions?: Array;
/**
* 问题和答案文本审核状态 1审核失败
*/
QaAuditStatus?: number;
/**
* 答案中的图片审核状态 1审核失败
*/
PicAuditStatus?: number;
/**
* 答案中的视频审核状态 1审核失败
*/
VideoAuditStatus?: number;
/**
* 问题描述
*/
QuestionDesc?: string;
/**
* 问答是否停用,false:未停用,true已停用
*/
IsDisabled?: boolean;
/**
* 从根节点开始的路径分类ID
注意:此字段可能返回 null,表示取不到有效值。
*/
CateBizIdPath?: Array;
/**
* 从根节点开始的路径分类名称
注意:此字段可能返回 null,表示取不到有效值。
*/
CateNamePath?: Array;
/**
* 问答生效域: 1-不生效;2-仅开发域生效;3-仅发布域生效;4-开发域和发布域均生效
注意:此字段可能返回 null,表示取不到有效值。
*/
EnableScope?: number;
/**
* 问答关联的文档生效域:1-不生效;2-仅开发域生效;3-仅发布域生效;4-开发域和发布域均生效.
若问答未关联文档,则该字段值同问答生效域
*/
DocEnableScope?: number;
/**
* 唯一请求 ID,由服务端生成,每次请求都会返回(若请求因其他原因未能抵达服务端,则该次请求不会获得 RequestId)。定位问题时需要提供该次请求的 RequestId。
*/
RequestId?: string;
}
/**
* DescribeReleaseInfo请求参数结构体
*/
export interface DescribeReleaseInfoRequest {
/**
* 应用ID
*/
BotBizId: string;
}
/**
* ModifyQA请求参数结构体
*/
export interface ModifyQARequest {
/**
* 应用ID
若要操作共享知识库,传KnowledgeBizId
*/
BotBizId: string;
/**
* 问答ID
*/
QaBizId: string;
/**
* 问题
*/
Question: string;
/**
* 答案
*/
Answer: string;
/**
* 自定义参数
*/
CustomParam?: string;
/**
* 标签适用范围 1:全部,2:按条件
默认值:当没有属性标签,labelRefers为空时,默认值为1
有属性标签,labelRefers不为空,默认值为2
*/
AttrRange?: number;
/**
* 标签引用
*/
AttrLabels?: Array;
/**
* 文档ID
*/
DocBizId?: string;
/**
* 分类ID
*/
CateBizId?: string;
/**
* 有效开始时间,单位是unix时间戳,默认值为0,代表永久有效
*/
ExpireStart?: string;
/**
* 有效结束时间,单位是unix时间戳,默认值为0,代表永久有效
*/
ExpireEnd?: string;
/**
* 相似问修改信息(相似问没有修改则不传)
*/
SimilarQuestionModify?: SimilarQuestionModify;
/**
* 问题描述
*/
QuestionDesc?: string;
/**
* 问答生效范围: 1-不生效;2-仅开发域生效;3-仅发布域生效;4-开发域和发布域均生效。若不传该字段,则不修改问答的生效范围。
*/
EnableScope?: number;
}
/**
* 消息详情
*/
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;
/**
* 评价原因
*/
Reasons?: Array;
/**
* 是否大模型
*/
IsLlmGenerated?: boolean;
/**
* 图片链接,可公有读
注意:此字段可能返回 null,表示取不到有效值。
*/
ImageUrls?: Array;
/**
* 当次 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;
/**
* 任务信息
注意:此字段可能返回 null,表示取不到有效值。
*/
TaskFlow?: TaskFlowInfo;
/**
* 用户传入的文件信息
注意:此字段可能返回 null,表示取不到有效值。
*/
FileInfos?: Array;
/**
* 参考来源引用位置信息
注意:此字段可能返回 null,表示取不到有效值。
*/
QuoteInfos?: Array;
/**
* Agent的思考过程信息
注意:此字段可能返回 null,表示取不到有效值。
*/
AgentThought?: AgentThought;
/**
* 扩展信息
注意:此字段可能返回 null,表示取不到有效值。
*/
ExtraInfo?: ExtraInfo;
/**
* 工作流信息
注意:此字段可能返回 null,表示取不到有效值。
*/
WorkFlow?: WorkflowInfo;
/**
* Widget信息
注意:此字段可能返回 null,表示取不到有效值。
*/
Widgets?: Array;
/**
* Widget动作信息
注意:此字段可能返回 null,表示取不到有效值。
*/
WidgetAction?: WidgetAction;
/**
* 音频信息
注意:此字段可能返回 null,表示取不到有效值。
*/
Audios?: Array