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 together in successive fashion
Platform docs: Append Files
AgentTools.append_files(tool_name="...")
Parameters
​
file_type
str
default:"'PDF'"
The type of file to append.
​
selected_files
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

Read data from an Excel cell. 
AgentTools.excel_cell_reader(tool_name="...")
Parameters
​
cell_index
Any
The cell to read from.
​
read_formatting
Any
Whether to read the formatting of the cell.
​
selected_file
str
The file to read from.
​
sheet
Any
The sheet to read from.

​
excel_cell_writer

Write data to an Excel cell. 
AgentTools.excel_cell_writer(tool_name="...")
Parameters
​
cell_index
Any
The cell to read from.
​
cell_value
Any
The value to write to the cell.
​
fill_color
Any
The fill color of the cell.
​
horizontal_alignment
Any
The horizontal alignment of the cell.
​
selected_file
str
The file to read from.
​
sheet
Any
The sheet to read from.
​
vertical_alignment
Any
The vertical alignment of the cell.
​
set_vertical_alignment
Any
Whether to set the vertical alignment of the cell.
​
set_horizontal_alignment
Any
Whether to set the horizontal alignment of the cell.
​
set_fill_color
Any
Whether to set the fill color of the cell.

​
excel_file_reader

Read data from an Excel file. 
AgentTools.excel_file_reader(tool_name="...", read_single_sheet=True, selected_file="...")
Parameters
​
read_single_sheet
bool
required
Whether to read a single sheet from the Excel file.
​
selected_file
str
required
The file to read from.
​
read_formatting
bool
Whether to read the formatting of the cell.
​
read_formula
bool
Whether to read the formula of the cell.
​
sheet
str
The sheet to read from.

​
excel_writer

Write data to an Excel sheet. 
AgentTools.excel_writer(tool_name="...")
Parameters
​
cell_start_index
Any
The cell to start writing from.
​
cell_values
Any
The values to write to the cells.
​
fill_color
Any
The fill color of the cells.
​
horizontal_alignment
Any
The horizontal alignment of the cells.
​
selected_file
str
The file to write to.
​
sheet
Any
The sheet to write to.
​
vertical_alignment
Any
The vertical alignment of the cells.
​
set_vertical_alignment
Any
Whether to set the vertical alignment of the cells.
​
set_horizontal_alignment
Any
Whether to set the horizontal alignment of the cells.
​
set_fill_color
Any
Whether to set the fill color of the cells.

​
file_save

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

​
file_to_text

Convert data from type File to type Text
Platform docs: File to Text
AgentTools.file_to_text(tool_name="...", chunk_text=True, file="...")
Parameters
​
chunk_text
bool
required
Whether to chunk the text into smaller pieces.
​
file
str
required
The file to convert to text.
​
file_parser
str
The type of file parser to use.
​
chunk_overlap
int
The overlap of each chunk of text.
​
chunk_size
int
The size of each chunk of text.

​
text_to_file

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