| 此版本仍在开发中,尚未被视为稳定版本。最新的快照版本请使用 Spring AI 1.0.0-SNAPSHOT! | 
Mistral AI 嵌入
Spring AI 支持 Mistral AI 的文本嵌入模型。 嵌入是文本的矢量表示形式,它通过段落在高维向量空间中的位置来捕获段落的语义含义。Mistral AI Embeddings API 为文本提供尖端、最先进的嵌入,可用于许多 NLP 任务。
先决条件
您需要使用 MistralAI 创建一个 API 才能访问 MistralAI 嵌入模型。
在 MistralAI 注册页面创建一个帐户,并在 API 密钥页面上生成令牌。
Spring AI 项目定义了一个名为spring.ai.mistralai.api-key,您应该设置为API Key从 console.mistral.ai 获得。
导出环境变量是设置该配置属性的一种方法:
export SPRING_AI_MISTRALAI_API_KEY=<INSERT KEY HERE>添加存储库和 BOM
Spring AI 工件发布在 Maven Central 和 Spring Snapshot 存储库中。 请参阅 Repositories 部分,将这些存储库添加到您的构建系统中。
为了帮助进行依赖项管理,Spring AI 提供了一个 BOM(物料清单),以确保在整个项目中使用一致的 Spring AI 版本。请参阅依赖项管理部分,将 Spring AI BOM 添加到您的构建系统中。
自动配置
Spring AI 为 MistralAI 嵌入模型提供 Spring Boot 自动配置。
要启用它,请将以下依赖项添加到项目的 Maven 中pom.xml文件:
<dependency>
    <groupId>org.springframework.ai</groupId>
    <artifactId>spring-ai-mistral-ai-spring-boot-starter</artifactId>
</dependency>或发送到您的 Gradlebuild.gradlebuild 文件。
dependencies {
    implementation 'org.springframework.ai:spring-ai-mistral-ai-spring-boot-starter'
}| 请参阅 Dependency Management 部分,将 Spring AI BOM 添加到您的构建文件中。 | 
嵌入属性
重试属性
前缀spring.ai.retry用作属性前缀,允许您为 Mistral AI Embedding 模型配置重试机制。
| 财产 | 描述 | 违约 | 
|---|---|---|
| spring.ai.retry.max 次尝试 | 最大重试尝试次数。 | 10 | 
| spring.ai.retry.backoff.initial-interval | 指数回退策略的初始休眠持续时间。 | 2 秒 | 
| spring.ai.retry.backoff.multiplier | Backoff interval 乘数。 | 5 | 
| spring.ai.retry.backoff.max 间隔 | 最大回退持续时间。 | 3 分钟 | 
| spring.ai.retry.on-client-errors | 如果为 false,则抛出 NonTransientAiException,并且不要尝试重试 | 假 | 
| spring.ai.retry.exclude-on-http-codes | 不应触发重试的 HTTP 状态代码列表(例如,引发 NonTransientAiException)。 | 空 | 
| spring.ai.retry.on-http-codes | 应触发重试的 HTTP 状态代码列表(例如,引发 TransientAiException)。 | 空 | 
连接属性
前缀spring.ai.mistralai用作允许您连接到 MistralAI 的属性前缀。
| 财产 | 描述 | 违约 | 
|---|---|---|
| spring.ai.mistralai.base-url | 要连接到的 URL | |
| spring.ai.mistralai.api-key | API 密钥 | - | 
配置属性
前缀spring.ai.mistralai.embedding是属性前缀,该前缀配置EmbeddingModelMistralAI 的实现。
| 财产 | 描述 | 违约 | 
|---|---|---|
| spring.ai.mistralai.embedding.enabled | 启用 OpenAI 嵌入模型。 | 真 | 
| spring.ai.mistralai.embedding.base-url | 可选覆盖spring.ai.mistralai.base-url以提供嵌入特定的 url | - | 
| spring.ai.mistralai.embedding.api-key | 可选覆盖spring.ai.mistralai.api-key以提供嵌入特定的 api-key | - | 
| spring.ai.mistralai.embedding.metadata-mode | 文档内容提取模式。 | 嵌入 | 
| spring.ai.mistralai.embedding.options.model | 要使用的模型 | Mistral-嵌入 | 
| spring.ai.mistralai.embedding.options.encodingFormat | 要返回嵌入向量的格式。可以是 float 或 base64。 | - | 
| 您可以覆盖常见的 spring.ai.mistralai.base-url和spring.ai.mistralai.api-key对于ChatModel和EmbeddingModel实现。
这spring.ai.mistralai.embedding.base-url和spring.ai.mistralai.embedding.api-key如果设置了 properties,则优先于 common properties。
同样,spring.ai.mistralai.chat.base-url和spring.ai.mistralai.chat.api-key如果设置了 properties,则优先于 common properties。
如果您想为不同的模型和不同的模型终端节点使用不同的 MistralAI 帐户,这将非常有用。 | 
| 所有前缀为 spring.ai.mistralai.embedding.options可以通过将特定于请求的运行时选项添加到EmbeddingRequest叫。 | 
运行时选项
MistralAiEmbeddingOptions.java 提供 MistralAI 配置,例如要使用的模型等。
默认选项可以使用spring.ai.mistralai.embedding.optionsproperties 也是如此。
启动时,使用MistralAiEmbeddingModelconstructor 设置用于所有嵌入请求的默认选项。
在运行时,您可以使用MistralAiEmbeddingOptions实例作为EmbeddingRequest.
例如,要覆盖特定请求的默认模型名称:
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()));Samples控制器
这将创建一个EmbeddingModel实现,您可以将其注入到您的类中。
下面是一个简单的示例@Controller类使用EmbeddingModel实现。
spring.ai.mistralai.api-key=YOUR_API_KEY
spring.ai.mistralai.embedding.options.model=mistral-embed@RestController
public class EmbeddingController {
    private final EmbeddingModel embeddingModel;
    @Autowired
    public EmbeddingController(EmbeddingModel embeddingModel) {
        this.embeddingModel = embeddingModel;
    }
    @GetMapping("/ai/embedding")
    public Map embed(@RequestParam(value = "message", defaultValue = "Tell me a joke") String message) {
        var embeddingResponse = this.embeddingModel.embedForResponse(List.of(message));
        return Map.of("embedding", embeddingResponse);
    }
}手动配置
如果您不使用 Spring Boot,则可以手动配置 OpenAI 嵌入模型。
为此,请添加spring-ai-mistral-ai依赖项添加到项目的 Mavenpom.xml文件:
<dependency>
    <groupId>org.springframework.ai</groupId>
    <artifactId>spring-ai-mistral-ai</artifactId>
</dependency>或发送到您的 Gradlebuild.gradlebuild 文件。
dependencies {
    implementation 'org.springframework.ai:spring-ai-mistral-ai'
}| 请参阅 Dependency Management 部分,将 Spring AI BOM 添加到您的构建文件中。 | 
| 这 spring-ai-mistral-aidependency 还提供对MistralAiChatModel.
有关MistralAiChatModel请参阅 MistralAI 聊天客户端部分。 | 
接下来,创建一个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"));这MistralAiEmbeddingOptions提供嵌入请求的配置信息。
options 类提供了一个builder()轻松创建选项。