Class: abstract BaseDocumentStore

Constructors

new BaseDocumentStore()

new BaseDocumentStore(): BaseDocumentStore

Returns

BaseDocumentStore

Methods

addDocuments()

abstract addDocuments(docs, allowUpdate): Promise<void>

Parameters

• docs: BaseNode <Metadata>[]

• allowUpdate: boolean

Returns

Promise<void>

Source

packages/llamaindex/src/storage/docStore/types.ts:23

---

deleteDocument()

abstract deleteDocument(docId, raiseError): Promise<void>

Parameters

• docId: string

• raiseError: boolean

Returns

Promise<void>

Source

packages/llamaindex/src/storage/docStore/types.ts:30

---

deleteRefDoc()

abstract deleteRefDoc(refDocId, raiseError): Promise<void>

Parameters

• refDocId: string

• raiseError: boolean

Returns

Promise<void>

Source

packages/llamaindex/src/storage/docStore/types.ts:46

---

docs()

abstract docs(): Promise<Record<string, BaseNode <Metadata>>>

Returns

Promise<Record<string, BaseNode <Metadata>>>

Source

packages/llamaindex/src/storage/docStore/types.ts:21

---

documentExists()

abstract documentExists(docId): Promise<boolean>

Parameters

• docId: string

Returns

Promise<boolean>

Source

packages/llamaindex/src/storage/docStore/types.ts:32

---

getAllDocumentHashes()

abstract getAllDocumentHashes(): Promise<Record<string, string>>

Returns

Promise<Record<string, string>>

Source

packages/llamaindex/src/storage/docStore/types.ts:39

---

getAllRefDocInfo()

abstract getAllRefDocInfo(): Promise<undefined | Record<string, RefDocInfo>>

Returns

Promise<undefined | Record<string, RefDocInfo>>

Source

packages/llamaindex/src/storage/docStore/types.ts:42

---

getDocument()

abstract getDocument(docId, raiseError): Promise<undefined | BaseNode <Metadata>>

Parameters

• docId: string

• raiseError: boolean

Returns

Promise<undefined | BaseNode <Metadata>>

Source

packages/llamaindex/src/storage/docStore/types.ts:25

---

getDocumentHash()

abstract getDocumentHash(docId): Promise<undefined | string>

Parameters

• docId: string

Returns

Promise<undefined | string>

Source

packages/llamaindex/src/storage/docStore/types.ts:37

---

getNode()

getNode(nodeId, raiseError): Promise <BaseNode <Metadata>>

Parameters

• nodeId: string

• raiseError: boolean= true

Returns

Promise <BaseNode <Metadata>>

Source

packages/llamaindex/src/storage/docStore/types.ts:55

---

getNodeDict()

getNodeDict(nodeIdDict): Promise<Record<number, BaseNode <Metadata>>>

Parameters

• nodeIdDict

Returns

Promise<Record<number, BaseNode <Metadata>>>

Source

packages/llamaindex/src/storage/docStore/types.ts:63

---

getNodes()

getNodes(nodeIds, raiseError): Promise <BaseNode <Metadata>[]>

Parameters

• nodeIds: string[]

• raiseError: boolean= true

Returns

Promise <BaseNode <Metadata>[]>

Source

packages/llamaindex/src/storage/docStore/types.ts:49

---

getRefDocInfo()

abstract getRefDocInfo(refDocId): Promise<undefined | RefDocInfo>

Parameters

• refDocId: string

Returns

Promise<undefined | RefDocInfo>

Source

packages/llamaindex/src/storage/docStore/types.ts:44

---

persist()

persist(persistPath): void

Parameters

• persistPath: string= defaultPersistPath

Returns

void

Source

packages/llamaindex/src/storage/docStore/types.ts:16

---

setDocumentHash()

abstract setDocumentHash(docId, docHash): Promise<void>

Parameters

• docId: string

• docHash: string

Returns

Promise<void>

Source

packages/llamaindex/src/storage/docStore/types.ts:35