mirror of
https://github.com/crewAIInc/crewAI.git
synced 2026-09-01 06:07:59 +00:00
docs: note constructor file_path resolves against base_dir
A relative default path anchors to base_dir when set, not the cwd. Co-authored-by: Rip&Tear <theCyberTech@users.noreply.github.com>
This commit is contained in:
@@ -52,7 +52,7 @@ The agent can pass these at runtime:
|
||||
|
||||
You can set these when you create the tool:
|
||||
|
||||
- `file_path`: (Optional) Default file to read when the agent calls the tool with no path.
|
||||
- `file_path`: (Optional) Default file to read when the agent calls the tool with no path. A relative path resolves against `base_dir` when `base_dir` is provided, otherwise against the current working directory.
|
||||
- `base_dir`: (Optional) Directory that runtime paths must stay inside. Default is the current working directory. The tool resolves this path when the tool is created, so a later change of working directory does not move the sandbox.
|
||||
- `encoding`: (Optional) Text encoding used to decode the file. Default is `utf-8`. If decoding fails, the tool returns an error and suggests passing a different `encoding`.
|
||||
|
||||
|
||||
Reference in New Issue
Block a user