Skip to content

Update README for external retrievers #247

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
willtai merged 2 commits into from
Jan 16, 2025
+10 −10
Merged

Update README for external retrievers #247

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
0d920d0
Update README for external retrievers
willtai Jan 15, 2025
64403b8
Merge branch 'main' into update-readme-for-external-retrievers
willtai Jan 15, 2025
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
6 changes: 3 additions & 3 deletions examples/customize/retrievers/external/pinecone/README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -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
Expand All @@ -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
```
6 changes: 3 additions & 3 deletions examples/customize/retrievers/external/qdrant/README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -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
Expand All @@ -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
```
8 changes: 4 additions & 4 deletions examples/customize/retrievers/external/weaviate/README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -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
Expand All @@ -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
```
Loading