Perplexity AI

Perplexity AI

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

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

Perplexity API 并未完全兼容 OpenAI API。Perplexity 将实时网络搜索结果与其语言模型的响应相结合。与 OpenAI 不同，Perplexity 并未开放 toolCalls—— 即函数调用机制。此外，目前 Perplexity 还不支持多模态消息。

前提条件（Prerequisites）

• 创建 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=< 模型名称 & gt; 属性来指定模型。 参考 支持的模型 以获取可用选项。
• 设置聊天完成路径： 将 spring.ai.openai.chat.completions-path设置为 /chat/completions。

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

spring.ai.openai.api-key=<your-perplexity-api-key>
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）引用自定义环境变量：

# In application.yml
spring:
  ai:
    openai:
      api-key: ${PERPLEXITY_API_KEY}
      base-url: ${PERPLEXITY_BASE_URL}
      chat:
        model: ${PERPLEXITY_MODEL}
        completions-path: ${PERPLEXITY_COMPLETIONS_PATH}

# In your environment or .env file
export PERPLEXITY_API_KEY=<your-perplexity-api-key>
export PERPLEXITY_BASE_URL=https://api.perplexity.ai
export PERPLEXITY_MODEL=llama-3.1-sonar-small-128k-online
export PERPLEXITY_COMPLETIONS_PATH=/chat/completions

添加存储库和 BOM

Spring AI 工件发布在 Spring Milestone 和 Snapshot 存储库中。请参阅存储库部分将这些存储库添加到您的构建系统中。

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

自动配置（Auto-configuration）

Spring AI 为 OpenAI 聊天模型提供 Spring Boot 自动配置。要启用它，请在项目的 Maven pom.xml文件中添加以下依赖项：

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

或者，在你的 Gradle 构建文件 build.gradle 中添加：

dependencies {
    implementation 'org.springframework.ai:spring-ai-starter-model-openai'
}

聊天属性（Chat Properties）

Retry 属性（Retry Properties）

前缀 spring.ai.retry 用作属性前缀，允许您为 OpenAI 模型配置 retry 机制。

连接属性（Connection Properties）

前缀是 spring.ai.openai 的属性，用于配置 OpenAI 的链接。

配置属性（Configuration Properties）

前缀是 spring.ai.openai.chat 的属性，用于配置 OpenAI 的 ChatModel 实现。

运行时选项（Runtime Options ）

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

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

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

ChatResponse response = chatModel.call(
    new Prompt(
        "Generate the names of 5 famous pirates.",
        OpenAiChatOptions.builder()
            .model("mixtral-8x7b-32768")
            .temperature(0.4)
        .build()
    ));

工具 / 功能调用（Tool/Function Calling）

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

多模态（Multimodal ）

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

示例控制器（Sample Controller）

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

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

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 类的示例，它使用聊天模型进行文本生成。

@RestController
public class ChatController {

    private final OpenAiChatModel chatModel;

    @Autowired
    public ChatController(OpenAiChatModel chatModel) {
        this.chatModel = chatModel;
    }

    /**
     * 文本生成
     * @param message 提示词
     * @return 响应结果
     */
    @GetMapping("/ai/generate")
    @Operation(summary = "文本生成")
    public Map<String, Object> generate(@RequestParam(value = "message", defaultValue = "你好！") String message) {
        try {
            String response = chatModel.call(message);
            return Map.of(
                    "success", true,
                    "generation", response,
                    "message", "Generated successfully"
            );
        } catch (Exception e) {
            return Map.of(
                    "success", false,
                    "error", e.getMessage(),
                    "message", "Generation failed"
            );
        }
    }

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

}

手动配置（Manual Configuration）