From 724a53711b5344de61686e780fb4527d3e36d49a Mon Sep 17 00:00:00 2001 From: SQpgducray <160224690+SQpgducray@users.noreply.github.com> Date: Tue, 17 Sep 2024 00:02:30 +0400 Subject: [PATCH] =?UTF-8?q?docs:=20Fix=20missing=20`self`=20argument=20in?= =?UTF-8?q?=20`=5Fget=5Fdocs=5Fwith=5Fquery`=20method=20of=20`Cust?= =?UTF-8?q?=E2=80=A6=20(#26312)?= MIME-Version: 1.0 Content-Type: text/plain; charset=UTF-8 Content-Transfer-Encoding: 8bit …omSelfQueryRetriever` This commit corrects an issue in the `_get_docs_with_query` method of the `CustomSelfQueryRetriever` class. The method was incorrectly using `self.vectorstore.similarity_search_with_score(query, **search_kwargs)` without including the `self` argument, which is required for proper method invocation. The `self` argument is necessary for calling instance methods and accessing instance attributes. By including `self` in the method call, we ensure that the method is correctly executed in the context of the current instance, allowing it to function as intended. No other changes were made to the method's logic or functionality. 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. Co-authored-by: Erick Friis --- docs/docs/how_to/add_scores_retriever.ipynb | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/docs/docs/how_to/add_scores_retriever.ipynb b/docs/docs/how_to/add_scores_retriever.ipynb index 80baff7d3eb..989b23594e1 100644 --- a/docs/docs/how_to/add_scores_retriever.ipynb +++ b/docs/docs/how_to/add_scores_retriever.ipynb @@ -206,7 +206,7 @@ " ) -> List[Document]:\n", " \"\"\"Get docs, adding score information.\"\"\"\n", " docs, scores = zip(\n", - " *vectorstore.similarity_search_with_score(query, **search_kwargs)\n", + " *self.vectorstore.similarity_search_with_score(query, **search_kwargs)\n", " )\n", " for doc, score in zip(docs, scores):\n", " doc.metadata[\"score\"] = score\n",