GenAIExamples/SearchQnA/README_miscellaneous.md

SearchQnA Docker Image Build

Table of Contents

1. Build MegaService Docker Image
2. Build UI Docker Image
3. Generate a HuggingFace Access Token
4. Troubleshooting

Build MegaService Docker Image

To build the SearchQnA Megaservice, use the GenAIExamples repository. Use the following command to build the Megaservice Docker image:

git clone https://github.com/opea-project/GenAIExamples.git
cd GenAIExamples/SearchQnA
docker build --no-cache -t opea/searchqna:latest --build-arg https_proxy=$https_proxy --build-arg http_proxy=$http_proxy -f Dockerfile .

Build UI Docker Image

Build frontend Docker image via below command:

cd GenAIExamples/SearchQnA/ui
docker build -t opea/searchqna-ui:latest --build-arg https_proxy=$https_proxy --build-arg http_proxy=$http_proxy -f ./docker/Dockerfile .

Generate a HuggingFace Access Token

Some HuggingFace resources require an access token. Developers can create one by first signing up on HuggingFace and then generating a user access token.

Troubleshooting

1. If errors such as "Access Denied" occur, validate the microservice that is querying the embed API. A simple example:

   http_proxy=""
   curl http://${host_ip}:3001/embed \
       -X POST \
       -d '{"inputs":"What is Deep Learning?"}' \
       -H 'Content-Type: application/json'
   

2. (Docker only) If all microservices work well, check the port ${host_ip}:3008, the port might already be in use by another service, you can modify the compose.yaml.

3. (Docker only) If you get errors like "The container name is in use", change container name in compose.yaml.