mirror of
https://github.com/hwchase17/langchain.git
synced 2025-11-23 08:46:40 +00:00
b2bc15e640
Thank you for contributing to LangChain!
- [ ] **PR title**: "package: description"
- Where "package" is whichever of langchain, community, core,
experimental, etc. is being modified. Use "docs: ..." for purely docs
changes, "templates: ..." for template changes, "infra: ..." for CI
changes.
- Example: "community: add foobar LLM"
- [ ] **PR message**: ***Delete this entire checklist*** and replace
with
- **Description:** a description of the change
- **Issue:** the issue # it fixes, if applicable
- **Dependencies:** any dependencies required for this change
- **Twitter handle:** if your PR gets announced, and you'd like a
mention, we'll gladly shout you out!
- [ ] **Add tests and docs**: If you're adding a new integration, please
include
1. a test for the integration, preferably unit tests that do not rely on
network access,
2. an example notebook showing its use. It lives in
`docs/docs/integrations` directory.
- [ ] **Lint and test**: Run `make format`, `make lint` and `make test`
from the root of the package(s) you've modified. See contribution
guidelines for more: https://python.langchain.com/docs/contributing/
Additional guidelines:
- Make sure optional dependencies are imported within a function.
- Please do not add dependencies to pyproject.toml files (even optional
ones) unless they are required for unit tests.
- Most PRs should not touch more than one package.
- Changes should be backwards compatible.
- If you are adding something to community, do not re-import it in
langchain.
If no one reviews your PR within a few days, please @-mention one of
baskaryan, efriis, eyurtsev, ccurme, vbarda, hwchase17.
40 lines
1.3 KiB
Markdown
40 lines
1.3 KiB
Markdown
# langchain-mongodb
|
|
|
|
# Installation
|
|
```
|
|
pip install -U langchain-mongodb
|
|
```
|
|
|
|
# Usage
|
|
- See [Getting Started with the LangChain Integration](https://www.mongodb.com/docs/atlas/atlas-vector-search/ai-integrations/langchain/#get-started-with-the-langchain-integration) for a walkthrough on using your first LangChain implementation with MongoDB Atlas.
|
|
|
|
## Using MongoDBAtlasVectorSearch
|
|
```python
|
|
from langchain_mongodb import MongoDBAtlasVectorSearch
|
|
|
|
# Pull MongoDB Atlas URI from environment variables
|
|
MONGODB_ATLAS_CLUSTER_URI = os.environ.get("MONGODB_ATLAS_CLUSTER_URI")
|
|
|
|
DB_NAME = "langchain_db"
|
|
COLLECTION_NAME = "test"
|
|
ATLAS_VECTOR_SEARCH_INDEX_NAME = "index_name"
|
|
MONGODB_COLLECTION = client[DB_NAME][COLLECITON_NAME]
|
|
|
|
# Create the vector search via `from_connection_string`
|
|
vector_search = MongoDBAtlasVectorSearch.from_connection_string(
|
|
MONGODB_ATLAS_CLUSTER_URI,
|
|
DB_NAME + "." + COLLECTION_NAME,
|
|
OpenAIEmbeddings(disallowed_special=()),
|
|
index_name=ATLAS_VECTOR_SEARCH_INDEX_NAME,
|
|
)
|
|
|
|
# Initialize MongoDB python client
|
|
client = MongoClient(MONGODB_ATLAS_CLUSTER_URI)
|
|
# Create the vector search via instantiation
|
|
vector_search_2 = MongoDBAtlasVectorSearch(
|
|
collection=MONGODB_COLLECTION,
|
|
embeddings=OpenAIEmbeddings(disallowed_special=()),
|
|
index_name=ATLAS_VECTOR_SEARCH_INDEX_NAME,
|
|
)
|
|
```
|