Elasticsearch

Elasticsearch

本节将引导您完成设置 Elasticsearch 向量存储库，以存储文档嵌入并执行相似性搜索。

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

先决条件

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

• Docker
• 自托管 Elasticsearch
• Elastic 云服务

自动配置

Spring AI 的自动配置及 starter 模块的工件名称发生了重大变更。 更多详情，请参阅 升级说明 。

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

向量存储实现可以为您初始化所需的模式，但您必须通过在适当的构造函数中指定 initializeSchema 布尔值，或在 application.properties 文件中设置 initialize-schema=true 来选择启用。或者，您可以选择不进行初始化，而是使用 Elasticsearch 客户端手动创建索引，这在索引需要高级映射或额外配置时非常有用。

请查阅 配置参数 列表，了解向量存储的默认值及配置选项。 这些属性也可以通过配置 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 Boot 中以 spring.elasticsearch.* 开头的属性用于配置 Elasticsearch 客户端：

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

关于每种方法的更多详情，请参阅 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
}

原生客户端为您提供了访问 Elasticsearch 特定功能和操作的途径，这些可能未通过 VectorStore 接口公开。

Couchbase