Remove deprecated methods from Media

ilayaperumalg · ilayaperumalg · commit 228ef10bfbfe · 2025-05-05T01:47:45.000+01:00
- Remove deprecated constructor method Media(MimeType mimeType, URL url) from Media
 - Remove deprecated builder method data(URL url) from Media builder
 - Update references to use the builder and the data(URI) methods

Signed-off-by: Ilayaperumal Gopinathan &lt;ilayaperumal.gopinathan@broadcom.com&gt;
diff --git a/auto-configurations/models/chat/memory/spring-ai-autoconfigure-model-chat-memory-neo4j/src/test/java/org/springframework/ai/model/chat/memory/neo4j/autoconfigure/Neo4jChatMemoryAutoConfigurationIT.java b/auto-configurations/models/chat/memory/spring-ai-autoconfigure-model-chat-memory-neo4j/src/test/java/org/springframework/ai/model/chat/memory/neo4j/autoconfigure/Neo4jChatMemoryAutoConfigurationIT.java
@@ -100,7 +100,7 @@ void addAndGet() {
 						.mimeType(textPlain)
 						.data("hello".getBytes(StandardCharsets.UTF_8))
 						.build(),
-					Media.builder().data(URI.create("http://www.google.com").toURL()).mimeType(textPlain).build());
+					Media.builder().data(URI.create("http://www.google.com")).mimeType(textPlain).build());
 			UserMessage userMessageWithMedia = UserMessage.builder().text("Message with media").media(media).build();
 			memory.add(sessionId, userMessageWithMedia);
 
diff --git a/memory/spring-ai-model-chat-memory-neo4j/src/main/java/org/springframework/ai/chat/memory/neo4j/Neo4jChatMemory.java b/memory/spring-ai-model-chat-memory-neo4j/src/main/java/org/springframework/ai/chat/memory/neo4j/Neo4jChatMemory.java
@@ -16,7 +16,6 @@
 
 package org.springframework.ai.chat.memory.neo4j;
 
-import java.net.MalformedURLException;
 import java.net.URI;
 import java.util.ArrayList;
 import java.util.HashMap;
@@ -282,12 +281,7 @@ private List<Media> getMedia(org.neo4j.driver.Record record) {
 				.id(Optional.ofNullable(mediaMap.get(MediaAttributes.ID.getValue())).map(Object::toString).orElse(null))
 				.mimeType(MimeType.valueOf(mediaMap.get(MediaAttributes.MIME_TYPE.getValue()).toString()));
 			if (mediaMap.get(MediaAttributes.DATA.getValue()) instanceof String stringData) {
-				try {
-					mediaBuilder.data(URI.create(stringData).toURL());
-				}
-				catch (MalformedURLException e) {
-					throw new IllegalArgumentException("Media data contains an invalid URL");
-				}
+				mediaBuilder.data(URI.create(stringData));
 			}
 			else if (mediaMap.get(MediaAttributes.DATA.getValue()).getClass().isArray()) {
 				mediaBuilder.data(mediaMap.get(MediaAttributes.DATA.getValue()));
diff --git a/models/spring-ai-mistral-ai/src/test/java/org/springframework/ai/mistralai/MistralAiChatModelIT.java b/models/spring-ai-mistral-ai/src/test/java/org/springframework/ai/mistralai/MistralAiChatModelIT.java
@@ -17,7 +17,7 @@
 package org.springframework.ai.mistralai;
 
 import java.io.IOException;
-import java.net.URL;
+import java.net.URI;
 import java.util.ArrayList;
 import java.util.Arrays;
 import java.util.List;
@@ -35,9 +35,9 @@
 
 import org.springframework.ai.chat.memory.ChatMemory;
 import org.springframework.ai.chat.memory.MessageWindowChatMemory;
-import org.springframework.ai.chat.messages.SystemMessage;
 import org.springframework.ai.chat.messages.AssistantMessage;
 import org.springframework.ai.chat.messages.Message;
+import org.springframework.ai.chat.messages.SystemMessage;
 import org.springframework.ai.chat.messages.UserMessage;
 import org.springframework.ai.chat.model.ChatModel;
 import org.springframework.ai.chat.model.ChatResponse;
@@ -296,7 +296,7 @@ void multiModalityImageUrl(String modelName) throws IOException {
 			.text("Explain what do you see on this picture?")
 			.media(List.of(Media.builder()
 				.mimeType(MimeTypeUtils.IMAGE_PNG)
-				.data(new URL("https://docs.spring.io/spring-ai/reference/_images/multimodal.test.png"))
+				.data(URI.create("https://docs.spring.io/spring-ai/reference/_images/multimodal.test.png"))
 				.build()))
 			.build();
 
@@ -314,7 +314,7 @@ void streamingMultiModalityImageUrl() throws IOException {
 			.text("Explain what do you see on this picture?")
 			.media(List.of(Media.builder()
 				.mimeType(MimeTypeUtils.IMAGE_PNG)
-				.data(new URL("https://docs.spring.io/spring-ai/reference/_images/multimodal.test.png"))
+				.data(URI.create("https://docs.spring.io/spring-ai/reference/_images/multimodal.test.png"))
 				.build()))
 			.build();
 
diff --git a/models/spring-ai-openai/src/test/java/org/springframework/ai/openai/chat/MessageTypeContentTests.java b/models/spring-ai-openai/src/test/java/org/springframework/ai/openai/chat/MessageTypeContentTests.java
@@ -127,10 +127,10 @@ public void userMessageWithMediaType() throws MalformedURLException {
 		given(this.openAiApi.chatCompletionEntity(this.pomptCaptor.capture(), this.headersCaptor.capture()))
 			.willReturn(Mockito.mock(ResponseEntity.class));
 
-		URL mediaUrl = new URL("http://test");
+		URI mediaUri = URI.create("http://test");
 		this.chatModel.call(new Prompt(List.of(UserMessage.builder()
 			.text("test message")
-			.media(List.of(Media.builder().mimeType(MimeTypeUtils.IMAGE_JPEG).data(mediaUrl).build()))
+			.media(List.of(Media.builder().mimeType(MimeTypeUtils.IMAGE_JPEG).data(mediaUri).build()))
 			.build())));
 
 		validateComplexContent(this.pomptCaptor.getValue());
diff --git a/models/spring-ai-openai/src/test/java/org/springframework/ai/openai/chat/OpenAiChatModelIT.java b/models/spring-ai-openai/src/test/java/org/springframework/ai/openai/chat/OpenAiChatModelIT.java
@@ -17,7 +17,7 @@
 package org.springframework.ai.openai.chat;
 
 import java.io.IOException;
-import java.net.URL;
+import java.net.URI;
 import java.util.ArrayList;
 import java.util.Arrays;
 import java.util.List;
@@ -49,12 +49,6 @@
 import org.springframework.ai.chat.metadata.Usage;
 import org.springframework.ai.chat.model.ChatResponse;
 import org.springframework.ai.chat.model.Generation;
-import org.springframework.ai.model.tool.DefaultToolCallingManager;
-import org.springframework.ai.model.tool.ToolCallingChatOptions;
-import org.springframework.ai.model.tool.ToolCallingManager;
-import org.springframework.ai.model.tool.ToolExecutionResult;
-import org.springframework.ai.tool.ToolCallbacks;
-import org.springframework.ai.tool.annotation.Tool;
 import org.springframework.ai.chat.prompt.ChatOptions;
 import org.springframework.ai.chat.prompt.Prompt;
 import org.springframework.ai.chat.prompt.PromptTemplate;
@@ -63,6 +57,10 @@
 import org.springframework.ai.converter.BeanOutputConverter;
 import org.springframework.ai.converter.ListOutputConverter;
 import org.springframework.ai.converter.MapOutputConverter;
+import org.springframework.ai.model.tool.DefaultToolCallingManager;
+import org.springframework.ai.model.tool.ToolCallingChatOptions;
+import org.springframework.ai.model.tool.ToolCallingManager;
+import org.springframework.ai.model.tool.ToolExecutionResult;
 import org.springframework.ai.openai.OpenAiChatOptions;
 import org.springframework.ai.openai.OpenAiTestConfiguration;
 import org.springframework.ai.openai.api.OpenAiApi;
@@ -71,6 +69,8 @@
 import org.springframework.ai.openai.api.OpenAiApi.ChatCompletionRequest.AudioParameters.Voice;
 import org.springframework.ai.openai.api.tool.MockWeatherService;
 import org.springframework.ai.openai.testutils.AbstractIT;
+import org.springframework.ai.tool.ToolCallbacks;
+import org.springframework.ai.tool.annotation.Tool;
 import org.springframework.ai.tool.function.FunctionToolCallback;
 import org.springframework.beans.factory.annotation.Value;
 import org.springframework.boot.test.context.SpringBootTest;
@@ -491,7 +491,7 @@ void multiModalityImageUrl(String modelName) throws IOException {
 			.text("Explain what do you see on this picture?")
 			.media(List.of(Media.builder()
 				.mimeType(MimeTypeUtils.IMAGE_PNG)
-				.data(new URL("https://docs.spring.io/spring-ai/reference/_images/multimodal.test.png"))
+				.data(URI.create("https://docs.spring.io/spring-ai/reference/_images/multimodal.test.png"))
 				.build()))
 			.build();
 
@@ -510,7 +510,7 @@ void streamingMultiModalityImageUrl() throws IOException {
 			.text("Explain what do you see on this picture?")
 			.media(List.of(Media.builder()
 				.mimeType(MimeTypeUtils.IMAGE_PNG)
-				.data(new URL("https://docs.spring.io/spring-ai/reference/_images/multimodal.test.png"))
+				.data(URI.create("https://docs.spring.io/spring-ai/reference/_images/multimodal.test.png"))
 				.build()))
 			.build();
 
diff --git a/models/spring-ai-openai/src/test/java/org/springframework/ai/openai/chat/proxy/GroqWithOpenAiChatModelIT.java b/models/spring-ai-openai/src/test/java/org/springframework/ai/openai/chat/proxy/GroqWithOpenAiChatModelIT.java
@@ -17,7 +17,7 @@
 package org.springframework.ai.openai.chat.proxy;
 
 import java.io.IOException;
-import java.net.URL;
+import java.net.URI;
 import java.util.ArrayList;
 import java.util.Arrays;
 import java.util.List;
@@ -334,7 +334,7 @@ void multiModalityImageUrl(String modelName) throws IOException {
 			.text("Explain what do you see on this picture?")
 			.media(List.of(Media.builder()
 				.mimeType(MimeTypeUtils.IMAGE_PNG)
-				.data(new URL("https://docs.spring.io/spring-ai/reference/_images/multimodal.test.png"))
+				.data(URI.create("https://docs.spring.io/spring-ai/reference/_images/multimodal.test.png"))
 				.build()))
 			.build();
 
@@ -354,7 +354,7 @@ void streamingMultiModalityImageUrl() throws IOException {
 			.text("Explain what do you see on this picture?")
 			.media(List.of(Media.builder()
 				.mimeType(MimeTypeUtils.IMAGE_PNG)
-				.data(new URL("https://docs.spring.io/spring-ai/reference/_images/multimodal.test.png"))
+				.data(URI.create("https://docs.spring.io/spring-ai/reference/_images/multimodal.test.png"))
 				.build()))
 			.build();
 
diff --git a/models/spring-ai-openai/src/test/java/org/springframework/ai/openai/chat/proxy/MistralWithOpenAiChatModelIT.java b/models/spring-ai-openai/src/test/java/org/springframework/ai/openai/chat/proxy/MistralWithOpenAiChatModelIT.java
@@ -18,7 +18,6 @@
 
 import java.io.IOException;
 import java.net.URI;
-import java.net.URL;
 import java.util.ArrayList;
 import java.util.Arrays;
 import java.util.List;
@@ -341,7 +340,7 @@ void multiModalityImageUrl(String modelName) throws IOException {
 			.text("Explain what do you see on this picture?")
 			.media(List.of(Media.builder()
 				.mimeType(MimeTypeUtils.IMAGE_PNG)
-				.data(new URL("https://docs.spring.io/spring-ai/reference/_images/multimodal.test.png"))
+				.data(URI.create("https://docs.spring.io/spring-ai/reference/_images/multimodal.test.png"))
 				.build()))
 			.build();
 
diff --git a/models/spring-ai-openai/src/test/java/org/springframework/ai/openai/chat/proxy/OllamaWithOpenAiChatModelIT.java b/models/spring-ai-openai/src/test/java/org/springframework/ai/openai/chat/proxy/OllamaWithOpenAiChatModelIT.java
@@ -18,7 +18,6 @@
 
 import java.io.IOException;
 import java.net.URI;
-import java.net.URL;
 import java.util.ArrayList;
 import java.util.Arrays;
 import java.util.List;
@@ -385,7 +384,7 @@ void streamingMultiModalityImageUrl(String modelName) throws IOException {
 			.text("Explain what do you see on this picture?")
 			.media(List.of(Media.builder()
 				.mimeType(MimeTypeUtils.IMAGE_PNG)
-				.data(new URL("https://docs.spring.io/spring-ai/reference/_images/multimodal.test.png"))
+				.data(URI.create("https://docs.spring.io/spring-ai/reference/_images/multimodal.test.png"))
 				.build()))
 			.build();
 
diff --git a/models/spring-ai-vertex-ai-embedding/src/test/java/org/springframework/ai/vertexai/embedding/multimodal/VertexAiMultimodalEmbeddingModelIT.java b/models/spring-ai-vertex-ai-embedding/src/test/java/org/springframework/ai/vertexai/embedding/multimodal/VertexAiMultimodalEmbeddingModelIT.java
@@ -114,7 +114,7 @@ void textMediaEmbedding() throws MalformedURLException {
 		var document = Document.builder()
 			.media(Media.builder()
 				.mimeType(MimeTypeUtils.TEXT_PLAIN)
-				.data(URI.create("http://example.com/image.png").toURL())
+				.data(URI.create("http://example.com/image.png"))
 				.build())
 			.build();
 
diff --git a/spring-ai-client-chat/src/main/java/org/springframework/ai/chat/client/DefaultChatClient.java b/spring-ai-client-chat/src/main/java/org/springframework/ai/chat/client/DefaultChatClient.java
@@ -17,6 +17,7 @@
 package org.springframework.ai.chat.client;
 
 import java.io.IOException;
+import java.net.URISyntaxException;
 import java.net.URL;
 import java.nio.charset.Charset;
 import java.util.ArrayList;
@@ -202,7 +203,12 @@ public PromptUserSpec media(Media... media) {
 		public PromptUserSpec media(MimeType mimeType, URL url) {
 			Assert.notNull(mimeType, "mimeType cannot be null");
 			Assert.notNull(url, "url cannot be null");
-			this.media.add(Media.builder().mimeType(mimeType).data(url).build());
+			try {
+				this.media.add(Media.builder().mimeType(mimeType).data(url.toURI()).build());
+			}
+			catch (URISyntaxException e) {
+				throw new RuntimeException(e);
+			}
 			return this;
 		}
 
diff --git a/spring-ai-client-chat/src/test/java/org/springframework/ai/chat/client/DefaultChatClientTests.java b/spring-ai-client-chat/src/test/java/org/springframework/ai/chat/client/DefaultChatClientTests.java
@@ -169,12 +169,12 @@ void whenUserMediaContainsNullElementsThenThrow() {
 	@Test
 	void whenUserMediaThenReturn() throws MalformedURLException {
 		DefaultChatClient.DefaultPromptUserSpec spec = new DefaultChatClient.DefaultPromptUserSpec();
-		URL mediaUrl = URI.create("http://example.com/image.png").toURL();
+		URI mediaUri = URI.create("http://example.com/image.png");
 		spec = (DefaultChatClient.DefaultPromptUserSpec) spec
-			.media(Media.builder().mimeType(MimeTypeUtils.IMAGE_PNG).data(mediaUrl).build());
+			.media(Media.builder().mimeType(MimeTypeUtils.IMAGE_PNG).data(mediaUri).build());
 		assertThat(spec.media()).hasSize(1);
 		assertThat(spec.media().get(0).getMimeType()).isEqualTo(MimeTypeUtils.IMAGE_PNG);
-		assertThat(spec.media().get(0).getData()).isEqualTo(mediaUrl.toString());
+		assertThat(spec.media().get(0).getData()).isEqualTo(mediaUri.toString());
 	}
 
 	@Test
diff --git a/spring-ai-commons/src/main/java/org/springframework/ai/content/Media.java b/spring-ai-commons/src/main/java/org/springframework/ai/content/Media.java
@@ -18,7 +18,6 @@
 
 import java.io.IOException;
 import java.net.URI;
-import java.net.URL;
 
 import org.springframework.core.io.Resource;
 import org.springframework.lang.Nullable;
@@ -116,22 +115,6 @@ public Media(MimeType mimeType, URI uri) {
 		this.name = generateDefaultName(mimeType);
 	}
 
-	/**
-	 * Create a new Media instance.
-	 * @param mimeType the media MIME type
-	 * @param url the URL for the media data
-	 * @deprecated in favour of {@link #Media(MimeType, URI)}
-	 */
-	@Deprecated
-	public Media(MimeType mimeType, URL url) {
-		Assert.notNull(mimeType, "MimeType must not be null");
-		Assert.notNull(url, "URL must not be null");
-		this.mimeType = mimeType;
-		this.id = null;
-		this.data = url.toString();
-		this.name = generateDefaultName(mimeType);
-	}
-
 	/**
 	 * Create a new Media instance.
 	 * @param mimeType the media MIME type
@@ -291,20 +274,6 @@ public Builder data(URI uri) {
 			return this;
 		}
 
-		/**
-		 * Sets the media data from a URL.
-		 * @param url the media URL, must not be null
-		 * @return the builder instance
-		 * @throws IllegalArgumentException if url is null
-		 * @deprecated in favour of {@link #data(URI)}
-		 */
-		@Deprecated
-		public Builder data(URL url) {
-			Assert.notNull(url, "URL must not be null");
-			this.data = url.toString();
-			return this;
-		}
-
 		/**
 		 * Sets the ID for the media object. The ID is typically assigned by AI models
 		 * when they return a reference to previously provided media content.
diff --git a/spring-ai-commons/src/test/java/org/springframework/ai/document/DocumentBuilderTests.java b/spring-ai-commons/src/test/java/org/springframework/ai/document/DocumentBuilderTests.java
@@ -16,8 +16,7 @@
 
 package org.springframework.ai.document;
 
-import java.net.MalformedURLException;
-import java.net.URL;
+import java.net.URI;
 import java.util.HashMap;
 import java.util.Map;
 
@@ -36,14 +35,7 @@ public class DocumentBuilderTests {
 	private Document.Builder builder;
 
 	private static Media getMedia() {
-		try {
-			URL mediaUrl1 = new URL("http://type1");
-			Media media1 = new Media(MimeTypeUtils.IMAGE_JPEG, mediaUrl1);
-			return media1;
-		}
-		catch (MalformedURLException e) {
-			throw new RuntimeException(e);
-		}
+		return Media.builder().data(URI.create("http://type1")).mimeType(MimeTypeUtils.IMAGE_JPEG).build();
 	}
 
 	@BeforeEach
@@ -97,9 +89,8 @@ void testWithContent() {
 	}
 
 	@Test
-	void testWithMediaSingle() throws MalformedURLException {
-		URL mediaUrl = new URL("http://test");
-		Media media = Media.builder().mimeType(MimeTypeUtils.IMAGE_JPEG).data(mediaUrl).build();
+	void testWithMediaSingle() {
+		Media media = Media.builder().mimeType(MimeTypeUtils.IMAGE_JPEG).data(URI.create("http://test")).build();
 
 		Document.Builder result = this.builder.media(media);
 
diff --git a/spring-ai-commons/src/test/java/org/springframework/ai/document/DocumentTests.java b/spring-ai-commons/src/test/java/org/springframework/ai/document/DocumentTests.java
@@ -17,6 +17,7 @@
 package org.springframework.ai.document;
 
 import java.net.MalformedURLException;
+import java.net.URI;
 import java.net.URL;
 import java.util.HashMap;
 import java.util.Map;
@@ -211,14 +212,7 @@ void testMetadataKeyValueAddition() {
 	}
 
 	private static Media getMedia() {
-		try {
-			URL mediaUrl1 = new URL("http://type1");
-			Media media1 = new Media(MimeTypeUtils.IMAGE_JPEG, mediaUrl1);
-			return media1;
-		}
-		catch (MalformedURLException e) {
-			throw new RuntimeException(e);
-		}
+		return Media.builder().mimeType(MimeTypeUtils.IMAGE_JPEG).data(URI.create("http://type1")).build();
 	}
 
 }
diff --git a/spring-ai-model/src/test/java/org/springframework/ai/model/MediaTests.java b/spring-ai-model/src/test/java/org/springframework/ai/model/MediaTests.java
