审核
引言
Spring AI 支持 OpenAI 的审核模型，该模型可用于检测文本中潜在有害或敏感的内容。请遵循此指南，获取更多关于 OpenAI 审核模型的信息。
前提条件
-
创建 OpenAI 账户并获取 API 密钥。您可以在OpenAI 注册页面注册，并在API Keys 页面生成 API 密钥。
-
将
spring-ai-openai依赖添加到项目的构建文件中。有关更多信息，请参阅依赖管理章节。
自动配置
|
Spring AI 自动配置、starter 模块的构件名称发生了重大变化。请参阅升级注意事项获取更多信息。 |
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.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。 |
text-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("text-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("text-moderation-latest")
.build();
ModerationPrompt moderationPrompt = new ModerationPrompt("Text to be moderated", this.moderationOptions);
ModerationResponse response = this.openAiModerationModel.call(this.moderationPrompt);
