Skip to content

build_handover_summary_prompt

Public callable

Build the handover-summary prompt for AI-assisted run handoff drafting.

This fits near the end of the FabricOps flow when teams prepare notebook lineage and operational handover notes.

Parameters:

Name Type Description Default
business_context str

Static business context embedded directly into the prompt text.

''

Returns:

Type Description
str

Prompt template string for use with Fabric DataFrame.ai.generate_response.

Notes

Hardcoded sections define expected JSON keys for handover summaries. Row placeholder injected from DataFrame rows is {summary}. Output is suggestion-oriented and requires human review.

Source code in src/fabricops_kit/ai.py
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
def build_handover_summary_prompt(business_context="", config: FrameworkConfig | None = None) -> str:
    """Build the handover-summary prompt for AI-assisted run handoff drafting.

    This fits near the end of the FabricOps flow when teams prepare notebook
    lineage and operational handover notes.


    Parameters
    ----------
    business_context : str, optional
        Static business context embedded directly into the prompt text.

    Returns
    -------
    str
        Prompt template string for use with Fabric ``DataFrame.ai.generate_response``.

    Notes
    -----
    Hardcoded sections define expected JSON keys for handover summaries.
    Row placeholder injected from DataFrame rows is ``{summary}``.
    Output is suggestion-oriented and requires human review.
    """
    template = _resolve_prompt_template(config, "handover_summary_template", DEFAULT_HANDOVER_SUMMARY_TEMPLATE)
    return template.replace("{business_context}", business_context or "")