Skip to content

Commit 422bd33

Browse files
authored
INTPYTHON-474 Add missing links in readme (#67)
1 parent 4b757b5 commit 422bd33

File tree

4 files changed

+21
-777
lines changed

4 files changed

+21
-777
lines changed

README.md

Lines changed: 7 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -24,16 +24,17 @@ It contains the following packages.
2424
- Retrievers
2525
- [MongoDBAtlasHybridSearchRetriever](https://python.langchain.com/docs/integrations/providers/mongodb_atlas/#hybrid-search-retriever)
2626
- [MongoDBAtlasFullTextSearchRetriever](https://python.langchain.com/docs/integrations/providers/mongodb_atlas/#full-text-search-retriever)
27-
- `MongoDBAtlasParentDocumentRetriever` - new feature, docs coming soon!
27+
- [MongoDBAtlasParentDocumentRetriever](https://langchain-mongodb.readthedocs.io/en/latest/langchain_mongodb/retrievers/langchain_mongodb.retrievers.parent_document.MongoDBAtlasParentDocumentRetriever.html#langchain_mongodb.retrievers.parent_document.MongoDBAtlasParentDocumentRetriever)
2828
- Indexing
29-
- `MongoDBRecordManager` - new feature, docs coming soon!
29+
- [MongoDBRecordManager](https://langchain-mongodb.readthedocs.io/en/latest/langchain_mongodb/indexes/langchain_mongodb.indexes.MongoDBRecordManager.html#langchain_mongodb.indexes.MongoDBRecordManager)
3030
- Loading
31-
- `MongoDBLoader` - new feature, docs coming soon!
31+
- [MongoDBLoader](https://langchain-mongodb.readthedocs.io/en/latest/langchain_mongodb/loaders/langchain_mongodb.loaders.MongoDBLoader.html#langchain_mongodb.loaders.MongoDBLoader)
3232

3333
### LangGraph
3434

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

3839
## Installation
3940

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

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

59+
API docs can be found on [ReadTheDocs](https://langchain-mongodb.readthedocs.io/en/latest/index.html).
60+
5861
## Contributing
5962

6063
See the [Contributing Guide](CONTRIBUTING.md).

libs/langchain-mongodb/langchain_mongodb/indexes.py

Lines changed: 7 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -18,10 +18,17 @@ class MongoDBRecordManager(RecordManager):
1818
def __init__(self, collection: Collection) -> None:
1919
"""Initialize the MongoDBRecordManager.
2020
21+
The record manager abstraction is used by the langchain indexing API.
22+
The record manager keeps track of which documents have been written into a vectorstore and when they were written.
23+
For more details, see the `RecordManager API Docs`_.
24+
2125
Args:
2226
connection_string: A valid MongoDB connection URI.
2327
db_name: The name of the database to use.
2428
collection_name: The name of the collection to use.
29+
30+
.. _RecordManager API Docs:
31+
https://python.langchain.com/api_reference/core/indexing/langchain_core.indexing.base.RecordManager.html
2532
"""
2633
namespace = f"{collection.database.name}.{collection.name}"
2734
super().__init__(namespace=namespace)

libs/langchain-mongodb/langchain_mongodb/loaders.py

Lines changed: 3 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -14,7 +14,9 @@
1414

1515

1616
class MongoDBLoader(BaseLoader):
17-
"""Load MongoDB documents."""
17+
"""Document Loaders are classes to load Documents.
18+
19+
Document Loaders are usually used to load a lot of Documents in a single run."""
1820

1921
def __init__(
2022
self,

0 commit comments

Comments
 (0)