OpenSearch

本节将引导您完成 OpenSearchVectorStore 的设置，以便存储文档嵌入并执行相似度搜索。

OpenSearch 是一个开源搜索和分析引擎，最初从 Elasticsearch 分支而来，根据 Apache License 2.0 发布。它通过简化 AI 生成资产的集成和管理，增强了 AI 应用开发。OpenSearch 支持向量、词法和混合搜索功能，利用先进的向量数据库功能来促进低延迟查询和相似度搜索，详情请参阅向量数据库页面。

OpenSearch k-NN 功能允许用户查询大型数据集中的向量嵌入。嵌入是数据对象（如文本、图像、音频或文档）的数值表示。嵌入可以存储在索引中，并使用各种相似度函数进行查询。

先决条件

自动配置

Spring AI 自动配置、starter 模块的 artifact 名称发生了重大变化。更多信息请参考升级说明。

Spring AI 为 OpenSearch 向量存储提供了 Spring Boot 自动配置。要启用它，请将以下依赖项添加到项目的 Maven pom.xml 文件中：

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

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

dependencies {
    implementation 'org.springframework.ai:spring-ai-starter-vector-store-opensearch'
}
请参阅依赖管理部分，了解如何将 Spring AI BOM 添加到您的构建文件中。

对于 Amazon OpenSearch 服务，请改用这些依赖项：

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

或对于 Gradle：

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

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

此外，您还需要配置一个 EmbeddingModel Bean。更多信息请参考嵌入模型 (EmbeddingModel) 部分。

现在，您可以在应用程序中将 OpenSearchVectorStore 作为向量存储进行自动装配：

@Autowired VectorStore vectorStore;

// ...

List<Document> documents = List.of(
    new Document("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 OpenSearch
vectorStore.add(documents);

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

配置属性

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

spring:
  ai:
    vectorstore:
      opensearch:
        uris: <opensearch instance URIs>
        username: <opensearch username>
        password: <opensearch password>
        index-name: spring-ai-document-index
        initialize-schema: true
        similarity-function: cosinesimil
        aws:  # Only for Amazon OpenSearch Service
          host: <aws opensearch host>
          service-name: <aws service name>
          access-key: <aws access key>
          secret-key: <aws secret key>
          region: <aws region>

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

属性 描述 默认值

spring.ai.vectorstore.opensearch.uris

OpenSearch 集群端点的 URI

-

spring.ai.vectorstore.opensearch.username

访问 OpenSearch 集群的用户名

-

spring.ai.vectorstore.opensearch.password

指定用户名的密码

-

spring.ai.vectorstore.opensearch.index-name

存储向量的索引名称

spring-ai-document-index

spring.ai.vectorstore.opensearch.initialize-schema

是否初始化所需模式

false

spring.ai.vectorstore.opensearch.similarity-function

要使用的相似度函数

cosinesimil

spring.ai.vectorstore.opensearch.aws.host

OpenSearch 实例的主机名

-

spring.ai.vectorstore.opensearch.aws.service-name

AWS 服务名称

-

spring.ai.vectorstore.opensearch.aws.access-key

AWS 访问密钥

-

spring.ai.vectorstore.opensearch.aws.secret-key

AWS 秘密密钥

-

spring.ai.vectorstore.opensearch.aws.region

AWS 区域

-

以下相似度函数可用：

  • cosinesimil - 默认值，适用于大多数用例。衡量向量之间的余弦相似度。

  • l1 - 向量之间的曼哈顿距离。

  • l2 - 向量之间的欧几里得距离。

  • linf - 向量之间的切比雪夫距离。

手动配置

您也可以手动配置 OpenSearch 向量存储，而不是使用 Spring Boot 自动配置。为此，您需要将 spring-ai-opensearch-store 添加到您的项目中：

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

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

dependencies {
    implementation 'org.springframework.ai:spring-ai-opensearch-store'
}
请参阅依赖管理部分，了解如何将 Spring AI BOM 添加到您的构建文件中。

创建 OpenSearch 客户端 Bean：

@Bean
public OpenSearchClient openSearchClient() {
    RestClient restClient = RestClient.builder(
        HttpHost.create("http://localhost:9200"))
        .build();

    return new OpenSearchClient(new RestClientTransport(
        restClient, new JacksonJsonpMapper()));
}

然后使用 Builder 模式创建 OpenSearchVectorStore Bean：

@Bean
public VectorStore vectorStore(OpenSearchClient openSearchClient, EmbeddingModel embeddingModel) {
    return OpenSearchVectorStore.builder(openSearchClient, embeddingModel)
        .index("custom-index")                // Optional: defaults to "spring-ai-document-index"
        .similarityFunction("l2")             // Optional: defaults to "cosinesimil"
        .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")));
}

元数据过滤

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

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

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());
这些（可移植的）过滤器表达式会自动转换为 OpenSearch 专有的查询字符串查询。

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

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

被转换为 OpenSearch 专有的过滤器格式：

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

_json_filter({"bool":{"must":[{"term":{"metadata.document_id":"doc1"}}]}})

访问原生客户端

OpenSearchVectorStore vectorStore = context.getBean(OpenSearchVectorStore.class);
Optional<OpenSearchClient> nativeClient = vectorStore.getNativeClient();

if (nativeClient.isPresent()) {
    OpenSearchClient client = nativeClient.get();
    // Use the native client for OpenSearch-specific operations
}

OpenSearch 向量存储实现通过 getNativeClient() 方法提供了对底层原生 OpenSearch 客户端 (OpenSearchClient) 的访问：