跳转到主要内容
GET
获取知识库详情

授权

Authorization
string
header
必填

每个请求都通过 API Key 认证:Authorization: Bearer {API_KEY}。应用接口使用应用 API Key,知识库接口使用知识库 API Key(快速开始)。

API Key 应保存在服务端,切勿嵌入客户端代码。缺失或无效的 Key 会返回 HTTP 401unauthorized)。

路径参数

dataset_id
string<uuid>
必填

知识库 ID。从 获取知识库列表 获取。

响应

知识库详情。

id
string

知识库的唯一标识符。

name
string

知识库的显示名称。在工作区内唯一。

description
string

描述知识库用途或内容的可选文本。

provider
string

供应商类型。内部管理为 vendor,外部知识库连接为 external

permission
string

控制谁可以访问此知识库。可选值:only_meall_team_memberspartial_members

data_source_type
string

文档的数据源类型,尚未配置时为 null

indexing_technique
string

high_quality 使用嵌入模型进行精确搜索;economy 使用基于关键词的索引。

app_count
integer

当前使用该知识库的应用数量。

document_count
integer

知识库中的文档总数。

word_count
integer

所有文档的总字数。

created_by
string

创建该知识库的用户 ID。

author_name
string

创建者的显示名称。

created_at
number

创建时间戳(Unix 纪元,单位为秒)。

updated_by
string

最后更新该知识库的用户 ID。

updated_at
number

最后更新时间戳(Unix 纪元,单位为秒)。

embedding_model
string

用于索引的嵌入模型名称。

embedding_model_provider
string

嵌入模型供应商标识符,格式为 organization/plugin_name/provider_name(例如 langgenius/openai/openai)。旧版知识库可能返回简写形式(例如 openai)。

embedding_available
boolean

配置的嵌入模型当前是否可用。

retrieval_model_dict
object

知识库的检索配置。

summary_index_setting
object | null

摘要索引配置。

tags
object[]

与该知识库关联的标签。

doc_form
string

文档分块模式。text_model 表示标准文本分块,hierarchical_model 表示父子结构,qa_model 表示问答对提取。

external_knowledge_info
object | null

外部知识库的连接详情。当 providerexternal 时存在。

external_retrieval_model
object | null

外部知识库的检索设置。内部知识库时为 null

doc_metadata
object[]

知识库的元数据字段定义。

built_in_field_enabled
boolean

是否启用内置元数据字段(例如 document_nameuploader)。

pipeline_id
string | null

自定义处理流水线的 ID(如果已配置)。

runtime_mode
string | null

运行时处理模式。

chunk_structure
string | null

分段结构配置。

icon_info
object | null

知识库的图标显示配置。

is_published
boolean

知识库是否已发布。

total_documents
integer

文档总数。

total_available_documents
integer

已启用且可用的文档数量。

enable_api
boolean

该知识库是否启用 API 访问。

is_multimodal
boolean

是否启用多模态内容处理。

partial_member_list
string[] | null

permissionpartial_members 时被授予访问权限的成员账户 ID。更新响应中始终返回;详情响应中仅当 permissionpartial_members 时返回。