Skip to content

Update readme #2021

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.

Sign up for GitHub

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

Open
wants to merge 3 commits into
base: main
Choose a base branch
from
Open

Update readme #2021

Changes from all commits
Commits
Show all changes
3 commits
Select commit Hold shift + click to select a range
4a3136d
Update readme
MSCetin37 Jun 3, 2025
b70edf1
Merge branch 'main' into agenQnA_doc_update
ifahim Jun 3, 2025
1ce3d3e
[pre-commit.ci] auto fixes from pre-commit.com hooks
pre-commit-ci[bot] Jun 3, 2025
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
15 changes: 10 additions & 5 deletions AgentQnA/README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -113,7 +113,8 @@ git clone https://github.com/opea-project/GenAIExamples.git
export http_proxy="Your_HTTP_Proxy"
export https_proxy="Your_HTTPs_Proxy"
# Example: no_proxy="localhost, 127.0.0.1, 192.168.1.1"
export no_proxy="Your_No_Proxy"
export host_ip=$(hostname -I | awk '{print $1}')
export no_proxy="Your_No_Proxy", host_ip #include host_ip in no_proxy
```

##### For using open-source llms
Expand All @@ -124,7 +125,7 @@ Then set an environment variable with the token and another for a directory to d

```bash
export HUGGINGFACEHUB_API_TOKEN=<your-HF-token>
export HF_CACHE_DIR=<directory-where-llms-are-downloaded> # to avoid redownloading models
export HF_CACHE_DIR=<directory-where-llms-are-downloaded> # to avoid redownloading models. The directory should have write access
```

##### [Optional] OPENAI_API_KEY to use OpenAI models or Intel® AI for Enterprise Inference
Expand All @@ -143,6 +144,8 @@ export OPENAI_API_KEY=<your-openai-key>

##### Gaudi

if your model is too big to fit on Gaudi, change the model in the `set_env.sh` file below before `source`-ing.

```bash
source $WORKDIR/GenAIExamples/AgentQnA/docker_compose/intel/hpu/gaudi/set_env.sh
```
Expand Down Expand Up @@ -240,11 +243,13 @@ bash run_ingest_data.sh

## How to interact with the agent system with UI

If you are runningthe containers on remote server and want to interact with UI in your local computer, please use tunneling to enable this. One way to do this is: `ssh <user@remote-server-ip> -L 5173:localhost:5173`

The UI microservice is launched in the previous step with the other microservices.
To see the UI, open a web browser to `http://${ip_address}:5173` to access the UI. Note the `ip_address` here is the host IP of the UI microservice.
To see the UI, open a web browser to `http://${ip_address}:5173` to access the UI. Note the `ip_address` here is the host IP (`host_ip` is the ip used while setting up `no_proxy` above) of the UI microservice. If you are using tunneling, `http://localhost:5173`

1. Click on the arrow above `Get started`. Create an admin account with a name, email, and password.
2. Add an OpenAI-compatible API endpoint. In the upper right, click on the circle button with the user's initial, go to `Admin Settings`->`Connections`. Under `Manage OpenAI API Connections`, click on the `+` to add a connection. Fill in these fields:
2. Add an OpenAI-compatible API endpoint. In the upper right, click on the circle button with the user's initial, go to`settings` -> `Admin Settings`->`Connections`. Under `Manage OpenAI API Connections`, click on the `+` to add a connection. Fill in these fields:

- **URL**: `http://${ip_address}:9090/v1`, do not forget the `v1`
- **Key**: any value
Expand All @@ -254,7 +259,7 @@ Click "Save".

![opea-agent-setting](assets/img/opea-agent-setting.png)

3. Test OPEA agent with UI. Return to `New Chat` and ensure the model (i.e. `opea-agent`) is selected near the upper left. Enter in any prompt to interact with the agent.
3. Test OPEA agent with UI. Return to `New Chat` and ensure the model (i.e. `opea-agent`) is selected near the upper left. Enter in any prompt to interact with the agent. The chat response will be displayed. If you get blank response, please check the logs in the containers.

![opea-agent-test](assets/img/opea-agent-test.png)

Expand Down