Files
modelstudioai__cli/docs/kscli/file.md
zeyu.fz a95ad7242b docs(cli): 添加完整的 KSCLI 命令手册文档
- 新增知识库管理(kb)命令详解,包含创建、查询、更新、删除和状态监控
- 补充文档(doc)管理命令,包括文件上传、导入状态查询、标签管理等
- 增加数据中心文件(file)管理说明,覆盖文件列表、详情、删除操作
- 完善集合与分类管理(collection/category)命令手册,支持创建、查询、删除等功能
- 详细描述 chunk 管理命令,包括添加、更新、查询和删除操作
- 统一说明通用约定,涵盖鉴权、全局参数、输出格式、确认机制及干跑模式
- 提供丰富参数说明、输出格式及使用示例,提升 CLI 使用体验和易用性
2026-08-22 12:19:55 +08:00

3.7 KiB
Raw Permalink Blame History

数据中心文件管理命令手册

数据中心是知识库文件的存储层。文件通过 doc uploaddoc import-oss 进入数据中心,再导入到知识库。数据中心文件可被多个知识库引用。

通用约定鉴权、Workspace ID、全局参数、输出格式、危险操作确认、Dry-run 模式)请参阅 总览文档


kscli file list

列出数据中心分类下的文件。

用法

kscli file list --category-id <id> [flags]

参数

参数 类型 必填 说明
--category-id <id> string 分类 ID通过 category listfile get 获取)
--name <text> string 按文件名过滤
--file-id <id> array 按文件 ID 过滤(可重复)
--next-token <token> string 游标分页令牌(从上次输出获取)
--max-result <n> number 每页条数

输出

text 模式:

file-xxx  SUCCESS  intro.md  1024
next: --next-token eyJ...

quiet 模式:每行一个 fileId

json 模式:返回 API 原始响应。

注意事项

  • --category-id 必须是真实的分类 ID。与上传 API 不同,字面量 default 在此不被解析,传入会返回空列表。通过 file get 的 category 字段或 category list 获取真实 ID。
  • 分页是游标方式:使用输出的 next: --next-token <token> 继续翻页。

示例

# 列出分类下文件
kscli file list --category-id cate-xxx --workspace-id ws-xxx

# 按名称过滤
kscli file list --category-id cate-xxx --name report

# 翻页
kscli file list --category-id cate-xxx --next-token eyJ...

kscli file get

查看数据中心文件详情。

用法

kscli file get --file-id <id> [flags]

参数

参数 类型 必填 说明
--file-id <id> string 数据中心文件 ID

输出

text 模式:

id: file-xxx
name: intro.md
type: md
size: 1024
status: SUCCESS
parser: AUTO_SELECT
category: cate-xxx
uploaded: 2026-01-01T00:00:00Z
tags: project-a, draft

quiet 模式:输出 JSON 格式。

json 模式:返回 API 原始响应。

注意事项

  • 无特殊注意事项。

示例

# 查看文件详情
kscli file get --file-id file-xxx --workspace-id ws-xxx

kscli file delete

从数据中心永久删除文件。

用法

kscli file delete --file-id <id> [flags]

参数

参数 类型 必填 说明
--file-id <id> string 数据中心文件 ID
--yes switch 跳过确认提示

输出

text 模式:

deleted: file-xxx

quiet 模式:无输出。

json 模式:返回 API 原始响应。

注意事项

  • 不可逆操作:如果知识库引用了此文件,相关文档索引会失效。
  • doc delete 的区别:doc delete 只从单个知识库索引中移除文档,数据中心源文件保留;file delete 删除源文件本身,影响所有引用它的知识库。

示例

# 删除文件(交互确认)
kscli file delete --file-id file-xxx --workspace-id ws-xxx

# 跳过确认
kscli file delete --file-id file-xxx --yes

返回总览