> ## Documentation Index > Fetch the complete documentation index at: https://docs.dify.ai/llms.txt > Use this file to discover all available pages before exploring further. # 获取知识库设置 > 返回知识库的嵌入模型、检索设置、就绪状态，以及调用 [更新知识库设置](/zh/api-reference/settings/update-knowledge-base-settings) 时需要发送的 `revision`。 何时可以通过 API 设置模型，详见 [更换模型或检索设置](/zh/api-reference/guides/knowledge-base#change-models-or-retrieval-settings)。 ## OpenAPI ````yaml /zh/api-reference/openapi_service.json get /knowledge-fs/spaces/{knowledge_base_id}/settings openapi: 3.0.1 info: description: 用于 Dify 应用与知识库的 REST API。应用类接口使用应用 API 密钥认证，知识库类接口使用知识库 API 密钥认证。 title: Dify 服务 API version: 1.0.0 servers: - description: Dify 服务 API 的基础 URL。自部署时，替换为你的 API 基础 URL。 url: https://{api_base_url} variables: api_base_url: default: api.dify.ai/v1 description: API 基础 URL 的主机与路径，不含 `https://` 前缀。 security: - ApiKeyAuth: [] tags: - description: 与聊天消息和交互相关的操作。 name: 对话消息 - description: 文件上传和预览操作。 name: 文件操作 - description: 终端用户信息相关操作。 name: 终端用户 - description: 用户反馈操作。 name: 消息反馈 - description: 与管理会话相关的操作。 name: 会话管理 - description: 文字转语音和语音转文字操作。 name: 语音与文字转换 - description: 获取应用设置和信息的操作。 name: 应用配置 - description: 与管理标注直接回复相关的操作。 name: 标注管理 - description: 暂停等待人工输入的工作流恢复操作。 name: 人工介入 - description: 用于执行和管理工作流的操作。 name: 工作流运行 - description: 文本生成相关操作。 name: 文本生成消息 - description: 用于管理知识库的操作，包括创建、配置和检索。 name: 知识库 - description: 用于在知识库中创建、更新和管理文档的操作。 name: 文档 - description: 用于管理分段和子分段的操作。 name: 分段 - description: 用于管理知识库元数据字段和文档元数据值的操作。 name: 元数据 - description: 用于管理知识库标签和标签绑定的操作。 name: 标签 - description: 用于获取可用模型的操作。 name: 模型 - description: 用于管理和运行知识流水线的操作，包括数据源插件和流水线执行。 name: 知识流水线 - description: 向知识库提问，并流式返回回答。 name: 查询 - description: 查看一次查询检索到了什么，以及原因。 name: 查询记录 - description: 在后台运行研究问题，并获取其结果。 name: 研究任务 - description: 读取知识库中的文档及其文件、修订版本和分段，并用元数据标注文档。 name: 文档与分段 - description: 跟踪、取消或重试索引，并列出知识库的后台任务。 name: 索引任务 - description: 跟踪文档文件、一批文件或数据源的删除，直到完成。 name: 删除作业 - description: 管理为知识库提供内容的数据源，以及它们的定时同步设置和连接。 name: 数据源 - description: 立即同步数据源，导入网站页面或提供商条目，并跟踪、取消或重试运行。 name: 数据源同步与导入 - description: 读取和更改知识库的模型与检索设置，并跟踪更改触发的迁移。 name: 设置 paths: /knowledge-fs/spaces/{knowledge_base_id}/settings: get: tags: - Settings summary: 获取知识库设置 description: >- 返回知识库的嵌入模型、检索设置、就绪状态，以及调用 [更新知识库设置](/zh/api-reference/settings/update-knowledge-base-settings) 时需要发送的 `revision`。 何时可以通过 API 设置模型，详见 [更换模型或检索设置](/zh/api-reference/guides/knowledge-base#change-models-or-retrieval-settings)。 operationId: getKnowledgeBaseSettings parameters: - description: >- 知识库 ID：即知识库 **API 访问** 对话框中所示服务 API 端点的最后一段（`…/knowledge-fs/spaces/`），也是地址栏中 `/datasets/new/` 之后的那一段。 in: path name: knowledge_base_id required: true schema: format: uuid type: string responses: '200': content: application/json: examples: setup_required: summary: 响应示例 - 需要设置 value: active_profile_available: false active_profile_revisions: embedding: null retrieval: null capabilities: deep: false index: false ingest: false query: false research: false source_sync: false configuration_state: setup-required embedding: null issues: - code: missing field: embedding retryable: false - code: missing field: reasoning retryable: false - code: missing field: rerank retryable: false retrieval: null revision: 1 success: summary: 响应示例 - 模型已生效 value: active_profile_available: true active_profile_revisions: embedding: 2 retrieval: 3 capabilities: deep: true index: true ingest: true query: true research: true source_sync: true configuration_state: active embedding: dimension: 1536 model: text-embedding-3-small plugin_id: langgenius/openai provider: openai revision: 2 vector_space_id: >- embedding-space-sha256:4f7c2d9a1b3e5f60718293a4b5c6d7e8f9a0b1c2d3e4f5a6b7c8d9e0f1a2b3c4 issues: [] retrieval: default_mode: fast reasoning_model: dimension: null model: gpt-4.1-mini plugin_id: langgenius/openai provider: openai revision: null vector_space_id: null rerank: enabled: true model: model: rerank-v3.5 pluginId: langgenius/cohere provider: cohere revision: 3 score_threshold: enabled: false stage: mode-final value: null top_k: 10 revision: 7 schema: $ref: '#/components/schemas/KnowledgeBaseSettings' description: 知识库的设置。 '401': content: application/json: examples: knowledge_fs_invalid_credential: summary: knowledge_fs_invalid_credential value: code: knowledge_fs_invalid_credential message: Invalid Agent Knowledge Base service credential. status: 401 unauthorized_1: summary: unauthorized (header missing) value: code: unauthorized message: >- Authorization header must be provided and start with 'Bearer' status: 401 unauthorized_2: summary: unauthorized (key unknown) value: code: unauthorized message: Access token is invalid status: 401 description: >- - `unauthorized`：缺少 `Authorization` 请求头，或密钥无法识别、不是知识库 API 密钥。 - `knowledge_fs_invalid_credential`：密钥有效，但其所属工作空间中没有此 ID 的知识库，或该密钥未关联任何工作空间。 '403': content: application/json: examples: forbidden: summary: forbidden (rate limit) value: code: forbidden message: >- Sorry, you have reached the knowledge base request rate limit of your subscription. status: 403 knowledge_fs_access_denied: summary: knowledge_fs_access_denied value: code: knowledge_fs_access_denied message: Agent Knowledge Base operation is not allowed. status: 403 description: >- - `knowledge_fs_access_denied`：该密钥的访问范围限定为其他知识库、此知识库已关闭 **API 访问**，或知识库未处于活动状态。 - `forbidden`：在 Dify Cloud 上，工作空间已达到其订阅套餐的知识库请求频率限制。所有调用都计入，读取操作也不例外。 '404': content: application/json: examples: knowledge_fs_resource_not_found: summary: knowledge_fs_resource_not_found value: code: knowledge_fs_resource_not_found failure: category: not_found code: KNOWLEDGE_FS_NOT_FOUND message: >- The requested Agent Knowledge Base resource was not found. retryPolicy: never traceId: 9b7d3e1a-4c2f-4a8e-b6d0-5f1e2c3d4a5b message: The requested Agent Knowledge Base resource was not found. status: 404 not_found: summary: not_found (feature off) value: code: not_found message: >- The requested URL was not found on the server. If you entered the URL manually please check your spelling and try again. status: 404 description: |- - `knowledge_fs_resource_not_found`：无法识别该知识库 ID。 - `not_found`：当前部署已关闭 Agent 知识库功能。 '502': content: application/json: examples: knowledge_fs_upstream_unavailable: summary: knowledge_fs_upstream_unavailable value: code: knowledge_fs_upstream_unavailable message: Agent Knowledge Base is unavailable. status: 502 knowledge_fs_upstream_unavailable_upstream: summary: knowledge_fs_upstream_unavailable (internal error) value: code: knowledge_fs_upstream_unavailable failure: action: contact_admin category: internal code: KNOWLEDGE_FS_INTERNAL_ERROR message: >- Agent Knowledge Base could not complete the operation. Try again, or contact an administrator with the error reference. retryPolicy: manual traceId: 9b7d3e1a-4c2f-4a8e-b6d0-5f1e2c3d4a5b message: >- Agent Knowledge Base could not complete the operation. Try again, or contact an administrator with the error reference. status: 502 description: '- `knowledge_fs_upstream_unavailable`：未能及时收到响应，或无法读取响应。稍候重试。' '503': content: application/json: examples: knowledge_fs_operation_unavailable: summary: knowledge_fs_operation_unavailable value: code: knowledge_fs_operation_unavailable message: Agent Knowledge Base operation is not available. status: 503 knowledge_fs_operation_unavailable_upstream: summary: knowledge_fs_operation_unavailable (temporary) value: code: knowledge_fs_operation_unavailable failure: action: retry category: dependency code: KNOWLEDGE_FS_UNAVAILABLE message: >- A service required by Agent Knowledge Base is temporarily unavailable. retryPolicy: manual traceId: 5e2a9c17-3b4d-4f60-8a1b-2c3d4e5f6a7b message: >- A service required by Agent Knowledge Base is temporarily unavailable. status: 503 description: >- - `knowledge_fs_operation_unavailable`：此工作空间尚未配置 Agent 知识库功能、当前部署不提供此操作，或在请求鉴权期间该密钥对此知识库的访问权限发生了变化。重试即可。 - `knowledge_fs_operation_unavailable`：暂时无法处理该请求。按 `failure.retryPolicy` 处理。 components: schemas: KnowledgeBaseSettings: properties: active_profile_available: description: 嵌入模型和检索设置均已生效时为 `true`，首个文档完成索引后即会如此。 type: boolean active_profile_revisions: description: >- 已生效模型的修订版本。首个文档完成索引前均为 `null`。配置生效后，通过 [更新知识库设置](/zh/api-reference/settings/update-knowledge-base-settings) 进行的更改会作为设置迁移执行。 properties: embedding: description: 已生效嵌入模型的修订版本。 nullable: true type: integer retrieval: description: 已生效检索设置的修订版本。 nullable: true type: integer type: object capabilities: description: >- 已发布设置的就绪情况。其中三个标志对应检索深度，`query` 对应 `fast`。 要检查某一深度是否就绪，显式传入该深度作为 `mode`，并查看对应的标志。查询未指定 `mode` 时，不要根据待生效的 `retrieval.default_mode` 判断其深度。 properties: deep: description: 可运行 `deep` 深度的查询。 type: boolean index: description: 可索引文档，模型已生效。 type: boolean ingest: description: 可添加文档：模型已生效，或者待生效设置已完整，可由首个文档激活。 type: boolean query: description: 可运行 `fast` 深度的查询。 type: boolean research: description: 可运行 `research` 深度的查询。 type: boolean source_sync: description: 数据源可同步，条件与 `ingest` 相同。 type: boolean type: object configuration_state: description: >- 已存储嵌入模型和完整的检索设置（含已启用的重排序模型）时为 `active`，缺少任一项时为 `setup-required`，首个文档索引期间待生效设置未通过校验时为 `validation-failed`。`issues` 列出未通过的设置项。 type: string embedding: description: |- 嵌入模型。若已存储待生效的选择，返回该选择，否则返回已生效的模型。待生效的选择可能与当前查询所用的模型不同。未设置时为 `null`。 其中的 `dimension`、`revision` 和 `vector_space_id` 仅供参考，没有任何操作接收这些值。 nullable: true properties: dimension: description: 向量维度，在首次使用模型时获取。模型生效前为 `null`。 nullable: true type: integer model: description: 模型名称。 type: string plugin_id: description: 提供该模型的插件，格式为 `organization/plugin_name`。 type: string provider: description: 插件内的供应商名称。 type: string revision: description: 已生效嵌入模型的修订版本。模型生效前为 `null`。 nullable: true type: integer vector_space_id: description: 标识该模型向量的存储位置。模型生效前为 `null`。 nullable: true type: string type: object issues: description: 导致知识库未就绪的问题。没有问题时为空。 items: properties: code: description: >- 该设置项的问题： - `missing`：未选择，或未启用重排序。 - `validation_failed`、`unavailable` 或 `incompatible`：待生效设置未通过校验。遇到 `incompatible` 时，检查模型支持的任务、嵌入维度，以及供应商是否返回了所选模型。 - `binding_missing`：已发布的内容尚未准备好使用所配置的模型。可在 Dify 中查看索引进度。 - `publication` 项为 `unavailable`：已发布的内容尚未对所有深度就绪。 type: string field: description: >- 涉及的设置项：`embedding`、`reasoning`、`rerank` 或 `publication`（已发布的内容）。 type: string retryable: description: 是否无需更改设置，只需等待并重试即可解决该问题。 type: boolean type: object type: array retrieval: description: 检索设置。若已存储待生效的选择，返回该选择，否则返回已生效的设置。待生效的选择可能与当前查询所用的设置不同。未设置时为 `null`。 nullable: true properties: default_mode: description: >- 返回的检索设置中的默认深度：`fast`、`deep` 或 `research`。查询未指定 `mode` 时使用已发布的默认值；如果返回的是待生效设置，该默认值可能与此值不同。 type: string reasoning_model: description: 系统推理模型。其 `dimension`、`revision` 和 `vector_space_id` 始终为 `null`。 properties: dimension: description: 始终为 `null`。 nullable: true type: integer model: description: 模型名称。 type: string plugin_id: description: 提供该模型的插件，格式为 `organization/plugin_name`。 type: string provider: description: 插件内的供应商名称。 type: string revision: description: 始终为 `null`。 nullable: true type: integer vector_space_id: description: 始终为 `null`。 nullable: true type: string type: object rerank: description: 重排序模型。其 `model` 对象使用 camelCase 键 `pluginId`，与此响应的其余部分不同。 properties: enabled: description: 是否对检索到的分段进行重排序。 type: boolean model: description: 所选的重排序模型。未设置重排序模型时为 `null`。 nullable: true properties: model: description: 模型名称。 type: string pluginId: description: 提供该模型的插件，格式为 `organization/plugin_name`。 type: string provider: description: 插件内的供应商名称。 type: string type: object type: object revision: description: 已生效检索设置的修订版本。设置待生效期间为 `null`。 nullable: true type: integer score_threshold: description: 分数阈值，用于舍弃得分较低的分段。 properties: enabled: description: 是否启用阈值。 type: boolean stage: description: >- 阈值应用的位置。`mode-final` 按实际运行的检索深度，对其最终分数应用阈值：`fast` 和 `deep` 下为重排序分数，`research` 下为 PageIndex 分数。`rerank` 是同一选项的旧名称。 type: string value: description: 阈值分数，取值 0～1。未设置时为 `null`。 nullable: true type: number type: object top_k: description: 每次检索最多返回的分段数。 type: integer type: object revision: description: >- 设置的修订版本。调用 [更新知识库设置](/zh/api-reference/settings/update-knowledge-base-settings) 时将其作为 `expectedRevision` 传入。此响应中的其他修订版本字段都不是该值。 type: integer type: object securitySchemes: ApiKeyAuth: bearerFormat: API_KEY description: >- 每个请求都通过 API Key 认证：`Authorization: Bearer {API_KEY}`。应用接口使用应用 API Key，知识库接口使用知识库 API Key（[快速开始](/zh/api-reference/guides/get-started)）。 API Key 应保存在服务端，切勿嵌入客户端代码。缺失或无效的 Key 会返回 HTTP `401`（`unauthorized`）。 scheme: bearer type: http ```` This documentation is built and hosted on [Mintlify](https://mintlify.com), a developer documentation platform.