Mistral AI 埋め込み
Spring AI は、Mistral AI のテキスト埋め込みモデルをサポートしています。埋め込みは、高次元ベクトル空間での位置を通じて段落の意味を捉えるテキストのベクトル表現です。Mistral AI Embeddings API は、多くの NLP タスクに使用できる最先端のテキスト埋め込みを提供します。
前提条件
MistralAI 埋め込みモデルにアクセスするには、MistralAI を使用して API を作成する必要があります。
MistralAI 登録ページ (英語) でアカウントを作成し、API キーページ (英語) でトークンを生成します。Spring AI プロジェクトでは、console.mistral.ai から取得した API Key の値に設定する必要がある spring.ai.mistralai.api-key という構成プロパティが定義されています。環境変数をエクスポートすることは、その構成プロパティを設定する 1 つの方法です。
export SPRING_AI_MISTRALAI_API_KEY=<INSERT KEY HERE>自動構成
Spring AI は、MistralAI 埋め込みモデル用の Spring Boot 自動構成を提供します。これを有効にするには、プロジェクトの Maven pom.xml ファイルに次の依存関係を追加します。
<dependency>
<groupId>org.springframework.ai</groupId>
<artifactId>spring-ai-mistral-ai-spring-boot-starter</artifactId>
</dependency> または、Gradle build.gradle ビルドファイルに保存します。
dependencies {
implementation 'org.springframework.ai:spring-ai-mistral-ai-spring-boot-starter'
}| Spring AI BOM をビルドファイルに追加するには、"依存関係管理" セクションを参照してください。 |
埋め込みプロパティ
再試行プロパティ
プレフィックス spring.ai.retry は、Mistral AI 埋め込みモデルの再試行メカニズムを構成できるプロパティプレフィックスとして使用されます。
| プロパティ | 説明 | デフォルト |
|---|---|---|
spring.ai.retry.max-attempts | 再試行の最大回数。 | 10 |
spring.ai.retry.backoff.initial-interval | 指数関数的バックオフポリシーの初期スリープ期間。 | 2 秒 |
spring.ai.retry.backoff.multiplier | バックオフ間隔の乗数。 | 5 |
spring.ai.retry.backoff.max-interval | 最大バックオフ期間。 | 3 分 |
spring.ai.retry.on-client-errors | false の場合、NonTransientAiException をスローし、 | false |
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 は、MistralAI の EmbeddingModel 実装を構成するプロパティプレフィックスです。
| プロパティ | 説明 | デフォルト |
|---|---|---|
spring.ai.mistralai.embedding.enabled | OpenAI 埋め込みモデルを有効にします。 | true |
spring.ai.mistralai.embedding.base-url | オプションで spring.ai.mistralai.base-url をオーバーライドして、埋め込み固有の URL を提供します | - |
spring.ai.mistralai.embedding.api-key | オプションで spring.ai.mistralai.api-key をオーバーライドして、埋め込み固有の API キーを提供します | - |
spring.ai.mistralai.embedding.metadata-mode | ドキュメントコンテンツ抽出モード。 | EMBED |
spring.ai.mistralai.embedding.options.model | 使用するモデル | mistral-embed |
spring.ai.mistralai.embedding.options.encodingFormat | 埋め込みを返す形式。float または Base64 のいずれかにすることができます。 | - |
ChatModel および EmbeddingModel 実装の共通の spring.ai.mistralai.base-url および spring.ai.mistralai.api-key をオーバーライドできます。spring.ai.mistralai.embedding.base-url および spring.ai.mistralai.embedding.api-key プロパティが設定されている場合は、共通のプロパティよりも優先されます。同様に、spring.ai.mistralai.embedding.base-url および spring.ai.mistralai.embedding.api-key プロパティが設定されている場合は、共通のプロパティよりも優先されます。これは、異なるモデルおよび異なるモデルエンドポイントに異なる MistralAI アカウントを使用する場合に便利です。 |
spring.ai.mistralai.embedding.options というプレフィックスが付いたすべてのプロパティは、リクエスト固有のランタイムオプションを EmbeddingRequest 呼び出しに追加することで実行時にオーバーライドできます。 |
ランタイムオプション
MistralAiEmbeddingOptions.java [GitHub] (英語) は、使用するモデルなどの MistralAI 構成を提供します。
デフォルトのオプションは、spring.ai.mistralai.embedding.options プロパティを使用して構成することもできます。
開始時に、MistralAiEmbeddingModel コンストラクターを使用して、すべての埋め込みリクエストに使用されるデフォルトのオプションを設定します。実行時に、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()));サンプルコントローラー
これにより、クラスに注入できる EmbeddingModel 実装が作成されます。以下は、EmbeddingModel 実装を使用する単純な @Controller クラスの例です。
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-ai-mistral-ai 依存関係を追加します。
<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'
}| Spring AI BOM をビルドファイルに追加するには、"依存関係管理" セクションを参照してください。 |
spring-ai-mistral-ai 依存関係により、MistralAiChatModel へのアクセスも提供されます。MistralAiChatModel の詳細については、MistralAI チャットクライアントセクションを参照してください。 |
次に、MistralAiEmbeddingModel インスタンスを作成し、それを使用して 2 つの入力テキスト間の類似性を計算します。
var mistralAiApi = new MistralAiApi(System.getenv("MISTRAL_AI_API_KEY"));
var embeddingModel = new MistralAiEmbeddingModel(mistralAiApi,
MistralAiEmbeddingOptions.builder()
.withModel("mistral-embed")
.withEncodingFormat("float")
.build());
EmbeddingResponse embeddingResponse = embeddingModel
.embedForResponse(List.of("Hello World", "World is big and salvation is near"));MistralAiEmbeddingOptions は、埋め込みリクエストの構成情報を提供します。オプションクラスは、オプションを簡単に作成できる builder() を提供します。
