Add Weaviate Vector Store

pom.xml

@@ -35,6 +35,7 @@
 		<module>vector-stores/spring-ai-pinecone</module>
 		<module>vector-stores/spring-ai-chroma</module>
 		<module>vector-stores/spring-ai-azure</module>
+		<module>vector-stores/spring-ai-weaviate</module>
 
 	</modules>
 
@@ -96,6 +97,7 @@
 		<protobuf-java-util.version>3.24.4</protobuf-java-util.version>
 		<fastjson.version>2.0.42</fastjson.version>
 		<azure-search.version>11.6.0</azure-search.version>
+		<weaviate-client.version>4.4.1</weaviate-client.version>
 
 		<!-- testing dependecies -->
 		<testcontainers.version>1.19.0</testcontainers.version>

spring-ai-spring-boot-autoconfigure/pom.xml

@@ -117,6 +117,14 @@
 			<optional>true</optional>
 		</dependency>
 
+		<!-- Weaviate Vector Store -->
+		<dependency>
+			<groupId>org.springframework.experimental.ai</groupId>
+			<artifactId>spring-ai-weaviate-store</artifactId>
+			<version>${project.parent.version}</version>
+			<optional>true</optional>
+		</dependency>
+
 
 		<dependency>
 			<groupId>org.springframework.boot</groupId>

spring-ai-spring-boot-autoconfigure/src/main/java/org/springframework/ai/autoconfigure/vectorstore/weaviate/WeaviateVectorStoreAutoConfiguration.java

@@ -0,0 +1,58 @@
+/*
+ * Copyright 2023-2023 the original author or authors.
+ *
+ * Licensed under the Apache License, Version 2.0 (the "License");
+ * you may not use this file except in compliance with the License.
+ * You may obtain a copy of the License at
+ *
+ *      https://www.apache.org/licenses/LICENSE-2.0
+ *
+ * Unless required by applicable law or agreed to in writing, software
+ * distributed under the License is distributed on an "AS IS" BASIS,
+ * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+ * See the License for the specific language governing permissions and
+ * limitations under the License.
+ */
+
+package org.springframework.ai.autoconfigure.vectorstore.weaviate;
+
+import org.springframework.ai.embedding.EmbeddingClient;
+import org.springframework.ai.vectorstore.VectorStore;
+import org.springframework.ai.vectorstore.WeaviateVectorStore;
+import org.springframework.ai.vectorstore.WeaviateVectorStore.WeaviateVectorStoreConfig;
+import org.springframework.ai.vectorstore.WeaviateVectorStore.WeaviateVectorStoreConfig.MetadataField;
+import org.springframework.boot.autoconfigure.AutoConfiguration;
+import org.springframework.boot.autoconfigure.condition.ConditionalOnClass;
+import org.springframework.boot.autoconfigure.condition.ConditionalOnMissingBean;
+import org.springframework.boot.context.properties.EnableConfigurationProperties;
+import org.springframework.context.annotation.Bean;
+
+/**
+ * @author Christian Tzolov
+ */
+@AutoConfiguration
+@ConditionalOnClass({ EmbeddingClient.class, WeaviateVectorStore.class })
+@EnableConfigurationProperties({ WeaviateVectorStoreProperties.class })
+public class WeaviateVectorStoreAutoConfiguration {
+
+	@Bean
+	@ConditionalOnMissingBean
+	public VectorStore vectorStore(EmbeddingClient embeddingClient, WeaviateVectorStoreProperties properties) {
+
+		WeaviateVectorStoreConfig.Builder configBuilder = WeaviateVectorStore.WeaviateVectorStoreConfig.builder()
+			.withScheme(properties.getScheme())
+			.withApiKey(properties.getApiKey())
+			.withHost(properties.getHost())
+			.withHeaders(properties.getHeaders())
+			.withObjectClass(properties.getObjectClass())
+			.withFilterableMetadataFields(properties.getFilterField()
+				.entrySet()
+				.stream()
+				.map(e -> new MetadataField(e.getKey(), e.getValue()))
+				.toList())
+			.withConsistencyLevel(properties.getConsistencyLevel());
+
+		return new WeaviateVectorStore(configBuilder.build(), embeddingClient);
+	}
+
+}

spring-ai-spring-boot-autoconfigure/src/main/java/org/springframework/ai/autoconfigure/vectorstore/weaviate/WeaviateVectorStoreProperties.java

@@ -0,0 +1,107 @@
+/*
+ * Copyright 2023-2023 the original author or authors.
+ *
+ * Licensed under the Apache License, Version 2.0 (the "License");
+ * you may not use this file except in compliance with the License.
+ * You may obtain a copy of the License at
+ *
+ *      https://www.apache.org/licenses/LICENSE-2.0
+ *
+ * Unless required by applicable law or agreed to in writing, software
+ * distributed under the License is distributed on an "AS IS" BASIS,
+ * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+ * See the License for the specific language governing permissions and
+ * limitations under the License.
+ */
+
+package org.springframework.ai.autoconfigure.vectorstore.weaviate;
+
+import java.util.Map;
+
+import org.springframework.ai.vectorstore.WeaviateVectorStore.WeaviateVectorStoreConfig;
+import org.springframework.ai.vectorstore.WeaviateVectorStore.WeaviateVectorStoreConfig.ConsistentLevel;
+import org.springframework.ai.vectorstore.WeaviateVectorStore.WeaviateVectorStoreConfig.MetadataField;
+import org.springframework.boot.context.properties.ConfigurationProperties;
+
+/**
+ * @author Christian Tzolov
+ */
+@ConfigurationProperties(WeaviateVectorStoreProperties.CONFIG_PREFIX)
+public class WeaviateVectorStoreProperties {
+
+	public static final String CONFIG_PREFIX = "spring.ai.vectorstore.weaviate";
+
+	private String scheme = "http";
+
+	private String host = "localhost:8080";
+
+	private String apiKey = "";
+
+	private String objectClass = "SpringAiWeaviate";
+
+	private ConsistentLevel consistencyLevel = WeaviateVectorStoreConfig.ConsistentLevel.ONE;
+
+	/**
+	 * spring.ai.vectorstore.weaviate.filter-field.<field-name>=<field-type>
+	 */
+	private Map<String, MetadataField.Type> filterField = Map.of();
+
+	private Map<String, String> headers = Map.of();
+
+	public void setScheme(String scheme) {
+		this.scheme = scheme;
+	}
+
+	public String getScheme() {
+		return scheme;
+	}
+
+	public void setHost(String host) {
+		this.host = host;
+	}
+
+	public String getHost() {
+		return host;
+	}
+
+	public String getApiKey() {
+		return apiKey;
+	}
+
+	public void setApiKey(String apiKey) {
+		this.apiKey = apiKey;
+	}
+
+	public String getObjectClass() {
+		return objectClass;
+	}
+
+	public void setObjectClass(String indexName) {
+		this.objectClass = indexName;
+	}
+
+	public ConsistentLevel getConsistencyLevel() {
+		return consistencyLevel;
+	}
+
+	public void setConsistencyLevel(ConsistentLevel consistencyLevel) {
+		this.consistencyLevel = consistencyLevel;
+	}
+
+	public Map<String, String> getHeaders() {
+		return headers;
+	}
+
+	public void setHeaders(Map<String, String> headers) {
+		this.headers = headers;
+	}
+
+	public Map<String, MetadataField.Type> getFilterField() {
+		return filterField;
+	}
+
+	public void setFilterField(Map<String, MetadataField.Type> filterMetadataFields) {
+		this.filterField = filterMetadataFields;
+	}
+
+}

spring-ai-spring-boot-autoconfigure/src/main/resources/META-INF/spring/org.springframework.boot.autoconfigure.AutoConfiguration.imports

@@ -8,3 +8,4 @@ org.springframework.ai.autoconfigure.embedding.transformer.TransformersEmbedding
 org.springframework.ai.autoconfigure.huggingface.HuggingfaceAutoConfiguration
 org.springframework.ai.autoconfigure.vectorstore.chroma.ChromaVectorStoreAutoConfiguration
 org.springframework.ai.autoconfigure.vectorstore.azure.AzureVectorStoreAutoConfiguration
+org.springframework.ai.autoconfigure.vectorstore.weaviate.WeaviateVectorStoreAutoConfiguration

spring-ai-spring-boot-autoconfigure/src/test/java/org/springframework/ai/autoconfigure/vectorstore/weaviate/WeaviateVectorStoreAutoConfigurationTests.java

@@ -0,0 +1,132 @@
+/*
+ * Copyright 2023-2023 the original author or authors.
+ *
+ * Licensed under the Apache License, Version 2.0 (the "License");
+ * you may not use this file except in compliance with the License.
+ * You may obtain a copy of the License at
+ *
+ *      https://www.apache.org/licenses/LICENSE-2.0
+ *
+ * Unless required by applicable law or agreed to in writing, software
+ * distributed under the License is distributed on an "AS IS" BASIS,
+ * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+ * See the License for the specific language governing permissions and
+ * limitations under the License.
+ */
+
+package org.springframework.ai.autoconfigure.vectorstore.weaviate;
+
+import java.util.List;
+import java.util.Map;
+
+import org.junit.jupiter.api.Test;
+import org.testcontainers.containers.GenericContainer;
+import org.testcontainers.junit.jupiter.Container;
+import org.testcontainers.junit.jupiter.Testcontainers;
+
+import org.springframework.ai.document.Document;
+import org.springframework.ai.embedding.EmbeddingClient;
+import org.springframework.ai.embedding.TransformersEmbeddingClient;
+import org.springframework.ai.vectorstore.SearchRequest;
+import org.springframework.ai.vectorstore.VectorStore;
+import org.springframework.ai.vectorstore.WeaviateVectorStore.WeaviateVectorStoreConfig.MetadataField;
+import org.springframework.boot.autoconfigure.AutoConfigurations;
+import org.springframework.boot.test.context.runner.ApplicationContextRunner;
+import org.springframework.context.annotation.Bean;
+import org.springframework.context.annotation.Configuration;
+
+import static org.assertj.core.api.Assertions.assertThat;
+
+/**
+ * @author Christian Tzolov
+ */
+@Testcontainers
+public class WeaviateVectorStoreAutoConfigurationTests {
+
+	@Container
+	static GenericContainer<?> weaviateContainer = new GenericContainer<>("semitechnologies/weaviate:1.22.4")
+		.withEnv("AUTHENTICATION_ANONYMOUS_ACCESS_ENABLED", "true")
+		.withEnv("PERSISTENCE_DATA_PATH", "/var/lib/weaviate")
+		.withEnv("QUERY_DEFAULTS_LIMIT", "25")
+		.withEnv("DEFAULT_VECTORIZER_MODULE", "none")
+		.withEnv("CLUSTER_HOSTNAME", "node1")
+		.withExposedPorts(8080);
+
+	private final ApplicationContextRunner contextRunner = new ApplicationContextRunner()
+		.withConfiguration(AutoConfigurations.of(WeaviateVectorStoreAutoConfiguration.class))
+		.withUserConfiguration(Config.class)
+		.withPropertyValues("spring.ai.vectorstore.weaviate.scheme=http",
+				"spring.ai.vectorstore.weaviate.host=localhost:" + weaviateContainer.getMappedPort(8080),
+				"spring.ai.vectorstore.weaviate.filter-field.country=TEXT",
+				"spring.ai.vectorstore.weaviate.filter-field.year=NUMBER",
+				"spring.ai.vectorstore.weaviate.filter-field.active=BOOLEAN",
+				"spring.ai.vectorstore.weaviate.filter-field.price=NUMBER");
+
+	@Test
+	public void addAndSearchWithFilters() {
+
+		contextRunner.run(context -> {
+
+			WeaviateVectorStoreProperties properties = context.getBean(WeaviateVectorStoreProperties.class);
+
+			assertThat(properties.getFilterField()).hasSize(4);
+
+			assertThat(properties.getFilterField().get("country")).isEqualTo(MetadataField.Type.TEXT);
+			assertThat(properties.getFilterField().get("year")).isEqualTo(MetadataField.Type.NUMBER);
+			assertThat(properties.getFilterField().get("active")).isEqualTo(MetadataField.Type.BOOLEAN);
+			assertThat(properties.getFilterField().get("price")).isEqualTo(MetadataField.Type.NUMBER);
+
+			VectorStore vectorStore = context.getBean(VectorStore.class);
+
+			var bgDocument = new Document("The World is Big and Salvation Lurks Around the Corner",
+					Map.of("country", "Bulgaria", "price", 3.14, "active", true, "year", 2020));
+			var nlDocument = new Document("The World is Big and Salvation Lurks Around the Corner",
+					Map.of("country", "Netherland", "price", 1.57, "active", false, "year", 2023));
+
+			vectorStore.add(List.of(bgDocument, nlDocument));
+
+			var request = SearchRequest.query("The World").withTopK(5);
+
+			List<Document> results = vectorStore.similaritySearch(request);
+			assertThat(results).hasSize(2);
+
+			results = vectorStore
+				.similaritySearch(request.withSimilarityThresholdAll().withFilterExpression("country == 'Bulgaria'"));
+			assertThat(results).hasSize(1);
+			assertThat(results.get(0).getId()).isEqualTo(bgDocument.getId());
+
+			results = vectorStore
+				.similaritySearch(request.withSimilarityThresholdAll().withFilterExpression("country == 'Netherland'"));
+			assertThat(results).hasSize(1);
+			assertThat(results.get(0).getId()).isEqualTo(nlDocument.getId());
+
+			results = vectorStore.similaritySearch(
+					request.withSimilarityThresholdAll().withFilterExpression("price > 1.57 && active == true"));
+			assertThat(results).hasSize(1);
+			assertThat(results.get(0).getId()).isEqualTo(bgDocument.getId());
+
+			results = vectorStore
+				.similaritySearch(request.withSimilarityThresholdAll().withFilterExpression("year in [2020, 2023]"));
+			assertThat(results).hasSize(2);
+
+			results = vectorStore.similaritySearch(
+					request.withSimilarityThresholdAll().withFilterExpression("year > 2020 && year <= 2023"));
+			assertThat(results).hasSize(1);
+			assertThat(results.get(0).getId()).isEqualTo(nlDocument.getId());
+
+			// Remove all documents from the store
+			vectorStore.delete(List.of(bgDocument, nlDocument).stream().map(doc -> doc.getId()).toList());
+		});
+	}
+
+	@Configuration(proxyBeanMethods = false)
+	static class Config {
+
+		@Bean
+		public EmbeddingClient embeddingClient() {
+			return new TransformersEmbeddingClient();
+		}
+
+	}
+
+}