Class IterationTracker

Index

Constructors

Methods

addError addLogEntry addLogEntryWithPrompt addTokenUsage addWarning completeRun failRun getCurrentRun getIterationStats getRecentChanges hasRecentChanges incrementBackpropagation incrementIteration CalculateCost

Constructors

constructor

new IterationTracker(): IterationTracker
Returns IterationTracker

Methods

addError

addError(run: AnalysisRun, error: string): void
Add error to run
Parameters
- run: AnalysisRun
- error: string
Returns void
- Defined in packages/DBAutoDoc/src/state/IterationTracker.ts:187

addLogEntry

addLogEntry(
run: AnalysisRun,
entry: Omit<ProcessingLogEntry, "timestamp">,
): void
Add processing log entry
Parameters
- run: AnalysisRun
- entry: Omit<ProcessingLogEntry, "timestamp">
Returns void
- Defined in packages/DBAutoDoc/src/state/IterationTracker.ts:22

addLogEntryWithPrompt

addLogEntryWithPrompt(
    run: AnalysisRun,
    entry: Omit<ProcessingLogEntry, "timestamp">,
    promptInput?: string,
    promptOutput?: string,
): void
Add processing log entry with prompt I/O details
Parameters
- run: AnalysisRun
- entry: Omit<ProcessingLogEntry, "timestamp">
- OptionalpromptInput: string
- OptionalpromptOutput: string
Returns void
- Defined in packages/DBAutoDoc/src/state/IterationTracker.ts:37

addTokenUsage

addTokenUsage(
    run: AnalysisRun,
    tokensUsed: number,
    cost?: number,
    inputTokens?: number,
    outputTokens?: number,
    pricing?: TokenPricingConfig,
): void
Add tokens to run total and calculate cost from pricing config if available
Parameters
- run: AnalysisRun
- tokensUsed: number
- Optionalcost: number
- OptionalinputTokens: number
- OptionaloutputTokens: number
- Optionalpricing: TokenPricingConfig
Returns void
- Defined in packages/DBAutoDoc/src/state/IterationTracker.ts:144

addWarning

addWarning(run: AnalysisRun, warning: string): void
Add warning to run
Parameters
- run: AnalysisRun
- warning: string
Returns void
- Defined in packages/DBAutoDoc/src/state/IterationTracker.ts:180

completeRun

completeRun(
    run: AnalysisRun,
    converged: boolean,
    convergenceReason?: string,
): void
Mark run as complete
Parameters
- run: AnalysisRun
- converged: boolean
- OptionalconvergenceReason: string
Returns void
- Defined in packages/DBAutoDoc/src/state/IterationTracker.ts:56

failRun

failRun(run: AnalysisRun, error: string): void
Mark run as failed
Parameters
- run: AnalysisRun
- error: string
Returns void
- Defined in packages/DBAutoDoc/src/state/IterationTracker.ts:70

getCurrentRun

getCurrentRun(state: DatabaseDocumentation): AnalysisRun
Get the current (latest) analysis run
Parameters
- state: DatabaseDocumentation
Returns AnalysisRun
- Defined in packages/DBAutoDoc/src/state/IterationTracker.ts:12

getIterationStats

getIterationStats(
    run: AnalysisRun,
): {
    changed: number;
    errors: number;
    totalProcessed: number;
    unchanged: number;
}
Get iteration statistics
Parameters
- run: AnalysisRun
Returns { changed: number; errors: number; totalProcessed: number; unchanged: number }
- Defined in packages/DBAutoDoc/src/state/IterationTracker.ts:111

getRecentChanges

getRecentChanges(run: AnalysisRun, count?: number): ProcessingLogEntry[]
Get recent changes from processing log
Parameters
- run: AnalysisRun
- count: number = 10
Returns ProcessingLogEntry[]
- Defined in packages/DBAutoDoc/src/state/IterationTracker.ts:79

hasRecentChanges

hasRecentChanges(state: DatabaseDocumentation, windowSize: number): boolean
Check if any changes occurred in last N iterations
Parameters
- state: DatabaseDocumentation
- windowSize: number
Returns boolean
- Defined in packages/DBAutoDoc/src/state/IterationTracker.ts:93

incrementBackpropagation

incrementBackpropagation(run: AnalysisRun): void
Increment backpropagation count
Parameters
- run: AnalysisRun
Returns void
- Defined in packages/DBAutoDoc/src/state/IterationTracker.ts:173

incrementIteration

incrementIteration(state: DatabaseDocumentation, run: AnalysisRun): void
Increment iteration count
Parameters
- state: DatabaseDocumentation
- run: AnalysisRun
Returns void
- Defined in packages/DBAutoDoc/src/state/IterationTracker.ts:165

`Static`CalculateCost

CalculateCost(
    inputTokens: number,
    outputTokens: number,
    pricing: TokenPricingConfig,
): number
Calculate cost from token counts and pricing config
Parameters
- inputTokens: number
- outputTokens: number
- pricing: TokenPricingConfig
Returns number
- Defined in packages/DBAutoDoc/src/state/IterationTracker.ts:158

Class IterationTracker

Index

Constructors

Methods

Constructors

constructor

Returns IterationTracker

Methods

addError

Parameters

Returns void

addLogEntry

Parameters

Returns void

addLogEntryWithPrompt

Parameters

Returns void

addTokenUsage

Parameters

Returns void

addWarning

Parameters

Returns void

completeRun

Parameters

Returns void

failRun

Parameters

Returns void

getCurrentRun

Parameters

Returns AnalysisRun

getIterationStats

Parameters

Returns { changed: number; errors: number; totalProcessed: number; unchanged: number }

getRecentChanges

Parameters

Returns ProcessingLogEntry[]

hasRecentChanges

Parameters

Returns boolean

incrementBackpropagation

Parameters

Returns void

incrementIteration

Parameters

Returns void

StaticCalculateCost

Parameters

Returns number

Settings

On This Page

`Static`CalculateCost