内容审核
介绍
Spring AI 支持 OpenAI 的审核模型，允许你检测文本中潜在有害或敏感内容。 请按照本指南了解OpenAI的审核模式。
前提条件
-
创建一个OpenAI账户并获取API密钥。你可以在 OpenAI 注册页面注册，并在 API 密钥页面生成 API 密钥。
-
添加
春艾开胃依赖你项目的构建文件。更多信息请参阅依赖管理部分。
自动配置
|
春季AI自动配置、起始模块的工件名称发生了重大变化。 更多信息请参阅升级说明。 |
Spring AI 为 OpenAI 审核模型提供 Spring Boot 自动配置。
要启用它，请在项目的Maven中添加以下依赖pom.xml文件：
<dependency>
<groupId>org.springframework.ai</groupId>
<artifactId>spring-ai-starter-model-openai</artifactId>
</dependency>或者去你的Gradlebuild.gradle构建文件：
dependencies {
implementation 'org.springframework.ai:spring-ai-starter-model-openai'
}| 请参考依赖管理部分，将Spring AI的物料清单添加到你的构建文件中。 |
减速性质
连接性质
spring.ai.openai 这个前缀被用作属性前缀，让你可以连接到 OpenAI。
属性 |
描述 |
默认值 |
Spring.ai.openai.base-url |
连接的URL（链接） |
|
spring.ai.openai.api-key（春.ai.openai.api-key） |
API 密钥 |
- |
spring.ai.openai.organization-id |
你可以选择指定API请求所使用的组织。 |
- |
spring.ai.openai.project-id |
可选地，你可以指定用于 API 请求的项目。 |
- |
| 对于属于多个组织的用户（或通过其遗留用户 API 密钥访问项目），你可以选择指定用于 API 请求的组织和项目。 这些 API 请求的使用将计入指定组织和项目的使用。 |
配置属性
|
嵌入自动配置的启用和禁用现在通过带有前缀的顶层属性配置 要启用，spring.ai.model.moderation=openai（默认启用） 要禁用，可以选择 spring.ai.model.moderation=none（或任何与 openai 不匹配的值） 此改动旨在允许配置多个模型。 |
前缀 spring.ai.openai.moderation 被用作配置 OpenAI 审核模型的属性前缀。
属性 |
描述 |
默认值 |
spring.ai.model.moderation |
启用调节模型 |
OpenAI |
spring.ai.openai.moderation.base-url |
连接的URL（链接） |
|
spring.ai.openai.moderation.api-key |
API 密钥 |
- |
spring.ai.openai.moderation.organization-id |
你可以选择指定API请求所使用的组织。 |
- |
spring.ai.openai.moderation.project-id |
可选地，你可以指定用于 API 请求的项目。 |
- |
spring.ai.openai.moderation.options.model |
用于审核的型号标识。 |
omni-moderation-latest |
你可以覆盖公共信息Spring.ai.openai.base-url,spring.ai.openai.api-key（春.ai.openai.api-key）,spring.ai.openai.organization-id和spring.ai.openai.project-id性能。
这spring.ai.openai.moderation.base-url,spring.ai.openai.moderation.api-key,spring.ai.openai.moderation.organization-id和spring.ai.openai.moderation.project-id如果属性被设置，则优先于共同属性。
如果你想为不同模型和不同模型端点使用不同的OpenAI账户，这非常有用。 |
所有以spring.ai.openai.moderation.options可以在运行时被覆盖。 |
运行时选项
OpenAiModerationOptions 类提供了提交审核请求时可用的选项。 启动时会使用spring.ai.openai.moderation指定的选项，但你可以在运行时覆盖这些选项。
例如：
OpenAiModerationOptions moderationOptions = OpenAiModerationOptions.builder()
.model("omni-moderation-latest")
.build();
ModerationPrompt moderationPrompt = new ModerationPrompt("Text to be moderated", this.moderationOptions);
ModerationResponse response = openAiModerationModel.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("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("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文件：
<dependency>
<groupId>org.springframework.ai</groupId>
<artifactId>spring-ai-openai</artifactId>
</dependency>或者去你的Gradlebuild.gradle构建文件：
dependencies {
implementation 'org.springframework.ai:spring-ai-openai'
}| 请参考依赖管理部分，将Spring AI的物料清单添加到你的构建文件中。 |
接下来，创建一个OpenAiModerationModel：
OpenAiModerationApi openAiModerationApi = new OpenAiModerationApi(System.getenv("OPENAI_API_KEY"));
OpenAiModerationModel openAiModerationModel = new OpenAiModerationModel(this.openAiModerationApi);
OpenAiModerationOptions moderationOptions = OpenAiModerationOptions.builder()
.model("omni-moderation-latest")
.build();
ModerationPrompt moderationPrompt = new ModerationPrompt("Text to be moderated", this.moderationOptions);
ModerationResponse response = this.openAiModerationModel.call(this.moderationPrompt);