Elasticsearch

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

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

先决条件

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

自动配置

Spring AI 为 Elasticsearch Vector Store 提供 Spring Boot 自动配置。要启用它，请将以下依赖项添加到项目的 Maven pom.xml 文件中

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

或添加到您的 Gradle build.gradle 构建文件中。

dependencies {
    implementation 'org.springframework.ai:spring-ai-elasticsearch-store-spring-boot-starter'
}
请参阅 依赖项管理 部分，将 Spring AI BOM 添加到您的构建文件中。
请参阅 存储库 部分，将里程碑和/或快照存储库添加到您的构建文件中。

向量存储实现可以为您初始化必要的模式，但您必须通过在适当的构造函数中指定 initializeSchema 布尔值或在 application.properties 文件中设置 …​initialize-schema=true 来选择加入。

这是一个重大更改！在早期版本的 Spring AI 中，此模式初始化默认情况下会发生。

请查看 配置参数 列表，了解向量存储的默认值和配置选项。

此外，您还需要一个配置好的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 Qdrant
vectorStore.add(documents);

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

配置属性

要连接到 Elasticsearch 并使用ElasticsearchVectorStore，您需要提供实例的访问详细信息。可以通过 Spring Boot 的application.yml提供简单的配置，

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>

环境变量，

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.yml文件中。

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

Spring Boot 的 Elasticsearch RestClient 自动配置功能将创建一个 bean 实例，该实例将被ElasticsearchVectorStore使用。

以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 捆绑包名称。

-

spring.elasticsearch.socket-keep-alive

是否启用客户端和 Elasticsearch 之间的套接字保持活动状态。

false

spring.elasticsearch.socket-timeout

与 Elasticsearch 通信时使用的套接字超时时间。

30s

以spring.ai.vectorstore.elasticsearch.*为前缀的属性用于配置ElasticsearchVectorStore。

属性 描述 默认值

spring.ai.vectorstore.elasticsearch.index-name

存储向量的索引名称。

spring-ai-document-index

spring.ai.vectorstore.elasticsearch.dimensions

向量中的维度数。

1536

spring.ai.vectorstore.elasticsearch.dense-vector-indexing

是否使用密集向量索引。

true

spring.ai.vectorstore.elasticsearch.similarity

要使用的相似度函数。

cosine

spring.ai.vectorstore.elasticsearch.initialize-schema

是否初始化所需的模式

false

元数据过滤

您也可以利用通用的、可移植的 元数据过滤器 与 Elasticsearch 一起使用。

例如，您可以使用文本表达式语言

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

或使用 Filter.Expression DSL 以编程方式使用

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

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

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() {
    RestClientBuilder builder = RestClient.builder(new HttpHost("<host>", 9200, "http"));
    Header[] defaultHeaders = new Header[] { new BasicHeader("Authorization", "Basic <encoded username and password>") };
    builder.setDefaultHeaders(defaultHeaders);
    return builder.build();
}

然后创建 ElasticsearchVectorStore bean

@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")));
}