OpenSearch

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

OpenSearch 是一个开源搜索和分析引擎,最初是从 Elasticsearch 分叉而来的,在 Apache 许可证 2.0 下分发。它通过简化人工智能生成资产的集成和管理来增强人工智能应用程序开发。OpenSearch 支持向量、词法和混合搜索功能,利用高级向量数据库功能来促进低延迟查询和相似性搜索,如向量数据库页面上所述。spring-doc.cadn.net.cn

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

前提条件

自动配置

Spring AI 自动配置、入门模块的工件名称发生了重大变化。 有关更多信息,请参阅升级说明spring-doc.cadn.net.cn

Spring AI 为 OpenSearch Vector Store 提供 Spring Boot 自动配置。 要启用它,请将以下依赖项添加到项目的 Mavenpom.xml文件:spring-doc.cadn.net.cn

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

或 Gradlebuild.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豆。有关详细信息,请参阅 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.*用于配置OpenSearchVectorStore:spring-doc.cadn.net.cn

属性 描述 默认值

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 捆绑包的名称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财产。spring-doc.cadn.net.cn

  • 如果此属性设置为false,则非 AWS OpenSearch 配置将被激活,即使类路径上存在 AWS SDK 类也是如此。这允许您在存在 AWS 开发工具包的环境中使用自我管理或第三方 OpenSearch 集群来提供其他服务。spring-doc.cadn.net.cn

  • 如果 AWS 开发工具包类不存在,则始终使用非 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: /opensearch.spring-doc.cadn.net.cn

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

手动配置

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

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

或 Gradlebuild.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()));
}

然后创建OpenSearchVectorStorebean 使用构建器模式: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.ExpressionDSL: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 查询字符串查询

例如,这个可移植过滤器表达式: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 向量存储实现提供对底层原生 OpenSearch 客户端 (OpenSearchClient) 通过getNativeClient()方法: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