Mistral AI

Mistral AI Embeddings

Spring AI 支持 Mistral AI 的文本嵌入模型。嵌入是文本的向量化表示，通过其在高维向量空间中的位置捕捉段落的语义意义。Mistral AI 嵌入 API 提供了前沿的、最先进的文本嵌入技术，可应用于多种自然语言处理任务。

前提条件（Prerequisites）

您需要创建一个与 MistralAI 对接的 API，以便访问 MistralAI 的嵌入模型。

在 MistralAI 注册页面 创建账户，并在 API 密钥页面 生成令牌。

Spring AI 项目定义了一个名为 spring.ai.mistralai.api-key 的配置属性，您应将其设置为从 console.mistral.ai 获取的 API 密钥的值。

您可以在 application.properties 文件中设置此配置属性：

spring.ai.mistralai.api-key=<your-mistralai-api-key>

为了提高处理 API 密钥等敏感信息时的安全性，可以使用 Spring Expression Language (SpEL) 来引用环境变量：

# In application.yml
spring:
  ai:
    mistralai:
      api-key: ${MISTRALAI_API_KEY}

# In your environment or .env file
export MISTRALAI_API_KEY=<your-mistralai-api-key>

您也可以在应用程序代码中以编程方式设置此配置：

// Retrieve API key from a secure source or environment variable
String apiKey = System.getenv("MISTRALAI_API_KEY");

添加存储库和 BOM

Spring AI 工件发布在 Spring Milestone 和 Snapshot 存储库中。请参阅存储库部分将这些存储库添加到您的构建系统中。

为了帮助进行依赖管理，Spring AI 提供了 BOM（物料清单），以确保在整个项目中使用一致的 Spring AI 版本。请参阅依赖管理部分将 Spring AI BOM 添加到您的构建系统。

自动配置（Auto-configuration）

Spring AI 为 MistralAI 嵌入模型提供了 Spring Boot 自动配置。要启用此功能，请将以下依赖项添加到项目的 Maven pom.xml 文件中：

<dependency>
    <groupId>org.springframework.ai</groupId>
    <artifactId>spring-ai-starter-model-mistral-ai</artifactId>
</dependency>

或者，在你的 Gradle 构建文件 build.gradle 中添加：

dependencies {
    implementation 'org.springframework.ai:spring-ai-starter-model-mistral-ai'
}

嵌入属性（Embedding Properties）

Retry 属性（Retry Properties）

前缀 spring.ai.retry 用作属性前缀，允许您为 Mistral AI 模型配置 retry 机制。

连接属性（Connection Properties）

前缀是 spring.ai.mistralai 的属性，用于配置 Mistra AI 的链接。

配置属性（Configuration Properties）

前缀是 spring.ai.mistralai.embedding 的属性，用于配置 Mistra AI 的 EmbeddingModel 实现。

运行时选项（Runtime Options ）

MistralAiEmbeddingOptions.java 提供了嵌入请求的配置信息，并提供了一个构建器来创建这些选项。

默认选项也可以通过配置 spring.ai.mistralai.embedding.options 属性来进行设置。

在启动时，使用 MistralAiEmbeddingModel 构造函数来设置所有嵌入请求默认使用的选项。在运行时，您可以通过在 EmbeddingRequest 中使用 MistralAiEmbeddingOptions 实例来覆盖这些默认选项。

例如，要为特定请求覆盖默认模型名称：

EmbeddingResponse embeddingResponse = embeddingModel.call(
    new EmbeddingRequest(List.of("Hello World", "World is big and salvation is near"),
        MistralAiEmbeddingOptions.builder()
            .withModel("Different-Embedding-Model-Deployment-Name")
        .build()));

示例控制器（Sample Controller）

创建一个新的 Spring Boot 项目，并将 spring-ai-starter-model-mistral-ai 添加到 pom (或 gradle) 依赖项中。

在 src/main/resources 目录下添加 application.properties 文件，以启用和配置 Mistra AI 的 Embedding 模型：

spring.ai.mistralai.api-key=YOUR_API_KEY
spring.ai.mistralai.embedding.options.model=mistral-embed

这将创建一个 MistralAiEmbeddingModel 的实现，你可以将其注入到你的类中。下面是一个简单的 @Controller 类的示例，它使用聊天模型进行文本生成。

@RestController
public class EmbeddingController {

    private final MistralAiEmbeddingModel embeddingModel;

    @Autowired
    public EmbeddingController(MistralAiEmbeddingModel embeddingModel) {
        this.embeddingModel = embeddingModel;
    }

    @GetMapping("/v1/embedding")
    public Map<String, Object> embedding(@RequestParam(value = "message", defaultValue = "Tell me a joke") String message) {
        return Map.of("embeddings", embeddingModel.embed(message));
    }

}

手动配置（Manual Configuration）

MistralAiEmbeddingModel 实现了 EmbeddingModel , 并使用轻量级 MistralAiApi 客户端连接到 Mistral Ai 服务。

要启用它，添加 spring-ai-mistral-ai 依赖到你的项目 Maven pom.xml 文件:

<dependency>
    <groupId>org.springframework.ai</groupId>
    <artifactId> spring-ai-mistral-ai</artifactId>
</dependency>

或者，在你的 Gradle 构建文件 build.gradle 中添加：

dependencies {
    implementation 'org.springframework.ai: spring-ai-mistral-ai'
}

接下来，创建一个 MistralAiEmbeddingModel 并将其用于文本嵌入：

 var mistralAiApi = new MistralAiApi(System.getenv("MISTRAL_AI_API_KEY"));

var embeddingModel = new MistralAiEmbeddingModel(this.mistralAiApi,
        MistralAiEmbeddingOptions.builder()
                .withModel("mistral-embed")
                .withEncodingFormat("float")
                .build());

EmbeddingResponse embeddingResponse = this.embeddingModel
        .embedForResponse(List.of("Hello World", "World is big and salvation is near"));