Skip to content

Conversation

surfiniaburger
Copy link

Fix conversational UI setup in ChatQnA (Draft)

This PR addresses [https://github.com/opea-project/GenAIExamples/issues/921#issuecomment-2723958947]. It provides a script (use_conversation_ui.sh) to automate switching to the conversational UI, along with a Bash test script (test_conversation_ui_setup.sh).

Important Note: I am currently unable to test these changes due to system limitations (Docker installation issues and low memory). I will be able to test thoroughly in approximately 1-2 months when I have a new system. I am submitting this as a Draft PR to:

  • Show the progress I've made.
  • Get early feedback from maintainers.
  • Allow others to potentially test the changes.
  • Avoid the issue getting lost.

Changes Made:

  • Created use_conversation_ui.sh to automate the setup process, addressing inconsistencies in the README.
  • Created test_conversation_ui_setup.sh (Bash) to verify the changes made by the script.
  • Updated the compose.yaml as described in the issue and script.
  • Updated the README.md

Testing Status:

  • Untested by me due to system limitations.
  • Requires yq to be installed to run the test script, sudo apt install yq.

Next Steps (for me):

  • Once I have a new system (in 1-2 months), I will:
    • Thoroughly test the changes.
    • Address any feedback from maintainers.
    • Convert this to a regular (non-draft) PR.

Request to Maintainers:

  • Please review the code for any obvious errors or improvements.
  • If possible, consider testing the changes on your end.
  • Let me know if you have any questions or suggestions.

Thank you for your understanding!

Copy link

github-actions bot commented Mar 17, 2025

Dependency Review

✅ No vulnerabilities or license issues found.

Scanned Files

None

for more information, see https://pre-commit.ci
Copy link
Contributor

@Copilot Copilot AI left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Copilot reviewed 1 out of 3 changed files in this pull request and generated 1 comment.

Files not reviewed (2)
  • ChatQnA/docker_compose/intel/cpu/xeon/use_conversation_ui.sh: Language not supported
  • ChatQnA/tests/test_conversation_ui_setup.sh: Language not supported

Verified

This commit was created on GitHub.com and signed with GitHub’s verified signature.
@yinghu5 yinghu5 requested a review from chensuyue April 15, 2025 05:01

Verified

This commit was created on GitHub.com and signed with GitHub’s verified signature.
correct the location

Co-authored-by: Copilot <175728472+Copilot@users.noreply.github.com>
fi

# Source environment variables
source ./set_env.sh[[3](https://www.google.com/url?sa=E&q=https%3A%2F%2Fvertexaisearch.cloud.google.com%2Fgrounding-api-redirect%2FAQXblrzJdVR5EXosjXbjSi13_w8_AjDsxY1z8tpwlX2Ht4FdLy1NFE8mDnpUWrLd1KeksZBRzGExdccSmovlOVd5GIk44_Ibde4YqSvt0wI6BvhM3TOJUVyxcWF7BH0XBGtNMn3rQueGW5X0aAetveHZAe6Q6d_fzeFIwluKFo_DQe-i)]
Copy link
Collaborator

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

why here has the [3]

Copy link
Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

I should have cleaned it up, it's not needed.

Copy link
Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

I've removed the redundant links.

surfiniaburger and others added 3 commits April 16, 2025 08:46

Verified

This commit was created on GitHub.com and signed with GitHub’s verified signature.
Removed trailing reference links.

Verified

This commit was created on GitHub.com and signed with GitHub’s verified signature.
for more information, see https://pre-commit.ci
@yinghu5 yinghu5 requested a review from WenjiaoYue April 24, 2025 07:03
@WenjiaoYue
Copy link
Collaborator

WenjiaoYue commented Apr 24, 2025

Hi @surfiniaburger,
Thank you very much for your help and contribution! We’ve updated the corresponding README and compose files based on the issue, and the inconsistency between the README and the actual service startup process has been resolved.
Regarding conversation-ui, we believe a better approach would be for developers to handle environment variables via Nginx forwarding, rather than reconfiguring them through a shell script.
Thanks again for your support! If you have any further questions or ideas, please feel free to reach out to us anytime.

@yinghu5
Copy link
Collaborator

yinghu5 commented Apr 25, 2025

Hi @surfiniaburger, Then I close the PR, but thank you very much for your PRs and continuous contribution.

@yinghu5 yinghu5 closed this Apr 25, 2025
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

None yet

3 participants