跳到主要内容
版本:2.0.1

Titan 嵌入

QWen 3.8 中英对照 Titan Titan Embeddings

提供 Bedrock Titan Embedding 模型。通过全托管 API,Amazon Titan 基础模型(FMs)为客户提供涵盖图像、多模态嵌入以及文本模型的多种高性能选择。Amazon Titan 模型由 AWS 创建,并基于大规模数据集进行预训练,使其成为功能强大、通用的模型,能够支持多种用例,同时支持 AI 的负责任使用。您可以直接使用这些模型,或使用自己的数据对其进行私有化定制。

备注

Bedrock Titan Embedding 支持 Text 和 Image 嵌入。

备注

Bedrock Titan Embedding 不支持批量嵌入。

AWS Bedrock Titan Model Page 和 Amazon Bedrock User Guide 包含如何使用 AWS 托管模型的详细信息。

先决条件​

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

添加仓库和 BOM​

Spring AI 构件发布在 Maven Central 和 Spring Snapshot 仓库中。请参阅 构件仓库 部分,将这些仓库添加到您的构建系统中。

为了辅助依赖管理,Spring AI 提供了一个 BOM(物料清单),以确保整个项目中使用的 Spring AI 版本保持一致。请参考依赖管理部分,将 Spring AI BOM 添加到您的构建系统中。

自动配置​

备注

Spring AI 的自动配置和 starter 模块的构件名称已发生重大变更。请参阅 升级说明 以获取更多信息。

在项目的 Maven pom.xml 文件中添加 spring-ai-starter-model-bedrock 依赖项:

<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'
}
提示

请参考 依赖管理 章节,以在你的构建文件中添加 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-keyAWS 访问密钥。-
spring.ai.bedrock.aws.secret-keyAWS 私有密钥。-
spring.ai.bedrock.aws.profile.nameAWS 配置文件名称。-
spring.ai.bedrock.aws.profile.credentials-pathAWS 凭证文件路径。-
spring.ai.bedrock.aws.profile.configuration-pathAWS 配置文件路径。-
备注

嵌入(embedding)自动配置项的启用和禁用现在通过前缀为 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 (已移除且不再有效)启用或禁用对 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。也可以在 AWS Bedrock 基础模型 ID 文档 中找到 Model ID 值。

运行时选项​

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

在运行时,你可以通过在 EmbeddingRequest 调用中添加新的、针对特定请求的选项来覆盖默认选项。例如,要为某个特定请求覆盖默认的 temperature:

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

示例控制器​

使用 Create 创建一个新的 Spring Boot 项目,并将 spring-ai-starter-model-bedrock 添加到您的 pom(或 gradle)依赖中。

在 src/main/resources 目录下添加 application.properties 文件,以启用并配置 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.model.embedding=bedrock-titan
提示

将 regions、access-key 和 secret-key 替换为您的 AWS 凭证。

这将创建一个 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 并使用 低层 TitanEmbeddingBedrockApi 客户端 连接 Bedrock Titan 服务。

在项目的 Maven pom.xml 文件中添加 spring-ai-bedrock 依赖项:

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

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

dependencies {
implementation 'org.springframework.ai:spring-ai-bedrock'
}
提示

请参见 Dependency Management 部分,将 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 Embedding models 的轻量级 Java 客户端。

下图中的类图展示了 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("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);