GH-3535: Make the content field configurable in Weaviate vector store properties

Fixes: #3535

Signed-off-by: jonghoonpark <dev@jonghoonpark.com>

Author: dev-jonghoonpark

auto-configurations/vector-stores/spring-ai-autoconfigure-vector-store-weaviate/src/main/java/org/springframework/ai/vectorstore/weaviate/autoconfigure/WeaviateVectorStoreAutoConfiguration.java

@@ -28,12 +28,14 @@
 import org.springframework.ai.vectorstore.SpringAIVectorStoreTypes;
 import org.springframework.ai.vectorstore.observation.VectorStoreObservationConvention;
 import org.springframework.ai.vectorstore.weaviate.WeaviateVectorStore;
+import org.springframework.ai.vectorstore.weaviate.WeaviateVectorStoreOptions;
 import org.springframework.beans.factory.ObjectProvider;
 import org.springframework.boot.autoconfigure.AutoConfiguration;
 import org.springframework.boot.autoconfigure.condition.ConditionalOnClass;
 import org.springframework.boot.autoconfigure.condition.ConditionalOnMissingBean;
 import org.springframework.boot.autoconfigure.condition.ConditionalOnProperty;
 import org.springframework.boot.context.properties.EnableConfigurationProperties;
+import org.springframework.boot.context.properties.PropertyMapper;
 import org.springframework.context.annotation.Bean;
 
 /**
@@ -42,6 +44,7 @@
  * @author Christian Tzolov
  * @author Eddú Meléndez
  * @author Soby Chacko
+ * @author Jonghoon Park
  */
 @AutoConfiguration
 @ConditionalOnClass({ EmbeddingModel.class, WeaviateVectorStore.class })
@@ -82,9 +85,8 @@ public WeaviateVectorStore vectorStore(EmbeddingModel embeddingModel, WeaviateCl
 			WeaviateVectorStoreProperties properties, ObjectProvider<ObservationRegistry> observationRegistry,
 			ObjectProvider<VectorStoreObservationConvention> customObservationConvention,
 			BatchingStrategy batchingStrategy) {
-
 		return WeaviateVectorStore.builder(weaviateClient, embeddingModel)
-			.objectClass(properties.getObjectClass())
+			.options(mappingPropertiesToOptions(properties))
 			.filterMetadataFields(properties.getFilterField()
 				.entrySet()
 				.stream()
@@ -97,6 +99,16 @@ public WeaviateVectorStore vectorStore(EmbeddingModel embeddingModel, WeaviateCl
 			.build();
 	}
 
+	WeaviateVectorStoreOptions mappingPropertiesToOptions(WeaviateVectorStoreProperties properties) {
+		WeaviateVectorStoreOptions weaviateVectorStoreOptions = new WeaviateVectorStoreOptions();
+
+		PropertyMapper mapper = PropertyMapper.get();
+		mapper.from(properties::getContentFieldName).whenHasText().to(weaviateVectorStoreOptions::setContentFieldName);
+		mapper.from(properties::getObjectClass).whenHasText().to(weaviateVectorStoreOptions::setObjectClass);
+
+		return weaviateVectorStoreOptions;
+	}
+
 	static class PropertiesWeaviateConnectionDetails implements WeaviateConnectionDetails {
 
 		private final WeaviateVectorStoreProperties properties;

auto-configurations/vector-stores/spring-ai-autoconfigure-vector-store-weaviate/src/main/java/org/springframework/ai/vectorstore/weaviate/autoconfigure/WeaviateVectorStoreProperties.java

@@ -27,6 +27,7 @@
  * Configuration properties for Weaviate Vector Store.
  *
  * @author Christian Tzolov
+ * @author Jonghoon Park
  */
 @ConfigurationProperties(WeaviateVectorStoreProperties.CONFIG_PREFIX)
 public class WeaviateVectorStoreProperties {
@@ -41,6 +42,8 @@ public class WeaviateVectorStoreProperties {
 
 	private String objectClass = "SpringAiWeaviate";
 
+	private String contentFieldName = "content";
+
 	private ConsistentLevel consistencyLevel = WeaviateVectorStore.ConsistentLevel.ONE;
 
 	/**
@@ -78,6 +81,20 @@ public String getObjectClass() {
 		return this.objectClass;
 	}
 
+	/**
+	 * @since 1.1.0
+	 */
+	public String getContentFieldName() {
+		return contentFieldName;
+	}
+
+	/**
+	 * @since 1.1.0
+	 */
+	public void setContentFieldName(String contentFieldName) {
+		this.contentFieldName = contentFieldName;
+	}
+
 	public void setObjectClass(String indexName) {
 		this.objectClass = indexName;
 	}

auto-configurations/vector-stores/spring-ai-autoconfigure-vector-store-weaviate/src/test/java/org/springframework/ai/vectorstore/weaviate/autoconfigure/WeaviateVectorStoreAutoConfigurationIT.java

@@ -1,5 +1,5 @@
 /*
- * Copyright 2023-2024 the original author or authors.
+ * Copyright 2023-2025 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.
@@ -35,6 +35,7 @@
 import org.springframework.ai.vectorstore.observation.VectorStoreObservationContext;
 import org.springframework.ai.vectorstore.weaviate.WeaviateVectorStore;
 import org.springframework.ai.vectorstore.weaviate.WeaviateVectorStore.MetadataField;
+import org.springframework.ai.vectorstore.weaviate.WeaviateVectorStoreOptions;
 import org.springframework.boot.autoconfigure.AutoConfigurations;
 import org.springframework.boot.test.context.runner.ApplicationContextRunner;
 import org.springframework.context.annotation.Bean;
@@ -48,6 +49,7 @@
  * @author Eddú Meléndez
  * @author Soby Chacko
  * @author Thomas Vitale
+ * @author Jonghoon Park
  */
 @Testcontainers
 public class WeaviateVectorStoreAutoConfigurationIT {
@@ -174,6 +176,22 @@ public void autoConfigurationEnabledWhenTypeIsWeaviate() {
 		});
 	}
 
+	@Test
+	public void testMappingPropertiesToOptions() {
+		this.contextRunner
+			.withPropertyValues("spring.ai.vectorstore.weaviate.object-class=CustomObjectClass",
+					"spring.ai.vectorstore.weaviate.content-field-name=customContentFieldName")
+			.run(context -> {
+				WeaviateVectorStoreAutoConfiguration autoConfiguration = context
+					.getBean(WeaviateVectorStoreAutoConfiguration.class);
+				WeaviateVectorStoreProperties properties = context.getBean(WeaviateVectorStoreProperties.class);
+				WeaviateVectorStoreOptions options = autoConfiguration.mappingPropertiesToOptions(properties);
+
+				assertThat(options.getObjectClass()).isEqualTo("CustomObjectClass");
+				assertThat(options.getContentFieldName()).isEqualTo("customContentFieldName");
+			});
+	}
+
 	@Configuration(proxyBeanMethods = false)
 	static class Config {
 

spring-ai-docs/src/main/antora/modules/ROOT/pages/api/vectordbs/weaviate.adoc

@@ -156,7 +156,7 @@ public WeaviateClient weaviateClient() {
 @Bean
 public VectorStore vectorStore(WeaviateClient weaviateClient, EmbeddingModel embeddingModel) {
     return WeaviateVectorStore.builder(weaviateClient, embeddingModel)
-        .objectClass("CustomClass")                    // Optional: defaults to "SpringAiWeaviate"
+        .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"),
@@ -261,11 +261,14 @@ You can use the following properties in your Spring Boot configuration to custom
 |`spring.ai.vectorstore.weaviate.host`|The host of the Weaviate server|localhost:8080
 |`spring.ai.vectorstore.weaviate.scheme`|Connection schema|http
 |`spring.ai.vectorstore.weaviate.api-key`|The API key for authentication|
-|`spring.ai.vectorstore.weaviate.object-class`|The class name for storing documents|SpringAiWeaviate
+|`spring.ai.vectorstore.weaviate.object-class`|The class name for storing documents. should|SpringAiWeaviate
+|`spring.ai.vectorstore.weaviate.content-field-name`|The field name for content|content
 |`spring.ai.vectorstore.weaviate.consistency-level`|Desired tradeoff between consistency and speed|ConsistentLevel.ONE
 |`spring.ai.vectorstore.weaviate.filter-field`|Configures metadata fields that can be used in filters. Format: spring.ai.vectorstore.weaviate.filter-field.<field-name>=<field-type>|
 |===
 
+TIP: Object class names should start with an uppercase letter, and field names should start with a lowercase letter. see link:https://weaviate.io/developers/weaviate/concepts/data#data-object-concepts[data-object-concepts]
+
 == Accessing the Native Client
 
 The Weaviate Vector Store implementation provides access to the underlying native Weaviate client (`WeaviateClient`) through the `getNativeClient()` method:

vector-stores/spring-ai-weaviate-store/src/main/java/org/springframework/ai/vectorstore/weaviate/WeaviateVectorStore.java

@@ -75,7 +75,7 @@
  * <pre>{@code
  * // Create the vector store with builder
  * WeaviateVectorStore vectorStore = WeaviateVectorStore.builder(weaviateClient, embeddingModel)
- *     .objectClass("CustomClass")                // Optional: Custom class name (default: SpringAiWeaviate)
+ *     .options(options)                     	  // Optional: use custom options
  *     .consistencyLevel(ConsistentLevel.QUORUM)  // Optional: Set consistency level (default: ONE)
  *     .filterMetadataFields(List.of(             // Optional: Configure filterable metadata fields
  *         MetadataField.text("country"),
@@ -89,6 +89,7 @@
  * @author Josh Long
  * @author Soby Chacko
  * @author Thomas Vitale
+ * @author Jonghoon Park
  * @since 1.0.0
  */
 public class WeaviateVectorStore extends AbstractObservationVectorStore {
@@ -97,8 +98,6 @@ public class WeaviateVectorStore extends AbstractObservationVectorStore {
 
 	private static final String METADATA_FIELD_PREFIX = "meta_";
 
-	private static final String CONTENT_FIELD_NAME = "content";
-
 	private static final String METADATA_FIELD_NAME = "metadata";
 
 	private static final String ADDITIONAL_FIELD_NAME = "_additional";
@@ -111,9 +110,9 @@ public class WeaviateVectorStore extends AbstractObservationVectorStore {
 
 	private final WeaviateClient weaviateClient;
 
-	private final ConsistentLevel consistencyLevel;
+	private final WeaviateVectorStoreOptions options;
 
-	private final String weaviateObjectClass;
+	private final ConsistentLevel consistencyLevel;
 
 	/**
 	 * List of metadata fields (as field name and type) that can be used in similarity
@@ -157,9 +156,10 @@ protected WeaviateVectorStore(Builder builder) {
 
 		Assert.notNull(builder.weaviateClient, "WeaviateClient must not be null");
 
+		this.options = builder.options;
+
 		this.weaviateClient = builder.weaviateClient;
 		this.consistencyLevel = builder.consistencyLevel;
-		this.weaviateObjectClass = builder.weaviateObjectClass;
 		this.filterMetadataFields = builder.filterMetadataFields;
 		this.filterExpressionConverter = new WeaviateFilterExpressionConverter(
 				this.filterMetadataFields.stream().map(MetadataField::name).toList());
@@ -179,7 +179,7 @@ private Field[] buildWeaviateSimilaritySearchFields() {
 
 		List<Field> searchWeaviateFieldList = new ArrayList<>();
 
-		searchWeaviateFieldList.add(Field.builder().name(CONTENT_FIELD_NAME).build());
+		searchWeaviateFieldList.add(Field.builder().name(this.options.getContentFieldName()).build());
 		searchWeaviateFieldList.add(Field.builder().name(METADATA_FIELD_NAME).build());
 		searchWeaviateFieldList.addAll(this.filterMetadataFields.stream()
 			.map(mf -> Field.builder().name(METADATA_FIELD_PREFIX + mf.name()).build())
@@ -247,7 +247,7 @@ private WeaviateObject toWeaviateObject(Document document, List<Document> docume
 
 		// https://weaviate.io/developers/weaviate/config-refs/datatypes
 		Map<String, Object> fields = new HashMap<>();
-		fields.put(CONTENT_FIELD_NAME, document.getText());
+		fields.put(this.options.getContentFieldName(), document.getText());
 		try {
 			String metadataString = this.objectMapper.writeValueAsString(document.getMetadata());
 			fields.put(METADATA_FIELD_NAME, metadataString);
@@ -265,7 +265,7 @@ private WeaviateObject toWeaviateObject(Document document, List<Document> docume
 		}
 
 		return WeaviateObject.builder()
-			.className(this.weaviateObjectClass)
+			.className(this.options.getObjectClass())
 			.id(document.getId())
 			.vector(EmbeddingUtils.toFloatArray(embeddings.get(documents.indexOf(document))))
 			.properties(fields)
@@ -277,7 +277,7 @@ public void doDelete(List<String> documentIds) {
 
 		Result<BatchDeleteResponse> result = this.weaviateClient.batch()
 			.objectsBatchDeleter()
-			.withClassName(this.weaviateObjectClass)
+			.withClassName(this.options.getObjectClass())
 			.withConsistencyLevel(this.consistencyLevel.name())
 			.withWhere(WhereFilter.builder()
 				.path("id")
@@ -336,7 +336,7 @@ public List<Document> doSimilaritySearch(SearchRequest request) {
 
 		GetBuilder.GetBuilderBuilder builder = GetBuilder.builder();
 
-		GetBuilderBuilder queryBuilder = builder.className(this.weaviateObjectClass)
+		GetBuilderBuilder queryBuilder = builder.className(this.options.getObjectClass())
 			.withNearVectorFilter(NearVectorArgument.builder()
 				.vector(EmbeddingUtils.toFloatArray(embedding))
 				.certainty((float) request.getSimilarityThreshold())
@@ -418,7 +418,7 @@ private Document toDocument(Map<String, ?> item) {
 		}
 
 		// Content
-		String content = (String) item.get(CONTENT_FIELD_NAME);
+		String content = (String) item.get(this.options.getContentFieldName());
 
 		// @formatter:off
 		return Document.builder()
@@ -434,7 +434,7 @@ public VectorStoreObservationContext.Builder createObservationContextBuilder(Str
 
 		return VectorStoreObservationContext.builder(VectorStoreProvider.WEAVIATE.value(), operationName)
 			.dimensions(this.embeddingModel.dimensions())
-			.collectionName(this.weaviateObjectClass);
+			.collectionName(this.options.getObjectClass());
 	}
 
 	@Override
@@ -526,7 +526,7 @@ public enum Type {
 
 	public static class Builder extends AbstractVectorStoreBuilder<Builder> {
 
-		private String weaviateObjectClass = "SpringAiWeaviate";
+		private WeaviateVectorStoreOptions options = new WeaviateVectorStoreOptions();
 
 		private ConsistentLevel consistencyLevel = ConsistentLevel.ONE;
 
@@ -552,10 +552,27 @@ private Builder(WeaviateClient weaviateClient, EmbeddingModel embeddingModel) {
 		 * @param objectClass the object class to use
 		 * @return this builder instance
 		 * @throws IllegalArgumentException if objectClass is null or empty
+		 * @deprecated Use
+		 * {@link org.springframework.ai.vectorstore.weaviate.WeaviateVectorStore.Builder#options(WeaviateVectorStoreOptions)}
+		 * instead.
 		 */
+		@Deprecated
 		public Builder objectClass(String objectClass) {
 			Assert.hasText(objectClass, "objectClass must not be empty");
-			this.weaviateObjectClass = objectClass;
+			this.options.setObjectClass(objectClass);
+			return this;
+		}
+
+		/**
+		 * Configures the Weaviate vector store option.
+		 * @param options the vector store options to use
+		 * @return this builder instance
+		 * @throws IllegalArgumentException if options is null or empty
+		 * @since 1.1.0
+		 */
+		public Builder options(WeaviateVectorStoreOptions options) {
+			Assert.notNull(options, "options must not be empty");
+			this.options = options;
 			return this;
 		}
 

vector-stores/spring-ai-weaviate-store/src/main/java/org/springframework/ai/vectorstore/weaviate/WeaviateVectorStoreOptions.java

@@ -0,0 +1,51 @@
+/*
+ * Copyright 2023-2025 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.vectorstore.weaviate;
+
+import org.springframework.util.Assert;
+
+/**
+ * Provided Weaviate vector option configuration.
+ *
+ * @author Jonghoon Park
+ * @since 1.1.0.
+ */
+public class WeaviateVectorStoreOptions {
+
+	private String objectClass = "SpringAiWeaviate";
+
+	private String contentFieldName = "content";
+
+	public String getObjectClass() {
+		return objectClass;
+	}
+
+	public void setObjectClass(String objectClass) {
+		Assert.hasText(objectClass, "objectClass cannot be null or empty");
+		this.objectClass = objectClass;
+	}
+
+	public String getContentFieldName() {
+		return contentFieldName;
+	}
+
+	public void setContentFieldName(String contentFieldName) {
+		Assert.hasText(contentFieldName, "contentFieldName cannot be null or empty");
+		this.contentFieldName = contentFieldName;
+	}
+
+}