Back to Spring Ai Alibaba

Agent Chat UI

spring-ai-alibaba-studio/README.md

1.1.2.21.9 KB
Original Source

Agent Chat UI

Agent Chat UI provides a visualized way for developers to chat with any Spring AI Alibaba developed Agents.

Quick Experience

Go to the examples directory to experience real world usage.

  1. Start backend agent

Go to the src/test/java directory, start the backend agent by running StudioApplication. The unified application supports both Graph (e.g. simple_workflow) and Agent (e.g. single_agent, research_agent) APIs.

  1. Then, start the chat ui
shell
npm install
npm run dev
  1. Chat with agent

Visit http://localhost:3000.

Embedded mode

The ui can work in a embedded mode with any of your Spring Boot applications.

Just add the following dependency to your agent project:

xml
<dependency>
	<groupId>com.alibaba.cloud.ai</groupId>
	<artifactId>spring-ai-alibaba-studio</artifactId>
	<version>1.1.2.1</version>
</dependency>

Run your agent, visit http:localhost:{your-port}/chatui/index.html, and now you can chat with you agent.

Standalone mode

First, clone the repository,

bash
git clone https://github.com/alibaba/spring-ai-alibaba.git

cd spring-ai-alibaba/spring-ai-alibaba-studio/agent-chat-ui

Install dependencies:

bash
pnpm install
# or
# npm install

Run the app:

bash
pnpm dev
# or
# npm run dev

The app will be available at http://localhost:3000.

By default, the UI connects to your backend Agent at http://localhost:8080, you can change the address at .env.development file.

properties
# .env.development
NEXT_PUBLIC_API_URL=http://localhost:8080
# The agent to call in the backend application, backend application should register agent as required, check examples for how to configure.
NEXT_PUBLIC_APP_NAME=research_agent
NEXT_PUBLIC_USER_ID=user-001