mirror of
https://github.com/modelstudioai/cli.git
synced 2026-09-14 19:49:23 +08:00
zeyu.fz
e292b20d4b
- 新增 Chunk 管理命令手册，涵盖添加、列出、更新、删除操作详解 - 新增数据中心集合与分类命令文档，介绍集合创建、查看，分类增删查等功能 - 新增文档管理命令，包含文档上传、导入 OSS、状态查询、删除及标签管理 - 新增数据中心文件管理文档，涵盖文件列表、详情查看、删除等命令说明 - 新增知识库管理命令手册，包含知识库创建、查看、更新、删除和监控 - 各命令均详细说明参数、输出格式及多模式支持（text/quiet/json） - 提供丰富示例及注意事项，帮助用户正确使用相关命令
158 lines
3.8 KiB
Markdown
158 lines
3.8 KiB
Markdown
# 数据中心文件管理命令手册
|
||
|
||
数据中心是知识库文件的存储层。文件通过 `doc upload` 或 `doc import-oss` 进入数据中心，再导入到知识库。数据中心文件可被多个知识库引用。
|
||
|
||
> **通用约定**（鉴权、Workspace ID、全局参数、输出格式、危险操作确认、Dry-run 模式）请参阅 [总览文档](../knowledge-cli-guide.md#通用约定)。
|
||
|
||
---
|
||
|
||
#### `bl knowledge file list`
|
||
|
||
列出数据中心分类下的文件。
|
||
|
||
**用法**
|
||
|
||
```bash
|
||
bl knowledge file list --category-id <id> [flags]
|
||
```
|
||
|
||
**参数**
|
||
|
||
| 参数 | 类型 | 必填 | 说明 |
|
||
| ---------------------- | ------ | ---- | -------------------------------------------------- |
|
||
| `--category-id <id>` | string | 是 | 分类 ID（通过 `category list` 或 `file 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>` 继续翻页。
|
||
|
||
**示例**
|
||
|
||
```bash
|
||
# 列出分类下文件
|
||
bl knowledge file list --category-id cate-xxx --workspace-id ws-xxx
|
||
|
||
# 按名称过滤
|
||
bl knowledge file list --category-id cate-xxx --name report
|
||
|
||
# 翻页
|
||
bl knowledge file list --category-id cate-xxx --next-token eyJ...
|
||
```
|
||
|
||
---
|
||
|
||
#### `bl knowledge file get`
|
||
|
||
查看数据中心文件详情。
|
||
|
||
**用法**
|
||
|
||
```bash
|
||
bl knowledge 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 原始响应。
|
||
|
||
**注意事项**
|
||
|
||
- 无特殊注意事项。
|
||
|
||
**示例**
|
||
|
||
```bash
|
||
# 查看文件详情
|
||
bl knowledge file get --file-id file-xxx --workspace-id ws-xxx
|
||
```
|
||
|
||
---
|
||
|
||
#### `bl knowledge file delete`
|
||
|
||
从数据中心永久删除文件。
|
||
|
||
**用法**
|
||
|
||
```bash
|
||
bl knowledge 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` 删除源文件本身，影响所有引用它的知识库。
|
||
|
||
**示例**
|
||
|
||
```bash
|
||
# 删除文件（交互确认）
|
||
bl knowledge file delete --file-id file-xxx --workspace-id ws-xxx
|
||
|
||
# 跳过确认
|
||
bl knowledge file delete --file-id file-xxx --yes
|
||
```
|
||
|
||
---
|
||
|
||
← [返回总览](../knowledge-cli-guide.md)
|