### 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
```

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

### 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'
```

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

### 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
```

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

### 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 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
```

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

### 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
```

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

### 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
```

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

### 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
```

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

### 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
```

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

### 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
```

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

### 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).
```

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

### 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
```

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

### 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/
```

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

### 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
```

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

### 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
```

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

### 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
```

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

### 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
```

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

### 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
```

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

### 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
```

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

### 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
```

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

### 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
```

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

### 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
```

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

### 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
```

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

### 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
```

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

### 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
```

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

### 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
```

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

### 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
```

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

### 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
```

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

### 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
```

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

### 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
```

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

### 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
```

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

### 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
```

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

### 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
```

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

### 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
```

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

### 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 
```

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

### 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
```

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

### 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
```

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

### 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
```

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

### 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
```

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

### 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
```

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

### 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
```

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

### 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
```

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

### 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
```

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

### 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
```

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

### 引入 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>
```

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

### 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 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
```

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

### 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
```

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

### 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
```

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

### 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 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
```

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

### 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"
```

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

### 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/
```

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

### 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 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
```

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

### 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
```

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

### 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
```

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

### 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
```

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

### 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
```

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

### 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
```

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

### 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>
```

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

### 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
```

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

### 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
```

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

### 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 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
```

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

### 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
```

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

### 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
```

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

### 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
```

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

### 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"
```

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

### 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
```

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

### 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
```

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

### 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
```

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

### 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
```

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

### 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
```