开放搜索

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

OpenSearch 是一个开源搜索和分析引擎，最初是从 Elasticsearch 分叉而来的，在 Apache License 2.0 下分发。它通过简化 AI 生成资产的集成和管理来增强 AI 应用程序开发。OpenSearch 支持向量、词法和混合搜索功能，利用高级向量数据库功能来促进低延迟查询和相似性搜索，如向量数据库页面上详述的那样。该平台非常适合构建可扩展的 AI 驱动型应用程序，并为数据管理、容错和资源访问控制提供强大的工具。spring-doc.cn

先决条件

依赖

将 OpenSearch Vector Store 依赖项添加到您的项目中：spring-doc.cn

<dependency>
    <groupId>org.springframework.ai</groupId>
    <artifactId>spring-ai-opensearch-store</artifactId>
</dependency>
dependencies {
    implementation 'org.springframework.ai:spring-ai-opensearch-store'
}
请参阅 Dependency Management 部分，将 Spring AI BOM 添加到您的构建文件中。

配置

要连接到 OpenSearch 并使用 ，您需要提供实例的访问详细信息。 可以通过 Spring Boot 的 ，OpenSearchVectorStoreapplication.ymlspring-doc.cn

spring:
  ai:
    vectorstore:
      opensearch:
        uris: <opensearch instance URIs>
        username: <opensearch username>
        password: <opensearch password>
        indexName: <opensearch index name>
        mappingJson: <JSON mapping for opensearch index>
        aws:
          host: <aws opensearch host>
          serviceName: <aws service name>
          accessKey: <aws access key>
          secretKey: <aws secret key>
          region: <aws region>
# API key if needed, e.g. OpenAI
    openai:
      apiKey: <api-key>
检查配置参数列表以了解默认值和配置选项。

自动配置

自我管理的 OpenSearch

Spring AI 为 OpenSearch Vector Store 提供 Spring Boot 自动配置。 要启用它，请将以下依赖项添加到项目的 Maven 或 Gradle 构建文件中：pom.xmlbuild.gradlespring-doc.cn

<dependency>
    <groupId>org.springframework.ai</groupId>
    <artifactId>spring-ai-opensearch-store-spring-boot-starter</artifactId>
</dependency>
dependencies {
    implementation 'org.springframework.ai:spring-ai-opensearch-store-spring-boot-starter'
}

然后使用属性配置与自行管理的 OpenSearch 实例的连接。spring.ai.vectorstore.opensearch.*spring-doc.cn

Amazon OpenSearch 服务

要启用 Amazon OpenSearch Service，请将以下依赖项添加到项目的 Maven 或 Gradle 构建文件中：pom.xmlbuild.gradlespring-doc.cn

<dependency>
    <groupId>org.springframework.ai</groupId>
    <artifactId>spring-ai-aws-opensearch-store-spring-boot-starter</artifactId>
</dependency>
dependencies {
    implementation 'org.springframework.ai:spring-ai-aws-opensearch-store-spring-boot-starter'
}

然后使用属性配置与 Amazon OpenSearch Service 的连接。spring.ai.vectorstore.opensearch.aws.*spring-doc.cn

请参阅 Dependency Management 部分，将 Spring AI BOM 添加到您的构建文件中。

以下是所需 bean 的示例：spring-doc.cn

@Bean
public EmbeddingModel embeddingModel() {
    // Can be any other EmbeddingModel implementation
    return new OpenAiEmbeddingModel(new OpenAiApi(System.getenv("SPRING_AI_OPENAI_API_KEY")));
}

现在，您可以在应用程序中将 自动连接为矢量存储。OpenSearchVectorStorespring-doc.cn

@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 OpenSearch
vectorStore.add(List.of(document));

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

配置属性

您可以在 Spring Boot 配置中使用以下属性来自定义 OpenSearch 矢量存储。spring-doc.cn

财产 描述 默认值

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

OpenSearch 集群终端节点的 URI。spring-doc.cn

-spring-doc.cn

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

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

-spring-doc.cn

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

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

-spring-doc.cn

spring.ai.vectorstore.opensearch.indexNamespring-doc.cn

要在 OpenSearch 集群中使用的默认索引的名称。spring-doc.cn

spring-ai-document-indexspring-doc.cn

spring.ai.vectorstore.opensearch.mappingJsonspring-doc.cn

定义索引映射的 JSON 字符串;指定文档及其 字段被存储和索引。有关一些示例配置，请参阅此处spring-doc.cn

{ “属性”：{ “嵌入”：{ “type”：“knn_vector”， “dimension”：1536 } } }spring-doc.cn

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

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

-spring-doc.cn

spring.ai.vectorstore.opensearch.aws.serviceNamespring-doc.cn

OpenSearch 实例的 AWS 服务名称。spring-doc.cn

-spring-doc.cn

spring.ai.vectorstore.opensearch.aws.accessKeyspring-doc.cn

OpenSearch 实例的 AWS 访问密钥。spring-doc.cn

-spring-doc.cn

spring.ai.vectorstore.opensearch.aws.secretKeyspring-doc.cn

OpenSearch 实例的 AWS 密钥。spring-doc.cn

-spring-doc.cn

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

OpenSearch 实例的 AWS 区域。spring-doc.cn

-spring-doc.cn

自定义 OpenSearch 客户端配置

如果 Spring Boot 自动配置的 OpenSearchClient 与 bean 不是 您想要或需要，您仍然可以定义自己的 bean。 请阅读 OpenSearch Java 客户端文档Apache HttpClient 5 Transportspring-doc.cn

元数据筛选

您还可以将通用的可移植元数据筛选器与 OpenSearch 结合使用。spring-doc.cn

例如，您可以使用文本表达式语言：spring-doc.cn

vectorStore.similaritySearch(SearchRequest.defaults()
        .withQuery("The World")
        .withTopK(TOP_K)
        .withSimilarityThreshold(SIMILARITY_THRESHOLD)
        .withFilterExpression("author in ['john', 'jill'] && 'article_type' == 'blog'"));
FilterExpressionBuilder b = new FilterExpressionBuilder();

vectorStore.similaritySearch(SearchRequest.defaults()
        .withQuery("The World")
        .withTopK(TOP_K)
        .withSimilarityThreshold(SIMILARITY_THRESHOLD)
        .withFilterExpression(b.and(
                b.in("john", "jill"),
                b.eq("article_type", "blog")).build()));
这些（可移植的）筛选表达式会自动转换为专有的 OpenSearch 查询字符串查询。

例如，此可移植筛选条件表达式：spring-doc.cn

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

转换为专有的 OpenSearch 筛选条件格式：spring-doc.cn

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