OpenSearch
本节将引导您设置 OpenSearchVectorStore 以存储文档嵌入并执行相似性搜索。
OpenSearch 是一个开源的搜索和分析引擎,最初从 Elasticsearch 分支而来,并以 Apache 许可证 2.0 发布。它通过简化 AI 生成资产的集成和管理来增强 AI 应用程序开发。OpenSearch 支持向量、词法和混合搜索功能,利用先进的向量数据库功能来促进低延迟查询和相似性搜索,详情请参阅向量数据库页面。
OpenSearch k-NN 功能允许用户查询大型数据集中的向量嵌入。嵌入是数据对象(如文本、图像、音频或文档)的数值表示。嵌入可以存储在索引中,并使用各种相似性函数进行查询。
先决条件
-
正在运行的 OpenSearch 实例。以下选项可用:
-
如果需要,还需要一个 EmbeddingModel 的 API 密钥,用于生成由
OpenSearchVectorStore存储的嵌入。
自动配置
|
Spring AI 自动配置、启动模块的工件名称发生了重大变化。请参阅 升级说明 以获取更多信息。 |
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 服务,请使用相同的依赖项。请参阅依赖管理部分,将 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
| 财产 | 描述 | 默认值 |
|---|---|---|
|
OpenSearch 集群端点的 URI |
- |
|
访问 OpenSearch 集群的用户名 |
- |
|
指定用户名的密码 |
- |
|
存储向量的索引名称 |
|
|
是否初始化所需的模式 |
|
|
要使用的相似性函数(cosinesimil、l1、l2、linf、innerproduct) |
|
|
是否使用近似 k-NN 进行更快搜索。如果为 true,则使用基于 HNSW 的近似搜索。如果为 false,则使用精确的暴力 k-NN。请参阅近似 k-NN 和精确 k-NN |
|
|
向量嵌入的维度数量。用于为近似 k-NN 创建索引映射。如果未设置,则使用嵌入模型的维度。 |
|
|
索引的自定义 JSON 映射。覆盖默认映射生成。 |
- |
|
等待对端响应的时间。0 - 无限。 |
- |
|
等待建立连接的时间。0 - 无限。 |
- |
|
OpenSearch API 端点的路径前缀。当 OpenSearch 位于非根路径的反向代理后面时很有用。 |
- |
|
在 SSL 连接情况下要使用的 SSL 捆绑包名称 |
- |
|
OpenSearch 实例的主机名 |
- |
|
AWS 服务名称 |
- |
|
AWS 访问密钥 |
- |
|
AWS 秘密密钥 |
- |
|
AWS 区域 |
- |
|
您可以使用
此回退逻辑确保用户可以明确控制 OpenSearch 集成类型,从而避免在不需要时意外激活 AWS 特定逻辑。 |
|
|
以下相似性函数可用
-
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("https://: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(new OpenAiApi(System.getenv("OPENAI_API_KEY")));
}
元数据过滤
您也可以将通用的、可移植的元数据过滤器与 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 查询字符串查询。 |
例如,这个可移植的过滤器表达式
author in ['john', 'jill'] && 'article_type' == 'blog'
转换为专有的 OpenSearch 过滤器格式
(metadata.author:john OR jill) AND metadata.article_type:blog
访问原生客户端
OpenSearch 向量存储实现通过 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
}
原生客户端允许您访问 VectorStore 接口可能未公开的 OpenSearch 特定功能和操作。