Skip to content

MB-66396: Interface for IndexInsightsReader #71

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Open
wants to merge 4 commits into
base: master
Choose a base branch
from
Open

MB-66396: Interface for IndexInsightsReader #71

Changes from all commits
Commits
Show all changes
4 commits
Select commit Hold shift + click to select a range
1d0b371
MB-66396: Interface for "IndexInsightsReader"
abhinavdangeti Aug 18, 2025
aeb3035
Update API signatures
abhinavdangeti Aug 22, 2025
998f434
Add index name to CentroidCardinality response
abhinavdangeti Sep 8, 2025
949c7cc
Fix json for index
abhinavdangeti Sep 8, 2025
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
26 changes: 26 additions & 0 deletions index.go
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -365,3 +365,29 @@ type EligibleDocumentSelector interface {
// This must be called after all eligible documents have been added.
SegmentEligibleDocs(segmentID int) []uint64
}

// -----------------------------------------------------------------------------

type TermFreq struct {
Term string `json:"term"`
Frequency uint64 `json:"frequency"`
}
Comment on lines +370 to +374
Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

not required, the struct required is already defined, this becomes duplicate Count === Frequency

type DictEntry struct {
	Term         string
	Count        uint64
	EditDistance uint8
}

Copy link
Member Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Fair, just created a separate entry for context.


type CentroidCardinality struct {
Index string `json:"index"`
Centroid []float32 `json:"centroid"`
Cardinality uint64 `json:"cardinality"`
}

// IndexInsightsReader is an extended index reader that supports APIs which can advertise
// details about content held within the index.
type IndexInsightsReader interface {
IndexReader

// Obtains a maximum limit number of indexed tokens for the field sorted based on frequencies.
TermFrequencies(field string, limit int, descending bool) (termFreqs []TermFreq, err error)

// Obtains a maximum limit number of centroid vectors from IVF indexes sorted based on
// cluster densities (or cardinalities)
CentroidCardinalities(field string, limit int, descending bool) (cenCards []CentroidCardinality, err error)
}
Loading