Skip to main content

Documentation Index

Fetch the complete documentation index at: https://docs.camel-ai.org/llms.txt

Use this file to discover all available pages before exploring further.

​
ExcelToolkit

class ExcelToolkit(BaseToolkit):
A class representing a toolkit for extract detailed cell information from an Excel file. This class provides methods extracting detailed content from Excel files (including .xls, .xlsx,.csv), and converting the data into Markdown formatted table.

​
init

def __init__(
    self,
    timeout: Optional[float] = None,
    working_directory: Optional[str] = None
):
Initializes a new instance of the ExcelToolkit class. Parameters:
  • timeout (Optional[float]): The timeout value for API requests in seconds. If None, no timeout is applied. (default: :obj:None)
  • working_directory (str, optional): The default directory for output files. If not provided, it will be determined by the CAMEL_WORKDIR environment variable (if set). If the environment variable is not set, it defaults to camel_working_dir.

​
_validate_file_path

def _validate_file_path(self, file_path: str):
Validate file path for security. Parameters:
  • file_path (str): The file path to validate.
Returns: bool: True if path is safe, False otherwise.

​
_convert_to_markdown

def _convert_to_markdown(self, df: 'DataFrame'):
Convert DataFrame to Markdown format table. Parameters:
  • df (DataFrame): DataFrame containing the Excel data.
Returns: str: Markdown formatted table.

​
extract_excel_content

def extract_excel_content(self, document_path: str):
Extract and analyze the full content of an Excel file (.xlsx/.xls/. csv). Use this tool to read and understand the structure and content of Excel files. This is typically the first step when working with existing Excel files. Parameters:
  • document_path (str): The file path to the Excel file.
Returns: str: A comprehensive report containing:
  • Sheet names and their content in markdown table format
  • Detailed cell information including values, colors, and positions
  • Formatted data that’s easy to understand and analyze

​
_save_workbook

def _save_workbook(self, file_path: str):
Save the current workbook to file. Parameters:
  • file_path (str): The path to save the workbook.
Returns: str: Success or error message.

​
save_workbook

def save_workbook(self, filename: str):
Save the current in-memory workbook to a file. Parameters:
  • filename (str): The filename to save the workbook. Must end with .xlsx extension. The file will be saved in self. working_directory.
Returns: str: Success message or error details.

​
create_workbook

def create_workbook(
    self,
    filename: Optional[str] = None,
    sheet_name: Optional[str] = None,
    data: Optional[List[List[Union[str, int, float, None]]]] = None
):
Create a new Excel workbook from scratch. Use this when you need to create a new Excel file. This sets up the toolkit to work with the new file and optionally adds initial data. Parameters:
  • filename (Optional[str]): The filename for the workbook. Must end with .xlsx extension. The file will be saved in self.working_directory. (default: :obj:None)
  • sheet_name (Optional[str]): Name for the first sheet. If None, creates “Sheet1”. (default: :obj:None)
  • data (Optional[List[List[Union[str, int, float, None]]]]): Initial data as rows. Each inner list is one row. (default: :obj:None)
Returns: str: Success confirmation message or error details

​
delete_workbook

def delete_workbook(self, filename: str):
Delete a spreadsheet file from the working directory. Parameters:
  • filename (str): The filename to delete. Must end with .xlsx extension. The file will be deleted from self. working_directory.
Returns: str: Success message or error details.

​
create_sheet

def create_sheet(
    self,
    sheet_name: str,
    data: Optional[List[List[Union[str, int, float, None]]]] = None
):
Create a new sheet with the given sheet name and data. Parameters:
  • sheet_name (str): The name of the sheet to create.
  • data (Optional[List[List[Union[str, int, float, None]]]]): The data to write to the sheet.
Returns: str: Success message.

​
delete_sheet

def delete_sheet(self, sheet_name: str):
Delete a sheet from the workbook. Parameters:
  • sheet_name (str): The name of the sheet to delete.
Returns: str: Success message.

​
clear_sheet

def clear_sheet(self, sheet_name: str):
Clear all data from a sheet. Parameters:
  • sheet_name (str): The name of the sheet to clear.
Returns: str: Success message.

​
delete_rows

def delete_rows(
    self,
    sheet_name: str,
    start_row: int,
    end_row: Optional[int] = None
):
Delete rows from a sheet. Use this to remove unwanted rows. You can delete single rows or ranges. Parameters:
  • sheet_name (str): Name of the sheet to modify.
  • start_row (int): Starting row number to delete (1-based, where 1 is first row).
  • end_row (Optional[int]): Ending row number to delete (1-based). If None, deletes only start_row. (default: :obj:None)
Returns: str: Success confirmation message or error details

​
delete_columns

def delete_columns(
    self,
    sheet_name: str,
    start_col: int,
    end_col: Optional[int] = None
):
Delete columns from a sheet. Use this to remove unwanted columns. You can delete single columns or ranges. Parameters:
  • sheet_name (str): Name of the sheet to modify.
  • start_col (int): Starting column number to delete (1-based, where 1 is column A).
  • end_col (Optional[int]): Ending column number to delete (1-based). If None, deletes only start_col. (default: :obj:None)
Returns: str: Success confirmation message or error details

​
get_cell_value

def get_cell_value(self, sheet_name: str, cell_reference: str):
Get the value from a specific cell. Use this to read a single cell’s value. Useful for checking specific data points or getting values for calculations. Parameters:
  • sheet_name (str): Name of the sheet containing the cell.
  • cell_reference (str): Excel-style cell reference (column letter + row number).
Returns: Union[str, int, float, None]: The cell’s value or error message Returns None for empty cells.

​
set_cell_value

def set_cell_value(
    self,
    sheet_name: str,
    cell_reference: str,
    value: Union[str, int, float, None]
):
Set the value of a specific cell. Use this to update individual cells with new values. Useful for corrections, calculations, or updating specific data points. Parameters:
  • sheet_name (str): Name of the sheet containing the cell.
  • cell_reference (str): Excel-style cell reference (column letter + row number).
  • value (Union[str, int, float, None]): New value for the cell. (default: :obj:None)
Returns: str: Success confirmation message or error details.

​
get_column_data

def get_column_data(self, sheet_name: str, column: Union[int, str]):
Get all data from a specific column. Use this to extract all values from a column for analysis or processing. Parameters:
  • sheet_name (str): Name of the sheet to read from.
  • column (Union[int, str]): Column identifier - either number (1-based) or letter.
Returns: Union[List[Union[str, int, float, None]], str]: List of all non-empty values in the column or error message

​
find_cells

def find_cells(
    self,
    sheet_name: str,
    search_value: Union[str, int, float],
    search_column: Optional[Union[int, str]] = None
):
Find cells containing a specific value. Use this to locate where specific data appears in the sheet. Parameters:
  • sheet_name (str): Name of the sheet to search in.
  • search_value (Union[str, int, float]): Value to search for.
  • search_column (Optional[Union[int, str]]): Limit search to specific column. If None, searches entire sheet. (default: :obj:None)
Returns: Union[List[str], str]: List of cell references (like “A5”, “B12”) where the value was found, or error message.

​
get_range_values

def get_range_values(self, sheet_name: str, cell_range: str):
Get values from a specific range of cells. Use this to read a rectangular block of cells at once. Parameters:
  • sheet_name (str): Name of the sheet to read from.
  • cell_range (str): Range in Excel format (start:end).
Returns: Union[List[List[Union[str, int, float, None]]], str]: 2D list where each inner list is a row of cell values, or error message.

​
set_range_values

def set_range_values(
    self,
    sheet_name: str,
    cell_range: str,
    values: List[List[Union[str, int, float, None]]]
):
Set values for a specific range of cells. Use this to update multiple cells at once with a 2D array of data. Parameters:
  • sheet_name (str): Name of the sheet to modify.
  • cell_range (str): Range in Excel format to update.
  • values (List[List[Union[str, int, float, None]]]): 2D array of values. Each inner list represents a row.
Returns: str: Success confirmation message or error details.

​
export_sheet_to_csv

def export_sheet_to_csv(self, sheet_name: str, csv_filename: str):
Export a specific sheet to CSV format. Use this to convert Excel sheets to CSV files for compatibility or data exchange. Parameters:
  • sheet_name (str): Name of the sheet to export.
  • csv_filename (str): Filename for the CSV file. Must end with .csv extension. The file will be saved in self.working_directory.
Returns: str: Success confirmation message or error details.

​
get_rows

def get_rows(
    self,
    sheet_name: str,
    start_row: Optional[int] = None,
    end_row: Optional[int] = None
):
Retrieve rows of data from a sheet. Use this to read data from a sheet. You can get all rows or specify a range. Returns actual data as lists, making it easy to process programmatically. Parameters:
  • sheet_name (str): Name of the sheet to read from.
  • start_row (Optional[int]): First row to read (1-based). If None, starts from row 1. (default: :obj:None)
  • end_row (Optional[int]): Last row to read (1-based). If None, reads to the end. (default: :obj:None)
Returns: Union[List[List[Union[str, int, float, None]]], str]: List of rows (each row is a list of cell values) or error message.

​
append_row

def append_row(
    self,
    sheet_name: str,
    row_data: List[Union[str, int, float, None]]
):
Add a single row to the end of a sheet. Use this to add one row of data to the end of existing content. For multiple rows, use multiple calls to this function. Parameters:
  • sheet_name (str): Name of the target sheet.
  • row_data (List[Union[str, int, float, None]]): Single row of data to add.
Returns: str: Success confirmation message or error details.

​
update_row

def update_row(
    self,
    sheet_name: str,
    row_number: int,
    row_data: List[Union[str, int, float, None]]
):
Update a specific row in the sheet. Use this to replace all data in a specific row with new values. Parameters:
  • sheet_name (str): Name of the sheet to modify.
  • row_number (int): The row number to update (1-based, where 1 is first row).
  • row_data (List[Union[str, int, float, None]]): New data for the entire row.
Returns: str: Success confirmation message or error details.

​
get_tools

def get_tools(self):
Returns: List[FunctionTool]: A list of FunctionTool objects representing the functions in the toolkit.