Titan 嵌入
提供 Bedrock Titan 嵌入模型。 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 访问。
Auto-configuration
|
Spring AI自动配置和starter模块的artifact名称有了重大变化。 请参阅升级说明获取更多信息。 |
将如下的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'
}| 请参阅依赖管理部分，将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 的属性前缀。
| <property> </property> | <description> </description> | 默认 |
|---|---|---|
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.model.embedding=bedrock-titan（默认已启用） 要禁用，请设置 spring.ai.model.embedding=none（或任何不匹配 bedrock-titan 的值） 此更改是为了允许配置多个模型。 |
前缀 spring.ai.bedrock.titan.embedding（在 BedrockTitanEmbeddingProperties 中定义）是用于配置 Titan 嵌入模型实现的属性前缀。
<property> </property> |
<description> </description> |
默认 |
spring.ai.bedrock.titan.embedding.enabled（已移除且不再生效） |
启用或禁用对 Titan 嵌入的支持 |
false |
spring.ai.model.embedding |
启用或禁用对 Titan 嵌入的支持 |
bedrock-titan |
spring.ai.bedrock.titan.embedding.model |
要使用的模型 ID。请参阅 |
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项目，并在pom（或gradle）依赖中添加spring-ai-starter-model-bedrock。
在 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将 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 服务。
将如下的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添加到您的构建文件中。 |
接下来，创建一个 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 提供了一个轻量级的 Java 客户端，构建于 AWS Bedrock Titan 嵌入模型 之上。
以下类图展示了 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);