Cohere Embeddings

提供 Bedrock Cohere Embedding 客户端。将生成式 AI 功能集成到核心应用程序和工作流中，以改善业务成果。 AWS Bedrock Cohere Model Page和 Amazon Bedrock User Guide包含有关如何使用 AWS 托管模型的详细信息。

Prerequisites

请参阅 Spring AI documentation on Amazon Bedrock 以设置 API 访问。

Add Repositories and BOM

Spring AI 工件发布在 Spring Milestone 和 Snapshot 存储库中。有关将这些存储库添加到你的构建系统的说明，请参阅 Repositories 部分。

为了帮助进行依赖项管理，Spring AI 提供了一个 BOM（物料清单）以确保在整个项目中使用一致版本的 Spring AI。有关将 Spring AI BOM 添加到你的构建系统的说明，请参阅 Dependency Management 部分。

Auto-configuration

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

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

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

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

  1. 参见 Dependency Management 部分，将 Spring AI BOM 添加到你的构建文件中。

Enable Cohere Embedding Support

默认情况下，Cohere 模型被禁用。要启用它，请将 spring.ai.bedrock.cohere.embedding.enabled 属性设置为 true。导出环境变量是设置此配置属性的一种方法：

export SPRING_AI_BEDROCK_COHERE_EMBEDDING_ENABLED=true

Embedding Properties

spring.ai.bedrock.aws 前缀是配置与 AWS Bedrock 的连接的属性前缀。

Property Description Default

spring.ai.bedrock.aws.region

AWS region to use.

us-east-1

spring.ai.bedrock.aws.access-key

AWS access key.

-

spring.ai.bedrock.aws.secret-key

AWS secret key.

-

前缀 spring.ai.bedrock.cohere.embedding （在 BedrockCohereEmbeddingProperties 中定义）是配置 Cohere 嵌入式客户端实现的属性前缀。

Property

Description

Default

spring.ai.bedrock.cohere.embedding.enabled

启用或禁用对 Cohere 的支持

false

spring.ai.bedrock.cohere.embedding.model

要使用的模型 ID。请参阅 CohereEmbeddingModel以了解支持的模型。

cohere.embed-multilingual-v3

spring.ai.bedrock.cohere.embedding.options.input-type

在前缀中添加特殊令牌以区分各种类型。你不应将不同的类型混合在一起，但用于搜索和检索的混合类型除外。在这种情况下，请使用 search_document 类型嵌入语料库，并将嵌入查询与 search_query 类型嵌入。

SEARCH_DOCUMENT

spring.ai.bedrock.cohere.embedding.options.truncate

指定 API 如何处理长度超过最大标记长度的输入。如果你指定 LEFT 或 RIGHT，该模型将丢弃输入，直到剩余输入恰好达到该模型的最大输入标记长度。

NONE

查看 CohereEmbeddingModel 获取其他模型 ID。支持的值为： cohere.embed-multilingual-v3 和 cohere.embed-english-v3。模型 ID 值也可以在 AWS Bedrock documentation for base model IDs 中找到。

所有前缀为 spring.ai.bedrock.cohere.embedding.options 的属性可以通过在 EmbeddingRequest 调用中添加一个请求特定的 Embedding Options 来在运行时覆盖。

Embedding Options

BedrockCohereEmbeddingOptions.java 提供模型配置，例如 input-type 或 truncate。

在启动时，可以使用 BedrockCohereEmbeddingClient(api, options) 构造函数或 spring.ai.bedrock.cohere.embedding.options.* 属性配置默认选项。

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

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

Sample Controller (Auto-configuration)

Create一个新的 Spring Boot 项目，并将 `spring-ai-bedrock-ai-spring-boot-starter`添加到您的 pom（或 gradle）依赖项。

在 src/main/resources 目录下添加一个 application.properties 文件，以启用和配置 Cohere 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.bedrock.cohere.embedding.enabled=true
spring.ai.bedrock.cohere.embedding.options.input-type=search-document

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

这将创建一个 BedrockCohereEmbeddingClient 实现，你可以将其注入到你的类中。这是一个使用聊天客户端进行文本生成的简单 @Controller 类的示例：

@RestController
public class EmbeddingController {

    private final EmbeddingClient embeddingClient;

    @Autowired
    public EmbeddingController(EmbeddingClient embeddingClient) {
        this.embeddingClient = embeddingClient;
    }

    @GetMapping("/ai/embedding")
    public Map embed(@RequestParam(value = "message", defaultValue = "Tell me a joke") String message) {
        EmbeddingResponse embeddingResponse = this.embeddingClient.embedForResponse(List.of(message));
        return Map.of("embedding", embeddingResponse);
    }
}

Manual Configuration

BedrockCohereEmbeddingClient实现`EmbeddingClient`，并且使用Low-level CohereEmbeddingBedrockApi Client连接到Bedrock Cohere服务。

将 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'
}

  1. 参见 Dependency Management 部分，将 Spring AI BOM 添加到你的构建文件中。

接下来，创建一个 BedrockCohereEmbeddingClient 并在其中使用文本嵌入：

var cohereEmbeddingApi =new CohereEmbeddingBedrockApi(
		CohereEmbeddingModel.COHERE_EMBED_MULTILINGUAL_V1.id(),
		EnvironmentVariableCredentialsProvider.create(), Region.US_EAST_1.id(), new ObjectMapper());


var embeddingClient = new BedrockCohereEmbeddingClient(cohereEmbeddingApi);

EmbeddingResponse embeddingResponse = embeddingClient
	.embedForResponse(List.of("Hello World", "World is big and salvation is near"));

Low-level CohereEmbeddingBedrockApi Client

CohereEmbeddingBedrockApi 提供轻量级 Java 客户端，在 AWS Bedrock Cohere Command models 上。

以下类图说明了 CohereEmbeddingBedrockApi 接口和构建块：

bedrock cohere embedding low level api

CohereEmbeddingBedrockApi 支持 cohere.embed-english-v3 和 cohere.embed-multilingual-v3 模型用于单个和批处理嵌入计算。

下面是一个简单的片段，说明如何以编程方式使用 API：

CohereEmbeddingBedrockApi api = new CohereEmbeddingBedrockApi(
		CohereEmbeddingModel.COHERE_EMBED_MULTILINGUAL_V1.id(),
		EnvironmentVariableCredentialsProvider.create(),
		Region.US_EAST_1.id(), new ObjectMapper());

CohereEmbeddingRequest request = new CohereEmbeddingRequest(
		List.of("I like to eat apples", "I like to eat oranges"),
		CohereEmbeddingRequest.InputType.search_document,
		CohereEmbeddingRequest.Truncate.NONE);

CohereEmbeddingResponse response = api.embedding(request);