Google VertexAI PaLM2

VertexAI Embeddings

生成语言 PaLM API 允许开发人员使用 PaLM 模型构建生成 AI 应用程序。大型语言模型 (LLM) 是一种功能强大、多功能的机器学习模型，使计算机能够通过一系列提示理解和生成自然语言。 PaLM API 基于 Google 的下一代 LLM PaLM。它擅长各种不同的任务，例如代码生成、推理和编写。您可以使用 PaLM API 为内容生成、对话代理、摘要和分类系统等用例构建生成式 AI 应用程序。

基于 模型 REST API。

先决条件

要访问 PaLM2 REST API，您需要从 makersuite 获取访问API 密钥。

注意: 目前 PaLM API 在美国以外地区不可用，但您可以使用VPN进行测试。

Spring AI 项目定义了一个名为 spring.ai.vertex.ai.api-key 的配置属性，您应该将其设置为获取的API Key值。

导出环境变量是设置这些配置属性的一种方法：

export SPRING_AI_VERTEX_AI_API_KEY=<INSERT KEY HERE>

添加存储库和 BOM

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

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

自动配置

Spring AI 为 VertexAI Embedding Client 提供 Spring Boot 自动配置。要启用它，请将以下依赖项添加到项目的 Maven pom.xml 文件中：

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

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

dependencies {
    implementation 'org.springframework.ai:spring-ai-vertex-ai-palm2-spring-boot-starter'
}

Embedding 属性

spring.ai.vertex.ai 前缀的属性，可让您配置 VertexAI 客户端的连接。

spring.ai.vertex.ai.embedding 前缀的属性，可让您配置 VertexAI Chat 的 EmbeddingClient 实现。

Sample Controller （自动配置）

创建一个新的 Spring Boot 项目，并将 spring-ai-vertex-ai-palm2-spring-boot-starter 添加到您的 pom（或 gradle）依赖项中。

在 src/main/resources 目录下添加一个 application.properties 文件，以启用和配置 VertexAi 聊天客户端：

spring.ai.vertex.ai.api-key=YOUR_API_KEY
spring.ai.vertex.ai.embedding.model=embedding-gecko-001

这将创建一个可以注入到您的类中的 VertexAiPaLm2EmbeddingClient 实现。下面是一个@Controller使用 EmbeddingClient 的简单示例。

@RestController
public class EmbeddingController {

    private final EmbeddingClient embeddingClient;

    @Autowired
    public EmbeddingController(EmbeddingClient embeddingClient) {
        this.embeddingClient = embeddingClient;
    }

    @GetMapping("/ai/embedding")
    public Map embed(@RequestParam(value = "message", defaultValue = "Tell me a joke") String message) {
        EmbeddingResponse embeddingResponse = this.embeddingClient.embedForResponse(List.of(message));
        return Map.of("embedding", embeddingResponse);
    }
}

手动配置

如果您不使用 Spring Boot，则可以手动配置 VertexAiPaLm2EmbeddingClient。为此，请将 spring-ai-vertex-ai 依赖项添加到项目的 Maven pom.xml文件中：

<dependency>
    <groupId>org.springframework.ai</groupId>
    <artifactId>spring-ai-vertex-ai</artifactId>
</dependency>

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

dependencies {
    implementation 'org.springframework.ai:spring-ai-vertex-ai'
}

接下来，创建一个 VertexAiPaLm2EmbeddingClient实例并使用它来计算两个输入文本之间的相似度：

VertexAiPaLm2Api vertexAiApi = new VertexAiPaLm2Api(< YOUR PALM_API_KEY>);

var embeddingClient = new VertexAiPaLm2EmbeddingClient(vertexAiApi);

EmbeddingResponse embeddingResponse = embeddingClient
    .embedForResponse(List.of("Hello World", "World is big and salvation is near"));

轻量级 VertexAiPaLm2Api 客户端

VertexAiPaLm2Api 为 VertexAiPaLm2Api Chat API 提供了轻量级 Java 客户端。

以下类图说明了 VertexAiPaLm2Api 嵌入接口和构建块：

以下是如何以编程方式使用 api 的简单片段：

VertexAiPaLm2Api vertexAiApi = new VertexAiPaLm2Api(< YOUR PALM_API_KEY>);

// Generate
var prompt = new MessagePrompt(List.of(new Message("0", "Hello, how are you?")));

GenerateMessageRequest request = new GenerateMessageRequest(prompt);

GenerateMessageResponse response = vertexAiApi.generateMessage(request);

// Embed text
Embedding embedding = vertexAiApi.embedText("Hello, how are you?");

// Batch embedding
List<Embedding> embeddings = vertexAiApi.batchEmbedText(List.of("Hello, how are you?", "I am fine, thank you!"));