Perplexity Chat

Perplexity AI 提供了一项独特的 AI 服务，该服务将其语言模型与实时搜索功能相结合。它提供了多种模型，并支持流式响应，用于会话式 AI。

Spring AI 通过重用现有的 OpenAI 客户端来与 Perplexity AI 集成。要开始使用，您需要获取 Perplexity API 密钥，配置基础 URL，并选择一个支持的模型。

spring ai perplexity integration
Perplexity API 与 OpenAI API 不完全兼容。Perplexity 将实时网络搜索结果与其语言模型响应相结合。与 OpenAI 不同，Perplexity 不暴露 toolCalls - function call 机制。此外，Perplexity 目前不支持多模态消息。

查看 PerplexityWithOpenAiChatModelIT.java 测试用例，了解如何在 Spring AI 中使用 Perplexity 的示例。

先决条件

  • 创建 API 密钥：访问此处创建 API 密钥。使用您 Spring AI 项目中的 spring.ai.openai.api-key 属性进行配置。

  • 设置 Perplexity 基础 URL：将 spring.ai.openai.base-url 属性设置为 api.perplexity.ai。

  • 选择 Perplexity 模型：使用 spring.ai.openai.chat.model=<model name> 属性指定模型。参考 支持的模型 查看可用选项。

  • 设置 chat completions 路径：将 spring.ai.openai.chat.completions-path 设置为 /chat/completions。参考 chat completions api 查看更多详情。

环境变量配置示例

export SPRING_AI_OPENAI_API_KEY=<INSERT PERPLEXITY API KEY HERE>
export SPRING_AI_OPENAI_BASE_URL=https://api.perplexity.ai
export SPRING_AI_OPENAI_CHAT_MODEL=llama-3.1-sonar-small-128k-online

添加仓库和 BOM

Spring AI artifacts 发布在 Maven Central 和 Spring Snapshot 仓库中。参考仓库部分将这些仓库添加到您的构建系统中。

为了帮助进行依赖管理，Spring AI 提供了一个 BOM (bill of materials)，以确保整个项目中使用一致版本的 Spring AI。参考依赖管理部分将 Spring AI BOM 添加到您的构建系统中。

自动配置

Spring AI 自动配置、starter 模块的 artifact 名称发生了重大变化。请参考升级说明获取更多信息。

Spring AI 为 OpenAI Chat Client 提供了 Spring Boot 自动配置。要启用它，请将以下依赖项添加到您项目的 Maven pom.xml 或 Gradle build.gradle 构建文件中

  • Maven

  • Gradle

<dependency>
    <groupId>org.springframework.ai</groupId>
    <artifactId>spring-ai-starter-model-openai</artifactId>
</dependency>
dependencies {
    implementation 'org.springframework.ai:spring-ai-starter-model-openai'
}
参考依赖管理部分将 Spring AI BOM 添加到您的构建文件中。

Chat 属性

重试属性

spring.ai.retry 前缀用作属性前缀，您可以使用它配置 OpenAI chat 模型的重试机制。

属性 描述 默认值

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。必须设置为 api.perplexity.ai

-

spring.ai.openai.chat.api-key

您的 Perplexity API 密钥

-

配置属性

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

要启用，请将 spring.ai.model.chat 设置为 openai（默认已启用）

要禁用，请将 spring.ai.model.chat 设置为 none（或任何与 openai 不匹配的值）

此更改旨在允许配置多个模型。

spring.ai.openai.chat 前缀是属性前缀，您可以使用它配置 OpenAI 的 chat 模型实现。

属性 描述 默认值

spring.ai.model.chat

启用 OpenAI chat 模型。

openai

spring.ai.openai.chat.model

一种受支持的 Perplexity 模型。例如：llama-3.1-sonar-small-128k-online。

-

spring.ai.openai.chat.base-url

可选地覆盖 spring.ai.openai.base-url，以提供 chat 特定 URL。必须设置为 api.perplexity.ai

-

spring.ai.openai.chat.completions-path

必须设置为 /chat/completions

/v1/chat/completions

spring.ai.openai.chat.options.temperature

响应中的随机性量，值在 0（包含）到 2（不包含）之间。值越高越随机，值越低越确定。必需范围：0 < x < 2。

0.2

spring.ai.openai.chat.options.frequencyPenalty

大于 0 的乘法惩罚项。大于 1.0 的值根据新 token 在目前文本中出现的频率来惩罚它们，降低模型逐字重复同一行的可能性。值为 1.0 表示没有惩罚。与 presence_penalty 不兼容。必需范围：x > 0。

1

spring.ai.openai.chat.options.maxTokens

API 返回的最大完成 token 数量。max_tokens 中请求的 token 总数加上消息中发送的 prompt token 数量不得超过所请求模型的上下文窗口 token 限制。如果未指定，模型将生成 token，直到达到其停止 token 或上下文窗口结束。

-

spring.ai.openai.chat.options.presencePenalty

介于 -2.0 和 2.0 之间的值。正值根据新 token 是否出现在目前文本中来惩罚它们，增加模型谈论新话题的可能性。与 frequency_penalty 不兼容。必需范围：-2 < x < 2

0

spring.ai.openai.chat.options.topP

核采样阈值，值在 0 到 1（包含）之间。对于每个后续 token，模型会考虑 top_p 概率质量的 token 结果。我们建议仅更改 top_k 或 top_p 其中一个，而不要同时更改两者。必需范围：0 < x < 1

0.9

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

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

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

运行时选项

OpenAiChatOptions.java 提供了模型配置，例如要使用的模型、temperature、frequency penalty 等。

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

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

ChatResponse response = chatModel.call(
    new Prompt(
        "Generate the names of 5 famous pirates.",
        OpenAiChatOptions.builder()
            .model("llama-3.1-sonar-large-128k-online")
            .temperature(0.4)
        .build()
    ));
除了模型特定的 OpenAiChatOptions 之外，您还可以使用通过 ChatOptions#builder() 创建的可移植 ChatOptions 实例。

函数调用

Perplexity 不支持显式函数调用。相反，它将搜索结果直接集成到响应中。

多模态

目前，Perplexity API 不支持媒体内容。

示例控制器

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

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

spring.ai.openai.api-key=<PERPLEXITY_API_KEY>
spring.ai.openai.base-url=https://api.perplexity.ai
spring.ai.openai.chat.completions-path=/chat/completions
spring.ai.openai.chat.options.model=llama-3.1-sonar-small-128k-online
spring.ai.openai.chat.options.temperature=0.7

# The Perplexity API doesn't support embeddings, so we need to disable it.
spring.ai.openai.embedding.enabled=false
将 api-key 替换为您自己的 Perplexity Api 密钥。

这将创建一个 OpenAiChatModel 实现，您可以将其注入到您的类中。这是一个使用 chat 模型进行文本生成的简单 @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);
    }
}

支持的模型

Perplexity 支持多种为搜索增强型会话式 AI 优化的模型。参考 支持的模型 获取详情。

参考资料