第九章 Spring AI API中文版 - Ollama Embeddings API_spring-ai-ollama api文档

Ollama嵌入

通过Ollama，您可以在本地运行各种大型语言模型（LLMs），并从中生成嵌入。
Spring AI通过OllamaEmbeddingClient支持Ollama文本嵌入。

嵌入是一个浮点数向量（列表）。
两个向量之间的距离衡量它们的相关性。
小距离表明高相关性，大距离表明低相关性。

先决条件

您首先需要在本地机器上运行Ollama。

参考官方Ollama项目链接：README，开始在本地机器上运行模型。
注意，安装ollama运行llama2将下载一个4GB的docker镜像。

添加仓库和BOM

Spring AI工件发布在Spring Milestone和Snapshot仓库中。参考xref:getting-started.adoc#repositories部分将这些仓库添加到您的构建系统中。

为了帮助依赖管理，Spring AI提供了一个BOM（物料清单），以确保在整个项目中使用一致的Spring AI版本。参考xref:getting-started.adoc#dependency-management部分将Spring AI BOM添加到您的构建系统中。

自动配置

Spring AI为Azure Ollama嵌入客户端提供了Spring Boot自动配置。
要启用它，请将以下依赖项添加到您的Maven pom.xml文件中：

<dependency>
   <groupId>org.springframework.ai</groupId>
   <artifactId>spring-ai-ollama-spring-boot-starter</artifactId>
</dependency>
1
2
3
4

或添加到您的Gradle build.gradle构建文件中。

dependencies {
   implementation 'org.springframework.ai:spring-ai-ollama-spring-boot-starter'
}
1
2
3

提示：参考xref:getting-started.adoc#dependency-management部分将Spring AI BOM添加到您的构建文件中。

spring.ai.ollama.embedding.options.*属性用于配置所有嵌入请求使用的默认选项。
（它被用作OllamaEmbeddingClient#withDefaultOptions()实例）。

嵌入属性

前缀spring.ai.ollama是属性前缀，用于配置与Ollama的连接

前缀spring.ai.ollama.embedding.options是属性前缀，用于配置Ollama的EmbeddingClient实现。

注意：spring.ai.ollama.embedding.options.*属性基于Ollama有效参数和值和Ollama类型。

提示：所有以spring.ai.ollama.embedding.options为前缀的属性都可以在运行时通过在EmbeddingRequest调用中添加请求特定的>覆盖。

嵌入选项

OllamaOptions.java提供了Ollama配置，例如要使用的模型、底层GPU和CPU调优等。

默认选项可以使用spring.ai.ollama.embedding.options属性进行配置。

启动时使用OllamaEmbeddingClient#withDefaultOptions()来配置所有嵌入请求使用的默认选项。
运行时，您可以使用OllamaOptions实例作为您的EmbeddingRequest的一部分来覆盖默认选项。

例如，要覆盖特定请求的默认模型名称：

EmbeddingResponse embeddingResponse = embeddingClient.call(
    new EmbeddingRequest(List.of("Hello World", "World is big and salvation is near"),
        OllamaOptions
        .create()
            .withModel("Different-Embedding-Model-Deployment-Name"));
1
2
3
4
5

示例控制器（自动配置）

这将创建一个EmbeddingClient实现，您可以将其注入到您的类中。
这是一个使用EmbeddingClient实现的简单@Controller类的示例。

@RestController
public class EmbeddingController {

    private final EmbeddingClient embeddingClient;

    @Autowired
    public EmbeddingController(EmbeddingClient embeddingClient) {
        this.embeddingClient = embeddingClient;
    }

    @GetMapping("/ai/embedding")
    public Map embed(@RequestParam(value = "message", defaultValue = "Tell me a joke") String message) {
        EmbeddingResponse embeddingResponse = this.embeddingClient.embedForResponse(List.of(message));
        return Map.of("embedding", embeddingResponse);
    }
}
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16

手动配置

如果您不使用Spring Boot，您可以手动配置OllamaEmbeddingClient。
为此，将spring-ai-ollama依赖项添加到您项目的Maven pom.xml文件中：

<dependency>
    <groupId>org.springframework.ai</groupId>
    <artifactId>spring-ai-ollama</artifactId>
</dependency>
1
2
3
4

或添加到您的Gradle build.gradle构建文件中。

dependencies {
   implementation 'org.springframework.ai:spring-ai-ollama'
}
1
2
3

提示：参考xref:getting-started.adoc#dependency-management部分将Spring AI BOM添加到您的构建文件中。

注意：spring-ai-ollama依赖项还提供了对OllamaChatClient的访问。
有关OllamaChatClient的更多信息，请参阅Ollama聊天客户端部分。

接下来，创建一个OllamaEmbeddingClient实例，并使用它来计算两个输入文本之间的相似性：

var ollamaApi = new OllamaApi();

var embeddingClient = new OllamaEmbeddingClient(ollamaApi)
    .withDefaultOptions(OllamaOptions.create()
            .withModel(OllamaOptions.DEFAULT_MODEL)
            .toMap());

EmbeddingResponse embeddingResponse = embeddingClient
    .embedForResponse(List.of("Hello World", "World is big and salvation is near"));
1
2
3
4
5
6
7
8
9

OllamaOptions为所有嵌入请求提供配置信息。