github/langchain
1
0
Fork 0
mirror of https://github.com/hwchase17/langchain.git synced 2025-09-16 15:04:13 +00:00
Code Issues Packages Projects Releases Wiki Activity

docs: fix kwargs docstring (#25010)

Browse Source 
Fix:
![Screenshot 2024-08-02 at 5 33 37
PM](https://github.com/user-attachments/assets/7c56cdeb-ee81-454c-b3eb-86aa8a9bdc8d)
This commit is contained in:
Bagatur
2024-08-02 19:54:54 -07:00
committed by GitHub
parent 57747892ce
commit e81ddb32a6
61 changed files with 143 additions and 143 deletions
Download Patch File Download Diff File Expand all files Collapse all files

24
libs/partners/chroma/langchain_chroma/vectorstores.py
View File

@@ -250,7 +250,7 @@ class Chroma(VectorStore):
e.g. {"color" : "red", "price": 4.20}.
where_document: dict used to filter by the documents.
E.g. {$contains: {"text": "hello"}}.
**kwargs: Additional keyword arguments to pass to Chroma collection query.
kwargs: Additional keyword arguments to pass to Chroma collection query.
Returns:
List of `n_results` nearest neighbor embeddings for provided
@@ -286,7 +286,7 @@ class Chroma(VectorStore):
metadatas: Optional list of metadatas.
When querying, you can filter on this metadata.
ids: Optional list of IDs.
**kwargs: Additional keyword arguments to pass.
kwargs: Additional keyword arguments to pass.
Returns:
List of IDs of the added images.
@@ -374,7 +374,7 @@ class Chroma(VectorStore):
metadatas: Optional list of metadatas.
When querying, you can filter on this metadata.
ids: Optional list of IDs.
**kwargs: Additional keyword arguments.
kwargs: Additional keyword arguments.
Returns:
List of IDs of the added texts.
@@ -456,7 +456,7 @@ class Chroma(VectorStore):
query: Query text to search for.
k: Number of results to return. Defaults to 4.
filter: Filter by metadata. Defaults to None.
**kwargs: Additional keyword arguments to pass to Chroma collection query.
kwargs: Additional keyword arguments to pass to Chroma collection query.
Returns:
List of documents most similar to the query text.
@@ -482,7 +482,7 @@ class Chroma(VectorStore):
filter: Filter by metadata. Defaults to None.
where_document: dict used to filter by the documents.
E.g. {$contains: {"text": "hello"}}.
**kwargs: Additional keyword arguments to pass to Chroma collection query.
kwargs: Additional keyword arguments to pass to Chroma collection query.
Returns:
List of Documents most similar to the query vector.
@@ -512,7 +512,7 @@ class Chroma(VectorStore):
filter: Filter by metadata. Defaults to None.
where_document: dict used to filter by the documents.
E.g. {$contains: {"text": "hello"}}.
**kwargs: Additional keyword arguments to pass to Chroma collection query.
kwargs: Additional keyword arguments to pass to Chroma collection query.
Returns:
List of documents most similar to the query text and relevance score
@@ -543,7 +543,7 @@ class Chroma(VectorStore):
filter: Filter by metadata. Defaults to None.
where_document: dict used to filter by the documents.
E.g. {$contains: {"text": "hello"}}.
**kwargs: Additional keyword arguments to pass to Chroma collection query.
kwargs: Additional keyword arguments to pass to Chroma collection query.
Returns:
List of documents most similar to the query text and
@@ -722,7 +722,7 @@ class Chroma(VectorStore):
filter: Filter by metadata. Defaults to None.
where_document: dict used to filter by the documents.
E.g. {$contains: {"text": "hello"}}.
**kwargs: Additional keyword arguments to pass to Chroma collection query.
kwargs: Additional keyword arguments to pass to Chroma collection query.
Returns:
List of Documents selected by maximal marginal relevance.
@@ -773,7 +773,7 @@ class Chroma(VectorStore):
filter: Filter by metadata. Defaults to None.
where_document: dict used to filter by the documents.
E.g. {$contains: {"text": "hello"}}.
**kwargs: Additional keyword arguments to pass to Chroma collection query.
kwargs: Additional keyword arguments to pass to Chroma collection query.
Returns:
List of Documents selected by maximal marginal relevance.
@@ -935,7 +935,7 @@ class Chroma(VectorStore):
https://docs.trychroma.com/reference/js-client#class:-chromaclient
collection_metadata: Collection configurations.
Defaults to None.
**kwargs: Additional keyword arguments to initialize a Chroma client.
kwargs: Additional keyword arguments to initialize a Chroma client.
Returns:
Chroma: Chroma vectorstore.
@@ -1000,7 +1000,7 @@ class Chroma(VectorStore):
https://docs.trychroma.com/reference/js-client#class:-chromaclient
collection_metadata: Collection configurations.
Defaults to None.
**kwargs: Additional keyword arguments to initialize a Chroma client.
kwargs: Additional keyword arguments to initialize a Chroma client.
Returns:
Chroma: Chroma vectorstore.
@@ -1025,6 +1025,6 @@ class Chroma(VectorStore):
Args:
ids: List of ids to delete.
**kwargs: Additional keyword arguments.
kwargs: Additional keyword arguments.
"""
self._collection.delete(ids=ids)