このバージョンはまだ開発中であり、まだ安定しているとは考えられていません。最新のスナップショットバージョンについては、Spring AI 1.0.3 を使用してください。

モデレーション

導入

Spring AI は、Mistral AI が導入した新しいモデレーションサービスをサポートし、Mistral モデレーションモデルを基盤としています。これにより、複数のポリシー要素に基づいて有害なテキストコンテンツを検出できます。Mistral AI モデレーションモデルの詳細については、こちらのリンク (英語) を参照してください。

前提条件

  1. Mistral AI アカウントを作成し、API キーを取得してください。Mistral AI 登録ページ (英語) でサインアップし、API キーページ (英語) で API キーを生成できます。

  2. プロジェクトのビルドファイルに spring-ai-mistral-ai 依存関係を追加します。詳細については、依存関係管理セクションを参照してください。

自動構成

Spring AI 自動構成、スターターモジュールのアーティファクト名に大きな変更がありました。詳細については、アップグレードノートを参照してください。

Spring AI は、Mistral AI モデレーションモデル用の 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'
}
Spring AI BOM をビルドファイルに追加するには、"依存関係管理" セクションを参照してください。

モデレーションプロパティ

接続プロパティ

プレフィックス spring.ai.mistralai は、Mistral AI に接続できるようにするプロパティプレフィックスとして使用されます。

プロパティ

説明

デフォルト

spring.ai.mistralai.base-url

接続先の URL

api.mistral.ai (英語)

spring.ai.mistralai.api-key

API キー

-

プロパティの構成

モデレーションの自動構成の有効化と無効化は、プレフィックス spring.ai.model.moderation を持つ最上位プロパティを介して構成されるようになりました。

有効にするには、spring.ai.model.moderation=mistral (デフォルトで有効になっています)

無効にするには、spring.ai.model.moderation=none (またはミストラルと一致しない値)

この変更は、複数のモデルの構成を可能にするために行われます。

プレフィックス spring.ai.mistralai.moderation は、Mistral AI モデレーションモデルを構成するためのプロパティプレフィックスとして使用されます。

プロパティ

説明

デフォルト

spring.ai.model.moderation

モデレーションモデルを有効にする

ミストラル

spring.ai.mistralai.moderation.base-url

接続先の URL

api.mistral.ai (英語)

spring.ai.mistralai.moderation.api-key

API キー

-

spring.ai.mistralai.moderation.options.model

モデレーションに使用するモデルの ID。

mistral-moderation-latest

共通プロパティ spring.ai.mistralai.base-urlspring.ai.mistralai.api-key をオーバーライドできます。spring.ai.mistralai.moderation.base-urlspring.ai.mistralai.moderation.api-key が設定されている場合は、共通プロパティよりも優先されます。これは、異なるモデルや異なるモデルエンドポイントに異なる Mistral AI アカウントを使用する場合に便利です。
spring.ai.mistralai.moderation.options で始まるすべてのプロパティは、実行時にオーバーライドできます。

ランタイムオプション

MistralAiModerationOptions クラスは、モデレーションリクエストを行うときに使用するオプションを提供します。起動時には、spring.ai.mistralai.moderation で指定されたオプションが使用されますが、実行時にこれらを上書きできます。

例:

MistralAiModerationOptions moderationOptions = MistralAiModerationOptions.builder()
    .model("mistral-moderation-latest")
    .build();

ModerationPrompt moderationPrompt = new ModerationPrompt("Text to be moderated", this.moderationOptions);
ModerationResponse response = mistralAiModerationModel.call(this.moderationPrompt);

// Access the moderation results
Moderation moderation = moderationResponse.getResult().getOutput();

// Print general information
System.out.println("Moderation ID: " + moderation.getId());
System.out.println("Model used: " + moderation.getModel());

// Access the moderation results (there's usually only one, but it's a list)
for (ModerationResult result : moderation.getResults()) {
    System.out.println("\nModeration Result:");
    System.out.println("Flagged: " + result.isFlagged());

    // Access categories
    Categories categories = this.result.getCategories();
    System.out.println("\nCategories:");
    System.out.println("Law: " + categories.isLaw());
    System.out.println("Financial: " + categories.isFinancial());
    System.out.println("PII: " + categories.isPii());
    System.out.println("Sexual: " + categories.isSexual());
    System.out.println("Hate: " + categories.isHate());
    System.out.println("Harassment: " + categories.isHarassment());
    System.out.println("Self-Harm: " + categories.isSelfHarm());
    System.out.println("Sexual/Minors: " + categories.isSexualMinors());
    System.out.println("Hate/Threatening: " + categories.isHateThreatening());
    System.out.println("Violence/Graphic: " + categories.isViolenceGraphic());
    System.out.println("Self-Harm/Intent: " + categories.isSelfHarmIntent());
    System.out.println("Self-Harm/Instructions: " + categories.isSelfHarmInstructions());
    System.out.println("Harassment/Threatening: " + categories.isHarassmentThreatening());
    System.out.println("Violence: " + categories.isViolence());

    // Access category scores
    CategoryScores scores = this.result.getCategoryScores();
    System.out.println("\nCategory Scores:");
    System.out.println("Law: " + scores.getLaw());
    System.out.println("Financial: " + scores.getFinancial());
    System.out.println("PII: " + scores.getPii());
    System.out.println("Sexual: " + scores.getSexual());
    System.out.println("Hate: " + scores.getHate());
    System.out.println("Harassment: " + scores.getHarassment());
    System.out.println("Self-Harm: " + scores.getSelfHarm());
    System.out.println("Sexual/Minors: " + scores.getSexualMinors());
    System.out.println("Hate/Threatening: " + scores.getHateThreatening());
    System.out.println("Violence/Graphic: " + scores.getViolenceGraphic());
    System.out.println("Self-Harm/Intent: " + scores.getSelfHarmIntent());
    System.out.println("Self-Harm/Instructions: " + scores.getSelfHarmInstructions());
    System.out.println("Harassment/Threatening: " + scores.getHarassmentThreatening());
    System.out.println("Violence: " + scores.getViolence());
}

手動構成

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'
}
Spring AI BOM をビルドファイルに追加するには、"依存関係管理" セクションを参照してください。

次に、MistralAiModerationModel を作成します。

MistralAiModerationApi mistralAiModerationApi = new MistralAiModerationApi(System.getenv("MISTRAL_AI_API_KEY"));

MistralAiModerationModel mistralAiModerationModel = new MistralAiModerationModel(this.mistralAiModerationApi);

MistralAiModerationOptions moderationOptions = MistralAiModerationOptions.builder()
    .model("mistral-moderation-latest")
    .build();

ModerationPrompt moderationPrompt = new ModerationPrompt("Text to be moderated", this.moderationOptions);
ModerationResponse response = this.mistralAiModerationModel.call(this.moderationPrompt);

サンプルコード

MistralAiModerationModelIT テストでは、ライブラリの使用方法に関する一般的な例がいくつか提供されています。より詳細な使用例については、このテストを参照してください。