docs(chroma): clarify update_documents docstring and argument behavior (#35409)

This PR updates the update_documents docstring to accurately reflect its
batch behavior and clarify the positional mapping between ids and
documents.

No breaking changes. Documentation-only update.
This commit is contained in:
Kanav Bansal
2026-03-01 22:51:29 +05:30
committed by GitHub
parent 6335968237
commit 21b64e56fe

View File

@@ -1221,11 +1221,11 @@ class Chroma(VectorStore):
return self.update_documents([document_id], [document])
def update_documents(self, ids: list[str], documents: list[Document]) -> None:
"""Update a document in the collection.
"""Update multiple documents in the collection.
Args:
ids: List of ids of the document to update.
documents: List of documents to update.
ids: List of document IDs to update.
documents: List of Document objects corresponding to the given IDs.
Raises:
ValueError: If the embedding function is not provided.