Class: ListIndex

A ListIndex keeps nodes in a sequential list structure

Hierarchy

• BaseIndex<IndexList>

  ↳ ListIndex

Constructors

constructor

• new ListIndex(init)

Parameters

Name	Type
init	BaseIndexInit<IndexList>

Overrides

BaseIndex.constructor

Defined in

indices/list/ListIndex.ts:43

Properties

docStore

• docStore: BaseDocumentStore

Inherited from

BaseIndex.docStore

Defined in

indices/BaseIndex.ts:117

---

indexStore

• Optional indexStore: BaseIndexStore

Inherited from

BaseIndex.indexStore

Defined in

indices/BaseIndex.ts:119

---

indexStruct

• indexStruct: IndexList

Inherited from

BaseIndex.indexStruct

Defined in

indices/BaseIndex.ts:120

---

serviceContext

• serviceContext: ServiceContext

Inherited from

BaseIndex.serviceContext

Defined in

indices/BaseIndex.ts:115

---

storageContext

• storageContext: StorageContext

Inherited from

BaseIndex.storageContext

Defined in

indices/BaseIndex.ts:116

---

vectorStore

• Optional vectorStore: VectorStore

Inherited from

BaseIndex.vectorStore

Defined in

indices/BaseIndex.ts:118

Methods

_deleteNode

▸ Protected _deleteNode(nodeId): void

Parameters

Name	Type
nodeId	string

Returns

void

Defined in

indices/list/ListIndex.ts:193

---

_insert

▸ Protected _insert(nodes): void

Parameters

Name	Type
nodes	BaseNode[]

Returns

void

Defined in

indices/list/ListIndex.ts:187

---

asQueryEngine

▸ asQueryEngine(options?): BaseQueryEngine

Create a new query engine from the index. It will also create a retriever and response synthezier if they are not provided.

Parameters

Name	Type	Description
options?	Object	you can supply your own custom Retriever and ResponseSynthesizer
options.responseSynthesizer?	ResponseSynthesizer	-
options.retriever?	BaseRetriever	-

Returns

BaseQueryEngine

Overrides

BaseIndex.asQueryEngine

Defined in

indices/list/ListIndex.ts:151

---

asRetriever

▸ asRetriever(options?): BaseRetriever

Create a new retriever from the index.

Parameters

Name	Type
options?	Object
options.mode	ListRetrieverMode

Returns

BaseRetriever

Overrides

BaseIndex.asRetriever

Defined in

indices/list/ListIndex.ts:138

---

getRefDocInfo

▸ getRefDocInfo(): Promise<Record<string, RefDocInfo>>

Returns

Promise<Record<string, RefDocInfo>>

Defined in

indices/list/ListIndex.ts:199

---

_buildIndexFromNodes

▸ Static _buildIndexFromNodes(nodes, docStore, indexStruct?): Promise<IndexList>

Parameters

Name	Type
nodes	BaseNode[]
docStore	BaseDocumentStore
indexStruct?	IndexList

Returns

Promise<IndexList>

Defined in

indices/list/ListIndex.ts:172

---

fromDocuments

▸ Static fromDocuments(documents, args?): Promise<ListIndex>

Parameters

Name	Type
documents	Document[]
args	Object
args.serviceContext?	ServiceContext
args.storageContext?	StorageContext

Returns

Promise<ListIndex>

Defined in

indices/list/ListIndex.ts:112

---

init

▸ Static init(options): Promise<ListIndex>

Parameters

Name	Type
options	ListIndexOptions

Returns

Promise<ListIndex>

Defined in

indices/list/ListIndex.ts:47