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.

​
check_suffix

def check_suffix(valid_suffixs: List[str]):
A decorator to check the file suffix of a given file path. Parameters:
  • valid_suffix (str): The required file suffix.
Returns: Callable: The decorator function.

​
PandasReader

class PandasReader:

​
init

def __init__(self, config: Optional[Dict[str, Any]] = None):
Initializes the PandasReader class. Parameters:
  • config (Optional[Dict[str, Any]], optional): The configuration dictionary that can include LLM API settings for LLM-based processing. If not provided, no LLM will be configured by default. You can customize the LLM configuration by providing a ‘llm’ key in the config dictionary. (default: :obj:None)

​
load

def load(
    self,
    data: Union['DataFrame', str],
    *args: Any,
    **kwargs: Dict[str, Any]
):
Loads a file or DataFrame and returns a DataFrame or SmartDataframe object. If an LLM is configured in the config dictionary, a SmartDataframe will be returned, otherwise a regular pandas DataFrame will be returned. Parameters:
  • data (Union[DataFrame, str]): The data to load. *args (Any): Additional positional arguments. **kwargs (Dict[str, Any]): Additional keyword arguments.
Returns: Union[DataFrame, SmartDataframe]: The DataFrame or SmartDataframe object.

​
read_csv

def read_csv(
    self,
    file_path: str,
    *args: Any,
    **kwargs: Dict[str, Any]
):
Reads a CSV file and returns a DataFrame. Parameters:
  • file_path (str): The path to the CSV file. *args (Any): Additional positional arguments. **kwargs (Dict[str, Any]): Additional keyword arguments.
Returns: DataFrame: The DataFrame object.

​
read_excel

def read_excel(
    self,
    file_path: str,
    *args: Any,
    **kwargs: Dict[str, Any]
):
Reads an Excel file and returns a DataFrame. Parameters:
  • file_path (str): The path to the Excel file. *args (Any): Additional positional arguments. **kwargs (Dict[str, Any]): Additional keyword arguments.
Returns: DataFrame: The DataFrame object.

​
read_json

def read_json(
    self,
    file_path: str,
    *args: Any,
    **kwargs: Dict[str, Any]
):
Reads a JSON file and returns a DataFrame. Parameters:
  • file_path (str): The path to the JSON file. *args (Any): Additional positional arguments. **kwargs (Dict[str, Any]): Additional keyword arguments.
Returns: DataFrame: The DataFrame object.

​
read_parquet

def read_parquet(
    self,
    file_path: str,
    *args: Any,
    **kwargs: Dict[str, Any]
):
Reads a Parquet file and returns a DataFrame. Parameters:
  • file_path (str): The path to the Parquet file. *args (Any): Additional positional arguments. **kwargs (Dict[str, Any]): Additional keyword arguments.
Returns: DataFrame: The DataFrame object.

​
read_sql

def read_sql(self, *args: Any, **kwargs: Dict[str, Any]):
Reads a SQL file and returns a DataFrame. Returns: DataFrame: The DataFrame object.

​
read_table

def read_table(
    self,
    file_path: str,
    *args: Any,
    **kwargs: Dict[str, Any]
):
Reads a table and returns a DataFrame. Parameters:
  • file_path (str): The path to the table. *args (Any): Additional positional arguments. **kwargs (Dict[str, Any]): Additional keyword arguments.
Returns: DataFrame: The DataFrame object.

​
read_clipboard

def read_clipboard(self, *args: Any, **kwargs: Dict[str, Any]):
Reads a clipboard and returns a DataFrame. Returns: DataFrame: The DataFrame object.

​
read_html

def read_html(
    self,
    file_path: str,
    *args: Any,
    **kwargs: Dict[str, Any]
):
Reads an HTML file and returns a DataFrame. Parameters:
  • file_path (str): The path to the HTML file. *args (Any): Additional positional arguments. **kwargs (Dict[str, Any]): Additional keyword arguments.
Returns: DataFrame: The DataFrame object.

​
read_feather

def read_feather(
    self,
    file_path: str,
    *args: Any,
    **kwargs: Dict[str, Any]
):
Reads a Feather file and returns a DataFrame. Parameters:
  • file_path (str): The path to the Feather file. *args (Any): Additional positional arguments. **kwargs (Dict[str, Any]): Additional keyword arguments.
Returns: DataFrame: The DataFrame object.

​
read_stata

def read_stata(
    self,
    file_path: str,
    *args: Any,
    **kwargs: Dict[str, Any]
):
Reads a Stata file and returns a DataFrame. Parameters:
  • file_path (str): The path to the Stata file. *args (Any): Additional positional arguments. **kwargs (Dict[str, Any]): Additional keyword arguments.
Returns: DataFrame: The DataFrame object.

​
read_sas

def read_sas(
    self,
    file_path: str,
    *args: Any,
    **kwargs: Dict[str, Any]
):
Reads a SAS file and returns a DataFrame. Parameters:
  • file_path (str): The path to the SAS file. *args (Any): Additional positional arguments. **kwargs (Dict[str, Any]): Additional keyword arguments.
Returns: DataFrame: The DataFrame object.

​
read_pickle

def read_pickle(
    self,
    file_path: str,
    *args: Any,
    **kwargs: Dict[str, Any]
):
Reads a Pickle file and returns a DataFrame. Parameters:
  • file_path (str): The path to the Pickle file. *args (Any): Additional positional arguments. **kwargs (Dict[str, Any]): Additional keyword arguments.
Returns: DataFrame: The DataFrame object.

​
read_hdf

def read_hdf(
    self,
    file_path: str,
    *args: Any,
    **kwargs: Dict[str, Any]
):
Reads an HDF file and returns a DataFrame. Parameters:
  • file_path (str): The path to the HDF file. *args (Any): Additional positional arguments. **kwargs (Dict[str, Any]): Additional keyword arguments.
Returns: DataFrame: The DataFrame object.

​
read_orc

def read_orc(
    self,
    file_path: str,
    *args: Any,
    **kwargs: Dict[str, Any]
):
Reads an ORC file and returns a DataFrame. Parameters:
  • file_path (str): The path to the ORC file. *args (Any): Additional positional arguments. **kwargs (Dict[str, Any]): Additional keyword arguments.
Returns: DataFrame: The DataFrame object.