[Documentation]: query method of Chroma vector store is not up to date

[LeoWanty]

Documentation Issue Description

The args do not correspond to the docstring.

Asking copilot confirmation : https://github.com/copilot/share/481d13b0-4104-84a7-8110-0041044c099f

Documentation Link

https://github.com/run-llama/llama_index/blob/main/llama-index-integrations/vector_stores/llama-index-vector-stores-chroma/llama_index/vector_stores/chroma/base.py#L369-L401

[dosubot]

You're correct—there is a mismatch between the query method's signature and its docstring in the Chroma vector store integration. The method signature is:

def query(self, query: VectorStoreQuery, **kwargs: Any) -> VectorStoreQueryResult:

But the docstring lists query_embedding and similarity_top_k as separate arguments, which doesn't match the actual signature. The method expects a single query argument (a VectorStoreQuery object) and uses its attributes (query_embedding, similarity_top_k, etc.) internally. The docstring also doesn't mention the use of kwargs for additional parameters, so the documentation is indeed out of date and misleading for users referencing it directly cite.

To reply, just mention @dosu.

---

^{How did I do? Good | Irrelevant | Incorrect | Verbose | Hallucination | Report 🐛 | Other}