Add Mistral AI Medium and Saba models

- Add Mistral Medium Latest model to ChatModel
- Add Mistral Saba Latest model to ChatModel
- Rename Ministraux models from ChatModel
- Improve javadoc and update documentation links
- Add small code enhancements

Signed-off-by: Nicolas Krier <[email protected]>

Author: nicolaskrier

models/spring-ai-mistral-ai/src/main/java/org/springframework/ai/mistralai/api/MistralAiApi.java

@@ -153,7 +153,7 @@ public <T> ResponseEntity<EmbeddingList<Embedding>> embeddings(EmbeddingRequest<
 
 		// The input must not an empty string, and any array must be 1024 dimensions or
 		// less.
-		if (embeddingRequest.input() instanceof List list) {
+		if (embeddingRequest.input() instanceof List<?> list) {
 			Assert.isTrue(!CollectionUtils.isEmpty(list), "The input list can not be empty.");
 			Assert.isTrue(list.size() <= 1024, "The list must be 1024 dimensions or less");
 			Assert.isTrue(
@@ -269,28 +269,28 @@ public enum ChatCompletionFinishReason {
 
 	/**
 	 * List of well-known Mistral chat models.
-	 * https://docs.mistral.ai/platform/endpoints/#mistral-ai-generative-models
 	 *
-	 * <p>
-	 * Mistral AI provides two types of models: open-weights models (Mistral 7B, Mixtral
-	 * 8x7B, Mixtral 8x22B) and optimized commercial models (Mistral Small, Mistral
-	 * Medium, Mistral Large, and Mistral Embeddings).
+	 * @see <a href=
+	 * "https://docs.mistral.ai/getting-started/models/models_overview/">Mistral AI Models
+	 * Overview</a>
 	 */
 	public enum ChatModel implements ChatModelDescription {
 
 		// @formatter:off
 		// Premier Models
 		CODESTRAL("codestral-latest"),
 		LARGE("mistral-large-latest"),
+		MEDIUM("mistral-medium-latest"),
+		MINISTRAL_3B("ministral-3b-latest"),
+		MINISTRAL_8B("ministral-8b-latest"),
 		PIXTRAL_LARGE("pixtral-large-latest"),
-		MINISTRAL_3B_LATEST("ministral-3b-latest"),
-		MINISTRAL_8B_LATEST("ministral-8b-latest"),
+		SABA("mistral-saba-latest"),
 		// Free Models
-		SMALL("mistral-small-latest"),
 		PIXTRAL("pixtral-12b-2409"),
+		SMALL("mistral-small-latest"),
 		// Free Models - Research
-		OPEN_MISTRAL_NEMO("open-mistral-nemo"),
-		OPEN_CODESTRAL_MAMBA("open-codestral-mamba");
+		OPEN_CODESTRAL_MAMBA("open-codestral-mamba"),
+		OPEN_MISTRAL_NEMO("open-mistral-nemo");
 		// @formatter:on
 
 		private final String value;
@@ -312,11 +312,15 @@ public String getName() {
 
 	/**
 	 * List of well-known Mistral embedding models.
-	 * https://docs.mistral.ai/platform/endpoints/#mistral-ai-embedding-model
+	 *
+	 * @see <a href=
+	 * "https://docs.mistral.ai/getting-started/models/models_overview/">Mistral AI Models
+	 * Overview</a>
 	 */
 	public enum EmbeddingModel {
 
 		// @formatter:off
+		// Premier Models
 		EMBED("mistral-embed");
 		 // @formatter:on
 
@@ -820,8 +824,7 @@ public String content() {
 		}
 
 		/**
-		 * The role of the author of this message.
-		 *
+		 * The role of the author of this message. <br/>
 		 * NOTE: Mistral expects the system message to be before the user message or will
 		 * fail with 400 error.
 		 */

models/spring-ai-mistral-ai/src/main/java/org/springframework/ai/mistralai/api/MistralAiModerationApi.java

@@ -33,7 +33,7 @@
  * MistralAI Moderation API.
  *
  * @author Ricken Bazolo
- * @see <a href= "https://docs.mistral.ai/capabilities/guardrailing/</a>
+ * @see <a href= "https://docs.mistral.ai/capabilities/guardrailing/">Moderation</a>
  */
 public class MistralAiModerationApi {
 
@@ -71,9 +71,17 @@ public ResponseEntity<MistralAiModerationResponse> moderate(MistralAiModerationR
 			.toEntity(MistralAiModerationResponse.class);
 	}
 
+	/**
+	 * List of well-known Mistral moderation models.
+	 *
+	 * @see <a href=
+	 * "https://docs.mistral.ai/getting-started/models/models_overview/">Mistral AI Models
+	 * Overview</a>
+	 */
 	public enum Model {
 
 		// @formatter:off
+		// Premier Models
 		MISTRAL_MODERATION("mistral-moderation-latest");
 		// @formatter:on
 

models/spring-ai-mistral-ai/src/test/java/org/springframework/ai/mistralai/MistralAiChatClientIT.java

@@ -16,17 +16,10 @@
 
 package org.springframework.ai.mistralai;
 
-import java.util.Arrays;
-import java.util.List;
-import java.util.Map;
-import java.util.stream.Collectors;
-
 import org.junit.jupiter.api.Test;
 import org.junit.jupiter.api.condition.EnabledIfEnvironmentVariable;
 import org.slf4j.Logger;
 import org.slf4j.LoggerFactory;
-import reactor.core.publisher.Flux;
-
 import org.springframework.ai.chat.client.ChatClient;
 import org.springframework.ai.chat.client.advisor.SimpleLoggerAdvisor;
 import org.springframework.ai.chat.messages.UserMessage;
@@ -43,6 +36,13 @@
 import org.springframework.core.ParameterizedTypeReference;
 import org.springframework.core.convert.support.DefaultConversionService;
 import org.springframework.core.io.Resource;
+import reactor.core.publisher.Flux;
+
+import java.util.Arrays;
+import java.util.Collections;
+import java.util.List;
+import java.util.Map;
+import java.util.stream.Collectors;
 
 import static org.assertj.core.api.Assertions.assertThat;
 
@@ -53,7 +53,7 @@ class MistralAiChatClientIT {
 	private static final Logger logger = LoggerFactory.getLogger(MistralAiChatClientIT.class);
 
 	@Autowired
-	MistralAiChatModel chatModel;
+	private MistralAiChatModel chatModel;
 
 	@Value("classpath:/prompts/system-message.st")
 	private Resource systemTextResource;
@@ -290,9 +290,7 @@ void streamFunctionCallTest() {
 
 	@Test
 	void validateCallResponseMetadata() {
-		// String model = MistralAiApi.ChatModel.OPEN_MISTRAL_7B.getName();
-		String model = MistralAiApi.ChatModel.PIXTRAL.getName();
-		// String model = MistralAiApi.ChatModel.PIXTRAL_LARGE.getName();
+		String model = selectChatModelName();
 		// @formatter:off
 		ChatResponse response = ChatClient.create(this.chatModel).prompt()
 				.options(MistralAiChatOptions.builder().model(model).build())
@@ -301,6 +299,7 @@ void validateCallResponseMetadata() {
 				.chatResponse();
 		// @formatter:on
 
+		assertThat(response).isNotNull();
 		logger.info(response.toString());
 		assertThat(response.getMetadata().getId()).isNotEmpty();
 		assertThat(response.getMetadata().getModel()).containsIgnoringCase(model);
@@ -309,6 +308,15 @@ void validateCallResponseMetadata() {
 		assertThat(response.getMetadata().getUsage().getTotalTokens()).isPositive();
 	}
 
+	private static String selectChatModelName() {
+		var chatModels = Arrays.asList(MistralAiApi.ChatModel.values());
+		Collections.shuffle(chatModels);
+		var chatModelName = chatModels.get(0).getName();
+		logger.info("Selected chat model name: {}", chatModelName);
+
+		return chatModelName;
+	}
+
 	record ActorsFilms(String actor, List<String> movies) {
 
 	}

models/spring-ai-mistral-ai/src/test/java/org/springframework/ai/mistralai/api/MistralAiApiIT.java

@@ -39,9 +39,9 @@
  * @since 0.8.1
  */
 @EnabledIfEnvironmentVariable(named = "MISTRAL_AI_API_KEY", matches = ".+")
-public class MistralAiApiIT {
+class MistralAiApiIT {
 
-	MistralAiApi mistralAiApi = new MistralAiApi(System.getenv("MISTRAL_AI_API_KEY"));
+	private final MistralAiApi mistralAiApi = new MistralAiApi(System.getenv("MISTRAL_AI_API_KEY"));
 
 	@Test
 	void chatCompletionEntity() {
@@ -61,7 +61,7 @@ void chatCompletionEntityWithSystemMessage() {
 				You are an AI assistant that helps people find information.
 				Your name is Bob.
 				You should reply to the user's request with your name and also in the style of a pirate.
-					""", Role.SYSTEM);
+				""", Role.SYSTEM);
 
 		ResponseEntity<ChatCompletion> response = this.mistralAiApi.chatCompletionEntity(new ChatCompletionRequest(
 				List.of(systemMessage, userMessage), MistralAiApi.ChatModel.SMALL.getValue(), 0.8, false));
@@ -83,9 +83,10 @@ void chatCompletionStream() {
 	@Test
 	void embeddings() {
 		ResponseEntity<EmbeddingList<Embedding>> response = this.mistralAiApi
-			.embeddings(new MistralAiApi.EmbeddingRequest<String>("Hello world"));
+			.embeddings(new MistralAiApi.EmbeddingRequest<>("Hello world"));
 
 		assertThat(response).isNotNull();
+		assertThat(response.getBody()).isNotNull();
 		assertThat(response.getBody().data()).hasSize(1);
 		assertThat(response.getBody().data().get(0).embedding()).hasSize(1024);
 	}