文档中心

数据智能体

结构化知识库查询

查询结构化数据表结构

查询结构化数据表结构

调用本接口查询逻辑字段、过滤/向量/返回能力和 OpenSearch 索引就绪状态，不暴露底层 mapping。

调用方：开放平台应用、外部 Agent 或集成服务。
前置条件：调用者拥有知识库查看权限。

接口说明

接口名称：get_schema_structured_knowledge_v1_kbs__kb_id__assets__asset_id__schema_get
接口地址：/structured_knowledge/v1/kbs/{kb_id}/assets/{asset_id}/schema
请求方式：GET

请求参数

Path

参数名	类型	是否必传	描述
kb_id	String	是	结构化知识库 ID，由创建知识库或查询知识库列表接口返回
asset_id	String	是	结构化数据资产 ID，由创建资产或查询资产列表接口返回

响应参数

参数名	类型	是否必传	描述
code	Number	是	响应码：0=成功，非0=失败
msg	String	否	Code非0时，返回错误信息
message	String	否	错误信息
data	Object	是	数据。详情请参见下文 data 表

data

参数名	类型	是否必传	描述
asset_id	String	是	结构化数据资产 ID
index_ready	Boolean	是	OpenSearch 索引是否已创建并可查询
fields	Array	否	当前生效的逻辑字段配置。详情请参见下文 fields 表
field_capabilities	Array	否	前端或调用方可用于构造过滤、向量和返回字段候选的能力视图。详情请参见下文 field_capabilities 表
operation_task_ref	String	否	Schema 变更触发的异步任务引用，例如向量回填任务

fields

参数名	类型	是否必传	描述
source_column_name	String	否	原始字段/列名；用户新增字段为空
field_name	String	是	导入后字段名，作为产品语义字段 key
display_name	String	是	字段展示名
data_type	String	是	数据类型 string int long float bool datetime
enabled	Boolean	否	是否启用并参与召回/展示候选
vector_enabled	Boolean	否	是否开启向量索引
filter_enabled	Boolean	否	是否允许作为过滤条件
return_enabled	Boolean	否	是否允许作为返回字段
description	String	否	字段描述
allowed_operators	Array	否	允许的过滤操作符；不传则按类型默认 eq ne gt ge lt le between is_null is_not_null contains not_contains in not_in

field_capabilities

参数名	类型	是否必传	描述
field_name	String	是	逻辑字段名，调用过滤、向量检索和返回字段时使用
display_name	String	是	字段展示名
data_type	String	否	数据类型 string int long float bool datetime
enabled	Boolean	否	字段当前是否启用
filter_enabled	Boolean	否	字段是否允许作为精确过滤条件
vector_enabled	Boolean	否	用户是否为该字段开启了向量索引
vector_status	String	否	DISABLED PENDING PROCESSING READY FAILED
vector_searchable	Boolean	否	字段当前是否已具备向量检索能力，仅向量构建完成时为 true
return_enabled	Boolean	否	字段是否允许出现在召回返回字段中
supported_operators	Array	否	该字段数据类型支持的过滤操作符列表 eq ne gt ge lt le between is_null is_not_null contains not_contains in not_in

最近更新时间：2026.09.17 19:26:44

这个页面对您有帮助吗？

有用

有用

无用

无用