概述
iFlow Python SDK 提供了安全的文件系统访问功能,允许 AI 助手在受控环境下读写本地文件。该功能基于白名单机制,确保只能访问明确授权的目录。
核心特性
- 目录白名单 - 只允许访问指定目录
- 路径安全 - 自动防止路径遍历攻击
- 大小限制 - 可配置文件大小上限
- 只读模式 - 可选的只读访问模式
- 权限控制 - 细粒度的文件操作权限
快速开始
最小配置(访问当前目录)
from iflow_sdk import IFlowClient, IFlowOptions
options = IFlowOptions(
file_access=True,
)
async with IFlowClient(options) as client:
await client.send_message("读取当前目录下的 README.md")
说明:
file_access=True 是必需的,默认为 False
- 不指定
file_allowed_dirs 时,默认只能访问 Python 进程的当前工作目录
配置参数
必需参数
| 参数 | 类型 | 默认值 | 说明 |
|---|
| file_access | bool | False | 必须设置为 True 才能启用文件系统功能 |
重要参数
| 参数 | 类型 | 默认值 | 说明 |
|---|
| file_allowed_dirs | List[str] | None | 允许访问的目录列表。None 表示只允许当前工作目录 |
| cwd | str | os.getcwd() | iFlow CLI 的工作目录。如果与当前目录不同,必须在 file_allowed_dirs 中包含 |
可选参数
| 参数 | 类型 | 默认值 | 说明 |
|---|
| file_read_only | bool |