NVIDIA Chat

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

Spring AI 通过重用现有的 OpenAI 客户端来与 NVIDIA LLM API 集成。为此，您需要将基本 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 为 OpenAI Chat 客户端提供 Spring Boot 自动配置。要启用它，请将以下依赖项添加到项目的 Maven pom.xml 文件

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

或到您的 Gradle build.gradle 构建文件。

dependencies {
    implementation 'org.springframework.ai:spring-ai-openai-spring-boot-starter'
}
请参阅 依赖项管理 部分，以将 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.openai.chat 是属性前缀，允许您配置 OpenAI 的聊天模型实现。

属性 描述 默认值

spring.ai.openai.chat.enabled

启用 OpenAI 聊天模型。

true

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

要使用的采样温度，控制生成的完成的明显创造力。较高的值将使输出更随机，而较低的值将使结果更集中和确定性。不建议为相同的完成请求修改 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 模式，这保证模型生成的 message 是有效的 JSON。

-

spring.ai.openai.chat.options.seed

此功能处于 Beta 阶段。如果指定，我们的系统将尽最大努力确定性地进行采样，以便使用相同的 seed 和参数重复请求应返回相同的结果。

-

spring.ai.openai.chat.options.stop

最多 4 个序列，API 将在这些序列处停止生成更多令牌。

-

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()
            .withModel("mixtral-8x7b-32768")
            .withTemperature(0.4)
        .build()
    ));
除了特定于模型的OpenAiChatOptions之外，您还可以使用可移植的ChatOptions实例，该实例使用ChatOptionsBuilder#builder()创建。

函数调用

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

spring ai nvidia function calling

您可以使用自定义 Java 函数注册您的 ChatModel，并让提供的模型智能地选择输出包含要调用一个或多个已注册函数的参数的 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") // 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);
        }
    }
}

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

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

示例控制器

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

添加一个application.properties文件，位于src/main/resources目录下，以启用和配置 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

# The NVIDIA LLM API doesn't support embeddings, so we need to disable it.
spring.ai.openai.embedding.enabled=false

# The NVIDIA LLM API requires this parameter to be set explicitly or server internal error will be thrown.
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);
    }
}