Add support for optional keyless authentication.

Implemented a new configuration property 'useKeylessAuth' to toggle
between API key and Azure default credential authentication.

Added necessary dependencies and updated tests to reflect the new changes.

co-authored-by: mattgotteiner <[email protected]>
Signed-off-by: leijendary <[email protected]>

Author: 2 people

pom.xml

@@ -213,6 +213,10 @@
 		<gemfire.testcontainers.version>2.3.0</gemfire.testcontainers.version>
 		<pinecone.version>0.8.0</pinecone.version>
 		<fastjson.version>2.0.46</fastjson.version>
+		<azure-core.version>1.53.0</azure-core.version>
+		<azure-json.version>1.3.0</azure-json.version>
+		<azure-identity.version>1.14.0</azure-identity.version>
+
 		<azure-search.version>11.6.1</azure-search.version>
 		<azure-cosmos.version>5.17.1</azure-cosmos.version>
 		<weaviate-client.version>4.5.1</weaviate-client.version>

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

@@ -101,6 +101,7 @@ You can use the following properties in your Spring Boot configuration to custom
 
 |`spring.ai.vectorstore.azure.url`|
 |`spring.ai.vectorstore.azure.api-key`|
+|`spring.ai.vectorstore.azure.useKeylessAuth`|false
 |`spring.ai.vectorstore.azure.initialize-schema`|false
 |`spring.ai.vectorstore.azure.index-name`|spring_ai_azure_vector_store
 |`spring.ai.vectorstore.azure.default-top-k`|4

spring-ai-spring-boot-autoconfigure/src/main/java/org/springframework/ai/autoconfigure/vectorstore/azure/AzureVectorStoreAutoConfiguration.java

@@ -20,6 +20,7 @@
 
 import com.azure.core.credential.AzureKeyCredential;
 import com.azure.core.util.ClientOptions;
+import com.azure.identity.DefaultAzureCredentialBuilder;
 import com.azure.search.documents.indexes.SearchIndexClient;
 import com.azure.search.documents.indexes.SearchIndexClientBuilder;
 import io.micrometer.observation.ObservationRegistry;
@@ -56,10 +57,18 @@ public class AzureVectorStoreAutoConfiguration {
 	public SearchIndexClient searchIndexClient(AzureVectorStoreProperties properties) {
 		ClientOptions clientOptions = new ClientOptions();
 		clientOptions.setApplicationId(APPLICATION_ID);
-		return new SearchIndexClientBuilder().endpoint(properties.getUrl())
-			.credential(new AzureKeyCredential(properties.getApiKey()))
-			.clientOptions(clientOptions)
-			.buildClient();
+		if (properties.isUseKeylessAuth()) {
+			return new SearchIndexClientBuilder().endpoint(properties.getUrl())
+				.credential(new DefaultAzureCredentialBuilder().build())
+				.clientOptions(clientOptions)
+				.buildClient();
+		}
+		else {
+			return new SearchIndexClientBuilder().endpoint(properties.getUrl())
+				.credential(new AzureKeyCredential(properties.getApiKey()))
+				.clientOptions(clientOptions)
+				.buildClient();
+		}
 	}
 
 	@Bean

spring-ai-spring-boot-autoconfigure/src/main/java/org/springframework/ai/autoconfigure/vectorstore/azure/AzureVectorStoreProperties.java

@@ -40,6 +40,8 @@ public class AzureVectorStoreProperties extends CommonVectorStoreProperties {
 
 	private double defaultSimilarityThreshold = -1;
 
+	private boolean useKeylessAuth;
+
 	public String getUrl() {
 		return this.url;
 	}
@@ -80,4 +82,12 @@ public void setDefaultSimilarityThreshold(double defaultSimilarityThreshold) {
 		this.defaultSimilarityThreshold = defaultSimilarityThreshold;
 	}
 
+	public boolean isUseKeylessAuth() {
+		return this.useKeylessAuth;
+	}
+
+	public void setUseKeylessAuth(boolean useKeylessAuth) {
+		this.useKeylessAuth = useKeylessAuth;
+	}
+
 }

vector-stores/spring-ai-azure-store/pom.xml

@@ -59,6 +59,24 @@
 				</exclusion>
 			</exclusions>
 		</dependency>
+		<!-- https://mvnrepository.com/artifact/com.azure/azure-identity -->
+		<dependency>
+			<groupId>com.azure</groupId>
+			<artifactId>azure-identity</artifactId>
+			<version>${azure-identity.version}</version>
+		</dependency>
+		<!-- https://mvnrepository.com/artifact/com.azure/azure-core -->
+		<dependency>
+			<groupId>com.azure</groupId>
+			<artifactId>azure-core</artifactId>
+			<version>${azure-core.version}</version>
+		</dependency>
+		<!-- https://mvnrepository.com/artifact/com.azure/azure-json -->
+		<dependency>
+			<groupId>com.azure</groupId>
+			<artifactId>azure-json</artifactId>
+			<version>${azure-json.version}</version>
+		</dependency>
 		<dependency>
 			<groupId>com.alibaba.fastjson2</groupId>
 			<artifactId>fastjson2</artifactId>

vector-stores/spring-ai-azure-store/src/test/java/org/springframework/ai/vectorstore/azure/AzureAiSearchFilterExpressionConverterTests.java

@@ -44,10 +44,6 @@
  */
 public class AzureAiSearchFilterExpressionConverterTests {
 
-	private static String format(String text) {
-		return text.trim().replace(" " + System.lineSeparator(), System.lineSeparator()) + System.lineSeparator();
-	}
-
 	@Test
 	public void testMissingFilterName() {
 
@@ -79,10 +75,9 @@ public void testEQ() {
 				List.of(MetadataField.text("country")));
 
 		// country == "BG"
+		String expected = "meta_country eq 'BG'";
 		String vectorExpr = converter.convertExpression(new Expression(EQ, new Key("country"), new Value("BG")));
-		assertThat(format(vectorExpr)).isEqualTo("""
-				meta_country eq 'BG'
-				""");
+		assertThat(vectorExpr).isEqualTo(expected);
 	}
 
 	@Test
@@ -91,12 +86,11 @@ public void tesEqAndGte() {
 				List.of(MetadataField.text("genre"), MetadataField.int32("year")));
 
 		// genre == "drama" AND year >= 2020
+		String expected = "meta_genre eq 'drama' and meta_year ge 2020";
 		String vectorExpr = converter
 			.convertExpression(new Expression(AND, new Expression(EQ, new Key("genre"), new Value("drama")),
 					new Expression(GTE, new Key("year"), new Value(2020))));
-		assertThat(format(vectorExpr)).isEqualTo("""
-				meta_genre eq 'drama' and meta_year ge 2020
-				""");
+		assertThat(vectorExpr).isEqualTo(expected);
 	}
 
 	@Test
@@ -105,11 +99,10 @@ public void tesIn() {
 				List.of(MetadataField.text("genre")));
 
 		// genre in ["comedy", "documentary", "drama"]
+		String expected = " search.in(meta_genre, 'comedy,documentary,drama', ',')";
 		String vectorExpr = converter.convertExpression(
 				new Expression(IN, new Key("genre"), new Value(List.of("comedy", "documentary", "drama"))));
-		assertThat(format(vectorExpr)).isEqualTo("""
-				search.in(meta_genre, 'comedy,documentary,drama', ',')
-				""");
+		assertThat(vectorExpr).isEqualTo(expected);
 	}
 
 	@Test
@@ -118,11 +111,10 @@ public void tesNin() {
 				List.of(MetadataField.text("genre")));
 
 		// genre in ["comedy", "documentary", "drama"]
+		String expected = " not search.in(meta_genre, 'comedy,documentary,drama', ',')";
 		String vectorExpr = converter.convertExpression(
 				new Expression(NIN, new Key("genre"), new Value(List.of("comedy", "documentary", "drama"))));
-		assertThat(format(vectorExpr)).isEqualTo("""
-				not search.in(meta_genre, 'comedy,documentary,drama', ',')
-				""");
+		assertThat(vectorExpr).isEqualTo(expected);
 	}
 
 	@Test
@@ -131,13 +123,12 @@ public void testNe() {
 				List.of(MetadataField.text("city"), MetadataField.int64("year"), MetadataField.text("country")));
 
 		// year >= 2020 OR country == "BG" AND city != "Sofia"
+		String expected = "meta_year ge 2020 or meta_country eq 'BG' and meta_city ne 'Sofia'";
 		String vectorExpr = converter
 			.convertExpression(new Expression(OR, new Expression(GTE, new Key("year"), new Value(2020)),
 					new Expression(AND, new Expression(EQ, new Key("country"), new Value("BG")),
 							new Expression(NE, new Key("city"), new Value("Sofia")))));
-		assertThat(format(vectorExpr)).isEqualTo("""
-				meta_year ge 2020 or meta_country eq 'BG' and meta_city ne 'Sofia'
-				""");
+		assertThat(vectorExpr).isEqualTo(expected);
 	}
 
 	@Test
@@ -146,14 +137,12 @@ public void testGroup() {
 				List.of(MetadataField.text("city"), MetadataField.int64("year"), MetadataField.text("country")));
 
 		// (year >= 2020 OR country == "BG") AND city != "Sofia"
+		String expected = "(meta_year ge 2020 or meta_country eq 'BG') and meta_city ne 'Sofia'";
 		String vectorExpr = converter.convertExpression(new Expression(AND,
 				new Group(new Expression(OR, new Expression(GTE, new Key("year"), new Value(2020)),
 						new Expression(EQ, new Key("country"), new Value("BG")))),
 				new Expression(NE, new Key("city"), new Value("Sofia"))));
-
-		assertThat(format(vectorExpr)).isEqualTo("""
-				(meta_year ge 2020 or meta_country eq 'BG') and meta_city ne 'Sofia'
-				""");
+		assertThat(vectorExpr).isEqualTo(expected);
 	}
 
 	@Test
@@ -162,14 +151,12 @@ public void tesBoolean() {
 				List.of(MetadataField.bool("isOpen"), MetadataField.int64("year"), MetadataField.text("country")));
 
 		// isOpen == true AND year >= 2020 AND country IN ["BG", "NL", "US"]
+		String expected = "meta_isOpen eq true and meta_year ge 2020 and  search.in(meta_country, 'BG,NL,US', ',')";
 		String vectorExpr = converter.convertExpression(new Expression(AND,
 				new Expression(AND, new Expression(EQ, new Key("isOpen"), new Value(true)),
 						new Expression(GTE, new Key("year"), new Value(2020))),
 				new Expression(IN, new Key("country"), new Value(List.of("BG", "NL", "US")))));
-
-		assertThat(format(vectorExpr)).isEqualTo("""
-				meta_isOpen eq true and meta_year ge 2020 and  search.in(meta_country, 'BG,NL,US', ',')
-				""");
+		assertThat(vectorExpr).isEqualTo(expected);
 	}
 
 	@Test
@@ -181,27 +168,21 @@ public void testDecimal() {
 		String vectorExpr = converter
 			.convertExpression(new Expression(AND, new Expression(GTE, new Key("temperature"), new Value(-15.6)),
 					new Expression(LTE, new Key("temperature"), new Value(20.13))));
-
-		assertThat(format(vectorExpr)).isEqualTo("""
-				meta_temperature ge -15.6 and meta_temperature le 20.13
-				""");
+		String expected = "meta_temperature ge -15.6 and meta_temperature le 20.13";
 	}
 
 	@Test
 	public void testComplexIdentifiers() {
 		FilterExpressionConverter converter = new AzureAiSearchFilterExpressionConverter(
 				List.of(MetadataField.text("country 1 2 3")));
 
+		String expected = "'meta_country 1 2 3' eq 'BG'";
 		String vectorExpr = converter
 			.convertExpression(new Expression(EQ, new Key("\"country 1 2 3\""), new Value("BG")));
-		assertThat(format(vectorExpr)).isEqualTo("""
-				'meta_country 1 2 3' eq 'BG'
-				""");
+		assertThat(vectorExpr).isEqualTo(expected);
 
 		vectorExpr = converter.convertExpression(new Expression(EQ, new Key("'country 1 2 3'"), new Value("BG")));
-		assertThat(format(vectorExpr)).isEqualTo("""
-				'meta_country 1 2 3' eq 'BG'
-				""");
+		assertThat(vectorExpr).isEqualTo(expected);
 	}
 
 }