NVIDIA 聊天

NVIDIA LLM API 是一个代理 AI 推理引擎，提供来自 各种提供商的广泛模型。

Spring AI 通过重用现有的 OpenAI 客户端与 NVIDIA LLM API 集成。 为此，您需要将 base-url 设置为 integrate.api.nvidia.com，选择提供的 LLM 模型之一，并获取其 api-key。

spring ai nvidia llm api 1

注意：NVIDIA LLM API 要求明确设置 max-tokens 参数，否则将抛出服务器错误。

查看 NvidiaWithOpenAiChatModelIT.java 测试， 了解如何使用 Spring AI 与 NVIDIA LLM API 的示例。

前提条件

  • 创建 NVIDIA 账户并确保有足够的积分。

  • 选择要使用的 LLM 模型。例如下面截图中的 meta/llama-3.1-70b-instruct。

  • 从所选模型的页面，您可以获取访问该模型的 api-key。

spring ai nvidia registration

自动配置

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

Spring AI 为 OpenAI 聊天客户端提供 Spring Boot 自动配置。 要启用它，请在项目的 Maven pom.xml 文件中添加以下依赖：

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

或添加到 Gradle build.gradle 构建文件中。

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

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

聊天属性

重试属性

前缀 spring.ai.retry 用作配置 OpenAI 聊天模型重试机制的属性前缀。

属性 描述 默认值

spring.ai.retry.max-attempts

最大重试尝试次数。

10

spring.ai.retry.backoff.initial-interval

指数退避策略的初始睡眠持续时间。

2 秒

spring.ai.retry.backoff.multiplier

退避间隔乘数。

5

spring.ai.retry.backoff.max-interval

最大退避持续时间。

3 分钟

spring.ai.retry.on-client-errors

如果为 false，则抛出 NonTransientAiException，并且不对 4xx 客户端错误代码进行重试

false

spring.ai.retry.exclude-on-http-codes

不应触发重试的 HTTP 状态代码列表（例如抛出 NonTransientAiException）。

空

spring.ai.retry.on-http-codes

应触发重试的 HTTP 状态代码列表（例如抛出 TransientAiException）。

空

连接属性

前缀 spring.ai.openai 用作连接到 OpenAI 的属性前缀。

属性 描述 默认值

spring.ai.openai.base-url

要连接的 URL。必须设置为 integrate.api.nvidia.com

-

spring.ai.openai.api-key

NVIDIA API 密钥

-

配置属性

聊天自动配置的启用和禁用现在通过前缀为 spring.ai.model.chat 的顶级属性进行配置。

要启用，spring.ai.model.chat=openai（默认启用）

要禁用，spring.ai.model.chat=none（或任何不匹配 openai 的值）

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

前缀 spring.ai.openai.chat 是用于配置 OpenAI 聊天模型实现的属性前缀。

属性 描述 默认值

spring.ai.openai.chat.enabled（已移除且不再有效）

启用 OpenAI 聊天模型。

true

spring.ai.model.chat

启用 OpenAI 聊天模型。

openai

spring.ai.openai.chat.base-url

可选覆盖 spring.ai.openai.base-url 以提供聊天特定的 url。必须设置为 integrate.api.nvidia.com

-

spring.ai.openai.chat.api-key

可选覆盖 spring.ai.openai.api-key 以提供聊天特定的 api-key

-

spring.ai.openai.chat.options.model

要使用的 NVIDIA LLM 模型

-

spring.ai.openai.chat.options.temperature

用于控制生成完成项的明显创造性的采样温度。较高的值将使输出更随机，而较低的值将使结果更集中和确定性。不建议为相同的完成请求同时修改温度和 top_p，因为这两个设置的交互难以预测。

0.8

spring.ai.openai.chat.options.frequencyPenalty

-2.0 到 2.0 之间的数字。正值会根据文本中现有频率对新标记进行惩罚，降低模型重复相同行的可能性。

0.0f

spring.ai.openai.chat.options.maxTokens

在聊天完成中生成的最大标记数。输入标记和生成标记的总长度受模型上下文长度的限制。

注意：NVIDIA LLM API 要求明确设置 max-tokens 参数，否则将抛出服务器错误。

spring.ai.openai.chat.options.n

为每个输入消息生成多少个聊天完成选项。请注意，您将根据所有选项中生成的标记数量收费。将 n 保持为 1 以最小化成本。

1

spring.ai.openai.chat.options.presencePenalty

-2.0 到 2.0 之间的数字。正值会根据它们是否出现在文本中到目前为止对新标记进行惩罚，增加模型谈论新主题的可能性。

-

spring.ai.openai.chat.options.responseFormat

指定模型必须输出的格式的对象。设置为 { "type": "json_object" } 启用 JSON 模式，这保证模型生成的消息是有效的 JSON。

-

spring.ai.openai.chat.options.seed

此功能处于测试阶段。如果指定，我们的系统将尽最大努力进行确定性采样，使得具有相同种子和参数的重复请求应该返回相同的结果。

-

spring.ai.openai.chat.options.stop

API 将停止生成更多标记的最多 4 个序列。

-

spring.ai.openai.chat.options.topP

温度采样的替代方案，称为核采样，其中模型考虑具有 top_p 概率质量的标记的结果。所以 0.1 意味着只考虑构成前 10% 概率质量的标记。我们通常建议修改这个或温度，但不要同时修改两者。

-

spring.ai.openai.chat.options.tools

模型可能调用的工具列表。目前，仅支持函数作为工具。使用此选项提供模型可能为其生成 JSON 输入的函数列表。

-

spring.ai.openai.chat.options.toolChoice

控制模型调用哪个（如果有）函数。none 意味着模型不会调用函数，而是生成消息。auto 意味着模型可以在生成消息或调用函数之间进行选择。通过 {"type: "function", "function": {"name": "my_function"}} 指定特定函数会强制模型调用该函数。当没有函数存在时，none 是默认值。如果存在函数，auto 是默认值。

-

spring.ai.openai.chat.options.user

代表您的最终用户的唯一标识符，可以帮助 OpenAI 监控和检测滥用。

-

spring.ai.openai.chat.options.functions

函数名称列表，用于在单个提示请求中启用函数调用。具有这些名称的函数必须存在于 functionCallbacks 注册表中。

-

spring.ai.openai.chat.options.stream-usage

（仅用于流式传输）设置为添加一个包含整个请求的标记使用统计信息的额外块。此块的 choices 字段是一个空数组，所有其他块也将包含一个 usage 字段，但值为 null。

false

spring.ai.openai.chat.options.proxy-tool-calls

如果为 true，Spring AI 将不会在内部处理函数调用，而是将它们代理给客户端。然后客户端负责处理函数调用，将它们分派到适当的函数，并返回结果。如果为 false（默认值），Spring AI 将在内部处理函数调用。仅适用于支持函数调用的聊天模型

false

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

运行时选项

OpenAiChatOptions.java 提供模型配置，例如要使用的模型、温度、频率惩罚等。

在启动时，默认选项可以通过 OpenAiChatModel(api, options) 构造函数或 spring.ai.openai.chat.options.* 属性进行配置。

在运行时，您可以通过在 Prompt 调用中添加新的、请求特定的选项来覆盖默认选项。 例如，要覆盖特定请求的默认模型和温度：

ChatResponse response = chatModel.call(
    new Prompt(
        "Generate the names of 5 famous pirates.",
        OpenAiChatOptions.builder()
            .model("mixtral-8x7b-32768")
            .temperature(0.4)
        .build()
    ));

提示：除了模型特定的 OpenAiChatOptions 之外，您还可以使用可移植的 ChatOptions 实例，使用 ChatOptions#builder() 创建。

函数调用

NVIDIA LLM API 在选择支持它的模型时支持工具/函数调用。

spring ai nvidia function calling

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

工具示例

以下是使用 Spring AI 的 NVIDIA LLM API 函数调用的简单示例：

spring.ai.openai.api-key=${NVIDIA_API_KEY}
spring.ai.openai.base-url=https://integrate.api.nvidia.com
spring.ai.openai.chat.options.model=meta/llama-3.1-70b-instruct
spring.ai.openai.chat.options.max-tokens=2048
@SpringBootApplication
public class NvidiaLlmApplication {

    public static void main(String[] args) {
        SpringApplication.run(NvidiaLlmApplication.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") // 通过 bean 名称引用。
                .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);
        }
    }
}

在此示例中，当模型需要天气信息时，它将自动调用 weatherFunction bean，然后可以获取实时天气数据。 预期响应如下："阿姆斯特丹的天气目前是 20 摄氏度，巴黎的天气目前是 25 摄氏度。"

阅读更多关于 OpenAI 函数调用的信息。

示例控制器

创建一个新的 Spring Boot 项目，并将 spring-ai-starter-model-openai 添加到您的 pom（或 gradle）依赖项中。

在 src/main/resources 目录下添加一个 application.properties 文件，以启用和配置 OpenAi 聊天模型：

spring.ai.openai.api-key=${NVIDIA_API_KEY}
spring.ai.openai.base-url=https://integrate.api.nvidia.com
spring.ai.openai.chat.options.model=meta/llama-3.1-70b-instruct

# NVIDIA LLM API 不支持嵌入，所以我们需要禁用它。
spring.ai.openai.embedding.enabled=false

# NVIDIA LLM API 要求明确设置此参数，否则将抛出服务器内部错误。
spring.ai.openai.chat.options.max-tokens=2048

提示：替换 api-key 为您的 NVIDIA 凭据。

注意：NVIDIA LLM API 要求明确设置 max-token 参数，否则将抛出服务器错误。

这是一个使用聊天模型进行文本生成的简单 @Controller 类的示例。

@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);
    }
}