Spring AI 初學

抱糖果彡發表於2024-05-27

SpringAI

Spring AI 初學

Spring AI 官方地址

”spring 不生產 AI，只是 AI 工具的搬運工“

專案可以檢視gitee

Open AI

前期準備

Open AI官方地址，需要使用魔法才能開啟，同時購買很麻煩，建議淘寶進行購買，只需要購買 open ai 的 apikey 即可。

apikey 形如 sk-xxxxxxxxxxxxxxxxx

專案建立

Idea 建立 SpringBoot Maven 專案（Spring AI基於1.0-SNAPSHOT版本，SpringBoot 3.2.6），依賴選擇Spring Web、 OpenAI。其他可以自行選擇

修改專案倉庫地址，中央倉庫暫時還沒 Spring AI 相關 jar 包。倉庫地址改成快照倉庫地址，官方說明

    <repository>
        <id>spring-snapshots</id>
        <name>Spring Snapshots</name>
        <url>https://repo.spring.io/snapshot</url>
        <releases>
            <enabled>false</enabled>
        </releases>
    </repository>

專案中找到 pom.xml 檔案，將 <spring-ai.version>0.8.1</spring-ai.version> 改為 <spring-ai.version>1.0.0-SNAPSHOT</spring-ai.version>

yaml 配置檔案中新增，openai 更多配置可以檢視 org.springframework.ai.autoconfigure.openai.OpenAiAutoConfiguration。

spring:
  ai:
    openai:
      # 購買的 api-key
      api-key: sk-xxxx
      # 如果是官方地址，則可以不填，預設為 https://api.openai.com
      base-url:

聊天

基礎使用

主要類 org.springframework.ai.openai.OpenAiChatModel，快照版本不同，可能名字不一樣，可以檢視 org.springframework.ai.autoconfigure.openai.OpenAiAutoConfiguration 中的聊天類是哪個。

import jakarta.annotation.Resource;
import org.junit.jupiter.api.Test;
import org.springframework.ai.openai.OpenAiChatModel;
import org.springframework.boot.test.context.SpringBootTest;

@SpringBootTest
public class ChatTest {

    @Resource
    private OpenAiChatModel chatModel;

    @Test
    public void chat1(){
        String msg = "你好";
        //返回string資料
        String res = chatModel.call(msg);
        System.out.println(res);
    }
    
    @Test
    public void chat2(){
        String msg = "你好";
        //返回物件
        ChatResponse res = chatModel.call(new Prompt(msg));
        System.out.println(res);
        //獲取對話返回結果
        System.out.println(res.getResult().getOutput().getContent());
    }

    /**
    * 流式返回資料，類似打字效果，一個詞一個json資料，整句話多個json資料
    */
    @Test
    public void chat3(){
        String msg = "你好";
        Prompt prompt = new Prompt(msg);
        Flux<ChatResponse> flux = chatModel.stream(prompt);
        flux.toStream().forEach(res -> {
            System.out.println(res.getResult().getOutput().getContent());
        });
    }
    
}

配置屬性

    @Test
    public void test3(){
        String msg = "你是誰";
        //採用 gpt-4-turbo 模型，配置屬性建立可以參考 OpenAiChatModel 建構函式
        OpenAiChatOptions options = OpenAiChatOptions.builder()
                .withModel("gpt-4-turbo")
                .build();
        ChatResponse res = chatModel.call(new Prompt(msg, options));
        System.out.println(res);
        //獲取對話返回結果
        System.out.println(res.getResult().getOutput().getContent());
    }

聊天模型配置屬性可以檢視 org.springframework.ai.autoconfigure.openai.OpenAiChatProperties，也可以在官網檢視更詳細的資訊。配置屬性也可以放在 yml 配置檔案中，如 OpenAiChatProperties 的註解，需要以 spring.ai.openai.chat 開頭，例如將 gpt-4-turbo 配置在配置檔案中，就是 OpenAiChatProperties 中 options 中的屬性。

spring:
  ai:
    openai:
      chat:
        options:
          model: gpt-4-turbo

多模型

可以配合圖片等讓聊天模型進行回答。

    //給圖片來進行聊天
    @Test
    public void test4() {
        //獲取圖片資源
        ClassPathResource resource = new ClassPathResource("2024052701.png");
        UserMessage userMessage = new UserMessage("說說你看到了什麼", 
                List.of(new Media(MimeTypeUtils.IMAGE_PNG, resource)));
        ChatResponse res = chatModel.call(new Prompt(userMessage, OpenAiChatOptions.builder()
                .withModel("gpt-4-turbo")
                .build()));
        System.out.println(res);
        //獲取回答
        System.out.println(res.getResult().getOutput().getContent());
    }

影像

基礎使用

主要類 org.springframework.ai.openai.OpenAiImageModel，快照版本不同，可能類不一樣。可以檢視 org.springframework.ai.autoconfigure.openai.OpenAiAutoConfiguration 中具體的影像類是哪個。

import jakarta.annotation.Resource;
import org.junit.jupiter.api.Test;
import org.springframework.ai.image.ImagePrompt;
import org.springframework.ai.image.ImageResponse;
import org.springframework.ai.openai.OpenAiImageModel;
import org.springframework.boot.test.context.SpringBootTest;

@SpringBootTest
public class ImageTest {

    @Resource
    private OpenAiImageModel imageModel;

    @Test
    public void test(){
        //呼叫 image 模型的 call 方法獲取圖片
        ImageResponse res = imageModel.call(new ImagePrompt("山水畫"));
        //AI 繪製的圖片路徑
        String url = res.getResult().getOutput().getUrl();
        System.out.println(url);
    }

}

配置屬性

    @Test
    public void test2(){
        //使用 dall-e-2 繪畫，配置屬性模型建立可以參考 OpenAiImageModel 建構函式
        OpenAiImageOptions options = OpenAiImageOptions.builder()
            .withModel(OpenAiImageApi.ImageModel.DALL_E_2.getValue())
            .build();
        ImageResponse res = imageModel.call(new ImagePrompt("山水畫", options));
        //獲取 AI 繪畫路徑
        String url = res.getResult().getOutput().getUrl();
        System.out.println(url);
    }

影像模型屬性配置可以檢視 org.springframework.ai.autoconfigure.openai.OpenAiImageProperties，也可以檢視官網獲取更詳細的資訊。當然配置屬性也可以在 yml 中定義，如 OpenAiImageProperties 上的註解，需要以 spring.ai.openai.image 開頭，例如使用 dall-e-2 模型進行繪畫

 spring:
  ai:
    openai:
      image:
        options:
          model: dall-e-2

語音

語音轉文字

基礎使用

主要類 org.springframework.ai.openai.OpenAiAudioTranscriptionModel，快照版本不同，可能名字不一樣，可以檢視 org.springframework.ai.autoconfigure.openai.OpenAiAutoConfiguration 中的語音轉文字翻譯類是哪個。

import jakarta.annotation.Resource;
import org.junit.jupiter.api.Test;
import org.springframework.ai.openai.OpenAiAudioTranscriptionModel;
import org.springframework.boot.test.context.SpringBootTest;
import org.springframework.core.io.ClassPathResource;

@SpringBootTest
public class AudioTest {

    //語音轉文字
    @Resource
    private OpenAiAudioTranscriptionModel transcriptionModel;

    @Test
    public void testTranscription1(){
        String res = transcriptionModel.call(new ClassPathResource("2024052702.mp3"));
        System.out.println(res);
    }

}

配置屬性

    @Test
    public void testTranscription2(){
        //建立模型屬性，採用 whisper-1 語音模型，配置屬性建立可以參考 OpenAiAudioTranscriptionModel 建構函式
        OpenAiAudioTranscriptionOptions options = new OpenAiAudioTranscriptionOptions().builder()
                .withModel(OpenAiAudioApi.WhisperModel.WHISPER_1.getValue())
                .build();
        AudioTranscriptionResponse res = transcriptionModel.call(
            new AudioTranscriptionPrompt(new ClassPathResource("2024052702.mp3"), options));
        //獲取翻譯內容
        String output = res.getResult().getOutput();
        System.out.println(output);
    }

語音轉文字模型屬性可以檢視 org.springframework.ai.autoconfigure.openai.OpenAiAudioTranscriptionProperties，也可以在官網檢視更詳細資訊。當然可以在 yml 配置中配置屬性，如 OpenAiAudioTranscriptionProperties 上的註解，以 spring.ai.openai.audio.transcription 開頭，例如採用 whisper-1 模型

spring:
  ai:
    openai:
      audio:
        transcription:
          options:
            model: whisper-1

文字轉語音

基礎使用

主要類 org.springframework.ai.openai.OpenAiAudioSpeechModel，快照版本不同，可能名字不一樣，可以檢視 org.springframework.ai.autoconfigure.openai.OpenAiAutoConfiguration 中的文字轉語音類是哪個。

import jakarta.annotation.Resource;
import org.junit.jupiter.api.Test;
import org.springframework.ai.openai.OpenAiAudioSpeechModel;
import org.springframework.boot.test.context.SpringBootTest;
import java.io.FileOutputStream;
import java.io.IOException;

@SpringBootTest
public class AudioTest2 {

    @Resource
    private OpenAiAudioSpeechModel speechModel;

    //byte陣列轉檔案
    private void byteArrayToFile(byte[] byteArray, String filePath) throws IOException {
        FileOutputStream fos = new FileOutputStream(filePath);
        fos.write(byteArray);
        fos.close();
    }

    @Test
    public void testSpeech() throws IOException {
        byte[] res = speechModel.call("我愛北京");
        byteArrayToFile(res,"D:\\project\\AI\\openai\\speech\\1.mp3");
    }

}

屬性配置

    @Test
    public void testSpeech2() throws IOException {
        //採用 tts-1-hd 模型，配置屬性建立可以參考 OpenAiAudioSpeechModel 建構函式
        OpenAiAudioSpeechOptions options = new OpenAiAudioSpeechOptions().builder()
                .withModel(OpenAiAudioApi.TtsModel.TTS_1_HD.getValue())
                .build();
        SpeechPrompt prompt = new SpeechPrompt("我愛北京", options);
        SpeechResponse res = speechModel.call(prompt);
        byte[] bytes = res.getResult().getOutput();
        byteArrayToFile(bytes,"D:\\project\\AI\\openai\\speech\\1-hd.mp3");
    }

文字轉語音模型屬性可以檢視 org.springframework.ai.autoconfigure.openai.OpenAiAudioSpeechProperties，也可以在官網檢視更詳細資訊。當然可以在 yml 配置中配置屬性，如 OpenAiAudioSpeechProperties 上的註解，以 spring.ai.openai.audio.speech 開頭，例如採用 tts-1-hd 模型

spring:
  ai:
    openai:
      audio:
        speech:
          options:
            model: tts-1-hd

ollama

安裝 ollama

ollama 官網提供了下載地址，可以自己選擇版本安裝。ollama 主要提供了一些語言模型可以讓使用者在本地執行模型。

安裝執行模型

在 ollama 官網右上角提供下載模型。在模型中選擇想本地安裝使用的模型，如谷歌語言模型 gemma，搜尋查詢。選擇要下載的資料集，右邊選擇複製。

window 端開啟 cmd 命令視窗，貼上剛才複製的命令，回車下載安裝。

安裝完之後，使用剛才複製的命令，執行 gemma 模型，可以向模型提問。

java 整合 ollama

Idea 建立 SpringBoot Maven 專案（Spring AI基於1.0-SNAPSHOT版本，SpringBoot 3.2.6），依賴選擇Spring Web、 Ollama。其他可以自行選擇

修改專案倉庫地址，中央倉庫暫時還沒 Spring AI 相關 jar 包。倉庫地址改成快照倉庫地址，官方說明

    <repository>
        <id>spring-snapshots</id>
        <name>Spring Snapshots</name>
        <url>https://repo.spring.io/snapshot</url>
        <releases>
            <enabled>false</enabled>
        </releases>
    </repository>

專案中找到 pom.xml 檔案，將 <spring-ai.version>0.8.1</spring-ai.version> 改為 <spring-ai.version>1.0.0-SNAPSHOT</spring-ai.version>

簡單用法

SpringBoot 測試類

import jakarta.annotation.Resource;
import org.junit.jupiter.api.Test;
import org.springframework.ai.chat.model.ChatResponse;
import org.springframework.ai.chat.prompt.Prompt;
import org.springframework.ai.ollama.OllamaChatModel;
import org.springframework.ai.ollama.api.OllamaOptions;
import org.springframework.boot.test.context.SpringBootTest;

@SpringBootTest
public class SimpleTest {

    @Resource
    private OllamaChatModel chatModel;

    @Test
    public void test(){
        //使用下載的 gemma:7b 配置模型屬性，模型屬性建立可以參考 OllamaChatModel 建構函式
        OllamaOptions options = OllamaOptions.create().withModel("gemma:7b");
        Prompt prompt = new Prompt("你好", options);
        //呼叫聊天模型，獲取返回值物件
        ChatResponse res = chatModel.call(prompt);
        //獲取 AI 回答字串
        System.out.println(res.getResult().getOutput().getContent());
    }
    
    /**
     * 流式返回資料，類似打字效果，一個詞一個json資料，整句話多個json資料
     */
    @Test
    public void test2(){
        //使用下載的 gemma:7b 配置模型屬性，模型屬性配置可以參考 OllamaChatModel 建構函式
        OllamaOptions options = OllamaOptions.create().withModel("gemma:7b");
        Prompt prompt = new Prompt("你好", options);
        Flux<ChatResponse> flux = chatModel.stream(prompt);
        flux.toStream().forEach(res -> {
            System.out.println(res.getResult().getOutput().getContent());
        });
    }

}

模型屬性可以檢視 org.springframework.ai.autoconfigure.ollama.OllamaChatProperties，也可以在官網檢視具體的屬性。屬性配置也可以在 yml 檔案上定義，如 OllamaChatProperties 上的註解，需要以 spring.ai.ollama.chat 開頭，如配置 gemma:7b、訪問其他伺服器的 ollama（安裝ollama的伺服器環境變數配置增加 OLLAMA_HOST=0.0.0.0:11434）：

spring:
  ai:
    ollama:
      base-url: http://192.168.8.16:11434
      chat:
        model: gemma:7b

呼叫 ollama API

ollama 具體 API 方法可以檢視官網

import org.apache.http.HttpEntity;
import org.apache.http.client.methods.CloseableHttpResponse;
import org.apache.http.client.methods.HttpPost;
import org.apache.http.entity.StringEntity;
import org.apache.http.impl.client.CloseableHttpClient;
import org.apache.http.impl.client.HttpClients;
import org.apache.http.util.EntityUtils;
import org.json.JSONObject;
import org.junit.jupiter.api.Test;
import org.springframework.boot.test.context.SpringBootTest;

import java.nio.charset.Charset;
import java.util.HashMap;
import java.util.Map;


@SpringBootTest
public class OllamaApiTest {

    @Test
    public void test() throws Exception{
        CloseableHttpClient client = HttpClients.createDefault();
        //ollama 預設埠是 11434
        HttpPost post = new HttpPost("http://127.0.0.1:11434/api/generate");
        post.addHeader("Content-type","application/json; charset=utf-8");
        //引數
        Map<String, Object> map = new HashMap<>();
        map.put("model","gemma:7b");
        map.put("prompt","你好");
        //不以流式返回
        map.put("stream",false);

        StringEntity stringEntity = new StringEntity(JSONObject.valueToString(map),Charset.forName("UTF-8"));
        post.setEntity(stringEntity);
        CloseableHttpResponse response = client.execute(post);
        HttpEntity entity = response.getEntity();
        System.out.println(EntityUtils.toString(entity));
    }

}

Spring Boot初學改錯合集（持續更新）
2020-10-07
Spring Boot
Spring 初識
2024-06-29
Spring
Spring 事務學習筆記(一) 初遇篇
2022-02-27
Spring筆記
初識Spring Boot
2018-08-25
Spring Boot
初識Spring IoC
2022-03-08
Spring
Spring Boot 初識
2017-05-30
Spring Boot
初識Spring Security
2014-12-05
Spring
Java開發學習(一)----初識Spring及其核心概念
2022-05-28
JavaSpring
初學
2003-05-30
【初學】Spring原始碼筆記之零：閱讀原始碼
2020-07-10
Spring原始碼筆記
初學 Spring Boot，你需要了解的 7 樣東西
2018-01-07
Spring Boot
Spring AI + ollama 本地搭建聊天 AI
2024-11-13
SpringAI
初學go
2021-06-07
Go
Vue初學
2020-11-02
Vue
初學JavaScript
2020-09-09
JavaScript
Maven初學
2016-09-23
Maven
Arduino初學
2017-10-14
UI
Java初學
2017-10-14
Java
Bootstrap初學
2017-04-30
boot
AJAX初學
2017-04-30
SQLite 初學
2016-06-27
SQLite
Ruby初學
2009-01-11
初學php
2009-02-26
PHP
初學jboss
2006-10-28
vim初學
2015-11-15
statspack 初學
2008-03-31
初學Servlet
2024-11-06
Servlet
【Spring技術棧】初識Spring Data JPA
2018-08-19
Spring
Spring學習01--初學者關於AOP和DI的理解
2019-01-06
Spring
Spring Cloud Gateway初體驗
2019-03-03
SpringCloudGateway
Spring AI（繪圖）
2024-07-16
SpringAI繪圖
從零一起學Spring Boot之LayIM專案長成記（一）初見 Spring Boot
2017-11-01
Spring Boot
自動機器學習和AI初學者指南
2018-12-04
機器學習AI
初學指令碼
2019-02-16
指令碼
C#初學
2019-02-16
C#
初學Python
2018-11-26
Python
初學 Bootstrap 表格
2018-10-23
boot
初學 Bootstrap 排版
2018-10-22
boot

Spring AI 初學

Spring AI 初學

Open AI

前期準備

專案建立

聊天

基礎使用

配置屬性

多模型

影像

基礎使用

配置屬性

語音

語音轉文字

基礎使用

配置屬性

文字轉語音

基礎使用

屬性配置

ollama

安裝 ollama

安裝執行模型

java 整合 ollama

簡單用法

呼叫 ollama API

相關文章