OpenSearch

DeepSeek V3 中英对照 OpenSearch

本节将引导您设置 OpenSearchVectorStore 以存储文档嵌入并执行相似性搜索。

OpenSearch 是一个开源的搜索和分析引擎，最初是从 Elasticsearch 分支而来，基于 Apache 2.0 许可证分发。它通过简化 AI 生成资产的集成和管理，增强了 AI 应用程序的开发。OpenSearch 支持向量、词汇和混合搜索功能，利用先进的向量数据库功能，促进低延迟查询和相似性搜索，详细信息可参考向量数据库页面。

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

前提条件

• 一个正在运行的 OpenSearch 实例。以下选项可用：

  • 自托管的 OpenSearch

  • Amazon OpenSearch 服务

• 如果需要，为 EmbeddingModel 提供一个 API 密钥，用于生成由 OpenSearchVectorStore 存储的嵌入。

自动配置

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

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

xml

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

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

groovy

:::提示
请参考 依赖管理 部分，将 Spring AI BOM 添加到您的构建文件中。
:::

对于 Amazon OpenSearch Service，请使用以下依赖项：

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

xml

或对于 Gradle：

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

groovy

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

此外，你还需要一个配置好的 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.build().query("Spring").topK(5).build());

java

配置属性

要连接到 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
        batching-strategy: TOKEN_COUNT
        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>

yaml

以 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.batching-strategy	计算嵌入时的文档批处理策略。选项为 TOKEN_COUNT 或 FIXED_SIZE	TOKEN_COUNT
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 - 向量之间的切比雪夫距离。

手动配置

除了使用 Spring Boot 的自动配置外，你还可以手动配置 OpenSearch 向量存储。为此，你需要在项目中添加 spring-ai-opensearch-store 依赖：

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

xml

或者在你的 Gradle build.gradle 构建文件中：

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

groovy

提示

请参考 依赖管理 部分，将 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()));
}

java

然后使用构建器模式创建 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")));
}

java

元数据过滤

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

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

vectorStore.similaritySearch(
    SearchRequest.builder()
        .query("The World")
        .topK(TOP_K)
        .similarityThreshold(SIMILARITY_THRESHOLD)
        .filterExpression("author in ['john', 'jill'] && 'article_type' == 'blog'").build());

java

或者可以通过编程方式使用 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());

java

备注

这些（可移植的）过滤表达式会自动转换为专有的 OpenSearch Query string query。

例如，这个便携式过滤器表达式：

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

sql

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

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

text

访问原生客户端

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

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
}

java

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