此版本仍在开发中，尚未被视为稳定版本。最新的快照版本请使用 Spring AI 1.0.0-SNAPSHOT！spring-doc.cadn.net.cn

Perplexity Chart

Perplexity AI 提供独特的 AI 服务，将其语言模型与实时搜索功能集成在一起。它提供了多种模型，并支持对话式 AI 的流式响应。spring-doc.cadn.net.cn

Spring AI 通过重用现有的 OpenAI 客户端与 Perplexity AI 集成。要开始使用，您需要获取 Perplexity API 密钥，配置基本 URL，然后选择一个受支持的模型。spring-doc.cadn.net.cn

Spring AI Perplexity 集成
Perplexity API 与 OpenAI API 不完全兼容。 Perplexity 将实时 Web 搜索结果与其语言模型响应相结合。 与 OpenAI 不同，Perplexity 不会暴露toolCalls - function call机制。 此外，目前 Perplexity 不支持多模式消息。

查看 PerplexityWithOpenAiChatModelIT.java 测试，了解将 Perplexity 与 Spring AI 结合使用的示例。spring-doc.cadn.net.cn

先决条件

环境变量配置示例：spring-doc.cadn.net.cn

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 工件发布在 Maven Central 和 Spring Snapshot 存储库中。 请参阅 Repositories 部分，将这些存储库添加到您的构建系统中。spring-doc.cadn.net.cn

为了帮助进行依赖项管理，Spring AI 提供了一个 BOM（物料清单），以确保在整个项目中使用一致的 Spring AI 版本。请参阅依赖项管理部分，将 Spring AI BOM 添加到您的构建系统中。spring-doc.cadn.net.cn

自动配置

Spring AI 为 OpenAI Chat 客户端提供 Spring Boot 自动配置。 要启用它，请将以下依赖项添加到项目的 Maven 中pom.xml或 Gradlebuild.gradlebuild 文件：spring-doc.cadn.net.cn

<dependency>
    <groupId>org.springframework.ai</groupId>
    <artifactId>spring-ai-openai-spring-boot-starter</artifactId>
</dependency>
dependencies {
    implementation 'org.springframework.ai:spring-ai-openai-spring-boot-starter'
}
请参阅 Dependency Management 部分，将 Spring AI BOM 添加到您的构建文件中。

聊天属性

重试属性

前缀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

2 秒spring-doc.cadn.net.cn

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

Backoff interval 乘数。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

如果为 false，则抛出 NonTransientAiException，并且不要尝试重试4xx客户端错误代码spring-doc.cadn.net.cn

假spring-doc.cadn.net.cn

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

不应触发重试的 HTTP 状态代码列表（例如，引发 NonTransientAiException）。spring-doc.cadn.net.cn

空spring-doc.cadn.net.cn

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

应触发重试的 HTTP 状态代码列表（例如，引发 TransientAiException）。spring-doc.cadn.net.cn

空spring-doc.cadn.net.cn

连接属性

前缀spring.ai.openai用作允许您连接到 OpenAI 的属性前缀。spring-doc.cadn.net.cn

财产 描述 违约

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

要连接到的 URL。必须设置为api.perplexity.aispring-doc.cadn.net.cn

-spring-doc.cadn.net.cn

spring.ai.openai.chat.api-keyspring-doc.cadn.net.cn

您的 Perplexity API 密钥spring-doc.cadn.net.cn

-spring-doc.cadn.net.cn

配置属性

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

财产 描述 违约

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

支持的 Perplexity 模型之一。例：llama-3.1-sonar-small-128k-online.spring-doc.cadn.net.cn

-spring-doc.cadn.net.cn

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

可选覆盖spring.ai.openai.base-url以提供特定于聊天的 url。必须设置为api.perplexity.aispring-doc.cadn.net.cn

-spring-doc.cadn.net.cn

spring.ai.openai.chat.completions-pathspring-doc.cadn.net.cn

必须设置为/chat/completionsspring-doc.cadn.net.cn

/v1/chat/completionsspring-doc.cadn.net.cn

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

响应中的随机性量，值介于 0 （含） 和 2 （不含） 之间。较高的值越随机，而较低的值则更具确定性。所需范围：0 < x < 2.spring-doc.cadn.net.cn

0.2spring-doc.cadn.net.cn

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

大于 0 的乘法惩罚。大于 1.0 的值会根据新标记到目前为止在文本中的现有频率对其进行惩罚，从而降低模型逐字重复同一行的可能性。值为 1.0 表示没有惩罚。与 presence_penalty 不兼容。所需范围：x > 0.spring-doc.cadn.net.cn

1spring-doc.cadn.net.cn

spring.ai.openai.chat.options.max代币spring-doc.cadn.net.cn

API 返回的完成令牌的最大数量。max_tokens 中请求的令牌总数加上消息中发送的提示令牌数量不得超过所请求模型的上下文窗口令牌限制。如果未指定，则模型将生成标记，直到到达其停止标记或上下文窗口结束。spring-doc.cadn.net.cn

-spring-doc.cadn.net.cn

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

介于 -2.0 和 2.0 之间的值。正值根据新标记到目前为止是否出现在文本中来惩罚新标记，从而增加模型讨论新主题的可能性。不兼容frequency_penalty.所需范围：-2 < x < 2spring-doc.cadn.net.cn

0spring-doc.cadn.net.cn

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

细胞核采样阈值，值介于 0 和 1 之间（包括 0 和 1）。对于每个后续标记，模型会考虑具有top_p概率质量的标记的结果。我们建议更改 top_k 或 top_p，但不能同时更改两者。所需范围：0 < x < 1spring-doc.cadn.net.cn

0.9spring-doc.cadn.net.cn

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

（仅用于流媒体）设置为添加一个额外的数据块，其中包含整个请求的令牌使用情况统计信息。这choicesfield 是一个空数组，所有其他数据块也将包含一个 usage 字段，但值为 null。spring-doc.cadn.net.cn

假spring-doc.cadn.net.cn
所有前缀为spring.ai.openai.chat.options可以通过将特定于请求的运行时选项添加到Prompt叫。

运行时选项

OpenAiChatOptions.java 提供模型配置，例如要使用的模型、温度、频率损失等。spring-doc.cadn.net.cn

启动时，可以使用OpenAiChatModel(api, options)constructor 或spring.ai.openai.chat.options.*性能。spring-doc.cadn.net.cn

在运行时，您可以通过向Prompt叫。 例如，要覆盖特定请求的默认模型和温度：spring-doc.cadn.net.cn

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 不支持媒体内容。

Samples控制器

创建一个新的 Spring Boot 项目并添加spring-ai-openai-spring-boot-starter添加到您的 POM（或 Gradle）依赖项中。spring-doc.cadn.net.cn

添加application.properties文件中的src/main/resources目录中，以启用和配置 OpenAi 聊天模型：spring-doc.cadn.net.cn

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实现，您可以将其注入到您的类中。 下面是一个简单的示例@Controller使用 Chat 模型生成文本的类。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);
    }
}

支持的型号

Perplexity 支持多个针对搜索增强型对话式 AI 优化的模型。有关详细信息，请参阅支持的型号。spring-doc.cadn.net.cn

引用