AppConfig
应用配置
被如下接口引用：DescribeApp, ModifyApp。
| 名称 | 类型 | 必选 | 描述 |
|---|---|---|---|
| KnowledgeQa | KnowledgeQaConfig | 否 | 知识问答管理应用配置 注意：此字段可能返回 null，表示取不到有效值。 |
| Summary | SummaryConfig | 否 | 知识摘要应用配置 注意：此字段可能返回 null，表示取不到有效值。 |
| Classify | ClassifyConfig | 否 | 标签提取应用配置 注意：此字段可能返回 null，表示取不到有效值。 |
AppInfo
应用详情
被如下接口引用：ListApp。
| 名称 | 类型 | 必选 | 描述 |
|---|---|---|---|
| AppType | String | 否 | 应用类型；knowledge_qa-知识问答管理；summary-知识摘要；classifys-知识标签提取 注意：此字段可能返回 null，表示取不到有效值。 |
| AppTypeDesc | String | 否 | 应用类型描述 注意：此字段可能返回 null，表示取不到有效值。 |
| AppBizId | String | 否 | 应用ID 注意：此字段可能返回 null，表示取不到有效值。 |
| Name | String | 否 | 应用名称 注意：此字段可能返回 null，表示取不到有效值。 |
| Avatar | String | 否 | 应用头像 注意：此字段可能返回 null，表示取不到有效值。 |
| Desc | String | 否 | 应用描述 注意：此字段可能返回 null，表示取不到有效值。 |
| AppStatus | Integer | 否 | 应用状态，1：未上线，2：运行中，3：停用 注意：此字段可能返回 null，表示取不到有效值。 |
| AppStatusDesc | String | 否 | 状态说明 注意：此字段可能返回 null，表示取不到有效值。 |
| UpdateTime | String | 否 | 修改时间 注意：此字段可能返回 null，表示取不到有效值。 |
| Operator | String | 否 | 最后修改人 注意：此字段可能返回 null，表示取不到有效值。 |
| ModelName | String | 否 | 模型名称 注意：此字段可能返回 null，表示取不到有效值。 |
| ModelAliasName | String | 否 | 模型别名 注意：此字段可能返回 null，表示取不到有效值。 |
AppModel
应用模型配置
被如下接口引用：DescribeApp, ModifyApp。
| 名称 | 类型 | 必选 | 描述 |
|---|---|---|---|
| Name | String | 否 | 模型名称 注意：此字段可能返回 null，表示取不到有效值。 |
| Desc | String | 否 | 模型描述 注意：此字段可能返回 null，表示取不到有效值。 |
| ContextLimit | Integer | 否 | 上下文指代轮次 注意：此字段可能返回 null，表示取不到有效值。 |
| AliasName | String | 否 | 模型别名 注意：此字段可能返回 null，表示取不到有效值。 |
| TokenBalance | Float | 否 | token余量 注意：此字段可能返回 null，表示取不到有效值。 |
AttrLabel
属性标签详情信息
被如下接口引用：DescribeDoc, DescribeQA, ListDoc。
| 名称 | 类型 | 描述 |
|---|---|---|
| Source | Integer | 属性标签来源 注意：此字段可能返回 null，表示取不到有效值。 |
| AttrBizId | String | 属性ID 注意：此字段可能返回 null，表示取不到有效值。 |
| AttrKey | String | 属性标识 注意：此字段可能返回 null，表示取不到有效值。 |
| AttrName | String | 属性名称 注意：此字段可能返回 null，表示取不到有效值。 |
| Labels | Array of Label | 标签ID 注意：此字段可能返回 null，表示取不到有效值。 |
AttrLabelDetail
属性标签详情
被如下接口引用：ListAttributeLabel。
| 名称 | 类型 | 描述 |
|---|---|---|
| AttrBizId | String | 属性ID 注意：此字段可能返回 null，表示取不到有效值。 |
| AttrKey | String | 属性标识 注意：此字段可能返回 null，表示取不到有效值。 |
| AttrName | String | 属性名称 注意：此字段可能返回 null，表示取不到有效值。 |
| LabelNames | Array of String | 标签名称 注意：此字段可能返回 null，表示取不到有效值。 |
| IsUpdating | Boolean | 属性标签是否在更新中 注意：此字段可能返回 null，表示取不到有效值。 |
AttrLabelRefer
属性标签引用信息
被如下接口引用：CreateQA, ModifyDoc, ModifyDocAttrRange, ModifyQA, ModifyQAAttrRange, SaveDoc。
| 名称 | 类型 | 必选 | 描述 |
|---|---|---|---|
| Source | Integer | 否 | 属性标签来源，1：属性标签 示例值：1 |
| AttributeBizId | String | 否 | 属性ID 示例值：1 |
| LabelBizIds | Array of String | 否 | 标签ID 示例值：[1,2] |
AttributeFilters
导出知识标签过滤器
被如下接口引用：ExportAttributeLabel。
| 名称 | 类型 | 必选 | 描述 |
|---|---|---|---|
| Query | String | 否 | 检索，属性或标签名称 |
AttributeLabel
属性标签
被如下接口引用：CreateAttributeLabel, DescribeAttributeLabel, ModifyAttributeLabel。
| 名称 | 类型 | 必选 | 描述 |
|---|---|---|---|
| LabelBizId | String | 否 | 标签ID 注意：此字段可能返回 null，表示取不到有效值。 |
| LabelName | String | 否 | 标签名称 注意：此字段可能返回 null，表示取不到有效值。 |
| SimilarLabels | Array of String | 否 | 相似标签名称 注意：此字段可能返回 null，表示取不到有效值。 |
BaseConfig
应用基础配置
被如下接口引用：CreateApp, DescribeApp, ModifyApp。
| 名称 | 类型 | 必选 | 描述 |
|---|---|---|---|
| Name | String | 是 | 应用名称 |
| Avatar | String | 是 | 应用头像 |
| Desc | String | 否 | 应用描述 |
ClassifyConfig
标签提取配置
被如下接口引用：DescribeApp, ModifyApp。
| 名称 | 类型 | 必选 | 描述 |
|---|---|---|---|
| Model | AppModel | 否 | 模型配置 注意：此字段可能返回 null，表示取不到有效值。 |
| Labels | Array of ClassifyLabel | 否 | 标签列表 注意：此字段可能返回 null，表示取不到有效值。 |
| Greeting | String | 否 | 欢迎语，200字符以内 注意：此字段可能返回 null，表示取不到有效值。 |
ClassifyLabel
标签信息
被如下接口引用：DescribeApp, ModifyApp。
| 名称 | 类型 | 必选 | 描述 |
|---|---|---|---|
| Name | String | 否 | 标签名称 注意：此字段可能返回 null，表示取不到有效值。 |
| Description | String | 否 | 标签描述 注意：此字段可能返回 null，表示取不到有效值。 |
| Values | Array of String | 否 | 标签取值范围 注意：此字段可能返回 null，表示取不到有效值。 |
Context
获取不满意回复上下文响
被如下接口引用：DescribeUnsatisfiedReplyContext。
| 名称 | 类型 | 描述 |
|---|---|---|
| RecordBizId | String | 消息记录ID信息 注意：此字段可能返回 null，表示取不到有效值。 |
| IsVisitor | Boolean | 是否为用户 注意：此字段可能返回 null，表示取不到有效值。 |
| NickName | String | 昵称 注意：此字段可能返回 null，表示取不到有效值。 |
| Avatar | String | 头像 注意：此字段可能返回 null，表示取不到有效值。 |
| Content | String | 消息内容 注意：此字段可能返回 null，表示取不到有效值。 |
| FileInfos | Array of MsgFileInfo | 文档信息 注意：此字段可能返回 null，表示取不到有效值。 |
Coord
坐标
被如下接口引用：ReconstructDocument。
| 名称 | 类型 | 描述 |
|---|---|---|
| X | Integer | 横坐标 |
| Y | Integer | 纵坐标 |
CreateReconstructDocumentFlowConfig
创建智能文档解析任务的配置信息
被如下接口引用：CreateReconstructDocumentFlow。
| 名称 | 类型 | 必选 | 描述 |
|---|---|---|---|
| TableResultType | String | 否 | Markdown文件中表格返回的形式 0，表格以MD形式返回 1，表格以HTML形式返回 默认为1 示例值：1 |
Credentials
临时密钥结构
被如下接口引用：DescribeStorageCredential。
| 名称 | 类型 | 描述 |
|---|---|---|
| Token | String | token 注意：此字段可能返回 null，表示取不到有效值。 |
| TmpSecretId | String | 临时证书密钥ID 注意：此字段可能返回 null，表示取不到有效值。 |
| TmpSecretKey | String | 临时证书密钥Key 注意：此字段可能返回 null，表示取不到有效值。 |
DocSegment
文档片段
被如下接口引用：DescribeSegments。
| 名称 | 类型 | 描述 |
|---|---|---|
| Id | String | 片段ID 注意：此字段可能返回 null，表示取不到有效值。 |
| BusinessId | String | 业务ID 注意：此字段可能返回 null，表示取不到有效值。 |
| FileType | String | 文件类型(markdown,word,txt) 注意：此字段可能返回 null，表示取不到有效值。 |
| SegmentType | String | 文档切片类型(segment-文档切片 table-表格) 注意：此字段可能返回 null，表示取不到有效值。 |
| Title | String | 标题 注意：此字段可能返回 null，表示取不到有效值。 |
| PageContent | String | 段落内容 注意：此字段可能返回 null，表示取不到有效值。 |
| OrgData | String | 段落原文 注意：此字段可能返回 null，表示取不到有效值。 |
| DocId | String | 文章ID 注意：此字段可能返回 null，表示取不到有效值。 |
| DocBizId | String | 文档业务ID 注意：此字段可能返回 null，表示取不到有效值。 |
| DocUrl | String | 文档链接 注意：此字段可能返回 null，表示取不到有效值。 |
DocumentElement
文档元素字段
被如下接口引用：ReconstructDocument。
| 名称 | 类型 | 描述 |
|---|---|---|
| Index | Integer | 文档元素索引 注意：此字段可能返回 null，表示取不到有效值。 |
| Type | String | 元素类型，包括paragraph、table、formula、figure、title、header、footer、figure_text 注意：此字段可能返回 null，表示取不到有效值。 |
| Text | String | 元素内容，当type为figure或formula(公式识别关闭)时该字段内容为图片的位置 注意：此字段可能返回 null，表示取不到有效值。 |
| Polygon | Polygon | 元素坐标，左上角(x1, y1)，右上角(x2, y2)，右下角(x3, y3)，左下角(x4, y4) 注意：此字段可能返回 null，表示取不到有效值。 |
| Level | Integer | 元素层级 注意：此字段可能返回 null，表示取不到有效值。 |
| InsetImageName | String | 入参开启EnableInsetImage后返回，表示在InsetImagePackage中的内嵌图片名称 注意：此字段可能返回 null，表示取不到有效值。 |
| Elements | Array of DocumentElement | 嵌套的文档元素信息，一般包含的是文档内嵌入图片的文字识别结果 注意：此字段可能返回 null，表示取不到有效值。 |
DocumentRecognizeInfo
单页文档识别的内容
被如下接口引用：ReconstructDocument。
| 名称 | 类型 | 描述 |
|---|---|---|
| PageNumber | Integer | 输入PDF文件的页码，从1开始。输入图片的话值始终为1 注意：此字段可能返回 null，表示取不到有效值。 |
| Angle | Integer | 旋转角度 注意：此字段可能返回 null，表示取不到有效值。 |
| Height | Integer | AI算法识别处理后的图片高度 注意：此字段可能返回 null，表示取不到有效值。 |
| Width | Integer | AI算法识别处理后的图片宽度 注意：此字段可能返回 null，表示取不到有效值。 |
| OriginHeight | Integer | 图片的原始高度，输入PDF文件则表示单页PDF转图片之后的图片高度 注意：此字段可能返回 null，表示取不到有效值。 |
| OriginWidth | Integer | 图片的原始宽度，输入PDF文件则表示单页PDF转图片之后的图片宽度 注意：此字段可能返回 null，表示取不到有效值。 |
| Elements | Array of DocumentElement | 文档元素信息 注意：此字段可能返回 null，表示取不到有效值。 |
| RotatedAngle | Float | 旋转角度 注意：此字段可能返回 null，表示取不到有效值。 |
EmbeddingObject
向量
被如下接口引用：GetEmbedding。
| 名称 | 类型 | 必选 | 描述 |
|---|---|---|---|
| Embedding | Array of Float | 否 | 向量 |
FileInfo
实时上传的文件信息
被如下接口引用：GetMsgRecord。
| 名称 | 类型 | 描述 |
|---|---|---|
| FileName | String | 文件名称 注意：此字段可能返回 null，表示取不到有效值。 |
| FileSize | String | 文件大小 注意：此字段可能返回 null，表示取不到有效值。 |
| FileUrl | String | 文件的URL地址，COS地址 注意：此字段可能返回 null，表示取不到有效值。 |
| FileType | String | 文件类型 注意：此字段可能返回 null，表示取不到有效值。 |
| DocId | String | 解析后返回的DocID 注意：此字段可能返回 null，表示取不到有效值。 |
Filters
不满意回复检索过滤
被如下接口引用：ExportUnsatisfiedReply。
| 名称 | 类型 | 必选 | 描述 |
|---|---|---|---|
| Query | String | 否 | 检索，用户问题或答案 |
| Reasons | Array of String | 否 | 错误类型检索 |
GetWsTokenReq_Label
获取ws token label
被如下接口引用：GetWsToken。
| 名称 | 类型 | 必选 | 描述 |
|---|---|---|---|
| Name | String | 否 | 标签名 |
| Values | Array of String | 否 | 标签值 |
Highlight
分片高亮内容
被如下接口引用：DescribeQA, DescribeRefer。
| 名称 | 类型 | 必选 | 描述 |
|---|---|---|---|
| StartPos | String | 否 | 高亮起始位置 注意：此字段可能返回 null，表示取不到有效值。 |
| EndPos | String | 否 | 高亮结束位置 注意：此字段可能返回 null，表示取不到有效值。 |
| Text | String | 否 | 高亮子文本 注意：此字段可能返回 null，表示取不到有效值。 |
KnowledgeQaConfig
知识问答配置
被如下接口引用：DescribeApp, ModifyApp。
| 名称 | 类型 | 必选 | 描述 |
|---|---|---|---|
| Greeting | String | 否 | 欢迎语，200字符以内 注意：此字段可能返回 null，表示取不到有效值。 |
| RoleDescription | String | 否 | 角色描述，300字符以内 注意：此字段可能返回 null，表示取不到有效值。 |
| Model | AppModel | 否 | 模型配置 注意：此字段可能返回 null，表示取不到有效值。 |
| Search | Array of KnowledgeQaSearch | 否 | 知识搜索配置 注意：此字段可能返回 null，表示取不到有效值。 |
| Output | KnowledgeQaOutput | 否 | 知识管理输出配置 注意：此字段可能返回 null，表示取不到有效值。 |
KnowledgeQaOutput
应用管理输出配置
被如下接口引用：DescribeApp, ModifyApp。
| 名称 | 类型 | 必选 | 描述 |
|---|---|---|---|
| Method | Integer | 否 | 输出方式 1：流式 2：非流式 注意：此字段可能返回 null，表示取不到有效值。 |
| UseGeneralKnowledge | Boolean | 否 | 通用模型回复 注意：此字段可能返回 null，表示取不到有效值。 |
| BareAnswer | String | 否 | 未知回复语，300字符以内 注意：此字段可能返回 null，表示取不到有效值。 |
| ShowQuestionClarify | Boolean | 否 | 是否展示问题澄清开关 注意：此字段可能返回 null，表示取不到有效值。 |
| UseQuestionClarify | Boolean | 否 | 是否打开问题澄清 注意：此字段可能返回 null，表示取不到有效值。 |
| QuestionClarifyKeywords | Array of String | 否 | 问题澄清关键词列表 注意：此字段可能返回 null，表示取不到有效值。 |
KnowledgeQaSearch
检索配置
被如下接口引用：DescribeApp, ModifyApp。
| 名称 | 类型 | 必选 | 描述 |
|---|---|---|---|
| Type | String | 否 | 知识来源 doc：文档，qa：问答 taskflow：业务流程，search：搜索增强 注意：此字段可能返回 null，表示取不到有效值。 |
| ReplyFlexibility | Integer | 否 | 问答-回复灵活度 1：已采纳答案直接回复 2：已采纳润色后回复 注意：此字段可能返回 null，表示取不到有效值。 |
| UseSearchEngine | Boolean | 否 | 搜索增强-搜索引擎状态 注意：此字段可能返回 null，表示取不到有效值。 |
| ShowSearchEngine | Boolean | 否 | 是否显示搜索引擎检索状态 注意：此字段可能返回 null，表示取不到有效值。 |
| IsEnabled | Boolean | 否 | 知识来源，是否选择 注意：此字段可能返回 null，表示取不到有效值。 |
| QaTopN | Integer | 否 | 问答最大召回数量, 默认2，限制5 注意：此字段可能返回 null，表示取不到有效值。 |
| DocTopN | Integer | 否 | 文档最大召回数量, 默认3，限制5 注意：此字段可能返回 null，表示取不到有效值。 |
| Confidence | Float | 否 | 检索置信度，针对文档和问答有效，最小0.01，最大0.99 注意：此字段可能返回 null，表示取不到有效值。 |
Label
标签ID
被如下接口引用：DescribeDoc, DescribeQA。
| 名称 | 类型 | 描述 |
|---|---|---|
| LabelBizId | String | 标签ID 注意：此字段可能返回 null，表示取不到有效值。 |
| LabelName | String | 标签名称 注意：此字段可能返回 null，表示取不到有效值。 |
ListAppCategoryRspOption
应用类型详情
被如下接口引用：ListAppCategory。
| 名称 | 类型 | 描述 |
|---|---|---|
| Text | String | 类型名称 注意：此字段可能返回 null，表示取不到有效值。 |
| Value | String | 类型值 注意：此字段可能返回 null，表示取不到有效值。 |
| Logo | String | 类型log 注意：此字段可能返回 null，表示取不到有效值。 |
ListDocItem
文档列表详情描述
被如下接口引用：ListDoc。
| 名称 | 类型 | 描述 |
|---|---|---|
| DocBizId | String | 文档ID 注意：此字段可能返回 null，表示取不到有效值。 |
| FileName | String | 文件名称 注意：此字段可能返回 null，表示取不到有效值。 |
| FileType | String | 文件类型 注意：此字段可能返回 null，表示取不到有效值。 |
| CosUrl | String | cos路径 注意：此字段可能返回 null，表示取不到有效值。 |
| UpdateTime | String | 更新时间 注意：此字段可能返回 null，表示取不到有效值。 |
| Status | Integer | 文档状态 注意：此字段可能返回 null，表示取不到有效值。 |
| StatusDesc | String | 文档状态描述 注意：此字段可能返回 null，表示取不到有效值。 |
| Reason | String | 原因 注意：此字段可能返回 null，表示取不到有效值。 |
| IsRefer | Boolean | 答案中是否引用 注意：此字段可能返回 null，表示取不到有效值。 |
| QaNum | Integer | 问答对数量 注意：此字段可能返回 null，表示取不到有效值。 |
| IsDeleted | Boolean | 是否已删除 注意：此字段可能返回 null，表示取不到有效值。 |
| Source | Integer | 文档来源 注意：此字段可能返回 null，表示取不到有效值。 |
| SourceDesc | String | 文档来源描述 注意：此字段可能返回 null，表示取不到有效值。 |
| IsAllowRestart | Boolean | 是否允许重新生成 注意：此字段可能返回 null，表示取不到有效值。 |
| IsDeletedQa | Boolean | qa是否已删除 注意：此字段可能返回 null，表示取不到有效值。 |
| IsCreatingQa | Boolean | 问答是否生成中 注意：此字段可能返回 null，表示取不到有效值。 |
| IsAllowDelete | Boolean | 是否允许删除 注意：此字段可能返回 null，表示取不到有效值。 |
| IsAllowRefer | Boolean | 是否允许操作引用开关 注意：此字段可能返回 null，表示取不到有效值。 |
| IsCreatedQa | Boolean | 问答是否生成过 注意：此字段可能返回 null，表示取不到有效值。 |
| DocCharSize | String | 文档字符量 注意：此字段可能返回 null，表示取不到有效值。 |
| AttrRange | Integer | 属性标签适用范围 注意：此字段可能返回 null，表示取不到有效值。 |
| AttrLabels | Array of AttrLabel | 属性标签 注意：此字段可能返回 null，表示取不到有效值。 |
| IsAllowEdit | Boolean | 是否允许编辑 注意：此字段可能返回 null，表示取不到有效值。 |
| ReferUrlType | Integer | 外部引用链接类型 0：系统链接 1：自定义链接 值为1时，WebUrl 字段不能为空，否则不生效。 注意：此字段可能返回 null，表示取不到有效值。 |
| WebUrl | String | 网页(或自定义链接)地址 注意：此字段可能返回 null，表示取不到有效值。 |
| ExpireStart | String | 有效开始时间，unix时间戳 注意：此字段可能返回 null，表示取不到有效值。 |
| ExpireEnd | String | 有效结束时间，unix时间戳，0代表永久有效 注意：此字段可能返回 null，表示取不到有效值。 |
| IsAllowRetry | Boolean | 是否允许重试，0：否，1：是 注意：此字段可能返回 null，表示取不到有效值。 |
ListQaItem
问答详情数据
被如下接口引用：ListQA。
| 名称 | 类型 | 描述 |
|---|---|---|
| QaBizId | String | 问答ID |
| Question | String | 问题 |
| Answer | String | 答案 |
| Source | Integer | 来源 |
| SourceDesc | String | 来源描述 |
| UpdateTime | String | 更新时间 |
| Status | Integer | 状态 |
| StatusDesc | String | 状态描述 |
| DocBizId | String | 文档ID |
| CreateTime | String | 创建时间 |
| IsAllowEdit | Boolean | 是否允许编辑 |
| IsAllowDelete | Boolean | 是否允许删除 |
| IsAllowAccept | Boolean | 是否允许校验 |
| FileName | String | 文档名称 |
| FileType | String | 文档类型 |
| QaCharSize | String | 问答字符数 |
ListReleaseItem
发布列表详情
被如下接口引用：ListRelease。
| 名称 | 类型 | 描述 |
|---|---|---|
| ReleaseBizId | String | 版本ID |
| Operator | String | 发布人 |
| Desc | String | 发布描述 |
| UpdateTime | String | 更新时间 |
| Status | Integer | 发布状态 |
| StatusDesc | String | 发布状态描述 |
| Reason | String | 失败原因 |
| SuccessCount | Integer | 发布成功数 |
| FailCount | Integer | 发布失败数 |
Message
一条message代表一条对话记录
role表示角色 user或者assistant
content表示对话内容
被如下接口引用：QueryRewrite。
| 名称 | 类型 | 必选 | 描述 |
|---|---|---|---|
| Role | String | 是 | role表示角色 user标识用户提问，assistant标识返回的答案 注意：此字段可能返回 null，表示取不到有效值。 示例值：user; assistant |
| Content | String | 是 | 对话内容 注意：此字段可能返回 null，表示取不到有效值。 示例值：你好 |
ModelInfo
模型信息
被如下接口引用：ListModel。
| 名称 | 类型 | 必选 | 描述 |
|---|---|---|---|
| ModelName | String | 否 | 模型名称 注意：此字段可能返回 null，表示取不到有效值。 |
| ModelDesc | String | 否 | 模型描述 注意：此字段可能返回 null，表示取不到有效值。 |
| AliasName | String | 否 | 模型名称 注意：此字段可能返回 null，表示取不到有效值。 |
MsgFileInfo
文档信息
被如下接口引用：DescribeUnsatisfiedReplyContext。
| 名称 | 类型 | 描述 |
|---|---|---|
| FileName | String | 文档名称 注意：此字段可能返回 null，表示取不到有效值。 |
| FileSize | String | 文档大小 注意：此字段可能返回 null，表示取不到有效值。 |
| FileUrl | String | 文档URL 注意：此字段可能返回 null，表示取不到有效值。 |
| FileType | String | 文档类型 注意：此字段可能返回 null，表示取不到有效值。 |
| DocId | String | 文档ID 注意：此字段可能返回 null，表示取不到有效值。 |
MsgRecord
消息详情
被如下接口引用：GetMsgRecord。
| 名称 | 类型 | 描述 |
|---|---|---|
| Content | String | 内容 |
| SessionId | String | 当前记录所对应的 Session ID 注意：此字段可能返回 null，表示取不到有效值。 |
| RecordId | String | 记录ID |
| RelatedRecordId | String | 关联记录ID |
| IsFromSelf | Boolean | 是否来自自己 |
| FromName | String | 发送者名称 |
| FromAvatar | String | 发送者头像 |
| Timestamp | String | 时间戳 |
| HasRead | Boolean | 是否已读 |
| Score | Integer | 评价 |
| CanRating | Boolean | 是否评分 |
| CanFeedback | Boolean | 是否展示反馈按钮 注意：此字段可能返回 null，表示取不到有效值。 |
| Type | Integer | 记录类型 |
| References | Array of MsgRecordReference | 引用来源 |
| Reasons | Array of String | 评价原因 |
| IsLlmGenerated | Boolean | 是否大模型 |
| ImageUrls | Array of String | 图片链接，可公有读 |
| TokenStat | TokenStat | 当次 token 统计信息 注意：此字段可能返回 null，表示取不到有效值。 |
| ReplyMethod | Integer | 回复方式 1:大模型直接回复; 2:保守回复, 未知问题回复; 3:拒答问题回复; 4:敏感回复; 5:问答对直接回复, 已采纳问答对优先回复; 6:欢迎语回复; 7:并发超限回复; 8:全局干预知识; 9:任务流程过程回复, 当历史记录中 task_flow.type = 0 时, 为大模型回复; 10:任务流程答案回复; 11:搜索引擎回复; 12:知识润色后回复; 13:图片理解回复; 14:实时文档回复; 注意：此字段可能返回 null，表示取不到有效值。 |
| OptionCards | Array of String | 选项卡, 用于多轮对话 注意：此字段可能返回 null，表示取不到有效值。 |
| TaskFlow | TaskFlowInfo | 任务信息 注意：此字段可能返回 null，表示取不到有效值。 |
| FileInfos | Array of FileInfo | 用户传入的文件信息 注意：此字段可能返回 null，表示取不到有效值。 |
MsgRecordReference
聊天详情Refer
被如下接口引用：GetMsgRecord。
| 名称 | 类型 | 描述 |
|---|---|---|
| Id | String | id |
| Url | String | 链接 |
| Type | Integer | 类型 |
| Name | String | 名称 |
| DocId | String | 来源文档ID |
Option
下拉框选项
被如下接口引用：ListSelectDoc。
| 名称 | 类型 | 必选 | 描述 |
|---|---|---|---|
| Text | String | 否 | 文本 注意：此字段可能返回 null，表示取不到有效值。 |
| Value | String | 否 | 值 注意：此字段可能返回 null，表示取不到有效值。 |
| CharSize | String | 否 | 文件字符数 注意：此字段可能返回 null，表示取不到有效值。 |
| FileType | String | 否 | 文件类型 注意：此字段可能返回 null，表示取不到有效值。 |
Polygon
文本的坐标，以四个顶点坐标表示
注意：此字段可能返回 null，表示取不到有效值
被如下接口引用：ReconstructDocument。
| 名称 | 类型 | 描述 |
|---|---|---|
| LeftTop | Coord | 左上顶点坐标 |
| RightTop | Coord | 右上顶点坐标 |
| RightBottom | Coord | 右下顶点坐标 |
| LeftBottom | Coord | 左下顶点坐标 |
Procedure
执行过程信息记录
被如下接口引用：GetMsgRecord。
| 名称 | 类型 | 必选 | 描述 |
|---|---|---|---|
| Name | String | 否 | 执行过程英语名 注意：此字段可能返回 null，表示取不到有效值。 |
| Title | String | 否 | 中文名, 用于展示 注意：此字段可能返回 null，表示取不到有效值。 |
| Status | String | 否 | 状态常量: 使用中: processing, 成功: success, 失败: failed 注意：此字段可能返回 null，表示取不到有效值。 |
| Count | Integer | 否 | 消耗 token 数 注意：此字段可能返回 null，表示取不到有效值。 |
QACate
获取QA分类分组
被如下接口引用：ListQACate。
| 名称 | 类型 | 描述 |
|---|---|---|
| CateBizId | String | QA分类的业务ID 注意：此字段可能返回 null，表示取不到有效值。 |
| Name | String | 分类名称 注意：此字段可能返回 null，表示取不到有效值。 |
| Total | Integer | 分类下QA数量 注意：此字段可能返回 null，表示取不到有效值。 |
| CanAdd | Boolean | 是否可新增 注意：此字段可能返回 null，表示取不到有效值。 |
| CanEdit | Boolean | 是否可编辑 注意：此字段可能返回 null，表示取不到有效值。 |
| CanDelete | Boolean | 是否可删除 注意：此字段可能返回 null，表示取不到有效值。 |
| Children | Array of QACate | 子分类 注意：此字段可能返回 null，表示取不到有效值。 |
QAList
问答列表
被如下接口引用：VerifyQA。
| 名称 | 类型 | 必选 | 描述 |
|---|---|---|---|
| QaBizId | String | 是 | 问答ID |
| IsAccepted | Boolean | 否 | 是否采纳 |
| CateBizId | String | 否 | 分类ID |
| Question | String | 否 | 问题 |
| Answer | String | 否 | 答案 |
QAQuery
QA查询参数
被如下接口引用：ExportQAList。
| 名称 | 类型 | 必选 | 描述 |
|---|---|---|---|
| PageNumber | Integer | 是 | 页码 |
| PageSize | Integer | 是 | 每页数量 |
| BotBizId | String | 是 | 应用ID |
| Query | String | 否 | 查询内容 |
| CateBizId | String | 否 | 分类ID |
| AcceptStatus | Array of Integer | 否 | 校验状态 |
| ReleaseStatus | Array of Integer | 否 | 发布状态 |
| DocBizId | String | 否 | 文档ID |
| QaBizId | String | 否 | QAID |
| Source | Integer | 否 | 来源 |
| QueryAnswer | String | 否 | 查询答案 |
ReconstructDocumentConfig
ReconstructDocument配置选项
被如下接口引用：ReconstructDocument。
| 名称 | 类型 | 必选 | 描述 |
|---|---|---|---|
| EnableInsetImage | Boolean | 否 | 生成的Markdown中是否嵌入图片 |
ReconstructDocumentFailedPage
文档解析失败记录
被如下接口引用：GetReconstructDocumentResult。
| 名称 | 类型 | 描述 |
|---|---|---|
| PageNumber | Integer | 失败页码 注意：此字段可能返回 null，表示取不到有效值。 |
ReferDetail
引用来源详情
被如下接口引用：DescribeRefer。
| 名称 | 类型 | 描述 |
|---|---|---|
| ReferBizId | String | 引用ID 注意：此字段可能返回 null，表示取不到有效值。 |
| DocType | Integer | 文档类型 (1 QA, 2 文档段) 注意：此字段可能返回 null，表示取不到有效值。 |
| DocName | String | 文档名称 注意：此字段可能返回 null，表示取不到有效值。 |
| PageContent | String | 分片内容 注意：此字段可能返回 null，表示取不到有效值。 |
| Question | String | 问题 注意：此字段可能返回 null，表示取不到有效值。 |
| Answer | String | 答案 注意：此字段可能返回 null，表示取不到有效值。 |
| Confidence | Float | 置信度 注意：此字段可能返回 null，表示取不到有效值。 |
| Mark | Integer | 标记 注意：此字段可能返回 null，表示取不到有效值。 |
| Highlights | Array of Highlight | 分片高亮内容 注意：此字段可能返回 null，表示取不到有效值。 |
| OrgData | String | 原始内容 注意：此字段可能返回 null，表示取不到有效值。 |
RejectedQuestion
发布拒答
被如下接口引用：ListRejectedQuestion。
| 名称 | 类型 | 描述 |
|---|---|---|
| RejectedBizId | String | 拒答问题ID 注意：此字段可能返回 null，表示取不到有效值。 |
| Question | String | 被拒答的问题 注意：此字段可能返回 null，表示取不到有效值。 |
| Status | Integer | 状态 注意：此字段可能返回 null，表示取不到有效值。 |
| StatusDesc | String | 状态描述 注意：此字段可能返回 null，表示取不到有效值。 |
| UpdateTime | String | 更新时间 注意：此字段可能返回 null，表示取不到有效值。 |
| IsAllowEdit | Boolean | 是否允许编辑 注意：此字段可能返回 null，表示取不到有效值。 |
| IsAllowDelete | Boolean | 是否允许删除 注意：此字段可能返回 null，表示取不到有效值。 |
ReleaseConfigs
发布配置项
被如下接口引用：ListReleaseConfigPreview。
| 名称 | 类型 | 描述 |
|---|---|---|
| ConfigItem | String | 配置项描述 注意：此字段可能返回 null，表示取不到有效值。 |
| UpdateTime | String | 更新时间 注意：此字段可能返回 null，表示取不到有效值。 |
| Action | Integer | 状态 注意：此字段可能返回 null，表示取不到有效值。 |
| Value | String | 变更后的内容 注意：此字段可能返回 null，表示取不到有效值。 |
| LastValue | String | 变更前的内容 注意：此字段可能返回 null，表示取不到有效值。 |
| Content | String | 变更内容(优先级展示content内容,content为空取value内容) 注意：此字段可能返回 null，表示取不到有效值。 |
| Message | String | 失败原因 注意：此字段可能返回 null，表示取不到有效值。 |
ReleaseDoc
发布文档详情
被如下接口引用：ListReleaseDocPreview。
| 名称 | 类型 | 必选 | 描述 |
|---|---|---|---|
| FileName | String | 否 | 文件名 |
| FileType | String | 否 | 文件类型 |
| UpdateTime | String | 否 | 更新时间 |
| Action | Integer | 否 | 状态 |
| ActionDesc | String | 否 | 状态描述 |
| Message | String | 否 | 失败原因 |
| DocBizId | String | 否 | 文档业务ID |
ReleaseQA
发布问答
被如下接口引用：ListReleaseQAPreview。
| 名称 | 类型 | 必选 | 描述 |
|---|---|---|---|
| Question | String | 否 | 问题 |
| UpdateTime | String | 否 | 更新时间 |
| Action | Integer | 否 | 状态 |
| ActionDesc | String | 否 | 状态描述 |
| Source | Integer | 否 | 来源 |
| SourceDesc | String | 否 | 来源描述 |
| FileName | String | 否 | 文件名字 |
| FileType | String | 否 | 文档类型 |
| Message | String | 否 | 失败原因 |
| ReleaseStatus | Integer | 否 | 发布状态 |
| QaBizId | String | 否 | QAID |
| DocBizId | String | 否 | 文档业务ID |
ReleaseRejectedQuestion
发布拒答
被如下接口引用：ListRejectedQuestionPreview。
| 名称 | 类型 | 描述 |
|---|---|---|
| Question | String | 问题 注意：此字段可能返回 null，表示取不到有效值。 |
| UpdateTime | String | 更新时间 注意：此字段可能返回 null，表示取不到有效值。 |
| Action | Integer | 状态 注意：此字段可能返回 null，表示取不到有效值。 |
| ActionDesc | String | 状态描述 注意：此字段可能返回 null，表示取不到有效值。 |
| Message | String | 失败原因 注意：此字段可能返回 null，表示取不到有效值。 |
SummaryConfig
知识摘要应用配置
被如下接口引用：DescribeApp, ModifyApp。
| 名称 | 类型 | 必选 | 描述 |
|---|---|---|---|
| Model | AppModel | 否 | 模型配置 注意：此字段可能返回 null，表示取不到有效值。 |
| Output | SummaryOutput | 否 | 知识摘要输出配置 注意：此字段可能返回 null，表示取不到有效值。 |
| Greeting | String | 否 | 欢迎语，200字符以内 注意：此字段可能返回 null，表示取不到有效值。 |
SummaryOutput
知识摘要输出配置
被如下接口引用：DescribeApp, ModifyApp。
| 名称 | 类型 | 必选 | 描述 |
|---|---|---|---|
| Method | Integer | 否 | 输出方式 1：流式 2：非流式 注意：此字段可能返回 null，表示取不到有效值。 |
| Requirement | Integer | 否 | 输出要求 1：文本总结 2：自定义要求 注意：此字段可能返回 null，表示取不到有效值。 |
| RequireCommand | String | 否 | 自定义要求指令 注意：此字段可能返回 null，表示取不到有效值。 |
TaskFlowInfo
任务流程信息
被如下接口引用：GetMsgRecord。
| 名称 | 类型 | 描述 |
|---|---|---|
| TaskFlowId | String | 任务流程ID 注意：此字段可能返回 null，表示取不到有效值。 |
| TaskFlowName | String | 任务流程名称 注意：此字段可能返回 null，表示取不到有效值。 |
| QueryRewrite | String | Query 重写结果 注意：此字段可能返回 null，表示取不到有效值。 |
| HitIntent | String | 命中意图 注意：此字段可能返回 null，表示取不到有效值。 |
| Type | Integer | 任务流程回复类型 0: 任务流回复 1: 任务流静默 2: 任务流拉回话术 3: 任务流自定义回复 注意：此字段可能返回 null，表示取不到有效值。 |
TaskParams
任务参数
被如下接口引用：GetTaskStatus。
| 名称 | 类型 | 描述 |
|---|---|---|
| CosPath | String | 下载地址,需要通过cos桶临时密钥去下载 注意：此字段可能返回 null，表示取不到有效值。 |
TokenStat
当前执行的 token 统计信息
被如下接口引用：GetMsgRecord。
| 名称 | 类型 | 必选 | 描述 |
|---|---|---|---|
| SessionId | String | 否 | 会话 ID 注意：此字段可能返回 null，表示取不到有效值。 |
| RequestId | String | 否 | 请求 ID 注意：此字段可能返回 null，表示取不到有效值。 |
| RecordId | String | 否 | 对应哪条会话, 会话 ID, 用于回答的消息存储使用, 可提前生成, 保存消息时使用 注意：此字段可能返回 null，表示取不到有效值。 |
| UsedCount | Integer | 否 | token 已使用数 注意：此字段可能返回 null，表示取不到有效值。 |
| FreeCount | Integer | 否 | 免费 token 数 注意：此字段可能返回 null，表示取不到有效值。 |
| OrderCount | Integer | 否 | 订单总 token 数 注意：此字段可能返回 null，表示取不到有效值。 |
| StatusSummary | String | 否 | 当前执行状态汇总, 常量: 使用中: processing, 成功: success, 失败: failed 注意：此字段可能返回 null，表示取不到有效值。 |
| StatusSummaryTitle | String | 否 | 当前执行状态汇总后中文展示 注意：此字段可能返回 null，表示取不到有效值。 |
| Elapsed | Integer | 否 | 当前请求执行时间, 单位 ms 注意：此字段可能返回 null，表示取不到有效值。 |
| TokenCount | Integer | 否 | 当前请求消耗 token 数 注意：此字段可能返回 null，表示取不到有效值。 |
| Procedures | Array of Procedure | 否 | 执行过程信息 注意：此字段可能返回 null，表示取不到有效值。 |
UnsatisfiedReply
不满意回复
被如下接口引用：ListUnsatisfiedReply。
| 名称 | 类型 | 描述 |
|---|---|---|
| ReplyBizId | String | 不满意回复ID 注意：此字段可能返回 null，表示取不到有效值。 |
| RecordBizId | String | 消息记录ID 注意：此字段可能返回 null，表示取不到有效值。 |
| Question | String | 用户问题 注意：此字段可能返回 null，表示取不到有效值。 |
| Answer | String | 应用回复 注意：此字段可能返回 null，表示取不到有效值。 |
| Reasons | Array of String | 错误类型 注意：此字段可能返回 null，表示取不到有效值。 |
Usage
消耗量
被如下接口引用：GetEmbedding, QueryParseDocResult, QueryRewrite。
| 名称 | 类型 | 描述 |
|---|---|---|
| TotalPages | Integer | 文档页数 示例值：10 |
| InputTokens | Integer | 输入token数 示例值：10 |
| OutputTokens | Integer | 输出token数 示例值：10 |
| TotalTokens | Integer | 总token数 示例值：10 |
WordRecognizeInfo
解析为 word 文档的结果
被如下接口引用：ConvertDocument。
| 名称 | 类型 | 描述 |
|---|---|---|
| PageNumber | Integer | 输入文件的页码数 注意：此字段可能返回 null，表示取不到有效值。 示例值：1 |
| WordBase64 | String | word的base64 注意：此字段可能返回 null，表示取不到有效值。 |
