Spring AI Alibaba Examples

https://github.com/spring-ai-alibaba/examples
Admin
Spring AI Alibaba Examples is a collection of example modules demonstrating basic to advanced usage...
Tokens:146,057
Snippets:1,684
Trust Score:7.2
License:Apache-2.0
Update:2 months ago
Show doc for...
Tokens:
Raw
### Install Frontend Dependencies and Start Development Server

Source: https://github.com/spring-ai-alibaba/examples/blob/main/spring-ai-alibaba-usecase-example/spring-ai-alibaba-comprehensive-example/README_EN.md

Steps to set up the frontend development environment. Navigate to the frontend directory, install npm packages, and start the dev server.

```bash
cd chatAiDemo-frontend

# Install dependencies
npm install

# Start development server
npm run dev
```

--------------------------------

### Start Frontend Development Server

Source: https://github.com/spring-ai-alibaba/examples/blob/main/spring-ai-alibaba-sandbox-example/sandbox-browser-fullstack/QUICKSTART.md

Navigate to the frontend directory, install dependencies, and start the React development server.

```bash
cd spring-ai-alibaba-sandbox-example/sandbox-browser-fullstack/frontend

# Install dependencies
npm install

# Start development server
npm run dev
```

--------------------------------

### Install uvx for SQLite Example

Source: https://github.com/spring-ai-alibaba/examples/blob/main/spring-ai-alibaba-mcp-example/spring-ai-alibaba-mcp-manual-example/README.md

Install the uvx package using pip, which is a Python package manager. This is a prerequisite for the SQLite MCP examples.

```bash
# 安装 uvx (Python 包管理器)
pip install uvx
```

--------------------------------

### Run Project: Build and Start

Source: https://github.com/spring-ai-alibaba/examples/blob/main/spring-ai-alibaba-agent-example/adk-samples-llm-auditor/README.md

Builds the project using Maven and then starts the Spring Boot application. Assumes Maven is installed and configured.

```bash
mvn clean install

mvn spring-boot:run
```

--------------------------------

### Cloud RAG Quick Start Steps

Source: https://github.com/spring-ai-alibaba/examples/blob/main/spring-ai-alibaba-rag-example/rag-elasticsearch-example/README.md

Provides the command-line steps to run the Cloud RAG example, including starting the application, importing documents, and performing a retrieval and generation query.

```bash
1. 启动应用
2. 导入文档
curl -X GET http://127.0.0.1:8080/ai/cloud/rag/importDocument

3. 检索和生成
curl -G 'http://127.0.0.1:8080/ai/cloud/rag' --data-urlencode 'message=如何快速开始spring ai alibaba'
```

--------------------------------

### Local RAG Quick Start Steps

Source: https://github.com/spring-ai-alibaba/examples/blob/main/spring-ai-alibaba-rag-example/rag-elasticsearch-example/README.md

Provides the command-line steps to run the Local RAG example, including starting the application, importing documents, and performing a retrieval and generation query.

```bash
1. 启动应用
2. 导入文档
curl -X GET http://127.0.0.1:8080/ai/rag/importDocument

3. 检索和生成
curl -G 'http://127.0.0.1:8080/ai/rag' --data-urlencode 'message=如何快速开始spring ai alibaba'
```

--------------------------------

### Install npx

Source: https://github.com/spring-ai-alibaba/examples/blob/main/spring-ai-alibaba-mcp-example/spring-ai-alibaba-mcp-manual-example/ai-mcp-fileserver/README.md

Ensure npx is installed globally. This is a prerequisite for running the example.

```bash
npm install -g npx
```

--------------------------------

### PDF Processing Quick Start Example

Source: https://github.com/spring-ai-alibaba/examples/blob/main/spring-ai-alibaba-agent-example/skills-agent-example/skills/skill-creator/SKILL.md

Demonstrates how to extract text using pdfplumber. This is a basic example for quick integration.

```markdown
# PDF Processing

## Quick start

Extract text with pdfplumber:
[code example]
```

--------------------------------

### Run Example Application

Source: https://github.com/spring-ai-alibaba/examples/blob/main/spring-ai-alibaba-mcp-example/spring-ai-alibaba-mcp-manual-example/ai-mcp-fileserver/README.md

Start the Spring Boot application. The agent will interact with the model using pre-defined questions in the source code.

```bash
./mvnw spring-boot:run
```

--------------------------------

### Run File System Operation Example

Source: https://github.com/spring-ai-alibaba/examples/blob/main/spring-ai-alibaba-mcp-example/spring-ai-alibaba-mcp-manual-example/README.md

Execute the file system operation example using Maven. This will start the Spring Boot application for file system interactions.

```bash
cd ai-mcp-fileserver
mvn spring-boot:run
```

--------------------------------

### Start Frontend Development Server

Source: https://github.com/spring-ai-alibaba/examples/blob/main/spring-ai-alibaba-sandbox-example/sandbox-browser-fullstack/README.md

Navigate to the frontend directory, install dependencies, and start the Vite development server. The frontend will be available at http://localhost:5173.

```bash
cd frontend
npm install
npm run dev
```

--------------------------------

### Resume API Request Example

Source: https://github.com/spring-ai-alibaba/examples/blob/main/spring-ai-alibaba-graph-example/usecase-field-classifier/README.md

Demonstrates how to make a GET request to the resume endpoint.

```bash
GET http://localhost:8080/sec/graph/resume
```

--------------------------------

### Environment Variables Setup

Source: https://github.com/spring-ai-alibaba/examples/blob/main/spring-ai-alibaba-mcp-example/spring-ai-alibaba-mcp-manual-example/README.md

Set up necessary environment variables for cloud services and authentication. Ensure these are exported before running the examples.

```bash
# DashScope API Key (阿里云通义千问)
export AI_DASHSCOPE_API_KEY=your_api_key_here

# GitHub Personal Access Token (GitHub 示例需要)
export GITHUB_PERSONAL_ACCESS_TOKEN=your_github_token_here
```

--------------------------------

### Feedback API Request Example

Source: https://github.com/spring-ai-alibaba/examples/blob/main/spring-ai-alibaba-agent-example/react-agent-example/README.md

Example of how to make a GET request to the feedback endpoint.

```bash
GET http://localhost:8080/feedback
```

--------------------------------

### Run SQLite Predefined Query Example

Source: https://github.com/spring-ai-alibaba/examples/blob/main/spring-ai-alibaba-mcp-example/spring-ai-alibaba-mcp-manual-example/README.md

Execute the SQLite MCP client example with predefined queries using Maven. This starts the application for database operations.

```bash
cd sqlite/ai-mcp-sqlite
mvn spring-boot:run
```

--------------------------------

### Clone Repository

Source: https://github.com/spring-ai-alibaba/examples/blob/main/spring-ai-alibaba-usecase-example/spring-ai-alibaba-translate-example/README-en.md

Clone the project repository to get started.

```sh
git clone https://github.com/springaialibaba/spring-ai-alibaba-examples.git
cd spring-ai-alibaba-translate-example
```

--------------------------------

### Run GitHub Operation Example

Source: https://github.com/spring-ai-alibaba/examples/blob/main/spring-ai-alibaba-mcp-example/spring-ai-alibaba-mcp-manual-example/README.md

Execute the GitHub operation example using Maven. This will start the Spring Boot application for automating GitHub tasks.

```bash
cd ai-mcp-github
mvn spring-boot:run
```

--------------------------------

### Navigate to Starter Example Module

Source: https://github.com/spring-ai-alibaba/examples/blob/main/spring-ai-alibaba-mcp-example/readme.md

Change directory to the spring-ai-alibaba-mcp-starter-example module, recommended for initial learning.

```bash
cd spring-ai-alibaba-mcp-starter-example
```

--------------------------------

### DOCX Processing - Creating Documents Example

Source: https://github.com/spring-ai-alibaba/examples/blob/main/spring-ai-alibaba-agent-example/skills-agent-example/skills/skill-creator/SKILL.md

Provides an example of creating documents using docx-js, with a link to a more detailed guide.

```markdown
# DOCX Processing

## Creating documents

Use docx-js for new documents. See [DOCX-JS.md](DOCX-JS.md).
```

--------------------------------

### Build Specific Example Module

Source: https://github.com/spring-ai-alibaba/examples/blob/main/spring-ai-alibaba-mcp-example/readme.md

Compile and package a single example module, such as the starter example, skipping tests.

```bash
mvn clean package -pl spring-ai-alibaba-mcp-starter-example -DskipTests
```

--------------------------------

### Install Project Dependencies

Source: https://github.com/spring-ai-alibaba/examples/blob/main/spring-ai-alibaba-usecase-example/spring-ai-alibaba-comprehensive-example/chatAiDemo-frontend/README.md

Installs all the necessary packages for the project. Run this command after cloning the repository.

```sh
npm install
```

--------------------------------

### Docker Command to Run Elasticsearch

Source: https://github.com/spring-ai-alibaba/examples/blob/main/spring-ai-alibaba-rag-example/module-rag/README.md

Command to start an Elasticsearch instance using Docker, required for the RAG example's environment setup.

```bash
docker run -d \
  --name elasticsearch \
  -p 9200:9200 \
  -p 9300:9300 \
  -e "discovery.type=single-node" \
  -e "xpack.security.enabled=false" \
  elasticsearch:8.11.0
```

--------------------------------

### Example GET Request for retrievalHyde

Source: https://github.com/spring-ai-alibaba/examples/blob/main/spring-ai-alibaba-rag-example/rag-elasticsearch-autoconfigure-example/README.md

This is an example GET request to the retrievalHyde endpoint. It is used for data processing and response, and API integration testing.

```bash
GET http://localhost:8080/rag/retrieval/hyde
```

--------------------------------

### Run SQLite Chatbot Example

Source: https://github.com/spring-ai-alibaba/examples/blob/main/spring-ai-alibaba-mcp-example/spring-ai-alibaba-mcp-manual-example/README.md

Execute the interactive SQLite chatbot example using Maven. This starts the Spring Boot application for conversational database interactions.

```bash
cd sqlite/ai-mcp-sqlite-chatbot
mvn spring-boot:run
```

--------------------------------

### Example GET Request for retrievalHybrid

Source: https://github.com/spring-ai-alibaba/examples/blob/main/spring-ai-alibaba-rag-example/rag-elasticsearch-autoconfigure-example/README.md

This is an example GET request to the retrievalHybrid endpoint. It is used for data processing and response, and API integration testing.

```bash
GET http://localhost:8080/rag/retrieval/hybrid
```

--------------------------------

### Build and Run with Maven

Source: https://github.com/spring-ai-alibaba/examples/blob/main/spring-ai-alibaba-graph-example/multiagent-openmanus/README.md

Instructions to build the project and run the example application using Maven commands.

```Shell
mvn clean install
cd spring-ai-alibaba-graph/spring-ai-alibaba-graph-example
mvn spring-boot:run
```

--------------------------------

### Example GET Request for transformHyde

Source: https://github.com/spring-ai-alibaba/examples/blob/main/spring-ai-alibaba-rag-example/rag-elasticsearch-autoconfigure-example/README.md

This is an example GET request to the transformHyde endpoint. It is used for data processing and response, and API integration testing.

```bash
GET http://localhost:8080/rag/transform/hyde
```

--------------------------------

### HomeController Index API Example

Source: https://github.com/spring-ai-alibaba/examples/blob/main/spring-ai-alibaba-nl2sql-example/README.md

Demonstrates the root endpoint for the HomeController. This is a GET request to the / endpoint.

```bash
GET http://localhost:8080/
```

--------------------------------

### Clone Example Source Code

Source: https://github.com/spring-ai-alibaba/examples/blob/main/spring-ai-alibaba-mcp-example/spring-ai-alibaba-mcp-manual-example/ai-mcp-fileserver/README.md

Download the source code for the Spring AI Alibaba examples.

```bash
git clone https://github.com/springaialibaba/spring-ai-alibaba-examples.git
cd spring-ai-alibaba-mcp-example/spring-ai-alibaba-manual-mcp-example/ai-mcp-fileserver
```

--------------------------------

### Start Authentication Client

Source: https://github.com/spring-ai-alibaba/examples/blob/main/spring-ai-alibaba-mcp-example/spring-ai-alibaba-mcp-auth-example/server/mcp-auth-web-server/README.md

Command to start the accompanying authentication client for end-to-end testing.

```bash
cd ../client/mcp-auth-client
mvn spring-boot:run
```

--------------------------------

### Example HTTP Request for enrichProduct

Source: https://github.com/spring-ai-alibaba/examples/blob/main/spring-ai-alibaba-graph-example/product-analysis-graph/README.md

An example GET request to the enrichProduct endpoint, used for basic testing or documentation purposes.

```http
GET http://localhost:8080/product/enrich
```

--------------------------------

### Start Corresponding Client

Source: https://github.com/spring-ai-alibaba/examples/blob/main/spring-ai-alibaba-mcp-example/readme.md

Execute the Maven command to run the client that corresponds to the annotation-driven server.

```bash
cd client/mcp-annotation-client
mvn spring-boot:run
```

--------------------------------

### Resume API Request Example

Source: https://github.com/spring-ai-alibaba/examples/blob/main/spring-ai-alibaba-graph-example/human-node/README.md

Example of an HTTP GET request to the resume API endpoint. Used for data processing and API integration testing.

```bash
GET http://localhost:8080/graph/human/resume
```

--------------------------------

### Backend Environment Check

Source: https://github.com/spring-ai-alibaba/examples/blob/main/spring-ai-alibaba-sandbox-example/sandbox-browser-fullstack/README.md

Verify that Java, Node.js, npm, and Docker are installed and running before proceeding with backend setup.

```bash
java -version
node -v
npm -v
docker ps
```

--------------------------------

### AnalyticDbVectorManagementController Schema Initialization API Example

Source: https://github.com/spring-ai-alibaba/examples/blob/main/spring-ai-alibaba-nl2sql-example/README.md

Demonstrates initializing the schema for the analytic database vector management system. This is a GET request to the /init/schema endpoint.

```bash
GET http://localhost:8080/init/schema
```

--------------------------------

### Clone Spring AI Alibaba Examples

Source: https://github.com/spring-ai-alibaba/examples/blob/main/spring-ai-alibaba-playground/src/main/resources/rag/markdown/chatbot.md

Download the project source code and navigate to the helloworld example directory.

```shell
git clone --depth=1 https://github.com/springaialibaba/spring-ai-alibaba-examples.git
cd spring-ai-alibaba-examples/spring-ai-alibaba-helloworld
```

--------------------------------

### GitHub Example Configuration (application.yml)

Source: https://github.com/spring-ai-alibaba/examples/blob/main/spring-ai-alibaba-mcp-example/spring-ai-alibaba-mcp-manual-example/README.md

Configure DashScope API key and MCP client settings for STDIO communication.

```yaml
spring:
    ai:
        dashscope:
            api-key: ${AI_DASHSCOPE_API_KEY}
        mcp:
            client:
                stdio:
                    servers-configuration: classpath:/mcp-servers-config.json
```

--------------------------------

### Curl Test Example

Source: https://github.com/spring-ai-alibaba/examples/blob/main/spring-ai-alibaba-playground/README.md

Example of how to test the Spring AI Alibaba Playground APIs using curl. This demonstrates a basic GET request structure.

```bash
curl 
```

--------------------------------

### SimpleVectorManagementController Schema Initialization API Example

Source: https://github.com/spring-ai-alibaba/examples/blob/main/spring-ai-alibaba-nl2sql-example/README.md

Shows how to initialize the schema for the simple vector management system. This is a GET request to the /simple/init/schema endpoint.

```bash
GET http://localhost:8080/simple/init/schema
```

--------------------------------

### Start Annotation-Driven Server and Client

Source: https://github.com/spring-ai-alibaba/examples/blob/main/spring-ai-alibaba-mcp-example/readme.md

Launch the annotation-driven MCP server and its corresponding client. This is recommended for beginners and rapid prototyping.

```bash
cd server/mcp-annotation-server
mvn spring-boot:run
```

```bash
cd client/mcp-annotation-client
mvn spring-boot:run
```

--------------------------------

### Clone Repository and Navigate

Source: https://github.com/spring-ai-alibaba/examples/blob/main/spring-ai-alibaba-mcp-example/spring-ai-alibaba-mcp-manual-example/sqlite/ai-mcp-sqlite/README.md

Steps to clone the Spring AI examples repository and navigate to the specific demo directory.

```bash
git clone https://github.com/spring-projects/spring-ai-examples.git
cd model-context-protocol/sqlite/simple
```

--------------------------------

### SimpleChat API Request Example

Source: https://github.com/spring-ai-alibaba/examples/blob/main/spring-ai-alibaba-graph-example/usecase-field-classifier/README.md

Demonstrates how to make a GET request to the simpleChat endpoint.

```bash
GET http://localhost:8080/sec/graph/chat
```

--------------------------------

### SaRelevancy API Request Example

Source: https://github.com/spring-ai-alibaba/examples/blob/main/spring-ai-alibaba-evaluation-example/README.md

Example GET request for the saRelevancy API, used to evaluate the relevance of AI-generated responses to provided context.

```bash
GET http://localhost:8080/ai/evaluation/sa/relevancy
```

--------------------------------

### Start Service

Source: https://github.com/spring-ai-alibaba/examples/blob/main/spring-ai-alibaba-nl2sql-example/chat/README.md

Run the application using the generated JAR file. The service will be available at http://localhost:8065.

```bash
java -jar target/chat-1.0.0.jar
```

--------------------------------

### Application Configuration Example

Source: https://github.com/spring-ai-alibaba/examples/blob/main/spring-ai-alibaba-rag-example/module-rag/README.md

Example `application.yaml` configuration for Spring AI with Alibaba Dashscope and Elasticsearch integration.

```yaml
spring:
  ai:
    dashscope:
      api-key: ${AI_DASHSCOPE_API_KEY}
      chat:
        model: qwen-plus
        options:
          temperature: 0.7
          max-tokens: 2000
  elasticsearch:
    uris: http://localhost:9200
```

--------------------------------

### Build Example with Maven Wrapper

Source: https://github.com/spring-ai-alibaba/examples/blob/main/spring-ai-alibaba-mcp-example/spring-ai-alibaba-mcp-manual-example/ai-mcp-fileserver/README.md

Build the Spring Boot application using the Maven wrapper.

```bash
./mvnw clean install
```

--------------------------------

### Start MCP Server

Source: https://github.com/spring-ai-alibaba/examples/blob/main/spring-ai-alibaba-mcp-example/spring-ai-alibaba-mcp-starter-example/client/mcp-streamable-webflux-client/README.md

Navigate to the server directory and run the Maven command to start the MCP Streamable WebFlux server.

```bash
cd ../server/mcp-streamable-webflux-server
mvn spring-boot:run
```

--------------------------------

### Production Environment Configuration Example

Source: https://github.com/spring-ai-alibaba/examples/blob/main/spring-ai-alibaba-mcp-example/spring-ai-alibaba-mcp-auth-example/client/mcp-auth-client/README.md

Example production configuration using environment variables for tokens and setting appropriate logging levels.

```yaml
# 生产环境配置示例
spring:
  profiles:
    active: prod

auth:
  # 从环境变量读取 token
  token1: ${AUTH_TOKEN_1}
  token2: ${AUTH_TOKEN_2}

logging:
  level:
    com.alibaba.cloud.ai.mcp.client: INFO
    # 避免在生产环境中打印敏感信息
    io.modelcontextprotocol.client: WARN
```

--------------------------------

### Expand API Request Example

Source: https://github.com/spring-ai-alibaba/examples/blob/main/spring-ai-alibaba-graph-example/human-node/README.md

Example of an HTTP GET request to the expand API endpoint. Used for data processing and API integration testing.

```bash
GET http://localhost:8080/graph/human/expand
```

--------------------------------

### Start Server with JAR

Source: https://github.com/spring-ai-alibaba/examples/blob/main/spring-ai-alibaba-mcp-example/spring-ai-alibaba-mcp-starter-example/server/mcp-streamable-webflux-server/README.md

Command to run the Spring Boot application from a packaged JAR file.

```bash
java -jar target/mcp-streamable-webflux-server-*.jar
```

--------------------------------

### Example Commands for Browser Automation

Source: https://github.com/spring-ai-alibaba/examples/blob/main/spring-ai-alibaba-sandbox-example/sandbox-browser-fullstack/QUICKSTART.md

A list of example commands to test the AI agent's web browsing capabilities.

```bash
"Navigate to https://www.baidu.com and tell me what you see"
"Go to GitHub and search for spring-ai-alibaba"
"Visit Stack Overflow and find questions about Java"
"Open Amazon and search for laptops"
"Go to YouTube and search for Java tutorials"
```

--------------------------------

### SimpleVectorManagementController Add Evidence API Example

Source: https://github.com/spring-ai-alibaba/examples/blob/main/spring-ai-alibaba-nl2sql-example/README.md

Demonstrates adding evidence to the simple vector management system. This is a GET request to the /simple/simple endpoint.

```bash
GET http://localhost:8080/simple/simple
```

--------------------------------

### Install uvx Package Manager

Source: https://github.com/spring-ai-alibaba/examples/blob/main/spring-ai-alibaba-mcp-example/spring-ai-alibaba-mcp-manual-example/sqlite/ai-mcp-sqlite/README.md

Instructions for installing the uvx package manager. Follow the official documentation for detailed steps.

```bash
# Follow installation instructions at:
https://docs.astral.sh/uv/getting-started/installation/
```

--------------------------------

### SaaAnswerRelevancy API Request Example

Source: https://github.com/spring-ai-alibaba/examples/blob/main/spring-ai-alibaba-evaluation-example/README.md

Example GET request for the saaAnswerRelevancy API, used for scoring AI-generated responses based on provided criteria and content.

```bash
GET http://localhost:8080/ai/evaluation/saa/answer-relevancy
```

--------------------------------

### Example Request for retrievalHybridWithEsQuery

Source: https://github.com/spring-ai-alibaba/examples/blob/main/spring-ai-alibaba-rag-example/rag-component-example/README.md

Use this GET request to test the retrievalHybridWithEsQuery functionality. Ensure the application is running on localhost:8080.

```bash
GET http://localhost:8080/rag/component/retrieval/hybrid/esquery
```

--------------------------------

### Get Memory Example with Query and User ID

Source: https://github.com/spring-ai-alibaba/examples/blob/main/spring-ai-alibaba-mem0-example/README.md

This example shows how to retrieve chat memory using the 'messages' endpoint with a specific query and user ID. Ensure the AI_DASHSCOPE_API_KEY and AI_DEEPSEEK_API_KEY environment variables are configured.

```shell
### 获取记忆
GET http://localhost:8080/advisor/memory/mem0/messages?query=我的爱好是什么&user_id=miao
```

--------------------------------

### SimpleVectorManagementController Search API Example

Source: https://github.com/spring-ai-alibaba/examples/blob/main/spring-ai-alibaba-nl2sql-example/README.md

Demonstrates searching within the simple vector management system. This is a GET request to the /simple/search endpoint.

```bash
GET http://localhost:8080/simple/search
```

--------------------------------

### Compile MCP Server Example

Source: https://github.com/spring-ai-alibaba/examples/blob/main/spring-ai-alibaba-mcp-example/spring-ai-alibaba-mcp-starter-example/client/mcp-stdio-client-example/README.md

Compile the MCP server example using Maven. Ensure you are in the correct directory.

```bash
cd spring-ai-alibaba-mcp-example/spring-ai-alibaba-mcp-build-example/mcp-stdio-server-example
mvn clean package
```

--------------------------------

### Example Request for rerankDocuments

Source: https://github.com/spring-ai-alibaba/examples/blob/main/spring-ai-alibaba-rag-example/rag-component-example/README.md

Use this GET request to test the rerankDocuments functionality. Ensure the application is running on localhost:8080.

```bash
GET http://localhost:8080/rag/component/rerank/documents
```

--------------------------------

### Example Request for retrievalHybridWithFilter

Source: https://github.com/spring-ai-alibaba/examples/blob/main/spring-ai-alibaba-rag-example/rag-component-example/README.md

Use this GET request to test the retrievalHybridWithFilter functionality. Ensure the application is running on localhost:8080.

```bash
GET http://localhost:8080/rag/component/retrieval/hybrid/filter
```

--------------------------------

### Expand API Request Example

Source: https://github.com/spring-ai-alibaba/examples/blob/main/spring-ai-alibaba-graph-example/parallel-node/README.md

Demonstrates how to make a GET request to the expand API endpoint. This is useful for testing data processing and API integration.

```bash
GET http://localhost:8080/graph/stream/expand
```

--------------------------------

### Example Request for callMultiQueryRetrieverAdvisor

Source: https://github.com/spring-ai-alibaba/examples/blob/main/spring-ai-alibaba-rag-example/rag-component-example/README.md

Use this GET request to test the callMultiQueryRetrieverAdvisor functionality. Ensure the application is running on localhost:8080.

```bash
GET http://localhost:8080/rag/component/call/multiquery/advisor
```

--------------------------------

### Example Request for retrievalHydeWithFilter

Source: https://github.com/spring-ai-alibaba/examples/blob/main/spring-ai-alibaba-rag-example/rag-component-example/README.md

Use this GET request to test the retrievalHydeWithFilter functionality. Ensure the application is running on localhost:8080.

```bash
GET http://localhost:8080/rag/component/retrieval/hyde/filter
```

--------------------------------

### AnalyticDbVectorManagementController Add Evidence API Example

Source: https://github.com/spring-ai-alibaba/examples/blob/main/spring-ai-alibaba-nl2sql-example/README.md

Demonstrates adding evidence to the analytic database vector management system. This is a GET request to the /add/evidence endpoint.

```bash
GET http://localhost:8080/add/evidence
```

--------------------------------

### Nl2sqlForGraphController Search API Example

Source: https://github.com/spring-ai-alibaba/examples/blob/main/spring-ai-alibaba-nl2sql-example/README.md

Demonstrates how to call the search API for NL2SQL functionality. This is a GET request to the /nl2sql/search endpoint.

```bash
GET http://localhost:8080/nl2sql/search
```

--------------------------------

### Run Development Server with npm

Source: https://github.com/spring-ai-alibaba/examples/blob/main/spring-ai-alibaba-usecase-example/spring-ai-alibaba-scene-example/frontend/README.md

Use this command to start the Next.js development server when using npm.

```bash
npm run dev
```

--------------------------------

### AnalyticNl2SqlController NL2SQL API Example

Source: https://github.com/spring-ai-alibaba/examples/blob/main/spring-ai-alibaba-nl2sql-example/README.md

Shows how to use the NL2SQL functionality via the chat API. This is a GET request to the /chat endpoint.

```bash
GET http://localhost:8080/chat
```

--------------------------------

### Example Request for retrievalHyde

Source: https://github.com/spring-ai-alibaba/examples/blob/main/spring-ai-alibaba-rag-example/rag-component-example/README.md

Use this GET request to test the retrievalHyde functionality. Ensure the application is running on localhost:8080.

```bash
GET http://localhost:8080/rag/component/retrieval/hyde
```

--------------------------------

### Example Request for retrievalHybrid

Source: https://github.com/spring-ai-alibaba/examples/blob/main/spring-ai-alibaba-rag-example/rag-component-example/README.md

Use this GET request to test the retrievalHybrid functionality. Ensure the application is running on localhost:8080.

```bash
GET http://localhost:8080/rag/component/retrieval/hybrid
```

--------------------------------

### Compile MCP Client Example

Source: https://github.com/spring-ai-alibaba/examples/blob/main/spring-ai-alibaba-mcp-example/spring-ai-alibaba-mcp-starter-example/client/mcp-stdio-client-example/README.md

Compile the MCP client example using Maven. After compilation, configure the MCP Server's absolute path in the client's resource directory.

```bash
cd spring-ai-alibaba-mcp-example/spring-ai-alibaba-mcp-starter-example/client/mcp-stdio-client-example
mvn clean package
```

--------------------------------

### Example Request for callHybridAdvisor

Source: https://github.com/spring-ai-alibaba/examples/blob/main/spring-ai-alibaba-rag-example/rag-component-example/README.md

Use this GET request to test the callHybridAdvisor functionality. Ensure the application is running on localhost:8080.

```bash
GET http://localhost:8080/rag/component/call/hybrid/advisor
```

--------------------------------

### Build and Run Client

Source: https://github.com/spring-ai-alibaba/examples/blob/main/spring-ai-alibaba-mcp-example/spring-ai-alibaba-mcp-starter-example/client/mcp-streamable-webflux-client/README.md

Navigate to the client directory, compile the project using Maven, and then run the client application.

```bash
# 进入客户端目录
cd spring-ai-alibaba-mcp-starter-example/client/mcp-streamable-webflux-client

# 编译项目
mvn clean package -DskipTests

# 启动客户端
mvn spring-boot:run
```

--------------------------------

### Run Development Server with bun

Source: https://github.com/spring-ai-alibaba/examples/blob/main/spring-ai-alibaba-usecase-example/spring-ai-alibaba-scene-example/frontend/README.md

Use this command to start the Next.js development server when using bun.

```bash
bun dev
```

--------------------------------

### AnalyticDbVectorManagementController Search API Example

Source: https://github.com/spring-ai-alibaba/examples/blob/main/spring-ai-alibaba-nl2sql-example/README.md

Illustrates searching within the analytic database vector management system. This is a GET request to the /search endpoint.

```bash
GET http://localhost:8080/search
```

--------------------------------

### Navigate to Nacos Example Module

Source: https://github.com/spring-ai-alibaba/examples/blob/main/spring-ai-alibaba-mcp-example/readme.md

Change directory to the spring-ai-alibaba-mcp-nacos-example module, recommended for enterprise integration scenarios.

```bash
cd spring-ai-alibaba-mcp-nacos-example
```

--------------------------------

### Start Annotation-Driven Server

Source: https://github.com/spring-ai-alibaba/examples/blob/main/spring-ai-alibaba-mcp-example/readme.md

Execute the Maven command to run the annotation-driven MCP server.

```bash
cd server/mcp-annotation-server
mvn spring-boot:run
```

--------------------------------

### Start MCP Auth Web Server

Source: https://github.com/spring-ai-alibaba/examples/blob/main/spring-ai-alibaba-mcp-example/spring-ai-alibaba-mcp-auth-example/client/mcp-auth-client/README.md

Navigate to the server directory and run the Maven command to start the MCP Auth Web Server. This server will be accessible at http://localhost:20000 and includes an authentication filter.

```bash
cd ../server/mcp-auth-web-server
mvn spring-boot:run
```

--------------------------------

### Other Example Configuration (application.properties)

Source: https://github.com/spring-ai-alibaba/examples/blob/main/spring-ai-alibaba-mcp-example/spring-ai-alibaba-mcp-manual-example/README.md

Configure DashScope API key and disable the banner mode for STDIO communication.

```properties
# DashScope API Key
sspring.ai.dashscope.api-key=${AI_DASHSCOPE_API_KEY}

# 禁用横幅显示（用于 STDIO 通信）
spring.main.banner-mode=off
```

--------------------------------

### Example Request for transformHyde

Source: https://github.com/spring-ai-alibaba/examples/blob/main/spring-ai-alibaba-rag-example/rag-component-example/README.md

Use this GET request to test the transformHyde functionality. Ensure the application is running on localhost:8080.

```bash
GET http://localhost:8080/rag/component/transform/hyde
```

--------------------------------

### SimpleChatController Simple NL2SQL API Example

Source: https://github.com/spring-ai-alibaba/examples/blob/main/spring-ai-alibaba-nl2sql-example/README.md

Illustrates the simple NL2SQL chat functionality. This is a GET request to the /simpleChat endpoint.

```bash
GET http://localhost:8080/simpleChat
```

--------------------------------

### SaaAnswerCorrectness API Request Example

Source: https://github.com/spring-ai-alibaba/examples/blob/main/spring-ai-alibaba-evaluation-example/README.md

Example GET request for the saaAnswerCorrectness API, used to evaluate if the AI-generated response aligns with the provided context.

```bash
GET http://localhost:8080/ai/evaluation/saa/answer-correctness
```

--------------------------------

### Start MCP Authentication Server

Source: https://github.com/spring-ai-alibaba/examples/blob/main/spring-ai-alibaba-mcp-example/spring-ai-alibaba-mcp-auth-example/README.md

Launches the MCP authentication server using Maven. The server will start on http://localhost:20000 and enforce the defined authentication mechanisms.

```bash
cd server/mcp-auth-web-server

# 启动服务器
mvn spring-boot:run
```

--------------------------------

### Test Endpoint Example

Source: https://github.com/spring-ai-alibaba/examples/blob/main/spring-ai-alibaba-mem0-example/README.md

This example demonstrates how to use the 'test' endpoint for the Mem0 Memory service. Ensure the AI_DASHSCOPE_API_KEY and AI_DEEPSEEK_API_KEY environment variables are configured.

```shell
### 测试
GET http://localhost:8080/advisor/memory/mem0/test
```

--------------------------------

### Build Project with Maven

Source: https://github.com/spring-ai-alibaba/examples/blob/main/spring-ai-alibaba-evaluation-example/README.md

Maven command to clean and install the project, compiling the code and preparing it for execution.

```shell
mvn clean install
```

--------------------------------

### Example: Search Bioinformatics Methods

Source: https://github.com/spring-ai-alibaba/examples/blob/main/spring-ai-alibaba-agent-example/skills-agent-example/skills/arxiv-search/SKILL.md

An example command to search for 'genome assembly algorithms' papers. This command also uses the default maximum number of papers.

```bash
.venv/bin/python ~/.deepagents/agent/skills/arxiv-search/arxiv_search.py "genome assembly algorithms"
```

--------------------------------

### Basic Time Query Example

Source: https://github.com/spring-ai-alibaba/examples/blob/main/spring-ai-alibaba-mcp-example/spring-ai-alibaba-mcp-starter-example/client/mcp-streamable-webflux-client/README.md

Examples of asking for current time in different cities and calculating time differences.

```text
>>> QUESTION: 北京现在是什么时间？
>>> ASSISTANT: [AI 调用时间工具，返回北京当前时间]

>>> QUESTION: 伦敦和东京的时差是多少？
>>> ASSISTANT: [AI 调用工具查询两个城市时间，计算时差]
```

--------------------------------

### SimpleVectorManagementController Add Evidence (Specific Path) API Example

Source: https://github.com/spring-ai-alibaba/examples/blob/main/spring-ai-alibaba-nl2sql-example/README.md

Shows how to add evidence using a specific path in the simple vector management system. This is a GET request to the /simple/add/evidence endpoint.

```bash
GET http://localhost:8080/simple/add/evidence
```

--------------------------------

### SKILL.md Frontmatter Example

Source: https://github.com/spring-ai-alibaba/examples/blob/main/spring-ai-alibaba-agent-example/skills-agent-example/skills/skill-creator/SKILL.md

Shows the required YAML frontmatter for a SKILL.md file, including 'name' and 'description' fields.

```yaml
name: (required)
description: (required)

```

--------------------------------

### Call API Endpoint Example

Source: https://github.com/spring-ai-alibaba/examples/blob/main/spring-ai-alibaba-mem0-example/README.md

This example shows how to call the Mem0 Memory chat functionality. Ensure the AI_DASHSCOPE_API_KEY environment variable is set.

```bash
GET http://localhost:8080/advisor/memory/mem0/call
```

--------------------------------

### SaaAnswerFaithfulness API Request Example

Source: https://github.com/spring-ai-alibaba/examples/blob/main/spring-ai-alibaba-evaluation-example/README.md

Example GET request for the saaAnswerFaithfulness API, used for scoring AI-generated responses based on provided criteria and content.

```bash
GET http://localhost:8080/ai/evaluation/saa/answer-faithfulness
```

--------------------------------

### Compile and Run Spring Boot Backend

Source: https://github.com/spring-ai-alibaba/examples/blob/main/spring-ai-alibaba-usecase-example/spring-ai-alibaba-comprehensive-example/README_EN.md

Instructions for compiling the project and starting the Spring Boot application. Ensure all dependencies are resolved.

```bash
# Compile project
mvn clean compile

# Start application
mvn spring-boot:run
```

--------------------------------

### Summarizer API Endpoint

Source: https://github.com/spring-ai-alibaba/examples/blob/main/spring-ai-alibaba-playground/README.md

Example GET request for the summary method, used for text summarization tasks. Implemented as a Spring Boot REST API.

```bash
GET http://localhost:8080/api/v1/summarizer
```

--------------------------------

### Start Backend with Maven

Source: https://github.com/spring-ai-alibaba/examples/blob/main/spring-ai-alibaba-sandbox-example/sandbox-browser-fullstack/QUICKSTART.md

Run the Spring Boot backend application using Maven. Ensure the Aliyun DashScope API key is set as an environment variable.

```bash
# Set API key (required)
export AI_DASHSCOPE_API_KEY=your-api-key-here

# Run with Maven (from project root - no need to cd into a backend folder)
mvn spring-boot:run
```

--------------------------------

### Troubleshooting: Start Docker on macOS

Source: https://github.com/spring-ai-alibaba/examples/blob/main/spring-ai-alibaba-sandbox-example/sandbox-browser-fullstack/QUICKSTART.md

If the BrowserSandbox fails to initialize, ensure the Docker application is running on macOS.

```bash
open -a Docker  # macOS
```

--------------------------------

### Test API Endpoint Example

Source: https://github.com/spring-ai-alibaba/examples/blob/main/spring-ai-alibaba-mem0-example/README.md

This example shows how to test the Mem0 Memory functionality via its dedicated test endpoint.

```bash
GET http://localhost:8080/advisor/memory/mem0/test
```

--------------------------------

### Install arXiv Package (System-wide)

Source: https://github.com/spring-ai-alibaba/examples/blob/main/spring-ai-alibaba-agent-example/skills-agent-example/skills/arxiv-search/SKILL.md

Command to install the 'arxiv' Python package system-wide. Use this if not running within a virtual environment.

```bash
python3 -m pip install arxiv
```

--------------------------------

### Example: Search Deep Learning Papers

Source: https://github.com/spring-ai-alibaba/examples/blob/main/spring-ai-alibaba-agent-example/skills-agent-example/skills/arxiv-search/SKILL.md

An example command to search for 'deep learning drug discovery' papers and limit the results to 5. This uses the virtual environment's Python interpreter.

```bash
.venv/bin/python ~/.deepagents/agent/skills/arxiv-search/arxiv_search.py "deep learning drug discovery" --max-papers 5
```

--------------------------------

### SaFactChecking API Request Example

Source: https://github.com/spring-ai-alibaba/examples/blob/main/spring-ai-alibaba-evaluation-example/README.md

Example GET request for the saFactChecking API, used to assess the factual accuracy of AI-generated responses against provided context.

```bash
GET http://localhost:8080/ai/evaluation/sa/fact-checking
```

--------------------------------

### Verify Docker Installation

Source: https://github.com/spring-ai-alibaba/examples/blob/main/spring-ai-alibaba-sandbox-example/sandbox-browser-fullstack/QUICKSTART.md

Ensure Docker is installed and running. This is crucial for the BrowserSandbox container.

```bash
docker --version
docker ps  # Verify Docker is running
```

--------------------------------

### Run Development Server with pnpm

Source: https://github.com/spring-ai-alibaba/examples/blob/main/spring-ai-alibaba-usecase-example/spring-ai-alibaba-scene-example/frontend/README.md

Use this command to start the Next.js development server when using pnpm.

```bash
pnpm dev
```

--------------------------------

### Build and Run the Authentication Client

Source: https://github.com/spring-ai-alibaba/examples/blob/main/spring-ai-alibaba-mcp-example/spring-ai-alibaba-mcp-auth-example/client/mcp-auth-client/README.md

Navigate to the client directory, compile the project using Maven, and then run the application using `mvn spring-boot:run`. This starts the MCP authentication client.

```bash
# 进入客户端目录
cd spring-ai-alibaba-mcp-auth-example/client/mcp-auth-client

# 编译项目
mvn clean package -DskipTests

# 启动客户端
mvn spring-boot:run
```

--------------------------------

### 引入 Spring AI 和 Spring AI Alibaba Starter 依赖

Source: https://github.com/spring-ai-alibaba/examples/blob/main/spring-ai-alibaba-more-platform-and-model-example/README.md

在 pom.xml 中引入 DashScope 和 Ollama 的 Spring Boot Starter 依赖。请注意指定版本。

```xml
<dependency>
    <groupId>com.alibaba.cloud.ai</groupId>
    <artifactId>spring-ai-alibaba-starter-dashscope</artifactId>
</dependency>

<dependency>
    <groupId>org.springframework.ai</groupId>
    <artifactId>spring-ai-ollama-spring-boot-starter</artifactId>
</dependency>
```

--------------------------------

### Generate Video API Endpoint

Source: https://github.com/spring-ai-alibaba/examples/blob/main/spring-ai-alibaba-playground/README.md

Example GET request for the genVideo method, a simple text-to-video generation interface. Implemented as a Spring Boot REST API.

```bash
GET http://localhost:8080/api/v1/video-gen
```

--------------------------------

### Initialize Vue Project with Vite

Source: https://github.com/spring-ai-alibaba/examples/blob/main/spring-ai-alibaba-agent-example/playground-flight-booking/frontend/README.md

Use npm to create a new Vue.js project with Vite. Ensure you have Node.js and Yarn installed.

```shell
npm create vue@latest
yarn
yarn format
yarn dev
```

--------------------------------

### Run Development Server with yarn

Source: https://github.com/spring-ai-alibaba/examples/blob/main/spring-ai-alibaba-usecase-example/spring-ai-alibaba-scene-example/frontend/README.md

Use this command to start the Next.js development server when using yarn.

```bash
yarn dev
```

--------------------------------

### Run Packaged Application

Source: https://github.com/spring-ai-alibaba/examples/blob/main/spring-ai-alibaba-agent-example/playground-flight-booking/README.md

Execute the built JAR file to start the Spring Boot application.

```shell
java -jar ./target/playground-flight-booking-0.0.1-SNAPSHOT.jar
```

--------------------------------

### Production Environment Spring Configuration Example

Source: https://github.com/spring-ai-alibaba/examples/blob/main/spring-ai-alibaba-mcp-example/spring-ai-alibaba-mcp-auth-example/README.md

Example of a production-ready Spring Boot configuration file, including active profile, JWT secrets, API keys, and logging levels.

```yaml
# 生产环境配置示例
spring:
  profiles:
    active: prod

# 认证配置
auth:
  jwt:
    secret: ${JWT_SECRET}
    expiration: ${JWT_EXPIRATION:3600}
  api-keys:
    - ${API_KEY_1}
    - ${API_KEY_2}

# 日志配置
logging:
  level:
    com.alibaba.cloud.ai.mcp.server.filter: INFO
    # 避免在生产环境中打印敏感信息
    root: WARN
```

--------------------------------

### Reflection Example URL

Source: https://github.com/spring-ai-alibaba/examples/blob/main/spring-ai-alibaba-graph-example/multiagent-openmanus/README.md

Example URL to test the Reflection system for generating essays or performing iterative tasks.

```URL
http://localhost:18080/reflection/chat?query=写一篇论文，题目是东北经济落后分析
```

--------------------------------

### Audio to Text API Endpoint

Source: https://github.com/spring-ai-alibaba/examples/blob/main/spring-ai-alibaba-playground/README.md

Example GET request for the audioToText method, used for converting audio input into text output. Implemented as a Spring Boot REST API.

```bash
GET http://localhost:8080/api/v1//audio2text
```

--------------------------------

### Troubleshooting: Start Docker Service

Source: https://github.com/spring-ai-alibaba/examples/blob/main/spring-ai-alibaba-sandbox-example/sandbox-browser-fullstack/QUICKSTART.md

If the BrowserSandbox fails to initialize, ensure the Docker service is running. This command is for Linux systems.

```bash
sudo systemctl start docker  # Linux
```

--------------------------------

### Expand Translate API Request

Source: https://github.com/spring-ai-alibaba/examples/blob/main/spring-ai-alibaba-graph-example/parallel-stream-node/README.md

Example GET request to the expand-translate endpoint for parallel stream processing.

```bash
GET http://localhost:8080/graph/parallel-stream/expand-translate
```

--------------------------------

### MCP Client Configuration

Source: https://github.com/spring-ai-alibaba/examples/blob/main/spring-ai-alibaba-mcp-example/spring-ai-alibaba-mcp-starter-example/server/mcp-streamable-webflux-server/README.md

Example JSON configuration for an MCP client to connect to the time-server.

```json
{
  "mcpServers": {
    "time-server": {
      "url": "http://localhost:20000/mcp"
    }
  }
}
```

--------------------------------

### React Agent Weather Query Example URL

Source: https://github.com/spring-ai-alibaba/examples/blob/main/spring-ai-alibaba-graph-example/multiagent-openmanus/README.md

Example URL to test the React Agent's weather query functionality.

```URL
http://localhost:18080/react/chat?query=分别帮我查询杭州、上海和南京的天气
```

--------------------------------

### JSON-RPC Response Example

Source: https://github.com/spring-ai-alibaba/examples/blob/main/spring-ai-alibaba-mcp-example/spring-ai-alibaba-mcp-starter-example/server/mcp-streamable-webflux-server/README.md

Example JSON-RPC response for a successful tool call, containing the current time.

```json
{
  "jsonrpc": "2.0",
  "result": {
    "content": [
      {
        "type": "text",
        "text": "The current time zone is Asia/Shanghai and the current time is 2024-01-15 14:30:25 CST"
      }
    ]
  },
  "id": 1
}
```

--------------------------------

### BigTool Example URL

Source: https://github.com/spring-ai-alibaba/examples/blob/main/spring-ai-alibaba-graph-example/multiagent-openmanus/README.md

Example URL to test the BigTool system for calculating mathematical operations using a large set of tools.

```URL
http://localhost:18080/bigtool/search?query=计算0.5的余弦
```

--------------------------------

### Video Question Answering API Endpoint

Source: https://github.com/spring-ai-alibaba/examples/blob/main/spring-ai-alibaba-playground/README.md

Example GET request for the videoQuestionAnswering method, enabling question answering on video content. Implemented as a Spring Boot REST API.

```bash
GET http://localhost:8080/api/v1/video-qa
```

--------------------------------

### Customer Service Workflow Example URL

Source: https://github.com/spring-ai-alibaba/examples/blob/main/spring-ai-alibaba-graph-example/multiagent-openmanus/README.md

Example URL to test the customer service workflow, which handles customer feedback and categorizes issues.

```URL
http://localhost:18080/customer/chat?query=我收到的产品有快递破损，需要退换货？
```

```URL
http://localhost:18080/customer/chat?query=我的产品不能正常工作了，要怎么去做维修？
```

```URL
http://localhost:18080/customer/chat?query=商品收到了，非常好，下次还会买。
```

--------------------------------

### Troubleshoot SQLite MCP Server

Source: https://github.com/spring-ai-alibaba/examples/blob/main/spring-ai-alibaba-mcp-example/spring-ai-alibaba-mcp-manual-example/README.md

Check uvx installation and manually test the SQLite MCP server.

```bash
# 检查 uvx 安装
uvx --version

# 手动测试 SQLite MCP 服务器
uvx mcp-server-sqlite --help
```

--------------------------------

### Install arXiv Package (Virtual Environment)

Source: https://github.com/spring-ai-alibaba/examples/blob/main/spring-ai-alibaba-agent-example/skills-agent-example/skills/arxiv-search/SKILL.md

Command to install the required 'arxiv' Python package using the virtual environment's pip. This is recommended for isolated dependency management.

```bash
.venv/bin/python -m pip install arxiv
```

--------------------------------

### Example: Search Computational Biology Papers

Source: https://github.com/spring-ai-alibaba/examples/blob/main/spring-ai-alibaba-agent-example/skills-agent-example/skills/arxiv-search/SKILL.md

An example command to search for 'protein folding prediction' papers. This command uses the default maximum number of papers.

```bash
.venv/bin/python ~/.deepagents/agent/skills/arxiv-search/arxiv_search.py "protein folding prediction"
```

--------------------------------

### Build Project with Maven

Source: https://github.com/spring-ai-alibaba/examples/blob/main/spring-ai-alibaba-mcp-example/spring-ai-alibaba-mcp-auth-example/README.md

Compiles and packages the entire Spring AI Alibaba MCP Authentication Example project using Maven. Tests are skipped during this build process.

```bash
# 进入项目根目录
cd spring-ai-alibaba-mcp-auth-example

# 构建整个项目
mvn clean package -DskipTests
```

--------------------------------

### Multi-agent OpenManus Chat Example URL

Source: https://github.com/spring-ai-alibaba/examples/blob/main/spring-ai-alibaba-graph-example/multiagent-openmanus/README.md

Example URL to interact with the Multi-agent OpenManus system for task execution.

```URL
http://localhost:18080/manus/chat?query=帮我查询阿里巴巴近一周的股票信息
```

--------------------------------

### Enable Debug Logging

Source: https://github.com/spring-ai-alibaba/examples/blob/main/spring-ai-alibaba-mcp-example/spring-ai-alibaba-mcp-build-example/README.md

YAML configuration to enable detailed debug logging for the stock example and MCP components.

```yaml
logging:
  level:
    com.alibaba.cloud.ai.example.stock: DEBUG
    io.modelcontextprotocol: DEBUG
```

--------------------------------

### Add Spring AI Alibaba Dashscope Starter

Source: https://github.com/spring-ai-alibaba/examples/blob/main/spring-ai-alibaba-agent-example/playground-flight-booking/README.md

Include the Spring AI Alibaba boot starter for Dashscope in your project's POM file.

```xml
<dependency>
    <groupId>org.springframework.ai</groupId>
    <artifactId>spring-ai-alibaba-starter-dashscope</artifactId>
    <version>1.0.0.1</version>
</dependency>
```

--------------------------------

### Check Node.js and npm Versions

Source: https://github.com/spring-ai-alibaba/examples/blob/main/spring-ai-alibaba-sandbox-example/sandbox-browser-fullstack/QUICKSTART.md

Confirm that Node.js 18 or later and npm are installed for frontend development.

```bash
node --version
npm --version
```

--------------------------------

### LLM Auditor Interface Response Example

Source: https://github.com/spring-ai-alibaba/examples/blob/main/spring-ai-alibaba-agent-example/adk-samples-llm-auditor/README.md

Shows an example response from the /ai/agent endpoint, including critic agent output with citations and reviser agent output.

```text
===============critic_agent_ouput============
critic_agent_output:    
[审稿结果内容，包含验证的主张和裁决]

Reference:

* [蓝莓为什么是蓝色的](https://jandan.net/p/115589): 蓝莓之所以呈现出蓝色，秘密就在于其蜡质覆盖层的结构...
* [藍莓的藍色來自兩個關鍵因素](https://www.threads.com/...): 內部的花青素：讓果肉呈現紫色...
===============end============
===============reviser_agent_output============
reviser_agent_output:    
[修订后的答案内容]
===============end=============
```

--------------------------------

### Chat Memory Example with User ID

Source: https://github.com/spring-ai-alibaba/examples/blob/main/spring-ai-alibaba-mem0-example/README.md

This example demonstrates a chat interaction using the 'call' endpoint, including a message and a user ID. Ensure the AI_DASHSCOPE_API_KEY and AI_DEEPSEEK_API_KEY environment variables are configured.

```shell
### 聊天记忆
GET http://localhost:8080/advisor/memory/mem0/call?message=你好，我是万能的喵，我爱玩三角洲行动&user_id=miao
```

--------------------------------

### Install Node.js using NVM

Source: https://github.com/spring-ai-alibaba/examples/blob/main/spring-ai-alibaba-mcp-example/spring-ai-alibaba-mcp-manual-example/README.md

Install Node.js version 18 or later using the Node Version Manager (NVM). This is required for running MCP servers.

```bash
# 使用 nvm 安装 Node.js 18+
curl -o- https://raw.githubusercontent.com/nvm-sh/nvm/v0.39.0/install.sh | bash
nvm install 18
nvm use 18
```

--------------------------------

### Call Service with Curl

Source: https://github.com/spring-ai-alibaba/examples/blob/main/spring-ai-alibaba-observability-example/observability-arms-example/README.md

Use this command to call the joke service after the application has started.

```bash
curl --location 'http://localhost:8080/joke'
```

--------------------------------

### Example Curl Test for enrichProduct

Source: https://github.com/spring-ai-alibaba/examples/blob/main/spring-ai-alibaba-graph-example/product-analysis-graph/README.md

A simple curl command to test the enrichProduct interface, demonstrating a basic GET request.

```bash
# enrichProduct 接口测试
curl "http://localhost:8080/product/enrich"
```

--------------------------------

### Check Java Version

Source: https://github.com/spring-ai-alibaba/examples/blob/main/spring-ai-alibaba-sandbox-example/sandbox-browser-fullstack/QUICKSTART.md

Verify that Java Development Kit (JDK) 17 or later is installed.

```bash
java -version
```

--------------------------------

### Run Project with Maven

Source: https://github.com/spring-ai-alibaba/examples/blob/main/spring-ai-alibaba-evaluation-example/README.md

Maven command to run the Spring Boot application, starting the server and making the API endpoints available.

```shell
mvn spring-boot:run
```

--------------------------------

### Start Backend Server

Source: https://github.com/spring-ai-alibaba/examples/blob/main/spring-ai-alibaba-sandbox-example/sandbox-browser-fullstack/README.md

Set the DashScope API key as an environment variable and run the Spring Boot application from the module's root directory. The backend will be accessible at http://localhost:8080.

```bash
export AI_DASHSCOPE_API_KEY=你的Key
mvn spring-boot:run
```

--------------------------------

### Set SERP_API_KEY environment variable (Optional)

Source: https://github.com/spring-ai-alibaba/examples/blob/main/spring-ai-alibaba-graph-example/multiagent-openmanus/README.md

Optional configuration for SerpApi key, used when experiencing the OpenManus example.

```Shell
export SERP_API_KEY=xxx
```

--------------------------------

### Add New Tool Service

Source: https://github.com/spring-ai-alibaba/examples/blob/main/spring-ai-alibaba-mcp-example/spring-ai-alibaba-mcp-build-example/README.md

Example of creating a new service class and defining a tool with @Tool and @McpToolParam annotations.

```java
@Service
public class YourService {

    @Tool(name = "yourTool", description = "Your tool description")
    public YourResult yourMethod(@McpToolParam String param) {
        // 实现逻辑
    }
}
```

--------------------------------

### Basic Usage with Virtual Environment

Source: https://github.com/spring-ai-alibaba/examples/blob/main/spring-ai-alibaba-agent-example/skills-agent-example/skills/arxiv-search/SKILL.md

Demonstrates how to run the arXiv search script using the Python interpreter from a virtual environment. Replace `[YOUR_SKILLS_DIR]` with the actual path to your skills directory.

```bash
.venv/bin/python [YOUR_SKILLS_DIR]/arxiv-search/arxiv_search.py "your search query" [--max-papers N]
```

--------------------------------

### Streaming Chat API Request (HTTP)

Source: https://github.com/spring-ai-alibaba/examples/blob/main/spring-ai-alibaba-helloworld/README.md

Example HTTP GET request to the streaming chat endpoint for real-time AI responses.

```http
GET http://localhost:8080/helloworld/stream/chat
```

--------------------------------

### Simple Chat API Request (HTTP)

Source: https://github.com/spring-ai-alibaba/examples/blob/main/spring-ai-alibaba-helloworld/README.md

Example HTTP GET request to the simple chat endpoint for basic AI interaction.

```http
GET http://localhost:8080/helloworld/simple/chat
```

--------------------------------

### Skill File Structure Example

Source: https://github.com/spring-ai-alibaba/examples/blob/main/spring-ai-alibaba-agent-example/skills-agent-example/skills/skill-creator/SKILL.md

Illustrates the typical directory structure for a skill within the deepagents CLI, showing the location of the SKILL.md file and optional bundled resources.

```bash
~/.deepagents/agent/skills/
├── skill-name-1/
│   └── SKILL.md
├── skill-name-2/
│   └── SKILL.md
└── ...

```

--------------------------------

### Few Shots Prompt Classification

Source: https://github.com/spring-ai-alibaba/examples/blob/main/spring-ai-alibaba-usecase-example/spring-ai-alibaba-text-classification-example/README.md

Enhances classification accuracy by providing a few examples (shots) within the prompt to guide the model's understanding.

```APIDOC
## POST /classify/few-shots-prompt

### Description
Performs text classification using a few-shot prompting technique, where example input-output pairs are included in the prompt.

### Method
POST

### Endpoint
/classify/few-shots-prompt

### Request Body
- **text** (string) - Required - The text to be classified.

### Request Example
{
  "text": "Basketball fans can now watch the game on the brand-new NBA app for Apple Vision Pro."
}

### Response
#### Success Response (200)
- **classification** (string) - The predicted class name after considering few-shot examples.

#### Response Example
{
  "classification": "Entertainment"
}
```

--------------------------------

### Test retrievalHybrid with curl

Source: https://github.com/spring-ai-alibaba/examples/blob/main/spring-ai-alibaba-rag-example/rag-component-example/README.md

This curl command can be used to test the retrievalHybrid interface after starting the application. It sends a GET request to the specified endpoint.

```bash
# retrievalHybrid 接口测试
curl "http://localhost:8080/rag/component/retrieval/hybrid"
```

--------------------------------

### Run Project: Configure Environment Variables

Source: https://github.com/spring-ai-alibaba/examples/blob/main/spring-ai-alibaba-agent-example/adk-samples-llm-auditor/README.md

Sets the DashScope and Tavily API keys as environment variables. Replace placeholders with your actual keys.

```bash
export AI_DASHSCOPE_API_KEY=<your-dashscope-api-key>
export WEB_SEARCH_KEY=<your-tavily-api-key>
```

--------------------------------

### Test customOptions Interface with curl

Source: https://github.com/spring-ai-alibaba/examples/blob/main/spring-ai-alibaba-chat-example/README.md

Example of how to test the customOptions interface using curl. This is useful for verifying custom configurations.

```bash
# customOptions 接口测试
curl "http://localhost:8080/client/ai/customOptions"
```

--------------------------------

### SimpleVectorManagementController Delete Documents API Example

Source: https://github.com/spring-ai-alibaba/examples/blob/main/spring-ai-alibaba-nl2sql-example/README.md

Illustrates deleting documents from the simple vector management system. This is a GET request to the /simple/delete endpoint.

```bash
GET http://localhost:8080/simple/delete
```

--------------------------------

### Initialize a New Skill

Source: https://github.com/spring-ai-alibaba/examples/blob/main/spring-ai-alibaba-agent-example/skills-agent-example/skills/skill-creator/SKILL.md

Use this script to create a new skill template directory. It generates necessary files and directories for a new skill, including a SKILL.md template and example resource folders.

```bash
scripts/init_skill.py <skill-name> --path <output-directory>
```

```bash
scripts/init_skill.py <skill-name> --path ~/.deepagents/agent/skills
```

--------------------------------

### ChatController with Auto-configured ChatClient

Source: https://github.com/spring-ai-alibaba/examples/blob/main/spring-ai-alibaba-playground/src/main/resources/rag/markdown/chat-client.md

Example of injecting and using an auto-configured ChatClient.Builder to build a ChatClient for basic user input and model response.

```java
    @RestController
    public class ChatController {

    	private final ChatClient chatClient;

    	public ChatController(ChatClient.Builder builder) {
    		this.chatClient = builder.build();
    	}

    	@GetMapping("/chat")
    	public String chat(String input) {
    		return this.chatClient.prompt()
    				.user(input)
    				.call()
    				.content();
    	}
    }
```

--------------------------------

### New Chat API Request (HTTP)

Source: https://github.com/spring-ai-alibaba/examples/blob/main/spring-ai-alibaba-helloworld/README.md

Example HTTP GET request to the new chat endpoint, supporting streaming and custom ChatOptions.

```http
GET http://localhost:8080/helloworld/advisor/newChat?prompt=请写一首关于春天的诗&temperature=0.9
```

--------------------------------

### Start MCP Authentication Client

Source: https://github.com/spring-ai-alibaba/examples/blob/main/spring-ai-alibaba-mcp-example/spring-ai-alibaba-mcp-auth-example/README.md

Launches the MCP authentication client using Maven. The client will automatically include the configured authentication headers when connecting to the server.

```bash
cd client/mcp-auth-client

# 启动客户端
mvn spring-boot:run
```

--------------------------------

### Application Configuration Example

Source: https://github.com/spring-ai-alibaba/examples/blob/main/spring-ai-alibaba-rag-example/rag-elasticsearch-example/README.md

Shows a sample application.yml configuration for Spring AI with DashScope and Elasticsearch integration. Includes API key and connection details.

```yaml
spring:
  ai:
    dashscope:
      api-key: ${DASHSCOPE_API_KEY}
    elasticsearch:
      uris: http://localhost:9200
      username: ${ELASTICSEARCH_USERNAME:}
      password: ${ELASTICSEARCH_PASSWORD:}
```

--------------------------------

### AnalyticDbVectorManagementController Delete Documents API Example

Source: https://github.com/spring-ai-alibaba/examples/blob/main/spring-ai-alibaba-nl2sql-example/README.md

Shows how to delete documents from the analytic database vector management system. This is a GET request to the /delete endpoint.

```bash
GET http://localhost:8080/delete
```

--------------------------------

### Build Project with Maven

Source: https://github.com/spring-ai-alibaba/examples/blob/main/spring-ai-alibaba-mcp-example/spring-ai-alibaba-mcp-build-example/README.md

Commands to clean, package, and skip tests for the entire module or a specific stock server.

```bash
cd spring-ai-alibaba-mcp-example/spring-ai-alibaba-mcp-build-example

mvn clean package -DskipTests

mvn clean package -pl starter-stock-server -DskipTests
```

--------------------------------

### Advisor Chat API Request (HTTP)

Source: https://github.com/spring-ai-alibaba/examples/blob/main/spring-ai-alibaba-helloworld/README.md

Example HTTP GET request to the advisor chat endpoint, including a conversation ID and initial message.

```http
GET http://localhost:8080/helloworld/advisor/chat/session123?message=你好，我叫小明
```

--------------------------------

### BeanController chatModel API Request

Source: https://github.com/spring-ai-alibaba/examples/blob/main/spring-ai-alibaba-structured-example/README.md

Example GET request for the chatModel endpoint in BeanController. This endpoint is designed for AI chat interactions and intelligent Q&A systems.

```bash
GET http://localhost:8080/bean/chat-model-format
```

--------------------------------

### Navigate to Project Directory

Source: https://github.com/spring-ai-alibaba/examples/blob/main/spring-ai-alibaba-sandbox-example/sandbox-browser-fullstack/QUICKSTART.md

Change the current directory to the root of the full-stack application.

```bash
cd spring-ai-alibaba-sandbox-example/sandbox-browser-fullstack
```

--------------------------------

### BeanController simpleChatFormat API Request

Source: https://github.com/spring-ai-alibaba/examples/blob/main/spring-ai-alibaba-structured-example/README.md

Example GET request for the simpleChatFormat endpoint in BeanController. This endpoint is designed for AI chat interactions and intelligent Q&A systems.

```bash
GET http://localhost:8080/bean/chat-format
```

--------------------------------

### BeanController simpleChat API Request

Source: https://github.com/spring-ai-alibaba/examples/blob/main/spring-ai-alibaba-structured-example/README.md

Example GET request for the simpleChat endpoint in BeanController. This endpoint is used for AI chat interactions and intelligent Q&A systems.

```bash
GET http://localhost:8080/bean/chat
```

--------------------------------

### JsonController simpleChatFormat API Request

Source: https://github.com/spring-ai-alibaba/examples/blob/main/spring-ai-alibaba-structured-example/README.md

Example GET request for the simpleChatFormat endpoint in JsonController. This endpoint is designed for AI chat interactions and intelligent Q&A systems.

```bash
GET http://localhost:8080/json/chat-format
```

--------------------------------

### JsonController simpleChat API Request

Source: https://github.com/spring-ai-alibaba/examples/blob/main/spring-ai-alibaba-structured-example/README.md

Example GET request for the simpleChat endpoint in JsonController. This endpoint is used for AI chat interactions and intelligent Q&A systems.

```bash
GET http://localhost:8080/json/chat
```

--------------------------------

### MapListController chatList API Request

Source: https://github.com/spring-ai-alibaba/examples/blob/main/spring-ai-alibaba-structured-example/README.md

Example GET request for the chatList endpoint in MapListController. This endpoint is designed for AI chat interactions and intelligent Q&A systems.

```bash
GET http://localhost:8080/map-list/chatList
```

--------------------------------

### Build Frontend Application

Source: https://github.com/spring-ai-alibaba/examples/blob/main/spring-ai-alibaba-agent-example/playground-flight-booking/frontend/README.md

Run the build command to generate production-ready assets for the frontend application.

```shell
yarn build
```

--------------------------------

### Local Run Command

Source: https://github.com/spring-ai-alibaba/examples/blob/main/spring-ai-alibaba-observability-example/observability-arms-example/README.md

Execute this command to build and run the observability example locally. Ensure you have set the necessary environment variables for API keys and ARMS configuration.

```bash
mvn clean package -Dmvn.test.skip=true

export AI_DASHSCOPE_API_KEY=${AI_DASHSCOPE_API_KEY}

java \
  -javaagent:./src/javaagent/AliyunJavaAgent/aliyun-java-agent.jar \
  -Darms.licenseKey=${ARMS_LICENSE_KEY} \
  -Darms.appName=${ARMS_APP_NAME} \
  -Daliyun.javaagent.regionId=${ARMS_REGION_ID} \
  -jar ./target/observability-arms-example-1.0.0.jar
```

--------------------------------

### MapListController chatList API Request

Source: https://github.com/spring-ai-alibaba/examples/blob/main/spring-ai-alibaba-structured-example/README.md

Example GET request for the chatList endpoint in MapListController. This endpoint is designed for AI chat interactions and intelligent Q&A systems.

```bash
GET http://localhost:8080/map-list/chatMap
```

--------------------------------

### Import Document API Request

Source: https://github.com/spring-ai-alibaba/examples/blob/main/spring-ai-alibaba-rag-example/bailian-rag-knowledge/README.md

Example of an HTTP GET request to import documents via the CloudRagController. This is useful for testing API integration and data processing.

```bash
GET http://localhost:8080/ai/bailian/knowledge/importDocument
```

--------------------------------

### Text to Image API Endpoint

Source: https://github.com/spring-ai-alibaba/examples/blob/main/spring-ai-alibaba-playground/README.md

Example GET request for the text2Image method, generating images from text descriptions. Implemented as a Spring Boot REST API.

```bash
GET http://localhost:8080/api/v1/text2image
```

--------------------------------

### Troubleshoot MCP Server Startup

Source: https://github.com/spring-ai-alibaba/examples/blob/main/spring-ai-alibaba-mcp-example/spring-ai-alibaba-mcp-manual-example/README.md

Commands to check Node.js version and manually test the MCP server for filesystem operations.

```bash
# 检查 Node.js 版本
node --version

# 手动测试 MCP 服务器
npx -y @modelcontextprotocol/server-filesystem --help
```

--------------------------------

### Tool Call API Endpoint

Source: https://github.com/spring-ai-alibaba/examples/blob/main/spring-ai-alibaba-playground/README.md

Example GET request for the toolCallChat method, used for AI-driven tool interactions. Implemented as a Spring Boot REST API.

```bash
GET http://localhost:8080/api/v1/tool-call
```
Tokens:
Raw