Interface FacetStore

Facet reads used by countFacets (VectorStoreClient.facets).

interface FacetStore {
    facetCounts(read: FacetRead, limit: number): Promise<FacetHit[]>;
    payloadIndexTypes(): Promise<Record<string, string>>;
    rangeBound(read: FacetRead, end: RangeEnd): Promise<RangeBound>;
    systemIndexState(field: string): SystemIndexState | undefined;
}

Index

Methods

facetCounts payloadIndexTypes rangeBound systemIndexState

Methods

facetCounts

facetCounts(read: FacetRead, limit: number): Promise<FacetHit[]>
Approximate value counts of a field, highest first (D194).
Parameters
- read: FacetRead
  Field, filter and timeout.
- limit: number
  Most values returned.
Returns Promise<FacetHit[]>
The counted values.
- Defined in packages/service/src/vectorStore/facets.ts:46

payloadIndexTypes

payloadIndexTypes(): Promise<Record<string, string>>
Returns Promise<Record<string, string>>
Payload index type by field (keyword, integer, ...).
- Defined in packages/service/src/vectorStore/facets.ts:58

rangeBound

rangeBound(read: FacetRead, end: RangeEnd): Promise<RangeBound>
One end of a field's range over the filter.
Parameters
- read: FacetRead
  Field, filter and timeout.
- end: RangeEnd
  min or max.
Returns Promise<RangeBound>
The bound, or null when no point holds the field.
- Defined in packages/service/src/vectorStore/facets.ts:55

systemIndexState

systemIndexState(field: string): SystemIndexState | undefined
Parameters
- field: string
  A system index field (chunk_index, matched_rules).
Returns SystemIndexState | undefined
Its state, or undefined before startup.
- Defined in packages/service/src/vectorStore/facets.ts:64