建構一個 Kotlin 應用程式，使用 Spring AI 回答基於 Qdrant 中儲存文件的問題 — 教學課程

在本教學課程中，您將學習如何建構一個 Kotlin 應用程式，該應用程式使用 Spring AI 來連接到大型語言模型 (LLM)，將文件儲存在向量資料庫中，並使用來自這些文件的上下文來回答問題。

在本教學課程中，您將使用以下工具：

Spring Boot 作為配置和運行網路應用程式的基礎。
Spring AI 用於與 LLM 互動並執行基於上下文的檢索。
IntelliJ IDEA 用於生成專案並實作應用程式邏輯。
Qdrant 作為用於相似性搜尋的向量資料庫。
Docker 用於在本地運行 Qdrant。
OpenAI 作為 LLM 提供者。

開始之前

下載並安裝最新版 IntelliJ IDEA Ultimate Edition。
如果您使用 IntelliJ IDEA Community Edition 或其他 IDE，您可以使用基於網路的專案生成器來生成 Spring Boot 專案。
在 OpenAI 平台上建立 OpenAI API 金鑰以存取 API。
安裝 Docker 以在本地運行 Qdrant 向量資料庫。
安裝 Docker 後，開啟您的終端機並執行以下命令來啟動容器：
bash
```
docker run -p 6333:6333 -p 6334:6334 qdrant/qdrant
```

建立專案

您可以使用 Spring Boot 基於網路的專案生成器作為替代方案來生成您的專案。

在 IntelliJ IDEA Ultimate Edition 中建立新的 Spring Boot 專案：

在 IntelliJ IDEA 中，選擇 File | New | Project。
在左側面板中，選擇 New Project | Spring Boot。
在 New Project 視窗中指定以下欄位和選項：
- Name: springAIDemo
- Language: Kotlin
- Type: Gradle - Kotlin
  此選項指定建構系統和 DSL。
- Package name: com.example.springaidemo
- JDK: Java JDK
  本教學課程使用 Oracle OpenJDK 21.0.1 版。如果您沒有安裝 JDK，可以從下拉式清單中下載。
- Java: 17
  如果您沒有安裝 Java 17，可以從 JDK 下拉式清單中下載。
確保您已指定所有欄位並點擊 Next。
在 Spring Boot 欄位中選擇最新的穩定 Spring Boot 版本。
選擇本教學課程所需的以下依賴項：
- Web | Spring Web
- AI | OpenAI
- SQL | Qdrant Vector Database
點擊 Create 以生成並設定專案。
IDE 將生成並開啟一個新專案。下載和匯入專案依賴項可能需要一些時間。

之後，您可以在 Project view 中看到以下結構：

Spring Boot 專案檢視

生成的 Gradle 專案對應於 Maven 的標準目錄佈局：

應用程式的套件和類別位於 main/kotlin 資料夾下。
應用程式的入口點是 SpringAiDemoApplication.kt 檔案的 main() 方法。

更新專案配置

使用以下內容更新您的 build.gradle.kts Gradle 建構檔：

kotlin

plugins {
    kotlin("jvm") version "2.2.10"
    kotlin("plugin.spring") version "2.2.10"
    // Rest of the plugins
}

將 springAiVersion 設定為 1.0.0：
kotlin
```
extra["springAiVersion"] = "1.0.0"
```
點擊 Sync Gradle Changes 按鈕以同步 Gradle 檔案。

使用以下內容更新您的 src/main/resources/application.properties 檔案：

text

# OpenAI
spring.ai.openai.api-key=YOUR_OPENAI_API_KEY
spring.ai.openai.chat.options.model=gpt-4o-mini
spring.ai.openai.embedding.options.model=text-embedding-ada-002
# Qdrant
spring.ai.vectorstore.qdrant.host=localhost
spring.ai.vectorstore.qdrant.port=6334
spring.ai.vectorstore.qdrant.collection-name=kotlinDocs
spring.ai.vectorstore.qdrant.initialize-schema=true

將您的 OpenAI API 金鑰設定到 spring.ai.openai.api-key 屬性。

執行 SpringAiDemoApplication.kt 檔案以啟動 Spring Boot 應用程式。運行後，在瀏覽器中開啟 Qdrant collections 頁面以查看結果：

建立用於載入和搜尋文件的控制器

建立一個 Spring @RestController 來搜尋文件並將其儲存在 Qdrant 集合中：

在 src/main/kotlin/org/example/springaidemo 目錄中，建立一個名為 KotlinSTDController.kt 的新檔案，並添加以下程式碼：

kotlin

package org.example.springaidemo

// Imports the required Spring and utility classes
import org.slf4j.LoggerFactory
import org.springframework.ai.document.Document
import org.springframework.ai.vectorstore.SearchRequest
import org.springframework.ai.vectorstore.VectorStore
import org.springframework.web.bind.annotation.GetMapping
import org.springframework.web.bind.annotation.PostMapping
import org.springframework.web.bind.annotation.RequestMapping
import org.springframework.web.bind.annotation.RequestParam
import org.springframework.web.bind.annotation.RestController
import org.springframework.web.client.RestTemplate
import kotlin.uuid.ExperimentalUuidApi
import kotlin.uuid.Uuid

@RestController
@RequestMapping("/kotlin")
class KotlinSTDController(
private val restTemplate: RestTemplate,
private val vectorStore: VectorStore,
) {
private val logger = LoggerFactory.getLogger(this::class.java)

    @OptIn(ExperimentalUuidApi::class)
    @PostMapping("/load-docs")
    fun load() {
        // Loads a list of documents from the Kotlin documentation
        val kotlinStdTopics = listOf(
            "collections-overview", "constructing-collections", "iterators", "ranges", "sequences",
            "collection-operations", "collection-transformations", "collection-filtering", "collection-plus-minus",
            "collection-grouping", "collection-parts", "collection-elements", "collection-ordering",
            "collection-aggregate", "collection-write", "list-operations", "set-operations",
            "map-operations", "read-standard-input", "opt-in-requirements", "scope-functions", "time-measurement",
        )
        // Base URL for the documents
        val url = "https://raw.githubusercontent.com/JetBrains/kotlin-web-site/refs/heads/master/docs/topics/"
        // Retrieves each document from the URL and adds it to the vector store
        kotlinStdTopics.forEach { topic ->
            val data = restTemplate.getForObject("$url$topic.md", String::class.java)
            data?.let { it ->
                val doc = Document.builder()
                    // Builds a document with a random UUID
                    .id(Uuid.random().toString())
                    .text(it)
                    .metadata("topic", topic)
                    .build()
                vectorStore.add(listOf(doc))
                logger.info("Document $topic loaded.")
            } ?: logger.warn("Failed to load document for topic: $topic")
        }
    }

    @GetMapping("docs")
    fun query(
        @RequestParam query: String = "operations, filtering, and transformations",
        @RequestParam topK: Int = 2
    ): List<Document>? {
        val searchRequest = SearchRequest.builder()
            .query(query)
            .topK(topK)
            .build()
        val results = vectorStore.similaritySearch(searchRequest)
        logger.info("Found ${results?.size ?: 0} documents for query: '$query'")
        return results
    }
}

更新 SpringAiDemoApplication.kt 檔案以宣告 RestTemplate bean：

kotlin

package org.example.springaidemo

import org.springframework.boot.autoconfigure.SpringBootApplication
import org.springframework.boot.runApplication
import org.springframework.context.annotation.Bean
import org.springframework.web.client.RestTemplate

@SpringBootApplication
class SpringAiDemoApplication {

    @Bean
    fun restTemplate(): RestTemplate = RestTemplate()
}

fun main(args: Array<String>) {
    runApplication<SpringAiDemoApplication>(*args)
}

運行應用程式。
在終端機中，向 /kotlin/load-docs 端點發送 POST 請求以載入文件：
bash
```
curl -X POST http://localhost:8080/kotlin/load-docs
```
文件載入後，您可以使用 GET 請求搜尋它們：
Bash
```
curl -X GET http://localhost:8080/kotlin/docs
```

您也可以在 Qdrant collections 頁面查看結果。

實作 AI 聊天端點

文件載入後，最後一步是添加一個端點，透過 Spring AI 的檢索增強生成 (Retrieval-Augmented Generation, RAG) 支援，使用 Qdrant 中的文件來回答問題：

開啟 KotlinSTDController.kt 檔案，並匯入以下類別：

kotlin

import org.springframework.ai.chat.client.ChatClient
import org.springframework.ai.chat.client.advisor.SimpleLoggerAdvisor
import org.springframework.ai.chat.client.advisor.vectorstore.QuestionAnswerAdvisor
import org.springframework.ai.chat.prompt.Prompt
import org.springframework.ai.chat.prompt.PromptTemplate
import org.springframework.web.bind.annotation.RequestBody

定義一個 ChatRequest 資料類別：

kotlin

// Represents the request payload for chat queries
data class ChatRequest(val query: String, val topK: Int = 3)

將 ChatClient.Builder 添加到控制器的建構函式參數中：

kotlin

class KotlinSTDController(
    private val chatClientBuilder: ChatClient.Builder,
    private val restTemplate: RestTemplate,
    private val vectorStore: VectorStore,
)

在控制器類別內部，建立一個 ChatClient 實例：

kotlin

// Builds the chat client with a simple logging advisor
private val chatClient = chatClientBuilder.defaultAdvisors(SimpleLoggerAdvisor()).build()

在 KotlinSTDController.kt 檔案底部，添加一個新的 chatAsk() 端點，其中包含以下邏輯：

kotlin

@PostMapping("/chat/ask")
fun chatAsk(@RequestBody request: ChatRequest): String? {
    // Defines the prompt template with placeholders
    val promptTemplate = PromptTemplate(
        """
        {query}.
        Please provide a concise answer based on the "Kotlin standard library" documentation.
    """.trimIndent()
    )

    // Creates the prompt by substituting placeholders with actual values
    val prompt: Prompt =
        promptTemplate.create(mapOf("query" to request.query))

    // Configures the retrieval advisor to augment the query with relevant documents
    val retrievalAdvisor = QuestionAnswerAdvisor.builder(vectorStore)
        .searchRequest(
            SearchRequest.builder()
                .similarityThreshold(0.7)
                .topK(request.topK)
                .build()
        )
        .promptTemplate(promptTemplate)
        .build()

    // Sends the prompt to the LLM with the retrieval advisor and retrieves the generated content
    val response = chatClient.prompt(prompt)
        .advisors(retrievalAdvisor)
        .call()
        .content()
    logger.info("Chat response generated for query: '${request.query}'")
    return response
}

運行應用程式。

在終端機中，向新端點發送 POST 請求以查看結果：

bash

curl -X POST "http://localhost:8080/kotlin/chat/ask" \
     -H "Content-Type: application/json" \
     -d '{"query": "What are the performance implications of using lazy sequences in Kotlin for large datasets?", "topK": 3}'

OpenAI 對聊天請求的回覆

恭喜！您現在擁有一個 Kotlin 應用程式，可以連接到 OpenAI 並使用從 Qdrant 中儲存的文件檢索到的上下文來回答問題。嘗試使用不同的查詢或匯入其他文件以探索更多可能性。

您可以在 Spring AI demo GitHub 儲存庫中查看已完成的專案，或在 Kotlin AI Examples 中探索其他 Spring AI 範例。

基本類型

建構器

Spring

使用 Spring Boot 建立一個包含資料庫的 RESTful Web 服務

Java 遷移至 Kotlin 指南

C 互通

Objective-C 互通

記憶體管理器

參考與提示

用於 JS 平台的 Kotlin

概覽

執行 Dokka

輸出格式

最小化心智複雜度

建構一個 Kotlin 應用程式，使用 Spring AI 回答基於 Qdrant 中儲存文件的問題 — 教學課程

開始之前

建立專案

更新專案配置

建立用於載入和搜尋文件的控制器

實作 AI 聊天端點

使用 Spring Boot 建立一個包含資料庫的 RESTful Web 服務

建構一個 Kotlin 應用程式，使用 Spring AI 回答基於 Qdrant 中儲存文件的問題 — 教學課程 ​

開始之前 ​

建立專案 ​

更新專案配置 ​

建立用於載入和搜尋文件的控制器 ​

實作 AI 聊天端點 ​

建構一個 Kotlin 應用程式，使用 Spring AI 回答基於 Qdrant 中儲存文件的問題 — 教學課程

開始之前

建立專案

更新專案配置

建立用於載入和搜尋文件的控制器

實作 AI 聊天端點