Merge pull request #71 from springaialibaba/0308-yuluo/add-examples

feat: add more example

Author: yuluo-yx

spring-ai-alibaba-sql-example/README.md

@@ -0,0 +1,7 @@
+# 使用 Spring AI Alibaba 总结文本内容
+
+使用示例
+
+```shell
+curl -X POST -F file='./saa.pdf' http://localhost:10091/summarize
+```

spring-ai-alibaba-sql-example/pom.xml

@@ -0,0 +1,87 @@
+<?xml version="1.0" encoding="UTF-8"?>
+
+<!--
+   Copyright 2023-2024 the original author or authors.
+
+   Licensed under the Apache License, Version 2.0 (the "License");
+   you may not use this file except in compliance with the License.
+   You may obtain a copy of the License at
+
+        https://www.apache.org/licenses/LICENSE-2.0
+
+   Unless required by applicable law or agreed to in writing, software
+   distributed under the License is distributed on an "AS IS" BASIS,
+   WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+   See the License for the specific language governing permissions and
+   limitations under the License.
+-->
+
+<project xmlns="http://maven.apache.org/POM/4.0.0" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance"
+		 xsi:schemaLocation="http://maven.apache.org/POM/4.0.0 https://maven.apache.org/xsd/maven-4.0.0.xsd">
+	<modelVersion>4.0.0</modelVersion>
+
+	<parent>
+		<groupId>com.alibaba.cloud.ai</groupId>
+		<artifactId>spring-ai-alibaba-examples</artifactId>
+		<version>${revision}</version>
+		<relativePath>../pom.xml</relativePath>
+	</parent>
+
+	<artifactId>spring-ai-alibaba-text-summarizer-example</artifactId>
+	<version>0.0.1-SNAPSHOT</version>
+	<name>Spring AI Alibaba Text Summarizer Example</name>
+	<description>Spring AI Alibaba Text Summarizer Example</description>
+
+	<properties>
+		<maven.compiler.source>17</maven.compiler.source>
+		<maven.compiler.target>17</maven.compiler.target>
+		<maven-deploy-plugin.version>3.1.1</maven-deploy-plugin.version>
+	</properties>
+
+	<dependencies>
+		<dependency>
+			<groupId>com.alibaba.cloud.ai</groupId>
+			<artifactId>spring-ai-alibaba-starter</artifactId>
+			<version>${spring-ai-alibaba.version}</version>
+		</dependency>
+
+		<dependency>
+			<groupId>org.springframework.boot</groupId>
+			<artifactId>spring-boot-starter-web</artifactId>
+		</dependency>
+
+		<dependency>
+			<groupId>org.springframework.ai</groupId>
+			<artifactId>spring-ai-tika-document-reader</artifactId>
+		</dependency>
+	</dependencies>
+
+	<build>
+		<plugins>
+			<plugin>
+				<groupId>org.springframework.boot</groupId>
+				<artifactId>spring-boot-maven-plugin</artifactId>
+			</plugin>
+			<plugin>
+				<groupId>org.apache.maven.plugins</groupId>
+				<artifactId>maven-deploy-plugin</artifactId>
+				<version>${maven-deploy-plugin.version}</version>
+				<configuration>
+					<skip>true</skip>
+				</configuration>
+			</plugin>
+		</plugins>
+	</build>
+
+	<repositories>
+		<repository>
+			<id>spring-milestones</id>
+			<name>Spring Milestones</name>
+			<url>https://repo.spring.io/milestone</url>
+			<snapshots>
+				<enabled>false</enabled>
+			</snapshots>
+		</repository>
+	</repositories>
+
+</project>

spring-ai-alibaba-sql-example/src/main/java/com/alibaba/example/sql/SQLApplication.java

@@ -0,0 +1,14 @@
+package com.alibaba.example.summarizer;
+
+import org.springframework.boot.SpringApplication;
+import org.springframework.boot.autoconfigure.SpringBootApplication;
+
+@SpringBootApplication
+public class SQLApplication {
+
+	public static void main(String[] args) {
+
+		SpringApplication.run(SQLApplication.class, args);
+	}
+
+}

spring-ai-alibaba-sql-example/src/main/java/com/alibaba/example/sql/SQLGenerationException.java

@@ -0,0 +1,8 @@
+package com.alibaba.example.summarizer;
+
+public class SQLGenerationException extends RuntimeException {
+
+	public SQLGenerationException(String response) {
+		super(response);
+	}
+}

spring-ai-alibaba-sql-example/src/main/java/com/alibaba/example/sql/SQLGenerationExceptionHandler.java

@@ -0,0 +1,20 @@
+package com.alibaba.example.summarizer;
+
+import org.springframework.http.HttpStatus;
+import org.springframework.http.ProblemDetail;
+import org.springframework.web.bind.annotation.ExceptionHandler;
+import org.springframework.web.bind.annotation.RestControllerAdvice;
+
+@RestControllerAdvice
+public class SQLGenerationExceptionHandler {
+
+	@ExceptionHandler(SQLGenerationException.class)
+	public ProblemDetail handle(SQLGenerationException ex) {
+
+		return ProblemDetail.forStatusAndDetail(
+				HttpStatus.EXPECTATION_FAILED,
+				ex.getMessage()
+		);
+	}
+
+}

spring-ai-alibaba-sql-example/src/main/java/com/alibaba/example/sql/controller/SQLController.java

@@ -0,0 +1,69 @@
+package com.alibaba.example.summarizer.controller;
+
+import java.io.IOException;
+import java.nio.charset.Charset;
+import java.util.List;
+import java.util.Map;
+
+import com.alibaba.example.summarizer.SQLGenerationException;
+
+import org.springframework.ai.chat.client.ChatClient;
+import org.springframework.beans.factory.annotation.Value;
+import org.springframework.core.io.Resource;
+import org.springframework.jdbc.core.JdbcTemplate;
+import org.springframework.web.bind.annotation.PostMapping;
+import org.springframework.web.bind.annotation.RequestBody;
+import org.springframework.web.bind.annotation.RestController;
+
+@RestController
+public class SQLController {
+
+	@Value("classpath:/schema.sql")
+	private Resource ddlResource;
+
+	@Value("classpath:/sql-prompt-template.st")
+	private Resource sqlPromptTemplateResource;
+
+	private final ChatClient chatClient;
+	private final JdbcTemplate jdbcTemplate;
+
+	public SQLController(
+			ChatClient.Builder aiClientBuilder,
+			JdbcTemplate jdbcTemplate
+	) {
+
+		this.chatClient = aiClientBuilder.build();
+		this.jdbcTemplate = jdbcTemplate;
+	}
+
+	@PostMapping(path = "/sql")
+	public Answer sql(@RequestBody SqlRequest sqlRequest) throws IOException {
+
+		String schema = ddlResource.getContentAsString(Charset.defaultCharset());
+
+		String query = chatClient.prompt()
+				.user(userSpec -> userSpec
+						.text(sqlPromptTemplateResource)
+						.param("question", sqlRequest.question())
+						.param("ddl", schema)
+				)
+				.call()
+				.content();
+
+		assert query != null;
+		if (query.toLowerCase().startsWith("select")) {
+
+			return new Answer(
+					query,
+					jdbcTemplate.queryForList(query)
+			);
+		}
+
+		throw new SQLGenerationException(query);
+	}
+
+	public record SqlRequest(String question) { }
+
+	public record Answer(String sqlQuery, List<Map<String, Object>> results) { }
+
+}

spring-ai-alibaba-sql-example/src/main/resources/application.yml

@@ -0,0 +1,14 @@
+server:
+  port: 10091
+
+spring:
+  application:
+    name: spring-ai-alibaba-text-summarizer-example
+
+  ai:
+    dashscope:
+      api-key: ${AI_DASHSCOPE_API_KEY}
+
+  servlet:
+    multipart:
+      max-file-size: 5MB

spring-ai-alibaba-sql-example/src/main/resources/data.sql

@@ -0,0 +1,14 @@
+Given the DDL in the DDL section, write an SQL query to answer the question in the QUESTION section.
+Only produce select queries. If the question would result in an insert, update,
+or delete, or if the query would alter the DDL in any way, say that the operation
+isn't supported. If the question can't be answered, say that the DDL doesn't support
+answering that question.
+
+Answer with the raw SQL query only; no markdown or other punctuation that isn't part of the query itself.
+
+
+QUESTION
+{question}
+
+DDL
+{ddl}