稽核

簡介

Spring AI 支援 Mistral AI 推出的由 Mistral Moderation 模型提供支援的新內容稽核服務。它能夠檢測多個策略維度上的有害文字內容。有關 Mistral AI 內容稽核模型的更多資訊，請點選此連結。

先決條件

建立一個 Mistral AI 賬戶並獲取一個 API 金鑰。您可以在Mistral AI 註冊頁面註冊，並在API 金鑰頁面生成一個 API 金鑰。
將 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（或任何不匹配 mistral 的值）

此更改是為了允許配置多個模型。

字首 spring.ai.mistralai.moderation 用作配置 Mistral AI 內容稽核模型的屬性字首。

財產

描述

預設值

spring.ai.model.moderation

啟用內容稽核模型

mistral

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-url、spring.ai.mistralai.api-key 屬性。如果設定了 spring.ai.mistralai.moderation.base-url、spring.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 測試提供了一些如何使用該庫的通用示例。您可以參考此測試以獲取更詳細的使用示例。