Class BackpropagationEngine

Index

Constructors

Methods

detectParentInsights DetectParentInsights execute Execute

Constructors

constructor

new BackpropagationEngine(
    promptEngine: PromptEngine,
    stateManager: StateManager,
    iterationTracker: IterationTracker,
    maxDepth: number,
    config?: DBAutoDocConfig,
): BackpropagationEngine
Parameters
- promptEngine: PromptEngine
- stateManager: StateManager
- iterationTracker: IterationTracker
- maxDepth: number
- Optionalconfig: DBAutoDocConfig
Returns BackpropagationEngine
- Defined in packages/DBAutoDoc/src/core/BackpropagationEngine.ts:16

Methods

detectParentInsights

detectParentInsights(
    table: TableDefinition,
    analysisResult: any,
    schema?: string,
    tableName?: string,
): BackpropagationTrigger[]
Parameters
- table: TableDefinition
- analysisResult: any
- Optionalschema: string
- OptionaltableName: string
Returns BackpropagationTrigger[]
Deprecated
Use DetectParentInsights.
- Defined in packages/DBAutoDoc/src/core/BackpropagationEngine.ts:190

DetectParentInsights

DetectParentInsights(
    table: TableDefinition,
    analysisResult: any,
    schema?: string,
    tableName?: string,
): BackpropagationTrigger[]
Detect insights about parent tables from analysis result Uses LLM-provided insights instead of NLP pattern matching
Parameters
- table: TableDefinition
- analysisResult: any
- Optionalschema: string
- OptionaltableName: string
Returns BackpropagationTrigger[]
- Defined in packages/DBAutoDoc/src/core/BackpropagationEngine.ts:163

execute

execute(
    state: DatabaseDocumentation,
    run: AnalysisRun,
    triggers: BackpropagationTrigger[],
): Promise<{ tablesUpdated: number; tokensUsed: number }>
Parameters
- state: DatabaseDocumentation
- run: AnalysisRun
- triggers: BackpropagationTrigger[]
Returns Promise<{ tablesUpdated: number; tokensUsed: number }>
Deprecated
Use Execute.
- Defined in packages/DBAutoDoc/src/core/BackpropagationEngine.ts:151

Execute

Execute(
    state: DatabaseDocumentation,
    run: AnalysisRun,
    triggers: BackpropagationTrigger[],
): Promise<{ tablesUpdated: number; tokensUsed: number }>
Execute backpropagation for a set of triggers
Parameters
- state: DatabaseDocumentation
- run: AnalysisRun
- triggers: BackpropagationTrigger[]
Returns Promise<{ tablesUpdated: number; tokensUsed: number }>
- Defined in packages/DBAutoDoc/src/core/BackpropagationEngine.ts:29