最新快照版本请使用Spring AI 1.1.0spring-doc.cadn.net.cn

Docker 模型运行者聊天

Docker Model Runner 是一款 AI 推理引擎,提供来自不同提供商的多种模型。spring-doc.cadn.net.cn

Spring AI 通过重用现有的 OpenAI 支持版本,与 Docker 模型运行器集成聊天客户端. 为此,将基础URL设置为localhost:12434/engines并选择提供的LLM模型之一。spring-doc.cadn.net.cn

检查DockerModelRunnerWithOpenAiChatModelIT.java测试 关于如何将 Docker 模型运行器与 Spring AI 结合的示例。spring-doc.cadn.net.cn

前提条件

请选择以下选项之一以启用模型运行器:spring-doc.cadn.net.cn

@Container
private static final DockerModelRunnerContainer DMR = new DockerModelRunnerContainer("alpine/socat:1.7.4.3-r0");

@Bean
public OpenAiApi chatCompletionApi() {
	var baseUrl = DMR.getOpenAIEndpoint();
	return OpenAiApi.builder().baseUrl(baseUrl).apiKey("test").build();
}

您可以通过阅读“本地运行 Docker LLM”博客文章来了解更多关于 Docker 模型运行器的知识。spring-doc.cadn.net.cn

自动配置

自1.0.0.M7版本起,Spring AI入门模块的工件ID已重命名。依赖名称现在应遵循模型、向量存储和MCP起始符的更新命名模式。 更多信息请参阅升级说明spring-doc.cadn.net.cn

Spring AI 为 OpenAI 聊天客户端提供 Spring Boot 自动配置。 要启用它,请在项目的 Maven 中添加以下依赖pom.xml文件:spring-doc.cadn.net.cn

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

或者在你的Gradle上添加以下内容build.gradle构建文件。spring-doc.cadn.net.cn

dependencies {
    implementation 'org.springframework.ai:spring-ai-starter-model-openai'
}
请参考依赖管理部分,将Spring AI的物料清单添加到你的构建文件中。

聊天属性

重试属性

前缀spring.ai.retry作为属性前缀,用于配置OpenAI聊天模型的重试机制。spring-doc.cadn.net.cn

属性 描述 默认值

spring.ai.retry.max尝试spring-doc.cadn.net.cn

重试次数上限。spring-doc.cadn.net.cn

10spring-doc.cadn.net.cn

spring.ai.retry.backoff.initial-intervalspring-doc.cadn.net.cn

指数式退避政策的初始睡眠时长。spring-doc.cadn.net.cn

两秒钟。spring-doc.cadn.net.cn

spring.ai.retry.backoff.multiplierspring-doc.cadn.net.cn

后退间隔倍数。spring-doc.cadn.net.cn

5spring-doc.cadn.net.cn

spring.ai.retry.backoff.max区间spring-doc.cadn.net.cn

最大退回时间。spring-doc.cadn.net.cn

3分钟。spring-doc.cadn.net.cn

spring.ai.retry.on-client-errorsspring-doc.cadn.net.cn

如果为假,抛出非瞬态AiException,且不要尝试重试4xx客户端错误代码spring-doc.cadn.net.cn

falsespring-doc.cadn.net.cn

spring.ai.retry.exclude-on-http-codesspring-doc.cadn.net.cn

不应该触发重试的HTTP状态码列表(例如抛出非瞬态Ai异常)。spring-doc.cadn.net.cn

emptyspring-doc.cadn.net.cn

spring.ai.retry.on-http-codesspring-doc.cadn.net.cn

应触发重试的HTTP状态码列表(例如抛出TransientAiException)。spring-doc.cadn.net.cn

emptyspring-doc.cadn.net.cn

连接性质

前缀春.ai.openai作为属性前缀,允许你连接到OpenAI。spring-doc.cadn.net.cn

属性 描述 默认值

Spring.ai.openai.base-urlspring-doc.cadn.net.cn

连接的网址。必须设置为hub.docker.com/u/aispring-doc.cadn.net.cn

-spring-doc.cadn.net.cn

spring.ai.openai.api-key(春.ai.openai.api-key)spring-doc.cadn.net.cn

任何字符串spring-doc.cadn.net.cn

-spring-doc.cadn.net.cn

配置属性

现在通过带有前缀的顶层属性来启用和禁用聊天自动配置spring.ai.model.chat.spring-doc.cadn.net.cn

为了实现,spring.ai.model.chat=openai(默认情况下已启用)spring-doc.cadn.net.cn

要使之失效,spring.ai.model.chat=none(或者任何与OpenAI不匹配的数值)spring-doc.cadn.net.cn

这一变化允许在你的应用中配置多个模型。spring-doc.cadn.net.cn

前缀spring.ai.openai.chat是允许您配置OpenAI聊天模型实现的属性前缀。spring-doc.cadn.net.cn

属性 描述 默认值

spring.ai.openai.chat.enabled(已移除且不再有效)spring-doc.cadn.net.cn

启用OpenAI聊天模型。spring-doc.cadn.net.cn

truespring-doc.cadn.net.cn

spring.ai.model.chatspring-doc.cadn.net.cn

启用OpenAI聊天模型。spring-doc.cadn.net.cn

OpenAIspring-doc.cadn.net.cn

spring.ai.openai.chat.base-urlspring-doc.cadn.net.cn

可选覆盖Spring.ai.openai.base-url提供一个专门针对聊天的网址。必须设置为localhost:12434/enginesspring-doc.cadn.net.cn

-spring-doc.cadn.net.cn

spring.ai.openai.chat.api-key。spring-doc.cadn.net.cn

可选覆盖 spring.ai.openai.api-key,提供针对聊天的 api-key。spring-doc.cadn.net.cn

-spring-doc.cadn.net.cn

spring.ai.openai.chat.options.modelspring-doc.cadn.net.cn

用于使用的LLM模型spring-doc.cadn.net.cn

-spring-doc.cadn.net.cn

spring.ai.openai.chat.options.temperature.spring-doc.cadn.net.cn

采样温度控制了生成完备作品的显得创造力。值越高,输出越随机,值越低,结果越聚焦且确定性强。不建议对相同的完井请求调整温度和top_p,因为这两种设置的相互作用难以预测。spring-doc.cadn.net.cn

0.8spring-doc.cadn.net.cn

spring.ai.openai.chat.options.frequency 惩罚spring-doc.cadn.net.cn

数字介于-2.0到2.0之间。正值会根据新标记在文本中已有的频率进行惩罚,降低模型逐字重复同一行的可能性。spring-doc.cadn.net.cn

0.0fspring-doc.cadn.net.cn

spring.ai.openai.chat.options.maxTokensspring-doc.cadn.net.cn

聊天补全时最多可生成的Tokens数。输入标记和生成标记的总长度受模型上下文长度限制。spring-doc.cadn.net.cn

-spring-doc.cadn.net.cn

spring.ai.openai.chat.options.nspring-doc.cadn.net.cn

每个输入消息需要生成多少聊天补全选项。请注意,你将根据所有选项中生成的Tokens数量收费。保持n为1以降低成本。spring-doc.cadn.net.cn

1spring-doc.cadn.net.cn

spring.ai.openai.chat.options.presence惩罚spring-doc.cadn.net.cn

数字介于-2.0到2.0之间。正值会根据新Tokens是否出现在文本中来惩罚它们,从而提高模型讨论新话题的可能性。spring-doc.cadn.net.cn

-spring-doc.cadn.net.cn

spring.ai.openai.chat.options.response格式spring-doc.cadn.net.cn

一个对象,指定模型必须输出的格式。设置为{ “类型”:“json_object” }启用 JSON 模式,保证模型生成的消息是有效的 JSON。spring-doc.cadn.net.cn

-spring-doc.cadn.net.cn

spring.ai.openai.chat.options.seedspring-doc.cadn.net.cn

该功能目前处于测试阶段。如果需要,我们的系统将尽最大努力采用确定性采样,使得使用相同的种子和参数重复请求应返回相同的结果。spring-doc.cadn.net.cn

-spring-doc.cadn.net.cn

spring.ai.openai.chat.options.stopspring-doc.cadn.net.cn

最多有4个序列,API会停止生成更多Tokens。spring-doc.cadn.net.cn

-spring-doc.cadn.net.cn

spring.ai.openai.chat.options.topPspring-doc.cadn.net.cn

另一种基于温度抽样的替代方案称为核抽样,模型考虑具有top_p概率质量的标记结果。因此,0.1意味着只考虑构成概率质量最高10%的标记。我们通常建议改变这个或温度,但不要两者兼顾。spring-doc.cadn.net.cn

-spring-doc.cadn.net.cn

spring.ai.openai.chat.options.toolsspring-doc.cadn.net.cn

模型可能调用的工具列表。目前,仅支持函数作为工具。利用该列表提供模型可能生成 JSON 输入的函数列表。spring-doc.cadn.net.cn

-spring-doc.cadn.net.cn

spring.ai.openai.chat.options.toolChoicespring-doc.cadn.net.cn

控制模型调用的函数(如果有的话)。无函数表示模型不会调用函数,而是生成消息。自动表示模型可以选择生成消息或调用函数。通过{“类型:”函数“, ”函数“: {”name“: ”my_function“}}指定特定函数,强制模型调用该函数。当不存在函数时,默认为n。如果存在函数,则自动为默认。spring-doc.cadn.net.cn

-spring-doc.cadn.net.cn

spring.ai.openai.chat.options.userspring-doc.cadn.net.cn

一个代表终端用户的唯一标识符,可以帮助OpenAI监控和检测滥用行为。spring-doc.cadn.net.cn

-spring-doc.cadn.net.cn

spring.ai.openai.chat.options.functionsspring-doc.cadn.net.cn

函数列表,以名称标识,以支持函数调用一次提示请求。带有这些名称的函数必须存在于 functionCallbacks 注册表中。spring-doc.cadn.net.cn

-spring-doc.cadn.net.cn

spring.ai.openai.chat.options.stream-usagespring-doc.cadn.net.cn

(仅限流媒体播放)设置为为整个请求添加一个额外的块,包含Tokens使用统计数据。这选择该块的字段是空数组,其他块也会包含使用字段,但为空值。spring-doc.cadn.net.cn

falsespring-doc.cadn.net.cn

spring.ai.openai.chat.options.proxy-tool-callsspring-doc.cadn.net.cn

如果属实,Spring AI不会在内部处理函数调用,而是会代理给客户端。那么,客户端负责处理函数调用,将其派遣到相应的函数,并返回结果。如果 false(默认),Spring AI 会在内部处理函数调用。仅适用于支持函数调用的聊天模型spring-doc.cadn.net.cn

falsespring-doc.cadn.net.cn

所有以spring.ai.openai.chat.options。可以通过在运行时为 在提示叫。

运行时选项

OpenAiChatOptions.java提供模型配置,如所用模型、温度、频率惩罚等。spring-doc.cadn.net.cn

启动时,默认选项可以配置为OpenAiChatModel(api, options)构造者或spring.ai.openai.chat.options.*性能。spring-doc.cadn.net.cn

运行时,你可以通过添加新的、请求专属的选项来覆盖默认选项,提示叫。 例如,要覆盖特定请求的默认型号和温度:spring-doc.cadn.net.cn

ChatResponse response = chatModel.call(
    new Prompt(
        "Generate the names of 5 famous pirates.",
        OpenAiChatOptions.builder()
            .model("ai/gemma3:4B-F16")
        .build()
    ));
除了模型特定的OpenAiChatOptions外,你还可以使用用ChatOptions#builder()创建的便携式ChatOptions实例。

函数调用

Docker 模型运行器支持在选择支持工具/函数的模型时调用工具/函数。spring-doc.cadn.net.cn

你可以向ChatModel注册自定义Java函数,并让模型智能地选择输出包含参数的JSON对象,调用一个或多个注册函数。这是一种强大的技术,将LLM功能与外部工具和API连接起来。spring-doc.cadn.net.cn

工具示例

这里有一个简单的示例,说明如何用 Spring AI 调用 Docker Model Runner 函数:spring-doc.cadn.net.cn

spring.ai.openai.api-key=test
spring.ai.openai.base-url=http://localhost:12434/engines
spring.ai.openai.chat.options.model=ai/gemma3:4B-F16
@SpringBootApplication
public class DockerModelRunnerLlmApplication {

    public static void main(String[] args) {
        SpringApplication.run(DockerModelRunnerLlmApplication.class, args);
    }

    @Bean
    CommandLineRunner runner(ChatClient.Builder chatClientBuilder) {
        return args -> {
            var chatClient = chatClientBuilder.build();

            var response = chatClient.prompt()
                .user("What is the weather in Amsterdam and Paris?")
                .functions("weatherFunction") // reference by bean name.
                .call()
                .content();

            System.out.println(response);
        };
    }

    @Bean
    @Description("Get the weather in location")
    public Function<WeatherRequest, WeatherResponse> weatherFunction() {
        return new MockWeatherService();
    }

    public static class MockWeatherService implements Function<WeatherRequest, WeatherResponse> {

        public record WeatherRequest(String location, String unit) {}
        public record WeatherResponse(double temp, String unit) {}

        @Override
        public WeatherResponse apply(WeatherRequest request) {
            double temperature = request.location().contains("Amsterdam") ? 20 : 25;
            return new WeatherResponse(temperature, request.unit);
        }
    }
}

在这个例子中,当模型需要天气信息时,它会自动调用weatherFunctionBean,然后可以获取实时天气数据。预期的回复是:“阿姆斯特丹目前天气为20摄氏度,巴黎天气为25摄氏度。”spring-doc.cadn.net.cn

阅读更多关于OpenAI函数调用的信息。spring-doc.cadn.net.cn

采样控制器

创建一个新的 Spring Boot 项目并添加Spring-AI-starter-model-openai对你的POM(或Gradle)依赖。spring-doc.cadn.net.cn

添加一个application.properties文件,在src/主/资源目录,用于启用和配置OpenAi聊天模型:spring-doc.cadn.net.cn

spring.ai.openai.api-key=test
spring.ai.openai.base-url=http://localhost:12434/engines
spring.ai.openai.chat.options.model=ai/gemma3:4B-F16

# Docker Model Runner doesn't support embeddings, so we need to disable them.
spring.ai.openai.embedding.enabled=false

这里有一个简单的例子@Controller使用聊天模式生成文本的课程。spring-doc.cadn.net.cn

@RestController
public class ChatController {

    private final OpenAiChatModel chatModel;

    @Autowired
    public ChatController(OpenAiChatModel chatModel) {
        this.chatModel = chatModel;
    }

    @GetMapping("/ai/generate")
    public Map 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);
    }
}