Ollama 嵌入

使用 Ollama，您可以在本地运行各种 AI 模型并从中生成嵌入。嵌入是浮点数的向量（列表）。两个向量之间的距离衡量它们的关联程度。较小的距离表示较高的关联性，较大的距离表示较低的关联性。

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

先决条件

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

下载并安装 Ollama 到您的本地机器上。
配置并通过 Testcontainers 运行 Ollama。
通过 Kubernetes 服务绑定绑定到 Ollama 实例。

您可以从 Ollama 模型库中提取您想要在应用程序中使用的模型。

ollama pull <model-name>

您还可以提取数千个免费的 GGUF Hugging Face 模型。

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

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

自动配置

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

Maven
Gradle

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

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

请参阅依赖项管理部分，将 Spring AI BOM 添加到您的构建文件中。Spring AI 工件发布在 Spring Milestone 和 Snapshot 存储库中。请参阅存储库部分，将这些存储库添加到您的构建系统中。

基本属性

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

属性

描述

默认值

spring.ai.ollama.base-url

Ollama API 服务器正在运行的基本 URL。

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

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

属性

描述

默认值

spring.ai.ollama.embedding.enabled

启用 Ollama 嵌入模型自动配置。

true

spring.ai.ollama.embedding.options.model

要使用的支持模型的名称。您可以使用专用的嵌入模型类型

mistral

spring.ai.ollama.embedding.options.keep_alive

控制模型在请求后将在内存中保留多长时间

spring.ai.ollama.embedding.options.truncate

截断每个输入的末尾以适合上下文长度。如果为假且超过上下文长度，则返回错误。

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 以启用金属支持，0 以禁用。这里的 1 表示 NumGPU 应该动态设置

-1

spring.ai.ollama.embedding.options.main-gpu

当使用多个 GPU 时，此选项控制哪个 GPU 用于小型张量，对于这些张量，跨所有 GPU 分割计算的开销不值得。相关 GPU 将使用略多的 VRAM 来存储用于临时结果的 scratch buffer。

spring.ai.ollama.embedding.options.low-vram

false

spring.ai.ollama.embedding.options.f16-kv

true

spring.ai.ollama.embedding.options.logits-all

返回所有标记的 logits，而不仅仅是最后一个标记。要使补全返回 logprobs，这必须为真。

spring.ai.ollama.embedding.options.vocab-only

仅加载词汇表，而不是权重。

spring.ai.ollama.embedding.options.use-mmap

默认情况下，模型会映射到内存中，这允许系统根据需要仅加载模型的必要部分。但是，如果模型大于您的总内存量或您的系统内存不足，则使用 mmap 可能会增加页面调出的风险，从而对性能产生负面影响。禁用 mmap 会导致加载时间变慢，但如果未使用 mlock，则可能会减少页面调出。请注意，如果模型大于总内存量，则关闭 mmap 将完全阻止模型加载。

null

spring.ai.ollama.embedding.options.use-mlock

将模型锁定在内存中，防止在内存映射时被换出。这可以提高性能，但通过需要更多 RAM 来运行并可能减慢加载时间（因为模型加载到 RAM 中）而牺牲了内存映射的一些优势。

false

spring.ai.ollama.embedding.options.num-thread

设置计算过程中使用的线程数。默认情况下，Ollama 将检测此值以获得最佳性能。建议将此值设置为系统物理 CPU 内核数（而不是逻辑内核数）。0 = 让运行时决定

spring.ai.ollama.embedding.options.num-keep

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）将更加保守。

spring.ai.ollama.embedding.options.top-p

与 top-k 一起工作。较高的值（例如，0.95）将导致更多样化的文本，而较低的值（例如，0.5）将生成更集中和保守的文本。

0.9

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）

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）

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 将停止生成文本并返回。可以通过在模型文件中指定多个单独的停止参数来设置多个停止模式。

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 的一部分来覆盖默认选项。

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

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

自动拉取模型

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

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

有三种拉取模型的策略

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

由于下载模型时可能存在延迟，因此不建议在生产环境中使用自动拉取。相反，请考虑提前评估和预下载必要的模型。

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

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

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

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

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

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

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

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

示例控制器

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

@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
Gradle

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

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

请参阅依赖项管理部分以将 Spring AI BOM 添加到您的构建文件中。

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

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

var ollamaApi = new OllamaApi();

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

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

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