审核
介绍
Spring AI 支持 Mistral AI 推出的新审核服务,该服务由 Mistral Moderation 模型提供支持。它能够在多个策略维度上检测有害的文本内容。有关 Mistral AI 审核模型的更多信息,请访问此链接。
前提条件
-
创建一个 Mistral AI 账户并获取 API 密钥。你可以在 Mistral AI 注册页面 进行注册,并在 API 密钥页面 生成 API 密钥。
-
将
spring-ai-mistral-ai依赖项添加到项目的构建文件中。更多信息请参考 依赖管理 部分。
自动配置
Spring AI 的自动配置和 starter 模块的 artifact 名称已发生重大变更。详情请参阅升级说明。
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。
| Property | 描述 | 默认值 |
|---|---|---|
| spring.ai.mistralai.base-url | 连接的 URL | api.mistral.ai |
| spring.ai.mistralai.api-key | API Key | - |
配置属性
审核自动配置(moderation auto-configurations)的启用与禁用现在通过前缀为 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 Key | - |
| spring.ai.mistralai.moderation.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 为前缀的属性都可以在运行时进行覆盖。
运行时选项
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());
}
手动配置
在项目的 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 添加到你的构建文件中。
接下来,创建一个 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 测试提供了一些关于如何使用该库的一般示例。您可以参考此测试以获取更详细的使用示例。