Elasticsearch
本节将指导您设置 Elasticsearch VectorStore,以存储文档嵌入并执行相似性搜索。
Elasticsearch 是一个基于 Apache Lucene 库的开源搜索和分析引擎。
自动配置
|
There has been a significant change in the Spring AI auto-configuration, starter modules' artifact names. Please refer to the 升级说明以获取更多信息。 |
Spring AI 为 Elasticsearch 向量存储提供 Spring Boot 自动配置。
要启用它，请将以下依赖项添加到项目的 Maven pom.xml 或 Gradle build.gradle 构建文件中：
-
Maven
-
Gradle
<dependency>
<groupId>org.springframework.ai</groupId>
<artifactId>spring-ai-starter-vector-store-elasticsearch</artifactId>
</dependency>dependencies {
implementation 'org.springframework.ai:spring-ai-starter-vector-store-elasticsearch'
}|
对于 Spring Boot 3.3.0 之前的版本，必须显式添加 Elasticsearch-Java 依赖，且版本需高于 8.13.3；否则，所使用的旧版本将与执行的查询不兼容。
|
| 参考以下依赖管理部分，添加Spring AI BOM到你的构建文件中。 |
| 引用 Artifact 仓库 部分，以在构建文件中添加 Maven Central 和/或 Snapshot 仓库。 |
向量存储实现可以为您初始化所需的模式，但您必须通过在相应构造函数中指定布尔值 initializeSchema 或在 application.properties 文件中设置 …initialize-schema=true 来选择加入。
或者，您也可以选择不进行初始化，并使用 Elasticsearch 客户端手动创建索引，这在索引需要高级映射或额外配置时非常有用。
| 这是一个破坏性变更！在早期版本的 Spring AI 中，此模式初始化是默认进行的。 |
请查看向量存储的配置参数列表，以了解默认值和配置选项。
这些属性也可以通过配置ElasticsearchVectorStoreOptions Bean来设置。
此外，您还需要配置一个EmbeddingModel的豆。有关详细信息，请参阅
现在您可以在应用程序中自动将ElasticsearchVectorStore作为向量存储进行注入。
@Autowired VectorStore vectorStore;
// ...
List <Document> documents = List.of(
new Document("Spring AI rocks!! Spring AI rocks!! 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 Elasticsearch
vectorStore.add(documents);
// Retrieve documents similar to a query
List<Document> results = this.vectorStore.similaritySearch(SearchRequest.builder().query("Spring").topK(5).build());配置属性
要连接到 Elasticsearch 并使用 ElasticsearchVectorStore,您需要提供实例的访问详细信息。
可以通过 Spring Boot 的 application.yml 提供简单的配置，
spring:
elasticsearch:
uris: <elasticsearch instance URIs>
username: <elasticsearch username>
password: <elasticsearch password>
ai:
vectorstore:
elasticsearch:
initialize-schema: true
index-name: custom-index
dimensions: 1536
similarity: cosineSpring Boot 中以 spring.elasticsearch.* 开头的属性用于配置 Elasticsearch 客户端：
| 属性 | 描述 | 默认值 |
|---|---|---|
|
与 Elasticsearch 通信时使用的连接超时时间。 |
|
|
用于 Elasticsearch 身份验证的密码。 |
- |
|
用于 Elasticsearch 身份验证的用户名。 |
- |
|
用逗号分隔的要使用的 Elasticsearch 实例列表。 |
|
|
添加到发送至 Elasticsearch 的每个请求路径前的前缀。 |
- |
|
故障后计划执行的嗅探操作的延迟时间。 |
|
|
连续普通嗅探执行之间的间隔。 |
|
|
SSL 证书包名称。 |
- |
|
是否在客户端与 Elasticsearch 之间启用套接字保活（socket keep alive）。 |
|
|
与 Elasticsearch 通信时使用的套接字超时时间。 |
|
以 spring.ai.vectorstore.elasticsearch.* 开头的属性用于配置 ElasticsearchVectorStore：
| 属性 | 描述 | 默认值 |
|---|---|---|
|
是否初始化所需的模式 |
|
|
存储向量的索引名称 |
|
|
向量中的维度数量 |
|
|
要使用的相似度函数 |
|
|
要搜索的向量字段名称 |
|
以下相似度函数可用：
-
cosine- 默认值，适用于大多数用例。衡量向量之间的余弦相似度。 -
l2_norm- 向量之间的欧几里得距离。数值越低，表示相似度越高。 -
dot_product- 归一化向量的最佳性能（例如，OpenAI 嵌入）。
更多关于每个内容的详细信息，请参阅 Elasticsearch 文档 中有关稠密向量的部分。
元数据过滤
您也可以在 Elasticsearch 中利用通用、可移植的 元数据过滤器。
例如，你可以使用文本表达式语言：
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());| 那些（可移植的）过滤表达式会自动转换为专有的 Elasticsearch 查询字符串查询。 |
例如，这个可移植的过滤表达式：
author in ['john', 'jill'] && 'article_type' == 'blog'被转换为专有的 Elasticsearch 过滤器格式：
(metadata.author:john OR jill) AND metadata.article_type:blog手动配置
与其使用 Spring Boot 自动配置，您可以手动配置 Elasticsearch 向量存储。为此，您需要将 spring-ai-elasticsearch-store 添加到您的项目中：
<dependency>
<groupId>org.springframework.ai</groupId>
<artifactId>spring-ai-elasticsearch-store</artifactId>
</dependency>或者添加到您的Gradle 构建脚本文件中。
dependencies {
implementation 'org.springframework.ai:spring-ai-elasticsearch-store'
}创建一个 Elasticsearch RestClient bean。
请阅读Elasticsearch 文档,以获取有关自定义 RestClient 配置的更深入信息。
@Bean
public RestClient restClient() {
return RestClient.builder(new HttpHost("<host>", 9200, "http"))
.setDefaultHeaders(new Header[]{
new BasicHeader("Authorization", "Basic <encoded username and password>")
})
.build();
}然后使用构建器模式创建 ElasticsearchVectorStore Bean：
@Bean
public VectorStore vectorStore(RestClient restClient, EmbeddingModel embeddingModel) {
ElasticsearchVectorStoreOptions options = new ElasticsearchVectorStoreOptions();
options.setIndexName("custom-index"); // Optional: defaults to "spring-ai-document-index"
options.setSimilarity(COSINE); // Optional: defaults to COSINE
options.setDimensions(1536); // Optional: defaults to model dimensions or 1536
return ElasticsearchVectorStore.builder(restClient, embeddingModel)
.options(options) // Optional: use custom options
.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")));
}访问原生客户端
Elasticsearch 向量存储实现通过 getNativeClient() 方法提供对底层原生 Elasticsearch 客户端 (ElasticsearchClient) 的访问：
ElasticsearchVectorStore vectorStore = context.getBean(ElasticsearchVectorStore.class);
Optional<ElasticsearchClient> nativeClient = vectorStore.getNativeClient();
if (nativeClient.isPresent()) {
ElasticsearchClient client = nativeClient.get();
// Use the native client for Elasticsearch-specific operations
}原生客户端使您能够访问 Elasticsearch 特有的功能和操作，而这些功能和操作可能不会通过 VectorStore 接口公开。