update test scripts and readme

Signed-off-by: minmin-intel <minmin.hou@intel.com>

Author: minmin-intel

FinanceAgent/README.md

@@ -27,8 +27,8 @@ Please note:
 ```bash
 mkdir /path/to/your/workspace/
 export WORKDIR=/path/to/your/workspace/
-genaicomps
-genaiexamples
+cd $WORKDIR
+git clone https://github.com/opea-project/GenAIExamples.git
 ```
 
 ### 2.2 Set up env vars
@@ -37,15 +37,18 @@ genaiexamples
 export HF_CACHE_DIR=/path/to/your/model/cache/
 export HF_TOKEN=<you-hf-token>
 export FINNHUB_API_KEY=<your-finnhub-api-key> # go to https://finnhub.io/ to get your free api key
-export FINANCIAL_DATASETS_API_KEY=<your-api-key> # go to 
+export FINANCIAL_DATASETS_API_KEY=<your-api-key> # go to https://docs.financialdatasets.ai/ to get your free api key
 ```
 
-### 2.3 Build docker images
+### 2.3 [Optional] Build docker images
 
-Build docker images for dataprep, agent, agent-ui.
+Only needed when docker pull failed.
 
 ```bash
-cd GenAIExamples/FinanceAgent/docker_image_build
+cd $WORKDIR/GenAIExamples/FinanceAgent/docker_image_build
+# get GenAIComps repo
+git clone https://github.com/opea-project/GenAIComps.git
+# build the images
 docker compose -f build.yaml build --no-cache
 ```
 
@@ -92,7 +95,7 @@ python $WORKPATH/tests/test_redis_finance.py --port 6007 --test_option get
 ```
 
 ### 3.3 Launch the multi-agent system
-
+The command below will launch 3 agent microservices, 1 docsum microservice, 1 UI microservice.
 ```bash
 # inside $WORKDIR/GenAIExamples/FinanceAgent/docker_compose/intel/hpu/gaudi/
 bash launch_agents.sh
@@ -116,14 +119,14 @@ prompt="generate NVDA financial research report"
 python3 $WORKDIR/GenAIExamples/FinanceAgent/tests/test.py --prompt "$prompt" --agent_role "worker" --ext_port $agent_port --tool_choice "get_current_date" --tool_choice "get_share_performance"
 ```
 
-Supervisor ReAct Agent:
+Supervisor Agent single turns:
 
 ```bash
 export agent_port="9090"
 python3 $WORKDIR/GenAIExamples/FinanceAgent/tests/test.py --agent_role "supervisor" --ext_port $agent_port --stream
 ```
 
-Supervisor ReAct Agent Multi turn:
+Supervisor Agent multi turn:
 
 ```bash
 python3 $WORKDIR/GenAIExamples/FinanceAgent/tests/test.py --agent_role "supervisor" --ext_port $agent_port --multi-turn --stream
@@ -135,12 +138,34 @@ python3 $WORKDIR/GenAIExamples/FinanceAgent/tests/test.py --agent_role "supervis
 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}:5175` to access the UI. Note the `ip_address` here is the host IP of the UI microservice.
 
-1. `create Admin Account` with a random value
+1. Create Admin Account with a random value
+
+2. Enter the endpoints in the `Connections` settings
+
+    First, click on the user icon in the upper right corner to open `Settings`. Click on `Admin Settings`. Click on `Connections`. 
+
+    Then, enter the supervisor agent endpoint in the `OpenAI API` section: `http://${ip_address}:9090/v1`. Enter the API key as "empty". Add an arbitrary model id in `Model IDs`, for example, "opea_agent". The `ip_address` here should be the host ip of the agent microservice.
+
+    Then, enter the dataprep endpoint in the `Icloud File API` section. You first need to enable `Icloud File API` by clicking on the button on the right to turn it into green and then enter the endpoint url, for example, `http://${ip_address}:6007/v1`. The `ip_address` here should be the host ip of the dataprep microservice.
+
+    You should see screen like the screenshot below when the settings are done.
 
-2. use an opea agent endpoint, for example, the `Research Agent` endpoint `http://$ip_address:9096/v1`, which is a openai compatible api
+![opea-agent-setting](assets/ui_connections_settings.png)
 
-![opea-agent-setting](assets/opea-agent-setting.png)
+3. Upload documents with UI
 
-3. test opea agent with ui
+    Click on the `Workplace` icon in the top left corner. Click `Knowledge`. Click on the "+" sign to the right of `Icloud Knowledge`. You can paste in an url the the left hand side of the pop-up window, or upload a local file by click on the cloud icon on the right hand side of the pop-up window. Then click on the `Upload Confirm` button. Wait till the processing is done and the pop-up window will be closed on its own when the data ingestion is done. See the screenshot below.
+
+    Note: the data ingestion may take a few minutes depending on the length of the document. Please wait patiently and do not close the pop-up window.
+
+![upload-doc-ui](assets/upload_doc_ui.png)
+
+4. Test agent with UI
+
+    After the settings are done and documents are ingested, you can start to ask questions to the agent. Click on the `New Chat` icon in the top left corner, and type in your questions in the text box in the middle of the UI. 
+
+    The UI will stream the agent's response tokens. You need to expand the `Thinking` tab to see the agent's reasoning process. After the agent made tool calls, you would also see the tool output after the tool returns output to the agent. Note: it may take a while to get the tool output back if the tool execution takes time.
 
 ![opea-agent-test](assets/opea-agent-test.png)
+
+

FinanceAgent/assets/ui_connections_settings.png

@@ -20,9 +20,4 @@ services:
         https_proxy: ${https_proxy}
         no_proxy: ${no_proxy}
     image: ${REGISTRY:-opea}/agent:${TAG:-latest}
-  # agent-ui:
-  #   build:
-  #     context: ../ui
-  #     dockerfile: ./docker/Dockerfile
-  #   extends: agent
-  #   image: ${REGISTRY:-opea}/agent-ui:${TAG:-latest}
+

FinanceAgent/assets/upload_doc_ui.png

@@ -76,8 +76,8 @@ def test_chat_completion_multi_turn(args):
 def test_supervisor_agent_single_turn(args):
     url = f"http://{args.ip_addr}:{args.ext_port}/v1/chat/completions"
     query_list = [
-        # "What was Gap's revenue growth in 2024?",
-        # "Can you summarize Costco's 2025 Q2 earnings call?",
+        "What was Gap's revenue growth in 2024?",
+        "Can you summarize Costco's 2025 Q2 earnings call?",
         "Should I increase investment in Johnson & Johnson?",
     ]
     for query in query_list:

FinanceAgent/docker_image_build/build.yaml

@@ -165,56 +165,56 @@ function start_agents() {
 
 function validate_agent_service() {
     # # test worker finqa agent
-    # echo "======================Testing worker finqa agent======================"
-    # export agent_port="9095"
-    # prompt="What is Gap's revenue in 2024?"
-    # local CONTENT=$(python3 $WORKDIR/GenAIExamples/FinanceAgent/tests/test.py --prompt "$prompt" --agent_role "worker" --ext_port $agent_port)
-    # echo $CONTENT
-    # local EXIT_CODE=$(validate "$CONTENT" "15" "finqa-agent-endpoint")
-    # echo $EXIT_CODE
-    # local EXIT_CODE="${EXIT_CODE:0-1}"
-    # if [ "$EXIT_CODE" == "1" ]; then
-    #     docker logs finqa-agent-endpoint
-    #     exit 1
-    # fi
+    echo "======================Testing worker finqa agent======================"
+    export agent_port="9095"
+    prompt="What is Gap's revenue in 2024?"
+    local CONTENT=$(python3 $WORKDIR/GenAIExamples/FinanceAgent/tests/test.py --prompt "$prompt" --agent_role "worker" --ext_port $agent_port)
+    echo $CONTENT
+    local EXIT_CODE=$(validate "$CONTENT" "15" "finqa-agent-endpoint")
+    echo $EXIT_CODE
+    local EXIT_CODE="${EXIT_CODE:0-1}"
+    if [ "$EXIT_CODE" == "1" ]; then
+        docker logs finqa-agent-endpoint
+        exit 1
+    fi
 
     # # test worker research agent
-    # echo "======================Testing worker research agent======================"
-    # export agent_port="9096"
-    # prompt="Johnson & Johnson"
-    # local CONTENT=$(python3 $WORKDIR/GenAIExamples/AgentQnA/tests/test.py --prompt "$prompt" --agent_role "worker" --ext_port $agent_port --tool_choice "get_current_date" --tool_choice "get_share_performance")
-    # local EXIT_CODE=$(validate "$CONTENT" "Johnson" "research-agent-endpoint")
-    # echo $CONTENT
-    # echo $EXIT_CODE
-    # local EXIT_CODE="${EXIT_CODE:0-1}"
-    # if [ "$EXIT_CODE" == "1" ]; then
-	# docker logs research-agent-endpoint
-	# exit 1
-    # fi
+    echo "======================Testing worker research agent======================"
+    export agent_port="9096"
+    prompt="Johnson & Johnson"
+    local CONTENT=$(python3 $WORKDIR/GenAIExamples/AgentQnA/tests/test.py --prompt "$prompt" --agent_role "worker" --ext_port $agent_port --tool_choice "get_current_date" --tool_choice "get_share_performance")
+    local EXIT_CODE=$(validate "$CONTENT" "Johnson" "research-agent-endpoint")
+    echo $CONTENT
+    echo $EXIT_CODE
+    local EXIT_CODE="${EXIT_CODE:0-1}"
+    if [ "$EXIT_CODE" == "1" ]; then
+	docker logs research-agent-endpoint
+	exit 1
+    fi
 
     # test supervisor react agent
     echo "======================Testing supervisor agent: single turns ======================"
     export agent_port="9090"
     local CONTENT=$(python3 $WORKDIR/GenAIExamples/FinanceAgent/tests/test.py --agent_role "supervisor" --ext_port $agent_port --stream)
     echo $CONTENT
-    local EXIT_CODE=$(validate "$CONTENT" "test completed with success" "react-agent-endpoint")
+    local EXIT_CODE=$(validate "$CONTENT" "test completed with success" "supervisor-agent-endpoint")
     echo $EXIT_CODE
     local EXIT_CODE="${EXIT_CODE:0-1}"
     if [ "$EXIT_CODE" == "1" ]; then
-        docker logs react-agent-endpoint
+        docker logs supervisor-agent-endpoint
         exit 1
     fi
 
     # echo "======================Testing supervisor agent: multi turns ======================"
-    # local CONTENT=$(python3 $WORKDIR/GenAIExamples/FinanceAgent/tests/test.py --agent_role "supervisor" --ext_port $agent_port --multi-turn --stream)
-    # echo $CONTENT
-    # local EXIT_CODE=$(validate "$CONTENT" "test completed with success" "react-agent-endpoint")
-    # echo $EXIT_CODE
-    # local EXIT_CODE="${EXIT_CODE:0-1}"
-    # if [ "$EXIT_CODE" == "1" ]; then
-    #     docker logs react-agent-endpoint
-    #     exit 1
-    # fi
+    local CONTENT=$(python3 $WORKDIR/GenAIExamples/FinanceAgent/tests/test.py --agent_role "supervisor" --ext_port $agent_port --multi-turn --stream)
+    echo $CONTENT
+    local EXIT_CODE=$(validate "$CONTENT" "test completed with success" "supervisor-agent-endpoint")
+    echo $EXIT_CODE
+    local EXIT_CODE="${EXIT_CODE:0-1}"
+    if [ "$EXIT_CODE" == "1" ]; then
+        docker logs supervisor-agent-endpoint
+        exit 1
+    fi
 
 }
 
@@ -231,40 +231,40 @@ function stop_agent_docker() {
 
 echo "workpath: $WORKPATH"
 echo "=================== Stop containers ===================="
-# stop_llm
+stop_llm
 stop_agent_docker
-# stop_dataprep
+stop_dataprep
 
 cd $WORKPATH/tests
 
-# echo "=================== #1 Building docker images===================="
-# build_vllm_docker_image
-# build_dataprep_agent_images
+echo "=================== #1 Building docker images===================="
+build_vllm_docker_image
+build_dataprep_agent_images
 
 #### for local test
 # build_agent_image_local
 # echo "=================== #1 Building docker images completed===================="
 
-# echo "=================== #2 Start vllm endpoint===================="
-# start_vllm_service_70B
-# echo "=================== #2 vllm endpoint started===================="
+echo "=================== #2 Start vllm endpoint===================="
+start_vllm_service_70B
+echo "=================== #2 vllm endpoint started===================="
 
-# echo "=================== #3 Start dataprep and ingest data ===================="
-# start_dataprep
-# ingest_validate_dataprep
-# echo "=================== #3 Data ingestion and validation completed===================="
+echo "=================== #3 Start dataprep and ingest data ===================="
+start_dataprep
+ingest_validate_dataprep
+echo "=================== #3 Data ingestion and validation completed===================="
 
-# echo "=================== #4 Start agents ===================="
+echo "=================== #4 Start agents ===================="
 start_agents
 validate_agent_service
-# echo "=================== #4 Agent test passed ===================="
+echo "=================== #4 Agent test passed ===================="
 
-# echo "=================== #5 Stop microservices ===================="
-# stop_agent_docker
-# stop_dataprep
-# stop_llm
-# echo "=================== #5 Microservices stopped===================="
+echo "=================== #5 Stop microservices ===================="
+stop_agent_docker
+stop_dataprep
+stop_llm
+echo "=================== #5 Microservices stopped===================="
 
-# echo y | docker system prune
+echo y | docker system prune
 
-# echo "ALL DONE!!"
+echo "ALL DONE!!"