Skip to content
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

Update README.md for usage experience #215

Merged
merged 2 commits into from
Oct 18, 2024
Merged

Update README.md for usage experience #215

Changes from 1 commit
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
05e41ea
Update README.md for usage experience
yinghu5 Oct 18, 2024
07c6e57
Update README.md for check before run
yinghu5 Oct 18, 2024
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
10 changes: 8 additions & 2 deletions getting-started/README.md
View file
Open in desktop
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