Elasticsearch

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

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

先决条件

一个正在运行的 Elasticsearch 实例。以下选项可用

自动配置

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

Spring AI 为 Elasticsearch Vector Store 提供了 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'
}

对于早于 3.3.0 的 spring-boot 版本，需要明确添加版本 > 8.13.3 的 elasticsearch-java 依赖项，否则使用的旧版本将与执行的查询不兼容

  • Maven

  • Gradle

<dependency>
    <groupId>co.elastic.clients</groupId>
    <artifactId>elasticsearch-java</artifactId>
    <version>8.13.3</version>
</dependency>
dependencies {
    implementation 'co.elastic.clients:elasticsearch-java:8.13.3'
}
请参阅依赖管理部分，将 Spring AI BOM 添加到您的构建文件中。
请参阅仓库部分，将 Maven Central 和/或 Snapshot 仓库添加到您的构建文件中。

向量存储实现可以为您初始化必要的模式，但您必须通过在相应的构造函数中指定 initializeSchema 布尔值或在 application.properties 文件中设置 …​initialize-schema=true 来选择启用。或者，您可以选择不进行初始化，并使用 Elasticsearch 客户端手动创建索引，这在索引需要高级映射或额外配置时非常有用。

这是一个重大变更！在早期版本的 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 实例的逗号分隔列表。

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 之间启用 socket keep alive。

false

spring.elasticsearch.socket-timeout

与 Elasticsearch 通信时使用的 socket 超时。

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

以下相似度函数可用

  • 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 build.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
}

原生客户端允许您访问可能未通过 VectorStore 接口公开的特定于 Elasticsearch 的功能和操作。