5.1Spring AI Ollama 嵌入模型

Spring AI Ollama 嵌入模型

前言

使用 Ollama，您可以在本地运行各种 AI 模型并从中生成嵌入。

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

OllamaEmbeddingModel 实现利用了 Ollama 嵌入 API 端点。

前提条件

您首先需要访问 Ollama 实例。有几个选项，包括以下：

在本地机器上下载并安装 Ollama。
配置并通过 Testcontainers 运行 Ollama。
通过 Kubernetes Service Bindings 绑定到 Ollama 实例。

您可以从 Ollama 模型库中拉取要在应用程序中使用的模型：

shellscript 复制代码

ollama pull <model-name>

您也可以拉取数千个免费的 GGUF Hugging Face 模型：

shellscript 复制代码

ollama pull hf.co/<username>/<model-repository>

或者，您可以启用自动下载任何所需模型的选项：自动拉取模型。

自动配置

注意 Spring AI 自动配置、启动器模块的构件名称发生了重大变化。请参考升级说明了解更多信息。

Spring AI 为 Ollama 嵌入模型提供了 Spring Boot 自动配置。要启用它，请将以下依赖项添加到您的 Maven pom.xml 或 Gradle build.gradle 构建文件中：

Maven:

xml 复制代码

<dependency>
   <groupId>org.springframework.ai</groupId>
   <artifactId>spring-ai-starter-model-ollama</artifactId>
</dependency>

Gradle:

groovy 复制代码

dependencies {
    implementation 'org.springframework.ai:spring-ai-starter-model-ollama'
}

提示参考依赖管理部分，将 Spring AI BOM 添加到您的构建文件中。 Spring AI 构件发布在 Maven Central 和 Spring Snapshot 仓库中。参考仓库部分将这些仓库添加到您的构建系统中。

基础属性

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

属性	描述	默认值
spring.ai.ollama.base-url	Ollama API 服务器运行的基础 URL。	`http://localhost:11434`

以下是用于初始化 Ollama 集成和自动拉取模型的属性：

属性	描述	默认值
spring.ai.ollama.init.pull-model-strategy	是否在启动时拉取模型以及如何拉取。	`never`
spring.ai.ollama.init.timeout	等待模型拉取完成的时间。	`5m`
spring.ai.ollama.init.max-retries	模型拉取操作的最大重试次数。	`0`
spring.ai.ollama.init.embedding.include	在初始化任务中包含此类型的模型。	`true`
spring.ai.ollama.init.embedding.additional-models	除了通过默认属性配置的模型之外，还要初始化的附加模型。	`[]`

嵌入属性

注意嵌入自动配置的启用和禁用现在通过前缀为 spring.ai.model.embedding 的顶级属性配置。

要启用，设置 spring.ai.model.embedding=ollama（默认启用）

要禁用，设置 spring.ai.model.embedding=none（或任何不匹配 ollama 的值）

进行此更改是为了允许配置多个模型。

前缀 spring.ai.ollama.embedding.options 是配置 Ollama 嵌入模型的属性前缀。它包括 Ollama 请求（高级）参数，如 model、keep-alive 和 truncate，以及 Ollama 模型 options 属性。

以下是 Ollama 嵌入模型的高级请求参数：

属性	描述	默认值
spring.ai.ollama.embedding.enabled (已移除，不再有效)	启用 Ollama 嵌入模型自动配置。	true
spring.ai.model.embedding	启用 Ollama 嵌入模型自动配置。	ollama
spring.ai.ollama.embedding.options.model	要使用的支持的模型的名称。您可以使用专用的嵌入模型类型	mxbai-embed-large
spring.ai.ollama.embedding.options.keep_alive	控制模型在请求后保持加载在内存中的时间	5m
spring.ai.ollama.embedding.options.truncate	截断每个输入的末尾以适应上下文长度。如果为 false 且超过上下文长度，则返回错误。	true

其余的 options 属性基于 Ollama 有效参数和值和 Ollama 类型。默认值基于：Ollama 类型默认值。

属性	描述	默认值
spring.ai.ollama.embedding.options.numa	是否使用 NUMA。	false
spring.ai.ollama.embedding.options.num-ctx	设置用于生成下一个标记的上下文窗口大小。	2048
spring.ai.ollama.embedding.options.num-batch	提示处理最大批量大小。	512
spring.ai.ollama.embedding.options.num-gpu	要发送到 GPU 的层数。在 macOS 上默认为 1 以启用 metal 支持，0 表示禁用。这里的 1 表示应该动态设置 NumGPU	-1
spring.ai.ollama.embedding.options.main-gpu	当使用多个 GPU 时，此选项控制哪个 GPU 用于小张量，对于这些张量，在所有 GPU 上分割计算的开销是不值得的。所涉及的 GPU 将使用更多的 VRAM 来存储临时结果的暂存缓冲区。	0
spring.ai.ollama.embedding.options.low-vram	-	false
spring.ai.ollama.embedding.options.f16-kv	-	true
spring.ai.ollama.embedding.options.logits-all	返回所有标记的对数，而不仅仅是最后一个。要启用补全返回对数概率，这必须为 true。	-
spring.ai.ollama.embedding.options.vocab-only	仅加载词汇表，不加载权重。	-
spring.ai.ollama.embedding.options.use-mmap	默认情况下，模型被映射到内存中，这允许系统仅根据需要加载模型的必要部分。但是，如果模型大于您的总 RAM 量，或者您的系统可用内存较少，使用 mmap 可能会增加页面调出的风险，从而对性能产生负面影响。禁用 mmap 会导致加载时间变慢，但如果您不使用 mlock，可能会减少页面调出。请注意，如果模型大于总 RAM 量，关闭 mmap 将完全阻止模型加载。	null
spring.ai.ollama.embedding.options.use-mlock	将模型锁定在内存中，防止在内存映射时被换出。这可以提高性能，但通过需要更多 RAM 来运行并可能减慢模型加载到 RAM 的时间，而失去了内存映射的一些优势。	false
spring.ai.ollama.embedding.options.num-thread	设置计算期间使用的线程数。默认情况下，Ollama 将检测此值以获得最佳性能。建议将此值设置为您的系统具有的物理 CPU 核心数（而不是逻辑核心数）。0 = 让运行时决定	0
spring.ai.ollama.embedding.options.num-keep	-	4
spring.ai.ollama.embedding.options.seed	设置用于生成的随机数种子。将此设置为特定数字将使模型为相同的提示生成相同的文本。	-1
spring.ai.ollama.embedding.options.num-predict	生成文本时要预测的最大标记数。（-1 = 无限生成，-2 = 填充上下文）	-1
spring.ai.ollama.embedding.options.top-k	减少生成无意义的概率。较高的值（例如，100）将给出更多样化的答案，而较低的值（例如，10）将更加保守。	40
spring.ai.ollama.embedding.options.top-p	与 top-k 一起工作。较高的值（例如，0.95）将导致更多样化的文本，而较低的值（例如，0.5）将生成更专注和保守的文本。	0.9
spring.ai.ollama.embedding.options.min-p	top_p 的替代方案，旨在确保质量和多样性的平衡。参数 p 表示相对于最可能标记的概率，要考虑的标记的最小概率。例如，当 p=0.05 且最可能标记的概率为 0.9 时，值小于 0.045 的对数被过滤掉。	0.0
spring.ai.ollama.embedding.options.tfs-z	无尾采样用于减少输出中不太可能标记的影响。较高的值（例如，2.0）将更多地减少影响，而值为 1.0 则禁用此设置。	1.0
spring.ai.ollama.embedding.options.typical-p	-	1.0
spring.ai.ollama.embedding.options.repeat-last-n	设置模型回溯多远以防止重复。（默认值：64，0 = 禁用，-1 = num_ctx）	64
spring.ai.ollama.embedding.options.temperature	模型的温度。提高温度将使模型的回答更具创造性。	0.8
spring.ai.ollama.embedding.options.repeat-penalty	设置对重复的惩罚强度。较高的值（例如，1.5）将更强烈地惩罚重复，而较低的值（例如，0.9）将更加宽容。	1.1
spring.ai.ollama.embedding.options.presence-penalty	-	0.0
spring.ai.ollama.embedding.options.frequency-penalty	-	0.0
spring.ai.ollama.embedding.options.mirostat	启用 Mirostat 采样以控制困惑度。（默认值：0，0 = 禁用，1 = Mirostat，2 = Mirostat 2.0）	0
spring.ai.ollama.embedding.options.mirostat-tau	控制输出的连贯性和多样性之间的平衡。较低的值将导致更专注和连贯的文本。	5.0
spring.ai.ollama.embedding.options.mirostat-eta	影响算法对生成文本的反馈响应速度。较低的学习率将导致调整较慢，而较高的学习率将使算法更具响应性。	0.1
spring.ai.ollama.embedding.options.penalize-newline	-	true
spring.ai.ollama.embedding.options.stop	设置要使用的停止序列。当遇到此模式时，LLM 将停止生成文本并返回。可以通过在 modelfile 中指定多个单独的停止参数来设置多个停止模式。	-
spring.ai.ollama.embedding.options.functions	要在单个提示请求中启用函数调用的函数名称列表。具有这些名称的函数必须存在于 functionCallbacks 注册表中。	-

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

运行时选项

OllamaOptions.java 提供 Ollama 配置，如要使用的模型、低级 GPU 和 CPU 调整等。

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

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

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

java 复制代码

EmbeddingResponse embeddingResponse = embeddingModel.call(
    new EmbeddingRequest(List.of("Hello World", "World is big and salvation is near"),
        OllamaOptions.builder()
            .model("Different-Embedding-Model-Deployment-Name"))
            .truncates(false)
            .build());

自动拉取模型

Spring AI Ollama 可以在模型在您的 Ollama 实例中不可用时自动拉取它们。此功能对于开发和测试以及将应用程序部署到新环境特别有用。

提示您也可以按名称拉取数千个免费的 GGUF Hugging Face 模型。

拉取模型有三种策略：

always（在 PullModelStrategy.ALWAYS 中定义）：总是拉取模型，即使它已经可用。有助于确保您使用的是模型的最新版本。
when_missing（在 PullModelStrategy.WHEN_MISSING 中定义）：仅当模型尚不可用时才拉取。这可能导致使用较旧版本的模型。
never（在 PullModelStrategy.NEVER 中定义）：从不自动拉取模型。

注意由于下载模型时可能出现潜在的延迟，不建议在生产环境中使用自动拉取。相反，考虑提前评估并预下载必要的模型。

所有通过配置属性和默认选项定义的模型都可以在启动时自动拉取。您可以使用配置属性配置拉取策略、超时和最大重试次数：

yaml 复制代码

spring:
  ai:
    ollama:
      init:
        pull-model-strategy: always
        timeout: 60s
        max-retries: 1

注意应用程序在所有指定模型在 Ollama 中可用之前不会完成其初始化。根据模型大小和互联网连接速度，这可能会显著减慢应用程序的启动时间。

您可以在启动时初始化其他模型，这对于在运行时动态使用的模型很有用：

yaml 复制代码

spring:
  ai:
    ollama:
      init:
        pull-model-strategy: always
        embedding:
          additional-models:
            - mxbai-embed-large
            - nomic-embed-text

如果您想仅对特定类型的模型应用拉取策略，可以从初始化任务中排除嵌入模型：

yaml 复制代码

spring:
  ai:
    ollama:
      init:
        pull-model-strategy: always
        embedding:
          include: false

此配置将拉取策略应用于除嵌入模型之外的所有模型。

HuggingFace 模型

Ollama 可以开箱即用地访问所有 GGUF Hugging Face 嵌入模型。您可以按名称拉取这些模型中的任何一个：ollama pull hf.co/<username>/<model-repository> 或配置自动拉取策略：自动拉取模型：

ini 复制代码

spring.ai.ollama.embedding.options.model=hf.co/mixedbread-ai/mxbai-embed-large-v1
spring.ai.ollama.init.pull-model-strategy=always

spring.ai.ollama.embedding.options.model：指定要使用的 Hugging Face GGUF 模型。
spring.ai.ollama.init.pull-model-strategy=always：（可选）在启动时启用自动模型拉取。对于生产环境，您应该预下载模型以避免延迟：ollama pull hf.co/mixedbread-ai/mxbai-embed-large-v1。

示例控制器

这将创建一个可以注入到类中的 EmbeddingModel 实现。以下是使用 EmbeddingModel 实现的简单 @Controller 类示例：

java 复制代码

@RestController
public class EmbeddingController {

    private final EmbeddingModel embeddingModel;

    @Autowired
    public EmbeddingController(EmbeddingModel embeddingModel) {
        this.embeddingModel = embeddingModel;
    }

    @GetMapping("/ai/embedding")
    public Map embed(@RequestParam(value = "message", defaultValue = "Tell me a joke") String message) {
        EmbeddingResponse embeddingResponse = this.embeddingModel.embedForResponse(List.of(message));
        return Map.of("embedding", embeddingResponse);
    }
}

手动配置

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

Maven:

xml 复制代码

<dependency>
    <groupId>org.springframework.ai</groupId>
    <artifactId>spring-ai-ollama</artifactId>
</dependency>

Gradle:

groovy 复制代码

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

提示参考依赖管理部分，将 Spring AI BOM 添加到您的构建文件中。
注意 spring-ai-ollama 依赖项也提供对 OllamaChatModel 的访问。有关 OllamaChatModel 的更多信息，请参考 Ollama 聊天客户端部分。

接下来，创建一个 OllamaEmbeddingModel 实例，并使用它使用专用的 chroma/all-minilm-l6-v2-f32 嵌入模型计算两个输入文本的嵌入：

java 复制代码

var ollamaApi = OllamaApi.builder().build();

var embeddingModel = new OllamaEmbeddingModel(this.ollamaApi,
        OllamaOptions.builder()
			.model(OllamaModel.MISTRAL.id())
            .build());

EmbeddingResponse embeddingResponse = this.embeddingModel.call(
    new EmbeddingRequest(List.of("Hello World", "World is big and salvation is near"),
        OllamaOptions.builder()
            .model("chroma/all-minilm-l6-v2-f32"))
            .truncate(false)
            .build());

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