Class IterationTracker

Constructors

constructor

new IterationTracker(): IterationTracker
Returns IterationTracker

Methods

addError

addError(run: AnalysisRun, error: string): void
Parameters
- run: AnalysisRun
- error: string
Returns void
Deprecated
Use AddError.
- Defined in packages/DBAutoDoc/src/state/IterationTracker.ts:275

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:270

addLogEntry

addLogEntry(
run: AnalysisRun,
entry: Omit<ProcessingLogEntry, "timestamp">,
): void
Parameters
- run: AnalysisRun
- entry: Omit<ProcessingLogEntry, "timestamp">
Returns void
Deprecated
Use AddLogEntry.
- Defined in packages/DBAutoDoc/src/state/IterationTracker.ts:40

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:27

addLogEntryWithPrompt

addLogEntryWithPrompt(
    run: AnalysisRun,
    entry: Omit<ProcessingLogEntry, "timestamp">,
    promptInput?: string,
    promptOutput?: string,
): void
Parameters
- run: AnalysisRun
- entry: Omit<ProcessingLogEntry, "timestamp">
- OptionalpromptInput: string
- OptionalpromptOutput: string
Returns void
Deprecated
Use AddLogEntryWithPrompt.
- Defined in packages/DBAutoDoc/src/state/IterationTracker.ts:67

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:50

addTokenUsage

addTokenUsage(
    run: AnalysisRun,
    tokensUsed: number,
    cost?: number,
    inputTokens?: number,
    outputTokens?: number,
    pricing?: TokenPricingConfig,
): void
Parameters
- run: AnalysisRun
- tokensUsed: number
- Optionalcost: number
- OptionalinputTokens: number
- OptionaloutputTokens: number
- Optionalpricing: TokenPricingConfig
Returns void
Deprecated
Use AddTokenUsage.
- Defined in packages/DBAutoDoc/src/state/IterationTracker.ts:219

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:207

addWarning

addWarning(run: AnalysisRun, warning: string): void
Parameters
- run: AnalysisRun
- warning: string
Returns void
Deprecated
Use AddWarning.
- Defined in packages/DBAutoDoc/src/state/IterationTracker.ts:263

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:258

completeRun

completeRun(
    run: AnalysisRun,
    converged: boolean,
    convergenceReason?: string,
): void
Parameters
- run: AnalysisRun
- converged: boolean
- OptionalconvergenceReason: string
Returns void
Deprecated
Use CompleteRun.
- Defined in packages/DBAutoDoc/src/state/IterationTracker.ts:91

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:79

failRun

failRun(run: AnalysisRun, error: string): void
Parameters
- run: AnalysisRun
- error: string
Returns void
Deprecated
Use FailRun.
- Defined in packages/DBAutoDoc/src/state/IterationTracker.ts:109

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:102

getCurrentRun

getCurrentRun(state: DatabaseDocumentation): AnalysisRun
Parameters
- state: DatabaseDocumentation
Returns AnalysisRun
Deprecated
Use GetCurrentRun.
- Defined in packages/DBAutoDoc/src/state/IterationTracker.ts:20

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;
}
Parameters
- run: AnalysisRun
Returns { changed: number; errors: number; totalProcessed: number; unchanged: number }
Deprecated
Use GetIterationStats.
- Defined in packages/DBAutoDoc/src/state/IterationTracker.ts:195

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:164

getRecentChanges

getRecentChanges(run: AnalysisRun, count?: number): ProcessingLogEntry[]
Parameters
- run: AnalysisRun
- count: number = 10
Returns ProcessingLogEntry[]
Deprecated
Use GetRecentChanges.
- Defined in packages/DBAutoDoc/src/state/IterationTracker.ts:128

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:116

hasRecentChanges

hasRecentChanges(state: DatabaseDocumentation, windowSize: number): boolean
Parameters
- state: DatabaseDocumentation
- windowSize: number
Returns boolean
Deprecated
Use HasRecentChanges.
- Defined in packages/DBAutoDoc/src/state/IterationTracker.ts:154

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:138

incrementBackpropagation

incrementBackpropagation(run: AnalysisRun): void
Parameters
- run: AnalysisRun
Returns void
Deprecated
Use IncrementBackpropagation.
- Defined in packages/DBAutoDoc/src/state/IterationTracker.ts:251

IncrementBackpropagation

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

incrementIteration

incrementIteration(state: DatabaseDocumentation, run: AnalysisRun): void
Parameters
- state: DatabaseDocumentation
- run: AnalysisRun
Returns void
Deprecated
Use IncrementIteration.
- Defined in packages/DBAutoDoc/src/state/IterationTracker.ts:239

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:233

`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:226

Class IterationTracker

Index

Constructors

Methods

Constructors

constructor

Returns IterationTracker

Methods

addError

Parameters

Returns void

Deprecated

AddError

Parameters

Returns void

addLogEntry

Parameters

Returns void

Deprecated

AddLogEntry

Parameters

Returns void

addLogEntryWithPrompt

Parameters

Returns void

Deprecated

AddLogEntryWithPrompt

Parameters

Returns void

addTokenUsage

Parameters

Returns void

Deprecated

AddTokenUsage

Parameters

Returns void

addWarning

Parameters

Returns void

Deprecated

AddWarning

Parameters

Returns void

completeRun

Parameters

Returns void

Deprecated

CompleteRun

Parameters

Returns void

failRun

Parameters

Returns void

Deprecated

FailRun

Parameters

Returns void

getCurrentRun

Parameters

Returns AnalysisRun

Deprecated

GetCurrentRun

Parameters

Returns AnalysisRun

getIterationStats

Parameters

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

Deprecated

GetIterationStats

Parameters

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

getRecentChanges

Parameters

Returns ProcessingLogEntry[]

Deprecated

GetRecentChanges

Parameters

Returns ProcessingLogEntry[]

hasRecentChanges

Parameters

`Static`CalculateCost