Merge pull request #9 from chickenlj/1.0.0-M2-release

Prepare for 1.0.0-M2 release

.github/ISSUE_TEMPLATE/bug_report.md

@@ -35,4 +35,4 @@ If applicable, add screenshots to help explain your problem.
 
 **Additional context**
 Add any other context about the problem here.
-e.g.  MacOS  、Java17 、 Version 1.0.0-SNAPSHOT
+e.g.  MacOS  、Java17 、 Version 1.0.0-M2

README-zh.md

@@ -11,7 +11,7 @@
 <dependency>
 	<groupId>com.alibaba.ai</groupId>
 	<artifactId>spring-ai-alibaba-starter</artifactId>
-	<version>1.0.0-SNAPSHOT</version>
+	<version>1.0.0-M2</version>
 </dependency>
 ```
 

README.md

@@ -15,7 +15,7 @@ Overall, it takes only two steps to turn your Spring Boot application into an in
 <dependency>
 	<groupId>com.alibaba.ai</groupId>
 	<artifactId>spring-ai-alibaba-starter</artifactId>
-	<version>1.0.0-SNAPSHOT</version>
+	<version>1.0.0-M2</version>
 </dependency>
 ```
 
@@ -41,6 +41,17 @@ public class ChatController {
 }
 ```
 
+## Examples
+More examples can be found at [spring-ai-alibaba-examples](./spring-ai-alibaba-examples).
+
+* Hello World
+* Chat Model
+* Function Calling
+* Structured Output
+* Prompt
+* RAG
+* Flight Booking Playground, an advanced example showcasing usage of prompt template, function calling, chat memory and rag at the same time.
+
 ## Core Features
 
 Spring AI Alibaba provides the following features, read the [documentation](https://sca.aliyun.com/ai) on our website for more details of how to use these features.

pom.xml

@@ -20,7 +20,7 @@
 	</modules>
 
 	<properties>
-		<revision>1.0.0-SNAPSHOT</revision>
+		<revision>1.0.0-M2</revision>
 
 		<project.build.sourceEncoding>UTF-8</project.build.sourceEncoding>
 		<project.reporting.outputEncoding>UTF-8</project.reporting.outputEncoding>
@@ -120,13 +120,6 @@
 			<organizationUrl>https://aliyun.com</organizationUrl>
 		</developer>
 	</developers>
-	<distributionManagement>
-		<snapshotRepository>
-			<id>sonatype-nexus-snapshots</id>
-			<name>Sonatype Nexus Snapshots</name>
-			<url>https://oss.sonatype.org/content/repositories/snapshots/</url>
-		</snapshotRepository>
-	</distributionManagement>
 
 	<build>
 		<plugins>
@@ -181,20 +174,6 @@
 					</archive>
 				</configuration>
 			</plugin>
-			<plugin>
-				<groupId>org.apache.maven.plugins</groupId>
-				<artifactId>maven-source-plugin</artifactId>
-				<version>${maven-source-plugin.version}</version>
-				<executions>
-					<execution>
-						<id>generate-sources</id>
-						<phase>package</phase>
-						<goals>
-							<goal>jar</goal>
-						</goals>
-					</execution>
-				</executions>
-			</plugin>
 			<plugin>
 				<groupId>org.codehaus.mojo</groupId>
 				<artifactId>flatten-maven-plugin</artifactId>
@@ -266,7 +245,7 @@
 								<licenseSet>
 									<inlineHeader>
 										<!-- @formatter:off -->
-										Copyright 2023 - ${year} the original author or authors.
+										Copyright 2024 - ${year} 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.
@@ -425,6 +404,9 @@
 						<groupId>org.apache.maven.plugins</groupId>
 						<artifactId>maven-javadoc-plugin</artifactId>
 						<version>${maven-javadoc-plugin.version}</version>
+						<configuration>
+							<doclint>all,-missing</doclint>
+						</configuration>
 						<executions>
 							<execution>
 								<phase>package</phase>

spring-ai-alibaba-core/pom.xml

@@ -13,6 +13,12 @@
 	<artifactId>spring-ai-alibaba-core</artifactId>
 	<name>Spring AI Alibaba Core</name>
 	<packaging>jar</packaging>
+	<url>https://github.com/alibaba/spring-ai-alibaba</url>
+	<scm>
+		<url>https://github.com/alibaba/spring-ai-alibaba</url>
+		<connection>git://github.com/alibaba/spring-ai-alibaba.git</connection>
+		<developerConnection>[email protected]:alibaba/spring-ai-alibaba.git</developerConnection>
+	</scm>
 
 	<dependencies>
 		<dependency>

spring-ai-alibaba-core/src/main/java/com/alibaba/cloud/ai/autoconfigure/dashscope/DashScopeAutoConfiguration.java

@@ -66,7 +66,7 @@
 /**
  * @author nuocheng.lxm
  * @author yuluo
- * @date 2024/8/16 11:45
+ * @since 2024/8/16 11:45
  */
 @AutoConfiguration(after = { RestClientAutoConfiguration.class, WebClientAutoConfiguration.class,
 		SpringAiRetryAutoConfiguration.class })

spring-ai-alibaba-core/src/main/java/com/alibaba/cloud/ai/dashscope/api/ApiUtils.java

@@ -28,7 +28,7 @@
 
 /**
  * @author nuocheng.lxm
- * @date 2024/7/23 17:53
+ * @since 2024/7/23 17:53
  */
 public class ApiUtils {
 

spring-ai-alibaba-core/src/main/java/com/alibaba/cloud/ai/dashscope/api/DashScopeAgentApi.java

@@ -33,7 +33,7 @@
 
 /**
  * @author linkesheng.lks
- * @date 2024/8/30 15:17
+ * @since 2024/8/30 15:17
  */
 public class DashScopeAgentApi {
 

spring-ai-alibaba-core/src/main/java/com/alibaba/cloud/ai/dashscope/api/DashScopeApi.java

@@ -39,7 +39,7 @@
 /**
  * @author nuocheng.lxm
  * @author yuluo
- * @date 2024/7/31 14:15
+ * @since 2024/7/31 14:15
  */
 public class DashScopeApi {
 

spring-ai-alibaba-core/src/main/java/com/alibaba/cloud/ai/dashscope/api/DashScopeImageApi.java

@@ -31,7 +31,7 @@
 
 /**
  * @author nuocheng.lxm
- * @date 2024/7/31 14:15
+ * @since 2024/7/31 14:15
  */
 public class DashScopeImageApi {
 

spring-ai-alibaba-core/src/main/java/com/alibaba/cloud/ai/dashscope/audio/speech/AudioSpeechModels.java

@@ -29,7 +29,8 @@
 public final class AudioSpeechModels {
 
 	/**
-	 * Male Voice of the Tongue(舌尖男声). zh & en. Default sample rate: 48 Hz.
+	 * Male Voice of the Tongue(舌尖男声), support for both zh and en. Default sample rate: 48
+	 * Hz.
 	 */
 	public static final String SAMBERT_ZHICHU_V1 = "sambert-zhichu-v1";
 

spring-ai-alibaba-core/src/main/java/com/alibaba/cloud/ai/dashscope/common/DashScopeApiConstants.java

@@ -18,7 +18,7 @@
 
 /**
  * @author nuocheng.lxm
- * @date 2024/7/23 16:01
+ * @since 2024/7/23 16:01
  */
 public final class DashScopeApiConstants {
 

spring-ai-alibaba-core/src/main/java/com/alibaba/cloud/ai/dashscope/common/DashScopeException.java

@@ -18,7 +18,7 @@
 
 /**
  * @author nuocheng.lxm
- * @date 2024/7/24 11:37
+ * @since 2024/7/24 11:37
  */
 public class DashScopeException extends RuntimeException {
 

spring-ai-alibaba-core/src/main/java/com/alibaba/cloud/ai/dashscope/common/ErrorCodeEnum.java

@@ -18,7 +18,7 @@
 
 /**
  * @author nuocheng.lxm
- * @date 2024/7/24 11:39
+ * @since 2024/7/24 11:39
  */
 public enum ErrorCodeEnum {
 

spring-ai-alibaba-core/src/main/java/com/alibaba/cloud/ai/dashscope/common/IdGenerator.java

@@ -18,7 +18,7 @@
 
 /**
  * @author nuocheng.lxm
- * @date 2024/8/6 10:47
+ * @since 2024/8/6 10:47
  */
 public interface IdGenerator {
 

spring-ai-alibaba-core/src/main/java/com/alibaba/cloud/ai/dashscope/common/RequestIdGenerator.java

@@ -20,7 +20,7 @@
 
 /**
  * @author nuocheng.lxm
- * @date 2024/8/6 10:47
+ * @since 2024/8/6 10:47
  */
 public class RequestIdGenerator implements IdGenerator {
 

spring-ai-alibaba-core/src/main/java/com/alibaba/cloud/ai/dashscope/embedding/DashScopeEmbeddingModel.java

@@ -45,7 +45,7 @@
  * @author why_ohh
  * @author yuluo
  * @author <a href="mailto:[email protected]">why_ohh</a>
- * @date 2024/7/31 10:57
+ * @since 2024/7/31 10:57
  */
 public class DashScopeEmbeddingModel extends AbstractEmbeddingModel {
 

spring-ai-alibaba-core/src/main/java/com/alibaba/cloud/ai/dashscope/embedding/DashScopeEmbeddingOptions.java

@@ -26,7 +26,7 @@
  * @author why_ohh
  * @author yuluo
  * @author <a href="mailto:[email protected]">why_ohh</a>
- * @date 2024/8/1 11:14
+ * @since 2024/8/1 11:14
  */
 @JsonInclude(JsonInclude.Include.NON_NULL)
 public class DashScopeEmbeddingOptions implements EmbeddingOptions {

spring-ai-alibaba-core/src/main/java/com/alibaba/cloud/ai/dashscope/image/DashScopeImageModel.java

@@ -15,7 +15,7 @@
 /**
  * @author nuocheng.lxm
  * @author yuluo
- * @date 2024/8/16 11:29
+ * @since 2024/8/16 11:29
  */
 public class DashScopeImageModel implements ImageModel {
 

spring-ai-alibaba-core/src/main/java/com/alibaba/cloud/ai/dashscope/image/DashScopeImageOptions.java

@@ -24,7 +24,7 @@
 /**
  * @author nuocheng.lxm
  * @author yuluo
- * @date 2024/8/16 11:29
+ * @since 2024/8/16 11:29
  */
 @JsonInclude(JsonInclude.Include.NON_NULL)
 public class DashScopeImageOptions implements ImageOptions {

spring-ai-alibaba-core/src/main/java/com/alibaba/cloud/ai/dashscope/rag/DashScopeCloudStore.java

@@ -33,7 +33,7 @@
 
 /**
  * @author nuocheng.lxm
- * @date 2024/8/6 15:42
+ * @since 2024/8/6 15:42
  */
 public class DashScopeCloudStore implements VectorStore {
 

spring-ai-alibaba-core/src/main/java/com/alibaba/cloud/ai/dashscope/rag/DashScopeDocumentCloudReader.java

@@ -35,7 +35,7 @@
 
 /**
  * @author nuocheng.lxm
- * @date 2024/7/22 14:40 百炼云端文档解析，主要是走当前数据中心逻辑
+ * @since 2024/7/22 14:40 百炼云端文档解析，主要是走当前数据中心逻辑
  *
  */
 public class DashScopeDocumentCloudReader implements DocumentReader {

spring-ai-alibaba-core/src/main/java/com/alibaba/cloud/ai/dashscope/rag/DashScopeDocumentCloudReaderOptions.java

@@ -21,7 +21,7 @@
 
 /**
  * @author nuocheng.lxm
- * @date 2024/7/22 15:14 百炼文档解析相关配置项
+ * @since 2024/7/22 15:14 百炼文档解析相关配置项
  */
 @JsonInclude(JsonInclude.Include.NON_NULL)
 public class DashScopeDocumentCloudReaderOptions {

spring-ai-alibaba-core/src/main/java/com/alibaba/cloud/ai/dashscope/rag/DashScopeDocumentRetriever.java

@@ -27,7 +27,7 @@
 
 /**
  * @author nuocheng.lxm
- * @date 2024/8/5 14:42
+ * @since 2024/8/5 14:42
  */
 public class DashScopeDocumentRetriever implements DocumentRetriever {
 

spring-ai-alibaba-core/src/main/java/com/alibaba/cloud/ai/dashscope/rag/DashScopeDocumentRetrieverOptions.java

@@ -21,7 +21,7 @@
 
 /**
  * @author nuocheng.lxm
- * @date 2024/8/6 11:04
+ * @since 2024/8/6 11:04
  */
 @JsonInclude(JsonInclude.Include.NON_NULL)
 public class DashScopeDocumentRetrieverOptions {

spring-ai-alibaba-core/src/main/java/com/alibaba/cloud/ai/dashscope/rag/DashScopeDocumentTransformer.java

@@ -33,7 +33,7 @@
 
 /**
  * @author nuocheng.lxm
- * @date 2024/8/6 16:19
+ * @since 2024/8/6 16:19
  */
 public class DashScopeDocumentTransformer implements DocumentTransformer {
 

spring-ai-alibaba-core/src/main/java/com/alibaba/cloud/ai/dashscope/rag/DashScopeDocumentTransformerOptions.java

@@ -21,7 +21,7 @@
 
 /**
  * @author nuocheng.lxm
- * @date 2024/8/6 16:21
+ * @since 2024/8/6 16:21
  */
 @JsonInclude(JsonInclude.Include.NON_NULL)
 public class DashScopeDocumentTransformerOptions {

spring-ai-alibaba-core/src/main/java/com/alibaba/cloud/ai/dashscope/rag/DashScopeStoreOptions.java

@@ -22,7 +22,7 @@
 
 /**
  * @author nuocheng.lxm
- * @date 2024/8/9 10:00
+ * @since 2024/8/9 10:00
  */
 @JsonInclude(JsonInclude.Include.NON_NULL)
 public class DashScopeStoreOptions {

spring-ai-alibaba-examples/README.md

@@ -0,0 +1,9 @@
+This directory contains examples demonstrating basic and advanced usages of Spring AI Alibaba.
+
+* Hello World
+* Chat Model
+* Function Calling
+* Structured Output
+* Prompt
+* RAG
+* Flight Booking Playground, an advanced example showcasing usage of prompt template, function calling, chat memory and rag at the same time.

spring-ai-alibaba-examples/chatmodel-example/pom.xml

@@ -10,7 +10,7 @@
 	</parent>
 	<groupId>com.alibaba.cloud.ai</groupId>
 	<artifactId>chatmodel-example</artifactId>
-	<version>1.0.0-SNAPSHOT</version>
+	<version>1.0.0-M2</version>
 	<name>chatmodel-example</name>
 	<description>Demo project for Spring AI Alibaba</description>
 
@@ -22,7 +22,7 @@
 		<maven-deploy-plugin.version>3.1.1</maven-deploy-plugin.version>
 
 		<!-- Spring AI -->
-		<spring-ai-alibaba.version>1.0.0-SNAPSHOT</spring-ai-alibaba.version>
+		<spring-ai-alibaba.version>1.0.0-M2</spring-ai-alibaba.version>
 	</properties>
 
 	<dependencies>

spring-ai-alibaba-examples/function-calling-example/pom.xml

@@ -10,7 +10,7 @@
 	</parent>
 	<groupId>com.alibaba.cloud.ai</groupId>
 	<artifactId>function-calling-example</artifactId>
-	<version>1.0.0-SNAPSHOT</version>
+	<version>1.0.0-M2</version>
 	<name>function-calling-example</name>
 	<description>Demo project for Spring AI Alibaba</description>
 
@@ -22,7 +22,7 @@
 		<maven-deploy-plugin.version>3.1.1</maven-deploy-plugin.version>
 
 		<!-- Spring AI -->
-		<spring-ai-alibaba.version>1.0.0-SNAPSHOT</spring-ai-alibaba.version>
+		<spring-ai-alibaba.version>1.0.0-M2</spring-ai-alibaba.version>
 	</properties>
 
 	<dependencies>
@@ -37,11 +37,6 @@
 			<artifactId>spring-boot-starter-web</artifactId>
 		</dependency>
 
-		<dependency>
-			<groupId>org.springframework.boot</groupId>
-			<artifactId>spring-boot-starter-webflux</artifactId>
-			<scope>optional</scope>
-		</dependency>
 	</dependencies>
 
 	<build>