OpenSearch
本部分将指导您配置 OpenSearchVectorStore,以存储文档嵌入并执行相似性搜索。
OpenSearch 是一个开源的搜索和分析引擎,最初是从 Elasticsearch 分支而来,并基于 Apache License 2.0 授权分发。它通过简化和人工智能生成资产的集成与管理,提升了 AI 应用开发的效率。OpenSearch 支持向量、词汇和混合搜索功能,利用先进的向量数据库功能来实现低延迟查询和相似性搜索,详见 向量数据库页面。
OpenSearch k-NN 功能允许用户从大规模数据集中查询向量嵌入。嵌入是数据对象(如文本、图像、音频或文档)的数值表示。嵌入可以存储在索引中,并使用各种相似性函数进行查询。
先决条件
-
一个正在运行的 OpenSearch 实例。以下选项可供选择:
-
如果需要,用于 EmbeddingModel 的 API 密钥,以生成存储在
OpenSearchVectorStore中的嵌入向量。
自动配置
Spring AI 自动配置和 starter 模块的构件名称发生了重大变更。详情请参阅升级说明。
Spring AI 为 OpenSearch 向量存储提供了 Spring Boot 自动配置。要启用它,请将以下依赖项添加到项目的 Maven pom.xml 文件中:
<dependency>
<groupId>org.springframework.ai</groupId>
<artifactId>spring-ai-starter-vector-store-opensearch</artifactId>
</dependency>
或添加到您的 Gradle build.gradle 构建文件中:
dependencies {
implementation 'org.springframework.ai:spring-ai-starter-vector-store-opensearch'
}
对于自托管和 Amazon OpenSearch Service,使用相同的依赖项。请参考依赖管理部分,将 Spring AI BOM 添加到您的构建文件中。
请查看向量存储的配置参数列表,以了解默认值和配置选项。
此外,您还需要一个已配置的 EmbeddingModel bean。有关更多信息,请参阅 EmbeddingModel 部分。
现在,您可以在应用程序中将 OpenSearchVectorStore 自动装配为向量存储:
@Autowired VectorStore vectorStore;
// ...
List<Document> documents = List.of(
new Document("Spring AI rocks!! Spring AI rocks!! Spring AI rocks!!", Map.of("meta1", "meta1")),
new Document("The World is Big and Salvation Lurks Around the Corner"),
new Document("You walk forward facing the past and you turn back toward the future.", Map.of("meta2", "meta2")));
// Add the documents to OpenSearch
vectorStore.add(documents);
// Retrieve documents similar to a query
List<Document> results = vectorStore.similaritySearch(SearchRequest.builder().query("Spring").topK(5).build());
配置属性
要连接到 OpenSearch 并使用 OpenSearchVectorStore,您需要提供实例的访问详细信息。可以通过 Spring Boot 的 application.yml 提供简单的配置:
spring:
ai:
vectorstore:
opensearch:
uris: <opensearch instance URIs>
username: <opensearch username>
password: <opensearch password>
index-name: spring-ai-document-index
initialize-schema: true
similarity-function: cosinesimil
read-timeout: <time to wait for response>
connect-timeout: <time to wait until connection established>
path-prefix: <custom path prefix>
ssl-bundle: <name of SSL bundle>
aws: # Only for Amazon OpenSearch Service
host: <aws opensearch host>
service-name: <aws service name>
access-key: <aws access key>
secret-key: <aws secret key>
region: <aws region>
以 spring.ai.vectorstore.opensearch.* 开头的属性用于配置 OpenSearchVectorStore:
| 属性 | 描述 | 默认值 |
|---|---|---|
spring.ai.vectorstore.opensearch.uris | OpenSearch 集群端点的 URIs | - |
spring.ai.vectorstore.opensearch.username | 用于访问 OpenSearch 集群的用户名 | - |
spring.ai.vectorstore.opensearch.password | 指定用户名的密码 | - |
spring.ai.vectorstore.opensearch.index-name | 用于存储向量的索引名称 | spring-ai-document-index |
spring.ai.vectorstore.opensearch.initialize-schema | 是否初始化所需的 schema | false |
spring.ai.vectorstore.opensearch.similarity-function | 要使用的相似度函数 (cosinesimil, l1, l2, linf, innerproduct) | cosinesimil |
spring.ai.vectorstore.opensearch.use-approximate-knn | 是否使用近似 k-NN 以加快搜索速度。如果为 true,则使用基于 HNSW 的近似搜索;如果为 false,则使用精确的暴力 k-NN 搜索。参见 近似 k-NN 和 精确 k-NN | false |
spring.ai.vectorstore.opensearch.dimensions | 向量嵌入的维度数量。用于创建近似 k-NN 的索引映射。如果未设置,则使用嵌入模型的维度。 | 1536 |
spring.ai.vectorstore.opensearch.mapping-json | 索引的自定义 JSON 映射。覆盖默认映射生成。 | - |
spring.ai.vectorstore.opensearch.read-timeout | 等待对端端点响应的时间。0 - 无限大。 | - |
spring.ai.vectorstore.opensearch.connect-timeout | 等待连接建立的时间。0 - 无限大。 | - |
spring.ai.vectorstore.opensearch.path-prefix | OpenSearch API 端点的路径前缀。当 OpenSearch 位于具有非根路径的反向代理后面时非常有用。 | - |
spring.ai.vectorstore.opensearch.ssl-bundle | 在 SSL 连接情况下使用的 SSL Bundle 名称 | - |
spring.ai.vectorstore.opensearch.aws.host | OpenSearch 实例的主机名 | - |
spring.ai.vectorstore.opensearch.aws.service-name | AWS 服务名称 | - |
spring.ai.vectorstore.opensearch.aws.access-key | AWS 访问密钥 | - |
spring.ai.vectorstore.opensearch.aws.secret-key | AWS 秘密密钥 | - |
spring.ai.vectorstore.opensearch.aws.region | AWS 区域 | - |
您可以使用 spring.ai.vectorstore.opensearch.aws.enabled 属性来控制是否启用 AWS 特定的 OpenSearch 自动配置。
-
如果将此属性设置为
false,即使类路径中存在 AWS SDK 类,也会启用非 AWS 的 OpenSearch 配置。这使得您可以在存在用于其他服务的 AWS SDK 的环境中,使用自管理或第三方的 OpenSearch 集群。 -
如果不存在 AWS SDK 类,则始终使用非 AWS 配置。
-
如果存在 AWS SDK 类且该属性未设置或设置为
true,则默认使用 AWS 特定的配置。
此回退逻辑确保用户能够明确控制 OpenSearch 集成的类型,防止在不希望时使用 AWS 特定逻辑被意外激活。
path-prefix 属性允许你在 OpenSearch 运行于使用非根路径的反向代理之后时,指定自定义路径前缀。例如,如果你的 OpenSearch 实例通过 [example.com/opensearch/](https://example.com/opensearch/) 而不是 [example.com/](https://example.com/) 访问,则应将 path-prefix 设置为 /opensearch。
以下相似度函数可用:
cosinesimil- 默认选项,适用于大多数使用场景。衡量向量之间的余弦相似度。l1- 向量之间的曼哈顿距离。l2- 向量之间的欧几里得距离。linf- 向量之间的切比雪夫距离。
手动配置
除了使用 Spring Boot 自动配置外,您也可以手动配置 OpenSearch 向量存储。为此,需要在项目中添加 spring-ai-opensearch-store 依赖:
<dependency>
<groupId>org.springframework.ai</groupId>
<artifactId>spring-ai-opensearch-store</artifactId>
</dependency>
或添加至你的 Gradle build.gradle 构建文件中:
dependencies {
implementation 'org.springframework.ai:spring-ai-opensearch-store'
}
请参考 依赖管理 章节,以在您的构建文件中添加 Spring AI BOM。
创建一个 OpenSearch 客户端 Bean:
@Bean
public OpenSearchClient openSearchClient() {
RestClient restClient = RestClient.builder(
HttpHost.create("http://localhost:9200"))
.build();
return new OpenSearchClient(new RestClientTransport(
restClient, new JacksonJsonpMapper()));
}
然后使用构建器模式创建 OpenSearchVectorStore Bean:
@Bean
public VectorStore vectorStore(OpenSearchClient openSearchClient, EmbeddingModel embeddingModel) {
return OpenSearchVectorStore.builder(openSearchClient, embeddingModel)
.index("custom-index") // Optional: defaults to "spring-ai-document-index"
.similarityFunction("l2") // Optional: defaults to "cosinesimil"
.useApproximateKnn(true) // Optional: defaults to false (exact k-NN)
.dimensions(1536) // Optional: defaults to 1536 or embedding model's dimensions
.initializeSchema(true) // Optional: defaults to false
.batchingStrategy(new TokenCountBatchingStrategy()) // Optional: defaults to TokenCountBatchingStrategy
.build();
}
// This can be any EmbeddingModel implementation
@Bean
public EmbeddingModel embeddingModel() {
return new OpenAiEmbeddingModel(OpenAiEmbeddingOptions.builder().apiKey(System.getenv("OPENAI_API_KEY")).build());
}
元数据过滤
您也可以利用通用且可移植的 metadata filters 来配合 OpenSearch 使用。
例如,您可以使用以下文本表达式语言:
vectorStore.similaritySearch(
SearchRequest.builder()
.query("The World")
.topK(TOP_K)
.similarityThreshold(SIMILARITY_THRESHOLD)
.filterExpression("author in ['john', 'jill'] && 'article_type' == 'blog'").build());
或通过使用 Filter.Expression DSL 以编程方式:
FilterExpressionBuilder b = new FilterExpressionBuilder();
vectorStore.similaritySearch(SearchRequest.builder()
.query("The World")
.topK(TOP_K)
.similarityThreshold(SIMILARITY_THRESHOLD)
.filterExpression(b.and(
b.in("author", "john", "jill"),
b.eq("article_type", "blog")).build()).build());
这些(可移植的)过滤表达式会自动转换为 OpenSearch 专有的查询字符串查询(Query string query)。
例如,此便携式过滤器表达式:
author in ['john', 'jill'] && 'article_type' == 'blog'
会被转换为 OpenSearch 的专有过滤器格式:
(metadata.author:john OR jill) AND metadata.article_type:blog
访问 Native Client
OpenSearch Vector Store 实现通过 getNativeClient() 方法提供了对底层原生 OpenSearch 客户端(OpenSearchClient)的访问:
OpenSearchVectorStore vectorStore = context.getBean(OpenSearchVectorStore.class);
Optional<OpenSearchClient> nativeClient = vectorStore.getNativeClient();
if (nativeClient.isPresent()) {
OpenSearchClient client = nativeClient.get();
// Use the native client for OpenSearch-specific operations
}
原生客户端为您提供对 OpenSearch 特定特性和操作(这些特性和操作可能未通过 VectorStore 接口公开)的访问权限。