API 中心

云服务器

3.0

云硬盘

3.0

容器服务

3.0

负载均衡

3.0

弹性伸缩

3.0

云函数

3.0

私有网络

3.0

专线接入

3.0

批量计算

3.0

API 网关

3.0

NAT 网关

微服务平台 TSF

3.0

对象存储

文件存储

3.0

全站加速网络

3.0

消息队列 CKafka 版

3.0

日志服务

3.0

云数据库 MySQL

3.0

弹性网卡

云数据库 MariaDB

3.0

云数据库 SQL Server

3.0

云数据库 PostgreSQL

3.0

内容分发网络 CDN

3.0

云数据库 Redis®

3.0

网络流日志

云数据库 Memcached

3.0

云数据库 MongoDB

3.0

TDSQL MySQL版

3.0

全球应用加速

3.0

数据传输服务

3.0

腾讯云可观测平台

3.0

共享带宽包

云拨测

3.0

腾讯云区块链服务平台 TBaaS

3.0

访问管理

3.0

主机安全

3.0

标签

3.0

DDoS 防护

3.0

Web 应用防火墙

3.0

密钥管理系统

3.0

域名注册

3.0

操作审计

3.0

SSL 证书

3.0

数据万象

短信

3.0

NLP 技术

3.0

云点播

3.0

云加密机

3.0

云市场

3.0

云安全中心

3.0

云开发 CloudBase

3.0

流计算 Oceanus

3.0

口语评测（基础版）

3.0

人脸识别

3.0

文字识别

3.0

图像识别

3.0

集团账号管理

3.0

Elasticsearch Service

3.0

腾讯云数据仓库 TCHouse-P

3.0

媒体处理

3.0

云直播

3.0

云联络中心

3.0

物联网通信

3.0

机器翻译

3.0

人脸融合

3.0

弹性 MapReduce

3.0

游戏数据库 TcaplusDB

3.0

腾讯云 BI

3.0

游戏多媒体引擎

3.0

实时音视频

3.0

渠道合作伙伴

3.0

TI-ONE 训练平台

3.0

数据安全审计

3.0

高性能应用服务 HAI

3.0

微瓴同业开放平台

3.0

消息队列 RocketMQ 版

3.0

数据安全治理中心

3.0

智能视图计算平台

3.0

知识引擎原子能力

3.0

商场客留大数据

3.0

腾讯云健康看板

3.0

声音复刻

3.0

文旅客情大数据

3.0

实时互动-工业能源版

3.0

腾讯健康组学平台

3.0

大模型图像创作引擎

3.0

云压测

3.0

数据加速器 GooseFS

3.0

云数据库 KeeWiDB

3.0

多媒体处理

腾讯云数据仓库 TCHouse-C

3.0

语音识别

3.0

配置审计

3.0

统一 Catalog 服务

3.0

视频审核

消息队列 MQTT 版

3.0

AI 临床助手

3.0

音视频终端 SDK（腾讯云视立方）

3.0

智能导诊

3.0

消息队列 RabbitMQ 版

3.0

腾讯云微搭低代码

3.0

云托付物理服务器

3.0

内容识别

弹性公网 IPv6

弹性公网 IP

文档服务

腾讯微卡

网关负载均衡

3.0

腾讯混元大模型

3.0

腾讯云 CA

3.0

图片处理

控制中心

3.0

云应用

3.0

云桌面

专属可用区

3.0

大模型视频创作引擎

3.0

腾讯同传

3.0

向量数据库

3.0

腾讯云智能体开发平台

3.0

分布式身份

3.0

iOA 零信任安全管理系统

3.0

腾讯云数据仓库 TCHouse-D

3.0

商业流程服务

3.0

云顾问

3.0

设备安全

3.0

互动白板

3.0

数据湖计算 DLC

3.0

物联网智能视频服务（行业版）

3.0

自动化助手

3.0

视频内容安全

3.0

邮件推送

3.0

安全凭证服务

3.0

音频内容安全

3.0

轻量应用服务器

3.0

人像变换

3.0

人脸试妆

3.0

云游戏

3.0

智能创作

3.0

容器镜像服务

3.0

凭据管理系统

3.0

云防火墙

3.0

物联网智能视频服务（消费版）

3.0

数据库智能管家 DBbrain

3.0

语音消息

3.0

文本内容安全

3.0

验证码

3.0

边缘计算机器

3.0

云 HDFS

3.0

证书监控 SSLPod

3.0

物联网开发平台

3.0

英文作文批改

3.0

语音合成

3.0

人脸核身

3.0

数学作业批改

3.0

TDSQL-C MySQL 版

3.0

计费相关

3.0

注册配置治理

3.0

弹性微服务

3.0

实时互动-教育版

3.0

软件成分分析

3.0

Cloud Studio（云端 IDE）

3.0

全栈式风控引擎

3.0

地域管理系统

3.0

数据开发治理平台 WeData

3.0

云托管 CloudBase Run

3.0

账号风控平台

3.0

小程序安全检测

3.0

腾讯安心平台

3.0

云数据库独享集群

3.0

应用性能监控

3.0

本地专用集群

3.0

运维安全中心（堡垒机）

3.0

边缘安全加速平台 EO

3.0

应用云渲染

3.0

智能媒资托管

3.0

多网聚合加速

3.0

混沌演练平台

3.0

TDSQL-C PostgreSQL 版

3.0

腾讯电子签

3.0

高性能计算平台

3.0

事件总线

3.0

容器安全服务

3.0

视频理解

3.0

服务网格

3.0

前端性能监控

3.0

数字身份管控平台（员工版）

3.0

图片内容安全

3.0

医疗报告结构化

3.0

DNSPod

3.0

私有域解析 Private DNS

3.0

消息队列 Pulsar 版

3.0
管理与支持产品文档捉虫活动邀您参加！> HOT
文档中心>API 中心>腾讯云微搭低代码>数据结构

数据结构

最近更新时间：2025-03-13 01:45:23

我的收藏

本页目录：

DataSourceDetail

数据源详情列表

被如下接口引用：DescribeDataSourceList。

名称 类型 描述
Id String 数据源 ID
示例值：jl_yy0gs82
Title String 数据源名称
示例值：数据源
Name String 数据源标识
示例值：jl_yy0gs83
Type String 数据源类型
示例值：datasource
Description String 数据源描述
注意：此字段可能返回 null，表示取不到有效值。
示例值：数据源说明
Schema String 数据源配置
示例值：{"x-primary-column":"_id","x-id":"7b9e453","title":"","type":"object","x-index":1)
CmsProject String cms 项目状态, 0: 重新获取详情信息，1： 不需要重新获取详情信息
示例值：1
PkgId String 当前为环境 id
示例值：lowcode-we34fvsdf
SchemaVersion String schema 版本信息
注意：此字段可能返回 null，表示取不到有效值。
示例值：2.6
CreatorId String 创建者用户 ID
示例值：0gs83
CreatedAt String 创建时间
注意：此字段可能返回 null，表示取不到有效值。
示例值：2024-11-10 12:00:00
UpdatedAt String 更新时间
注意：此字段可能返回 null，表示取不到有效值。
示例值：2024-11-10 12:00:00
EnvId String 环境 id
示例值：lowcode-wa2332
DataSourceVersion String 版本
注意：此字段可能返回 null，表示取不到有效值。
示例值：2.1
AppUsageList Array of DataSourceLinkApp 所属应用数组
注意：此字段可能返回 null，表示取不到有效值。
示例值：{"Id":"app-abc"}
PublishedAt String 发布时间
示例值：2024-11-10 12:00:00
ChildDataSourceIds Array of String 子数据源ids
注意：此字段可能返回 null，表示取不到有效值。
示例值：jl_yy0gs84
Fun String 数据源发布信息
注意：此字段可能返回 null，表示取不到有效值。
示例值：{"onlineVersion": 1, "previewVersion": 1, "onlinePublishAt": 1704256751993, "prviewPublishAt": 1704256745583}
ScfStatus Integer 云函数状态 1 Active 2 Creating 3 Updating 4 Deleting 9 Deleted 11 CreatFailed 12 UpdateFailed 13 DeleteFailed 21 UpdateTimeOut
示例值：1
Methods String 自定义方法
示例值：action1
ChildDataSourceNames Array of String 子数据源名数组
注意：此字段可能返回 null，表示取不到有效值。
示例值：["jl_yy0gs85","jl_yy0gs86"]
IsNewDataSource Integer 是否旧数据源 1 新 0 旧
示例值：1
ViewId String 数据源视图id
注意：此字段可能返回 null，表示取不到有效值。
示例值：234233
Configuration String 数据源属性配置
注意：此字段可能返回 null，表示取不到有效值。
示例值：cfg_23sa
TemplateCode String 外部数据源模板code
注意：此字段可能返回 null，表示取不到有效值。
示例值：tpl_2sewe32
Source Integer 外部数据源模板来源 0 空模板 1 腾讯文档 2 腾讯会议 3 企业微信 4 微信电商
注意：此字段可能返回 null，表示取不到有效值。
示例值：0
PublishViewId String 发布视图id
注意：此字段可能返回 null，表示取不到有效值。
示例值：2353342
SubType String 数据源子类型 "database" 标准模型 "custom-database" 自定义模型 "system" 系统模型 "connector" 连接器 "custom-connector" 自定义连接器 "hidden" 隐藏数据源
示例值：datasource_type
AuthStatus Integer 授权状态 0 授权无效 1 授权有效
注意：此字段可能返回 null，表示取不到有效值。
示例值：0
AuthInfo TicketAuthInfo 数据源授权信息
注意：此字段可能返回 null，表示取不到有效值。
示例值：{"AuthUser":"abc"}
PublishStatus Integer 1发布0未发布
示例值：1
UpdateVersion Integer 更新版本
示例值：1
RelationFieldList Array of RelationField 模型关联关系字段列表
注意：此字段可能返回 null，表示取不到有效值。
示例值：{"Field":"abc"}
DbInstanceType String db实例类型
注意：此字段可能返回 null，表示取不到有效值。
示例值：MYSQL
PreviewTableName String 体验环境db表名
注意：此字段可能返回 null，表示取不到有效值。
示例值：pre_createA
PublishedTableName String 正式环境db表名
注意：此字段可能返回 null，表示取不到有效值。
示例值：prod_createA
DbSourceType String DB来源类型
注意：此字段可能返回 null，表示取不到有效值。
示例值：internal_flexdb

DataSourceDetailItems

数据详情列表

被如下接口引用：DescribeDataSourceList。

名称 类型 描述
Rows Array of DataSourceDetail 数据详情列表
示例值：[{"id":"jl_yy0gs82","Title":"数据源title"},{"id":"jl_yy0gs83","Title":"数据源title3"}]
Count Integer 数据源列表总个数
示例值：1

DataSourceLinkApp

数据源关联App信息

被如下接口引用：DescribeDataSourceList。

名称 类型 描述
Id String 应用Id
示例值：app-xx
Title String 应用名称
示例值：MyApp
EditStatusUse Integer 是否编辑状态使用
示例值：1
PreviewStatusUse Integer 是否预览状态使用
示例值：1
OnlineStatusUse Integer 是否正式状态使用
示例值：1
DataSourceId String 数据源ID
示例值：data-xxx

DataSourceQueryOption

数据源模糊查询参数

被如下接口引用：DescribeDataSourceList。

名称 类型 必选 描述
LikeName String 否 数据源标识模糊匹配
示例值：data-3w6wEhrF
LikeTitle String 否 数据源名称模糊匹配
示例值：时间轴区块数据

DeleteKnowledgeDocumentSetRsp

删除文档出参

被如下接口引用：DeleteKnowledgeDocumentSet。

名称 类型 描述
AffectedCount Integer 删除文档数量。
示例值：10

DescribeKnowledgeDocumentSetDetailRsp

上传知识库文档返回结果

被如下接口引用：DescribeKnowledgeDocumentSetDetail。

名称 类型 描述
Count Integer 获取的数量。
示例值：10
DocumentSet KnowledgeDocumentSet 文档信息

DescribeKnowledgeDocumentSetListRsp

删除文档出参

被如下接口引用：DescribeKnowledgeDocumentSetList。

名称 类型 描述
DocumentSets Array of QureyKnowledgeDocumentSet 文件集
Count Integer 条数
示例值：10

DocumentQuery

删除文档时查询入参

被如下接口引用：DeleteKnowledgeDocumentSet。

名称 类型 必选 描述
DocumentSetId Array of String 否 文件ids
示例值：docId
DocumentSetName Array of String 否 文件名集合
示例值：docName
Filter String 否 使用创建 CollectionView 指定的 Filter 索引的字段设置查询过滤表达式
示例值：filter

KnowledgeDocumentSet

文档信息

被如下接口引用：DescribeKnowledgeDocumentSetDetail。

名称 类型 描述
DocumentSetId String 文档id
示例值：docId
DocumentSetName String 文档名
示例值：docName
Text String 文件完整内容。
示例值：我的文档
TextPrefix String 文件内容前 200个字符。
示例值：我的文档
DocumentSetInfo KnowledgeDocumentSetInfo 文件详情
SplitterPreprocess KnowledgeSplitterPreprocess 文件拆分信息
Name String 未使用
示例值：name
FileTitle String 文档标题
示例值：kent测试文件
FileMetaData String 文档元信息，必须为jsonstring
示例值：{"url": "https://ww.com\", "total": 3}
Author String 作者
示例值：bob

KnowledgeDocumentSetInfo

文档信息

被如下接口引用：DescribeKnowledgeDocumentSetDetail。

名称 类型 描述
TextLength Integer 文件的字符数。
示例值：64
ByteLength Integer 文件的字节数。
示例值：256
IndexedProgress Integer 文件被预处理、Embedding 向量化的进度。
示例值：64
IndexedStatus String 文件预处理、Embedding 向量化的状态。
New：等待解析。
Loading：文件解析中。
Failure：文件解析、写入出错。
Ready：文件解析、写入完成。

示例值：Ready
CreateTime String 文件创建时间。
示例值：2020-01-01 00:00:00
LastUpdateTime String 文件最后更新时间。
示例值：2020-01-01 00:00:00
Keywords String 文件关键字。
示例值：key

KnowledgeSet

知识库信息

被如下接口引用：DescribeKnowledgeSetList。

名称 类型 描述
Name String 知识库标识
示例值：name
Title String 知识库名称
示例值：title
Desc String 描述
示例值：desc
Active String 状态，
NOT_ENABLED未启用
ENABLED 已启用
示例值：NOT_ENABLED
CreateTime String 创建时间
示例值：2024-06-04 11:16:49
UpdateTime String 更新时间
示例值：2024-06-04 11:16:49
Meta String 知识库的meta信息
示例值：meta

KnowledgeSetRsp

查询知识库列表返回

被如下接口引用：DescribeKnowledgeSetList。

名称 类型 描述
Total Integer 总数
示例值：1
KnowledgeSets Array of KnowledgeSet 知识库列表

KnowledgeSplitterPreprocess

文件拆分信息

被如下接口引用：DescribeKnowledgeDocumentSetDetail, DescribeKnowledgeDocumentSetList。

名称 类型 描述
AppendTitleToChunk Boolean 在对文件拆分时，配置是否将 Title 追加到切分后的段落后面一并 Embedding。取值如下所示：
false：不追加。
true：将段落 Title 追加到切分后的段落。

示例值：true
AppendKeywordsToChunk Boolean 在对文件拆分时，配置是否将关键字 keywords 追加到切分后的段落一并 Embedding。取值如下所示：
false：不追加。
true：将全文的 keywords 追加到切分后的段落。

示例值：true

PageQuery

查询条件

被如下接口引用：DescribeKnowledgeDocumentSetList。

名称 类型 必选 描述
DocumentSetId Array of String 否 文件id数组，表示要查询的文件的所有 ID，支持批量查询，数组元素范围[1,20]。
示例值：docId
DocumentSetName Array of String 否 表示要查询的文档名称，支持批量查询，数组元素范围[1,20]。
示例值：docName
Limit Integer 否 取值范围：[1,16384]
示例值：10
Offset Integer 否 设置分页偏移量，用于控制分页查询返回结果的起始位置，方便用户对数据进行分页展示和浏览。
取值：为 limit 整数倍。
计算公式：offset=limit*(page-1)。
例如：当 limit = 10，page = 2 时，分页偏移量 offset = 10 * (2 - 1) = 10，表示从查询结果的第 11 条记录开始返回数据。

示例值：0
OutputFields Array of String 否 设置后，其他字段为空值
示例值：file
Filter String 否 使用创建 CollectionView 指定的 Filter 索引的字段设置查询过滤表达式。
示例值：filter

QureyKnowledgeDocumentSet

搜索数据的集合

被如下接口引用：DescribeKnowledgeDocumentSetList。

名称 类型 描述
DocumentSetId String 文件id
示例值：docId
DocumentSetName String 文件名
示例值：docName
TextPrefix String 文件内容前 200个字符。
示例值：我的文档
SplitterPreprocess KnowledgeSplitterPreprocess 文件拆分信息
DocumentSetInfo QureyKnowledgeDocumentSetInfo 文件详情
FileTitle String 文件标题
示例值：kent测试文件
FileMetaData String 文件元信息，必须为jsonstring
示例值：{"url": "https://ww.com\", "total": 3}
Name String name
示例值：name
Author String 作者
示例值：bob

QureyKnowledgeDocumentSetInfo

查询文件集合信息详情

被如下接口引用：DescribeKnowledgeDocumentSetList。

名称 类型 必选 描述
TextLength Integer 否 文件的字符数。
示例值：1024
ByteLength Integer 否 文件的字节数。
示例值：4096
IndexedProgress Integer 否 文件被预处理、Embedding 向量化的进度。
示例值：10
IndexedStatus String 否 文件预处理、Embedding 向量化的状态。
New：等待解析。
Loading：文件解析中。
Failure：文件解析、写入出错。
Ready：文件解析、写入完成。

示例值：Ready
IndexedErrorMsg String 否 错误信息
示例值：error
CreateTime String 否 文件创建时间。
示例值：2020-01-01 00:00:00
LastUpdateTime String 否 文件最后更新时间。
示例值：2020-01-01 00:00:00
Keywords String 否 文件关键字。
示例值：key

RelationField

数据源关联的的信息

被如下接口引用：DescribeDataSourceList。

名称 类型 描述
Field String 关联关系字段
示例值：name
Format String 关联关系格式
示例值：format_name
RelateDataSourceName String 关联数据源名称
示例值：sys_department

SearchDocInfo

知识库搜索文档信息

被如下接口引用：SearchDocList。

名称 类型 描述
CollectionViewName String 知识库名称
示例值：collectionName
DocSetId String 文档Id
示例值：docId
DocSetName String 文档Name
示例值：docName
DocType String 文档类型
示例值：.md
FileTitle String 文档标题
示例值：title
FileMetaData String 文档元信息
示例值：{"foo":"bar"}
DocDesc String 文档描述
示例值：docDesc
FileSize Integer 文档大小
示例值：100

SearchDocRsp

知识库文档搜索结果

被如下接口引用：SearchDocList。

名称 类型 描述
DocInfos Array of SearchDocInfo 文档基本信息
示例值：[]
Total Integer 文档总数
示例值：0

TicketAuthInfo

数据源授权信息

被如下接口引用：DescribeDataSourceList。

名称 类型 描述
AuthUser String 授权用户
示例值：relation_data_depart

UploadKnowledgeDocumentSetRsp

上传知识库文档返回结果

被如下接口引用：UploadKnowledgeDocumentSet。

名称 类型 必选 描述
DocumentSetId String 否 给文件分配的 ID 信息。
示例值：docId
DocumentSetName String 否 文件名
示例值：docName
FileTitle String 否 文件标题
示例值：文件标题
FileMetaData String 否 文件元信息，为jsonstring
示例值：{"url":"url","title":"标题"}

如果遇到产品相关问题，您可咨询 在线客服寻求帮助。

中国站
目录
返回顶部