|
此版本仍在开发中，尚未被视为稳定版。为了获取最新的快照版本，请使用Spring AI 1.1.3！ |
Titan嵌入
提供Bedrock Titan嵌入模型。 Amazon Titan基础模型（FMs）通过完全托管的API为客户提供了一系列高性能的图像、多模态嵌入和文本模型选择。 Amazon Titan模型由AWS创建，并在大型数据集上进行预训练，使它们成为强大、通用的模型，旨在支持多种使用场景，同时支持AI的负责任使用。 您可以直接使用它们，或根据自己的数据私下进行定制。
| Bedrock Titan 嵌入支持文本和图像嵌入。 |
| Bedrock Titan 嵌入不支持批量嵌入。 |
AWS Bedrock 泰坦模型页面AWS Bedrock Titan Model Page和Amazon Bedrock 用户指南包含了如何使用AWS托管模型的详细信息。
前提条件
请参阅Amazon Bedrock 上的 Spring AI 文档以设置 API 访问权限。
自动配置
|
There has been a significant change in the Spring AI auto-configuration, starter modules' artifact names. Please refer to the 升级说明以获取更多信息。 |
将 spring-ai-starter-model-bedrock 依赖添加到您项目的 Maven pom.xml 文件中：
<dependency>
<groupId>org.springframework.ai</groupId>
<artifactId>spring-ai-starter-model-bedrock</artifactId>
</dependency>或者添加到您的Gradle 构建脚本文件中。
dependencies {
implementation 'org.springframework.ai:spring-ai-starter-model-bedrock'
}| 参考以下依赖管理部分，添加Spring AI BOM到你的构建文件中。 |
启用Titan嵌入式支持
默认情况下，Titan嵌入式模型是禁用的。
要启用它，请在应用程序配置中将embeddingEnabled属性设置为true:
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 是配置到亚马逊 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.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。参见 |
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-boot-starter-web添加到您的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将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);
}
}手动配置
BedrockTitan嵌入模型 实现了 EmbeddingModel 并使用 低级Titan嵌入BedrockApi客户端 连接到Bedrock Titan服务。
将 spring-ai-bedrock 依赖添加到您项目的 Maven pom.xml 文件中：
<dependency>
<groupId>org.springframework.ai</groupId>
<artifactId>spring-ai-bedrock</artifactId>
</dependency>或者添加到您的Gradle 构建脚本文件中。
dependencies {
implementation 'org.springframework.ai:spring-ai-bedrock'
}| 参考以下依赖管理部分，添加Spring AI BOM到你的构建文件中。 |
接下来，创建一个BedrockTitan嵌入模型并用它来进行文本嵌入:
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);