Skip to content

Commit

Permalink
Fix the Retriever README error (#655)
Browse files Browse the repository at this point in the history
* change based on comments for missing places.
Signed-off-by: zhlsunshine <[email protected]>
  • Loading branch information
zhlsunshine authored Sep 11, 2024
1 parent f84d91a commit 1d761fa
Show file tree
Hide file tree
Showing 4 changed files with 20 additions and 8 deletions.
10 changes: 8 additions & 2 deletions comps/retrievers/pathway/langchain/README.md
Original file line number Diff line number Diff line change
Expand Up @@ -23,13 +23,19 @@ docker run -p 6060:80 -e http_proxy=$http_proxy -e https_proxy=$https_proxy --pu
Health check the embedding service with:

```bash
curl 127.0.0.1:6060/embed -X POST -d '{"inputs":"What is Deep Learning?"}' -H 'Content-Type: application/json'
curl 127.0.0.1:6060/embed \
-X POST \
-d '{"inputs":"What is Deep Learning?"}' \
-H 'Content-Type: application/json'
```

If the model supports re-ranking, you can also use:

```bash
curl 127.0.0.1:6060/rerank -X POST -d '{"query":"What is Deep Learning?", "texts": ["Deep Learning is not...", "Deep learning is..."]}' -H 'Content-Type: application/json'
curl 127.0.0.1:6060/rerank \
-X POST \
-d '{"query":"What is Deep Learning?", "texts": ["Deep Learning is not...", "Deep learning is..."]}' \
-H 'Content-Type: application/json'
```

#### Start Retriever Service
Expand Down
6 changes: 4 additions & 2 deletions comps/retrievers/pgvector/langchain/README.md
Original file line number Diff line number Diff line change
Expand Up @@ -26,10 +26,12 @@ docker run -d -p 6060:80 -v $volume:/data -e http_proxy=$http_proxy -e https_pro

### 1.3 Verify the TEI Service

Health check the embedding service with:

```bash
curl 127.0.0.1:6060/rerank \
curl 127.0.0.1:6060/embed \
-X POST \
-d '{"query":"What is Deep Learning?", "texts": ["Deep Learning is not...", "Deep learning is..."]}' \
-d '{"inputs":"What is Deep Learning?"}' \
-H 'Content-Type: application/json'
```

Expand Down
6 changes: 4 additions & 2 deletions comps/retrievers/redis/langchain/README.md
Original file line number Diff line number Diff line change
Expand Up @@ -26,10 +26,12 @@ docker run -d -p 6060:80 -v $volume:/data -e http_proxy=$http_proxy -e https_pro

### 1.3 Verify the TEI Service

Health check the embedding service with:

```bash
curl 127.0.0.1:6060/rerank \
curl 127.0.0.1:6060/embed \
-X POST \
-d '{"query":"What is Deep Learning?", "texts": ["Deep Learning is not...", "Deep learning is..."]}' \
-d '{"inputs":"What is Deep Learning?"}' \
-H 'Content-Type: application/json'
```

Expand Down
6 changes: 4 additions & 2 deletions comps/retrievers/vdms/langchain/README.md
Original file line number Diff line number Diff line change
Expand Up @@ -43,10 +43,12 @@ docker run -d -p 6060:80 -v $volume:/data -e http_proxy=$http_proxy -e https_pro

### 1.3 Verify the TEI Service

Health check the embedding service with:

```bash
curl 127.0.0.1:6060/rerank \
curl 127.0.0.1:6060/embed \
-X POST \
-d '{"query":"What is Deep Learning?", "texts": ["Deep Learning is not...", "Deep learning is..."]}' \
-d '{"inputs":"What is Deep Learning?"}' \
-H 'Content-Type: application/json'
```

Expand Down

0 comments on commit 1d761fa

Please sign in to comment.