From 21d8d41595f444a866d43eb082f4ccd50f1a26d1 Mon Sep 17 00:00:00 2001 From: A Venkata Sai Krishna Varun Date: Fri, 31 Jan 2025 23:45:28 +0530 Subject: [PATCH] docs: update delete method in vectorstores.mdx (#29497) Thank you for contributing to LangChain! - [ ] **PR title**: "package: description" - Where "package" is whichever of langchain, community, core, etc. is being modified. Use "docs: ..." for purely docs 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: Chester Curme --- docs/docs/concepts/vectorstores.mdx | 6 +++--- 1 file changed, 3 insertions(+), 3 deletions(-) diff --git a/docs/docs/concepts/vectorstores.mdx b/docs/docs/concepts/vectorstores.mdx index 3493d6b0d2b..16cc23ba797 100644 --- a/docs/docs/concepts/vectorstores.mdx +++ b/docs/docs/concepts/vectorstores.mdx @@ -39,7 +39,7 @@ The interface consists of basic methods for writing, deleting and searching for The key methods are: - `add_documents`: Add a list of texts to the vector store. -- `delete_documents`: Delete a list of documents from the vector store. +- `delete`: Delete a list of documents from the vector store. - `similarity_search`: Search for similar documents to a given query. @@ -89,10 +89,10 @@ vector_store.add_documents(documents=documents, ids=["doc1", "doc2"]) ## Delete -To delete documents, use the `delete_documents` method which takes a list of document IDs to delete. +To delete documents, use the `delete` method which takes a list of document IDs to delete. ```python -vector_store.delete_documents(ids=["doc1"]) +vector_store.delete(ids=["doc1"]) ``` ## Search