Allowing a custom embedding field by using a record instead of a map

Signed-off-by: jonghoon park <[email protected]>

Author: dev-jonghoonpark

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

@@ -16,6 +16,7 @@
 
 package org.springframework.ai.vectorstore.elasticsearch.autoconfigure;
 
+import org.springframework.ai.vectorstore.elasticsearch.common.ElasticsearchVectorStoreConstants;
 import org.springframework.ai.vectorstore.properties.CommonVectorStoreProperties;
 import org.springframework.ai.vectorstore.elasticsearch.SimilarityFunction;
 import org.springframework.boot.context.properties.ConfigurationProperties;
@@ -50,7 +51,7 @@ public class ElasticsearchVectorStoreProperties extends CommonVectorStorePropert
 	/**
 	 * The name of the vector field to search against
 	 */
-	private String embeddingFieldName = "embedding";
+	private String embeddingFieldName = ElasticsearchVectorStoreConstants.DEFAULT_EMBEDDING_FIELD_NAME;
 
 	public String getIndexName() {
 		return this.indexName;

vector-stores/spring-ai-elasticsearch-store/src/main/java/org/springframework/ai/vectorstore/elasticsearch/ElasticsearchVectorStore.java

@@ -32,6 +32,8 @@
 import co.elastic.clients.json.jackson.JacksonJsonpMapper;
 import co.elastic.clients.transport.Version;
 import co.elastic.clients.transport.rest_client.RestClientTransport;
+import com.fasterxml.jackson.annotation.JsonAnyGetter;
+import com.fasterxml.jackson.annotation.JsonIgnore;
 import com.fasterxml.jackson.databind.DeserializationFeature;
 import com.fasterxml.jackson.databind.ObjectMapper;
 import org.elasticsearch.client.RestClient;
@@ -189,12 +191,12 @@ public void doAdd(List<Document> documents) {
 		List<float[]> embeddings = this.embeddingModel.embed(documents, EmbeddingOptionsBuilder.builder().build(),
 				this.batchingStrategy);
 
-		for (int i = 0; i < embeddings.size(); i++) {
-			Document document = documents.get(i);
-			float[] embedding = embeddings.get(i);
-			bulkRequestBuilder.operations(op -> op.index(idx -> idx.index(this.options.getIndexName())
-				.id(document.getId())
-				.document(getDocument(document, embedding, this.options.getEmbeddingFieldName()))));
+		for (Document document : documents) {
+			ElasticSearchDocument doc = new ElasticSearchDocument(document.getId(), document.getText(),
+					document.getMetadata(), embeddings.get(documents.indexOf(document)),
+					this.options.getEmbeddingFieldName());
+			bulkRequestBuilder.operations(
+					op -> op.index(idx -> idx.index(this.options.getIndexName()).id(document.getId()).document(doc)));
 		}
 		BulkResponse bulkRequest = bulkRequest(bulkRequestBuilder.build());
 		if (bulkRequest.errors()) {
@@ -207,13 +209,6 @@ public void doAdd(List<Document> documents) {
 		}
 	}
 
-	private Object getDocument(Document document, float[] embedding, String embeddingFieldName) {
-		Assert.notNull(document.getText(), "document's text must not be null");
-
-		return Map.of("id", document.getId(), "content", document.getText(), "metadata", document.getMetadata(),
-				embeddingFieldName, embedding);
-	}
-
 	@Override
 	public void doDelete(List<String> idList) {
 		BulkRequest.Builder bulkRequestBuilder = new BulkRequest.Builder();
@@ -379,6 +374,25 @@ public static Builder builder(RestClient restClient, EmbeddingModel embeddingMod
 		return new Builder(restClient, embeddingModel);
 	}
 
+	/**
+	 * The representation of {@link Document} along with its embedding.
+	 *
+	 * @param id The id of the document
+	 * @param content The content of the document
+	 * @param metadata The metadata of the document
+	 * @param embedding The vectors representing the content of the document
+	 * @param embeddingFieldName The field name used in the serialized JSON for the
+	 * embedding vector
+	 */
+	public record ElasticSearchDocument(String id, String content, Map<String, Object> metadata,
+			@JsonIgnore float[] embedding, @JsonIgnore String embeddingFieldName) {
+
+		@JsonAnyGetter
+		public Map<String, Object> dynamicEmbeddingField() {
+			return Map.of(embeddingFieldName, embedding);
+		}
+	}
+
 	public static class Builder extends AbstractVectorStoreBuilder<Builder> {
 
 		private final RestClient restClient;

vector-stores/spring-ai-elasticsearch-store/src/main/java/org/springframework/ai/vectorstore/elasticsearch/ElasticsearchVectorStoreOptions.java

@@ -16,6 +16,8 @@
 
 package org.springframework.ai.vectorstore.elasticsearch;
 
+import org.springframework.ai.vectorstore.elasticsearch.common.ElasticsearchVectorStoreConstants;
+
 /**
  * Provided Elasticsearch vector option configuration.
  * https://www.elastic.co/guide/en/elasticsearch/reference/current/dense-vector.html
@@ -29,7 +31,7 @@ public class ElasticsearchVectorStoreOptions {
 	/**
 	 * The name of the index to store the vectors.
 	 */
-	private String indexName = "spring-ai-document-index";
+	private String indexName = ElasticsearchVectorStoreConstants.DEFAULT_INDEX_NAME;
 
 	/**
 	 * The number of dimensions in the vector.
@@ -44,7 +46,7 @@ public class ElasticsearchVectorStoreOptions {
 	/**
 	 * The name of the vector field to search against
 	 */
-	private String embeddingFieldName = "embedding";
+	private String embeddingFieldName = ElasticsearchVectorStoreConstants.DEFAULT_EMBEDDING_FIELD_NAME;
 
 	public String getIndexName() {
 		return this.indexName;

vector-stores/spring-ai-elasticsearch-store/src/main/java/org/springframework/ai/vectorstore/elasticsearch/common/ElasticsearchVectorStoreConstants.java

@@ -0,0 +1,30 @@
+/*
+ * 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.elasticsearch.common;
+
+/**
+ * Common value constants for Elasticsearch VectorStore.
+ *
+ * @author Jonghoon Park
+ */
+public class ElasticsearchVectorStoreConstants {
+
+	public static final String DEFAULT_INDEX_NAME = "spring-ai-document-index";
+
+	public static final String DEFAULT_EMBEDDING_FIELD_NAME = "embedding";
+
+}