merge main branch and change class name

Author: nottyjay

README.md

@@ -10,147 +10,14 @@ For further information go to our [Spring AI reference documentation](https://do
 
 ## Breaking changes
 
-On our march to release 1.0.0 M1 we have made several breaking changes.  Apologies, it is for the best!
-
-**(22.05.2024)**
-
-A major change was made that took the 'old' `ChatClient` and moved the functionality into `ChatModel`.  The 'new' `ChatClient` now takes an instance of `ChatModel`. This was done do support a fluent API for creating and executing prompts in a style similar to other client classes in the Spring ecosystem, such as `RestClient`, `WebClient`, and `JdbcClient`.  Refer to the [JavaDoc](https://docs.spring.io/spring-ai/docs/1.0.0-SNAPSHOT/api/) for more information on the Fluent API, proper reference documentation is coming shortly.
-
-We renamed the 'old' `ModelClient` to `Model` and renamed implementing classes, for example `ImageClient` was renamed to `ImageModel`.  The `Model` implementation represent the portability layer that converts between the Spring AI API and the underlying AI Model API.
-
-### Adapting to the changes
-
-NOTE: The `ChatClient` class is now in the package `org.springframework.ai.chat.client`
-
-#### Approach 1
-
-Now, instead of getting an Autoconfigured `ChatClient` instance, you will get a `ChatModel` instance.  The `call` method signatures after renaming remain the same.
-To adapt your code should refactor you code to change use of the type `ChatClient` to `ChatModel`
-Here is an example of existing code before the change
-
-```java
-@RestController
-public class OldSimpleAiController {
-
-    private final ChatClient chatClient;
-
-    public OldSimpleAiController(ChatClient chatClient) {
-        this.chatClient = chatClient;
-    }
-
-    @GetMapping("/ai/simple")
-    Map<String, String> completion(@RequestParam(value = "message", defaultValue = "Tell me a joke") String message) {
-        return Map.of("generation", chatClient.call(message));
-    }
-}
-```
-
-Now after the changes this will be
-
-```java
-@RestController
-public class SimpleAiController {
-
-    private final ChatModel chatModel;
-
-    public SimpleAiController(ChatModel chatModel) {
-        this.chatModel = chatModel;
-    }
-
-    @GetMapping("/ai/simple")
-    Map<String, String> completion(@RequestParam(value = "message", defaultValue = "Tell me a joke") String message) {
-        return Map.of("generation", chatModel.call(message));
-    }
-}
-```
-
-NOTE: The renaming also applies to the classes
-* `StreamingChatClient` -> `StreamingChatModel`
-* `EmbeddingClient` -> `EmbeddingModel`
-* `ImageClient` -> `ImageModel`
-* `SpeechClient` -> `SpeechModel`
-* and similar for other `<XYZ>Client` classes
-
-#### Approach 2
-
-In this approach you will use the new fluent API available on the 'new' `ChatClient`
-
-Here is an example of existing code before the change
-
-```java
-@RestController
-class OldSimpleAiController {
-
-    ChatClient chatClient;
-
-    OldSimpleAiController(ChatClient chatClient) {
-        this.chatClient = chatClient;
-	}
-
-	@GetMapping("/ai/simple")
-	Map<String, String> completion(@RequestParam(value = "message", defaultValue = "Tell me a joke") String message) {
-		return Map.of(
-                "generation",
-                chatClient.call(message)
-        );
-	}
-}
-```
-
-Now after the changes this will be
-
-```java
-@RestController
-class SimpleAiController {
-
-    private final ChatClient chatClient;
-
-    SimpleAiController(ChatClient.Builder builder) {
-      this.builder = builder.build();
-    }
-
-    @GetMapping("/ai/simple")
-    Map<String, String> completion(@RequestParam(value = "message", defaultValue = "Tell me a joke") String message) {
-        return Map.of(
-                "generation",
-                chatClient.prompt().user(message).call().content()
-        );
-    }
-}
-```
-
-
-NOTE: The `ChatModel` instance is made available to you through autoconfiguration.
-
-#### Approach 3
-
-There is a tag in the GitHub repository called [v1.0.0-SNAPSHOT-before-chatclient-changes](https://github.com/spring-projects/spring-ai/tree/v1.0.0-SNAPSHOT-before-chatclient-changes) that you can checkout and do a local build to avoid updating any of your code until you are ready to migrate your code base.
-
-```bash
-git checkout tags/v1.0.0-SNAPSHOT-before-chatclient-changes
-
-./mvnw clean install -DskipTests
-```
-
-
-**(15.05.2024)**
-
-Renamed POM artifact names:
- - spring-ai-qdrant -> spring-ai-qdrant-store
- - spring-ai-cassandra -> spring-ai-cassandra-store
- - spring-ai-pinecone -> spring-ai-pinecone-store
- - spring-ai-redis -> spring-ai-redis-store
- - spring-ai-qdrant -> spring-ai-qdrant-store
- - spring-ai-gemfire -> spring-ai-gemfire-store
- - spring-ai-azure-vector-store-spring-boot-starter -> spring-ai-azure-store-spring-boot-starter
- - spring-ai-redis-spring-boot-starter -> spring-ai-redis-store-spring-boot-starter
+* Refer to the [upgrade notes](https://docs.spring.io/spring-ai/reference/upgrade-notes.html) to see how to upgrade to 1.0.0.M1 or higher.
 
 ## Project Links
 
 * [Documentation](https://docs.spring.io/spring-ai/reference/)
 * [Issues](https://github.com/spring-projects/spring-ai/issues)
 * [Discussions](https://github.com/spring-projects/spring-ai/discussions) - Go here if you have a question, suggestion, or feedback!
-* [Upgrade from 0.7.1-SNAPSHOT](https://docs.spring.io/spring-ai/reference/upgrade-notes.html)
+
 
 ## Educational Resources
 

models/spring-ai-anthropic/src/main/java/org/springframework/ai/anthropic/metadata/AnthropicChatResponseMetadata.java

@@ -24,6 +24,8 @@
 import org.springframework.lang.Nullable;
 import org.springframework.util.Assert;
 
+import java.util.HashMap;
+
 /**
  * {@link ChatResponseMetadata} implementation for {@literal AnthropicApi}.
  *
@@ -33,7 +35,7 @@
  * @see Usage
  * @since 1.0.0
  */
-public class AnthropicChatResponseMetadata implements ChatResponseMetadata {
+public class AnthropicChatResponseMetadata extends HashMap<String, Object> implements ChatResponseMetadata {
 
 	protected static final String AI_METADATA_STRING = "{ @type: %1$s, id: %2$s, usage: %3$s, rateLimit: %4$s }";
 

models/spring-ai-azure-openai/src/main/java/org/springframework/ai/azure/openai/AzureOpenAiChatModel.java

@@ -183,8 +183,8 @@ public Flux<ChatResponse> stream(Prompt prompt) {
 					isFunctionCall.set(false);
 					return true;
 				}
-				return false;
-			}, false)
+				return !isFunctionCall.get();
+			})
 			.concatMapIterable(window -> {
 				final var reduce = window.reduce(MergeUtils.emptyChatCompletions(), MergeUtils::mergeChatCompletions);
 				return List.of(reduce);

models/spring-ai-azure-openai/src/main/java/org/springframework/ai/azure/openai/AzureOpenAiImageModel.java

@@ -0,0 +1,190 @@
+package org.springframework.ai.azure.openai;
+
+import com.azure.ai.openai.OpenAIClient;
+import com.azure.ai.openai.models.ImageGenerationOptions;
+import com.azure.ai.openai.models.ImageGenerationQuality;
+import com.azure.ai.openai.models.ImageGenerationResponseFormat;
+import com.azure.ai.openai.models.ImageGenerationStyle;
+import com.azure.ai.openai.models.ImageSize;
+import com.fasterxml.jackson.core.JsonProcessingException;
+import com.fasterxml.jackson.databind.DeserializationFeature;
+import com.fasterxml.jackson.databind.ObjectMapper;
+import com.fasterxml.jackson.databind.SerializationFeature;
+import com.fasterxml.jackson.datatype.jsr310.JavaTimeModule;
+import org.slf4j.Logger;
+import org.slf4j.LoggerFactory;
+import org.springframework.ai.azure.openai.metadata.AzureOpenAiImageGenerationMetadata;
+import org.springframework.ai.azure.openai.metadata.AzureOpenAiImageResponseMetadata;
+import org.springframework.ai.image.Image;
+import org.springframework.ai.image.ImageGeneration;
+import org.springframework.ai.image.ImageModel;
+import org.springframework.ai.image.ImagePrompt;
+import org.springframework.ai.image.ImageResponse;
+import org.springframework.ai.image.ImageResponseMetadata;
+import org.springframework.ai.model.ModelOptionsUtils;
+import org.springframework.beans.factory.annotation.Autowired;
+import org.springframework.util.Assert;
+
+import java.util.List;
+
+import static java.lang.String.format;
+
+/**
+ * {@link ImageModel} implementation for {@literal Microsoft Azure AI} backed by
+ * {@link OpenAIClient}.
+ *
+ * @author Benoit Moussaud
+ * @see ImageModel
+ * @see com.azure.ai.openai.OpenAIClient
+ * @since 1.0.0 M1
+ */
+public class AzureOpenAiImageModel implements ImageModel {
+
+	private static final String DEFAULT_DEPLOYMENT_NAME = AzureOpenAiImageOptions.DEFAULT_IMAGE_MODEL;
+
+	private final Logger logger = LoggerFactory.getLogger(getClass());
+
+	@Autowired
+	private final OpenAIClient openAIClient;
+
+	private final AzureOpenAiImageOptions defaultOptions;
+
+	public AzureOpenAiImageModel(OpenAIClient openAIClient) {
+		this(openAIClient, AzureOpenAiImageOptions.builder().withDeploymentName(DEFAULT_DEPLOYMENT_NAME).build());
+	}
+
+	public AzureOpenAiImageModel(OpenAIClient microsoftOpenAiClient, AzureOpenAiImageOptions options) {
+		Assert.notNull(microsoftOpenAiClient, "com.azure.ai.openai.OpenAIClient must not be null");
+		Assert.notNull(options, "AzureOpenAiChatOptions must not be null");
+		this.openAIClient = microsoftOpenAiClient;
+		this.defaultOptions = options;
+	}
+
+	public AzureOpenAiImageOptions getDefaultOptions() {
+		return defaultOptions;
+	}
+
+	@Override
+	public ImageResponse call(ImagePrompt imagePrompt) {
+		ImageGenerationOptions imageGenerationOptions = toOpenAiImageOptions(imagePrompt);
+		String deploymentOrModelName = getDeploymentName(imagePrompt);
+		if (logger.isTraceEnabled()) {
+			logger.trace("Azure ImageGenerationOptions call {} with the following options : {} ", deploymentOrModelName,
+					toPrettyJson(imageGenerationOptions));
+		}
+
+		var images = openAIClient.getImageGenerations(deploymentOrModelName, imageGenerationOptions);
+
+		if (logger.isTraceEnabled()) {
+			logger.trace("Azure ImageGenerations: {}", toPrettyJson(images));
+		}
+
+		List<ImageGeneration> imageGenerations = images.getData().stream().map(entry -> {
+			var image = new Image(entry.getUrl(), entry.getBase64Data());
+			var metadata = new AzureOpenAiImageGenerationMetadata(entry.getRevisedPrompt());
+			return new ImageGeneration(image, metadata);
+		}).toList();
+
+		ImageResponseMetadata openAiImageResponseMetadata = AzureOpenAiImageResponseMetadata.from(images);
+		return new ImageResponse(imageGenerations, openAiImageResponseMetadata);
+	}
+
+	private String toPrettyJson(Object object) {
+		ObjectMapper objectMapper = new ObjectMapper().disable(DeserializationFeature.FAIL_ON_UNKNOWN_PROPERTIES)
+			.disable(SerializationFeature.FAIL_ON_EMPTY_BEANS)
+			.registerModule(new JavaTimeModule());
+		try {
+			return objectMapper.writeValueAsString(object);
+		}
+		catch (JsonProcessingException e) {
+			return "JsonProcessingException:" + e + " [" + object.toString() + "]";
+		}
+	}
+
+	/**
+	 * Return the deployment-name if provided or use the model name.
+	 * @param prompt the image prompt
+	 * @return Return the deployment-name if provided or use the model name.
+	 */
+	private String getDeploymentName(ImagePrompt prompt) {
+		var runtimeImageOptions = prompt.getOptions();
+
+		if (this.defaultOptions != null) {
+			// Merge options fixed in beta7
+			// https://github.com/Azure/azure-sdk-for-java/issues/38183
+			runtimeImageOptions = ModelOptionsUtils.merge(runtimeImageOptions, this.defaultOptions,
+					AzureOpenAiImageOptions.class);
+		}
+
+		if (runtimeImageOptions != null) {
+			if (runtimeImageOptions instanceof AzureOpenAiImageOptions runtimeAzureOpenAiImageOptions) {
+				if (runtimeAzureOpenAiImageOptions.getDeploymentName() != null) {
+					return runtimeAzureOpenAiImageOptions.getDeploymentName();
+				}
+			}
+
+		}
+
+		// By default the one provided in the image prompt
+		return prompt.getOptions().getModel();
+
+	}
+
+	private ImageGenerationOptions toOpenAiImageOptions(ImagePrompt prompt) {
+
+		if (prompt.getInstructions().size() > 1) {
+			throw new RuntimeException(format("implementation support 1 image instruction only, found %s",
+					prompt.getInstructions().size()));
+		}
+		if (prompt.getInstructions().isEmpty()) {
+			throw new RuntimeException("please provide image instruction, current is empty");
+		}
+
+		var instructions = prompt.getInstructions().get(0).getText();
+		var runtimeImageOptions = prompt.getOptions();
+		ImageGenerationOptions imageGenerationOptions = new ImageGenerationOptions(instructions);
+
+		if (this.defaultOptions != null) {
+			// Merge options fixed in beta7
+			// https://github.com/Azure/azure-sdk-for-java/issues/38183
+			runtimeImageOptions = ModelOptionsUtils.merge(runtimeImageOptions, this.defaultOptions,
+					AzureOpenAiImageOptions.class);
+		}
+
+		if (runtimeImageOptions != null) {
+			// Handle portable image options
+			if (runtimeImageOptions.getN() != null) {
+				imageGenerationOptions.setN(runtimeImageOptions.getN());
+			}
+			if (runtimeImageOptions.getModel() != null) {
+				imageGenerationOptions.setModel(runtimeImageOptions.getModel());
+			}
+			if (runtimeImageOptions.getResponseFormat() != null) {
+				// b64_json or url
+				imageGenerationOptions.setResponseFormat(
+						ImageGenerationResponseFormat.fromString(runtimeImageOptions.getResponseFormat()));
+			}
+			if (runtimeImageOptions.getWidth() != null && runtimeImageOptions.getHeight() != null) {
+				imageGenerationOptions.setSize(
+						ImageSize.fromString(runtimeImageOptions.getWidth() + "x" + runtimeImageOptions.getHeight()));
+			}
+
+			// Handle OpenAI specific image options
+			if (runtimeImageOptions instanceof AzureOpenAiImageOptions runtimeAzureOpenAiImageOptions) {
+				if (runtimeAzureOpenAiImageOptions.getQuality() != null) {
+					imageGenerationOptions
+						.setQuality(ImageGenerationQuality.fromString(runtimeAzureOpenAiImageOptions.getQuality()));
+				}
+				if (runtimeAzureOpenAiImageOptions.getStyle() != null) {
+					imageGenerationOptions
+						.setStyle(ImageGenerationStyle.fromString(runtimeAzureOpenAiImageOptions.getStyle()));
+				}
+				if (runtimeAzureOpenAiImageOptions.getUser() != null) {
+					imageGenerationOptions.setUser(runtimeAzureOpenAiImageOptions.getUser());
+				}
+			}
+		}
+		return imageGenerationOptions;
+	}
+
+}