帮你快速理解、总结文档立即下载

read_file

最近更新时间:2026-08-27 17:42:02
我的收藏

方法介绍

read_file 用于读取 Skill 中某个资源文件的内容。功能说明如下:
按路径读取:通过 path 指定要读取的资源文件路径。
版本指定:支持按版本号读取历史版本中的文件,不传 version 则返回最新版本。
编码控制:通过 encoding 参数控制内容编码方式。

导入

from tencentdb_agent_memory.v3 import SkillClient

方法签名

def read_file(
self,
skill_id: str,
path: str,
*,
version: Optional[int] = None,
encoding: Optional[str] = None,
team_id: Optional[str] = None,
agent_id: Optional[str] = None,
user_id: Optional[str] = None,
task_id: Optional[str] = None,
) -> Dict[str, Any]

使用示例

from tencentdb_agent_memory.v3 import SkillClient

with SkillClient(
endpoint="https://memory.tdai.tencentyun.com",
api_key="sk-xxxxxxxxxxxxxxxx",
service_id="tdai-mem-xxxxxxxx",
team_id="team-abc123",
agent_id="agt-xyz789",
user_id="usr-456",
) as client:
result = client.read_file(
skill_id="skill-abc123", # 必填,Skill ID
path="examples/usage.py", # 必填,文件路径
version=3, # 可选,指定版本号
)
print(result["content"])

请求参数

参数名
类型
必填
描述说明
skill_id
str
Skill ID
path
str
文件路径
version
int
指定版本号,不传返回最新版本
encoding
str
内容编码方式,默认返回原始格式
team_id
str
团队 ID,覆盖构造时的默认值
agent_id
str
Agent ID,覆盖构造时的默认值
user_id
str
用户 ID,覆盖构造时的默认值
task_id
str
Task ID,覆盖构造时的默认值

响应示例

{
"path": "examples/usage.py",
"content": "print('hello world')",
"mime_type": "text/x-python",
"encoding": "utf-8",
"size": 20
}

Running Environment

Operating System: Ubuntu 24.04.3 LTS / x86_64

Runtime Version: Python 3.11.1

响应参数说明

参数名
类型
参数含义
path
str
文件路径
content
str
文件内容
mime_type
str
MIME 类型
encoding
str
编码方式
size
int
文件大小(字节)

错误码

错误码
触发场景
处理建议
404
Skill 或文件不存在
检查 skill_id 和 path 是否正确
401
API Key 无效或过期
检查 api_key 配置
500
服务内部错误
可有限重试