Titan 嵌入

提供 Bedrock Titan 嵌入模型。 Amazon Titan 基础模型（FM）通过全托管 API，为客户提供大量高性能的图像、多模态嵌入和文本模型选择。 Amazon Titan 模型由 AWS 创建并在大数据集上预训练，是通用、强大的模型，支持多种用例，同时也支持负责任地使用 AI。你可以直接使用它们，或用你自己的数据私下定制它们。

NOTE

Bedrock Titan 嵌入支持文本与图像嵌入。

NOTE

Bedrock Titan 嵌入不支持批量嵌入。

AWS Bedrock Titan 模型页 与 Amazon Bedrock 用户指南 含有关于如何使用 AWS 托管模型的详细信息。

前置条件

关于设置 API 访问，参见 Spring AI 关于 Amazon Bedrock 的文档。

添加仓库与 BOM

Spring AI 的制品发布在 Maven Central 和 Spring Snapshot 仓库中。 参见 制品仓库 一节，把这些仓库添加到你的构建系统。

为便于依赖管理，Spring AI 提供了一个 BOM（物料清单），以确保整个项目中使用一致版本的 Spring AI。参见 依赖管理 一节，把 Spring AI BOM 添加到你的构建系统。

自动配置

NOTE

Spring AI 的自动配置、starter 模块的制品名称发生了重大变更。 更多信息请参阅 升级说明。

把 spring-ai-starter-model-bedrock 依赖添加到你的项目的 Maven pom.xml 文件：

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

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

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

TIP

参见 依赖管理 一节，把 Spring AI BOM 添加到你的构建文件。

启用 Titan 嵌入支持

默认情况下 Titan 嵌入模型是禁用的。 要启用它，在你的应用配置中把 spring.ai.model.embedding 属性设为 bedrock-titan：

spring.ai.model.embedding=bedrock-titan

或者，你可以使用 Spring 表达式语言（SpEL）引用一个环境变量：

# In application.yml
spring:
  ai:
    model:
      embedding: ${AI_MODEL_EMBEDDING}

# In your environment or .env file
export AI_MODEL_EMBEDDING=bedrock-titan

你也可以在启动应用时用 Java 系统属性设置此属性：

java -Dspring.ai.model.embedding=bedrock-titan -jar your-application.jar

嵌入属性

前缀 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.aws.profile.name	AWS 配置档名。	-
spring.ai.bedrock.aws.profile.credentials-path	AWS 凭据文件路径。	-
spring.ai.bedrock.aws.profile.configuration-path	AWS 配置文件路径。	-

NOTE

嵌入自动配置的启用与禁用，现通过以 spring.ai.model.embedding 为前缀的顶层属性来配置。

要启用，spring.ai.model.embedding=bedrock-titan（默认启用）

要禁用，spring.ai.model.embedding=none（或任何不匹配 bedrock-titan 的值）

做出此变更是为了支持配置多个模型。

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

属性	描述	默认值
spring.ai.bedrock.titan.embedding.enabled (Removed and no longer valid)	启用或禁用 Titan 嵌入支持	false
spring.ai.model.embedding	启用或禁用 Titan 嵌入支持	bedrock-titan
spring.ai.bedrock.titan.embedding.model	要使用的模型 id。受支持的模型参见 TitanEmbeddingModel。	amazon.titan-embed-image-v1

受支持的值有：amazon.titan-embed-image-v1、amazon.titan-embed-text-v1 和 amazon.titan-embed-text-v2:0。模型 ID 值也可在 AWS Bedrock 基础模型 ID 文档中找到。

运行时选项

BedrockTitanEmbeddingOptions.java 提供诸如 input-type 的模型配置。在启动时，可通过 BedrockTitanEmbeddingOptions.builder().inputType(type).build() 方法或 spring.ai.bedrock.titan.embedding.input-type 属性配置默认选项。

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

EmbeddingResponse embeddingResponse = embeddingModel.call(
    new EmbeddingRequest(List.of("Hello World", "World is big and salvation is near"),
        BedrockTitanEmbeddingOptions.builder()
        .inputType(InputType.TEXT)
        .build()));

示例控制器

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

在 src/main/resources 目录下添加一个 application.properties 文件，以启用并配置 Titan 嵌入模型：

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.model.embedding=bedrock-titan

TIP

用你的 AWS 凭据替换 regions、access-key 和 secret-key。

这会创建一个可注入到你类中的 EmbeddingController 实现。 下面是一个简单 @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);
    }
}

手动配置

BedrockTitanEmbeddingModel 实现了 EmbeddingModel，并使用底层 api 连接到 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'
}

TIP

参见 依赖管理 一节，把 Spring AI BOM 添加到你的构建文件。

接下来，创建一个 BedrockTitanEmbeddingModel 并将其用于文本嵌入：

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

var embeddingModel = new BedrockTitanEmbeddingModel(this.titanEmbeddingApi);

EmbeddingResponse embeddingResponse = this.embeddingModel
	.embedForResponse(List.of("Hello World")); // NOTE titan does not support batch embedding.

底层 TitanEmbeddingBedrockApi 客户端

TitanEmbeddingBedrockApi 在 AWS Bedrock Titan 嵌入模型之上提供一个轻量级 Java 客户端。

下面的类图展示了 TitanEmbeddingBedrockApi 接口与构建块：

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("I like to eat apples.")
	.build();

TitanEmbeddingResponse response = this.titanEmbedApi.embedding(this.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(this.image))
	.build();

TitanEmbeddingResponse response = this.titanEmbedApi.embedding(this.request);