[DOC] Need ChatQnA document update FaqGen Information

[xiguiw]

Priority

Undecided

OS type

Ubuntu

Hardware type

Xeon-GNR

Installation method

• Pull docker images from hub.docker.com
• Build docker images from source
• Other

Deploy method

• Docker
• Docker Compose
• Kubernetes Helm Charts
• Kubernetes GMC
• Other

Running nodes

Single Node

What's the version?

Main branch latest

Description

FagGen was merged into ChatQnA in this PR
#1654

The functionality of FagGen and data process flow are different from ChatQnA before merged
GenAIExamples/FaqGen at v1.2 · opea-project/GenAIExamples

After merged, the document of FagGen is missed.

Please confirm:

1. The functionality of FagGen, is changed or not. If not, the document and data process flow should be kept. Should it be independent from ChatQna?

2. If FagGen function is changed and merged into ChatQnA, the modification should be pointed out. e.g., Does FagGen work with data-prep? FaqGen and text-generation are two different restful API path. This should be pointed out.

3. How ChatQnA README describe the merged ChatQna functionality and interface? The shared the same UI. If files are uploaded, does it change faqgen behavior?

Reproduce steps

n/a

Raw log

N/A

Attachments

No response

[joshuayao]

FaqGen related content is missing in #1755.

[xiguiw]

1. The functionality of FagGen, is changed or not. If not, the document and data process flow should be kept. Should it be independent from ChatQna?
2. If FagGen function is changed and merged into ChatQnA, the modification should be pointed out. e.g., Does FagGen work with data-prep? FaqGen and text-generation are two different restful API path. This should be pointed out.
3. How ChatQnA README describe the merged ChatQna functionality and interface? The shared the same UI. If files are uploaded, does it change faqgen behavior?

From the code, the pipeline of FaqGen is changed. It's the same as ChatQnA now.

GenAIExamples/ChatQnA/chatqna.py

Line 340 in 2d8a7e2

def add_remote_service_faqgen(self):

We may describe the subfunction (or user scenarios) of ChatQnA example:
ChatQna and FaqGen