跳到主要内容

Weaviate

Deepseek 3.2 中英对照 Weaviate

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

Weaviate 是一个开源向量数据库，它允许您存储来自您喜爱的机器学习模型的数据对象和向量嵌入，并能无缝扩展到数十亿个数据对象。它提供了存储文档嵌入、内容和元数据的工具，以及搜索这些嵌入（包括元数据过滤）的功能。

先决条件​

  • 一个正在运行的 Weaviate 实例。以下选项可供选择：

  • 如果需要，获取用于生成 WeaviateVectorStore 所存储嵌入向量的 EmbeddingModel 的 API 密钥。

依赖关系​

备注

Spring AI 的自动配置和 starter 模块的 artifact 名称发生了重大变更。更多信息请参考 升级说明。

将 Weaviate 向量存储依赖项添加到你的项目中：

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

或将其添加到你的Gradle build.gradle 构建文件中。

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

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

配置​

要连接Weaviate并使用WeaviateVectorStore，您需要提供实例的访问详细信息。可以通过Spring Boot的application.properties进行配置：

spring.ai.vectorstore.weaviate.host=<host_of_your_weaviate_instance>
spring.ai.vectorstore.weaviate.scheme=<http_or_https>
spring.ai.vectorstore.weaviate.api-key=<your_api_key>
# API key if needed, e.g. OpenAI
spring.ai.openai.api-key=<api-key>

如果你倾向于使用环境变量来处理API密钥等敏感信息，有以下几种可选方案：

选项 1：使用 Spring 表达式语言 (SpEL)​

您可以使用自定义环境变量名称，并在应用程序配置中引用它们：

# In application.yml
spring:
  ai:
    vectorstore:
      weaviate:
        host: ${WEAVIATE_HOST}
        scheme: ${WEAVIATE_SCHEME}
        api-key: ${WEAVIATE_API_KEY}
    openai:
      api-key: ${OPENAI_API_KEY}
# In your environment or .env file
export WEAVIATE_HOST=<host_of_your_weaviate_instance>
export WEAVIATE_SCHEME=<http_or_https>
export WEAVIATE_API_KEY=<your_api_key>
export OPENAI_API_KEY=<api-key>

选项2：以编程方式访问环境变量​

或者，你可以在 Java 代码中访问环境变量：

String weaviateApiKey = System.getenv("WEAVIATE_API_KEY");
String openAiApiKey = System.getenv("OPENAI_API_KEY");
备注

如果你选择创建一个 Shell 脚本来管理环境变量，请确保在启动应用程序之前通过 "sourcing" 该文件来运行它，即 source <你的脚本名>.sh。

自动配置​

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

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

添加到您的 Gradle build.gradle 构建文件中。

dependencies {
    implementation 'org.springframework.ai:spring-ai-starter-vector-store-weaviate'
}

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

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

提示

参考 Artifact 仓库 部分，将 Maven Central 和/或 Snapshot 仓库添加到你的构建文件中。

此外，你需要配置一个 EmbeddingModel bean。更多信息请参考 EmbeddingModel 章节。

以下是所需bean的一个示例：

@Bean
public EmbeddingModel embeddingModel() {
    // Retrieve API key from a secure source or environment variable
    String apiKey = System.getenv("OPENAI_API_KEY");

    // Can be any other EmbeddingModel implementation
    return new OpenAiEmbeddingModel(OpenAiApi.builder().apiKey(apiKey).build());
}

现在您可以在应用程序中将 WeaviateVectorStore 自动连接为向量存储。

手动配置​

与其使用 Spring Boot 自动配置，你也可以通过构建器模式手动配置 WeaviateVectorStore：

@Bean
public WeaviateClient weaviateClient() {
    return new WeaviateClient(new Config("http", "localhost:8080"));
}

@Bean
public VectorStore vectorStore(WeaviateClient weaviateClient, EmbeddingModel embeddingModel) {
    return WeaviateVectorStore.builder(weaviateClient, embeddingModel)
        .options(options)                              // Optional: use custom options
        .consistencyLevel(ConsistentLevel.QUORUM)      // Optional: defaults to ConsistentLevel.ONE
        .filterMetadataFields(List.of(                 // Optional: fields that can be used in filters
            MetadataField.text("country"),
            MetadataField.number("year")))
        .build();
}

元数据筛选​

您可以同样利用通用的、可移植的元数据过滤器与 Weaviate 存储。

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

vectorStore.similaritySearch(
    SearchRequest.builder()
        .query("The World")
        .topK(TOP_K)
        .similarityThreshold(SIMILARITY_THRESHOLD)
        .filterExpression("country in ['UK', 'NL'] && year >= 2020").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("country", "UK", "NL"),
        b.gte("year", 2020)).build()).build());
备注

这些（可移植的）过滤表达式会自动转换为 Weaviate 专有的 where 过滤器。

例如，这个可移植的筛选表达式：

country in ['UK', 'NL'] && year >= 2020

将被转换为专有的 Weaviate GraphQL 过滤器格式：

operator: And
operands:
    [{
        operator: Or
        operands:
            [{
                path: ["meta_country"]
                operator: Equal
                valueText: "UK"
            },
            {
                path: ["meta_country"]
                operator: Equal
                valueText: "NL"
            }]
    },
    {
        path: ["meta_year"]
        operator: GreaterThanEqual
        valueNumber: 2020
    }]

在 Docker 中运行 Weaviate​

要快速开始使用本地Weaviate实例，您可以通过Docker运行它：

docker run -it --rm --name weaviate \
    -e AUTHENTICATION_ANONYMOUS_ACCESS_ENABLED=true \
    -e PERSISTENCE_DATA_PATH=/var/lib/weaviate \
    -e QUERY_DEFAULTS_LIMIT=25 \
    -e DEFAULT_VECTORIZER_MODULE=none \
    -e CLUSTER_HOSTNAME=node1 \
    -p 8080:8080 \
    semitechnologies/weaviate:1.22.4

这将启动一个可通过 localhost:8080 访问的 Weaviate 实例。

WeaviateVectorStore 属性​

您可以在 Spring Boot 配置中使用以下属性来自定义 Weaviate 向量存储。

属性描述默认值
spring.ai.vectorstore.weaviate.hostWeaviate 服务器的主机地址localhost:8080
spring.ai.vectorstore.weaviate.scheme连接模式http
spring.ai.vectorstore.weaviate.api-key用于身份验证的 API 密钥
spring.ai.vectorstore.weaviate.object-class用于存储文档的类名。SpringAiWeaviate
spring.ai.vectorstore.weaviate.content-field-name内容字段名content
spring.ai.vectorstore.weaviate.meta-field-prefix元数据字段前缀meta_
spring.ai.vectorstore.weaviate.consistency-level一致性与速度之间的期望权衡ConsistentLevel.ONE
spring.ai.vectorstore.weaviate.filter-field配置可在过滤器中使用的元数据字段。格式: spring.ai.vectorstore.weaviate.filter-field.<field-name>=<field-type>
提示

对象类名应以大写字母开头，字段名应以小写字母开头。详情请参阅 data-object-concepts

访问原生客户端​

Weaviate Vector Store 实现通过 getNativeClient() 方法提供了对底层原生 Weaviate 客户端 (WeaviateClient) 的访问：

WeaviateVectorStore vectorStore = context.getBean(WeaviateVectorStore.class);
Optional<WeaviateClient> nativeClient = vectorStore.getNativeClient();

if (nativeClient.isPresent()) {
    WeaviateClient client = nativeClient.get();
    // Use the native client for Weaviate-specific operations
}

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