Mistral AI 嵌入

Spring AI 支持 Mistral AI 的文本嵌入模型。 嵌入是文本的矢量表示,通过段落在高维向量空间中的位置捕捉其语义意义。Mistral AI 嵌入 API 提供前沿、最先进的文本嵌入,可用于多种自然语言处理任务。spring-doc.cadn.net.cn

可选型号

Mistral AI 提供了两种嵌入模型,分别针对不同用例进行了优化:spring-doc.cadn.net.cn

尺寸 用例 描述

米斯特拉尔嵌入spring-doc.cadn.net.cn

1024spring-doc.cadn.net.cn

正文spring-doc.cadn.net.cn

适用于语义搜索、聚类和文本相似性任务的通用嵌入模型。非常适合自然语言内容。spring-doc.cadn.net.cn

codestral嵌入spring-doc.cadn.net.cn

1536spring-doc.cadn.net.cn

法典spring-doc.cadn.net.cn

专门的嵌入模型,针对代码相似性、代码搜索和检索增强生成(RAG)进行了优化,并与代码仓库相匹配。提供专门为理解代码语义设计的高维嵌入。spring-doc.cadn.net.cn

选择模型时:spring-doc.cadn.net.cn

前提条件

你需要用 MistralAI 创建一个 API 来访问 MistralAI 的嵌入模型。spring-doc.cadn.net.cn

MistralAI注册页面创建账户,并在API密钥页面生成Tokens。spring-doc.cadn.net.cn

Spring AI 项目定义了一个配置属性,名为spring.ai.mistralai.api-key你应该设置为API 密钥摘自 console.mistral.ai。spring-doc.cadn.net.cn

你可以在你的application.properties文件:spring-doc.cadn.net.cn

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

为了在处理敏感信息如 API 密钥时增强安全性,您可以使用 Spring 表达式语言(SpEL)引用环境变量:spring-doc.cadn.net.cn

# 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>

你也可以在应用代码中编程设置此配置:spring-doc.cadn.net.cn

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

添加仓库和物料清单

Spring AI 产物发布于 Maven Central 和 Spring Snapshot 仓库中。 请参阅神器仓库部分,将这些仓库添加到你的构建系统中。spring-doc.cadn.net.cn

为帮助依赖管理,Spring AI 提供了物料清单(BOM),确保整个项目中使用一致版本的 Spring AI。请参考依赖管理部分,将春季AI物料清单添加到你的构建系统中。spring-doc.cadn.net.cn

自动配置

春季AI自动配置、起始模块的工件名称发生了重大变化。 更多信息请参阅升级说明spring-doc.cadn.net.cn

Spring AI 为 MistralAI 嵌入模型提供 Spring Boot 自动配置。 要启用它,请在项目的Maven中添加以下依赖pom.xml文件:spring-doc.cadn.net.cn

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

或者去你的Gradlebuild.gradle构建文件。spring-doc.cadn.net.cn

dependencies {
    implementation 'org.springframework.ai:spring-ai-starter-model-mistral-ai'
}
请参考依赖管理部分,将Spring AI的物料清单添加到你的构建文件中。

嵌入性质

重试属性

前缀spring.ai.retry作为属性前缀,允许你配置Mistral AI嵌入模型的重试机制。spring-doc.cadn.net.cn

属性 描述 默认值

spring.ai.retry.max尝试spring-doc.cadn.net.cn

重试次数上限。spring-doc.cadn.net.cn

10spring-doc.cadn.net.cn

spring.ai.retry.backoff.initial-intervalspring-doc.cadn.net.cn

指数式退避政策的初始睡眠时长。spring-doc.cadn.net.cn

两秒钟。spring-doc.cadn.net.cn

spring.ai.retry.backoff.multiplierspring-doc.cadn.net.cn

后退间隔倍数。spring-doc.cadn.net.cn

5spring-doc.cadn.net.cn

spring.ai.retry.backoff.max区间spring-doc.cadn.net.cn

最大退回时间。spring-doc.cadn.net.cn

3分钟。spring-doc.cadn.net.cn

spring.ai.retry.on-client-errorsspring-doc.cadn.net.cn

如果为假,抛出非瞬态AiException,且不要尝试重试4xx客户端错误代码spring-doc.cadn.net.cn

falsespring-doc.cadn.net.cn

spring.ai.retry.exclude-on-http-codesspring-doc.cadn.net.cn

不应该触发重试的HTTP状态码列表(例如抛出非瞬态Ai异常)。spring-doc.cadn.net.cn

emptyspring-doc.cadn.net.cn

spring.ai.retry.on-http-codesspring-doc.cadn.net.cn

应触发重试的HTTP状态码列表(例如抛出TransientAiException)。spring-doc.cadn.net.cn

emptyspring-doc.cadn.net.cn

连接性质

前缀春.ai.mistralai作为属性前缀,允许你连接到MistralAI。spring-doc.cadn.net.cn

属性 描述 默认值

Spring.ai.mistralai.base-urlspring-doc.cadn.net.cn

连接的URL(链接)spring-doc.cadn.net.cn

api.mistral.aispring-doc.cadn.net.cn

spring.ai.mistralai.api-keyspring-doc.cadn.net.cn

API 密钥spring-doc.cadn.net.cn

-spring-doc.cadn.net.cn

配置属性

嵌入自动配置的启用和禁用现在通过带有前缀的顶层属性配置spring.ai.model.embedding.spring-doc.cadn.net.cn

启用时,spring.ai.model.embedding=mistral(默认启用)spring-doc.cadn.net.cn

要禁用,可以使用spring.ai.model.embedding=none(或任何与Mistral不匹配的值)spring-doc.cadn.net.cn

此改动旨在允许配置多个模型。spring-doc.cadn.net.cn

前缀spring.ai.mistralai.embedding是配置嵌入模型MistralAI 的实现。spring-doc.cadn.net.cn

属性 描述 默认值

spring.ai.mistralai.embedding.enabled(已移除且不再有效)spring-doc.cadn.net.cn

启用OpenAI嵌入模型。spring-doc.cadn.net.cn

truespring-doc.cadn.net.cn

spring.ai.model.embeddingspring-doc.cadn.net.cn

启用OpenAI嵌入模型。spring-doc.cadn.net.cn

密斯特拉尔spring-doc.cadn.net.cn

spring.ai.mistralai.embedding.base-urlspring-doc.cadn.net.cn

可选覆盖 spring.ai.mistralai.base-url,提供嵌入专用的 URLspring-doc.cadn.net.cn

-spring-doc.cadn.net.cn

spring.ai.mistralai.embedding.api-keyspring-doc.cadn.net.cn

可选覆盖 spring.ai.mistralai.api-key,提供嵌入专用的 api key。spring-doc.cadn.net.cn

-spring-doc.cadn.net.cn

spring.ai.mistralai.embedding.metadata-modespring-doc.cadn.net.cn

文档内容提取模式。spring-doc.cadn.net.cn

嵌入spring-doc.cadn.net.cn

spring.ai.mistralai.embedding.options.modelspring-doc.cadn.net.cn

应采用的模型spring-doc.cadn.net.cn

米斯特拉尔嵌入spring-doc.cadn.net.cn

spring.ai.mistralai.embedding.options.encodingFormatspring-doc.cadn.net.cn

格式是如何返回嵌入的。可以是float或者base64。spring-doc.cadn.net.cn

-spring-doc.cadn.net.cn

你可以覆盖公共信息Spring.ai.mistralai.base-urlspring.ai.mistralai.api-key对于聊天模型嵌入模型实现。 这spring.ai.mistralai.embedding.base-urlspring.ai.mistralai.embedding.api-key如果设置了属性,属性优先于常见属性。 同样,spring.ai.mistralai.chat.base-urlspring.ai.mistralai.chat.api-key如果设置了属性,属性优先于常见属性。 如果你想为不同模型和不同模型端点使用不同的 MistralAI 账户,这非常有用。
所有以spring.ai.mistralai.embedding.options可以通过在运行时为 在嵌入请求叫。

运行时选项

MistralAiEmbeddingOptions.java提供了MistralAI的配置,比如使用模型等。spring-doc.cadn.net.cn

默认选项可以通过以下方式配置spring.ai.mistralai.embedding.options房产也是。spring-doc.cadn.net.cn

在开始时使用MistralAiEmbeddingModel构建器(constructor)来设置所有嵌入请求的默认选项。 运行时你可以通过MistralAiEmbeddingOptions实例作为你的一部分嵌入请求.spring-doc.cadn.net.cn

例如,要覆盖特定请求的默认型号名称:spring-doc.cadn.net.cn

// Using mistral-embed for general text
EmbeddingResponse textEmbeddingResponse = embeddingModel.call(
    new EmbeddingRequest(List.of("Hello World", "World is big and salvation is near"),
        MistralAiEmbeddingOptions.builder()
            .withModel("mistral-embed")
        .build()));

// Using codestral-embed for code
EmbeddingResponse codeEmbeddingResponse = embeddingModel.call(
    new EmbeddingRequest(List.of("public class HelloWorld {}", "def hello_world():"),
        MistralAiEmbeddingOptions.builder()
            .withModel("codestral-embed")
        .build()));

采样控制器

这将产生嵌入模型你可以把这些实现注入到你的类里。 这里有一个简单的例子@Controller使用嵌入模型实现。spring-doc.cadn.net.cn

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 嵌入模型。 为此添加春艾米斯特拉尔艾对你项目Maven的依赖pom.xml文件:spring-doc.cadn.net.cn

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

或者去你的Gradlebuild.gradle构建文件。spring-doc.cadn.net.cn

dependencies {
    implementation 'org.springframework.ai:spring-ai-mistral-ai'
}
请参考依赖管理部分,将Spring AI的物料清单添加到你的构建文件中。
春艾米斯特拉尔艾依赖还提供访问MistralAiChatModel. 欲了解更多关于MistralAiChatModel请参阅MistralAI聊天客户端部分。

接下来,创建一个MistralAiEmbeddingModel实例并用它来计算两个输入文本之间的相似性:spring-doc.cadn.net.cn

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提供嵌入请求的配置信息。 期权类提供架构商()方便创建期权。spring-doc.cadn.net.cn