|
获取最新的快照版本，请使用 Spring AI 1.1.3！ |
审核
简介
Spring AI 支持Mistral AI新引入的审核服务，该服务由Mistral审核模型驱动。 它能沿多个策略维度检测有害文本内容。 点击此链接了解有关Mistral AI审核模型的更多信息。
前提条件
-
创建一个Mistral AI账户并获取API密钥。您可以在
上注册，并在 生成API密钥。 -
将
spring-ai-mistral-ai依赖项添加到项目的构建文件中。更多信息，请参阅依赖管理部分。
自动配置
|
There has been a significant change in the Spring AI auto-configuration, starter modules' artifact names. Please refer to the 升级说明以获取更多信息。 |
Spring AI 为 Mistral AI Moderation Model 提供了 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到你的构建文件中。 |
审核属性
连接属性
用于连接至Mistral AI的属性前缀为spring.ai.mistralai。
属性 |
描述 |
默认 |
spring.ai.mistralai.base-url |
要连接的URL |
|
spring.ai.mistralai.api-key |
API 密钥 |
- |
配置属性
|
现在，启用和禁用审核自动配置是通过带有前缀 要启用，请设置 spring.ai.model.moderation=mistral （默认情况下已启用） 要禁用，请设置 spring.ai.model.moderation=none（或任何不匹配mistral的值） 这种修改是为了允许配置多个模型。 |
用于配置Mistral AI审核模型的属性前缀为spring.ai.mistralai.moderation。
属性 |
描述 |
默认 |
spring.ai.model.moderation |
启用审核模型 |
密史脱拉风 |
spring.ai.mistralai.moderation.base-url |
要连接的URL |
|
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);