Elasticsearch

Deepseek 3.2 中英对照 Elasticsearch

本节将指导您如何设置Elasticsearch VectorStore 来存储文档嵌入并执行相似性搜索。

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

前提条件

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

• Docker

• 自托管 Elasticsearch

• Elastic Cloud

自动配置

备注

Spring AI 的自动配置和 starter 模块的 artifact 名称发生了显著变化。更多信息请参阅 升级说明。

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

Maven

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

Gradle

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

备注

对于 Spring Boot 3.3.0 之前的版本，必须显式添加版本大于 8.13.3 的 elasticsearch-java 依赖，否则所使用的旧版本将与执行的查询不兼容：

Maven

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

Gradle

dependencies {
    implementation 'co.elastic.clients:elasticsearch-java:8.13.3'
}

:::提示
请参考依赖管理章节，将 Spring AI BOM 添加到你的构建文件中。
:::

:::提示
参考 Artifact 仓库 部分，将 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，您需要提供 Elasticsearch 实例的访问详细信息。可以通过 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 捆绑包名称。	-
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());

备注

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

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

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。有关自定义 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();
}

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

原生客户端为您提供了访问Elasticsearch特有功能和操作的途径，这些可能无法通过VectorStore接口直接获取。