Spring Ai Resos

🚀 Spring AI ResOs Chatbot Development

This project aims to develop a ResOs chatbot based on Spring AI, supporting integration with AI providers such as OpenAI, Groq Cloud, and OpenRouter. The following is a detailed development guide.

✨ Features

Project Structure

The project's module structure is as follows:

• backend: Contains the backend logic of the chatbot, including interactions with AI providers.
• mcp-server: The Minimum Viable Product (MVP) server module, used to receive and process user query requests.
• mcp-client: The Minimum Viable Product (MVP) client module, used to send requests to the server and display results.

📦 Installation

1. Download the Project

Clone the project repository from GitHub:

git clone https://github.com/your-repository/spring-ai-resos.git
cd spring-ai-resos

2. Project Dependencies

Ensure the following dependencies are added to the pom.xml file:

<dependency>
    <groupId>org.springframework.boot</groupId>
    <artifactId>spring-boot-starter-web</artifactId>
</dependency>
<dependency>
    <groupId>com.azure.ai</groupId>
    <artifactId>azure-ai-textanalytics</artifactId>
</dependency>

3. Configuration Files

Create a config folder and add the following configuration files:

application.yml

server:
  port: 8081

spring:
  ai:
    openai:
      enabled: true
      api-key: sk-your-openai-api-key
    groq:
      enabled: false
      api-key: your-groq-api-key
    openrouter:
      enabled: false
      api-key: your-openrouter-api-key

logback-spring.xml

<configuration>
  <appender name="STDOUT" class="ch.qos.logback.core.ConsoleAppender">
    <layout class="ch.qos.logback.classic.PatternLayout">
      <pattern>%d{HH:mm:ss.SSS} %level - %msg%n</pattern>
    </layout>
  </appender>

  <root level="INFO">
    <appender-ref ref="STDOUT" />
  </root>
</configuration>

4. Start the Application

Run the following command in the project root directory to start the chatbot:

mvn spring-boot:run

💻 Usage Examples

1. Access the Web Interface

Open a browser and visit http://localhost:8081.

2. Enter a Query

Enter your question or instruction in the text box, for example:

• "Tell me the weather today?"
• "Help me write an email."

3. Get the Result

Click the "Send" button and wait a few seconds to see the result returned by the AI provider.

📚 Documentation

Example Screenshots

Supported AI Providers

OpenAI

• Enable: Set spring.ai.openai.enabled to true.
• Configure: Add your OpenAI API key in application.yml.

Groq Cloud

• Enable: Set spring.ai.groq.enabled to true.
• Configure: Add your Groq API key in application.yml.

OpenRouter

• Enable: Set spring.ai.openrouter.enabled to true.
• Configure: Add your OpenRouter API key in application.yml.

Extended Features

Text Embedding

Supports converting text into vector representations for subsequent processing. For example:

String text = "Hello, world!";
Vector embedding = textEmbeddingService.embedText(text);
System.out.println(embedding);

Custom Models

Supports integrating custom AI models. Simply add the corresponding configuration in application.yml.

🔧 Technical Details

Project Team

• Project Lead: Zhang San
• Developers: Li Si, Wang Wu
• Testers: Zhao Liu

Contact Information

If you have any questions, please contact Support Email or visit Project Website.

Hope the above content helps you!