Class: SummaryIndexRetriever

Simple retriever for SummaryIndex that returns all nodes

Implements

• BaseRetriever

Constructors

constructor

• new SummaryIndexRetriever(index): SummaryIndexRetriever

Parameters

Name	Type
index	SummaryIndex

Returns

SummaryIndexRetriever

Defined in

packages/core/src/indices/summary/index.ts:286

Properties

index

• index: SummaryIndex

Defined in

packages/core/src/indices/summary/index.ts:284

Methods

getServiceContext

▸ getServiceContext(): undefined | ServiceContext

Returns

undefined | ServiceContext

Implementation of

BaseRetriever.getServiceContext

Defined in

packages/core/src/indices/summary/index.ts:319

---

retrieve

▸ retrieve(«destructured»): Promise<NodeWithScore<Metadata>[]>

Parameters

Name	Type
«destructured»	RetrieveParams

Returns

Promise<NodeWithScore<Metadata>[]>

Implementation of

BaseRetriever.retrieve

Defined in

packages/core/src/indices/summary/index.ts:290