跳到主要内容

Elasticsearch

DeepSeek V3 中英对照 Elasticsearch

本节将引导您完成设置 Elasticsearch VectorStore 以存储文档嵌入并执行相似性搜索的过程。

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

先决条件​

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

自动配置​

Spring AI 提供了针对 Elasticsearch Vector Store 的 Spring Boot 自动配置。要启用它，请将以下依赖项添加到项目的 Maven pom.xml 或 Gradle build.gradle 构建文件中：

<dependency>
    <groupId>org.springframework.ai</groupId>
    <artifactId>spring-ai-elasticsearch-store-spring-boot-starter</artifactId>
</dependency>
xml
备注

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

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

请参考依赖管理部分，将 Spring AI BOM 添加到您的构建文件中。

提示

请参考 仓库 部分，将 Maven Central 和/或 Snapshot 仓库添加到你的构建文件中。

向量存储实现可以为你初始化所需的 schema，但你必须通过在适当的构造函数中指定 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());
java

配置属性​

要连接到 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
        batching-strategy: TOKEN_COUNT # Optional: Controls how documents are batched for embedding
yaml

以 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](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.bundleSSL 捆绑包名称。-
spring.elasticsearch.socket-keep-alive是否在客户端和 Elasticsearch 之间启用套接字保持活动状态。false
spring.elasticsearch.socket-timeout与 Elasticsearch 通信时使用的套接字超时时间。30s

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

属性描述默认值
spring.ai.vectorstore.elasticsearch.initialize-schema是否初始化所需的 schemafalse
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.batching-strategy计算嵌入时的文档批处理策略。选项为 TOKEN_COUNT 或 FIXED_SIZETOKEN_COUNT

以下相似度函数可用：

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

或者通过编程方式使用 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());
java
备注

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

例如，这个便携式过滤器表达式：

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

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

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

手动配置​

除了使用 Spring Boot 的自动配置，你还可以手动配置 Elasticsearch 向量存储。为此，你需要在项目中添加 spring-ai-elasticsearch-store 依赖：

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

或者到你的 Gradle build.gradle 构建文件中。

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

创建一个 Elasticsearch RestClient bean。有关自定义 RestClient 配置的更多深入信息，请阅读 Elasticsearch 文档。

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

然后使用构建器模式创建 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")));
}
java

访问原生客户端​

Elasticsearch Vector Store 实现通过 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
}
java

原生客户端允许你访问 Elasticsearch 特有的功能和操作，这些功能可能无法通过 VectorStore 接口暴露。