From 8638029a378a39f4f20b4033f63af4bd402bd8f3 Mon Sep 17 00:00:00 2001 From: Wang Guan Date: Wed, 3 Apr 2024 04:19:29 +0900 Subject: [PATCH] docs: mention caveats with CacheBackedEmbeddings.embed_query (#19926) Thank you for contributing to LangChain! - [x] **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" - [x] **PR message**: - **Description:** mention not-caching methods in CacheBackedEmbeddings - **Issue:** n/a I almost created one until I read the code - **Dependencies:** n/a - **Twitter handle:** `tarsylia` - [ ] **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, hwchase17. --- .../data_connection/text_embedding/caching_embeddings.ipynb | 5 ++++- 1 file changed, 4 insertions(+), 1 deletion(-) diff --git a/docs/docs/modules/data_connection/text_embedding/caching_embeddings.ipynb b/docs/docs/modules/data_connection/text_embedding/caching_embeddings.ipynb index 2e5241d00d..079fa3ce1d 100644 --- a/docs/docs/modules/data_connection/text_embedding/caching_embeddings.ipynb +++ b/docs/docs/modules/data_connection/text_embedding/caching_embeddings.ipynb @@ -29,7 +29,10 @@ "- batch_size: (optional, defaults to `None`) The number of documents to embed between store updates.\n", "- namespace: (optional, defaults to `\"\"`) The namespace to use for document cache. This namespace is used to avoid collisions with other caches. For example, set it to the name of the embedding model used.\n", "\n", - "**Attention**: Be sure to set the `namespace` parameter to avoid collisions of the same text embedded using different embeddings models." + "**Attention**:\n", + "\n", + "- Be sure to set the `namespace` parameter to avoid collisions of the same text embedded using different embeddings models.\n", + "- Currently `CacheBackedEmbeddings` does not cache embedding created with `embed_query()` `aembed_query()` methods." ] }, {