Spring AI with NVIDIA LLM API

工程 | Christian Tzolov | 2024 年 8 月 20 日 | ...

Spring AI 现在支持 NVIDIA 的大型语言模型 API,可与各种 模型集成。通过利用 NVIDIA 的 OpenAI 兼容 API,Spring AI 允许开发人员通过熟悉的 Spring AI API 使用 NVIDIA 的 LLM。

SpringAI-NVIDIA-API-5

我们将探讨如何配置和使用 Spring AI OpenAI 聊天客户端连接到 NVIDIA LLM API。

  • 演示应用程序代码可在 nvidia-llm GitHub 存储库中找到。
  • SpringAI / NVIDIA 集成 文档

先决条件

  • 创建具有足够积分的 NVIDIA 账户。
  • 从 NVIDIA 的产品中选择您偏好的 LLM 模型。例如,如下截图中的 meta/llama-3.1-70b-instruct
  • 从模型页面获取您所选模型的 API 密钥。

NVIDIA-API-KEYS

依赖项

要开始,请将 Spring AI OpenAI starter 添加到您的项目中。对于 Maven,请将此添加到您的 pom.xml

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

对于 Gradle,请将此添加到您的 build.gradle

gradleCopydependencies {
  implementation 'org.springframework.ai:spring-ai-openai-spring-boot-starter'
}

请确保您已添加 Spring Milestone 和 Snapshot 仓库,并添加 Spring AI BOM

配置 Spring AI

要使用 Spring AI 的 NVIDIA LLM API,我们需要配置 OpenAI 客户端以指向 NVIDIA LLM API 端点并使用 NVIDIA 特定的模型。

将以下环境变量添加到您的项目中

export SPRING_AI_OPENAI_API_KEY=<NVIDIA_API_KEY>
export SPRING_AI_OPENAI_BASE_URL=https://integrate.api.nvidia.com
export SPRING_AI_OPENAI_CHAT_OPTIONS_MODEL=meta/llama-3.1-70b-instruct
export SPRING_AI_OPENAI_EMBEDDING_ENABLED=false
export SPRING_AI_OPENAI_CHAT_OPTIONS_MAX_TOKENS=2048

或者,您可以将它们添加到您的 application.properties 文件中

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.
spring.ai.openai.embedding.enabled=false
# The NVIDIA LLM API requires this parameter to be set explicitly or error will be thrown.
spring.ai.openai.chat.options.max-tokens=2048

关键点

  • api-key 设置为您的 NVIDIA API 密钥。
  • base-url 设置为 NVIDIA 的 LLM API 端点:https://integrate.api.nvidia.com
  • model 设置为 NVIDIA LLM API 上可用的模型之一。
  • NVIDIA LLM API 要求显式设置 max-tokens,否则将抛出服务器错误。
  • 由于 NVIDIA LLM API 仅为 LLM,我们可以禁用嵌入端点:embedding.enabled=false

有关完整 配置属性 列表,请查看参考文档。

代码示例

现在我们已经配置了 Spring AI 使用 NVIDIA LLM API,让我们来看一个在您的应用程序中使用它的简单示例。

@RestController
public class ChatController {

    private final ChatClient chatClient;

	@Autowired
    public ChatController(ChatClient.Builder builder) {
      this.chatClient = builder.build();
    }

    @GetMapping("/ai/generate")
    public String generate(@RequestParam(value = "message", defaultValue =  "Tell me a joke") String message) {
      return  chatClient.prompt().user(message).call().content();
    }

    @GetMapping("/ai/generateStream")
    public Flux<String> generateStream(
		@RequestParam(value = "message", defaultValue = "Tell me a joke") String message) {
      return chatClient.prompt().user(message).stream().content();
    }
}

ChatController.java 示例中,我们创建了一个简单的 REST 控制器,其中包含两个端点

  • /ai/generate:为给定的提示生成单个响应。
  • /ai/generateStream:流式传输响应,这对于较长的输出或实时交互非常有用。

工具/函数调用

NVIDIA LLM API 端点在选择支持工具/函数的模型之一时,支持工具/函数调用。

SpringAI-NVIDIA-FuncitonCalling

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

有关 SpringAI/OpenAI 函数调用 支持的更多信息。

工具示例

以下是使用 Spring AI 进行工具/函数调用的简单示例

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

NvidiaLlmApplication.java 示例中,当模型需要天气信息时,它将自动调用 weatherFunction bean,然后该 bean 可以获取实时天气数据。预期的响应如下所示

阿姆斯特丹目前天气为 20 摄氏度,巴黎目前天气为 25 摄氏度。

关键注意事项

在使用 Spring AI 的 NVIDIA LLM API 时,请牢记以下几点

  • 模型选择:NVIDIA 提供来自各种提供商的广泛模型。请为您的用例选择合适的模型。
  • API 兼容性:NVIDIA LLM API 设计为与 OpenAI API 兼容,这使得与 Spring AI 的集成变得容易。
  • 性能:NVIDIA 的 LLM API 针对高性能推理进行了优化。您可能会注意到响应速度的提高,尤其是在处理大型模型时。
  • 专业模型:NVIDIA 提供针对不同任务的专业模型,例如代码补全、数学问题和一般聊天。选择最适合您特定需求的模型。
  • API 限制:请注意与您的 NVIDIA API 密钥相关的任何速率限制或使用配额。

参考资料

有关更多信息,请查看 Spring AI 和 OpenAI 的参考文档。

结论

将 NVIDIA LLM API 与 Spring AI 集成,为希望在其 Spring 应用程序中利用高性能 AI 模型的开发人员打开了新的可能性。通过重新利用 OpenAI 客户端,Spring AI 可以轻松地在不同的 AI 提供商之间切换,让您可以为您的特定需求选择最佳解决方案。

在探索此集成时,请记住及时了解 Spring AI 和 NVIDIA LLM API 的最新文档,因为功能和模型可用性可能会随时间演变。

我们鼓励您尝试不同的模型并比较它们的性能和输出,以找到最适合您用例的解决方案。

祝您编码愉快,尽情享受 NVIDIA LLM API 为您的人工智能驱动的 Spring 应用程序带来的速度和功能!

获取 Spring 新闻通讯

通过 Spring 新闻通讯保持联系

订阅

领先一步

VMware 提供培训和认证,助您加速进步。

了解更多

获得支持

Tanzu Spring 提供 OpenJDK™、Spring 和 Apache Tomcat® 的支持和二进制文件,只需一份简单的订阅。

了解更多

即将举行的活动

查看 Spring 社区所有即将举行的活动。

查看所有