弹性搜索
本节将引导您完成 Elasticsearch 的设置VectorStore以存储文档嵌入并执行相似性搜索。
Elasticsearch 是一个基于 Apache Lucene 库的开源搜索和分析引擎。
自动配置
|
Spring AI 自动配置、入门模块的工件名称发生了重大变化。 有关更多信息，请参阅升级说明。 |
Spring AI 为 Elasticsearch 矢量存储提供 Spring Boot 自动配置。
要启用它，请将以下依赖项添加到项目的 Mavenpom.xml或 Gradlebuild.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'
}|
对于 3.3.0 之前的 spring-boot 版本，必须显式添加 8.13.3 版本的 elasticsearch-java 依赖项>否则使用的旧版本将与执行的查询不兼容：
|
| 请参阅依赖项管理部分，将 Spring AI BOM 添加到构建文件中。 |
| 请参阅 Artifact Repositories 部分，将 Maven Central 和/或 Snapshot Repositories 添加到构建文件中。 |
矢量存储实现可以为您初始化必要的架构，但您必须通过指定initializeSchema布尔值或通过…initialize-schema=true在application.properties文件。
或者，您可以选择退出初始化并使用 Elasticsearch 客户端手动创建索引，如果索引需要高级映射或其他配置，这会很有用。
| 这是一个重大变化！在早期版本的 Spring AI 中，默认情况下会发生此模式初始化。 |
请查看矢量存储的配置参数列表，了解默认值和配置选项。
这些属性也可以通过配置ElasticsearchVectorStoreOptions豆。
此外，您还需要配置一个EmbeddingModel豆。有关详细信息，请参阅 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: cosine以spring.elasticsearch.*用于配置 Elasticsearch 客户端：
| 属性 | 描述 | 默认值 |
|---|---|---|
|
与 Elasticsearch 通信时使用的连接超时。 |
|
|
使用 Elasticsearch 进行身份验证的密码。 |
- |
|
使用 Elasticsearch 进行身份验证的用户名。 |
- |
|
要使用的 Elasticsearch 实例的逗号分隔列表。 |
|
|
添加到发送到 Elasticsearch 的每个请求的路径中的前缀。 |
- |
|
失败后计划的嗅探执行的延迟。 |
|
|
连续普通嗅探执行之间的间隔。 |
|
|
SSL 捆绑包名称。 |
- |
|
是否在客户端和 Elasticsearch 之间启用套接字保持活动状态。 |
|
|
与 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.ExpressionDSL：
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手动配置
您可以手动配置 Elasticsearch 矢量存储，而不是使用 Spring Boot 自动配置。为此，您需要添加spring-ai-elasticsearch-store到你的项目：
<dependency>
<groupId>org.springframework.ai</groupId>
<artifactId>spring-ai-elasticsearch-store</artifactId>
</dependency>或 Gradlebuild.gradle构建文件。
dependencies {
implementation 'org.springframework.ai:spring-ai-elasticsearch-store'
}创建 ElasticsearchRestClient豆。
阅读 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();
}然后创建ElasticsearchVectorStorebean 使用构建器模式：
@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 Vector Store 实现提供对底层原生 Elasticsearch 客户端 （ElasticsearchClient） 通过getNativeClient()方法：
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接口。