knowledge:update

更新知识库，用于将 Issue、仓库文档等构建入知识库。

• 适用事件
• 参数
• 配置样例

适用事件

所有事件

工作机制

拉取仓库的 Issue、仓库文档 -> 切片 -> 向量化 -> 进入知识库

参数

以下列表按「文档 / Issue」用途分组概览全部参数。

• include：需要纳入知识库的文件，Glob 匹配
• exclude：需要排除的文件，Glob 匹配
• chunkSize：文本分块大小
• chunkOverlap：相邻分块的重叠 token 数
• embeddingModel：嵌入模型（仅支持 hunyuan）
• issueSyncEnabled：是否同步 Issue 进知识库
• issueState：仅同步指定状态的 Issue（open/closed）
• issueLabels：仅同步指定标签的 Issue
• issueExcludeLabels：排除指定标签的 Issue（优先级更高）
• forceRebuild：是否删除知识库并重新构建
• ignoreProcessFailures：有文件处理失败时是否仍更新知识库

各参数详细说明如下。

include

• type: String | Array<String>
• required: false
• default: **/**.md

指定需要包含的文件，使用 Glob 模式匹配，默认为 **/**.md（包含所有 Markdown 文件）， 支持数组或逗号分隔。当前支持的文件类型有：.md、.mdx、.docx、.txt、.pdf。

exclude

• type: String | Array<String>
• required: false

指定需要排除的文件，使用 Glob 模式匹配，默认不排除任何文件，支持数组或逗号分隔。

chunkSize

• type: Number
• required: false
• default: 1500

指定文本分块大小。

chunkOverlap

• type: Number
• required: false
• default: 0

指定相邻两个分块之间的重叠 token 数量。

embeddingModel

• type: String
• required: false
• default: hunyuan

嵌入模型，目前仅支持 hunyuan。

issueSyncEnabled

• type: Boolean
• required: false
• default: true

是否启用 Issue 同步功能。启用后会自动拉取仓库的 Issue 数据并加入知识库。

issueState

• type: String
• required: false

仅同步指定状态的 Issue，默认包含全部 Issue，可选值为 open | closed。

issueLabels

• type: String | Array<String>
• required: false

仅同步指定标签的 Issue，默认包含全部 Issue，支持数组或逗号分隔。

issueExcludeLabels

• type: String | Array<String>
• required: false

排除带有指定标签的 Issue，默认不排除任何 Issue，支持数组或逗号分隔。 当与 issueLabels 存在交集时，exclude 优先。

forceRebuild

• type: Boolean
• required: false
• default: false

是否删除知识库并重新构建。当设置为 true 时，删除并重新创建知识库。

ignoreProcessFailures

• type: Boolean
• required: false
• default: false

是否忽略文档处理失败。当设置为 true 时，即使有文件处理失败也会更新知识库。

配置样例

基本使用

.cnb.yml

main:
  push:
    - stages:
        - name: build knowledge base
          type: knowledge:update
          options:
            include: "**/**.md"