From 68cba612ef24003c3f150fa22c7b32247fa33998 Mon Sep 17 00:00:00 2001 From: willtai Date: Thu, 16 Jan 2025 17:03:01 +0800 Subject: [PATCH] Update README for external retrievers (#247) --- examples/customize/retrievers/external/pinecone/README.md | 6 +++--- examples/customize/retrievers/external/qdrant/README.md | 6 +++--- examples/customize/retrievers/external/weaviate/README.md | 8 ++++---- 3 files changed, 10 insertions(+), 10 deletions(-) diff --git a/examples/customize/retrievers/external/pinecone/README.md b/examples/customize/retrievers/external/pinecone/README.md index 84bab8ee6..e6661de23 100644 --- a/examples/customize/retrievers/external/pinecone/README.md +++ b/examples/customize/retrievers/external/pinecone/README.md @@ -7,7 +7,7 @@ You will need both a Pinecone vector database and a Neo4j database to use this r Update `NEO4J_AUTH`, `NEO4J_URL`, and `PC_API_KEY` variables in the `tests/e2e/pinecone_e2e/populate_dbs.py` script then run this from the project root to write test data to both dbs. ``` -poetry run python tests/e2e/pinecone_e2e/populate_dbs.py +poetry run python -m tests/e2e/pinecone_e2e/populate_dbs.py ``` ### Install Pinecone client @@ -23,8 +23,8 @@ Update the `NEO4J_AUTH`, `NEO4J_URL`, and `PC_API_KEY` variables in each file th ``` # Search by vector -poetry run python -m examples.pinecone.vector_search +poetry run python -m examples.customize.retrievers.external.pinecone.vector_search # Search by text, with embeddings generated locally -poetry run python -m examples.pinecone.text_search +poetry run python -m examples.customize.retrievers.external.pinecone.text_search ``` diff --git a/examples/customize/retrievers/external/qdrant/README.md b/examples/customize/retrievers/external/qdrant/README.md index 57d9b14f9..81e62cda9 100644 --- a/examples/customize/retrievers/external/qdrant/README.md +++ b/examples/customize/retrievers/external/qdrant/README.md @@ -11,7 +11,7 @@ docker compose -f tests/e2e/docker-compose.yml up Run this from the project root to write data to both Neo4J and Qdrant. ```bash -poetry run python tests/e2e/qdrant_e2e/populate_dbs.py +poetry run python -m tests/e2e/qdrant_e2e/populate_dbs.py ``` ### Install Qdrant client @@ -24,8 +24,8 @@ pip install qdrant-client ```bash # search by vector -poetry run python -m examples.qdrant.vector_search +poetry run python -m examples.customize.retrievers.external.qdrant.vector_search # search by text, with embeddings generated locally -poetry run python -m examples.qdrant.text_search +poetry run python -m examples.customize.retrievers.external.qdrant.text_search ``` diff --git a/examples/customize/retrievers/external/weaviate/README.md b/examples/customize/retrievers/external/weaviate/README.md index fccbe4c5a..8f8e0796b 100644 --- a/examples/customize/retrievers/external/weaviate/README.md +++ b/examples/customize/retrievers/external/weaviate/README.md @@ -13,7 +13,7 @@ docker compose -f tests/e2e/docker-compose.yml up Run this from the project root to write data to both dbs. ``` -poetry run python tests/e2e/weaviate_e2e/populate_dbs.py +poetry run python -m tests/e2e/weaviate_e2e/populate_dbs.py ``` ### Install Weaviate client @@ -28,11 +28,11 @@ pip install weaviate-client ``` # search by vector -poetry run python -m examples.weaviate.vector_search +poetry run python -m examples.customize.retrievers.external.weaviate.vector_search # search by text, with embeddings generated locally (via embedder argument) -poetry run python -m examples.weaviate.text_search_local_embedder +poetry run python -m examples.customize.retrievers.external.weaviate.text_search_local_embedder # search by text, with embeddings generated on the Weaviate side, via configured vectorizer -poetry run python -m examples.weaviate.text_search_remote_embedder +poetry run python -m examples.customize.retrievers.external.weaviate.text_search_remote_embedder ```