如需最新的快照版本,请使用 Spring AI 1.1.3spring-doc.cadn.net.cn

OpenSearch

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

OpenSearch 是一个开源搜索和分析引擎,最初是从 Elasticsearch 分支出来的,采用 Apache License 2.0 许可证发布。它通过简化和集成人工智能生成资产的管理,增强了人工智能应用开发。OpenSearch 支持向量、词汇和混合搜索功能,利用先进的向量数据库功能来促进低延迟查询和相似性搜索,详情请参阅 向量数据库页面spring-doc.cadn.net.cn

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

前置条件

Auto-configuration

Spring AI自动配置和starter模块的artifact名称有了重大变化。 请参阅升级说明获取更多信息。spring-doc.cadn.net.cn

Spring AI 为 OpenSearch 向量存储提供了 Spring Boot 自动配置。 要启用它,请将以下依赖项添加到您项目的 Maven pom.xml 文件中:spring-doc.cadn.net.cn

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

或添加到您的 Gradle build.gradle 构建文件中:spring-doc.cadn.net.cn

dependencies {
    implementation 'org.springframework.ai:spring-ai-starter-vector-store-opensearch'
}
对于自托管和 Amazon OpenSearch Service,使用相同的依赖项。 请参阅 依赖管理 部分,将 Spring AI BOM 添加到您的构建文件中。

请查看 向量存储的配置参数 列表,以了解默认值和配置选项。spring-doc.cadn.net.cn

此外,您还需要一个已配置的 EmbeddingModel bean。有关更多信息,请参阅 EmbeddingModel 部分。spring-doc.cadn.net.cn

现在您可以在应用程序中将 OpenSearchVectorStore 自动装配为向量存储:spring-doc.cadn.net.cn

@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-doc.cadn.net.cn

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
        read-timeout: <time to wait for response>
        connect-timeout: <time to wait until connection established>
        path-prefix: <custom path prefix>
        ssl-bundle: <name of SSL bundle>
        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.* 开头的属性用于配置 OpenSearchVectorStorespring-doc.cadn.net.cn

<property> </property> <description> </description> 默认值

spring.ai.vectorstore.opensearch.urisspring-doc.cadn.net.cn

OpenSearch 集群端点的 URIspring-doc.cadn.net.cn

-spring-doc.cadn.net.cn

spring.ai.vectorstore.opensearch.usernamespring-doc.cadn.net.cn

用于访问 OpenSearch 集群的用户名spring-doc.cadn.net.cn

-spring-doc.cadn.net.cn

spring.ai.vectorstore.opensearch.passwordspring-doc.cadn.net.cn

指定用户名的密码spring-doc.cadn.net.cn

-spring-doc.cadn.net.cn

spring.ai.vectorstore.opensearch.index-namespring-doc.cadn.net.cn

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

spring-ai-document-indexspring-doc.cadn.net.cn

spring.ai.vectorstore.opensearch.initialize-schemaspring-doc.cadn.net.cn

是否初始化所需的模式spring-doc.cadn.net.cn

falsespring-doc.cadn.net.cn

spring.ai.vectorstore.opensearch.similarity-functionspring-doc.cadn.net.cn

要使用的相似度函数spring-doc.cadn.net.cn

cosinesimilspring-doc.cadn.net.cn

spring.ai.vectorstore.opensearch.read-timeoutspring-doc.cadn.net.cn

等待来自对端响应的时间。0 - 无穷大。spring-doc.cadn.net.cn

-spring-doc.cadn.net.cn

spring.ai.vectorstore.opensearch.connect-timeoutspring-doc.cadn.net.cn

建立连接前需要等待的时间。0 - 无穷大。spring-doc.cadn.net.cn

-spring-doc.cadn.net.cn

spring.ai.vectorstore.opensearch.path-prefixspring-doc.cadn.net.cn

OpenSearch API 端点的路径前缀。当 OpenSearch 位于具有非根路径的反向代理之后时,此选项非常有用。spring-doc.cadn.net.cn

-spring-doc.cadn.net.cn

spring.ai.vectorstore.opensearch.ssl-bundlespring-doc.cadn.net.cn

SSL 连接时要使用的 SSL Bundle 的名称spring-doc.cadn.net.cn

-spring-doc.cadn.net.cn

spring.ai.vectorstore.opensearch.aws.hostspring-doc.cadn.net.cn

OpenSearch 实例的主机名spring-doc.cadn.net.cn

-spring-doc.cadn.net.cn

spring.ai.vectorstore.opensearch.aws.service-namespring-doc.cadn.net.cn

AWS 服务名称spring-doc.cadn.net.cn

-spring-doc.cadn.net.cn

spring.ai.vectorstore.opensearch.aws.access-keyspring-doc.cadn.net.cn

AWS访问密钥spring-doc.cadn.net.cn

-spring-doc.cadn.net.cn

spring.ai.vectorstore.opensearch.aws.secret-keyspring-doc.cadn.net.cn

AWS密钥spring-doc.cadn.net.cn

-spring-doc.cadn.net.cn

spring.ai.vectorstore.opensearch.aws.regionspring-doc.cadn.net.cn

AWS 区域spring-doc.cadn.net.cn

-spring-doc.cadn.net.cn

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

  • 如果此属性设置为 false,则激活非 AWS OpenSearch 配置,即使 AWS SDK 类存在于类路径上。这允许您在存在其他服务的 AWS SDK 的环境中使用自托管或第三方 OpenSearch 集群。spring-doc.cadn.net.cn

  • 如果 AWS SDK 类不存在,则始终使用非 AWS 配置。spring-doc.cadn.net.cn

  • 如果存在 AWS SDK 类且该属性未设置或设置为 true,则默认使用 AWS 特定的配置。spring-doc.cadn.net.cn

这种回退逻辑确保用户对 OpenSearch 集成的类型拥有明确的控制权,防止在不需要时意外激活 AWS 特定的逻辑。spring-doc.cadn.net.cn

path-prefix 属性允许您在 OpenSearch 运行在使用非根路径的反向代理后面时指定自定义路径前缀。 例如,如果您的 OpenSearch 实例可以通过 example.com/opensearch/ 而不是 example.com/ 访问,您需要设置 path-prefix: /opensearchspring-doc.cadn.net.cn

以下相似性函数可用:spring-doc.cadn.net.cn

手动配置

不使用 Spring Boot 自动配置,您可以手动配置 OpenSearch 向量存储。为此,您需要将 spring-ai-opensearch-store 添加到您的项目中:spring-doc.cadn.net.cn

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

或添加到您的 Gradle build.gradle 构建文件中:spring-doc.cadn.net.cn

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

创建一个 OpenSearch 客户端 bean:spring-doc.cadn.net.cn

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

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

然后使用构建器模式创建 OpenSearchVectorStore bean:spring-doc.cadn.net.cn

@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 一起使用。spring-doc.cadn.net.cn

例如,您可以使用文本表达式语言:spring-doc.cadn.net.cn

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:spring-doc.cadn.net.cn

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 Query string query

例如,此可移植的过滤器表达式:spring-doc.cadn.net.cn

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

被转换为专有的 OpenSearch 过滤器格式:spring-doc.cadn.net.cn

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

访问原生客户端

OpenSearch 向量存储实现通过 getNativeClient() 方法提供对底层原生 OpenSearch 客户端(OpenSearchClient)的访问:spring-doc.cadn.net.cn

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 特有的功能和操作,这些功能和操作可能无法通过 VectorStore 接口暴露。spring-doc.cadn.net.cn