Skip to content

Commit

Permalink
INTPYTHON-474 Add missing links in readme (#67)
Browse files Browse the repository at this point in the history
  • Loading branch information
blink1073 authored Jan 24, 2025
1 parent 4b757b5 commit 422bd33
Show file tree
Hide file tree
Showing 4 changed files with 21 additions and 777 deletions.
11 changes: 7 additions & 4 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -24,16 +24,17 @@ It contains the following packages.
- Retrievers
- [MongoDBAtlasHybridSearchRetriever](https://python.langchain.com/docs/integrations/providers/mongodb_atlas/#hybrid-search-retriever)
- [MongoDBAtlasFullTextSearchRetriever](https://python.langchain.com/docs/integrations/providers/mongodb_atlas/#full-text-search-retriever)
- `MongoDBAtlasParentDocumentRetriever` - new feature, docs coming soon!
- [MongoDBAtlasParentDocumentRetriever](https://langchain-mongodb.readthedocs.io/en/latest/langchain_mongodb/retrievers/langchain_mongodb.retrievers.parent_document.MongoDBAtlasParentDocumentRetriever.html#langchain_mongodb.retrievers.parent_document.MongoDBAtlasParentDocumentRetriever)
- Indexing
- `MongoDBRecordManager` - new feature, docs coming soon!
- [MongoDBRecordManager](https://langchain-mongodb.readthedocs.io/en/latest/langchain_mongodb/indexes/langchain_mongodb.indexes.MongoDBRecordManager.html#langchain_mongodb.indexes.MongoDBRecordManager)
- Loading
- `MongoDBLoader` - new feature, docs coming soon!
- [MongoDBLoader](https://langchain-mongodb.readthedocs.io/en/latest/langchain_mongodb/loaders/langchain_mongodb.loaders.MongoDBLoader.html#langchain_mongodb.loaders.MongoDBLoader)

### LangGraph

- Checkpointing
- `MongoDBSaver` - new feature, docs coming soon!
- [MongoDBSaver](https://langchain-mongodb.readthedocs.io/en/latest/langgraph_checkpoint_mongodb/checkpoint/langgraph.checkpoint.mongodb.saver.MongoDBSaver.html#langgraph.checkpoint.mongodb.saver.MongoDBSaver)
- [AsyncMongoDBSaver](https://langchain-mongodb.readthedocs.io/en/latest/langgraph_checkpoint_mongodb/checkpoint/langgraph.checkpoint.mongodb.aio.AsyncMongoDBSaver.html)

## Installation

Expand All @@ -55,6 +56,8 @@ See [langchain-mongodb usage](libs/langchain-mongodb/README.md#usage) and [langg

For more detailed usage examples and documentation, please refer to the [LangChain documentation](https://python.langchain.com/docs/integrations/providers/mongodb_atlas/).

API docs can be found on [ReadTheDocs](https://langchain-mongodb.readthedocs.io/en/latest/index.html).

## Contributing

See the [Contributing Guide](CONTRIBUTING.md).
Expand Down
7 changes: 7 additions & 0 deletions libs/langchain-mongodb/langchain_mongodb/indexes.py
Original file line number Diff line number Diff line change
Expand Up @@ -18,10 +18,17 @@ class MongoDBRecordManager(RecordManager):
def __init__(self, collection: Collection) -> None:
"""Initialize the MongoDBRecordManager.
The record manager abstraction is used by the langchain indexing API.
The record manager keeps track of which documents have been written into a vectorstore and when they were written.
For more details, see the `RecordManager API Docs`_.
Args:
connection_string: A valid MongoDB connection URI.
db_name: The name of the database to use.
collection_name: The name of the collection to use.
.. _RecordManager API Docs:
https://python.langchain.com/api_reference/core/indexing/langchain_core.indexing.base.RecordManager.html
"""
namespace = f"{collection.database.name}.{collection.name}"
super().__init__(namespace=namespace)
Expand Down
4 changes: 3 additions & 1 deletion libs/langchain-mongodb/langchain_mongodb/loaders.py
Original file line number Diff line number Diff line change
Expand Up @@ -14,7 +14,9 @@


class MongoDBLoader(BaseLoader):
"""Load MongoDB documents."""
"""Document Loaders are classes to load Documents.
Document Loaders are usually used to load a lot of Documents in a single run."""

def __init__(
self,
Expand Down
Loading

0 comments on commit 422bd33

Please sign in to comment.