审核

引言

Spring AI 支持 Mistral AI 推出的、由 Mistral Moderation 模型驱动的新审核服务。 它能沿多个策略维度检测有害文本内容。 遵循此链接以了解更多关于 Mistral AI 审核模型的信息。

前置条件

1. 创建一个 Mistral AI 账户并获取 API 密钥。你可以在 Mistral AI 注册页 注册，并在 API Keys 页 生成一个 API 密钥。
2. 把 spring-ai-mistral-ai 依赖添加到你项目的构建文件。更多信息参见 依赖管理 一节。

自动配置

NOTE

Spring AI 的自动配置、starter 模块的制品名称发生了重大变更。 更多信息请参阅 升级说明。

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'
}

TIP

参见 依赖管理 一节，把 Spring AI BOM 添加到你的构建文件。

审核属性

连接属性

前缀 spring.ai.mistralai 用作连接 Mistral AI 的属性前缀。

属性	描述	默认值
spring.ai.mistralai.base-url	要连接到的 URL	https://api.mistral.ai
spring.ai.mistralai.api-key	API 密钥	-

配置属性

NOTE

审核自动配置的启用与禁用，现通过以 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	启用审核（Moderation）模型	mistral
spring.ai.mistralai.moderation.base-url	连接用的 URL	https://api.mistral.ai
spring.ai.mistralai.moderation.api-key	API Key	-
spring.ai.mistralai.moderation.model	用于审核的模型 ID。	mistral-moderation-latest

NOTE

你可以覆盖通用的 spring.ai.mistralai.base-url、spring.ai.mistralai.api-key 属性。

若设置了 spring.ai.mistralai.moderation.base-url、spring.ai.mistralai.moderation.api-key 属性，它们优先于通用属性。 当你想为不同模型、不同模型端点使用不同的 Mistral AI 账户时，这很有用。

TIP

所有以 spring.ai.mistralai.moderation 为前缀的属性都可在运行时被覆盖。

运行时选项

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'
}

TIP

参见 依赖管理 一节，把 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 测试提供了一些关于如何使用该库的通用示例。你可参考该测试了解更多详细用法。