Skip to main content

知识库管理命令

kscli kb 命令组,创建、查看、更新、删除知识库与监控查询

知识库存储文档解析后的索引内容,是检索的数据载体。本组共 6 个命令。 鉴权、业务空间 ID、全局参数、输出格式、二次确认和干跑模式等通用约定见 CLI 概述。以下示例默认已通过配置文件设置业务空间 ID,因此省略 --workspace-id。

kscli kb list

列出业务空间中的知识库。
kscli kb list [flags]
参数
参数类型必填说明
--name <text>string否按知识库名称模糊过滤,1–20 字符
--page-number <n>number否页码,默认 1
--page-size <n>number否每页条数,默认 20,范围 1–100
输出 text 模式每行一个知识库,字段以双空格分隔,末尾显示总数:
idx-xxx  my-kb  text-embedding-v4  600  product docs
total: 1
quiet 模式每行输出一个知识库 ID。json 模式返回完整结果,知识库列表在 data.rows 中。 输出的知识库 ID 用作后续命令的 --index-id。 示例
# 列出全部知识库
kscli kb list

# 按名称过滤并翻页
kscli kb list --name demo --page-number 2 --page-size 50

kscli kb info

查看知识库配置详情。
kscli kb info --index-id <id> [flags]
参数
参数类型必填说明
--index-id <id>string是知识库 ID
输出 text 模式按维度分组展示:
Basic:
  id: idx-xxx
  name: my-kb
  description: product docs
Indexing:   [immutable — recreate required to change]
  embeddingModelName: text-embedding-v4
  embeddingDimension: 1024
  chunkSize: 600
  overlapSize: 100
Retrieval:
  rerankModelName: qwen3-rerank
  rerankMinScore: 0.2
  rerankTopN: 5
  enableRewrite: true
Data:
  sourceType: DATA_CENTER_FILE
quiet 模式输出知识库 ID。json 模式返回完整配置。
Indexing 分组下的索引设置(向量模型、向量维度、切片大小、重叠长度、切分模式等)在知识库创建后不可修改。需要调整时只能重建知识库并重新导入文档。
示例
kscli kb info --index-id idx-xxx

kscli kb create

创建知识库并导入数据中心的文件或分类。
kscli kb create --name <text> (--doc-id <id> | --category-id <id>) [flags]
参数
参数类型必填说明
--name <text>string是知识库名称,1–20 字符,业务空间内唯一
--doc-id <id>array二选一数据中心文件 ID,可重复传入;与 --category-id 互斥
--category-id <id>array二选一导入该分类下的所有文件,可重复传入;与 --doc-id 互斥
--embedding-model <name>string否向量模型名称,默认 text-embedding-v4
--chunk-size <n>number否切片大小(字符数),默认 600,建议 300–800
--waitswitch否轮询初始导入任务直到终态
--poll-interval <seconds>number否轮询间隔秒数,默认 5
--doc-id 与 --category-id 互斥,必须提供其中一个。 输出
index_id: idx-xxx
ingestion_id: job-xxx
status: COMPLETED
quiet 模式只输出知识库 ID。json 模式返回知识库 ID 和导入任务 ID,使用 --wait 时追加 final_status 字段。 注意事项
  • 创建的是文档型(非结构化)知识库。
  • 返回的 ingestion_id 用于 kscli doc status 查询导入进度,也可以直接加 --wait 等待完成。
  • 使用 --wait 时如果部分文档解析失败,命令以非零退出码结束,但知识库本身已创建成功,错误提示中会说明具体失败的文档。
示例
# 从指定文件创建
kscli kb create --name demo --doc-id file-xxx

# 从分类导入并等待完成
kscli kb create --name demo --category-id cate-xxx --wait

# 指定向量模型和切片大小
kscli kb create --name my-kb --doc-id file-a --doc-id file-b \
  --embedding-model text-embedding-v4 --chunk-size 400

kscli kb update

更新知识库名称、描述或重排分数阈值。
kscli kb update --index-id <id> [flags]
参数
参数类型必填说明
--index-id <id>string是知识库 ID
--name <text>string否新名称,1–20 字符
--description <text>string否新描述
--rerank-min-score <score>number否重排最低分数阈值,范围 0–1,低于此分的切片被过滤
--name、--description、--rerank-min-score 至少提供一个,否则报错 Nothing to update。 输出
updated: idx-xxx
quiet 模式无输出。json 模式返回完整结果。 示例
# 更新描述
kscli kb update --index-id idx-xxx --description "product docs v2"

# 调整重排阈值
kscli kb update --index-id idx-xxx --rerank-min-score 0.3

kscli kb delete

删除知识库及其所有文档和切片。
kscli kb delete --index-id <id> [flags]
参数
参数类型必填说明
--index-id <id>string是知识库 ID
--yesswitch否跳过确认提示
输出
deleted: idx-xxx
删除操作不可恢复,知识库及其全部索引内容被永久删除。不带 --yes 时命令会先展示知识库名称和文档数量供确认。
数据中心的源文件不受影响,仅删除知识库索引。如需删除源文件,使用 kscli file delete。 示例
# 交互确认后删除
kscli kb delete --index-id idx-xxx

# 跳过确认,用于自动化脚本
kscli kb delete --index-id idx-xxx --yes

kscli kb stats

查看知识库的存储用量和 QPS 监控数据。
kscli kb stats --index-id <id> [flags]
参数
参数类型必填说明
--index-id <id>string是知识库 ID
--start <time>string否起始时间,Unix 秒或 ISO 日期,必须是过去时间,默认 24 小时前
--end <time>string否结束时间,Unix 秒或 ISO 日期,必须是过去时间,默认当前时间
输出
plan: standard
storage: 100 / 1000
peak qps: 5
qps windows: 24 data point(s)
quiet 模式和 json 模式均返回完整的存储与 QPS 监控数据。 --start 和 --end 同时支持 Unix 秒级时间戳和 ISO 日期(如 2026-07-30),毫秒级时间戳会自动兼容处理。 示例
# 最近 24 小时
kscli kb stats --index-id idx-xxx

# 指定日期范围
kscli kb stats --index-id idx-xxx --start 2026-07-30 --end 2026-07-31