Skip to main content

Class: abstract BaseDocumentStore

Constructors​

new BaseDocumentStore()​

new BaseDocumentStore(): BaseDocumentStore

Returns​

BaseDocumentStore

Properties​

serializer​

serializer: Serializer<any> = jsonSerializer

Defined in​

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

Methods​

addDocuments()​

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

Parameters​

• docs: BaseNode<Metadata>[]

• allowUpdate: boolean

Returns​

Promise<void>

Defined in​

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

deleteDocument()​

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

Parameters​

• docId: string

• raiseError: boolean

Returns​

Promise<void>

Defined in​

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

deleteRefDoc()​

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

Parameters​

• refDocId: string

• raiseError: boolean

Returns​

Promise<void>

Defined in​

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

docs()​

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

Returns​

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

Defined in​

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

documentExists()​

abstract documentExists(docId): Promise<boolean>

Parameters​

• docId: string

Returns​

Promise<boolean>

Defined in​

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

getAllDocumentHashes()​

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

Returns​

Promise<Record<string, string>>

Defined in​

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

getAllRefDocInfo()​

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

Returns​

Promise<undefined | Record<string, RefDocInfo>>

Defined in​

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

getDocument()​

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

Parameters​

• docId: string

• raiseError: boolean

Returns​

Promise<undefined | BaseNode<Metadata>>

Defined in​

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

getDocumentHash()​

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

Parameters​

• docId: string

Returns​

Promise<undefined | string>

Defined in​

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

getNode()​

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

Parameters​

• nodeId: string

• raiseError: boolean = true

Returns​

Promise<BaseNode<Metadata>>

Defined in​

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

getNodeDict()​

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

Parameters​

• nodeIdDict

Returns​

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

Defined in​

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

getNodes()​

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

Parameters​

• nodeIds: string[]

• raiseError: boolean = true

Returns​

Promise<BaseNode<Metadata>[]>

Defined in​

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

getRefDocInfo()​

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

Parameters​

• refDocId: string

Returns​

Promise<undefined | RefDocInfo>

Defined in​

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

persist()​

persist(persistPath): void

Parameters​

• persistPath: string = defaultPersistPath

Returns​

void

Defined in​

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

setDocumentHash()​

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

Parameters​

• docId: string

• docHash: string

Returns​

Promise<void>

Defined in​

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