Tables metadata prompt

generate_tables_metadata_prompt(metadata)

Generates a descriptive string for table metadata.

Parameters:

Name	Type	Description	Default
metadata	List[TableMetadata]	List[TableMetadata]: A list of TableMetadata objects containing table information.	required

Returns:

Name	Type	Description
str	str	A formatted string describing the tables and their columns.

Source code in api/utils/tables_metadata_prompt.py

def generate_tables_metadata_prompt(metadata: List[TableMetadata]) -> str:
    """
    Generates a descriptive string for table metadata.

    Args:
        metadata: List[TableMetadata]: A list of TableMetadata objects containing table information.

    Returns:
        str: A formatted string describing the tables and their columns.
    """
    table_descriptions = []
    for table in metadata:
        column_descriptions = "\n".join(
            [f"- {col.name}: {col.description}" for col in table.columns]
        )
        table_descriptions.append(
            f"Table: {table.name}\nDescription: {table.description}\nColumns:\n{column_descriptions}"
        )
    return "\n\n".join(table_descriptions)