wehub-resource-sync
c56bef871b
Sync docs with Docusaurus / sync (push) Waiting to run
Tests / Check if changed (push) Waiting to run
Tests / format (push) Blocked by required conditions
Tests / check-imports (push) Blocked by required conditions
Tests / Unit / macos-latest (push) Blocked by required conditions
Tests / Unit / ubuntu-latest (push) Blocked by required conditions
Tests / Unit / windows-latest (push) Blocked by required conditions
Tests / mypy (push) Blocked by required conditions
Tests / Integration / ubuntu-latest (push) Blocked by required conditions
Tests / Integration / macos-latest (push) Blocked by required conditions
Tests / Integration / windows-latest (push) Blocked by required conditions
Tests / notify-slack-on-failure (push) Blocked by required conditions
Tests / Mark tests as completed (push) Blocked by required conditions
Docker image release / Build base image (push) Waiting to run
CodeQL / Analyze (python) (push) Has been cancelled
Update Platform Components Table / update (push) Has been cancelled
61 lines
2.9 KiB
Plaintext
61 lines
2.9 KiB
Plaintext
---
|
||
title: "MongoDBAtlasDocumentStore"
|
||
id: mongodbatlasdocumentstore
|
||
slug: "/mongodbatlasdocumentstore"
|
||
description: ""
|
||
---
|
||
|
||
# MongoDBAtlasDocumentStore
|
||
|
||
<div className="key-value-table">
|
||
|
||
| | |
|
||
| :------------ | :---------------------------------------------------------------------------------------------- |
|
||
| API reference | [MongoDB Atlas](/reference/integrations-mongodb-atlas) |
|
||
| GitHub link | https://github.com/deepset-ai/haystack-core-integrations/tree/main/integrations/mongodb_atlas |
|
||
|
||
</div>
|
||
|
||
`MongoDBAtlasDocumentStore` can be used to manage documents using [MongoDB Atlas](https://www.mongodb.com/atlas), a multi-cloud database service by the same people who build MongoDB. Atlas simplifies deploying and managing your databases while offering the versatility you need to build resilient and performant global applications on the cloud providers of your choice. You can use MongoDB Atlas on cloud providers such as AWS, Azure, or Google Cloud, all without leaving Atlas' web UI.
|
||
|
||
MongoDB Atlas supports embeddings and can therefore be used for embedding retrieval.
|
||
|
||
## Installation
|
||
|
||
To use MongoDB Atlas with Haystack, install the integration first:
|
||
|
||
```shell
|
||
pip install mongodb-atlas-haystack
|
||
```
|
||
|
||
## Initialization
|
||
|
||
To use MongoDB Atlas with Haystack, you will need to create your MongoDB Atlas account: check the [MongoDB Atlas documentation](https://www.mongodb.com/docs/atlas/getting-started/) for help. You also need to [create a vector search index](https://www.mongodb.com/docs/atlas/atlas-vector-search/create-index/#std-label-avs-create-index) and [a full-text search index](https://www.mongodb.com/docs/atlas/atlas-search/manage-indexes/#create-an-atlas-search-index) for the collection you plan to use.
|
||
|
||
Once you have your connection string, you should export it in an environment variable called `MONGO_CONNECTION_STRING`. It should look something like this:
|
||
|
||
```python
|
||
export MONGO_CONNECTION_STRING="mongodb+srv://<username>:<password>@<cluster_name>.gwkckbk.mongodb.net/?retryWrites=true&w=majority"
|
||
```
|
||
|
||
At this point, you’re ready to initialize the store:
|
||
|
||
```python
|
||
from haystack_integrations.document_stores.mongodb_atlas import (
|
||
MongoDBAtlasDocumentStore,
|
||
)
|
||
|
||
## Initialize the document store
|
||
document_store = MongoDBAtlasDocumentStore(
|
||
database_name="haystack_test",
|
||
collection_name="test_collection",
|
||
vector_search_index="embedding_index",
|
||
full_text_search_index="search_index",
|
||
)
|
||
```
|
||
|
||
## Supported Retrievers
|
||
|
||
- [`MongoDBAtlasEmbeddingRetriever`](../pipeline-components/retrievers/mongodbatlasembeddingretriever.mdx): Compares the query and document embeddings and fetches the documents most relevant to the query.
|
||
- [`MongoDBAtlasFullTextRetriever`](../pipeline-components/retrievers/mongodbatlasfulltextretriever.mdx): A full-text search Retriever.
|