VertexAI 嵌入

The Generative Language 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 密钥 的值。导出环境变量是设置该配置属性的一种方法。

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 嵌入客户端提供 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'
}
请参阅 依赖项管理 部分，将 Spring AI BOM 添加到您的构建文件中。

嵌入属性

前缀 spring.ai.vertex.ai 用作属性前缀，允许您连接到 VertexAI。

属性 描述 默认值

spring.ai.vertex.ai.ai.base-url

要连接的 URL

generativelanguage.googleapis.com/v1beta3

spring.ai.vertex.ai.api-key

API 密钥

-

前缀 spring.ai.vertex.ai.embedding 是属性前缀，允许您配置 VertexAI Chat 的嵌入客户端实现。

属性 描述 默认值

spring.ai.vertex.ai.embedding.enabled

启用 Vertex AI PaLM API 嵌入客户端。

true

spring.ai.vertex.ai.embedding.model

这是要使用的 Vertex 嵌入模型

embedding-gecko-001

示例控制器

使用 创建 一个新的 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
将api-key替换为您的 VertexAI 凭据。

这将创建一个VertexAiPaLm2EmbeddingModel实现，您可以将其注入到您的类中。以下是一个使用嵌入客户端进行文本生成的简单@Controller类的示例。

@RestController
public class EmbeddingController {

    private final EmbeddingModel embeddingModel;

    @Autowired
    public EmbeddingController(EmbeddingModel embeddingModel) {
        this.embeddingModel = embeddingModel;
    }

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

手动配置

The VertexAiPaLm2EmbeddingModel 实现EmbeddingModel，并使用低级 VertexAiPaLm2Api 客户端连接到 VertexAI 服务。

将spring-ai-vertex-ai依赖项添加到项目的 Maven pom.xml 文件中

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

或添加到您的 Gradle build.gradle 构建文件中。

dependencies {
    implementation 'org.springframework.ai:spring-ai-vertex-ai-palm2'
}
请参阅 依赖项管理 部分，将 Spring AI BOM 添加到您的构建文件中。

接下来，创建一个VertexAiPaLm2EmbeddingModel并将其用于文本生成

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

var embeddingModel = new VertexAiPaLm2EmbeddingModel(vertexAiApi);

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

低级 VertexAiPaLm2Api 客户端

The VertexAiPaLm2Api 提供了一个轻量级的 Java 客户端，用于 VertexAiPaLm2Api Chat API。

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

vertex ai chat low level api

以下是一个简单的代码片段，说明如何以编程方式使用该 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!"));