openeuler/faqgen

Quick reference

• The offical OPEA docker images

• Maintained by: openEuler CloudNative SIG

• Where to get help: openEuler CloudNative SIG, openEuler

OPEA | openEuler

Current OPEA docker images are built on the openEuler<2060>. This repository is free to use and exempted from per-user rate limits.

OPEA is an open platform project that lets you create open, multi-provider, robust, and composable GenAI solutions that harness the best innovation across the ecosystem.

The OPEA platform includes:

• Detailed framework of composable building blocks for state-of-the-art generative AI systems including LLMs, data stores, and prompt engines

• Architectural blueprints of retrieval-augmented generative AI component stack structure and end-to-end workflows

• A four-step assessment for grading generative AI systems around performance, features, trustworthiness, and enterprise-grade readiness

Read more about OPEA at opea.dev and explore the OPEA technical documentation at https://opea-project.github.io/

Supported tags and respective Dockerfile links

The tag of each FaqGen docker image is consist of the version of FaqGen and the version of basic image. The details are as follows

Usage

The FaqGen service can be effortlessly deployed on Intel Gaudi2, Intel Xeon Scalable Processors and Nvidia GPU.

Two types of FaqGen pipeline are supported now: FaqGen with/without Rerank. And the FaqGen without Rerank pipeline (including Embedding, Retrieval, and LLM) is offered for Xeon customers who can not run rerank service on HPU yet require high performance and accuracy.

Quick Start Deployment Steps:

1. Set up the environment variables.
2. Run Docker Compose.
3. Consume the FaqGen Service.

Quick Start: 1.Setup Environment Variable

To set up environment variables for deploying FaqGen services, follow these steps:

1. Set the required environment variables:

   bash
   # Example: host_ip="192.168.1.1"
   export host_ip="External_Public_IP"
   # Example: no_proxy="localhost, 127.0.0.1, 192.168.1.1"
   export no_proxy="Your_No_Proxy"
   export HUGGINGFACEHUB_API_TOKEN="Your_Huggingface_API_Token"
   

2. If you are in a proxy environment, also set the proxy-related environment variables:

   bash
   export http_proxy="Your_HTTP_Proxy"
   export https_proxy="Your_HTTPs_Proxy"
   

3. Set up other environment variables:

   Get set_env.sh here: set_env.sh

   bash
   # on Xeon
   source set_env.sh
   

Quick Start: 2.Run Docker Compose

Select the compose.yaml file that matches your hardware.

CPU example:

Get compose.yml here: compose.yml

bash
docker compose -f compose.yml up -d

It will automatically download the docker image on docker hub:

bash
docker pull openeuler/faqgen:latest
docker pull openeuler/faqgen-ui:latest

QuickStart: 3.Consume the ChatQnA Service

To chat with retrieved information, you need to upload a file using Dataprep service.

Here is an example of Nike 2023 pdf.

bash
# download pdf file
wget https://raw.githubusercontent.com/opea-project/GenAIComps/v1.1/comps/retrievers/redis/data/nke-10k-2023.pdf
# upload pdf file with dataprep
curl -X POST "http://${host_ip}:6004/v1/dataprep/ingest" \
    -H "Content-Type: multipart/form-data" \
    -F "files=@./nke-10k-2023.pdf"

bash
curl http://${host_ip}:8888/v1/graphrag \
    -H "Content-Type: application/json"  \
    -d '{
        "model": "gpt-4o-mini","messages": [{"role": "user","content": "What is the revenue of Nike in 2023?
    "}]}'