Skip to content

Commit

Permalink
Update README.md for usage experience
Browse files Browse the repository at this point in the history
Update README.md for usage experience 
Check docker images before run the test so able to avoid the first error.
  • Loading branch information
yinghu5 authored Oct 18, 2024
1 parent ab8e620 commit 05e41ea
Showing 1 changed file with 8 additions and 2 deletions.
10 changes: 8 additions & 2 deletions getting-started/README.md
Original file line number Diff line number Diff line change
Expand Up @@ -33,7 +33,6 @@ To deploy ChatQnA services, follow these steps:
git clone https://github.com/opea-project/GenAIExamples.git
cd GenAIExamples/ChatQnA
```

### Set the required environment variables:
```
# Example: host_ip="192.168.1.1"
Expand All @@ -42,7 +41,6 @@ export host_ip="External_Public_IP"
export no_proxy="Your_No_Proxy"
export HUGGINGFACEHUB_API_TOKEN="Your_Huggingface_API_Token"
```

If you are in a proxy environment, also set the proxy-related environment variables:
```
export http_proxy="Your_HTTP_Proxy"
Expand Down Expand Up @@ -89,6 +87,14 @@ In the following cases, you will need to build the docker image from source by y
Refer to the {ref}`ChatQnA Example Deployment Options <chatqna-example-deployment>` section for building from source instructions matching your hardware.

## Interact with ChatQnA Megaservice and Microservice
Before interact ChatQnA Service, make sure the TGI/vLLM service is ready (which takes up to 2 minutes to start).
```
docker ps
# expected: all images's status are up
# TGI example
docker logs tgi-service | grep Connected
# execpted output: ... INFO text_generation_router::server: router/src/server.rs:2311: Connected
```
```
curl http://${host_ip}:8888/v1/chatqna \
-H "Content-Type: application/json" \
Expand Down

0 comments on commit 05e41ea

Please sign in to comment.