Titan 嵌入

提供 Bedrock Titan Embedding 模型。Amazon Titan 基础模型 (FM) 通过完全托管的 API 为客户提供了广泛的高性能图像、多模态嵌入和文本模型选择。 Amazon Titan 模型由 AWS 创建,并在大型数据集上进行预训练,使其成为强大的通用模型,旨在支持各种使用案例,同时还支持负责任地使用 AI。 按原样使用它们,或使用您自己的数据私下自定义它们。spring-doc.cadn.net.cn

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

AWS Bedrock Titan 模型页面Amazon Bedrock 用户指南包含有关如何使用 AWS 托管模型的详细信息。spring-doc.cadn.net.cn

先决条件

添加存储库和 BOM

Spring AI 工件发布在 Spring Milestone 和 Snapshot 存储库中。请参阅 Repositories 部分,将这些存储库添加到您的构建系统中。spring-doc.cadn.net.cn

为了帮助进行依赖项管理,Spring AI 提供了一个 BOM(物料清单),以确保在整个项目中使用一致的 Spring AI 版本。请参阅依赖项管理部分,将 Spring AI BOM 添加到您的构建系统中。spring-doc.cadn.net.cn

自动配置

添加spring-ai-bedrock-ai-spring-boot-starter依赖项添加到项目的 Mavenpom.xml文件:spring-doc.cadn.net.cn

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

或发送到您的 Gradlebuild.gradlebuild 文件。spring-doc.cadn.net.cn

dependencies {
    implementation 'org.springframework.ai:spring-ai-bedrock-ai-spring-boot-starter'
}
请参阅 Dependency Management 部分,将 Spring AI BOM 添加到您的构建文件中。

启用 Titan 嵌入支持

默认情况下,Titan 嵌入模型处于禁用状态。 要启用它,请将spring.ai.bedrock.titan.embedding.enabledproperty 设置为true. 导出环境变量是设置此配置属性的一种方法:spring-doc.cadn.net.cn

export SPRING_AI_BEDROCK_TITAN_EMBEDDING_ENABLED=true

嵌入属性

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

财产 描述 违约

spring.ai.bedrock.aws.regionspring-doc.cadn.net.cn

要使用的 AWS 区域。spring-doc.cadn.net.cn

us-east-1 (美国东部-1)spring-doc.cadn.net.cn

spring.ai.bedrock.aws.access-keyspring-doc.cadn.net.cn

AWS 访问密钥。spring-doc.cadn.net.cn

-spring-doc.cadn.net.cn

spring.ai.bedrock.aws.secret-keyspring-doc.cadn.net.cn

AWS 密钥。spring-doc.cadn.net.cn

-spring-doc.cadn.net.cn

前缀spring.ai.bedrock.titan.embedding(在BedrockTitanEmbeddingProperties) 是为 Titan 配置嵌入模型实现的属性前缀。spring-doc.cadn.net.cn

财产spring-doc.cadn.net.cn

描述spring-doc.cadn.net.cn

违约spring-doc.cadn.net.cn

spring.ai.bedrock.titan.embedding.enabledspring-doc.cadn.net.cn

启用或禁用对 Titan 嵌入的支持spring-doc.cadn.net.cn

spring-doc.cadn.net.cn

spring.ai.bedrock.titan.embedding.modelspring-doc.cadn.net.cn

要使用的模型 ID。请参阅TitanEmbeddingModel对于支持的型号。spring-doc.cadn.net.cn

亚马逊.titan-embed-image-v1spring-doc.cadn.net.cn

支持的值为:amazon.titan-embed-image-v1,amazon.titan-embed-text-v1amazon.titan-embed-text-v2:0. 模型 ID 值也可以在 AWS Bedrock 文档中找到基本模型 IDspring-doc.cadn.net.cn

运行时选项

BedrockTitanEmbeddingOptions.java 提供模型配置,例如input-type. 启动时,可以使用BedrockTitanEmbeddingModel(api).withInputType(type)方法或spring.ai.bedrock.titan.embedding.input-type性能。spring-doc.cadn.net.cn

在运行时,您可以通过向EmbeddingRequest叫。 例如,要覆盖特定请求的默认温度:spring-doc.cadn.net.cn

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

Samples控制器

创建一个新的 Spring Boot 项目并添加spring-ai-bedrock-ai-spring-boot-starter添加到您的 POM(或 Gradle)依赖项中。spring-doc.cadn.net.cn

添加application.properties文件中的src/main/resources目录中,以启用和配置 Titan Embedding 模型:spring-doc.cadn.net.cn

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
regions,access-keysecret-key替换为您的 AWS 凭证。

这将创建一个EmbeddingController实现,您可以将其注入到您的类中。 下面是一个简单的示例@Controller使用 Chat 模型生成文本的类。spring-doc.cadn.net.cn

@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并使用 Low-level TitanEmbeddingBedrockApi Client 连接到 Bedrock Titan 服务。spring-doc.cadn.net.cn

添加spring-ai-bedrock依赖项添加到项目的 Mavenpom.xml文件:spring-doc.cadn.net.cn

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

或发送到您的 Gradlebuild.gradlebuild 文件。spring-doc.cadn.net.cn

dependencies {
    implementation 'org.springframework.ai:spring-ai-bedrock'
}
请参阅 Dependency Management 部分,将 Spring AI BOM 添加到您的构建文件中。

接下来,创建一个 BedrockTitanEmbeddingModel 并将其用于文本嵌入:spring-doc.cadn.net.cn

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 模型的轻量级 Java 客户端。spring-doc.cadn.net.cn

下面的类图说明了 TitanEmbeddingBedrockApi 接口和构建块:spring-doc.cadn.net.cn

Bedrock Titan 嵌入低级 API

TitanEmbeddingBedrockApi 支持amazon.titan-embed-image-v1amazon.titan-embed-image-v1用于单个和批量嵌入计算的模型。spring-doc.cadn.net.cn

以下是如何以编程方式使用 api 的简单代码段:spring-doc.cadn.net.cn

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格式:spring-doc.cadn.net.cn

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