Class InMemoryDocstore

Class for storing and retrieving documents in memory asynchronously. Extends the Docstore class.

Hierarchy

Docstore
- InMemoryDocstore

Implements

BaseStoreInterface<string, Document>

Index

Constructors

Methods

add mdelete mget mset search yieldKeys

Constructors

constructor

new InMemoryDocstore(docs?): InMemoryDocstore
Parameters
- Optional docs: Map<string, Document<Record<string, any>>>
Returns InMemoryDocstore
Overrides Docstore.constructor
- Defined in docs/api_refs/langchain/src/stores/doc/in_memory.ts:16

Methods

add

add(texts): Promise<void>
Adds new documents to the store.
Parameters
- texts: Record<string, Document<Record<string, any>>>
  
  An object where the keys are document IDs and the values are the documents themselves.
Returns Promise<void>
Void
Overrides Docstore.add
- Defined in docs/api_refs/langchain/src/stores/doc/in_memory.ts:40

mdelete

mdelete(_keys): Promise<void>
Method to delete multiple keys.
Parameters
- _keys: string[]
  
  An array of keys to delete.
Returns Promise<void>
- A Promise that resolves when the operation is complete.
Implementation of BaseStoreInterface.mdelete
- Defined in docs/api_refs/langchain/src/stores/doc/in_memory.ts:63

mget

mget(keys): Promise<Document<Record<string, any>>[]>
Method to get multiple values for a set of keys.
Parameters
- keys: string[]
  
  An array of keys.
Returns Promise<Document<Record<string, any>>[]>
- A Promise that resolves with array of values or undefined if key not found.
Implementation of BaseStoreInterface.mget
- Defined in docs/api_refs/langchain/src/stores/doc/in_memory.ts:53

mset

mset(keyValuePairs): Promise<void>
Method to set a value for multiple keys.
Parameters
- keyValuePairs: [string, Document<Record<string, any>>][]
  
  An array of key-value pairs.
Returns Promise<void>
- A Promise that resolves when the operation is complete.
Implementation of BaseStoreInterface.mset
- Defined in docs/api_refs/langchain/src/stores/doc/in_memory.ts:57

search

search(search): Promise<Document<Record<string, any>>>
Searches for a document in the store based on its ID.
Parameters
- search: string
  
  The ID of the document to search for.
Returns Promise<Document<Record<string, any>>>
The document with the given ID.
Overrides Docstore.search
- Defined in docs/api_refs/langchain/src/stores/doc/in_memory.ts:26

yieldKeys

yieldKeys(_prefix?): AsyncGenerator<string, any, unknown>
Method to yield keys optionally based on a prefix.
Parameters
- Optional _prefix: string
  
  Optional prefix to filter keys.
Returns AsyncGenerator<string, any, unknown>
- An asynchronous generator that yields keys on iteration.
Implementation of BaseStoreInterface.yieldKeys
- Defined in docs/api_refs/langchain/src/stores/doc/in_memory.ts:68

Generated using TypeDoc