Skip to main content
Add these tools with AgentTools.<tool>(tool_name="...", ...) or agent.add_tool.<tool>(tool_name="...", ...). Every tool requires a unique tool_name=. Each entry lists the tool’s configuration parameters. See the Agent reference for attaching and running tools.

append_files — Append Files

Append files together in successive fashion
Platform docs: Append Files
Parameters
str
default:"'PDF'"
The type of file to append.
list[str]
default:"['']"
The number of files to be appended. Files will be appended in successive fashion (e.g., file-1 first, then file-2, etc.).

excel_cell_reader — Excel Cell Reader

Read data from an Excel cell.
Parameters
Any
The cell to read from.
Any
Whether to read the formatting of the cell.
str
The file to read from.
Any
The sheet to read from.

excel_cell_writer — Excel Cell Writer

Write data to an Excel cell.
Parameters
Any
The cell to read from.
Any
The value to write to the cell.
Any
The fill color of the cell.
Any
The horizontal alignment of the cell.
str
The file to read from.
Any
The sheet to read from.
Any
The vertical alignment of the cell.
Any
Whether to set the vertical alignment of the cell.
Any
Whether to set the horizontal alignment of the cell.
Any
Whether to set the fill color of the cell.

excel_file_reader — Excel File Reader

Read data from an Excel file.
Parameters
bool
required
Whether to read a single sheet from the Excel file.
str
required
The file to read from.
bool
Whether to read the formatting of the cell.
bool
Whether to read the formula of the cell.
str
The sheet to read from.

excel_writer — Excel Writer

Write data to an Excel sheet.
Parameters
Any
The cell to start writing from.
Any
The values to write to the cells.
Any
The fill color of the cells.
Any
The horizontal alignment of the cells.
str
The file to write to.
Any
The sheet to write to.
Any
The vertical alignment of the cells.
Any
Whether to set the vertical alignment of the cells.
Any
Whether to set the horizontal alignment of the cells.
Any
Whether to set the fill color of the cells.

file_save — File Save

Save a file on the VectorShift platform (under the ‘Files’ tab).
Platform docs: File Save
Parameters
list[str]
default:"['']"
The files to be saved
str
default:"''"
The name of the file

file_to_text — File to Text

Convert data from type File to type Text
Platform docs: File to Text
Parameters
bool
required
Whether to chunk the text into smaller pieces.
str
required
The file to convert to text.
str
The type of file parser to use.
int
The overlap of each chunk of text.
int
The size of each chunk of text.

text_to_file — Text to File

Convert data from type Text to type File.
Platform docs: Text to File
Parameters
str
default:"'converted_file'"
The name for the generated file (without extension).
str
default:"'PDF'"
The type of file to convert the text to.
str
default:"''"
The text for conversion.