审核
简介
Spring AI 支持 OpenAI 的内容审核模型，该模型允许您检测文本中潜在有害或敏感的内容。请遵循此 指南，以获取有关 OpenAI 内容审核模型的更多信息。
先决条件
-
创建一个 OpenAI 账户并获取一个 API 密钥。您可以在 OpenAI 注册页面 注册，并在 API 密钥页面 生成 API 密钥。
-
将
spring-ai-openai依赖项添加到您项目的构建文件中。有关更多信息，请参阅 依赖管理 部分。
自动配置
|
Spring AI 自动配置、启动模块的工件名称发生了重大变化。请参阅 升级说明 以获取更多信息。 |
Spring AI 为 OpenAI 内容审核模型提供了 Spring Boot 自动配置。要启用它，请将以下依赖项添加到您项目的 Maven pom.xml 文件中
<dependency>
<groupId>org.springframework.ai</groupId>
<artifactId>spring-ai-starter-model-openai</artifactId>
</dependency>或添加到您的 Gradle build.gradle 构建文件中
dependencies {
implementation 'org.springframework.ai:spring-ai-starter-model-openai'
}| 请参阅 依赖项管理 部分，将 Spring AI BOM 添加到您的构建文件中。 |
内容审核属性
连接属性
前缀 spring.ai.openai 用作属性前缀，让您连接到 OpenAI。
财产 |
描述 |
默认值 |
spring.ai.openai.base-url |
要连接的 URL |
|
spring.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 |
用于内容审核的模型的 ID。 |
omni-moderation-latest |
您可以覆盖通用的 spring.ai.openai.base-url、spring.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());
}手动配置
将 spring-ai-openai 依赖项添加到您的项目的 Maven pom.xml 文件中
<dependency>
<groupId>org.springframework.ai</groupId>
<artifactId>spring-ai-openai</artifactId>
</dependency>或添加到您的 Gradle build.gradle 构建文件中
dependencies {
implementation 'org.springframework.ai:spring-ai-openai'
}| 请参阅 依赖项管理 部分，将 Spring AI BOM 添加到您的构建文件中。 |
接下来，创建一个 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);
