> ## Documentation Index
> Fetch the complete documentation index at: https://javaai.pig4cloud.com/llms.txt
> Use this file to discover all available pages before exploring further.

# Perplexity 聊天

[Perplexity AI](https://perplexity.ai/) 提供独特的 AI 服务，将其语言模型与实时搜索功能相结合。它提供多种模型并支持流式响应以实现对话式 AI。

Spring AI 通过复用现有的 [OpenAI](/spring4ai/api/chat/openai-chat) 客户端与 Perplexity AI 集成。要开始使用，你需要获取一个 [Perplexity API 密钥](https://docs.perplexity.ai/guides/getting-started)，配置基本 URL，并选择一个支持的[模型](https://docs.perplexity.ai/guides/model-cards)。

<Frame caption="Spring AI Perplexity 集成">
  <img src="https://mintcdn.com/pig/mnE7V5Dtl5t5-aV7/images/spring-ai-perplexity-integration.jpg?fit=max&auto=format&n=mnE7V5Dtl5t5-aV7&q=85&s=4e4cb045afb7d58b241d6aaf03ea9290" width="800" data-path="images/spring-ai-perplexity-integration.jpg" />
</Frame>

<Note>
  Perplexity API 与 OpenAI API 不完全兼容。
  Perplexity 将实时 Web 搜索结果与其语言模型响应相结合。
  与 OpenAI 不同，Perplexity 不公开 `toolCalls` - `function call` 机制。
  此外，目前 Perplexity 不支持多模态消息。
</Note>

请查看 [PerplexityWithOpenAiChatModelIT.java](https://github.com/spring-projects/spring-ai/blob/main/models/spring-ai-openai/src/test/java/org/springframework/ai/openai/chat/proxy/PerplexityWithOpenAiChatModelIT.java) 测试，获取将 Perplexity 与 Spring AI 结合使用的示例。

## 前提条件

* **创建 API 密钥**：
  访问[此处](https://docs.perplexity.ai/guides/getting-started)创建 API 密钥。
  在你的 Spring AI 项目中使用 `spring.ai.openai.api-key` 属性进行配置。

* **设置 Perplexity 基本 URL**：
  将 `spring.ai.openai.base-url` 属性设置为 `https://api.perplexity.ai`。

* **选择 Perplexity 模型**：
  使用 `spring.ai.openai.chat.model=<模型名称>` 属性指定模型。
  有关可用选项，请参阅[支持的模型](https://docs.perplexity.ai/guides/model-cards)。

* **设置聊天补全路径**：
  将 `spring.ai.openai.chat.completions-path` 设置为 `/chat/completions`。
  有关更多详细信息，请参阅[聊天补全 API](https://docs.perplexity.ai/api-reference/chat-completions)。

你可以在 `application.properties` 文件中设置这些配置属性：

```properties theme={"system"}
spring.ai.openai.api-key=<你的-perplexity-api-密钥>
spring.ai.openai.base-url=https://api.perplexity.ai
spring.ai.openai.chat.model=llama-3.1-sonar-small-128k-online
spring.ai.openai.chat.completions-path=/chat/completions
```

为了在处理 API 密钥等敏感信息时增强安全性，你可以使用 Spring 表达式语言 (SpEL) 来引用自定义环境变量：

<Tabs>
  <Tab title="application.yml">
    ```yaml theme={"system"}
    spring:
      ai:
        openai:
          api-key: ${PERPLEXITY_API_KEY}
          base-url: ${PERPLEXITY_BASE_URL}
          chat:
            model: ${PERPLEXITY_MODEL}
            completions-path: ${PERPLEXITY_COMPLETIONS_PATH}
    ```
  </Tab>

  <Tab title=".env">
    ```bash theme={"system"}
    export PERPLEXITY_API_KEY=<你的-perplexity-api-密钥>
    export PERPLEXITY_BASE_URL=https://api.perplexity.ai
    export PERPLEXITY_MODEL=llama-3.1-sonar-small-128k-online
    export PERPLEXITY_COMPLETIONS_PATH=/chat/completions
    ```
  </Tab>
</Tabs>

你也可以在应用程序代码中以编程方式设置这些配置：

```java theme={"system"}
// 从安全来源或环境变量中检索配置
String apiKey = System.getenv("PERPLEXITY_API_KEY");
String baseUrl = System.getenv("PERPLEXITY_BASE_URL");
String model = System.getenv("PERPLEXITY_MODEL");
String completionsPath = System.getenv("PERPLEXITY_COMPLETIONS_PATH");
```

### 添加仓库和 BOM

Spring AI 的构件发布在 Maven Central 和 Spring Snapshot 仓库中。
请参阅[构件仓库](/spring4ai/getting-started#artifact-repositories)部分，将这些仓库添加到你的构建系统中。

为了帮助进行依赖管理，Spring AI 提供了一个 BOM (bill of materials)，以确保在整个项目中使用一致版本的 Spring AI。请参阅[依赖管理](/spring4ai/getting-started#dependency-management)部分，将 Spring AI BOM 添加到你的构建系统中。

## 自动配置

<Note>
  Spring AI 自动配置、启动器模块的构件名称发生了重大变化。
  有关更多信息，请参阅[升级说明](https://docs.spring.io/spring-ai/reference/upgrade-notes.html)。
</Note>

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

<Tabs>
  <Tab title="Maven">
    ```xml theme={"system"}
    <dependency>
        <groupId>org.springframework.ai</groupId>
        <artifactId>spring-ai-starter-model-openai</artifactId>
    </dependency>
    ```
  </Tab>

  <Tab title="Gradle">
    ```gradle theme={"system"}
    dependencies {
        implementation 'org.springframework.ai:spring-ai-starter-model-openai'
    }
    ```
  </Tab>
</Tabs>

<Tip>
  请参阅[依赖管理](/spring4ai/getting-started#dependency-management)部分，将 Spring AI BOM 添加到你的构建文件中。
</Tip>

### 聊天属性

#### 重试属性

前缀 `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。必须设置为 `https://api.perplexity.ai` | -   |
| spring.ai.openai.chat.api-key | 你的 Perplexity API 密钥                       | -   |

#### 配置属性

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

  要启用，`spring.ai.model.chat=openai` (默认启用)

  要禁用，`spring.ai.model.chat=none` (或任何与 openai 不匹配的值)

  此更改是为了允许配置多个模型。
</Note>

前缀 `spring.ai.openai.chat` 是属性前缀，允许你配置 OpenAI 的聊天模型实现。

| 属性                                             | 描述                                                                                                              | 默认值                    |
| :--------------------------------------------- | :-------------------------------------------------------------------------------------------------------------- | :--------------------- |
| spring.ai.model.chat                           | 启用 OpenAI 聊天模型。                                                                                                 | openai                 |
| spring.ai.openai.chat.model                    | 支持的 [Perplexity 模型](https://docs.perplexity.ai/guides/model-cards)之一。例如：`llama-3.1-sonar-small-128k-online`。    | -                      |
| spring.ai.openai.chat.base-url                 | 可选地覆盖 spring.ai.openai.base-url 以提供特定于聊天的 url。必须设置为 `https://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 的值会根据新标记在文本中已有的频率对其进行惩罚，从而降低模型逐字重复同一行的可能性。值为 1.0 表示没有惩罚。与 presence\_penalty 不兼容。必需范围：`x > 0`。 | 1                      |
| spring.ai.openai.chat.options.maxTokens        | API 返回的最大补全标记数。max\_tokens 中请求的标记总数加上消息中发送的提示标记数不得超过所请求模型的上下文窗口标记限制。如果未指定，则模型将生成标记，直到达到其停止标记或其上下文窗口的末尾。         | -                      |
| spring.ai.openai.chat.options.presencePenalty  | -2.0 到 2.0 之间的值。正值会根据新标记是否已出现在文本中对其进行惩罚，从而增加模型谈论新主题的可能性。与 `frequency_penalty` 不兼容。必需范围：`-2 < x < 2`             | 0                      |
| spring.ai.openai.chat.options.topP             | 核采样阈值，值介于 0 和 1（含）之间。对于每个后续标记，模型都会考虑具有 top\_p 概率质量的标记的结果。我们建议更改 top\_k 或 top\_p，但不能同时更改两者。必需范围：`0 < x < 1`      | 0.9                    |
| spring.ai.openai.chat.options.stream-usage     | （仅限流式传输）设置为添加一个包含整个请求的标记使用情况统计信息的附加块。此块的 `choices` 字段是一个空数组，所有其他块也将包含一个 usage 字段，但其值为 null。                     | false                  |

<Tip>
  所有以 `spring.ai.openai.chat.options` 为前缀的属性都可以在运行时通过向 `Prompt` 调用添加特定于请求的[运行时选项](#runtime-options)来覆盖。
</Tip>

## 运行时选项

[OpenAiChatOptions.java](https://github.com/spring-projects/spring-ai/blob/main/models/spring-ai-openai/src/main/java/org/springframework/ai/openai/OpenAiChatOptions.java) 提供模型配置，例如要使用的模型、温度、频率惩罚等。

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

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

```java theme={"system"}
ChatResponse response = chatModel.call(
    new Prompt(
        "生成 5 个著名海盗的名字。",
        OpenAiChatOptions.builder()
            .model("llama-3.1-sonar-large-128k-online")
            .temperature(0.4)
        .build()
    ));
```

<Tip>
  除了特定于模型的 [OpenAiChatOptions](https://github.com/spring-projects/spring-ai/blob/main/models/spring-ai-openai/src/main/java/org/springframework/ai/openai/OpenAiChatOptions.java)之外，你还可以使用通过 [ChatOptions#builder()](https://github.com/spring-projects/spring-ai/blob/main/spring-ai-client-chat/src/main/java/org/springframework/ai/chat/prompt/ChatOptions.java) 创建的可移植 [ChatOptions](https://github.com/spring-projects/spring-ai/blob/main/spring-ai-client-chat/src/main/java/org/springframework/ai/chat/prompt/ChatOptions.java) 实例。
</Tip>

## 函数调用

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

## 多模态

<Note>
  目前，Perplexity API 不支持媒体内容。
</Note>

## 示例控制器

[创建](https://start.spring.io/)一个新的 Spring Boot 项目，并将 `spring-ai-starter-model-openai` 添加到你的 pom (或 gradle) 依赖项中。

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

```properties theme={"system"}
spring.ai.openai.api-key=<PERPLEXITY_API_密钥>
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

# Perplexity API 不支持嵌入，因此我们需要禁用它。
spring.ai.openai.embedding.enabled=false
```

<Tip>
  将 `api-key` 替换为你的 Perplexity Api 密钥。
</Tip>

这将创建一个 `OpenAiChatModel` 实现，你可以将其注入到你的类中。
以下是一个简单的 `@Controller` 类的示例，该类使用聊天模型进行文本生成：

```java theme={"system"}
@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 = "给我讲个笑话") String message) {
        return Map.of("generation", this.chatModel.call(message));
    }

    @GetMapping("/ai/generateStream")
    public Flux<ChatResponse> generateStream(@RequestParam(value = "message", defaultValue = "给我讲个笑话") String message) {
        Prompt prompt = new Prompt(new UserMessage(message));
        return this.chatModel.stream(prompt);
    }
}
```

## 支持的模型

Perplexity 支持多种针对搜索增强型对话 AI 优化的模型。有关详细信息，请参阅[支持的模型](https://docs.perplexity.ai/guides/model-cards)。

## 参考

* [文档主页](https://docs.perplexity.ai/home)
* [API 参考](https://docs.perplexity.ai/api-reference/chat-completions)
* [入门指南](https://docs.perplexity.ai/guides/getting-started)
* [速率限制](https://docs.perplexity.ai/guides/rate-limits)

<Card title="文档有误？请协助编辑" icon="pencil" href="https://github.com/javaai-pig4cloud-com/javaai-docs/edit/main/spring-ai/api/chat/perplexity-chat.mdx">
  发现文档问题？点击此处直接在 GitHub 上编辑并提交 PR，帮助我们改进文档！
</Card>