Titan嵌入

提供Bedrock Titan Embedding客户端。Amazon Titan基础模型（FMs）通过完全托管的API向客户提供丰富的高性能图像、多模态嵌入和文本模型选择。Amazon Titan模型由AWS创建，并在大型数据集上进行预训练，使其成为功能强大的通用模型，可支持各种用例，同时支持负责任的AI使用。您可以直接使用它们，也可以使用您自己的数据进行私有定制。

Bedrock Titan Embedding支持文本和图像嵌入。
Bedrock Titan Embedding不支持批量嵌入。

AWS Bedrock Titan模型页面和Amazon Bedrock用户指南包含了如何使用AWS托管模型的详细信息。

先决条件

请参阅Amazon Bedrock上的Spring AI文档以设置API访问。

添加存储库和BOM

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

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

自动配置

将spring-ai-bedrock-ai-spring-boot-starter依赖项添加到项目的 Maven pom.xml文件中：

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

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

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

启用 Titan 嵌入支持

默认情况下，Titan 嵌入模型是禁用的。要启用它，请设置spring.ai.bedrock.titan.embedding.enabled属性为true。导出环境变量是设置此配置属性的一种方法：

export SPRING_AI_BEDROCK_TITAN_EMBEDDING_ENABLED=true

嵌入属性

前缀 spring.ai.bedrock.aws 是用于配置与AWS Bedrock连接的属性前缀。

属性 描述 默认值

spring.ai.bedrock.aws.region

要使用的AWS区域。

us-east-1

spring.ai.bedrock.aws.access-key

AWS访问密钥。

-

spring.ai.bedrock.aws.secret-key

AWS秘密密钥。

-

前缀 spring.ai.bedrock.titan.embedding （在 BedrockTitanEmbeddingProperties 中定义）是配置Titan嵌入客户端实现的属性前缀。

属性

描述

默认值

spring.ai.bedrock.titan.embedding.enabled

启用或禁用对Titan嵌入的支持

false

spring.ai.bedrock.titan.embedding.model

要使用的模型ID。请参阅支持的模型的 TitanEmbeddingModel。

amazon.titan-embed-image-v1

支持的值为：amazon.titan-embed-image-v1 和 amazon.titan-embed-text-v1。模型ID值也可以在 AWS Bedrock文档的基本模型ID 中找到。

样例控制器（自动配置）

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

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

spring.ai.bedrock.aws.region=eu-central-1
spring.ai.bedrock.aws.access-key=${AWS_ACCESS_KEY_ID}
spring.ai.bedrock.aws.secret-key=${AWS_SECRET_ACCESS_KEY}

spring.ai.bedrock.titan.embedding.enabled=true
用你的AWS凭证替换regions、access-key和secret-key。

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

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

手动配置

BedrockTitanEmbeddingClient 实现了 EmbeddingClient 并使用 低级 TitanEmbeddingBedrockApi 客户端 来连接 Bedrock Titan 服务。

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

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

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

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

接下来，创建一个 BedrockTitanEmbeddingClient 并用它进行文本嵌入：

var titanEmbeddingApi = new TitanEmbeddingBedrockApi(
	TitanEmbeddingModel.TITAN_EMBED_IMAGE_V1.id(), Region.US_EAST_1.id());

var embeddingClient  new BedrockTitanEmbeddingClient(titanEmbeddingApi);

EmbeddingResponse embeddingResponse = embeddingClient
	.embedForResponse(List.of("Hello World")); // 注意：titan 不支持批量嵌入。

低级 TitanEmbeddingBedrockApi 客户端

TitanEmbeddingBedrockApi 提供了一种轻量级的 Java 客户端，位于 AWS Bedrock Titan 嵌入模型 之上。

以下类图说明了 TitanEmbeddingBedrockApi 接口和构建模块：

bedrock titan embedding low level api

TitanEmbeddingBedrockApi 支持单个和批量嵌入计算的 amazon.titan-embed-image-v1 和 amazon.titan-embed-image-v1 模型。

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

TitanEmbeddingBedrockApi titanEmbedApi = new TitanEmbeddingBedrockApi(
		TitanEmbeddingModel.TITAN_EMBED_TEXT_V1.id(), Region.US_EAST_1.id());

TitanEmbeddingRequest request = TitanEmbeddingRequest.builder()
	.withInputText("我喜欢吃苹果。")
	.build();

TitanEmbeddingResponse response = titanEmbedApi.embedding(request);

要嵌入图像，您需要将其转换为 base64 格式：

TitanEmbeddingBedrockApi titanEmbedApi = new TitanEmbeddingBedrockApi(
		TitanEmbeddingModel.TITAN_EMBED_IMAGE_V1.id(), Region.US_EAST_1.id());

byte[] image = new DefaultResourceLoader()
	.getResource("classpath:/spring_framework.png")
	.getContentAsByteArray();


TitanEmbeddingRequest request = TitanEmbeddingRequest.builder()
	.withInputImage(Base64.getEncoder().encodeToString(image))
	.build();

TitanEmbeddingResponse response = titanEmbedApi.embedding(request);