Elasticsearch

本节将指导您设置 Elasticsearch 以存储文档嵌入并执行相似性搜索。VectorStorespring-doc.cn

Elasticsearch 是基于 Apache Lucene 库的开源搜索和分析引擎。spring-doc.cn

先决条件

正在运行的 Elasticsearch 实例。以下选项可用：spring-doc.cn

自动配置

Spring AI 为 Elasticsearch Vector Store 提供 Spring Boot 自动配置。要启用它，请将以下依赖项添加到项目的 Maven 或 Gradle 构建文件中：pom.xmlbuild.gradlespring-doc.cn

Mavenspring-doc.cn
Gradlespring-doc.cn

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

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

对于 spring-boot 3.3.0 之前的版本，必须显式添加版本 > 8.13.3 的 elasticsearch-java 依赖项，否则使用的旧版本将与执行的查询不兼容：spring-doc.cn

Mavenspring-doc.cn
Gradlespring-doc.cn

<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'
}

请参阅 Dependency Management 部分，将 Spring AI BOM 添加到您的构建文件中。

请参阅 Repositories 部分，将 Milestone 和/或 Snapshot Repositories 添加到您的构建文件中。

矢量存储实现可以为您初始化必要的架构，但您必须通过在相应的构造函数中指定布尔值或在文件中进行设置来选择加入。或者，您也可以选择退出初始化并使用 Elasticsearch 客户端手动创建索引，如果索引需要高级映射或其他配置，这可能非常有用。initializeSchema…initialize-schema=trueapplication.propertiesspring-doc.cn

这是一个突破性的变化！在早期版本的 Spring AI 中，默认情况下会进行此架构初始化。

请查看 vector store 的配置参数列表，了解默认值和配置选项。还可以通过配置 Bean 来设置这些属性。ElasticsearchVectorStoreOptionsspring-doc.cn

此外，您还需要一个已配置的 Bean。请参阅 EmbeddingModel 部分以了解更多信息。EmbeddingModelspring-doc.cn

现在，您可以在应用程序中将自动连接为矢量存储。ElasticsearchVectorStorespring-doc.cn

@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 Qdrant
vectorStore.add(documents);

// Retrieve documents similar to a query
List<Document> results = this.vectorStore.similaritySearch(SearchRequest.query("Spring").withTopK(5));

配置属性

要连接到 Elasticsearch 并使用，您需要提供实例的访问详细信息。可以通过 Spring Boot 的，ElasticsearchVectorStoreapplication.ymlspring-doc.cn

spring:
  elasticsearch:
    uris: <elasticsearch instance URIs>
    username: <elasticsearch username>
    password: <elasticsearch password>
# API key if needed, e.g. OpenAI
  ai:
    openai:
      api:
        key: <api-key>

环境变量 /spring-doc.cn

export SPRING_ELASTICSEARCH_URIS=<elasticsearch instance URIs>
export SPRING_ELASTICSEARCH_USERNAME=<elasticsearch username>
export SPRING_ELASTICSEARCH_PASSWORD=<elasticsearch password>
# API key if needed, e.g. OpenAI
export SPRING_AI_OPENAI_API_KEY=<api-key>

也可以是这些的混合。例如，如果要将密码存储为环境变量，但将其余密码保留在纯文件中。application.ymlspring-doc.cn

如果您选择创建 shell 脚本以方便将来的工作，请确保在启动应用程序之前通过“源”文件运行它，即 .source <your_script_name>.sh

Spring Boot 的 Elasticsearch RestClient 自动配置功能将创建一个 bean 实例，该实例将由 .ElasticsearchVectorStorespring-doc.cn

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

财产描述默认值

财产	描述	默认值
`spring.elasticsearch.connection-timeout`spring-doc.cn	与 Elasticsearch 通信时使用的连接超时。spring-doc.cn	`1s`spring-doc.cn
`spring.elasticsearch.password`spring-doc.cn	用于使用 Elasticsearch 进行身份验证的密码。spring-doc.cn	-spring-doc.cn
`spring.elasticsearch.username`spring-doc.cn	用于使用 Elasticsearch 进行身份验证的用户名。spring-doc.cn	-spring-doc.cn
`spring.elasticsearch.uris`spring-doc.cn	要使用的 Elasticsearch 实例的逗号分隔列表。spring-doc.cn	`localhost:9200`spring-doc.cn
`spring.elasticsearch.path-prefix`spring-doc.cn	添加到发送到 Elasticsearch 的每个请求的路径的前缀。spring-doc.cn	-spring-doc.cn
`spring.elasticsearch.restclient.sniffer.delay-after-failure`spring-doc.cn	在失败后计划的嗅探执行延迟。spring-doc.cn	`1m`spring-doc.cn
`spring.elasticsearch.restclient.sniffer.interval`spring-doc.cn	连续普通探查执行之间的间隔。spring-doc.cn	`5m`spring-doc.cn
`spring.elasticsearch.restclient.ssl.bundle`spring-doc.cn	SSL 捆绑包名称。spring-doc.cn	-spring-doc.cn
`spring.elasticsearch.socket-keep-alive`spring-doc.cn	是否开启 client 和 Elasticsearch 之间的 socket keep alive。spring-doc.cn	`false`spring-doc.cn
`spring.elasticsearch.socket-timeout`spring-doc.cn	与 Elasticsearch 通信时使用的套接字超时。spring-doc.cn	`30s`spring-doc.cn

spring.elasticsearch.connection-timeoutspring-doc.cn

与 Elasticsearch 通信时使用的连接超时。spring-doc.cn

1sspring-doc.cn

spring.elasticsearch.passwordspring-doc.cn

用于使用 Elasticsearch 进行身份验证的密码。spring-doc.cn

-spring-doc.cn

spring.elasticsearch.usernamespring-doc.cn

用于使用 Elasticsearch 进行身份验证的用户名。spring-doc.cn

-spring-doc.cn

spring.elasticsearch.urisspring-doc.cn

要使用的 Elasticsearch 实例的逗号分隔列表。spring-doc.cn

localhost:9200spring-doc.cn

spring.elasticsearch.path-prefixspring-doc.cn

添加到发送到 Elasticsearch 的每个请求的路径的前缀。spring-doc.cn

-spring-doc.cn

spring.elasticsearch.restclient.sniffer.delay-after-failurespring-doc.cn

在失败后计划的嗅探执行延迟。spring-doc.cn

1mspring-doc.cn

spring.elasticsearch.restclient.sniffer.intervalspring-doc.cn

连续普通探查执行之间的间隔。spring-doc.cn

5mspring-doc.cn

spring.elasticsearch.restclient.ssl.bundlespring-doc.cn

SSL 捆绑包名称。spring-doc.cn

-spring-doc.cn

spring.elasticsearch.socket-keep-alivespring-doc.cn

是否开启 client 和 Elasticsearch 之间的 socket keep alive。spring-doc.cn

falsespring-doc.cn

spring.elasticsearch.socket-timeoutspring-doc.cn

与 Elasticsearch 通信时使用的套接字超时。spring-doc.cn

30sspring-doc.cn

以 prefix 开头的属性用于配置。spring.ai.vectorstore.elasticsearch.*ElasticsearchVectorStorespring-doc.cn

财产描述默认值

财产	描述	默认值
`spring.ai.vectorstore.elasticsearch.initialize-schema`spring-doc.cn	是否初始化所需的 schemaspring-doc.cn	`false`spring-doc.cn
`spring.ai.vectorstore.elasticsearch.index-name`spring-doc.cn	用于存储向量的索引的名称。spring-doc.cn	spring-ai-文档索引spring-doc.cn
`spring.ai.vectorstore.elasticsearch.dimensions`spring-doc.cn	向量中的维数。spring-doc.cn	1536spring-doc.cn
`spring.ai.vectorstore.elasticsearch.similarity`spring-doc.cn	要使用的 similarity 函数。spring-doc.cn	`cosine`spring-doc.cn

spring.ai.vectorstore.elasticsearch.initialize-schemaspring-doc.cn

是否初始化所需的 schemaspring-doc.cn

falsespring-doc.cn

spring.ai.vectorstore.elasticsearch.index-namespring-doc.cn

用于存储向量的索引的名称。spring-doc.cn

spring-ai-文档索引spring-doc.cn

spring.ai.vectorstore.elasticsearch.dimensionsspring-doc.cn

向量中的维数。spring-doc.cn

1536spring-doc.cn

spring.ai.vectorstore.elasticsearch.similarityspring-doc.cn

要使用的 similarity 函数。spring-doc.cn

cosinespring-doc.cn

可以使用以下相似性函数：spring-doc.cn

余弦spring-doc.cn
l2_normspring-doc.cn
dot_productspring-doc.cn

有关每个方法的更多详细信息，请参阅有关密集向量的 Elasticsearch 文档。spring-doc.cn

元数据筛选

您也可以在 Elasticsearch 中使用通用的可移植元数据过滤器。spring-doc.cn

例如，您可以使用文本表达式语言：spring-doc.cn

vectorStore.similaritySearch(SearchRequest.defaults()
        .withQuery("The World")
        .withTopK(TOP_K)
        .withSimilarityThreshold(SIMILARITY_THRESHOLD)
        .withFilterExpression("author in ['john', 'jill'] && 'article_type' == 'blog'"));

或使用 DSL 以编程方式：Filter.Expressionspring-doc.cn

FilterExpressionBuilder b = new FilterExpressionBuilder();

vectorStore.similaritySearch(SearchRequest.defaults()
        .withQuery("The World")
        .withTopK(TOP_K)
        .withSimilarityThreshold(SIMILARITY_THRESHOLD)
        .withFilterExpression(b.and(
                b.in("john", "jill"),
                b.eq("article_type", "blog")).build()));

这些（可移植的）筛选条件表达式会自动转换为专有的 Elasticsearch Query 字符串查询。

例如，此可移植筛选条件表达式：spring-doc.cn

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

转换为专有的 Elasticsearch 过滤器格式：spring-doc.cn

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

手动配置

您可以手动配置 Elasticsearch 向量存储，而不是使用 Spring Boot 自动配置。为此，您需要将添加到您的项目中：spring-ai-elasticsearch-storespring-doc.cn

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

或您的 Gradle 构建文件。build.gradlespring-doc.cn

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

创建 Elasticsearch Bean。阅读 Elasticsearch 文档，了解有关自定义 RestClient 配置的更深入信息。RestClientspring-doc.cn

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

然后创建 Bean：ElasticsearchVectorStorespring-doc.cn

@Bean
public ElasticsearchVectorStore vectorStore(EmbeddingModel embeddingModel, RestClient restClient) {
    return new ElasticsearchVectorStore( restClient, embeddingModel);
}

// This can be any EmbeddingModel implementation.
@Bean
public EmbeddingModel embeddingModel() {
    return new OpenAiEmbeddingModel(new OpenAiApi(System.getenv("OPENAI_API_KEY")));
}