|
如需最新的快照版本，请使用 Spring AI 1.1.3！ |
Cohere 嵌入
提供 Bedrock Cohere 嵌入模型。 将生成式 AI 能力集成到关键应用和工作流中，以改善业务成果。
AWS Bedrock Cohere 模型页面和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添加到您的构建文件中。 |
启用 Cohere 嵌入支持
默认情况下，Cohere 嵌入模型处于禁用状态。
要启用它，请在您的应用程序配置中将 spring.ai.model.embedding 属性设置为 bedrock-cohere：
spring.ai.model.embedding=bedrock-cohere或者，您可以使用 Spring 表达式语言 (SpEL) 来引用环境变量：
# In application.yml
spring:
ai:
model:
embedding: ${AI_MODEL_EMBEDDING}# In your environment or .env file
export AI_MODEL_EMBEDDING=bedrock-cohere您也可以在启动应用程序时使用 Java 系统属性设置此属性：
java -Dspring.ai.model.embedding=bedrock-cohere -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-cohere（默认已启用） 要禁用，请设置 spring.ai.model.embedding=none（或任何不匹配 bedrock-cohere 的值） 此更改是为了允许配置多个模型。 |
前缀 spring.ai.bedrock.cohere.embedding（在 BedrockCohereEmbeddingProperties 中定义）是用于配置 Cohere 嵌入模型实现的属性前缀。
<property> </property> |
<description> </description> |
默认 |
spring.ai.model.embedding |
启用或禁用对 Cohere 的支持 |
bedrock-cohere |
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 |
在每个类型前添加特殊Tokens，以区分彼此。除非在混合搜索和检索的类型时，否则不应将不同类型混合在一起。在这种情况下，请使用 search_document 类型嵌入您的语料库，并使用 search_query 类型嵌入查询。 |
SEARCH_DOCUMENT |
spring.ai.bedrock.cohere.embedding.options.truncate |
指定 API 如何处理超过最大Tokens长度的输入。如果您指定 LEFT 或 RIGHT，模型将丢弃部分输入，直到剩余输入的长度恰好等于该模型的最大输入Tokens长度。 |
无 |
通过 Amazon Bedrock 访问 Cohere 时，截断功能不可用。这是 Amazon Bedrock 的一个问题。Spring AI 类 BedrockCohereEmbeddingModel 将截断为 2048 个字符长度，这是该模型支持的最大长度。 |
查看 CohereEmbeddingModel 以获取其他模型 ID。
支持的值为：cohere.embed-multilingual-v3 和 cohere.embed-english-v3。
模型 ID 值也可以在 AWS Bedrock 基础模型 ID 文档 中找到。
所有以spring.ai.bedrock.cohere.embedding.options开头的属性可以在运行时通过向EmbeddingRequest调用添加请求特定的运行时选项来覆盖。 |
运行时选项
BedrockCohereEmbeddingOptions.java 提供了模型配置，例如 input-type 或 truncate。
启动时，可以使用BedrockCohereEmbeddingModel(api, options)构造函数或spring.ai.bedrock.cohere.embedding.options.*属性来配置默认选项。
在运行时，您可以通过向 EmbeddingRequest 调用添加新的、特定于请求的选项来覆盖默认选项。
例如，为特定请求覆盖默认输入类型：
EmbeddingResponse embeddingResponse = embeddingModel.call(
new EmbeddingRequest(List.of("Hello World", "World is big and salvation is near"),
BedrockCohereEmbeddingOptions.builder()
.withInputType(InputType.SEARCH_DOCUMENT)
.build()));样本控制器
创建一个新的Spring Boot项目，并在pom（或gradle）依赖中添加spring-ai-starter-model-bedrock。
在 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.model.embedding=bedrock-cohere
spring.ai.bedrock.cohere.embedding.options.input-type=search-document将 regions、access-key 和 secret-key 替换为您的 AWS 凭证。 |
这将创建一个BedrockCohereEmbeddingModel实现，你可以在你的类中注入。
以下是一个使用聊天模型进行文本生成的简单@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);
}
}手动配置
BedrockCohereEmbeddingModel 实现了 EmbeddingModel，并使用 低级 CohereEmbeddingBedrockApi 客户端 连接到 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'
}| 请参阅依赖管理部分，将Spring AI BOM添加到您的构建文件中。 |
接下来，创建一个 BedrockCohereEmbeddingModel 并将其用于文本嵌入：
var cohereEmbeddingApi =new CohereEmbeddingBedrockApi(
CohereEmbeddingModel.COHERE_EMBED_MULTILINGUAL_V1.id(),
EnvironmentVariableCredentialsProvider.create(), Region.US_EAST_1.id(), new ObjectMapper());
var embeddingModel = new BedrockCohereEmbeddingModel(this.cohereEmbeddingApi);
EmbeddingResponse embeddingResponse = this.embeddingModel
.embedForResponse(List.of("Hello World", "World is big and salvation is near"));低级 CohereEmbeddingBedrockApi 客户端
CohereEmbeddingBedrockApi 提供了一个轻量级的 Java 客户端，构建于 AWS Bedrock Cohere Command 模型 之上。
以下类图展示了 CohereEmbeddingBedrockApi 接口及其构建模块：
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 = this.api.embedding(this.request);