OpenSearch

本节将指导您如何设置 OpenSearchVectorStore 来存储文档嵌入并执行相似性搜索。

OpenSearch 是一个开源的搜索和分析引擎，最初是从 Elasticsearch 分叉而来，在 Apache License 2.0 下分发。它通过简化 AI 生成资产的集成和管理来增强 AI 应用程序开发。OpenSearch 支持向量、词汇和混合搜索功能，利用先进的向量数据库功能来促进低延迟查询和相似性搜索，如 向量数据库页面 所述。

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

前提条件

自动配置

Spring AI 的自动配置和启动器模块的构件名称发生了重大变化。 请参阅 升级说明 了解更多信息。

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 Service，请使用以下依赖项：

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

// 将文档添加到 OpenSearch
vectorStore.add(documents);

// 检索与查询相似的文档
List<Document> results = vectorStore.similaritySearch(SearchRequest.builder().query("Spring").topK(5).build());

配置属性

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

spring:
  ai:
    vectorstore:
      opensearch:
        uris: <opensearch 实例 URIs>
        username: <opensearch 用户名>
        password: <opensearch 密码>
        index-name: spring-ai-document-index
        initialize-schema: true
        similarity-function: cosinesimil
        read-timeout: <等待响应的时间>
        connect-timeout: <等待建立连接的时间>
        path-prefix: <自定义路径前缀>
        ssl-bundle: <SSL 包的名称>
        aws:  # 仅适用于 Amazon OpenSearch Service
          host: <aws opensearch 主机>
          service-name: <aws 服务名称>
          access-key: <aws 访问密钥>
          secret-key: <aws 密钥>
          region: <aws 区域>

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

属性 描述 默认值

spring.ai.vectorstore.opensearch.uris

OpenSearch 集群端点的 URIs

-

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.read-timeout

等待对端响应的超时时间。0 - 无限。

-

spring.ai.vectorstore.opensearch.connect-timeout

等待建立连接的超时时间。0 - 无限。

-

spring.ai.vectorstore.opensearch.path-prefix

OpenSearch API 端点的路径前缀。当 OpenSearch 在具有非根路径的反向代理后面时很有用。

-

spring.ai.vectorstore.opensearch.ssl-bundle

在 SSL 连接情况下使用的 SSL 包名称

-

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 区域

-

您可以使用 spring.ai.vectorstore.opensearch.aws.enabled 属性控制是否启用 AWS 特定的 OpenSearch 自动配置。

  • 如果此属性设置为 false，即使类路径上存在 AWS SDK 类，也会激活非 AWS OpenSearch 配置。这允许您在其他服务需要 AWS SDK 的环境中使用自托管或第三方 OpenSearch 集群。

  • 如果不存在 AWS SDK 类，则始终使用非 AWS 配置。

  • 如果存在 AWS SDK 类且未设置该属性或设置为 true，则默认使用 AWS 特定配置。

这种回退逻辑确保用户对 OpenSearch 集成类型有明确的控制，防止在不需要时意外激活 AWS 特定逻辑。

path-prefix 属性允许您在 OpenSearch 在具有非根路径的反向代理后面运行时指定自定义路径前缀。 例如，如果您的 OpenSearch 实例可通过 example.com/opensearch/ 而不是 example.com/ 访问，您将设置 path-prefix: /opensearch。

以下相似性函数可用：

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

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

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

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

手动配置

除了使用 Spring Boot 自动配置外，您还可以手动配置 OpenSearch 向量存储。为此，您需要将 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()));
}

然后使用构建器模式创建 OpenSearchVectorStore bean：

@Bean
public VectorStore vectorStore(OpenSearchClient openSearchClient, EmbeddingModel embeddingModel) {
    return OpenSearchVectorStore.builder(openSearchClient, embeddingModel)
        .index("custom-index")                // 可选：默认为 "spring-ai-document-index"
        .similarityFunction("l2")             // 可选：默认为 "cosinesimil"
        .initializeSchema(true)               // 可选：默认为 false
        .batchingStrategy(new TokenCountBatchingStrategy()) // 可选：默认为 TokenCountBatchingStrategy
        .build();
}

// 这可以是任何 EmbeddingModel 实现
@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

访问原生客户端

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

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

if (nativeClient.isPresent()) {
    OpenSearchClient client = nativeClient.get();
    // 使用原生客户端进行 OpenSearch 特定的操作
}

原生客户端让您可以访问可能未通过 VectorStore 接口暴露的 OpenSearch 特定功能和操作。