|
此版本仍在开发中，尚未被视为稳定版。如需最新的快照版本，请使用 Spring AI 1.1.3！ |
Weaviate
本节将引导您完成设置 Weaviate VectorStore 以存储文档嵌入并执行相似性搜索的过程。
Weaviate 是一个开源的向量数据库，允许您存储来自您喜爱的机器学习模型的数据对象和向量嵌入，并能够无缝扩展到数十亿个数据对象。 它提供了存储文档嵌入、内容和元数据的工具，以及搜索这些嵌入（包括元数据过滤）的功能。
前置条件
-
一个正在运行的 Weaviate 实例。以下是可用的选项：
-
Weaviate 云服务（需要创建账户和 API 密钥）
-
-
如果需要，为EmbeddingModel提供一个API密钥，用于生成由
WeaviateVectorStore存储的嵌入向量。
依赖项
|
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>Auto-configuration
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添加到您的构建文件中。 |
请查看 向量存储的配置参数 列表，以了解默认值和配置选项。
| 请参阅 构件仓库 部分，将 Maven 中央仓库和/或快照仓库添加到您的构建文件中。 |
此外，您还需要一个已配置的 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这将启动一个 Weaviate 实例，可通过 localhost:8080 访问。
WeaviateVectorStore 属性
您可以在 Spring Boot 配置中使用以下属性来自定义 Weaviate 向量存储。
| <property> </property> | <description> </description> | 默认值 |
|---|---|---|
|
Weaviate 服务器的主机 |
localhost:8080 |
|
连接模式 |
HTTP |
|
用于身份验证的 API 密钥 |
|
|
用于存储文档的类名。 |
SpringAiWeaviate |
|
The field name for content |
内容 |
|
元数据字段前缀 |
meta_ |
|
一致性和速度之间的理想权衡 |
ConsistentLevel.ONE |
|
配置可在过滤器中使用的元数据字段。格式：spring.ai.vectorstore.weaviate.filter-field.<field-name>=<field-type> |
| 对象类名应以大写字母开头，字段名应以小写字母开头。 参见 data-object-concepts |
访问原生客户端
Weaviate 向量存储实现通过 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
}原生客户端使您能够访问 Weaviate 特有的功能和操作，这些功能和操作可能无法通过 VectorStore 接口暴露。