Login

MongoDB Atlas

Estimated reading: 2 minutes

The MongoDB Atlas component reads and writes to MongoDB Atlas vector stores using an instance of MongoDBAtlasVectorSearch.

For more information, see the following:

1. Hidden parameters
2. Search results output
3. Vector store instances
4. MongoDB Atlas documentation

MongoDB Atlas parameters

Name	Type	Description
mongodb_atlas_cluster_uri	SecretString	Input parameter. The connection URI for your MongoDB Atlas cluster. Required.
enable_mtls	Boolean	Input parameter. Enable mutual TLS authentication. Default: false.
mongodb_atlas_client_cert	SecretString	Input parameter. Client certificate combined with private key for mTLS authentication. Required if mTLS is enabled.
db_name	String	Input parameter. The name of the database to use. Required.
collection_name	String	Input parameter. The name of the collection to use. Required.
index_name	String	Input parameter. The name of the Atlas Search index, it should be a Vector Search. Required.
insert_mode	String	Input parameter. How to insert new documents into the collection. Options: "append" or "overwrite". Default: "append".
embedding	Embeddings	Input parameter. The embedding model to use.
number_of_results	Integer	Input parameter. Number of results to return in similarity search. Default: 4.
index_field	String	Input parameter. The field to index. Default: "embedding".
filter_field	String	Input parameter. The field to filter the index.
number_dimensions	Integer	Input parameter. Embedding context length. Default: 1536.
similarity	String	Input parameter. The method used to measure similarity between vectors. Options: "cosine", "euclidean", or "dotProduct". Default: "cosine".
quantization	String	Input parameter. Quantization reduces memory costs by converting 32-bit floats to smaller data types. Options: "scalar" or "binary".

CONTENTS