Add Spring Boot Project Starter for Google Gemini API model - ChatLangauge, Streaming model and Embedding Model

.github/workflows/main.yaml

@@ -34,6 +34,7 @@ jobs:
           AZURE_SEARCH_ENDPOINT: ${{ secrets.AZURE_SEARCH_ENDPOINT }}
           AZURE_SEARCH_KEY: ${{ secrets.AZURE_SEARCH_KEY }}
           GITHUB_TOKEN: ${{ secrets.GITHUB_TOKEN }}
+          GOOGLE_AI_GEMINI_API_KEY: ${{secrets.GOOGLE_AI_GEMINI_API_KEY}}
           OPENAI_API_KEY: ${{ secrets.OPENAI_API_KEY }}
           VOYAGE_API_KEY: ${{ secrets.VOYAGE_API_KEY }}
           OSSRH_USERNAME: ${{ secrets.OSSRH_USERNAME }}
@@ -50,4 +51,4 @@ jobs:
           distribution: 'temurin'
           cache: 'maven'
       - name: License Compliance
-        run: mvn -U -P compliance org.honton.chas:license-maven-plugin:compliance
+        run: mvn -U -P compliance org.honton.chas:license-maven-plugin:compliance

.github/workflows/release.yaml

@@ -33,6 +33,7 @@ jobs:
           AZURE_SEARCH_ENDPOINT: ${{ secrets.AZURE_SEARCH_ENDPOINT }}
           AZURE_SEARCH_KEY: ${{ secrets.AZURE_SEARCH_KEY }}
           GITHUB_TOKEN: ${{ secrets.GITHUB_TOKEN }}
+          GOOGLE_AI_GEMINI_API_KEY: ${{secrets.GOOGLE_AI_GEMINI_API_KEY}}
           OPENAI_API_KEY: ${{ secrets.OPENAI_API_KEY }}
           VOYAGE_API_KEY: ${{ secrets.VOYAGE_API_KEY }}
           GPG_PASSPHRASE: ${{ secrets.GPG_PASSPHRASE }}

.gitignore

@@ -2,6 +2,7 @@ target/
 
 ### IntelliJ IDEA ###
 .idea/*
+**/.idea/
 .idea/modules.xml
 .idea/jarRepositories.xml
 .idea/compiler.xml

langchain4j-google-ai-gemini-spring-boot-starter/pom.xml

@@ -0,0 +1,63 @@
+<?xml version="1.0" encoding="UTF-8"?>
+<project xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance"
+         xmlns="http://maven.apache.org/POM/4.0.0"
+         xsi:schemaLocation="http://maven.apache.org/POM/4.0.0 http://maven.apache.org/xsd/maven-4.0.0.xsd">
+    <modelVersion>4.0.0</modelVersion>
+
+    <parent>
+        <groupId>dev.langchain4j</groupId>
+        <artifactId>langchain4j-spring</artifactId>
+        <version>0.37.0-SNAPSHOT</version>
+        <relativePath>../pom.xml</relativePath>
+    </parent>
+
+    <artifactId>langchain4j-google-ai-gemini-spring-boot-starter</artifactId>
+    <name>LangChain4j Spring Boot starter for Google AI Gemini</name>
+    <packaging>jar</packaging>
+
+    <dependencies>
+
+        <dependency>
+            <groupId>dev.langchain4j</groupId>
+            <artifactId>langchain4j-google-ai-gemini</artifactId>
+            <version>${project.version}</version>
+        </dependency>
+
+        <dependency>
+            <groupId>org.springframework.boot</groupId>
+            <artifactId>spring-boot-starter</artifactId>
+        </dependency>
+
+        <dependency>
+            <groupId>org.springframework.boot</groupId>
+            <artifactId>spring-boot-autoconfigure-processor</artifactId>
+            <optional>true</optional>
+        </dependency>
+
+        <!-- needed to generate automatic metadata about available config properties -->
+        <dependency>
+            <groupId>org.springframework.boot</groupId>
+            <artifactId>spring-boot-configuration-processor</artifactId>
+            <optional>true</optional>
+        </dependency>
+
+        <dependency>
+            <groupId>org.springframework.boot</groupId>
+            <artifactId>spring-boot-starter-test</artifactId>
+            <scope>test</scope>
+        </dependency>
+
+
+
+    </dependencies>
+
+    <licenses>
+        <license>
+            <name>Apache-2.0</name>
+            <url>https://www.apache.org/licenses/LICENSE-2.0.txt</url>
+            <distribution>repo</distribution>
+            <comments>A business-friendly OSS license</comments>
+        </license>
+    </licenses>
+
+</project>

langchain4j-google-ai-gemini-spring-boot-starter/src/main/java/dev/langchain4j/googleaigemini/spring/AutoConfig.java

@@ -0,0 +1,94 @@
+package dev.langchain4j.googleaigemini.spring;
+
+import dev.langchain4j.model.googleai.GoogleAiEmbeddingModel;
+import dev.langchain4j.model.googleai.GoogleAiGeminiChatModel;
+import dev.langchain4j.model.googleai.GoogleAiGeminiStreamingChatModel;
+import org.springframework.boot.autoconfigure.AutoConfiguration;
+import org.springframework.boot.autoconfigure.condition.ConditionalOnProperty;
+import org.springframework.boot.context.properties.EnableConfigurationProperties;
+import org.springframework.context.annotation.Bean;
+
+import java.util.Map;
+
+import static dev.langchain4j.googleaigemini.spring.Properties.PREFIX;
+
+@AutoConfiguration
+@EnableConfigurationProperties(Properties.class)
+public class AutoConfig {
+
+    @Bean
+    @ConditionalOnProperty({
+            PREFIX + ".chat-model.api-key",
+            PREFIX + ".chat-model.model-name"
+    })
+    GoogleAiGeminiChatModel googleAiGeminiChatModel(Properties properties) {
+        ChatModelProperties chatModelProperties = properties.getChatModel();
+        return GoogleAiGeminiChatModel.builder()
+                .apiKey(chatModelProperties.apiKey())
+                .modelName(chatModelProperties.modelName())
+                .temperature(chatModelProperties.temperature())
+                .topP(chatModelProperties.topP())
+                .topK(chatModelProperties.topK())
+                .maxOutputTokens(chatModelProperties.maxOutputTokens())
+                .responseFormat(chatModelProperties.responseFormat())
+                .logRequestsAndResponses(chatModelProperties.logRequestsAndResponses())
+                .safetySettings(Map.of(
+                        // TODO NPE?
+                        chatModelProperties.safetySetting().geminiHarmCategory(),
+                        chatModelProperties.safetySetting().geminiHarmBlockThreshold()
+                ))
+                .toolConfig(
+                        // TODO NPE?
+                        chatModelProperties.functionCallingConfig().geminiMode(),
+                        chatModelProperties.functionCallingConfig().allowedFunctionNames().toArray(new String[0])
+                )
+                .build();
+    }
+
+    @Bean
+    @ConditionalOnProperty({
+            PREFIX + ".streaming-chat-model.api-key",
+            PREFIX + ".streaming-chat-model.model-name"
+    })
+    GoogleAiGeminiStreamingChatModel googleAiGeminiStreamingChatModel(Properties properties) {
+        ChatModelProperties chatModelProperties = properties.getStreamingChatModel();
+        return GoogleAiGeminiStreamingChatModel.builder()
+                .apiKey(chatModelProperties.apiKey())
+                .modelName(chatModelProperties.modelName())
+                .temperature(chatModelProperties.temperature())
+                .topP(chatModelProperties.topP())
+                .topK(chatModelProperties.topK())
+                .responseFormat(chatModelProperties.responseFormat())
+                .logRequestsAndResponses(chatModelProperties.logRequestsAndResponses())
+                .safetySettings(Map.of(
+                        // TODO NPE?
+                        chatModelProperties.safetySetting().geminiHarmCategory(),
+                        chatModelProperties.safetySetting().geminiHarmBlockThreshold()
+                ))
+                .toolConfig(
+                        // TODO NPE?
+                        chatModelProperties.functionCallingConfig().geminiMode(),
+                        chatModelProperties.functionCallingConfig().allowedFunctionNames().toArray(new String[0])
+                )
+                .build();
+    }
+
+    @Bean
+    @ConditionalOnProperty({
+            PREFIX + ".embedding-model.api-key",
+            PREFIX + ".embedding-model.model-name"
+    })
+    GoogleAiEmbeddingModel googleAiEmbeddingModel(Properties properties) {
+        EmbeddingModelProperties embeddingModelProperties = properties.getEmbeddingModel();
+        return GoogleAiEmbeddingModel.builder()
+                .apiKey(embeddingModelProperties.apiKey())
+                .modelName(embeddingModelProperties.modelName())
+                .logRequestsAndResponses(embeddingModelProperties.logRequestsAndResponses())
+                .maxRetries(embeddingModelProperties.maxRetries())
+                .outputDimensionality(embeddingModelProperties.outputDimensionality())
+                .taskType(embeddingModelProperties.taskType())
+                .timeout(embeddingModelProperties.timeout())
+                .titleMetadataKey(embeddingModelProperties.titleMetadataKey())
+                .build();
+    }
+}

langchain4j-google-ai-gemini-spring-boot-starter/src/main/java/dev/langchain4j/googleaigemini/spring/ChatModelProperties.java

@@ -0,0 +1,21 @@
+package dev.langchain4j.googleaigemini.spring;
+
+import dev.langchain4j.model.chat.request.ResponseFormat;
+
+import java.time.Duration;
+
+public record ChatModelProperties(
+        String apiKey,
+        String modelName,
+        Double temperature,
+        Double topP,
+        Integer topK,
+        Integer maxOutputTokens,
+        ResponseFormat responseFormat,
+        Boolean logRequestsAndResponses,
+        Integer maxRetries,
+        Duration timeout,
+        GeminiSafetySetting safetySetting,
+        GeminiFunctionCallingConfig functionCallingConfig
+) {
+}

langchain4j-google-ai-gemini-spring-boot-starter/src/main/java/dev/langchain4j/googleaigemini/spring/EmbeddingModelProperties.java

@@ -0,0 +1,17 @@
+package dev.langchain4j.googleaigemini.spring;
+
+import dev.langchain4j.model.googleai.GoogleAiEmbeddingModel.TaskType;
+
+import java.time.Duration;
+
+public record EmbeddingModelProperties(
+        String apiKey,
+        String modelName,
+        String titleMetadataKey,
+        Boolean logRequestsAndResponses,
+        Integer maxRetries,
+        Integer outputDimensionality,
+        TaskType taskType,
+        Duration timeout
+) {
+}

langchain4j-google-ai-gemini-spring-boot-starter/src/main/java/dev/langchain4j/googleaigemini/spring/GeminiFunctionCallingConfig.java

@@ -0,0 +1,11 @@
+package dev.langchain4j.googleaigemini.spring;
+
+import dev.langchain4j.model.googleai.GeminiMode;
+
+import java.util.List;
+
+public record GeminiFunctionCallingConfig(
+        GeminiMode geminiMode,
+        List<String> allowedFunctionNames
+) {
+}

langchain4j-google-ai-gemini-spring-boot-starter/src/main/java/dev/langchain4j/googleaigemini/spring/GeminiSafetySetting.java

@@ -0,0 +1,10 @@
+package dev.langchain4j.googleaigemini.spring;
+
+import dev.langchain4j.model.googleai.GeminiHarmBlockThreshold;
+import dev.langchain4j.model.googleai.GeminiHarmCategory;
+
+public record GeminiSafetySetting(
+        GeminiHarmCategory geminiHarmCategory,
+        GeminiHarmBlockThreshold geminiHarmBlockThreshold
+) {
+}

langchain4j-google-ai-gemini-spring-boot-starter/src/main/java/dev/langchain4j/googleaigemini/spring/Properties.java

@@ -0,0 +1,43 @@
+package dev.langchain4j.googleaigemini.spring;
+
+import org.springframework.boot.context.properties.ConfigurationProperties;
+import org.springframework.boot.context.properties.NestedConfigurationProperty;
+
+@ConfigurationProperties(prefix = Properties.PREFIX)
+public class Properties {
+
+    static final String PREFIX = "langchain4j.google-ai-gemini";
+
+    @NestedConfigurationProperty
+    private ChatModelProperties chatModel;
+
+    @NestedConfigurationProperty
+    private ChatModelProperties streamingChatModel;
+
+    @NestedConfigurationProperty
+    private EmbeddingModelProperties embeddingModel;
+
+    public EmbeddingModelProperties getEmbeddingModel() {
+        return embeddingModel;
+    }
+
+    public void setEmbeddingModel(EmbeddingModelProperties embeddingModel) {
+        this.embeddingModel = embeddingModel;
+    }
+
+    public ChatModelProperties getStreamingChatModel() {
+        return streamingChatModel;
+    }
+
+    public void setStreamingChatModel(ChatModelProperties streamingChatModel) {
+        this.streamingChatModel = streamingChatModel;
+    }
+
+    public ChatModelProperties getChatModel() {
+        return chatModel;
+    }
+
+    public void setChatModel(ChatModelProperties chatModel) {
+        this.chatModel = chatModel;
+    }
+}

langchain4j-google-ai-gemini-spring-boot-starter/src/main/resources/META-INF/spring/org.springframework.boot.autoconfigure.AutoConfiguration.imports

@@ -0,0 +1 @@
+dev.langchain4j.googleaigemini.spring.AutoConfig

langchain4j-google-ai-gemini-spring-boot-starter/src/test/java/dev/langchain4j/googleaigemini/spring/AutoConfigIT.java

@@ -0,0 +1,92 @@
+package dev.langchain4j.googleaigemini.spring;
+
+import dev.langchain4j.data.embedding.Embedding;
+import dev.langchain4j.data.message.AiMessage;
+import dev.langchain4j.model.StreamingResponseHandler;
+import dev.langchain4j.model.chat.ChatLanguageModel;
+import dev.langchain4j.model.chat.StreamingChatLanguageModel;
+import dev.langchain4j.model.embedding.EmbeddingModel;
+import dev.langchain4j.model.googleai.GoogleAiEmbeddingModel;
+import dev.langchain4j.model.googleai.GoogleAiGeminiChatModel;
+import dev.langchain4j.model.googleai.GoogleAiGeminiStreamingChatModel;
+import dev.langchain4j.model.output.Response;
+import org.junit.jupiter.api.Test;
+import org.springframework.boot.autoconfigure.AutoConfigurations;
+import org.springframework.boot.test.context.runner.ApplicationContextRunner;
+
+import java.util.concurrent.CompletableFuture;
+
+import static java.util.concurrent.TimeUnit.SECONDS;
+import static org.assertj.core.api.Assertions.assertThat;
+
+class AutoConfigIT {
+
+    private static final String API_KEY = System.getenv("GOOGLE_AI_GEMINI_API_KEY");
+
+    ApplicationContextRunner contextRunner = new ApplicationContextRunner()
+            .withConfiguration(AutoConfigurations.of(AutoConfig.class));
+
+    @Test
+    void provide_chat_model() {
+        contextRunner.withPropertyValues(
+                        "langchain4j.google-ai-gemini.chat-model.api-key=" + API_KEY,
+                        "langchain4j.google-ai-gemini.chat-model.model-name=gemini-1.5-flash"
+                )
+                .run(context -> {
+                    ChatLanguageModel chatLanguageModel = context.getBean(ChatLanguageModel.class);
+                    assertThat(context.getBean(GoogleAiGeminiChatModel.class)).isSameAs(chatLanguageModel);
+
+                    String response = chatLanguageModel.generate("What is the capital of India");
+                    assertThat(response).contains("Delhi");
+
+                    String newResponse = chatLanguageModel.generate("Calculate the Fibonacci of 22 and give me the result as an integer value along with the code. ");
+                    assertThat(newResponse).contains("17711");
+                });
+    }
+
+    @Test
+    void provide_streaming_chat_model() {
+        contextRunner.withPropertyValues(
+                        "langchain4j.google-ai-gemini.streaming-chat-model.api-key=" + API_KEY,
+                        "langchain4j.google-ai-gemini.streaming-chat-model.model-name=gemini-1.5-flash"
+                )
+                .run(context -> {
+                    StreamingChatLanguageModel streamingChatLanguageModel = context.getBean(StreamingChatLanguageModel.class);
+                    assertThat(context.getBean(GoogleAiGeminiStreamingChatModel.class)).isSameAs(streamingChatLanguageModel);
+
+                    CompletableFuture<Response<AiMessage>> future = new CompletableFuture<>();
+                    streamingChatLanguageModel.generate("What is the capital of India", new StreamingResponseHandler<>() {
+                        @Override
+                        public void onNext(String s) {
+                        }
+
+                        @Override
+                        public void onComplete(Response<AiMessage> response) {
+                            future.complete(response);
+                        }
+
+                        @Override
+                        public void onError(Throwable throwable) {
+                            future.completeExceptionally(throwable);
+                        }
+                    });
+
+                    Response<AiMessage> response = future.get(60, SECONDS);
+                    assertThat(response.content().text()).contains("Delhi");
+                });
+    }
+
+    @Test
+    void provide_embedding_model() {
+        contextRunner.withPropertyValues(
+                "langchain4j.google-ai-gemini.embedding-model.apiKey=" + API_KEY,
+                "langchain4j.google-ai-gemini.embedding-model.model-name=text-embedding-004"
+        ).run(context -> {
+            EmbeddingModel embeddingModel = context.getBean(EmbeddingModel.class);
+            assertThat(context.getBean(GoogleAiEmbeddingModel.class)).isSameAs(embeddingModel);
+
+            Response<Embedding> response = embeddingModel.embed("Hi, I live in India");
+            assertThat(response.content().dimension()).isEqualTo(768);
+        });
+    }
+}