|
最新快照版本请使用Spring AI 1.1.0! |
奥拉玛·查特
通过 Ollama 你可以在本地运行各种大型语言模型(LLM),并从中生成文本。
Spring AI 支持 Ollama 聊天补全功能,支持以下功能OllamaChatModel应用程序接口。
| Ollama 也提供兼容 OpenAI API 的端点。 OpenAI API 兼容性部分解释了如何使用 Spring AI OpenAI 连接到 Ollama 服务器。 |
前提条件
你首先需要访问一个Ollama实例。有几种选择,包括以下几种:
-
下载并安装 Ollama 到你本地的机器上。
-
通过 Kubernetes Service Bindings 绑定到 Ollama 实例。
你可以从 Ollama 模型库中提取你想在应用中使用的模型:
ollama pull <model-name>
你也可以抽取成千上万个免费的GGUF拥抱面模特:
ollama pull hf.co/<username>/<model-repository>
或者,你也可以启用自动下载任何需要模型的选项:自动拉取模型。
自动配置
|
春季AI自动配置、起始模块的工件名称发生了重大变化。 更多信息请参阅升级说明。 |
Spring AI 为 Ollama 聊天集成提供了 Spring Boot 自动配置。
要启用它,请在项目的Maven中添加以下依赖pom.xml或者Gradlebuild.gradle构建文件:
-
Maven
-
Gradle
<dependency>
<groupId>org.springframework.ai</groupId>
<artifactId>spring-ai-starter-model-ollama</artifactId>
</dependency>
dependencies {
implementation 'org.springframework.ai:spring-ai-starter-model-ollama'
}
| 请参考依赖管理部分,将Spring AI的物料清单添加到你的构建文件中。 |
基础性质
前缀spring.ai.ollama是配置与Ollama连接的属性前缀。
属性 |
描述 |
默认值 |
spring.ai.ollama.base-url |
Ollama API 服务器运行的基础网址。 |
|
以下是初始化 Ollama 积分和自动拉取模型的属性。
属性 |
描述 |
默认值 |
spring.ai.ollama.init.pull-model-strategy |
是否在启动时拉取模型以及如何进行。 |
|
spring.ai.ollama.init.timeout |
模型被拉出需要等多久。 |
|
spring.ai.ollama.init.max重试 |
模型拉取作的最大重试次数。 |
|
spring.ai.ollama.init.chat.include |
在初始化任务中包含这类模型。 |
|
spring.ai.ollama.init.chat.additional-models |
除了通过默认属性配置的模型外,还需要初始化更多模型。 |
|
聊天属性
|
现在,启用和禁用聊天自动配置通过带有前缀的顶层属性进行配置 要启用,spring.ai.model.chat=ollama(默认是启用的) 要禁用,可以选择 spring.ai.model.chat=none(或任何不匹配 ollama 的值) 此改动旨在允许配置多个模型。 |
前缀spring.ai.ollama.chat.options.是配置 Ollama 聊天模型的属性前缀。
它包含了 Ollama 请求(高级)参数,例如型,保持生命和格式以及Ollama模型选项性能。
以下是 Ollama 聊天模型的高级请求参数:
属性 |
描述 |
默认值 |
spring.ai.ollama.chat.enabled(已移除且不再有效) |
启用 Ollama 聊天模式。 |
true |
spring.ai.model.chat |
启用 Ollama 聊天模式。 |
奥拉玛 |
spring.ai.ollama.chat.options.model |
支持的型号名称。 |
密斯特拉尔 |
spring.ai.ollama.chat.options.format |
回复的格式。目前,唯一被接受的值为 |
- |
spring.ai.ollama.chat.options.keep_alive |
控制模型在请求后存储在内存中的持续时间 |
5米 |
剩余的选项属性基于 Ollama 有效参数和值以及 Ollama 类型。默认值基于 Ollama 类型的默认值。
属性 |
描述 |
默认值 |
spring.ai.ollama.chat.options.numa |
是否使用NUMA。 |
false |
spring.ai.ollama.chat.options.num-ctx |
设置用于生成下一个Tokens的上下文窗口大小。 |
2048 |
spring.ai.ollama.chat.options.num-batch |
提示处理最大批次大小。 |
512 |
Spring.ai.ollama.chat.options.num-GPU |
要发送给GPU的层数。在macOS上,默认设置为1以启用金属支持,使用0用于禁用。这里的 1 表示 NumGPU 应动态设置 |
-1 |
spring.ai.ollama.chat.options.main-GPU |
使用多GPU时,该选项控制用于小型张量,因此分散计算在所有GPU上的开销不值得。这块GPU会用更多的显存来存储临时缓冲区以实现临时效果。 |
0 |
spring.ai.ollama.chat.options.low-vram |
- |
false |
spring.ai.ollama.chat.options.f16-kv |
- |
true |
spring.ai.ollama.chat.options.logits-all |
返回所有Tokens的日志,而不仅仅是最后一个。为了使完备化返回 logprobs,这必须成立。 |
- |
spring.ai.ollama.chat.options.vocab-only |
只加载词汇,不要加载权重。 |
- |
spring.ai.ollama.chat.options.use-mmap |
默认情况下,模型会映射到内存中,这使得系统只能根据需要加载模型的必要部分。然而,如果模型大于你的总内存,或者系统内存不足,使用mmap可能会增加分页出错的风险,从而对性能产生负面影响。禁用 mmap 会让加载时间变慢,但如果你没用 mlock,可能会减少页面导出。注意,如果模型内存大于总内存,关闭 mmap 会阻止模型加载。 |
零 |
spring.ai.ollama.chat.options.use-mlock |
将模型锁定在内存中,防止在内存映射时被替换。这可以提升性能,但会牺牲内存映射的一些优势,因为需要更多内存运行,且模型加载到内存时可能变慢加载速度。 |
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表示相对于最可能Tokens概率的最小概率。例如,当p=0.05且最可能的token概率为0.9时,值小于0.045的logit会被过滤掉。 |
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.重复-罚球 |
规定重复行为应受到多大的惩罚。更高的数值(例如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将停止生成文本并返回。通过在模型文件中指定多个独立的停止参数,可以设置多个停止模式。 |
- |
spring.ai.ollama.chat.options.functions |
函数列表,以名称标识,以支持函数调用一次提示请求。带有这些名称的函数必须存在于 functionCallbacks 注册表中。 |
- |
spring.ai.ollama.chat.options.proxy-tool-calls |
如果属实,Spring AI不会在内部处理函数调用,而是会代理给客户端。那么,客户端负责处理函数调用,将其派遣到相应的函数,并返回结果。如果 false(默认),Spring AI 会在内部处理函数调用。仅适用于支持函数调用的聊天模型 |
false |
所有以spring.ai.ollama.chat.options.可以通过在运行时为 Run 添加请求特定的运行时选项来覆盖提示叫。 |
运行时选项
OllamaOptions.java类提供模型配置,如使用模型、温度等。
启动时,默认选项可以配置为OllamaChatModel(api, options)构造者或spring.ai.ollama.chat.options.*性能。
运行时,您可以通过添加新的、针对特定请求的选项来覆盖默认选项提示叫。 例如,要覆盖特定请求的默认型号和温度:
ChatResponse response = chatModel.call(
new Prompt(
"Generate the names of 5 famous pirates.",
OllamaOptions.builder()
.model(OllamaModel.LLAMA3_1)
.temperature(0.4)
.build()
));
| 除了模型特定的 OllamaOptions,你还可以使用用 ChatOptions#builder() 创建的便携式 ChatOptions 实例。 |
自动拉车模型
Spring AI Ollama 可以在 Ollama 实例中不可用的模型时自动拉取模型。此功能对开发和测试以及将应用部署到新环境时尤其有用。
| 你也可以按名字抽取成千上万个免费的GGUF抱脸模型。 |
拉取模型有三种策略:
-
总是(定义于拉取模型策略。始终):即使模型已经可用,也一定要拉出。这有助于确保你使用的是最新版本的模型。 -
when_missing(定义于PullModelStrategy.WHEN_MISSING只有当模型还没有时才会拉出。这可能会导致使用旧版本的模型。 -
从不(定义于PullModelStrategy.绝不绝不要自动拉取模型。
| 由于模型下载可能延迟,生产环境中不建议自动拉取。建议提前评估并预先下载必要的模型。 |
通过配置属性和默认选项定义的所有模型,启动时都可以自动拉取。您可以使用配置属性配置拉取策略、超时和最大重试次数:
spring:
ai:
ollama:
init:
pull-model-strategy: always
timeout: 60s
max-retries: 1
| 应用程序在Ollama中所有指定型号都可用后,才会完成初始化。根据型号大小和网络连接速度,这可能会显著降低应用启动速度。 |
你可以在启动时初始化额外的模型,这对运行时动态使用的模型非常有用:
spring:
ai:
ollama:
init:
pull-model-strategy: always
chat:
additional-models:
- llama3.2
- qwen2.5
如果你只想将拉取策略应用于特定类型的模型,可以将聊天模型排除在初始化任务之外:
spring:
ai:
ollama:
init:
pull-model-strategy: always
chat:
include: false
该配置将拉取策略应用于除聊天模型外的所有模型。
函数调用
你可以用OllamaChatModel并让 Ollama 模型智能选择输出包含参数的 JSON 对象,以调用一个或多个注册函数。这是一种强大的技术,将大型语言模型功能与外部工具和 API 连接起来。阅读更多关于工具调用的信息。
| 你需要 Ollama 0.2.8 或更新版本才能使用功能调用功能,需要 Ollama 0.4.6 或更新版本才能在流式模式下使用。 |
模 态
多模态指的是模型能够同时理解和处理来自多种来源的信息,包括文本、图像、音频及其他数据格式。
支持多模态的 Ollama 模型包括 LLaVA 和 BakLLaVA(详见完整列表)。更多详情请参见 LLaVA:大型语言与视觉助手。
Ollama 消息 API 提供了一个“images”参数,用于将 base64 编码的图片列表与消息一同整合。
Spring AI 的消息界面通过引入媒体类型,促进了多模态 AI 模型的发展。该类型包含了消息中媒体附件的数据和详细信息,利用 Spring 的org.springframework.util.MimeType以及一个org.springframework.core.io.Resource对于原始媒体数据。
以下是摘自OllamaChatModelMultimodalIT.java的简明代码示例,展示了用户文本与图像的融合。
var imageResource = new ClassPathResource("/multimodal.test.png");
var userMessage = new UserMessage("Explain what do you see on this picture?",
new Media(MimeTypeUtils.IMAGE_PNG, this.imageResource));
ChatResponse response = chatModel.call(new Prompt(this.userMessage,
OllamaOptions.builder().model(OllamaModel.LLAVA)).build());
示例展示了一个以multimodal.test.png图像:
并附上短信“请解释你在这张图片上看到了什么?”,并生成如下回复:
The image shows a small metal basket filled with ripe bananas and red apples. The basket is placed on a surface, which appears to be a table or countertop, as there's a hint of what seems like a kitchen cabinet or drawer in the background. There's also a gold-colored ring visible behind the basket, which could indicate that this photo was taken in an area with metallic decorations or fixtures. The overall setting suggests a home environment where fruits are being displayed, possibly for convenience or aesthetic purposes.
结构化输出
配置
Spring AI 允许你通过奥拉玛选项架构工人。
使用聊天选项生成器
你可以用奥拉玛选项架构师如下所示:
String jsonSchema = """
{
"type": "object",
"properties": {
"steps": {
"type": "array",
"items": {
"type": "object",
"properties": {
"explanation": { "type": "string" },
"output": { "type": "string" }
},
"required": ["explanation", "output"],
"additionalProperties": false
}
},
"final_answer": { "type": "string" }
},
"required": ["steps", "final_answer"],
"additionalProperties": false
}
""";
Prompt prompt = new Prompt("how can I solve 8x + 7 = -23",
OllamaOptions.builder()
.model(OllamaModel.LLAMA3_2.getName())
.format(new ObjectMapper().readValue(jsonSchema, Map.class))
.build());
ChatResponse response = this.ollamaChatModel.call(this.prompt);
与 BeanOutputConverter 工具集成
你可以利用现有的 BeanOutputConverter 工具,自动从你的域对象生成 JSON 模式,然后将结构化响应转换为域特定的实例:
record MathReasoning(
@JsonProperty(required = true, value = "steps") Steps steps,
@JsonProperty(required = true, value = "final_answer") String finalAnswer) {
record Steps(
@JsonProperty(required = true, value = "items") Items[] items) {
record Items(
@JsonProperty(required = true, value = "explanation") String explanation,
@JsonProperty(required = true, value = "output") String output) {
}
}
}
var outputConverter = new BeanOutputConverter<>(MathReasoning.class);
Prompt prompt = new Prompt("how can I solve 8x + 7 = -23",
OllamaOptions.builder()
.model(OllamaModel.LLAMA3_2.getName())
.format(outputConverter.getJsonSchemaMap())
.build());
ChatResponse response = this.ollamaChatModel.call(this.prompt);
String content = this.response.getResult().getOutput().getText();
MathReasoning mathReasoning = this.outputConverter.convert(this.content);
确保你使用以下条件@JsonProperty(必要=真,...)用于生成准确标记字段的模式的注释必填. 虽然 JSON Schema 是可选的,但建议这样结构化响应才能正常工作。 |
OpenAI API 兼容性
Ollama 兼容 OpenAI API,你可以使用 Spring AI OpenAI 客户端与 Ollama 通信并使用工具。为此,你需要配置 OpenAI 为你的 Ollama 实例设置基础 URL:spring.ai.openai.chat.base-url=http://localhost:11434并选择提供的Ollama型号之一:spring.ai.openai.chat.options.model=mistral.
查看OllamaWithOpenAiChatModelIT.java测试,了解如何使用Ollama而非Spring AI OpenAI的示例。
拥抱面模特
Ollama 可以开箱即用地访问所有 GGUF 的抱脸聊天模型。你可以按名称提取这些模型中的任意一个:ollama pull hf.co/<username>/<model-repository>或配置自动拉取策略:自动拉取模型:
spring.ai.ollama.chat.options.model=hf.co/bartowski/gemma-2-2b-it-GGUF
spring.ai.ollama.init.pull-model-strategy=always
-
spring.ai.ollama.chat.options.model: 指定了使用拥抱面GGUF模型。 -
spring.ai.ollama.init.pull-model-strategy=always:(可选)启动时启用自动拉取模型。生产时,应提前下载模型以避免延迟:奥拉玛拉 hf.co/bartowski/gemma-2-2b-it-GGUF.
采样控制器
创建一个新的 Spring Boot 项目并添加Spring-ai-starter-model-ollama对你的POM(或Gradle)依赖。
添加一个application.yaml文件,在src/主/资源目录,用于启用和配置 Ollama 聊天模型:
spring:
ai:
ollama:
base-url: http://localhost:11434
chat:
options:
model: mistral
temperature: 0.7
替换base-url用你的 Ollama 服务器网址。 |
这将产生OllamaChatModel你可以注入到你的类中。这里有一个简单的例子@RestController使用聊天模式生成文本的课程。
@RestController
public class ChatController {
private final OllamaChatModel chatModel;
@Autowired
public ChatController(OllamaChatModel chatModel) {
this.chatModel = chatModel;
}
@GetMapping("/ai/generate")
public Map<String,String> generate(@RequestParam(value = "message", defaultValue = "Tell me a joke") String message) {
return Map.of("generation", this.chatModel.call(message));
}
@GetMapping("/ai/generateStream")
public Flux<ChatResponse> generateStream(@RequestParam(value = "message", defaultValue = "Tell me a joke") String message) {
Prompt prompt = new Prompt(new UserMessage(message));
return this.chatModel.stream(prompt);
}
}
手动配置
如果你不想用 Spring Boot 的自动配置,可以手动配置OllamaChatModel在你的应用程序中。OllamaChatModel 实现了聊天模型和StreamingChatModel并使用低级 OllamaApi 客户端连接 Ollama 服务。
使用时,添加春艾奥拉玛对你项目Maven的依赖pom.xml或者Gradlebuild.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的物料清单添加到你的构建文件中。 |
这春艾奥拉玛依赖还提供访问OllamaEmbeddingModel. 欲了解更多关于OllamaEmbeddingModel请参阅奥拉玛嵌入模型部分。 |
接下来,创建一个OllamaChatModel实例并使用它来发送文本生成请求:
var ollamaApi = OllamaApi.builder().build();
var chatModel = OllamaChatModel.builder()
.ollamaApi(ollamaApi)
.defaultOptions(
OllamaOptions.builder()
.model(OllamaModel.MISTRAL)
.temperature(0.9)
.build())
.build();
ChatResponse response = this.chatModel.call(
new Prompt("Generate the names of 5 famous pirates."));
// Or with streaming responses
Flux<ChatResponse> response = this.chatModel.stream(
new Prompt("Generate the names of 5 famous pirates."));
这奥拉玛选项提供所有聊天请求的配置信息。
低级 OllamaApi 客户端
下图展示了奥拉玛阿皮聊天界面与构建模块:
这奥拉玛阿皮是一个低级别API,不推荐直接使用。使用OllamaChatModel相反。 |
这里有一个简单的片段,展示了如何以程序方式使用该 API:
OllamaApi ollamaApi = new OllamaApi("YOUR_HOST:YOUR_PORT");
// Sync request
var request = ChatRequest.builder("orca-mini")
.stream(false) // not streaming
.messages(List.of(
Message.builder(Role.SYSTEM)
.content("You are a geography teacher. You are talking to a student.")
.build(),
Message.builder(Role.USER)
.content("What is the capital of Bulgaria and what is the size? "
+ "What is the national anthem?")
.build()))
.options(OllamaOptions.builder().temperature(0.9).build())
.build();
ChatResponse response = this.ollamaApi.chat(this.request);
// Streaming request
var request2 = ChatRequest.builder("orca-mini")
.ttream(true) // streaming
.messages(List.of(Message.builder(Role.USER)
.content("What is the capital of Bulgaria and what is the size? " + "What is the national anthem?")
.build()))
.options(OllamaOptions.builder().temperature(0.9).build().toMap())
.build();
Flux<ChatResponse> streamingResponse = this.ollamaApi.streamingChat(this.request2);