Skip to content

Commit 40db744

Browse files
docs: sync Core Integrations API reference (mongodb_atlas) on Docusaurus (#11676)
Co-authored-by: anakin87 <44616784+anakin87@users.noreply.github.com>
1 parent a820fc5 commit 40db744

14 files changed

Lines changed: 694 additions & 610 deletions

File tree

docs-website/reference/integrations-api/mongodb_atlas.md

Lines changed: 23 additions & 11 deletions
Original file line numberDiff line numberDiff line change
@@ -46,7 +46,7 @@ __init__(
4646
filters: dict[str, Any] | None = None,
4747
top_k: int = 10,
4848
filter_policy: str | FilterPolicy = FilterPolicy.REPLACE
49-
)
49+
) -> None
5050
```
5151

5252
Create the MongoDBAtlasDocumentStore component.
@@ -127,8 +127,7 @@ run_async(
127127
) -> dict[str, list[Document]]
128128
```
129129

130-
Asynchronously retrieve documents from the MongoDBAtlasDocumentStore, based on the provided embedding
131-
similarity.
130+
Asynchronously retrieve documents from MongoDBAtlasDocumentStore based on embedding similarity.
132131

133132
**Parameters:**
134133

@@ -180,7 +179,7 @@ __init__(
180179
filters: dict[str, Any] | None = None,
181180
top_k: int = 10,
182181
filter_policy: str | FilterPolicy = FilterPolicy.REPLACE
183-
)
182+
) -> None
184183
```
185184

186185
**Parameters:**
@@ -312,8 +311,7 @@ Asynchronously retrieve documents from the MongoDBAtlasDocumentStore by full-tex
312311

313312
### MongoDBAtlasDocumentStore
314313

315-
A MongoDBAtlasDocumentStore implementation that uses the
316-
[MongoDB Atlas](https://www.mongodb.com/atlas/database) service that is easy to deploy, operate, and scale.
314+
A MongoDBAtlasDocumentStore backed by [MongoDB Atlas](https://www.mongodb.com/atlas/database).
317315

318316
To connect to MongoDB Atlas, you need to provide a connection string in the format:
319317
`"mongodb+srv://{mongo_atlas_username}:{mongo_atlas_password}@{mongo_atlas_host}/?{mongo_atlas_params_string}"`.
@@ -361,7 +359,7 @@ __init__(
361359
full_text_search_index: str,
362360
embedding_field: str = "embedding",
363361
content_field: str = "content"
364-
)
362+
) -> None
365363
```
366364

367365
Creates a new MongoDBAtlasDocumentStore instance.
@@ -392,6 +390,22 @@ Creates a new MongoDBAtlasDocumentStore instance.
392390

393391
- <code>ValueError</code> – If the collection name contains invalid characters.
394392

393+
#### connection
394+
395+
```python
396+
connection: AsyncMongoClient | MongoClient
397+
```
398+
399+
Return the active MongoDB client connection.
400+
401+
#### collection
402+
403+
```python
404+
collection: AsyncCollection | Collection
405+
```
406+
407+
Return the active MongoDB collection.
408+
395409
#### to_dict
396410

397411
```python
@@ -504,8 +518,7 @@ count_unique_metadata_by_filter_async(
504518
) -> dict[str, int]
505519
```
506520

507-
Asynchronously applies a filter selecting documents and counts the unique values for each meta field of the
508-
matched documents.
521+
Asynchronously applies a filter selecting documents and counts unique metadata values for each meta field.
509522

510523
**Parameters:**
511524

@@ -613,8 +626,7 @@ get_metadata_field_unique_values_async(
613626
) -> tuple[list[str], int]
614627
```
615628

616-
Asynchronously retrieves unique values for a field matching a search_term or all possible values if no search
617-
term is given.
629+
Asynchronously retrieves unique values for a metadata field, optionally filtered by a search term.
618630

619631
**Parameters:**
620632

0 commit comments

Comments
 (0)