Skip to main content

Class: SimpleDocumentStore

Extends

  • KVDocumentStore

Constructors

new SimpleDocumentStore()

new SimpleDocumentStore(kvStore?, namespace?): SimpleDocumentStore

Parameters

kvStore?: SimpleKVStore

namespace?: string

Returns

SimpleDocumentStore

Overrides

KVDocumentStore.constructor

Defined in

packages/llamaindex/src/storage/docStore/SimpleDocumentStore.ts:17

Properties

serializer

serializer: Serializer<any> = jsonSerializer

Inherited from

KVDocumentStore.serializer

Defined in

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

Methods

addDocuments()

addDocuments(docs, allowUpdate): Promise<void>

Parameters

docs: BaseNode<Metadata>[]

allowUpdate: boolean = true

Returns

Promise<void>

Inherited from

KVDocumentStore.addDocuments

Defined in

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


deleteDocument()

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

Parameters

docId: string

raiseError: boolean = true

removeRefDocNode: boolean = true

Returns

Promise<void>

Inherited from

KVDocumentStore.deleteDocument

Defined in

packages/llamaindex/src/storage/docStore/KVDocumentStore.ts:143


deleteRefDoc()

deleteRefDoc(refDocId, raiseError): Promise<void>

Parameters

refDocId: string

raiseError: boolean = true

Returns

Promise<void>

Inherited from

KVDocumentStore.deleteRefDoc

Defined in

packages/llamaindex/src/storage/docStore/KVDocumentStore.ts:160


docs()

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

Returns

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

Inherited from

KVDocumentStore.docs

Defined in

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


documentExists()

documentExists(docId): Promise<boolean>

Parameters

docId: string

Returns

Promise<boolean>

Inherited from

KVDocumentStore.documentExists

Defined in

packages/llamaindex/src/storage/docStore/KVDocumentStore.ts:117


getAllDocumentHashes()

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

Returns

Promise<Record<string, string>>

Inherited from

KVDocumentStore.getAllDocumentHashes

Defined in

packages/llamaindex/src/storage/docStore/KVDocumentStore.ts:191


getAllRefDocInfo()

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

Returns

Promise<undefined | Record<string, RefDocInfo>>

Inherited from

KVDocumentStore.getAllRefDocInfo

Defined in

packages/llamaindex/src/storage/docStore/KVDocumentStore.ts:105


getDocument()

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

Parameters

docId: string

raiseError: boolean = true

Returns

Promise<undefined | BaseNode<Metadata>>

Inherited from

KVDocumentStore.getDocument

Defined in

packages/llamaindex/src/storage/docStore/KVDocumentStore.ts:82


getDocumentHash()

getDocumentHash(docId): Promise<undefined | string>

Parameters

docId: string

Returns

Promise<undefined | string>

Inherited from

KVDocumentStore.getDocumentHash

Defined in

packages/llamaindex/src/storage/docStore/KVDocumentStore.ts:186


getNode()

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

Parameters

nodeId: string

raiseError: boolean = true

Returns

Promise<BaseNode<Metadata>>

Inherited from

KVDocumentStore.getNode

Defined in

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


getNodeDict()

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

Parameters

nodeIdDict

Returns

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

Inherited from

KVDocumentStore.getNodeDict

Defined in

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


getNodes()

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

Parameters

nodeIds: string[]

raiseError: boolean = true

Returns

Promise<BaseNode<Metadata>[]>

Inherited from

KVDocumentStore.getNodes

Defined in

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


getRefDocInfo()

getRefDocInfo(refDocId): Promise<undefined | RefDocInfo>

Parameters

refDocId: string

Returns

Promise<undefined | RefDocInfo>

Inherited from

KVDocumentStore.getRefDocInfo

Defined in

packages/llamaindex/src/storage/docStore/KVDocumentStore.ts:100


persist()

persist(persistPath): Promise<void>

Parameters

persistPath: string = ...

Returns

Promise<void>

Overrides

KVDocumentStore.persist

Defined in

packages/llamaindex/src/storage/docStore/SimpleDocumentStore.ts:43


refDocExists()

refDocExists(refDocId): Promise<boolean>

Parameters

refDocId: string

Returns

Promise<boolean>

Inherited from

KVDocumentStore.refDocExists

Defined in

packages/llamaindex/src/storage/docStore/KVDocumentStore.ts:113


setDocumentHash()

setDocumentHash(docId, docHash): Promise<void>

Parameters

docId: string

docHash: string

Returns

Promise<void>

Inherited from

KVDocumentStore.setDocumentHash

Defined in

packages/llamaindex/src/storage/docStore/KVDocumentStore.ts:181


toDict()

toDict(): SaveDict

Returns

SaveDict

Defined in

packages/llamaindex/src/storage/docStore/SimpleDocumentStore.ts:62


fromDict()

static fromDict(saveDict, namespace?): SimpleDocumentStore

Parameters

saveDict: SaveDict

namespace?: string

Returns

SimpleDocumentStore

Defined in

packages/llamaindex/src/storage/docStore/SimpleDocumentStore.ts:57


fromPersistDir()

static fromPersistDir(persistDir, namespace?): Promise<SimpleDocumentStore>

Parameters

persistDir: string = DEFAULT_PERSIST_DIR

namespace?: string

Returns

Promise<SimpleDocumentStore>

Defined in

packages/llamaindex/src/storage/docStore/SimpleDocumentStore.ts:24


fromPersistPath()

static fromPersistPath(persistPath, namespace?): Promise<SimpleDocumentStore>

Parameters

persistPath: string

namespace?: string

Returns

Promise<SimpleDocumentStore>

Defined in

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