MongoDBAtlasVectorSearch
Defined in: packages/providers/storage/mongodb/src/MongoDBAtlasVectorStore.ts:74
Vector store that uses MongoDB Atlas for storage and vector search. This store uses the $vectorSearch aggregation stage to perform vector similarity search.
Extends
Section titled “Extends”Constructors
Section titled “Constructors”Constructor
Section titled “Constructor”new MongoDBAtlasVectorSearch(
init):MongoDBAtlasVectorSearch
Defined in: packages/providers/storage/mongodb/src/MongoDBAtlasVectorStore.ts:143
Parameters
Section titled “Parameters”Partial<MongoDBAtlasVectorSearch> & object & VectorStoreBaseParams
Returns
Section titled “Returns”MongoDBAtlasVectorSearch
Overrides
Section titled “Overrides”Properties
Section titled “Properties”embedModel
Section titled “embedModel”embedModel:
BaseEmbedding
Defined in: packages/core/src/vector-store/index.ts:128
Inherited from
Section titled “Inherited from”isEmbeddingQuery?
Section titled “isEmbeddingQuery?”
optionalisEmbeddingQuery:boolean
Defined in: packages/core/src/vector-store/index.ts:130
Inherited from
Section titled “Inherited from”BaseVectorStore.isEmbeddingQuery
storesText
Section titled “storesText”storesText:
boolean=true
Defined in: packages/providers/storage/mongodb/src/MongoDBAtlasVectorStore.ts:75
Overrides
Section titled “Overrides”flatMetadata
Section titled “flatMetadata”flatMetadata:
boolean=true
Defined in: packages/providers/storage/mongodb/src/MongoDBAtlasVectorStore.ts:76
dbName
Section titled “dbName”dbName:
string
Defined in: packages/providers/storage/mongodb/src/MongoDBAtlasVectorStore.ts:78
collectionName
Section titled “collectionName”collectionName:
string
Defined in: packages/providers/storage/mongodb/src/MongoDBAtlasVectorStore.ts:79
autoCreateIndex
Section titled “autoCreateIndex”autoCreateIndex:
boolean
Defined in: packages/providers/storage/mongodb/src/MongoDBAtlasVectorStore.ts:80
embeddingDefinition
Section titled “embeddingDefinition”embeddingDefinition:
Record<string,unknown>
Defined in: packages/providers/storage/mongodb/src/MongoDBAtlasVectorStore.ts:81
indexedMetadataFields
Section titled “indexedMetadataFields”indexedMetadataFields:
string[]
Defined in: packages/providers/storage/mongodb/src/MongoDBAtlasVectorStore.ts:82
mongodbClient
Section titled “mongodbClient”mongodbClient:
MongoClient
Defined in: packages/providers/storage/mongodb/src/MongoDBAtlasVectorStore.ts:87
The used MongoClient. If not given, a new MongoClient is created based on the MONGODB_URI env variable.
indexName
Section titled “indexName”indexName:
string
Defined in: packages/providers/storage/mongodb/src/MongoDBAtlasVectorStore.ts:94
Name of the vector index. If invalid, Mongo will silently ignore this issue and return 0 results.
Default: “default”
embeddingKey
Section titled “embeddingKey”embeddingKey:
string
Defined in: packages/providers/storage/mongodb/src/MongoDBAtlasVectorStore.ts:101
Name of the key containing the embedding vector.
Default: “embedding”
idKey:
string
Defined in: packages/providers/storage/mongodb/src/MongoDBAtlasVectorStore.ts:108
Name of the key containing the node id.
Default: “id”
textKey
Section titled “textKey”textKey:
string
Defined in: packages/providers/storage/mongodb/src/MongoDBAtlasVectorStore.ts:115
Name of the key containing the node text.
Default: “text”
metadataKey
Section titled “metadataKey”metadataKey:
string
Defined in: packages/providers/storage/mongodb/src/MongoDBAtlasVectorStore.ts:122
Name of the key containing the node metadata.
Default: “metadata”
insertOptions?
Section titled “insertOptions?”
optionalinsertOptions:BulkWriteOptions
Defined in: packages/providers/storage/mongodb/src/MongoDBAtlasVectorStore.ts:127
Options to pass to the insertMany function when adding nodes.
numCandidates()
Section titled “numCandidates()”numCandidates: (
query) =>number
Defined in: packages/providers/storage/mongodb/src/MongoDBAtlasVectorStore.ts:140
Function to determine the number of candidates to retrieve for a given query. In case your results are not good, you might tune this value.
Default: query.similarityTopK * 10
Parameters
Section titled “Parameters”Returns
Section titled “Returns”number
Methods
Section titled “Methods”ensureCollection()
Section titled “ensureCollection()”ensureCollection():
Promise<Collection<Document>>
Defined in: packages/providers/storage/mongodb/src/MongoDBAtlasVectorStore.ts:188
Returns
Section titled “Returns”Promise<Collection<Document>>
add(
nodes):Promise<string[]>
Defined in: packages/providers/storage/mongodb/src/MongoDBAtlasVectorStore.ts:231
Add nodes to the vector store.
Parameters
Section titled “Parameters”Nodes to add to the vector store
Returns
Section titled “Returns”Promise<string[]>
List of node ids that were added
Overrides
Section titled “Overrides”delete()
Section titled “delete()”delete(
refDocId,deleteOptions?):Promise<void>
Defined in: packages/providers/storage/mongodb/src/MongoDBAtlasVectorStore.ts:272
Delete nodes from the vector store with the given redDocId.
Parameters
Section titled “Parameters”refDocId
Section titled “refDocId”string
The refDocId of the nodes to delete
deleteOptions?
Section titled “deleteOptions?”object
Options to pass to the deleteOne function
Returns
Section titled “Returns”Promise<void>
Overrides
Section titled “Overrides”client()
Section titled “client()”client():
MongoClient
Defined in: packages/providers/storage/mongodb/src/MongoDBAtlasVectorStore.ts:282
Returns
Section titled “Returns”MongoClient
Overrides
Section titled “Overrides”query()
Section titled “query()”query(
query,options?):Promise<VectorStoreQueryResult>
Defined in: packages/providers/storage/mongodb/src/MongoDBAtlasVectorStore.ts:292
Perform a vector similarity search query.
Parameters
Section titled “Parameters”The query to run
options?
Section titled “options?”object
Returns
Section titled “Returns”Promise<VectorStoreQueryResult>
List of nodes and their similarities
Overrides
Section titled “Overrides”exists()
Section titled “exists()”exists(
refDocId):Promise<boolean>
Defined in: packages/providers/storage/mongodb/src/MongoDBAtlasVectorStore.ts:428
Check if any nodes exist for the given document reference ID. Used for de-duplication during ingestion.
Parameters
Section titled “Parameters”refDocId
Section titled “refDocId”string
The reference document ID to check
Returns
Section titled “Returns”Promise<boolean>
true if any nodes with this ref_doc_id exist