Skip to main content
GET
获取知识库设置

Authorizations

Authorization
string
header
required

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

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

Path Parameters

knowledge_base_id
string<uuid>
required

知识库 ID:即知识库 API 访问 对话框中所示服务 API 端点的最后一段(…/knowledge-fs/spaces/<knowledge base ID>),也是地址栏中 /datasets/new/ 之后的那一段。

Response

知识库的设置。

active_profile_available
boolean

嵌入模型和检索设置均已生效时为 true,首个文档完成索引后即会如此。

active_profile_revisions
object

已生效模型的修订版本。首个文档完成索引前均为 null。配置生效后,通过 更新知识库设置 进行的更改会作为设置迁移执行。

capabilities
object

已发布设置的就绪情况。其中三个标志对应检索深度,query 对应 fast。

要检查某一深度是否就绪,显式传入该深度作为 mode,并查看对应的标志。查询未指定 mode 时,不要根据待生效的 retrieval.default_mode 判断其深度。

configuration_state
string

已存储嵌入模型和完整的检索设置(含已启用的重排序模型)时为 active,缺少任一项时为 setup-required,首个文档索引期间待生效设置未通过校验时为 validation-failed。issues 列出未通过的设置项。

embedding
object | null

嵌入模型。若已存储待生效的选择,返回该选择,否则返回已生效的模型。待生效的选择可能与当前查询所用的模型不同。未设置时为 null。

其中的 dimension、revision 和 vector_space_id 仅供参考,没有任何操作接收这些值。

issues
object[]

导致知识库未就绪的问题。没有问题时为空。

retrieval
object | null

检索设置。若已存储待生效的选择,返回该选择,否则返回已生效的设置。待生效的选择可能与当前查询所用的设置不同。未设置时为 null。

revision
integer

设置的修订版本。调用 更新知识库设置 时将其作为 expectedRevision 传入。此响应中的其他修订版本字段都不是该值。