Elasticsearch

本节将引导您设置 Elasticsearch VectorStore 以存储文档嵌入并执行相似性搜索。 Elasticsearch 是一个基于 Apache Lucene 库的开源搜索和分析引擎。

先决条件

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

自动配置

Spring AI 自动配置、启动器模块的 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'
}

对于 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 的早期版本中，此模式初始化是默认发生的。

请查看 elasticsearchvector-properties 列表，了解向量存储的默认值和配置选项。 这些属性也可以通过配置 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 捆绑包名称。

-

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 查询字符串查询。

例如，此可移植过滤器表达式：

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 特定功能和操作。