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.

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

[DOC] Need ChatQnA document update #1726

Open
2 of 8 tasks
xiguiw opened this issue Mar 27, 2025 · 0 comments
Open
2 of 8 tasks

[DOC] Need ChatQnA document update #1726

xiguiw opened this issue Mar 27, 2025 · 0 comments
Assignees
Labels
A1 high prority bug Something isn't working documentation Improvements or additions to documentation

Comments

@xiguiw
Copy link
Collaborator

xiguiw commented Mar 27, 2025

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

@xiguiw xiguiw added the bug Something isn't working label Mar 27, 2025
@xiguiw xiguiw changed the title [DOC] Need FagGen and ChatQnA document update [DOC] Need ChatQnA document update Mar 27, 2025
@yinghu5 yinghu5 added A1 high prority documentation Improvements or additions to documentation labels Mar 28, 2025
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
A1 high prority bug Something isn't working documentation Improvements or additions to documentation
Projects
None yet
Development

No branches or pull requests

3 participants