add ui doc.

Author: lkk12014402

FinanceAgent/README.md

@@ -128,3 +128,18 @@ Supervisor ReAct Agent Multi turn:
 python3 $WORKDIR/GenAIExamples/FinanceAgent/tests/test.py --agent_role "supervisor" --ext_port $agent_port --multi-turn --stream
 
 ```
+
+## How to interact with the agent system with UI
+
+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
+
+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/opea-agent-setting.png)
+
+3. test opea agent with ui
+
+![opea-agent-test](assets/opea-agent-test.png)

FinanceAgent/assets/opea-agent-setting.png

@@ -119,3 +119,15 @@ services:
       MAX_TOTAL_TOKENS: ${MAX_TOTAL_TOKENS}
       DocSum_COMPONENT_NAME: ${DocSum_COMPONENT_NAME:-OpeaDocSumvLLM}
     restart: unless-stopped
+
+  agent-ui:
+    image: opea/agent-ui:latest
+    container_name: agent-ui
+    environment:
+      host_ip: ${host_ip}
+      no_proxy: ${no_proxy}
+      http_proxy: ${http_proxy}
+      https_proxy: ${https_proxy}
+    ports:
+      - "5175:8080"
+    ipc: host