Interface IndexAdvisorData

The plugin's section of the state file (state.plugins.IndexAdvisor.Data).

interface IndexAdvisorData {
    AnalyzedAt: string;
    Existing: AutoDocIndex[];
    LLMReview?: IndexLLMReviewSummary;
    Options: IndexAdvisorOptions;
    Proposed: IndexProposal[];
    Redundant: RedundantIndex[];
    SkippedSchemas: { Error: string; SchemaName: string }[];
}

Index

Properties

AnalyzedAt Existing LLMReview? Options Proposed Redundant SkippedSchemas

Properties

AnalyzedAt

AnalyzedAt: string

Existing

Existing: AutoDocIndex[]

`Optional`LLMReview

LLMReview?: IndexLLMReviewSummary

What the LLM review did. Absent when the review was off.

Options

Options: IndexAdvisorOptions

Proposed

Proposed: IndexProposal[]

Redundant

Redundant: RedundantIndex[]

SkippedSchemas

SkippedSchemas: { Error: string; SchemaName: string }[]

Schemas whose existing indexes could not be read (proposals for them are skipped).