Elasticsearch

本节引导你设置 Elasticsearch VectorStore 以存储文档嵌入并执行相似度搜索。

Elasticsearch 是一个基于 Apache Lucene 库的开源搜索与分析引擎。

前置条件

一个正在运行的 Elasticsearch 实例。有以下可选方案：

• Docker
• 自管理 Elasticsearch
• Elastic Cloud

自动配置

NOTE

Spring AI 的自动配置、starter 模块的制品名称发生了重大变更。 更多信息请参阅 升级说明。

Spring AI 为 Elasticsearch 向量库提供 Spring Boot 自动配置。 要启用它，请将以下依赖添加到你的项目的 Maven pom.xml 或 Gradle build.gradle 构建文件：

<dependency>
    <groupId>org.springframework.ai</groupId>
    <artifactId>spring-ai-starter-vector-store-elasticsearch</artifactId>
</dependency>

对于 3.3.0 之前的 spring-boot 版本，需要显式添加版本 > 8.13.3 的 elasticsearch-java 依赖，否则所使用的较旧版本将与所执行的查询不兼容：

<dependency>
    <groupId>co.elastic.clients</groupId>
    <artifactId>elasticsearch-java</artifactId>
    <version>8.13.3</version>
</dependency>

TIP

参见 依赖管理 一节，把 Spring AI BOM 添加到你的构建文件。

TIP

参见 制品仓库 一节，把 Maven Central 和/或 Snapshot 仓库添加到你的构建文件。

向量库实现可以为你初始化所需的模式，但你必须显式开启——在相应的构造器中指定 initializeSchema 布尔值，或在 application.properties 文件中设置 ...initialize-schema=true。 或者，你可以选择不进行初始化，而是使用 Elasticsearch 客户端手动创建索引；当索引需要高级映射或额外配置时，这可能很有用。

NOTE

这是一处破坏性变更！在较早的 Spring AI 版本中，此模式初始化默认进行。

请查看该向量库的配置参数 列表，了解默认值和配置选项。 这些属性也可以通过配置 ElasticsearchVectorStoreOptions bean 来设置。

此外，你还需要一个已配置的 EmbeddingModel 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: cosine

以 spring.elasticsearch.* 开头的 Spring Boot 属性用于配置 Elasticsearch 客户端：

属性	描述	默认值
spring.elasticsearch.connection-timeout	与 Elasticsearch 通信时使用的连接超时。	1s
spring.elasticsearch.password	用于对 Elasticsearch 认证的密码。	-
spring.elasticsearch.username	用于对 Elasticsearch 认证的用户名。	-
spring.elasticsearch.uris	要使用的 Elasticsearch 实例的逗号分隔列表。	+http://localhost:9200+
spring.elasticsearch.path-prefix	添加到发往 Elasticsearch 的每个请求路径前的前缀。	-
spring.elasticsearch.restclient.sniffer.delay-after-failure	失败之后安排的一次嗅探执行的延迟。	1m
spring.elasticsearch.restclient.sniffer.interval	相邻普通嗅探执行之间的间隔。	5m
spring.elasticsearch.restclient.ssl.bundle	SSL bundle 名称。	-
spring.elasticsearch.socket-keep-alive	是否在客户端与 Elasticsearch 之间启用套接字保活。	false
spring.elasticsearch.socket-timeout	与 Elasticsearch 通信时使用的套接字超时。	30s

以 spring.ai.vectorstore.elasticsearch.* 开头的属性用于配置 ElasticsearchVectorStore：

属性	描述	默认值
spring.ai.vectorstore.elasticsearch.initialize-schema	是否初始化所需的模式	false
spring.ai.vectorstore.elasticsearch.index-name	存储向量的索引名	spring-ai-document-index
spring.ai.vectorstore.elasticsearch.dimensions	向量的维度数	1536
spring.ai.vectorstore.elasticsearch.similarity	要使用的相似度函数	cosine
spring.ai.vectorstore.elasticsearch.embedding-field-name	要据以搜索的向量字段名	embedding

以下相似度函数可用：

• 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());

NOTE

这些（可移植的）过滤表达式会被自动转换为 Elasticsearch 专有的 Query string query。

例如，这个可移植的过滤表达式：

author in ['john', 'jill'] && 'article_type' == 'blog'

会被转换为 Elasticsearch 专有的过滤格式：

(metadata.author:john OR jill) AND metadata.article_type:blog

upsert 支持

ElasticsearchVectorStore 实现了 upsert(List<EmbeddedDocument>)，因此你可以连同在别处计算好的嵌入一起写入文档，而不必让向量库去做嵌入。 以相同 id 再次写入会替换既有的行，因此用稳定的 id 重跑不会产生重复。 细节参见写入用户提供的嵌入。

手动配置

与其使用 Spring Boot 自动配置，不如手动配置 Elasticsearch 向量库。为此你需要把 spring-ai-elasticsearch-store 添加到你的项目：

<dependency>
    <groupId>org.springframework.ai</groupId>
    <artifactId>spring-ai-elasticsearch-store</artifactId>
</dependency>

或添加到你的 Gradle build.gradle 构建文件。

dependencies {
    implementation 'org.springframework.ai:spring-ai-elasticsearch-store'
}

创建一个 Elasticsearch Rest5Client bean。 要更深入地了解自定义 Rest5Client 的配置，请阅读 Elasticsearch 文档。

@Bean
public Rest5Client restClient() {
    return Rest5Client.builder(new HttpHost("<host>", 9200, "http"))
        .setDefaultHeaders(new Header[]{
            new BasicHeader("Authorization", "Basic <encoded username and password>")
        })
        .build();
}

然后使用构建器模式创建 ElasticsearchVectorStore bean：

@Bean
public VectorStore vectorStore(Rest5Client 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(OpenAiEmbeddingOptions.builder().apiKey(System.getenv("OPENAI_API_KEY")).build());
}

访问原生客户端

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
}

原生客户端让你得以访问那些可能未通过 VectorStore 接口暴露的 Elasticsearch 特定功能与操作。