OllamaChatModel
API。
pom.xml
或 Gradle build.gradle
构建文件中:
spring.ai.ollama
是用于配置与 Ollama 连接的属性前缀。
属性 | 描述 | 默认值 |
---|---|---|
spring.ai.ollama.base-url | Ollama API 服务器运行的基本 URL。 | http://localhost:11434 |
属性 | 描述 | 默认值 |
---|---|---|
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.chat.include | 在初始化任务中包含此类型的模型。 | true |
spring.ai.ollama.init.chat.additional-models | 除了通过默认属性配置的模型之外,还要初始化的其他模型。 | [] |
spring.ai.model.chat
的顶级属性进行配置。要启用,spring.ai.model.chat=ollama
(默认启用)要禁用,spring.ai.model.chat=none
(或任何与 ollama 不匹配的值)此更改是为了允许配置多个模型。spring.ai.ollama.chat.options
是配置 Ollama 聊天模型的属性前缀。
它包括 Ollama 请求(高级)参数,例如 model
、keep-alive
和 format
,以及 Ollama 模型 options
属性。
以下是 Ollama 聊天模型的高级请求参数:
属性 | 描述 | 默认值 |
---|---|---|
spring.ai.ollama.chat.enabled (已移除且不再有效) | 启用 Ollama 聊天模型。 | true |
spring.ai.model.chat | 启用 Ollama 聊天模型。 | ollama |
spring.ai.ollama.chat.options.model | 要使用的支持的模型的名称。 | mistral |
spring.ai.ollama.chat.options.format | 返回响应的格式。目前,唯一接受的值是 json | - |
spring.ai.ollama.chat.options.keep_alive | 控制请求后模型在内存中保留多长时间 | 5m |
options
属性基于 Ollama 有效参数和值 和 Ollama 类型。默认值基于 Ollama 类型默认值。
属性 | 描述 | 默认值 |
---|---|---|
spring.ai.ollama.chat.options.numa | 是否使用 NUMA。 | false |
spring.ai.ollama.chat.options.num-ctx | 设置用于生成下一个标记的上下文窗口的大小。 | 2048 |
spring.ai.ollama.chat.options.num-batch | 提示处理最大批处理大小。 | 512 |
spring.ai.ollama.chat.options.num-gpu | 要发送到 GPU 的层数。在 macOS 上,默认为 1 以启用 metal 支持,0 以禁用。此处的 1 表示应动态设置 NumGPU | -1 |
spring.ai.ollama.chat.options.main-gpu | 使用多个 GPU 时,此选项控制哪个 GPU 用于小型张量,对于这些张量,跨所有 GPU 拆分计算的开销不值得。相关 GPU 将使用稍多的 VRAM 来存储用于临时结果的暂存缓冲区。 | 0 |
spring.ai.ollama.chat.options.low-vram | - | false |
spring.ai.ollama.chat.options.f16-kv | - | true |
spring.ai.ollama.chat.options.logits-all | 返回所有标记的 logits,而不仅仅是最后一个。要使补全返回 logprobs,此项必须为 true。 | - |
spring.ai.ollama.chat.options.vocab-only | 仅加载词汇表,而不加载权重。 | - |
spring.ai.ollama.chat.options.use-mmap | 默认情况下,模型会映射到内存中,这允许系统根据需要仅加载模型的必要部分。但是,如果模型大于你的总 RAM 量,或者你的系统可用内存不足,则使用 mmap 可能会增加页面换出的风险,从而对性能产生负面影响。禁用 mmap 会导致加载时间变慢,但如果你不使用 mlock,则可能会减少页面换出。请注意,如果模型大于总 RAM 量,则关闭 mmap 将阻止模型完全加载。 | null |
spring.ai.ollama.chat.options.use-mlock | 将模型锁定在内存中,防止在内存映射时将其换出。这可以提高性能,但会牺牲内存映射的一些优势,因为它需要更多 RAM 才能运行,并且随着模型加载到 RAM 中,可能会减慢加载时间。 | false |
spring.ai.ollama.chat.options.num-thread | 设置计算期间要使用的线程数。默认情况下,Ollama 会检测此值以获得最佳性能。建议将此值设置为系统具有的物理 CPU 内核数(而不是逻辑内核数)。0 = 让运行时决定 | 0 |
spring.ai.ollama.chat.options.num-keep | - | 4 |
spring.ai.ollama.chat.options.seed | 设置用于生成的随机数种子。将其设置为特定数字将使模型为相同的提示生成相同的文本。 | -1 |
spring.ai.ollama.chat.options.num-predict | 生成文本时要预测的最大标记数。(-1 = 无限生成,-2 = 填充上下文) | -1 |
spring.ai.ollama.chat.options.top-k | 降低生成无意义内容的概率。较高的值(例如 100)将提供更多样化的答案,而较低的值(例如 10)将更保守。 | 40 |
spring.ai.ollama.chat.options.top-p | 与 top-k 一起使用。较高的值(例如 0.95)将导致更多样化的文本,而较低的值(例如 0.5)将生成更集中和保守的文本。 | 0.9 |
spring.ai.ollama.chat.options.min-p | top_p 的替代方案,旨在确保质量和多样性的平衡。参数 p 表示要考虑的标记的最小概率,相对于最可能标记的概率。例如,当 p=0.05 且最可能标记的概率为 0.9 时,值小于 0.045 的 logits 将被过滤掉。 | 0.0 |
spring.ai.ollama.chat.options.tfs-z | 无尾采样用于减少输出中不太可能的标记的影响。较高的值(例如 2.0)将更多地减少影响,而值 1.0 将禁用此设置。 | 1.0 |
spring.ai.ollama.chat.options.typical-p | - | 1.0 |
spring.ai.ollama.chat.options.repeat-last-n | 设置模型向后查看多远以防止重复。(默认值:64,0 = 禁用,-1 = num_ctx) | 64 |
spring.ai.ollama.chat.options.temperature | 模型的温度。增加温度会使模型回答更具创造性。 | 0.8 |
spring.ai.ollama.chat.options.repeat-penalty | 设置对重复的惩罚强度。较高的值(例如 1.5)将更强烈地惩罚重复,而较低的值(例如 0.9)将更宽松。 | 1.1 |
spring.ai.ollama.chat.options.presence-penalty | - | 0.0 |
spring.ai.ollama.chat.options.frequency-penalty | - | 0.0 |
spring.ai.ollama.chat.options.mirostat | 启用 Mirostat 采样以控制困惑度。(默认值:0,0 = 禁用,1 = Mirostat,2 = Mirostat 2.0) | 0 |
spring.ai.ollama.chat.options.mirostat-tau | 控制输出的连贯性和多样性之间的平衡。较低的值将导致更集中和连贯的文本。 | 5.0 |
spring.ai.ollama.chat.options.mirostat-eta | 影响算法对生成文本反馈的响应速度。较低的学习率将导致较慢的调整,而较高的学习率将使算法更具响应性。 | 0.1 |
spring.ai.ollama.chat.options.penalize-newline | - | true |
spring.ai.ollama.chat.options.stop | 设置要使用的停止序列。遇到此模式时,LLM 将停止生成文本并返回。可以通过在模型文件中指定多个单独的 stop 参数来设置多个停止模式。 | - |
spring.ai.ollama.chat.options.functions | 在单个提示请求中启用函数调用的函数列表(按其名称标识)。具有这些名称的函数必须存在于 functionCallbacks 注册表中。 | - |
spring.ai.ollama.chat.options.proxy-tool-calls | 如果为 true,Spring AI 将不会在内部处理函数调用,而是将它们代理到客户端。然后由客户端负责处理函数调用,将它们分派到适当的函数,并返回结果。如果为 false(默认值),Spring AI 将在内部处理函数调用。仅适用于具有函数调用支持的聊天模型 | false |
spring.ai.ollama.chat.options
为前缀的属性都可以在运行时通过向 Prompt
调用添加特定于请求的聊天选项来覆盖。OllamaChatModel(api, options)
构造函数或 spring.ai.ollama.chat.options.*
属性配置默认选项。
在运行时,你可以通过向 Prompt
调用添加新的、特定于请求的选项来覆盖默认选项。
例如,要为特定请求覆盖默认模型和温度:
always
(在 PullModelStrategy.ALWAYS
中定义):始终拉取模型,即使它已经可用。用于确保你使用的是最新版本的模型。when_missing
(在 PullModelStrategy.WHEN_MISSING
中定义):仅当模型尚不可用时才拉取模型。这可能会导致使用较旧版本的模型。never
(在 PullModelStrategy.NEVER
中定义):从不自动拉取模型。OllamaChatModel
注册自定义 Java 函数,并让 Ollama 模型智能地选择输出一个 JSON 对象,其中包含调用一个或多个已注册函数的参数。
这是将 LLM 功能与外部工具和 API 连接起来的强大技术。
阅读有关工具调用的更多信息。
org.springframework.util.MimeType
和 org.springframework.core.io.Resource
来获取原始媒体数据。
以下是从 OllamaChatModelMultimodalIT.java 中摘录的一个简单代码示例,说明了用户文本与图像的融合。
multimodal.test.png
图像作为输入:
JSON Schema
。
除了现有的与 Spring AI 模型无关的结构化输出转换器之外,这些 API 还提供了增强的控制和精度。
OllamaOptions
构建器以编程方式配置响应格式。
OllamaOptions
构建器以编程方式设置响应格式,如下所示:
@JsonProperty(required = true,...)
注释来生成准确标记字段为 required
的模式。
尽管这对于 JSON Schema 是可选的,但建议这样做以使结构化响应正常工作。spring.ai.openai.chat.base-url=http://localhost:11434
并选择提供的 Ollama 模型之一:spring.ai.openai.chat.options.model=mistral
。
ollama pull hf.co/<用户名>/<模型仓库>
或配置自动拉取策略:自动拉取模型:
spring.ai.ollama.chat.options.model
:指定要使用的 Hugging Face GGUF 模型。spring.ai.ollama.init.pull-model-strategy=always
:(可选)在启动时启用自动模型拉取。
对于生产环境,你应该预先下载模型以避免延迟:ollama pull hf.co/bartowski/gemma-2-2b-it-GGUF
。spring-ai-starter-model-ollama
添加到你的 pom (或 gradle) 依赖项中。
在 src/main/resources
目录下添加一个 application.yaml
文件,以启用和配置 Ollama 聊天模型:
base-url
替换为你的 Ollama 服务器 URL。OllamaChatModel
实现,你可以将其注入到你的类中。
以下是一个简单的 @RestController
类的示例,该类使用聊天模型进行文本生成:
OllamaChatModel
。
OllamaChatModel 实现了 ChatModel
和 StreamingChatModel
,并使用低级 API连接到 Ollama 服务。
要使用它,请将 spring-ai-ollama
依赖项添加到项目的 Maven pom.xml
或 Gradle build.gradle
构建文件中:
spring-ai-ollama
依赖项还提供对 OllamaEmbeddingModel
的访问。
有关 OllamaEmbeddingModel
的更多信息,请参阅 Ollama 嵌入模型 部分。OllamaChatModel
实例并将其用于发送文本生成请求:
OllamaOptions
为所有聊天请求提供配置信息。
OllamaApi
聊天接口和构建块:
OllamaApi
是一个低级 API,不建议直接使用。请改用 OllamaChatModel
。